epoc32/include/frmlaydt.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __FRMLAYDT_H__
williamr@2
    17
#define __FRMLAYDT_H__
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
williamr@2
    21
#if defined(TIMING_CODE)
williamr@2
    22
class CWindowGc;
williamr@2
    23
class RWsSession;
williamr@2
    24
#endif
williamr@2
    25
williamr@2
    26
/** 
williamr@2
    27
Layout data: no longer used.
williamr@2
    28
williamr@2
    29
This class provides two enumerations which are used in the Text Views API.
williamr@2
    30
@publishedAll
williamr@2
    31
@deprecated 7.0 
williamr@2
    32
*/
williamr@2
    33
class CLayoutData
williamr@2
    34
williamr@2
    35
	{
williamr@2
    36
public:
williamr@2
    37
	enum
williamr@2
    38
		{
williamr@2
    39
		EFLargeNumber = KMaxTInt / 3,	// must be less than KMaxTInt/2 to avoid overflow problems
williamr@2
    40
		EFFontHeightIncreaseFactor = 7,	// by default, increase the font height by this percentage
williamr@2
    41
		EFMinimumLineDescent = 3,		// by default, this is the minimum line descent
williamr@2
    42
		EFBaseLinePosition = 82			// position down ViewRect for BaseLine
williamr@2
    43
		};
williamr@2
    44
williamr@2
    45
	enum
williamr@2
    46
		{
williamr@2
    47
		EFHeightForFormattingAllText = EFLargeNumber,
williamr@2
    48
		EFBodyWidthForNoWrapping = EFLargeNumber
williamr@2
    49
		};
williamr@2
    50
	
williamr@2
    51
	/** Flags used when converting between layout coordinates and document
williamr@2
    52
	position.
williamr@2
    53
	@see CTextLayout::XyPosToDocPosL()
williamr@2
    54
	@see CTextLayout::DocPosToXyPosL() */
williamr@2
    55
	enum		
williamr@2
    56
		{
williamr@2
    57
		/**
williamr@2
    58
		Count individual characters and don't treat the end of the line specially.
williamr@2
    59
		@deprecated 6.2
williamr@2
    60
		*/
williamr@2
    61
		EFIndividualChars = 0,
williamr@2
    62
		/**
williamr@2
    63
		Only consider the beginnings and ends of whole lines. Only useful in
williamr@2
    64
		XyToDocPos functions.
williamr@2
    65
		*/
williamr@2
    66
		EFWholeLinesOnly = 1,
williamr@2
    67
		/**
williamr@2
    68
		Only consider the beginnings and ends of whole TBoxs so as not to
williamr@2
    69
		access the document. Only useful in XyToDocPos functions.
williamr@2
    70
		*/
williamr@2
    71
		EFWholeTBoxesOnly=EFWholeLinesOnly,
williamr@2
    72
		/**
williamr@2
    73
		Disambiguate the end position of a line from the start position of
williamr@2
    74
		the next line. If both positions are the same, a position at the end
williamr@2
    75
		of the line will be invalid, and the position before will be
williamr@2
    76
		returned instead.
williamr@2
    77
		*/
williamr@2
    78
		EFDisambiguateEndOfLine = 2,
williamr@2
    79
		};
williamr@2
    80
williamr@2
    81
	/** Format modes. */
williamr@2
    82
	enum TFormatMode
williamr@2
    83
		{
williamr@2
    84
		/** Dimensions stored in pixels with no mapping between format and image device. */
williamr@2
    85
		EFScreenMode, 
williamr@2
    86
		/** Dimensions stored in twips with no mapping. */
williamr@2
    87
		EFPrintMode,
williamr@2
    88
		/** Dimensions stored in twips with partial mapping. */
williamr@2
    89
		EFPrintPreviewMode, 
williamr@2
    90
		/** Dimensions stored in twips with full mapping. */
williamr@2
    91
		EFWysiwygMode
williamr@2
    92
		};
williamr@2
    93
private:
williamr@2
    94
	// not constructable
williamr@2
    95
	CLayoutData(CLayoutData&);
williamr@2
    96
	};
williamr@2
    97
williamr@2
    98
#endif