Collapse all Symbian^3 Product Developer Library

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

CEikMenuPaneItem
- CBase

Nested Classes and Structures

CEikMenuPaneItem::SData

Public Member Functions
	CEikMenuPaneItem()
	~CEikMenuPaneItem()
IMPORT_C void	CreateIconL(CFbsBitmap , CFbsBitmap )
IMPORT_C void	DrawItemIcon(CWindowGc &, TRect, TBool, TInt)
IMPORT_C CFbsBitmap *	IconBitmap()
IMPORT_C CFbsBitmap *	IconMask()
IMPORT_C TPtrC	ScaleableText()
IMPORT_C void	SetBitmapsOwnedExternally(TBool)
IMPORT_C void	SetIcon(CGulIcon *)
IMPORT_C void	SetIconBitmapL(CFbsBitmap *)
IMPORT_C void	SetIconMaskL(CFbsBitmap *)
IMPORT_C void	SetScaleableTextL(const TDesC &)

Private Member Functions
void	CreateExtendedDataBlock()
TPtrC	GetNominalText(const TDesC &)
TBool	IsScaleableText(const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Attributes
SData	iData
TInt	iHotKeyCode
TInt	iPos

Private Attributes
CExtendedItemData *	iExtendedData

Constructor & Destructor Documentation

CEikMenuPaneItem()

IMPORT_C

CEikMenuPaneItem

(

)

C++ default constructor.

~CEikMenuPaneItem()

IMPORT_C

~CEikMenuPaneItem

(

)

Destructor.

Member Functions Documentation

CreateExtendedDataBlock()

void

CreateExtendedDataBlock

(

)

[private, inline]

CreateIconL(CFbsBitmap , CFbsBitmap )

IMPORT_C void	CreateIconL	(	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 * aBitmap	Picture bitmap.
CFbsBitmap * aMask	Mask bitmap.

DrawItemIcon(CWindowGc &, TRect, TBool, TInt)

IMPORT_C void	DrawItemIcon	(	CWindowGc &	aGc,
			TRect	aRect,
			TBool	aDimmed,
			TInt	aBitmapSpaceRequired
		)	const

Draws the menu item icon.

Parameters

CWindowGc & aGc	Graphics context to which the icon is drawn.
TRect aRect	Rectangle in which the icon is drawn.
TBool aDimmed	If ETrue the icon is drawn dimmed.
TInt aBitmapSpaceRequired	Length 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 TPtrC

ScaleableText

(

)

const

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

SetBitmapsOwnedExternally(TBool)

IMPORT_C void

SetBitmapsOwnedExternally

(

TBool

aOwnedExternally

)

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

Parameters

TBool aOwnedExternally

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

SetIcon(CGulIcon *)

IMPORT_C void

SetIcon

(

CGulIcon *

aIcon

)

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

Parameters

CGulIcon * aIcon

Menu item icon consisting of a picture bitmap and a mask bitmap.

SetIconBitmapL(CFbsBitmap *)

IMPORT_C void

SetIconBitmapL

(

CFbsBitmap *

aBitmap

)

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

Parameters

CFbsBitmap * aBitmap

Picture bitmap.

SetIconMaskL(CFbsBitmap *)

IMPORT_C void

SetIconMaskL

(

CFbsBitmap *

aMask

)

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

Parameters

CFbsBitmap * aMask

Mask bitmap.

SetScaleableTextL(const TDesC &)

IMPORT_C void

SetScaleableTextL

(

const TDesC &

aText

)

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

Parameters

const TDesC & aText

Scalable 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.

CEikMenuPaneItem Class Reference

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CEikMenuPaneItem()

~CEikMenuPaneItem()

Member Functions Documentation

CreateExtendedDataBlock()

CreateIconL(CFbsBitmap *, CFbsBitmap *)

Parameters

DrawItemIcon(CWindowGc &, TRect, TBool, TInt)

Parameters

GetNominalText(const TDesC &)

Parameters

IconBitmap()

IconMask()

IsScaleableText(const TDesC &)

Parameters

ScaleableText()

SetBitmapsOwnedExternally(TBool)

Parameters

SetIcon(CGulIcon *)

Parameters

SetIconBitmapL(CFbsBitmap *)

Parameters

SetIconMaskL(CFbsBitmap *)

Parameters

SetScaleableTextL(const TDesC &)

Parameters

Member Data Documentation

SData iData

CExtendedItemData * iExtendedData

TInt iHotKeyCode

TInt iPos

CreateIconL(CFbsBitmap , CFbsBitmap )