CEikMenuBarTitle Class Reference

#include <mw/eikmenub.h>

class CEikMenuBarTitle : public CBase

Inherits from

  • CEikMenuBarTitle

    Nested Classes and Structures

    Detailed Description

    The CEikMenuBarTitle class encapsulates the data needed to define a menu bar title and provides some of the functionality required to display the title.

    Since
    ER5U

    Member Attribute Documentation

    iData

    SData iData

    The menu bar title text.

    iPos

    TInt iPos

    The title s position on the menu bar.

    iTitleFlags

    TInt iTitleFlags

    Flags used internally by the menu bar title.

    iWidth

    TInt iWidth

    The title s width.

    Constructor & Destructor Documentation

    CEikMenuBarTitle ( )

    IMPORT_CCEikMenuBarTitle()

    C++ default constructor.

    ~CEikMenuBarTitle ( )

    IMPORT_C~CEikMenuBarTitle()

    Destructor.

    Member Function Documentation

    CalculateBaseLine ( TInt &, TInt & )

    voidCalculateBaseLine(TInt &aBaseLine,
    TInt &aTitleHeight
    )

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

    ParameterDescription
    aBaseLineGets result of baseline.
    aTitleHeightGets result of height.

    CreateIconL ( CFbsBitmap *, CFbsBitmap * )

    IMPORT_C voidCreateIconL(CFbsBitmap *aBitmap,
    CFbsBitmap *aMask
    )

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

    ParameterDescription
    aBitmapBitmap.
    aMaskMask of the bitmap.

    DrawIcon ( CWindowGc &, TRect, TInt )

    IMPORT_C voidDrawIcon(CWindowGc &aGc,
    TRectaRect,
    TIntaLeftMargin
    )const

    Draws the title icon to the graphics context aGc, inside the rect aRect with an offset from the left side of the rectangle of size aLeftMargin.

    ParameterDescription
    aGcWindow graphic context.
    aRectRectangle area.
    aLeftMarginLeft margin.

    ExtraLeftMargin ( )

    TInt ExtraLeftMargin()const

    Gets the value of the extra left margin for the title text which will take into account the width of the title icon.

    Returns: Value of extra left margin.

    IconBitmap ( )

    IMPORT_C CFbsBitmap *IconBitmap()const

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

    Returns: Pointer to the title icon s bitmap.

    IconMask ( )

    IMPORT_C CFbsBitmap *IconMask()const

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

    Returns: Pointer to the title icon s bitmap mask.

    SetBitmapsOwnedExternally ( TBool )

    IMPORT_C voidSetBitmapsOwnedExternally(TBoolaOwnedExternally)

    Sets whether the bitmap and mask are owned externally or not.

    ParameterDescription
    aOwnedExternallyETrue if bitmaps are set as externally owned. EFalse if bitmaps are set as not being externally owned.

    SetIcon ( CGulIcon * )

    IMPORT_C voidSetIcon(CGulIcon *aIcon)

    Sets the title icon.

    ParameterDescription
    aIconThe icon to set.

    SetIconBitmapL ( CFbsBitmap * )

    IMPORT_C voidSetIconBitmapL(CFbsBitmap *aBitmap)

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

    ParameterDescription
    aBitmapBitmap

    SetIconMaskL ( CFbsBitmap * )

    IMPORT_C voidSetIconMaskL(CFbsBitmap *aMask)

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

    ParameterDescription
    aMaskMask of a bitmap.