Class CEikMenuBarTitle

CEikMenuBarTitle

Support

Supported from 6.0

Description

Defines a menu bar title and provides some of the functionality required to display it.

Derivation

CBase Base class for all classes to be instantiated on the heap CEikMenuBarTitle Defines a menu bar title and provides some of the functionality required to display it

Defined in CEikMenuBarTitle:
CEikMenuBarTitle(), CalculateBaseLineOffset(), CreateIconL(), IconBitmap(), IconMask(), SData, SetBitmapsOwnedExternally(), SetIcon(), SetIconBitmapL(), SetIconMaskL(), SetIconOwnedExternally, iData, iPos, iTitleFlags, iWidth, ~CEikMenuBarTitle()

Inherited from CBase:
operator new()

CEikMenuBarTitle();

Description

Constructor. Constructs a menu bar title.

~CEikMenuBarTitle();

Description

Destructor.

void CalculateBaseLineOffset(TInt& aBaseLine);

Description

Sets the value of the title text baseline offset to take into account the size of any title icon.

Parameters

TInt& aBaseLine Title text baseline offset.

void CreateIconL(CFbsBitmap* aBitmap, CFbsBitmap* aMask);

Description

Constructs a new icon for the title, taking ownership of the picture bitmap and the mask bitmap unless they are externally owned.

Parameters

CFbsBitmap* aBitmap The bitmap. CFbsBitmap* aMask The bitmap mask.

CFbsBitmap* IconBitmap() const;

Description

Gets a pointer to the title icon’s bitmap. Does not imply transfer of ownership.

Return value

CFbsBitmap* Pointer to the title icon’s bitmap.

CFbsBitmap* IconMask() const;

Description

Gets a pointer to the title icon’s bitmap mask. Does not imply transfer of ownership.

Return value

CFbsBitmap* Pointer to the title icon’s bitmap mask.

void SetBitmapsOwnedExternally(TBool aOwnedExternally);

Description

Sets external ownership of the title icon’s bitmaps.

Parameters

TBool aOwnedExternally If ETrue title icon bitmaps are set as externally owned. If EFalse title icon bitmaps are set as not being externally owned.

void SetIconOwnedExternally(TBool aOwnedExternally);

Description

Sets external ownership of the title icon.

Parameters

TBool aOwnedExternally If ETrue the icon is set as externally owned. If EFalse the icon is set as not being externally owned.

void SetIcon(CGulIcon* aIcon);

Description

Sets the title icon.

Parameters

CGulIcon* aIcon The icon to set.

void SetIconBitmapL(CFbsBitmap* aBitmap);

Description

Sets the bitmap for the icon. Transfers ownership unless the bitmaps are owned externally.

Parameters

CFbsBitmap* aBitmap The bitmap to use in the icon.

void SetIconMaskL(CFbsBitmap* aMask);

Description

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

Parameters

CFbsBitmap* aMask The bitmap mask to use in the icon.

SData

Description

Defines a menu bar. See also MEikMenuObserver::DynInitMenuPaneL().

See also MENU_TITLE for details of the resource interface to menu items.

Defined in CEikMenuBarTitle::SData:
iMenuPaneResourceId, iText

---

Description

Nominal text length (see iText below).

Defined in CEikMenuBarTitle::SData:::

iMenuPaneResourceId

---

TInt iMenuPaneResourceId

Description

The resource ID from which the menu pane is constructed.

iText

---

TBuf<ENominalTextLength> iText

Description

The text to display on the menu pane.

Description

Defines various title attributes.

SData iData

Description

The menu bar title text.

TInt iPos

Description

The title’s position on the menu bar.

TInt iTitleFlags

Description

Flags used internally by the menu bar title.

TInt iWidth

Description

The title’s width.