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