Symbian^3 Application Developer Library >

AknsDrawUtils Class Reference

class AknsDrawUtils

Static utility class to support Avkon Skins drawing operations. AknsDrawUtils provides utility methods to perform skin-aware drawing operations, such as background drawing.

This is a public static class with exported functions. The class is not intended for derivation outside the library.

AknSkins.lib

Since
2.0
Public Member Functions
IMPORT_C TBool Background ( MAknsSkinInstance *, MAknsControlContext *, CWindowGc &, const TRect &)
IMPORT_C TBool Background ( MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &)
IMPORT_C TBool Background ( MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TInt )
IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance *, MAknsControlContext *, CWindowGc &, const TRect &, const TRect &)
IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TRect &)
IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TRect &, const TInt )
IMPORT_C MAknsControlContext * ControlContext (const MObjectProvider *)
IMPORT_C MAknsControlContext * ControlContextOfParent (const CCoeControl *)
IMPORT_C TBool DrawBackground ( MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CBitmapContext &, const TPoint &, const TRect &, const TInt )
IMPORT_C void DrawCachedImage ( MAknsSkinInstance *, CWindowGc &, const TRect &, const TAknsItemID &)
IMPORT_C void DrawCachedImage ( MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TAknsItemID &)
IMPORT_C TBool DrawFrame ( MAknsSkinInstance *, CWindowGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)
IMPORT_C TBool DrawFrame ( MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &, const TInt )
IMPORT_C TBool DrawFrame ( MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)
IMPORT_C TBool DrawFramePart ( MAknsSkinInstance *, CWindowGc &, const TRect &, const TAknsItemID &, const TAknsFrameElementIndex )
IMPORT_C TBool HasBitmapBackground ( MAknsSkinInstance *, MAknsControlContext *)
IMPORT_C TBool IsListSeperatorLines ( MAknsSkinInstance *)
IMPORT_C TBool PrepareFrame ( MAknsSkinInstance *, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)
IMPORT_C TSlidingMode SlidingMode ( MAknsSkinInstance *)
Private Member Functions
AknsDrawUtils ()
~AknsDrawUtils ()

Constructor & Destructor Documentation

AknsDrawUtils()

AknsDrawUtils ( ) [private]

~AknsDrawUtils()

~AknsDrawUtils ( ) [private]

Member Functions Documentation

Background(MAknsSkinInstance *, MAknsControlContext *, CWindowGc &, const TRect &)

IMPORT_C TBool Background ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
CWindowGc & aGc,
const TRect & aRect
) [static]

Draws background with assumed origin. Draws bacground to the specified rectangle. Origin is assumed to be (0,0). This overload can not be used with parent absolute layouts.

See DrawBackground for details on chained layouts.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. If NULL and skin instance was given, default parameters are used.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aRect Rectangle to be drawn.

Background(MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &)

IMPORT_C TBool Background ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
const CCoeControl * aControl,
CWindowGc & aGc,
const TRect & aRect
) [static]

Draws background with proper origin. Draws bacground to the specified rectangle. The origin is queried from the control position list (if given using AknsUtils::RegisterControlPosition ). If not found, the origin is queried from the given control, which may result in a window server flush.

See DrawBackground for details on chained layouts.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. Must be specified, if aInstance is not NULL.
const CCoeControl * aControl Control that knows the current window. Must be specified if parent absolute layout can be used, otherwise NULL may be given.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aRect Rectangle to be drawn.

Background(MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TInt)

IMPORT_C TBool Background ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
const CCoeControl * aControl,
CWindowGc & aGc,
const TRect & aRect,
const TInt aDrawParam
) [static]

Draws background with proper origin and drawing parameters. Draws bacground to the specified rectangle. The origin is queried from the control position list (if given using AknsUtils::RegisterControlPosition ). If not found, the origin is queried from the given control, which may result in a window server flush. Drawing parameters may be used to control drawing.

See DrawBackground for details on chained layouts.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. Must be specified, if aInstance is not NULL.
const CCoeControl * aControl Control that knows the current window. Must be specified if parent absolute layout can be used, otherwise NULL may be given.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aRect Rectangle to be drawn.
const TInt aDrawParam Bitwise combination of drawing parameters. KAknsDrawParamDefault should be used if no special handling is required.

