EPOC   SDK Home Glossary Indexes Previous Next Up

Constants


Contents


Capability constants

The standard messaging capabilities allow clients to check dynamically the characteristics of an MTM. Many capabilities, such as whether the message type has a subject field, are simply supported or not. For some other capabilities, further information is available: for example, the maximum size of a message. In these cases, the type of this information is given in the Return type column of the following tables.

General capabilities

The messaging capability UIDs are as follows. The UIDs are defined as macros in mtmuids.h. Specific return type values are defined in mtmdef.hrh.

UID

Operation / capability

Return type

KUidMsvMtmQueryEditorUid

UID of default message editor

TUid

KUidMtmQueryCanReceiveMsg

Receive message

no return value

KUidMtmQueryCanSendMsg

Send message

no return value

KUidMtmQueryMaxBodySize

Maximum message body size

TInt

KUidMtmQueryMaxRecipientCount

Maximum number of recipients (-1 indicates unlimited numbers)

TInt

KUidMtmQueryMaxTotalMsgSize

Maximum total size of message

TInt

KUidMtmQueryOffLineAllowed

Off-line operation allowed

no return value

KUidMtmQuerySendAsRenderingUid

Printer driver UID for rendering the fax image

TUid

KUidMtmQuerySendAsRequiresRenderedImage

When using the MTM in Send-As, does a rendered image have to be prepared (i.e.fax)

TBool

KUidMtmQuerySupportAttachments

Are attachments supported

no return value

KUidMtmQuerySupportedBody

Character widths supported by message type (returned TInt is the sum of the appropriate values)

KMtm8BitBody (0x0002)
KMtm7BitBody (0x0001)
KMtm16BitBody (0x0004)

KUidMtmQuerySupportsFolder

Does the MTM support folders

no return value

KUidMtmQuerySupportSubject

Does the MTM message type have a subject field

no return value

UI Capabilities

The messaging capability UIDs are only intended for use by User Interface and UI Data MTMs. The UIDs are defined as macros in mtmuidef.h.

UID

Operation / capability

Return type

KUidMsvMtmUiQueryCanPrintMsgValue

Does the MTM support printing of messages through a KMtmUiFunctionPrint operation

no return value

KUidMsvMtmUiQueryCanPrintPreviewMsgValue

Does the MTM support print previewing of messages through a KMtmUiFunctionPrintPreview operation

no return value

KUidMsvMtmUiQueryConnectionOrientedServices

For Email, indicates whether services belonging to this MTM should be added to the Transfer/Open menu.

no return value

KUidMsvMtmUiQueryMessagingInitialisation

Indicates whether a special setup step needs to be taken on the first time of execution of Email. If so, Email initialisation calls the KMtmUiMessagingInitialisation operation on the MTM through the User Interface MTM InvokeSyncFunctionL() function.

no return value


Entry type constants

The following values are used for defining the entry type in TMsvEntry::iType members. They are defined as global const TUid variables in msvuids.h.

UID

Description

KUidMsvRootEntry

Root entry of entire index

KUidMsvServiceEntry

Service

KUidMsvFolderEntry

Folder

KUidMsvMessageEntry

Message

KUidMsvAttachmentEntry

Entry


Message part constants

The following constants are used to define message parts in a TMsvPartList value. They are defined as global const TMsvPartList variables in mtmdef.h

KMsvMessagePartAttachments

Message attachments

KMsvMessagePartBody

Message body

KMsvMessagePartDate

Message date

KMsvMessagePartDescription

Message description

KMsvMessagePartOriginator

Message originator

KMsvMessagePartRecipient

Message recipients


MTM component type UIDs

Registration information for a concrete MTM must specify the type of MTM component. This is done with one of the following UID values. The UIDs are defined as global const TUid variables in msvruids.h.

UID

MTM component

KUidMtmServerComponent

Server-side MTM

KUidMtmClientComponent

Client-side MTM

KUidMtmUiComponent

User Interface MTM

KUidMtmUiDataComponent

UI Data MTM


MTM type UID constants

The following table lists the UIDs that identify particular ER5 MTM types.

Value

Description

0x10001028

SMTP type

0x10001029

POP3 type. Note that POP3 cannot be used to send mail.

0x1000102B

Fax type

0x1000102C

SMS type


Predefined entry IDs

The following values define the entry index IDs. They are defined as global const TMsvId variables in msvids.h.

ID

Description

KMsvDraftEntryId

ID of Draft folder

KMsvGlobalInBoxIndexEntryId

ID of Inbox folder

KMsvGlobalOutBoxIndexEntryId

ID of Outbox folder

KMsvLocalServiceIndexEntryId

ID of local service (containing the standard folders)

KMsvRootIndexEntryId

ID of root entry of entire index

KMsvSentEntryId

ID of Sent folder

KMsvNullIndexEntryId

A NULL ID. This is typically used to indicate that the ID has not yet been set.


Predefined User Interface MTM operation IDs

There a few predefined IDs for MTM-specific operations. User Interface MTMs wishing to provide functionality of the appropriate type should do through these IDs. These macros are defined in mtmuidef.h.

KMtmUiFunctionPrint

Print message

KMtmUiFunctionPrintPreview

Print preview message

KMtmUiMessagingInitialisation

Carry out special setup steps to be taken only on the first time of execution of Email


UI Data MTM constants

Section Contents

The following values are used for defining MTM-specific operations in UI Data MTM resource files and TMtmUiFunction types. They are defined as macros in mtud.hrh.


Function flags

The following flags are used to set values for TMtmUiFunction::iFlags and MTUD_FUNCTION::flags. They may be combined in a bitmask.

EMtudContextSpecific

Operation requires that the context is set to the relevant entry before calling.

EMtudAsynchronous

Operation is asynchronous and should be invoked through CBaseMtmUi::InvokeAsyncFunctionL(). If this flag is not set, CBaseMtmUi::InvokeSyncFunctionL() should be used.

EMtudRemoteOnly

Operation requires that the context is set to a remote entry before calling.


Function location

The following flags are used to set values for TMtmUiFunction::iFlags and MTUD_FUNCTION::flags. They suggest where on the user interface, e.g. on which menu, the associated function should be placed. They should not be combined in a bitmask.

EMtudCommandTransferSend

Message transfer: sending

EMtudCommandTransferReceive

Message transfer: receiving

EMtudCommandEdit

Edit

EMtudCommandMessage

Message

EMtudCommandTool

Tools


Key flags

The following flags are used to set values for TMtmUiFunction::iPreferredHotKeyModifiers and MTUD_FUNCTION::keymodifiers. They may be combined in a bitmask.

EMtudShift

SHIFT key modifier

EMtudCtrl

CTRL key modifier

EPOC       SDK Home Glossary Indexes Previous Next Up