CEikMenuPaneItem Class Reference

class CEikMenuPaneItem : public CBase

The CEikMenuPaneItem class encapsulates the data needed to define a menu pane item and provides some of the functionality required to display the item.

Since
ER5U

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CEikMenuPaneItem()

IMPORT_CCEikMenuPaneItem()

C++ default constructor.

~CEikMenuPaneItem()

IMPORT_C~CEikMenuPaneItem()

Destructor.

Member Functions Documentation

CreateExtendedDataBlock()

voidCreateExtendedDataBlock()[private, inline]

CreateIconL(CFbsBitmap *, CFbsBitmap *)

IMPORT_C voidCreateIconL(CFbsBitmap *aBitmap,
CFbsBitmap *aMask
)

Construct an icon from bitmaps.

Constructs a new icon for the menu item, taking ownership of the picture bitmap aBitmap and the mask bitmap aMask unless the bitmaps are externally owned.

Parameters

CFbsBitmap * aBitmapPicture bitmap.
CFbsBitmap * aMaskMask bitmap.

DrawItemIcon(CWindowGc &, TRect, TBool, TInt)

IMPORT_C voidDrawItemIcon(CWindowGc &aGc,
TRectaRect,
TBoolaDimmed,
TIntaBitmapSpaceRequired
)const

Draws the menu item icon.

Parameters

CWindowGc & aGcGraphics context to which the icon is drawn.
TRect aRectRectangle in which the icon is drawn.
TBool aDimmedIf ETrue the icon is drawn dimmed.
TInt aBitmapSpaceRequiredLength of one side of the square required to contain the bitmap.

GetNominalText(const TDesC &)

TPtrC GetNominalText(const TDesC &aText)[private]

Parameters

const TDesC & aText

IconBitmap()

IMPORT_C CFbsBitmap *IconBitmap()const

Gets a pointer to the menu item's icon picture bitmap. This does not imply transfer of ownership.

IconMask()

IMPORT_C CFbsBitmap *IconMask()const

Gets a pointer to the menu item's icon mask bitmap. This does not imply transfer of ownership.

IsScaleableText(const TDesC &)

TBool IsScaleableText(const TDesC &aText)const [private, inline]

Parameters

const TDesC & aText

ScaleableText()

IMPORT_C TPtrCScaleableText()const

Returns scaleable text. If there isn't scaleable text available then this method returns iData.iText.

SetBitmapsOwnedExternally(TBool)

IMPORT_C voidSetBitmapsOwnedExternally(TBoolaOwnedExternally)

Sets icon bitmap ownership. Sets the menu item's icon bitmaps as externally owned if aOwnedExternally is ETrue.

Parameters

TBool aOwnedExternallyIf ETrue bitmaps are set as externally owned. If EFalse bitmaps are set as not being externally owned.

SetIcon(CGulIcon *)

IMPORT_C voidSetIcon(CGulIcon *aIcon)

Sets a menu item icon. This replaces any icon already set for the menu item.

Parameters

CGulIcon * aIconMenu item icon consisting of a picture bitmap and a mask bitmap.

SetIconBitmapL(CFbsBitmap *)

IMPORT_C voidSetIconBitmapL(CFbsBitmap *aBitmap)

Sets the picture bitmap. Transfers ownership unless the bitmaps are already owned externally.

Parameters

CFbsBitmap * aBitmapPicture bitmap.

SetIconMaskL(CFbsBitmap *)

IMPORT_C voidSetIconMaskL(CFbsBitmap *aMask)

Sets the mask bitmap. Transfers ownership unless the bitmaps are already owned externally.

Parameters

CFbsBitmap * aMaskMask bitmap.

SetScaleableTextL(const TDesC &)

IMPORT_C voidSetScaleableTextL(const TDesC &aText)

Sets scaleable text. iData.iText is set to first text version.

Parameters

const TDesC & aTextScalable text.

Member Data Documentation

SData iData

SData iData

Information from an SData struct.

CExtendedItemData * iExtendedData

CExtendedItemData *iExtendedData[private]

TInt iHotKeyCode

TInt iHotKeyCode

The menu pane item's hotkey text.

TInt iPos

TInt iPos

The y position of the menu pane item.