S60 3rd Edition API Reference: CAknsListBoxBackgroundControlContext Class Reference

CAknsListBoxBackgroundControlContext Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknslistboxbackgroundcontrolcontext.h>

Inherits CAknsBasicBackgroundControlContext.

Detailed Description

Implementation of a control context that provides a layout background with a background bitmap, its layout rectangle, a secondary bitmap that will be tiled in its own layout rectangle and third bitmap for the bottom part with its layout rectangle.

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


Public Member Functions

virtual ~CAknsListBoxBackgroundControlContext ()
 Destructor.
IMPORT_C void SetTiledBitmap (const TAknsItemID &aID)
 Sets the item ID of the tiled bitmap.
IMPORT_C void SetTiledRect (const TRect &aRect)
 Sets the layout rectangle of the tiled bitmap.
IMPORT_C void SetBottomBitmap (const TAknsItemID &aID)
 Sets the item ID of the bottom part bitmap.
IMPORT_C void SetBottomRect (const TRect &aRect)
 Sets the layout rectangle of the bottom part bitmap.
TBool IsCompatibleWithType (const TAknsControlContextType aType) const
 Determines whether this control context is compatible with the given derived type.

Parameters:
aType Type of the derived control context class (one of the values in TAknsControlContextType).
Returns:
ETrue if this control context instance is compatible with the given type (i.e. can be casted to the corresponding concrete class). EFalse otherwise.

TInt UpdateContext ()
 Updates the control context, if necessary.

Static Public Member Functions

static IMPORT_C CAknsListBoxBackgroundControlContext * NewL (const TAknsItemID &aImageID, const TRect &aRect, const TBool aParentAbsolute, const TAknsItemID &aTiledBitmapID, const TRect &aTiledRect)
 Two-phased constructor.

Protected Member Functions

 CAknsListBoxBackgroundControlContext ()
 C++ constructor.
void ConstructL (const TRect &aRect, const TBool aParentAbsolute, const TAknsItemID &aImageID, const TAknsItemID &aTiledBitmapID, const TRect &aTiledRect)
 Symbian 2nd phase constructor.

Protected Attributes

TAknsBackground * iTiledLayout
 Structure for tiled layout.
TAknsBackground * iBottomLayout
 Structure for bottom part layout.

Constructor & Destructor Documentation

virtual CAknsListBoxBackgroundControlContext::~CAknsListBoxBackgroundControlContext (   )  [virtual]
 

Destructor.

CAknsListBoxBackgroundControlContext::CAknsListBoxBackgroundControlContext (   )  [protected]
 

C++ constructor.

Member Function Documentation

void CAknsListBoxBackgroundControlContext::ConstructL ( const TRect &  aRect,
const TBool  aParentAbsolute,
const TAknsItemID &  aImageID,
const TAknsItemID &  aTiledBitmapID,
const TRect &  aTiledRect
)  [protected]
 

Symbian 2nd phase constructor.

TBool CAknsListBoxBackgroundControlContext::IsCompatibleWithType ( const TAknsControlContextType  aType  )  const [virtual]
 

Determines whether this control context is compatible with the given derived type.

Parameters:
aType Type of the derived control context class (one of the values in TAknsControlContextType).
Returns:
ETrue if this control context instance is compatible with the given type (i.e. can be casted to the corresponding concrete class). EFalse otherwise.

Reimplemented from CAknsBasicBackgroundControlContext.

static IMPORT_C CAknsListBoxBackgroundControlContext* CAknsListBoxBackgroundControlContext::NewL ( const TAknsItemID &  aImageID,
const TRect &  aRect,
const TBool  aParentAbsolute,
const TAknsItemID &  aTiledBitmapID,
const TRect &  aTiledRect
)  [static]
 

Two-phased constructor.

Parameters:
aImageID Item ID of the background bitmap.
aRect Rectangle where the bitmap should be laid out.
aParentAbsolute ETrue if parent absolute layout should be used, EFalse otherwise. If a parent absolute layout is used, the parent position must be set and updated using SetParentPos.
aTiledBitmapID Item ID of the second bitmap that will be tiled in another layout rectangle.
aTiledRect Rectangle where the second bitmap should be tiled to.
Returns:
Newly constructed object.
IMPORT_C void CAknsListBoxBackgroundControlContext::SetBottomBitmap ( const TAknsItemID &  aID  ) 
 

Sets the item ID of the bottom part bitmap.

Parameters:
aID Item ID of the bitmap.
IMPORT_C void CAknsListBoxBackgroundControlContext::SetBottomRect ( const TRect &  aRect  ) 
 

Sets the layout rectangle of the bottom part bitmap.

Parameters:
aRect Rectangle where the bitmap should be laid out.
IMPORT_C void CAknsListBoxBackgroundControlContext::SetTiledBitmap ( const TAknsItemID &  aID  ) 
 

Sets the item ID of the tiled bitmap.

Parameters:
aID Item ID of the bitmap.
IMPORT_C void CAknsListBoxBackgroundControlContext::SetTiledRect ( const TRect &  aRect  ) 
 

Sets the layout rectangle of the tiled bitmap.

Parameters:
aRect Rectangle where the bitmap should be laid out.
TInt CAknsListBoxBackgroundControlContext::UpdateContext (   )  [virtual]
 

Updates the control context, if necessary.

This method is called by the framework before drawing with the context.

Implementation in CAknsListBoxBackgroundControlContext disables any non-existing levels.

Returns:
Return value reserved for future use. Currently returns 0.

Reimplemented from MAknsControlContext.

Field Documentation

TAknsBackground* CAknsListBoxBackgroundControlContext::iBottomLayout [protected]
 

Structure for bottom part layout.

TAknsBackground* CAknsListBoxBackgroundControlContext::iTiledLayout [protected]
 

Structure for tiled layout.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top