![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
mtmuibas.h
Link against:
mtur.lib
CBaseMtmUi
Supported from 5.0
Provides MTM-specific user interaction, such as editing, viewing, deleting, and copying of message entries.
Message client applications use the class to access such functionality polymorphically. MTM implementers implement a derived class to provide such functionality for their message protocol.
The base class is largely an interface definition: it implements little important functionality itself. For implementers, this documentation defines conditions that any implementation must fulfil, plus suggested semantics for behaviour. This still leaves many decisions in the hands of the implementer. A key design time activity is to define how the particular characteristics of the implemented protocol are best mapped to the interface. As this class is concerned with user interfaces, implementers should be sensitive to the look and feel of the target devices.
Many functions are required to return an instance of a CMsvOperation-derived class to provide asynchronous control and monitoring to the caller of the operation being performed.
The following are some significant groups of functions:
Entry manipulation functions: OpenL(), CloseL(), EditL(), and ViewL() are all available in two overloaded versions. The first version operates on the current context. The second version operates upon groups of entries specified by a CMsvEntrySelection argument. All entries must be in same folder and all of the correct MTM type. The context may change after calling these functions. Concrete User Interface MTMs can legally ignore any of the entries within the selection—many may, for example, simply open the first entry.
Copying and moving functions: the CopyToL(), CopyFromL(), MoveToL(), and MoveFromL() functions are concerned with copying and moving entries to and from remote servers. MTMs can implement these functions to provide any user interaction needed before copying or moving can proceed, such as dialogs to confirm settings; and, any protocol-specific setup steps that can be done at this stage: for example, a fax MTM could render messages into the required image format.
Progress information functions: DisplayProgressSummary() and GetProgress() convert MTM-specific progress information about some asynchronous operation, such as message sending, to a human-readable form. The progress information to pass into these functions is, in general, obtained from an on-going CMsvOperation by calling CMsvOperation::Progress(). The nature of any information provided is MTM-specific.
MTM-specific UI functions: MTM components can offer protocol-specific functionality not provided by base class interface functions. MTM components define IDs that correspond to each protocol-specific operation offered, and implement the InvokeSyncFunctionL() and InvokeAsyncFunctionL() functions to allow clients to access these operations by passing in the appropriate ID. Two functions are provided to allow the MTM component to offer both synchronous and asynchronous functionality. Message client applications can dynamically add user-interface features for these operations using CBaseMtmUiData::MtmSpecificFunctions(). MTM developers should document the IDs if they wish to make the operations available to clients.
|
Defined in CBaseMtmUi:
Anonymous, BaseMtm(), CBaseMtmUi(), CancelL(), CloseL(), ConstructL(), CopyFromL(), CopyToL(), CreateL(), DeleteFromL(), DeleteServiceL(), DisplayProgressSummary(), EProgressStringMaxLen, EditL(), ForwardL(), GetProgress(), GetResourceFileName(), InvokeAsyncFunctionL(), InvokeSyncFunctionL(), MoveFromL(), MoveToL(), OpenL(), PreferEmbedded(), Preferences(), QueryCapability(), ReplyL(), Session(), SetPreferEmbeddedL(), SetPreferences(), Type(), UnDeleteFromL(), ViewL(), iBaseMtm, iCoeEnv, iFlags, ~CBaseMtmUi()
Inherited from CBase:
operator new()
protected: CBaseMtmUi(CBaseMtm& aBaseMtm, CRegisteredMtmDll& aRegisteredMtmDll);
Initialises member variables from the passed arguments. Client applications do not use this function. It is relevant only to implementers of derived classes.
The value of aBaseMtm is stored in the protected data member iBaseMtm, so it can be accessed by 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.
|
protected: virtual void ConstructL();
Client applications do not use this function. It is relevant only to implementers of derived classes.
Requirements:
Derived classes implement two-phase construction functions (NewL(), ConstructL()) to create a new instance of the object, in which any dynamic allocation should be performed. ConstructL() should be called from the NewL() function of the derived class.
The default implementation of this function loads resources required by the base class. 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.
|
protected: virtual void GetResourceFileName(TFileName& aFileName) const = 0;
Implementations provide this function to set the full path and name of the resource file associated with the User Interface MTM. Client applications do not use this function. It is relevant only to implementers of derived classes.
Requirements:
The function is called by CBaseMtmUi::ConstructL(), which then loads the resource file.
|
virtual ~CBaseMtmUi();
Cleans up the base class. CBaseMtmUi-derived objects must be deleted by client applications when they are no longer required.
Derived classes can implement a destructor to do any additional clean up tasks that they require.
|
void SetPreferEmbeddedL(TBool aEmbedIfPossible);
Withdrawn in 6.0
Requests that any message viewers or editors that are launched, for example when a message is created, are embedded in the calling application.
|
|
TBool PreferEmbedded() const;
Withdrawn in 6.0
Obtains whether launching message viewers and editors embedded in the calling application has been requested (through SetPreferEmbeddedL()).
|
void SetPreferences(TUint aFlags);
Supported from 6.0
Sets flags that communicate the MTM's preferences to the application UI.
|
TUint Preferences() const;
Supported from 6.0
Gets flags that communicate the MTM's preferences to the application UI.
|
|
CBaseMtm& BaseMtm() const;
Gets a reference to the Client-side MTM that requested this object.
|
CMsvSession& Session() const;
Gets a reference to the session object used by the Client-side MTM that requested the User Interface MTM.
|
TUid Type() const;
Gets the Type UID of the message type associated with the User Interface MTM.
|
|
virtual CMsvOperation* CreateL(const TMsvEntry& aEntry, CMsvEntry& aParent, TRequestStatus& aStatus);
Creates a new entry as a child. Typically, after creating the entry, the function would launch a suitable interface, such as a message editor, for the user to edit the new entry.
The returned CMsvOperation object completes when creation is complete (for example, when the message editor application is closed).
Requirements:
The default implementation simply calls aParent.CreateL() to create the entry. If creating entries is not supported, implementations should leave with KErrNotSupported. Otherwise, implementations should:
check aEntry.iType.iUid to ensure that they can create the requested type of entry and leave with code KErrNotSupported if they cannot
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
for messages, launch a suitable editor application developed for the message type.
|
|
|
|
virtual CMsvOperation* OpenL(TRequestStatus& aStatus) = 0;
virtual CMsvOperation* OpenL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection) = 0;
Opens an entry. The behaviour that this implies is dependent on the current context:
for message contexts, OpenL() is the equivalent of EditL(), or for read-only messages, ViewL(). Whether opening of remote messages is allowed is MTM-specific.
for service contexts, the function may initiate a connection to obtain the service contents from the server, completing asynchronously
for remote folder contexts, dependent on implementation, the function may initiate a connection to obtain the folder contents from the server, completing asynchronously
The returned CMsvOperation object completes when opening is complete.
Requirements:
If opening entries is not supported, implementations should leave with KErrNotSupported. Otherwise, implementations should:
check aEntry.iType.iUid to ensure that they can open the requested type of entry and leave with code KErrNotSupported if they cannot
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
for remote messages, typically, copy the messages to the Inbox
|
|
|
virtual CMsvOperation* CloseL(TRequestStatus& aStatus) = 0;
virtual CMsvOperation* CloseL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection) = 0;
Closes an entry. The behaviour that this implies is dependent on the current context:
for message contexts, this usually closes any launched editors or viewers
for folder contexts, leaves with KErrNotSupported
for service contexts, causes closure of a connection to a server
The returned CMsvOperation object completes when closing is complete.
Requirements:
Implementations should:
check aEntry.iType.iUid to ensure that they can close the requested type of entry and leave with code KErrNotSupported if they cannot
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
|
|
|
virtual CMsvOperation* EditL(TRequestStatus& aStatus) = 0;
virtual CMsvOperation* EditL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection) = 0;
Edits an entry. The behaviour that this implies is dependent on the current context:
for message contexts, this usually launches the appropriate message editor, or returns status KErrReadOnly if the message is not editable
for remote folder contexts, launches a settings dialog, for example to rename the folder, completing asynchronously
for service contexts, launches a service settings dialog, completing asynchronously
The returned CMsvOperation object completes when editing is complete.
Requirements:
Implementations should:
check aEntry.iType.iUid to ensure that they can edit the requested type of entry and leave with code KErrNotSupported if they cannot
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
for remote messages, typically, copy the messages to the Inbox
follow the leave protocols described in Leave considerations below
|
|
|
virtual CMsvOperation* ViewL(TRequestStatus& aStatus) = 0;
virtual CMsvOperation* ViewL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection) = 0;
Views an entry. For message contexts, this usually launches the appropriate message viewer. Other context types leave with KErrNotSupported. The returned CMsvOperation object completes when viewing is complete.
Requirements:
Implementations should:
check aEntry.iType.iUid to ensure that they can view the requested type of entry and leave with code KErrNotSupported if they cannot
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
|
|
|
virtual CMsvOperation* CancelL(TRequestStatus& aStatus,
const CMsvEntrySelection& aSelection) = 0;
Supported from 6.0
Cancels the sending of specified messages.
|
|
|
virtual CMsvOperation* DeleteFromL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
Deletes a selection of entries owned by the current context. The current context must be a folder or service of the relevant MTM. The returned CMsvOperation object completes when deleting is complete.
Requirements:
The default implementation simply calls CMsvEntry::DeleteL() to delete the entries. Implementations can override this to provide any additional checking or user interaction. If deleting entries is not supported, implementations should leave with KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
virtual CMsvOperation* UnDeleteFromL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
Supported from 6.0
Undeletes the specified selection.
The default implementation leaves with KErrNotSupported.
|
|
|
virtual CMsvOperation* DeleteServiceL(const TMsvEntry& aService, TRequestStatus& aStatus);
Deletes a specified service entry. This entry does not have to be the current context. The usual behaviour is to remove the service settings, disabling further use of that service. The returned CMsvOperation object completes when deleting is complete.
Requirements:
The default implementation calls CMsvEntry::DeleteL() to delete the entry. Implementations can override this to provide any additional checking or user interaction. If deleting services is not supported, implementations should leave with KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
|
virtual CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartlist, TRequestStatus& aCompletionStatus) = 0;
Creates a reply message to the current message context, and allows the user to edit it through a message-type specific editor. Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the reply. The parent for the new entry is specified in aDestination. The returned CMsvOperation object completes when editing the reply is complete. On completion, the context is set to the reply message.
Requirements:
A typical implementation for this function would include the following steps:
create a new reply entry by calling CBaseMtm::ReplyL()
call EditL() allow the user to edit the reply
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
If message replies are not supported, implementations should leave with KErrNotSupported.
|
|
|
virtual CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus) = 0;
Creates a forwarded message from the current message context, and allows the user to edit it through a message-type specific editor. Some MTMs may support inclusion of elements, specified by aPartlist, from the original message in the forwarded message. The parent for the new entry is specified in aDestination. The returned CMsvOperation object completes when editing the forwarded message is complete. On completion, the context is set to the forwarded message.
Requirements:
A typical implementation for this function would include the following steps:
create a new forwarded message entry by calling CBaseMtm::ForwardL()
call EditL() allow the user to edit the forwarded message
return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation
If forwarded messages are not supported, implementations should leave with KErrNotSupported.
|
|
|
|
The functions in this section are concerned with copying and moving entries to and from remote servers. MTMs can implement these functions to provide:
any user interaction needed before copying or moving can proceed, such as dialogs to confirm settings
any protocol-specific setup steps that can be done at this stage: for example, a fax MTM could render messages into the required image format
virtual CMsvOperation* CopyToL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
Copies an entry selection to a remote service. All entries in the selection must have the same parent. The current context must be the MTM folder or service to which to copy. The returned CMsvOperation object completes when copying the entries is complete.
The usual result of this function is to send messages. It is called by ER5 Email application when the user chooses to send the messages in the Outbox. The exact behaviour varies between MTMs: for example, a Fax MTM would transmit a fax when asked to copy a fax from a local folder to a fax service.
Requirements:
The default implementation calls CMsvEntry::CopyL() to do the copy. If message copying is not supported, implementations should leave with KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
virtual CMsvOperation* MoveToL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
Moves an entry selection to a remote service. All entries in the selection must have the same parent. The current context must be the MTM folder or service to which to move the entries. The returned CMsvOperation object completes when moving the entries is complete.
The usual result of this function is to send messages, in a similar way to CopyToL(). The difference is that CopyToL() does not remove the original entries. The function is called by ER5 Email application when the user cuts a message and pastes it to a remote destination.
The exact behaviour varies between MTMs, as described for CopyToL().
Requirements:
The default implementation calls CMsvEntry::MoveL() to do the move. Implementations are likely to be similar to those for CopyToL(), and may indeed share code.
If an MTM does not support message moving, then it should leave with value KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
virtual CMsvOperation* CopyFromL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus);
Copies an entry selection from a remote service. All entries in the selection must have the same parent. The current context must be the MTM folder or service from which to copy. The returned CMsvOperation object completes when copying the entries is complete.
The usual result of this function is to get messages. It is called when the user copies and pastes messages from a remote service. The exact behaviour varies between MTMs.
Requirements:
The default implementation calls CMsvEntry::CopyL() to do the copy. If message copying is not supported, implementations should leave with KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
virtual CMsvOperation* MoveFromL(const CMsvEntrySelection& aSelection, TMsvId aTargetId, TRequestStatus& aStatus);
Moves an entry selection from a remote service. All entries in the selection must have the same parent. The current context must be the MTM folder or service from which to move. The returned CMsvOperation object completes when moving the entries is complete.
The usual result of this function is to get messages, in a similar way to CopyFromL(). The difference is that CopyFromL() does not remove the original entries. The function is called by ER5 Email application when the user chooses the Move to Inbox command.
Requirements:
The default implementation calls CMsvEntry::MoveL() to do the move. Implementations are likely to be similar to those for CopyToL(), and may indeed share code.
If an MTM does not support message moving, then it should leave with value KErrNotSupported.
Where this function is implemented, it should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
|
virtual TInt DisplayProgressSummary(const TDesC8& aProgress) const;
Displays a message describing the progress of an operation.
Requirements:
The default implementation simply returns KErrNotSupported.
Implementations should unpack the passed aProgress buffer, construct from this a suitable message, and display it. The implementation of this function should share an understanding of the format of the buffer with the implementations of CMsvOperation-derived classes.
|
|
virtual TInt GetProgress(const TDesC8& aProgress,
TBuf<EProgressStringMaxLen>& aReturnString,
TInt& aTotalEntryCount, TInt& aEntriesDone,
TInt& aCurrentEntrySize, TInt& aCurrentBytesTrans) const;
Obtains progress information description and statistics. A message client application can then display this information to the user.
Requirements:
The default implementation returns KErrNotSupported.
Implementations should unpack the passed aProgress buffer, and fill in the return values appropriately. The implementation of this function should share an understanding of the format of the buffer with the implementations of CMsvOperation-derived classes.
|
|
|
virtual TInt QueryCapability(TUid aCapability, TInt& aResponse);
Queries if the MTM supports a particular capability, specified by a UID. For MTM-specific UIDs, see the documentation for the relevant MTM.
Requirements:
The default implementation calls iBaseMtm->QueryCapability() (i.e. the corresponding function on the Client-side MTM) to do the query. This is sufficient for many implementations.
However, it is expected that each MTM-specific function is indicated by a capability. For example, if the MTM supports a function with UID KMtmUiMessagingXYZ, then there might be a capability KMtmUiQueryMessagingXYZ. Therefore, if different MTM-specific functions are supported by a User Interface MTM and by the corresponding Client-side MTM, this function should be implemented to reflect this.
|
|
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
InvokeAsyncFunctionL()InvokeSyncFunctionL()
|
virtual CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TRequestStatus& aCompletionStatus, TDes8& aParameter);
Invokes asynchronous protocol-specific operations. For synchronous operations, a similar function, InvokeSyncFunctionL(), is available.
aSelection and aParameter allow data to be passed to the operation. The TRequestStatus and CMsvOperation objects are used as normal to control and monitor the operation.
Requirements:
The default implementation calls the corresponding function on the Client-side MTM (through iBaseMtm). This is sufficient for many implementations. However, there may be certain MTM-specific functions which require interaction with the user. These should be implemented here.
InvokeAsyncFunctionL() should return a CMsvOperation-derived object to provide asynchronous control and monitoring of the operation.
|
|
|
virtual void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter);
Invokes synchronous protocol-specific operations. For asynchronous operations, a similar function, InvokeAsyncFunctionL(), is available.
aSelection and aParameter allow data to be passed to the operation.
Requirements:
The default implementation calls the corresponding function on the Client-side MTM (through iBaseMtm). This is sufficient for many implementations. However, there may be certain MTM-specific functions which require interaction with the user. These should be implemented here.
|
|
|
CBaseMtm& iBaseMtm
The CBaseMtm-derived object (Client-side MTM) that requested the User Interface MTM. It is set by the constructor.
TInt iFlags
Withdrawn in 6.0
This flag records the embedding preference as set by SetPreferEmbeddedL(). It is set to EMtmUiFlagPreferEmbedded when embedding is preferred.
TUint iFlags
Supported from 6.0
This flag records the preferences as set by SetPreferences().
|
Anonymous
Progress information buffer length.
|
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up.gif){kind=icon}