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