#include <mw/mtudcbas.h>
Link against: mtur.lib
class CBaseMtmUiData : public CBase, public CBase |
Public Member Type Definitions | |
---|---|
typedef | CArrayPtr< CFbsBitmap > CBitmapArray |
Protected Attributes | |
---|---|
CCoeEnv * | iCoeEnv |
CArrayPtr< CBitmapArray > * | iIconArrays |
CArrayFix< TMtmUiFunction > * | iMtmSpecificFunctions |
Protected Member Functions | |
---|---|
CBaseMtmUiData(CRegisteredMtmDll &) | |
IMPORT_C void | ConstructL() |
CFbsBitmap * | CreateBitmapL(const TDesC &, TInt) |
IMPORT_C void | CreateBitmapsL(TInt, const TDesC &, TInt, TInt) |
virtual IMPORT_C TAny * | GetInterface(TUid) |
pure virtual void | GetResourceFileName(TFileName &) |
pure virtual void | PopulateArraysL() |
IMPORT_C void | ReadFunctionsFromResourceFileL(TInt) |
Base class for UI Data MTM components.
CBaseMtmUiData-derived classes allow message client applications to customise dynamically their user interfaces for a particular message type. For example, if a message client application currently had a fax entry selected, then it could use the fax MTM's concrete class to get information on the menus and icons that it should display.
Specifically, functionality falls into the following three areas:
1. supplying MTM-specific icons for Message Server entries
2. supplying user interface text, e.g. for menus, for MTM-specific operations
3. providing checks that MTM functions are suitable for use on an entry. It is intended that client applications will use these functions to select dynamically the user interface features available dependent on the entry currently selected within the application. For example, menu items that do not apply to particular entries could be greyed out. Note that OperationSupportedL() performs a similar function for MTM-specific functions. Implementations should determine if the operation is supported by checking the properties of the entry, such as its type. If the operation is not appropriate on the entry, then the aReasonResourceId argument is set to the ID of a string in the UI Data MTM's resource file that explains why not. Otherwise, aReasonResourceId is 0.
Message client applications use the class to access such functionality polymorphically. MTM implementers implement this class to provide such functionality for their message protocol.
typedef CArrayPtr< CFbsBitmap > | CBitmapArray |
Defines an array of icon bitmaps for the UI Data MTM.
It is used in the definition of CBaseMtmUiData::iIconArrays.
CArrayPtr< CBitmapArray > * | iIconArrays | [protected] |
The array that stores the arrays of icon bitmaps for the UI Data MTM. Items are added to the array by PopulateArraysL().
CArrayFix< TMtmUiFunction > * | iMtmSpecificFunctions | [protected] |
The array that stores MTM-specific function information for the UI Data MTM. Items are added to the array by ReadFunctionsFromResourceFileL().
IMPORT_C | CBaseMtmUiData | ( | CRegisteredMtmDll & | aRegisteredMtmDll | ) | [protected] |
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.
Parameters | |
---|---|
aRegisteredMtmDll | Registration data for the DLL. |
IMPORT_C | ~CBaseMtmUiData | ( | ) | [virtual] |
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.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID, or 0 if operation is supported. |
Tests if a close operation is supported.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID, or 0 if operation is supported. |
TBool | CanCopyMoveFromEntryL | ( | const TMsvEntry & | aContext, |
TInt & | aReasonResourceId | |||
) | const [pure virtual] |
Tests whether a copy from or move from operation is supported.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if a copy from or move to operation is supported.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
TBool | CanCreateEntryL | ( | const TMsvEntry & | aParent, |
TMsvEntry & | aNewEntry, | |||
TInt & | aReasonResourceId | |||
) | const [pure virtual] |
Tests if an entry can be created as a child.
Parameters | |
---|---|
aParent | The entry under which aNewEntry should be created. |
aNewEntry | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if a delete operation is supported.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if the service entry can be deleted.
Parameters | |
---|---|
aService | The service entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if the entry can be edited.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if an entry can be forwarded.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if an entry can be opened.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if an entry can be replied to.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
IMPORT_C TBool | CanUnDeleteFromEntryL | ( | const TMsvEntry & | aContext, |
TInt & | aReasonResourceId | |||
) | const [virtual] |
Tests if the entry can be undeleted.
Tests if the entry can be undeleted.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
Tests if an entry can be viewed.
Parameters | |
---|---|
aContext | The entry to which the operation applies. |
aReasonResourceId | On return, a resource string ID or 0. |
IMPORT_C void | ConstructL | ( | ) | [protected] |
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:
See also: MtmUiDataFactoryFunctionL
const CBitmapArray & | ContextIcon | ( | const TMsvEntry & | aContext, |
TInt | aStateFlags | |||
) | const [pure virtual] |
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.
Parameters | |
---|---|
aContext | Context entry to return the icons for. |
aStateFlags | Flasgs indicating the user interface state of the entry. |
CFbsBitmap * | CreateBitmapL | ( | const TDesC & | aFileName, |
TInt | aId | |||
) | const [protected] |
IMPORT_C void | CreateBitmapsL | ( | TInt | aNumZoomStates, |
const TDesC & | aBitmapFile, | |||
TInt | aStartBitmap, | |||
TInt | aEndBitmap | |||
) | [protected] |
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().
Parameters | |
---|---|
aNumZoomStates | Number of zoom states for each icon. This is used as the array size of each element in iIconArrays. |
aBitmapFile | Filename of .mbm format bitmap array file. |
aStartBitmap | First bitmap within the file for this MTM. |
aEndBitmap | Final bitmap within the file for this MTM. |
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.
Parameters | |
---|---|
aFunctionId | The operation to check |
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.
Parameters | |
---|---|
aUid | Uid of the extension interface |
void | GetResourceFileName | ( | TFileName & | aFileName | ) | const [protected, pure virtual] |
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.
Parameters | |
---|---|
aFileName | Filename buffer to be filled with the resource file path and name |
IMPORT_C const CArrayFix< TMtmUiFunction > & | MtmSpecificFunctions | ( | ) | const |
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.
Parameters | |
---|---|
aOperationId | ID of operation to query. |
aContext | The entry to which the operation applies. |
void | PopulateArraysL | ( | ) | [protected, pure virtual] |
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.
Parameters | |
---|---|
aFunctionId | UID of capability to be queried |
aResponse | Response value. The format of the response varies according to the capability. |
IMPORT_C void | ReadFunctionsFromResourceFileL | ( | TInt | aResourceId | ) | [protected] |
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().
Parameters | |
---|---|
aResourceId | Resource ID of MTM-specific operation definition array |
IMPORT_C TUid | Type | ( | ) | const |
Gets the Type UID of the message type associated with the UI Data MTM.