1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/coecoloruse.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,122 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __COECOLORUSE_H__
1.20 +#define __COECOLORUSE_H__
1.21 +
1.22 +#include <e32std.h>
1.23 +
1.24 +/** Logical colour used when drawing in controls.
1.25 +
1.26 +This class pairs a logical colour value with an explanation of how it is used
1.27 +when drawing a control. The explanation is in terms of categories of use, e.g.
1.28 +in the TGround category, the colour can used for either the foreground or
1.29 +background.
1.30 +
1.31 +@publishedAll
1.32 +@released */
1.33 +class TCoeColorUse
1.34 + {
1.35 +public:
1.36 + /** Foreground and background category flags */
1.37 + enum TGround
1.38 + {
1.39 + /** The logical colour is used to draw the control when it is in the foreground. */
1.40 + EFore=0x01,
1.41 + /** The logical colour is used to draw the control when it is in the background. */
1.42 + EBack=0x02
1.43 + };
1.44 +
1.45 + /** Flags that control the area in which colour is used. */
1.46 + enum TAreas
1.47 + {
1.48 + /** The logical colour is used to draw a control's contents. */
1.49 + EContents=0x10,
1.50 + /** The logical colour is used to draw a control's highlighted contents. */
1.51 + EHighlights=0x20,
1.52 + /** The logical colour is used to draw a control's surrounds. */
1.53 + ESurrounds=0x40,
1.54 + /** The logical colour is used to draw a control's borders. */
1.55 + EBorders=0x80
1.56 + };
1.57 +
1.58 + /** Focus category flags */
1.59 + enum TFocus
1.60 + {
1.61 + /** The logical colour is used to draw the control when active and either focused
1.62 + or unfocused. */
1.63 + EActive=0x100,
1.64 + /** The logical colour is used to draw the control when dimmed and either focused
1.65 + or unfocused. */
1.66 + EDimmed=0x200,
1.67 + /** The logical colour is used to draw the control when it is shadowed. */
1.68 + EShadowed=0x400,
1.69 + /** The logical colour is used to draw the control when focused and pressed. */
1.70 + EPressed=0x800
1.71 + };
1.72 +
1.73 + /** State category flags */
1.74 + enum TState
1.75 + {
1.76 + /** The logical colour is used to draw the control in the normal state. */
1.77 + ENormal=0x1000,
1.78 + /** The logical colour is used to draw the control in the set state. */
1.79 + ESet=0x2000,
1.80 + /** The logical colour is used to draw the control in the checked state. */
1.81 + EChecked=0x4000
1.82 + };
1.83 +
1.84 + /** Tone flags */
1.85 + enum TTones
1.86 + {
1.87 + /** The logical colour is used to draw the control in neutral tones. */
1.88 + ENeutral=0x10000,
1.89 + /** The logical colour is used to draw the control in light tones. */
1.90 + ELight=0x20000,
1.91 + /** The logical colour is used to draw the control in midlight tones. */
1.92 + EMidLight=0x40000,
1.93 + /** The logical colour is used to draw the control in mid tones. */
1.94 + EMid=0x80000,
1.95 + /** The logical colour is used to draw the control in dark tones. */
1.96 + EDark=0x100000
1.97 + };
1.98 +public:
1.99 + IMPORT_C TCoeColorUse();
1.100 + //
1.101 + IMPORT_C void SetUse(TInt aUse);
1.102 + IMPORT_C void SetLogicalColor(TInt aLogicalColor);
1.103 + IMPORT_C TInt LogicalColor() const;
1.104 + IMPORT_C TInt Use() const;
1.105 + //
1.106 + IMPORT_C TBool IsForeground() const;
1.107 + IMPORT_C TBool IsBackground() const;
1.108 + //
1.109 + IMPORT_C TBool IsContents() const;
1.110 + IMPORT_C TBool IsHighlights() const;
1.111 + IMPORT_C TBool IsSurrounds() const;
1.112 + IMPORT_C TBool IsBorders() const;
1.113 + IMPORT_C TBool IsActive() const;
1.114 + IMPORT_C TBool IsDimmed() const;
1.115 + IMPORT_C TBool IsPressed() const;
1.116 + IMPORT_C TBool IsNormal() const;
1.117 + IMPORT_C TBool IsSet() const;
1.118 +private:
1.119 + TInt iLogicalColor;
1.120 + TInt iUse;
1.121 + TInt iTCoeColorUse_Reserved1;
1.122 + };
1.123 +
1.124 +
1.125 +#endif // __COECOLORUSE_H__