BackgroundBetweenRects(MAknsSkinInstance *, MAknsControlContext *, CWindowGc &, const TRect &, const TRect &)

IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
CWindowGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect
) [static]

Draws background between rects. Draws bacground between specified rectangles. Origin is assumed to be (0,0).

See DrawBackground for details on chained layouts.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. If NULL and skin instance was given, default parameters are used.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle.
const TRect & aInnerRect Inner rectangle.

BackgroundBetweenRects(MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TRect &)

IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
const CCoeControl * aControl,
CWindowGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect
) [static]

Draws background between rects. Draws bacground between specified rectangles.

See DrawBackground for details on chained layouts.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. Must be specified if aInstance is not NULL.
const CCoeControl * aControl Control that knows the current window. Must be specified if parent absolute layout can be used, otherwise NULL may be given.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle.
const TRect & aInnerRect Inner rectangle.

BackgroundBetweenRects(MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CWindowGc &, const TRect &, const TRect &, const TInt)

IMPORT_C TBool BackgroundBetweenRects ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
const CCoeControl * aControl,
CWindowGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect,
const TInt aDrawParam
) [static]

Draws background between rects. Draws bacground between specified rectangles with drawing parameters.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. Must be specified if aInstance is not NULL.
const CCoeControl * aControl Control that knows the current window. Must be specified if parent absolute layout can be used, otherwise NULL may be given.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle.
const TRect & aInnerRect Inner rectangle.
const TInt aDrawParam Bitwise combination of drawing parameters. KAknsDrawParamDefault should be used if no special handling is required.

ControlContext(const MObjectProvider *)

IMPORT_C MAknsControlContext * ControlContext ( const MObjectProvider * aMop ) [static]

Returns pointer to the current control context. If aMop parameter is specified retrieves the nearest control context in control hierarchy. If none is found (or NULL parameter was given) returns NULL .

Since
2.0

Parameters

const MObjectProvider * aMop Object provider to be used to find the control context or NULL.

ControlContextOfParent(const CCoeControl *)

IMPORT_C MAknsControlContext * ControlContextOfParent ( const CCoeControl * aControl ) [static]

Returns pointer to the control context of the parent of the given control. The context possibly supplied by the control itself is ignored.

Since
2.6

Parameters

const CCoeControl * aControl Pointer to CCoeControl or NULL.

DrawBackground(MAknsSkinInstance *, MAknsControlContext *, const CCoeControl *, CBitmapContext &, const TPoint &, const TRect &, const TInt)

IMPORT_C TBool DrawBackground ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext,
const CCoeControl * aControl,
CBitmapContext & aGc,
const TPoint & aDstPos,
const TRect & aControlRect,
const TInt aDrawParam
) [static]

Draws background to the given graphics context. The origin is queried from the control position list (if given using AknsUtils::RegisterControlPosition ). If not found, the origin is queried from the given control, which may result in a window server flush.

If background contains multiple layers, they are drawn in the sequence specified by the context. If multiple contexts are chained (using SetParentContext ), they are drawn in reverse order, i.e. the context given as parameter to this method call is drawn last.

Drawing parameter KAknsDrawParamNoClearUnderImage is automatically assumed for all the chained contexts, except the deepest one.

Since
2.0

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance as obtained from AknsUtils::SkinInstance(). If NULL rectangle is cleared without bitmap.
MAknsControlContext * aContext Control context to obtain context specific information about background drawing. Must be specified, if aInstance is not NULL.
const CCoeControl * aControl Control that knows the current window. Must be specified if parent absolute layout can be used, otherwise NULL may be given.
CBitmapContext & aGc Graphics context to be used for drawing.
const TPoint & aDstPos Destination position (top-left corner of the area to be drawn) in graphics context coordinate system.
const TRect & aControlRect Rectangle (in the control coordinate system) to be drawn.
const TInt aDrawParam Bitwise combination of drawing parameters. KAknsDrawParamDefault should be used if no special handling is required.

DrawCachedImage(MAknsSkinInstance *, CWindowGc &, const TRect &, const TAknsItemID &)

IMPORT_C void DrawCachedImage ( MAknsSkinInstance * aInstance,
CWindowGc & aGc,
const TRect & aRect,
const TAknsItemID & aID
) [static]

