Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: FXUT.h
Link against: fxcm.lib

Class TMsvFaxEntry

class TMsvFaxEntry

Support

Supported from 6.0

Description

Settings for a fax message entry in the message index.

This class extends the basic TMsvEntry class. The extra settings are stored in the iMtmData members of the base class.

Derivation

TMsvEntryRepresents an entry in the Message Server index
TMsvFaxEntrySettings for a fax message entry in the message index

Defined in TMsvFaxEntry:
EMsvFineResolution, RenderingComplete(), Resolution(), SendingPage(), SendingRecipient(), SetRenderingComplete(), SetResolution(), SetSendingPage(), SetSendingRecipient(), SetTotalPages(), SetTotalRecipients(), TMsvFaxEntry(), TMsvFaxEntry(), TMsvFaxEntryFlags, TotalPages(), TotalRecipients()

Inherited from TMsvEntry:
Attachment(), Complete(), Connected(), DecPcSyncCount(), Deleted(), ExternalizeL(), Failed(), Folder(), Id(), InPreparation(), IncPcSyncCount(), InternalizeL(), MultipleRecipients(), New(), OffPeak(), Operation(), Owner(), Parent(), PcSyncCount(), Priority(), ReadOnly(), Scheduled(), SendingState(), SetAttachment(), SetComplete(), SetConnected(), SetFailed(), SetInPreparation(), SetMultipleRecipients(), SetNew(), SetOffPeak(), SetOperation(), SetPriority(), SetReadOnly(), SetScheduled(), SetSendingState(), SetStandardFolder(), SetUnread(), SetVisible(), StandardFolder(), Store(), Unread(), Visible(), iBioType, iDate, iDescription, iDetails, iError, iMtm, iMtmData1, iMtmData2, iMtmData3, iRelatedId, iServiceId, iSize, iType, iWdpPortNumber, operator=(), operator==()


Construction and destruction


TMsvFaxEntry()

TMsvFaxEntry();

Description

Default constructor.


TMsvFaxEntry()

TMsvFaxEntry(const TMsvEntry& aGenericEntry);

Description

Copy constructor.

Parameters

const TMsvEntry& aGenericEntry

Object to copy

[Top]


Member Functions


SendingPage()

inline TInt16 SendingPage() const;

Description

Gets the number of the page being currently sent.

If the fax is not being sent, the function panics.

Return value

TInt16

Number of the page being currently sent


SetSendingPage()

inline void SetSendingPage(TInt16 aPage);

Description

Sets the number of the page being currently sent.

Parameters

TInt16 aPage

Number of the page being currently sent


TotalPages()

inline TInt16 TotalPages() const;

Description

Gets the total number of the pages being sent.

Return value

TInt16

Total number of the pages being sent


SetTotalPages()

inline void SetTotalPages(TInt16 aTotal);

Description

Sets the total number of the pages being sent.

Parameters

TInt16 aTotal

Total number of the pages being sent


SendingRecipient()

inline TInt16 SendingRecipient() const;

Description

Gets which recipient is being sent to.

Recipients are numbered from 0: i.e. 0 is the first recipient.

Return value

TInt16

Number of the recipient being sent to


SetSendingRecipient()

inline void SetSendingRecipient(TInt16 aRecipient);

Description

Sets which recipient is being sent to.

Recipients are numbered from 0: i.e. 0 is the first recipient.

Parameters

TInt16 aRecipient

Number of the recipient being sent to


TotalRecipients()

inline TInt16 TotalRecipients() const;

Description

Gets the total number of recipients being sent to.

Return value

TInt16

Total number of recipients being sent to


SetTotalRecipients()

inline void SetTotalRecipients(TInt16 aTotal);

Description

Sets the total number of recipients being sent to.

Parameters

TInt16 aTotal

Total number of recipients being sent to


Resolution()

inline TFaxResolution Resolution() const;

Description

Gets the fax resolution.

Return value

TFaxResolution

Fax resolution


SetResolution()

inline void SetResolution(TFaxResolution aResolution);

Description

Sets the fax resolution.

Parameters

TFaxResolution aResolution

Fax resolution


RenderingComplete()

inline TInt8 RenderingComplete() const;

Description

Gets the percentage of the fax so far rendered.

The function panics if the fax is not being prepared to be sent.

Return value

TInt8

Percentage of the fax so far rendered


SetRenderingComplete()

inline void SetRenderingComplete(TInt8 aComplete);

Description

Sets the percentage of the fax so far rendered.

The function panics if the fax is not being prepared to be sent.

Parameters

TInt8 aComplete

Percentage of the fax so far rendered

[Top]


Internal members

Description

This member is internal and not intended for use.


Enum TMsvFaxEntryFlags

private: TMsvFaxEntryFlags

Description

This member is internal and not intended for use.

EMsvFineResolution

This member is internal and not intended for use.