Constructor.

This creates a CBaseMtmUiData and initialises its private member variables. Client applications do not use this function. It is relevant only to implementers of derived classes.

Derived classes can implement a constructor to perform any additional MTM-specific setup that can be safely carried out in a constructor. Such constructors must call the base class constructor function.

Destructor.

This cleans up the base class. CBaseMtmUiData-derived objects must be deleted by client applications when they are no longer required. Clean up includes:

1. cleaning up the iIconArrays and iMtmSpecificFunctions

2. unloading the UI Data MTM resource file

Derived classes can implement a destructor to do any additional clean up tasks that they require.

Tests if the current operation on the entry can be cancelled.

Tests if a close operation is supported.

Tests whether a copy from or move from operation is supported.

Tests if a copy from or move to operation is supported.

Tests if an entry can be created as a child.

Tests if a delete operation is supported.

Tests if the service entry can be deleted.

Tests if the entry can be edited.

Tests if an entry can be forwarded.

Tests if an entry can be opened.

Tests if an entry can be replied to.

Tests if the entry can be undeleted.

Tests if the entry can be undeleted.

Tests if an entry can be viewed.

Second-phase constructor.

This implements two-phase construction functions (NewL(), ConstructL() ) to create a new instance of the object. Client applications do not use this function. It is relevant only to implementers of derived classes.

The function should perform any necessary dynamic allocation. ConstructL() should be called from the NewL() function of the derived class.

The default implementation of this function initiates the loading of required resources:

1. instantiates objects for the iIconArrays and iMtmSpecificFunctions protected members

2. loads the UI Data MTM's resource file, as specified by GetResourceFileName()

3. calls PopulateArraysL() so that the derived class can load resources

Derived classes can implement this function to perform any additional MTM-specific second stage construction tasks that they require. Implementations must call the base class ConstructL() function.

Concrete MTMs must also implement a factory function by which a MTM registry can request an instance of the class:

MtmUiDataFactoryFunctionL

Gets an array of bitmaps relevant to the passed context entry.

The bitmaps within the array should be representations of the same bitmap at various sizes.

The aStateFlags argument indicates the user interface state, for example, "open", of the entry.

Requirements:

Implementations should check the type of the context, using TMsvEntry::iType::iUid, and the passed state, and return an appropriate bitmap array.

Fills the iIconArrays array with icon bitmaps from an mbm file.

Client applications do not use this function. It is relevant only to implementers of derived classes.

The bitmaps to load must be contiguous within the file between the positions indicated by aStartBitmap and aEndBitmap.

The function is typically called from PopulateArraysL() .

Tests if an operation with the specified ID is recognised by the UI Data MTM.

Implementers should note that this function searches the iMtmSpecificFunctions array for the aFunctionId.

Returns a pointer to the interface with the specified Uid.

This method is the first part of an extension pattern to allow for more functionality to be supported without adding virtual methods to this base class.

The default implementation returns a NULL pointer.

Gets the resource file name.

Client applications do not use this function. It is relevant only to implementers of derived classes.

Requirements:

Each UI Data MTM can have a resource file associated with it. Implementations should set aFilename to the full path and name of this resource file. The function is called by CBaseMtmUiData::ConstructL() , which then loads the resource file.

Gets an array of MTM-specific operations that can be carried out through the associated User Interface MTM's CBaseMtmUi::InvokeSyncFunctionL() /InvokeAsyncFunctionL() functions.

It is intended that message client applications will use this function to add dynamically user interface features, such as menu items, dependent on the MTM type of the entry currently selected within the application. Message client applications can also use OperationSupportedL() to check dynamically if a particular operation is appropriate to a particular entry.

Implementers should note that this function returns a pointer to the iMtmSpecificFunctions data member.

Tests if an MTM-specific operation is appropriate to the specified entry. The operation specified must have been obtained from a call to MtmSpecificFunctions() .

It is intended that client applications will use this function to select dynamically the MTM-specific user interface features available dependent on the entry currently selected within the application.

Requirements:

Implementations should check the type of the context, using TMsvEntry::iType::iUid, and use any other information required available from the context, to determine if the operation is supported.

Initialises bitmaps and function information.

Client applications do not use this function. It is relevant only to implementers of derived classes.

Requirements:

This function is called by the base class ConstructL() function. Implementations should provide this function to:

1. insert MTM-specific icon bitmap arrays into the iIconArrays array data member

2. insert MTM-specific operation information into the iMtmSpecificFunctions array data member

Queries if the MTM supports a particular capability, specified by a UID.

Requirements:

Implementations should check aCapability for the standard capability values and return a suitable response in aResponse. If aFunctionId is unknown, return KErrNotSupported.

Fills the iMtmSpecificFunctions array with MTM-specific operation definitions from the UI Data MTM's resource file.

Client applications do not use this function. It is relevant only to implementers of derived classes.

For each MTM-specific operation definition in the resource file, it adds a corresponding TMtmUiFunction object to iMtmSpecificFunctions.

The function is typically called from PopulateArraysL() .

Provides status text for the sending state of the entry.

Gets the Type UID of the message type associated with the UI Data MTM.

Defines an array of icon bitmaps for the UI Data MTM.

It is used in the definition of CBaseMtmUiData::iIconArrays .

Control environment object. It is set by the constructor.

The array that stores the arrays of icon bitmaps for the UI Data MTM. Items are added to the array by PopulateArraysL() .

The array that stores MTM-specific function information for the UI Data MTM. Items are added to the array by ReadFunctionsFromResourceFileL() .