textrendering/textformatting/inc/FRMLAYDT.H
author hgs
Mon, 12 Jul 2010 14:38:26 +0800
changeset 45 662fa7de7023
parent 0 1fb32624e06b
permissions -rw-r--r--
201024_05

/*
* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/


#ifndef __FRMLAYDT_H__
#define __FRMLAYDT_H__

#include <e32std.h>

#if defined(TIMING_CODE)
class CWindowGc;
class RWsSession;
#endif

/** 
Layout data: no longer used.

This class provides two enumerations which are used in the Text Views API.
@publishedAll
@deprecated 7.0 
*/
class CLayoutData

	{
public:
	enum
		{
		EFLargeNumber = KMaxTInt / 3,	// must be less than KMaxTInt/2 to avoid overflow problems
		EFFontHeightIncreaseFactor = 7,	// by default, increase the font height by this percentage
		EFMinimumLineDescent = 3,		// by default, this is the minimum line descent
		EFBaseLinePosition = 82			// position down ViewRect for BaseLine
		};

	enum
		{
		EFHeightForFormattingAllText = EFLargeNumber,
		EFBodyWidthForNoWrapping = EFLargeNumber
		};
	
	/** Flags used when converting between layout coordinates and document
	position.
	@see CTextLayout::XyPosToDocPosL()
	@see CTextLayout::DocPosToXyPosL() */
	enum		
		{
		/**
		Count individual characters and don't treat the end of the line specially.
		@deprecated 6.2
		*/
		EFIndividualChars = 0,
		/**
		Only consider the beginnings and ends of whole lines. Only useful in
		XyToDocPos functions.
		*/
		EFWholeLinesOnly = 1,
		/**
		Only consider the beginnings and ends of whole TBoxs so as not to
		access the document. Only useful in XyToDocPos functions.
		*/
		EFWholeTBoxesOnly=EFWholeLinesOnly,
		/**
		Disambiguate the end position of a line from the start position of
		the next line. If both positions are the same, a position at the end
		of the line will be invalid, and the position before will be
		returned instead.
		*/
		EFDisambiguateEndOfLine = 2,
		};

	/** Format modes. */
	enum TFormatMode
		{
		/** Dimensions stored in pixels with no mapping between format and image device. */
		EFScreenMode, 
		/** Dimensions stored in twips with no mapping. */
		EFPrintMode,
		/** Dimensions stored in twips with partial mapping. */
		EFPrintPreviewMode, 
		/** Dimensions stored in twips with full mapping. */
		EFWysiwygMode
		};
private:
	// not constructable
	CLayoutData(CLayoutData&);
	};

#endif