CEikMenuPaneItem Class Reference

#include <mw/eikmenup.h>

class CEikMenuPaneItem : public CBase

Inherits from

  • CEikMenuPaneItem

    Nested Classes and Structures

    Public Attributes
    SData iData
    TInt iHotKeyCode
    TInt iPos
    Public Member Functions
    CEikMenuPaneItem()
    ~CEikMenuPaneItem()
    IMPORT_C voidCreateIconL(CFbsBitmap *, CFbsBitmap *)
    IMPORT_C voidDrawItemIcon(CWindowGc &, TRect, TBool, TInt)
    IMPORT_C CFbsBitmap *IconBitmap()
    IMPORT_C CFbsBitmap *IconMask()
    IMPORT_C TPtrCScaleableText()
    IMPORT_C voidSetBitmapsOwnedExternally(TBool)
    IMPORT_C voidSetIcon(CGulIcon *)
    IMPORT_C voidSetIconBitmapL(CFbsBitmap *)
    IMPORT_C voidSetIconMaskL(CFbsBitmap *)
    IMPORT_C voidSetScaleableTextL(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()

    Detailed Description

    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

    Member Attribute Documentation

    iData

    SData iData

    Information from an SData struct.

    iHotKeyCode

    TInt iHotKeyCode

    The menu pane item's hotkey text.

    iPos

    TInt iPos

    The y position of the menu pane item.

    Constructor & Destructor Documentation

    CEikMenuPaneItem ( )

    IMPORT_CCEikMenuPaneItem()

    C++ default constructor.

    ~CEikMenuPaneItem ( )

    IMPORT_C~CEikMenuPaneItem()

    Destructor.

    Member Function Documentation

    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.

    ParameterDescription
    aBitmapPicture bitmap.
    aMaskMask bitmap.

    DrawItemIcon ( CWindowGc &, TRect, TBool, TInt )

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

    Draws the menu item icon.

    ParameterDescription
    aGcGraphics context to which the icon is drawn.
    aRectRectangle in which the icon is drawn.
    aDimmedIf ETrue the icon is drawn dimmed.
    aBitmapSpaceRequiredLength of one side of the square required to contain the bitmap.

    IconBitmap ( )

    IMPORT_C CFbsBitmap *IconBitmap()const

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

    Returns: Picture bitmap.

    IconMask ( )

    IMPORT_C CFbsBitmap *IconMask()const

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

    Returns: Mask bitmap.

    ScaleableText ( )

    IMPORT_C TPtrCScaleableText()const

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

    Returns: Pointer to TPtrC object that contains scaleable text.

    SetBitmapsOwnedExternally ( TBool )

    IMPORT_C voidSetBitmapsOwnedExternally(TBoolaOwnedExternally)

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

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

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

    ParameterDescription
    aBitmapPicture bitmap.

    SetIconMaskL ( CFbsBitmap * )

    IMPORT_C voidSetIconMaskL(CFbsBitmap *aMask)

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

    ParameterDescription
    aMaskMask bitmap.

    SetScaleableTextL ( const TDesC & )

    IMPORT_C voidSetScaleableTextL(const TDesC &aText)

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

    ParameterDescription
    aTextScalable text.
    © Nokia 2011.