| class CBaseMtmUiData::TMtmUiFunction |
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.
| Public Member Functions | |
|---|---|
| TMtmUiFunction(TResourceReader &) | |
| TMtmUiFunction(const TMtmUiFunction &) | |
| Private Member Functions | |
|---|---|
| void | SetModifiersFromResourceDefinition(TInt) |
| Public Member Enumerations | |
|---|---|
| enum | anonymous { ECaptionMaxLen = 40 } |
| Public Attributes | |
|---|---|
| TBuf< ECaptionMaxLen > | iCaption |
| TInt | iFlags |
| TInt | iFunctionId |
| TUint8 | iFunctionType |
| TInt | iPreferredHotKeyKeyCode |
| TInt | iPreferredHotKeyModifiers |
| IMPORT_C | TMtmUiFunction | ( | 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.
| TResourceReader & aResourceReader | Position in UI Data MTM resource file to read operation |
| IMPORT_C | TMtmUiFunction | ( | 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.
| const TMtmUiFunction & aFunc | TMtmUiFunction to copy |
| void | SetModifiersFromResourceDefinition | ( | TInt | aResourceFileModifiers | ) | [private] |
| TInt aResourceFileModifiers |
Enum to define UI Data base class constants.
| ECaptionMaxLen = 40 |
Maximum length for operation caption. Used in defining iCaption. |
| TBuf< ECaptionMaxLen > | iCaption |
String, suitable for a menu, describing the operation.
| TInt | iPreferredHotKeyKeyCode |
Character code for a suggested hotkey for the operation.
| TInt | iPreferredHotKeyModifiers |
Suggested key modifiers for the hotkey.
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.