Draws a cached image (with its attributes specified in the skin) to the given rectangle.

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns immediately.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aRect Rectangle specifying the pane used for drawing. The image is laid out within the rectangle.
const TAknsItemID & aID Item ID of the image to be drawn.

DrawCachedImage(MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TAknsItemID &)

IMPORT_C void DrawCachedImage ( MAknsSkinInstance * aInstance,
CFbsBitGc & aGc,
const TRect & aRect,
const TAknsItemID & aID
) [static]

Draws a cached image (with its attributes specified in the skin) to the given rectangle in an off-screen graphics context.

Since
2.8

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns immediately.
CFbsBitGc & aGc Bitmapped graphics context to be used for drawing.
const TRect & aRect Rectangle specifying the pane used for drawing. The image is laid out within the rectangle.
const TAknsItemID & aID Item ID of the image to be drawn.

DrawFrame(MAknsSkinInstance *, CWindowGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)

IMPORT_C TBool DrawFrame ( MAknsSkinInstance * aInstance,
CWindowGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect,
const TAknsItemID & aFrameID,
const TAknsItemID & aCenterID
) [static]

Draws a frame (with cached images) to the specified area.

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns EFalse.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle of the frame. Frame elements will be drawn within this rectangle.
const TRect & aInnerRect Inner rectangle of the frame. Frame center will be drawn within this rectangle.
const TAknsItemID & aFrameID Item ID of the entire frame.
const TAknsItemID & aCenterID Item ID of the center part of the frame. If KAknsIIDNone, no center will be drawn. If KAknsIIDDefault, the default value from the frame itself will be used. Other values, the item to be used for the center part. If the frame is specified as 1 part graphics in the skin instead of 9 part graphics, this parameter has no effect.

DrawFrame(MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &, const TInt)

IMPORT_C TBool DrawFrame ( MAknsSkinInstance * aInstance,
CFbsBitGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect,
const TAknsItemID & aFrameID,
const TAknsItemID & aCenterID,
const TInt aDrawParam
) [static]

Draws a frame (with cached images) to the specified area in an off-screen graphics context.

Since
2.8

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns EFalse.
CFbsBitGc & aGc Bitmapped graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle of the frame. Frame elements will be drawn within this rectangle.
const TRect & aInnerRect Inner rectangle of the frame. Frame center will be drawn within this rectangle.
const TAknsItemID & aFrameID Item ID of the entire frame.
const TAknsItemID & aCenterID Item ID of the center part of the frame. If KAknsIIDNone, no center will be drawn. If KAknsIIDDefault, the default value from the frame itself will be used. Other values, the item to be used for the center part. If unsure, specify KAknsIIDDefault. If the frame is specified as 1 part graphics in the skin instead of 9 part graphics, this parameter has no effect.
const TInt aDrawParam Bitwise combination of drawing parameters. KAknsDrawParamDefault should be used if no special handling is required.

DrawFrame(MAknsSkinInstance *, CFbsBitGc &, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)

IMPORT_C TBool DrawFrame ( MAknsSkinInstance * aInstance,
CFbsBitGc & aGc,
const TRect & aOuterRect,
const TRect & aInnerRect,
const TAknsItemID & aFrameID,
const TAknsItemID & aCenterID
) [static]

Draws a frame (with cached images) to the specified area in an off-screen graphics context.

Since
2.8

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns EFalse.
CFbsBitGc & aGc Bitmapped graphics context to be used for drawing.
const TRect & aOuterRect Outer rectangle of the frame. Frame elements will be drawn within this rectangle.
const TRect & aInnerRect Inner rectangle of the frame. Frame center will be drawn within this rectangle.
const TAknsItemID & aFrameID Item ID of the entire frame.
const TAknsItemID & aCenterID Item ID of the center part of the frame. If KAknsIIDNone, no center will be drawn. If KAknsIIDDefault, the default value from the frame itself will be used. Other values, the item to be used for the center part. If unsure, specifi KAknsIIDDefault. If the frame is specified as 1 part graphics in the skin instead of 9 part graphics, this parameter has no effect.

DrawFramePart(MAknsSkinInstance *, CWindowGc &, const TRect &, const TAknsItemID &, const TAknsFrameElementIndex)

