|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
* FORM global parameters; held in thread-local storage.
|
|
sl@0
|
16 |
*
|
|
sl@0
|
17 |
*/
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
|
|
sl@0
|
20 |
#ifndef __FRMPARAM_H__
|
|
sl@0
|
21 |
#define __FRMPARAM_H__
|
|
sl@0
|
22 |
|
|
sl@0
|
23 |
#include <gdi.h>
|
|
sl@0
|
24 |
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
/**
|
|
sl@0
|
27 |
Specifies the protocol for getting system colours for use in text views. A
|
|
sl@0
|
28 |
class which implements this protocol allows an application (or a thread,
|
|
sl@0
|
29 |
because a pointer to the object is held in thread-local storage) to use system
|
|
sl@0
|
30 |
colours in text views.
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
You should create an object of an MFormParam-derived class which implements the
|
|
sl@0
|
33 |
SystemColor() function. Then, pass a pointer to the object to the static
|
|
sl@0
|
34 |
function MFormParam::Set(). The MFormParam-derived object is owned by the
|
|
sl@0
|
35 |
caller of Set(). When system colours are no longer needed, you should cancel
|
|
sl@0
|
36 |
them by calling MFormParam::Set(NULL). It is the caller's responsibility to
|
|
sl@0
|
37 |
cause the text view to be redrawn after system colours are changed.
|
|
sl@0
|
38 |
|
|
sl@0
|
39 |
CTextLayout uses the colour translation function SystemColor() (if an
|
|
sl@0
|
40 |
MFormParam-derived object is present) to set the pen and brush colours for
|
|
sl@0
|
41 |
drawing components of the text view. It calls MFormParam::Get() before each
|
|
sl@0
|
42 |
draw. This enables an application to introduce system colours, change the
|
|
sl@0
|
43 |
parameter object, or abolish system colours, and redraw everything correctly;
|
|
sl@0
|
44 |
no information is left over from the last draw.
|
|
sl@0
|
45 |
@publishedAll
|
|
sl@0
|
46 |
@released
|
|
sl@0
|
47 |
*/
|
|
sl@0
|
48 |
class MFormParam
|
|
sl@0
|
49 |
|
|
sl@0
|
50 |
{
|
|
sl@0
|
51 |
public:
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
/** Translates 8-bit logical colour indices to physical colours pure
|
|
sl@0
|
54 |
virtual function.
|
|
sl@0
|
55 |
|
|
sl@0
|
56 |
The colour index is stored in a TLogicalRgb object and is returned by
|
|
sl@0
|
57 |
TLogicalRgb::SystemColorIndex().
|
|
sl@0
|
58 |
|
|
sl@0
|
59 |
There are three reserved index values:
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
Zero means the logical colour does not map to a system colour: the logical
|
|
sl@0
|
62 |
colour is in fact an ordinary TRgb. This function should not normally be
|
|
sl@0
|
63 |
called with this value.
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
254 and 255 are default foreground and background colours respectively, and
|
|
sl@0
|
66 |
should be converted to the GUI's standard foreground and background colours
|
|
sl@0
|
67 |
|
|
sl@0
|
68 |
The values 1-253 are reserved for the use of the GUI and can be interpreted
|
|
sl@0
|
69 |
as convenient. These can be interpreted as
|
|
sl@0
|
70 |
TLogicalColor::EColorWindowBackground upward; this mapping can be done by
|
|
sl@0
|
71 |
subtracting one from the index number aColorIndex.
|
|
sl@0
|
72 |
|
|
sl@0
|
73 |
@param aColorIndex Logical colour index. Between 1 and 255 inclusive.
|
|
sl@0
|
74 |
@param aDefaultColor The default colour. This is the colour to be used if
|
|
sl@0
|
75 |
no translation is performed. This allows translation to change certain
|
|
sl@0
|
76 |
indices but not others, (by passing the default colour back unchanged).
|
|
sl@0
|
77 |
@return The physical colour which maps to the logical colour index. */
|
|
sl@0
|
78 |
virtual TRgb SystemColor(TUint aColorIndex,TRgb aDefaultColor) const = 0;
|
|
sl@0
|
79 |
IMPORT_C virtual void Reserved();
|
|
sl@0
|
80 |
IMPORT_C static void Set(const MFormParam* aParam);
|
|
sl@0
|
81 |
IMPORT_C static const MFormParam* Get();
|
|
sl@0
|
82 |
};
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
#endif // __FRMPARAM_H__
|