1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/textandloc/textrendering/textformatting/inc/FRMPARAM.H	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,84 @@
     1.4 +/*
     1.5 +* Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +* FORM global parameters; held in thread-local storage.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef __FRMPARAM_H__
    1.24 +#define __FRMPARAM_H__
    1.25 +
    1.26 +#include <gdi.h>
    1.27 +
    1.28 +
    1.29 +/** 
    1.30 +Specifies the protocol for getting system colours for use in text views. A
    1.31 +class which implements this protocol allows an application (or a thread,
    1.32 +because a pointer to the object is held in thread-local storage) to use system
    1.33 +colours in text views.
    1.34 +
    1.35 +You should create an object of an MFormParam-derived class which implements the
    1.36 +SystemColor() function. Then, pass a pointer to the object to the static
    1.37 +function MFormParam::Set(). The MFormParam-derived object is owned by the
    1.38 +caller of Set(). When system colours are no longer needed, you should cancel
    1.39 +them by calling MFormParam::Set(NULL). It is the caller's responsibility to
    1.40 +cause the text view to be redrawn after system colours are changed.
    1.41 +
    1.42 +CTextLayout uses the colour translation function SystemColor() (if an
    1.43 +MFormParam-derived object is present) to set the pen and brush colours for
    1.44 +drawing components of the text view. It calls MFormParam::Get() before each
    1.45 +draw. This enables an application to introduce system colours, change the
    1.46 +parameter object, or abolish system colours, and redraw everything correctly;
    1.47 +no information is left over from the last draw.
    1.48 +@publishedAll
    1.49 +@released
    1.50 +*/
    1.51 +class MFormParam
    1.52 +
    1.53 +	{
    1.54 +	public:
    1.55 +
    1.56 +	/** Translates 8-bit logical colour indices to physical colours pure
    1.57 +	virtual function.
    1.58 +
    1.59 +	The colour index is stored in a TLogicalRgb object and is returned by
    1.60 +	TLogicalRgb::SystemColorIndex().
    1.61 +
    1.62 +	There are three reserved index values:
    1.63 +
    1.64 +	Zero means the logical colour does not map to a system colour: the logical
    1.65 +	colour is in fact an ordinary TRgb. This function should not normally be
    1.66 +	called with this value.
    1.67 +
    1.68 +	254 and 255 are default foreground and background colours respectively, and
    1.69 +	should be converted to the GUI's standard foreground and background colours
    1.70 +
    1.71 +	The values 1-253 are reserved for the use of the GUI and can be interpreted
    1.72 +	as convenient. These can be interpreted as
    1.73 +	TLogicalColor::EColorWindowBackground upward; this mapping can be done by
    1.74 +	subtracting one from the index number aColorIndex.
    1.75 +
    1.76 +	@param aColorIndex Logical colour index. Between 1 and 255 inclusive.
    1.77 +	@param aDefaultColor The default colour. This is the colour to be used if
    1.78 +	no translation is performed. This allows translation to change certain
    1.79 +	indices but not others, (by passing the default colour back unchanged).
    1.80 +	@return The physical colour which maps to the logical colour index. */
    1.81 +	virtual TRgb SystemColor(TUint aColorIndex,TRgb aDefaultColor) const = 0;
    1.82 +	IMPORT_C virtual void Reserved();
    1.83 +	IMPORT_C static void Set(const MFormParam* aParam);
    1.84 +	IMPORT_C static const MFormParam* Get();
    1.85 +	};
    1.86 +
    1.87 +#endif // __FRMPARAM_H__