CBaseMtmUiData::TMtmUiFunction Class Reference

#include <mw/mtudcbas.h>

Link against: mtur.lib

class CBaseMtmUiData::TMtmUiFunction
Public Attributes
TBuf< ECaptionMaxLen >iCaption
TInt iFlags
TInt iFunctionId
TUint8 iFunctionType
TInt iPreferredHotKeyKeyCode
TInt iPreferredHotKeyModifiers
Public Member Enumerations
enumanonymous { ECaptionMaxLen }
Public Member Functions
TMtmUiFunction(TResourceReader &)
TMtmUiFunction(const TMtmUiFunction &)

Detailed Description

Provides the interface for clients to access MTM-specific functions, and present these functions to the user. A message client application can use this information to customise the UI.

The class encapsulates information relating to an MTM-specific operation:

1. human-readable name: for display on the UI

2. ID: used to invoke the operation through the CBaseMtmUi::InvokeSyncFunctionL()/InvokeAsyncFunctionL() functions on the associated User Interface MTM

3. a suggested hot-key that the UI should support for the operation

4. flags that describe further operation characteristics.

Member Attribute Documentation

iCaption

TBuf< ECaptionMaxLen >iCaption

String, suitable for a menu, describing the operation.

iFlags

TInt iFlags

Flags setting characteristics of the operation.

iFunctionId

TInt iFunctionId

The ID that can be used to invoke the operation.

iFunctionType

TUint8 iFunctionType

Flags setting location characteristics of the operation.

iPreferredHotKeyKeyCode

TInt iPreferredHotKeyKeyCode

Character code for a suggested hotkey for the operation.

iPreferredHotKeyModifiers

TInt iPreferredHotKeyModifiers

Suggested key modifiers for the hotkey.

Member Enumeration Documentation

Enum anonymous

Enum to define UI Data base class constants.

EnumeratorValueDescription
ECaptionMaxLen40

Maximum length for operation caption. Used in defining iCaption.

Constructor & Destructor Documentation

TMtmUiFunction ( TResourceReader & )

IMPORT_CTMtmUiFunction(TResourceReader &aResourceReader)

Creates a TMtmUiFunction with its values read from the resource file location specified by TResourceReader. This position should be at a MTUD_FUNCTION resource.

Parameters
aResourceReaderPosition in UI Data MTM resource file to read operation

TMtmUiFunction ( const TMtmUiFunction & )

IMPORT_CTMtmUiFunction(const TMtmUiFunction &aFunc)

Copy constructor.

Creates a TMtmUiFunction by copying another TMtmUiFunction. Its action is the same as the default copy constructor, except that it will panic in debug builds if multiple location flags are set in aFunc.

Parameters
aFuncTMtmUiFunction to copy
© Nokia 2005.