IMPORT_C TBool DrawFramePart ( MAknsSkinInstance * aInstance,
CWindowGc & aGc,
const TRect & aRect,
const TAknsItemID & aFrameID,
const TAknsFrameElementIndex aFrameElement
) [static]

Draws the specified part of the frame (with a cached image) to the specified rectangle.

Compatibility note:
Prior to Series 60 release 2.8, the entire outer rectangle could be given as the rectangle of a corner part. Due to scalable UI compatibility, this is no longer supported in release 2.8, and thus the exact corner rectangle is required. This funtion may not function correctly if the skin specifies the frame as 1 part graphics.

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns EFalse.
CWindowGc & aGc Graphics context to be used for drawing.
const TRect & aRect Rectangle for drawing. This must be the rectangle of the specific part of the drawn that will be drawn, e.g. top-left corner rectangle if the top-left corner is being drawn.
const TAknsItemID & aFrameID Item ID of the entire frame.
const TAknsFrameElementIndex aFrameElement Element (index) of the frame element to be drawn.

HasBitmapBackground(MAknsSkinInstance *, MAknsControlContext *)

IMPORT_C TBool HasBitmapBackground ( MAknsSkinInstance * aInstance,
MAknsControlContext * aContext
) [static]

Determines whether background drawing would be done with a bitmap (deprecated).

This method is deprecated as of release 2.8. Use the return values of background drawing functions to determine whether the background was drawn with skinned content. The return value is always ETrue starting from rel 3.1

Parameters

MAknsSkinInstance * aInstance Pointer to skin instance. If NULL, method returns EFalse.
MAknsControlContext * aContext Control context, or NULL if no context is used. Note that absence of control context affects the result.

IsListSeperatorLines(MAknsSkinInstance *)

IMPORT_C TBool IsListSeperatorLines ( MAknsSkinInstance * aInstance ) [static]

Returns a boolean value indicating whether list separator lines should be drawn.

This method checks:

  • The value of KAknsIIDPropertyListSeparatorLines property.

  • The presence of (non-scalable) column bitmaps. If found, EFalse is returned.

  • The presence of generic list background (non-scalable). If found, EFalse is returned.

Note that the exact internal implementation of the checks is subject to change.

Since
2.8

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns ETrue.

PrepareFrame(MAknsSkinInstance *, const TRect &, const TRect &, const TAknsItemID &, const TAknsItemID &)

IMPORT_C TBool PrepareFrame ( MAknsSkinInstance * aInstance,
const TRect & aOuterRect,
const TRect & aInnerRect,
const TAknsItemID & aFrameID,
const TAknsItemID & aCenterID
) [static]

Prepares the frame graphics for drawing. This function should be called when the frame sizes are known and in places where Flushing the Window server buffer will not cause flicker. For example, a good place to call PrepareFrame() would be controls SizeChanged function. Altough its not mandatory to call PrepareFrame() before DrawFrame() , it's highly recommended in order to avoid unnecessary flushes in the middle of the actual drawing routine.

Note that the rect parameters must be exactly the same for PrepareFrame and subsequent DrawFrame calls. Otherwise the DrawFrame functions will cause a flush, which leads to flicker.

Since
2.8

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns EFalse.
const TRect & aOuterRect Outer rectangle of the frame. Frame elements are scaled to this size.
const TRect & aInnerRect Inner rectangle of the frame. Frame center is scaled to this size
const TAknsItemID & aFrameID Item ID of the entire frame.
const TAknsItemID & aCenterID Item ID of the center part of the frame. If KAknsIIDNone, no center part will be prepared. If KAknsIIDDefault, the default value from the frame itself will be used. Other values, the item to be used for the center part. If the frame is specified as 1 part graphics in the skin instead of 9 part graphics, this parameter has no effect.

SlidingMode(MAknsSkinInstance *)

IMPORT_C TSlidingMode SlidingMode ( MAknsSkinInstance * aInstance ) [static]

Returns an enum value indicating the way notes and queries appear to the screen (sliding animation)

Since
3.1

Parameters

MAknsSkinInstance * aInstance Pointer to the skin instance. If NULL, the method returns ESlidingDisabled.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.