ColorUtils Class Reference
| Public Member Functions |
|---|
| IMPORT_C TRgb | ColorAdjust(TRgb, TInt) |
| IMPORT_C void | CreateGradientBitmapL(CFbsBitmap &, const RWsSession &, TInt, TBitmapOrientation, TRgb, TRgb) |
| IMPORT_C CColorList * | CreateSystemColorListL(RFs &) |
| IMPORT_C CColorList * | CreateSystemColorListL(RFs &, const CColorList &) |
| IMPORT_C void | GetRgbDerivedBorderColors(TGulBorder::TColors &, TRgb, TDisplayMode) |
| IMPORT_C TRgb | RgbDarkerColor(TRgb, TDisplayMode) |
| IMPORT_C TRgb | RgbLighterColor(TRgb, TDisplayMode) |
| IMPORT_C TRgb | RgbMidDarkerColor(TRgb, TDisplayMode) |
| IMPORT_C void | UpdateSystemColorListL(RFs &, CColorList &) |
Detailed Description
Provides static functions for manipulating colours.
See also: TDisplayMode
Member Enumeration Documentation
Enum TBitmapOrientation
The orientation of a bitmap.
| Enumerator | Value | Description |
|---|
| EBitmapOrientationVertical | |
The bitmap is vertical.
|
| EBitmapOrientationHorizontal | |
The bitmap is horizontal.
|
Member Function Documentation
ColorAdjust ( TRgb, TInt )
| IMPORT_C TRgb | ColorAdjust | ( | TRgb | aColor, |
| | TInt | aPercentage |
| | ) | [static] |
Brightens or darkens a 24-bit colour by a percentage.
If the percentage given is less than 100%, a darker colour will be returned. The algorithm brightens or darkens each of the R, G and B channels equally.
| Parameter | Description | | aColor | Input colour. |
| aPercentage | Percentage by which to adjust the input colour. |
Returns: The adjusted colour.
CreateGradientBitmapL ( CFbsBitmap &, const RWsSession &, TInt, TBitmapOrientation, TRgb, TRgb )
Creates a CFbsBitmap containing a colour gradient.
To create a gradient, the end colour aEndColor must be different to the start colour aStartingColor.
| Parameter | Description | | aBitmap | Bitmap which on return contains the colour gradient. |
| aWs | Handle to a window server session. |
| aBreadth | The width or the height of the bitmap, depending on the orientation. |
| aOrientation | The bitmap's orientation (vertical or horizontal). |
| aStartColor | The start color. |
| aEndColor | The end color. |
CreateSystemColorListL ( RFs & )
CreateSystemColorListL ( RFs &, const CColorList & )
GetRgbDerivedBorderColors ( TGulBorder::TColors &, TRgb, TDisplayMode )
Gets the colours to use for a control's border.
Lighter and darker tones in the border are derived from the specified TRgb background colour using an algorithm operating on the RGB value of this color or a lookup table, depending on the display mode aMode. It sets the values of the aBorderColors members iBack, iLight, iMidlight, iMid, and iDark.
| Parameter | Description | | aBorderColors | On return, the derived border colours. |
| aBackgroundColor | The control's background colour. |
| aMode | The display mode. |
RgbDarkerColor ( TRgb, TDisplayMode )
| Parameter | Description | | aRgb | The RGB color. |
| aMode | The display mode, which indicates the screen output of the colour e.g. 256 colour display mode (8 bpp). |
Returns: The darker colour.
RgbLighterColor ( TRgb, TDisplayMode )
Creates a lighter colour.
| Parameter | Description | | aRgb | The Rgb colour. |
| aMode | The display mode, which indicates the screen output of the colour e.g. 256 colour display mode (8 bpp). |
Returns: The lighter colour.
RgbMidDarkerColor ( TRgb, TDisplayMode )
Creates a medium dark version of the colour.
This function darkens the colour 50% less than RgbDarkerColor().
| Parameter | Description | | aRgb | The Rgb color. |
| aMode | The display mode, which indicates the screen output of the colour e.g. 256 colour display mode (8 bpp). |
Returns: The medium dark colour.
UpdateSystemColorListL ( RFs &, CColorList & )
| IMPORT_C void | UpdateSystemColorListL | ( | RFs & | aFs, |
| | CColorList & | aColorList |
| | ) | [static] |