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