CSmsHyperLinkOperations Class Reference

class CSmsHyperLinkOperations : public CSmsCtrlOperation

Clients use this class to configure a CSmsMessage with hyperlinks per 23.040 v6.5.0 section 9.2.3.24.12.

Inherits from

Public Member Functions
CSmsHyperLinkOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &)
~CSmsHyperLinkOperations()
IMPORT_C voidAddHyperLinkL(TUint, TUint8, TUint8)
IMPORT_C voidCopyHyperLinkAtIndexL(TUint, TUint &, TUint8 &, TUint8 &)
IMPORT_C TUintNumberOfHyperLinksL()
IMPORT_C voidRemoveAllHyperLinksL()
IMPORT_C voidRemoveHyperLinkL(TUint)
Protected Member Functions
voidValidateOperationL()
voidoperator=(const CSmsHyperLinkOperations &)
TBool operator==(const CSmsHyperLinkOperations &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CSmsCtrlOperation::CSmsCtrlOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
CSmsCtrlOperation::operator=(const CSmsCtrlOperation &)
CSmsCtrlOperation::operator==(const CSmsCtrlOperation &)
CSmsCtrlOperation::~CSmsCtrlOperation()
CSmsIEOperation::CSmsIEOperation(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &)
CSmsIEOperation::Id()const
CSmsIEOperation::MessageTypeSupported()const
CSmsIEOperation::NewL(CSmsInformationElement::TSmsInformationElementIdentifier,CSmsMessage &,CCnvCharacterSetConverter &,RFs &)
CSmsIEOperation::operator=(const CSmsIEOperation &)
CSmsIEOperation::operator==(const CSmsIEOperation &)
CSmsIEOperation::~CSmsIEOperation()
Inherited Attributes
CSmsIEOperation::iMessage

Constructor & Destructor Documentation

CSmsHyperLinkOperations(CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage &)

CSmsHyperLinkOperations(CSmsInformationElement::TSmsInformationElementIdentifieraId,
CSmsMessage &aMessage
)

~CSmsHyperLinkOperations()

~CSmsHyperLinkOperations()[inline]

Member Functions Documentation

AddHyperLinkL(TUint, TUint8, TUint8)

IMPORT_C voidAddHyperLinkL(TUintaPosition,
TUint8aTitleLength,
TUint8aURLLength
)const

This method adds a HyperLink to the CSmsMessage.

leave
KErrNotSupported If the message version or type does not support hyperlinks.
capability
None

Parameters

TUint aPositionThe absolute character position within the message text.
TUint8 aTitleLength
TUint8 aURLLength

CopyHyperLinkAtIndexL(TUint, TUint &, TUint8 &, TUint8 &)

IMPORT_C voidCopyHyperLinkAtIndexL(TUintindex,
TUint &aPosition,
TUint8 &aTitleLength,
TUint8 &aURLLength
)const

Copies the attributes of the specified hyperlink. aIndex has the range [0..[n-1]] where n is the value returned by NumberOfHyperLinks()

leave
KErrNotSupported If the message version or type does not support hyperlinks.
leave
KErrArgument If aIndex is out of range.
capability
None

Parameters

TUint indexIdentifies the hyperlink to extract. Has the range [0..[n-1]] where n is the value returned by NumberOfHyperLinks().
TUint & aPosition
TUint8 & aTitleLength
TUint8 & aURLLength

NumberOfHyperLinksL()

IMPORT_C TUintNumberOfHyperLinksL()const
Returns the number of Hyper Link IEs contained in this message.
leave
KErrNotSupported If this functionality is not supported by this version or type of message.
capability
None

RemoveAllHyperLinksL()

IMPORT_C voidRemoveAllHyperLinksL()const

Removes all hyper Link IEs contained in this message.

leave
KErrNotSupported If the message version or type does not support hyperlinks.
capability
None

RemoveHyperLinkL(TUint)

IMPORT_C voidRemoveHyperLinkL(TUintaIndex)const

Removes the indexed hyperlink from this message.

leave
KErrNotSupported If the message version or type does not support hyperlinks.
leave
KErrArgument If the index is out of range.
capability
None

Parameters

TUint aIndexaIndex has the range [0..[n-1]] where n is the value returned by NumberOfHyperLinks()

ValidateOperationL()

voidValidateOperationL()const [protected, virtual]

Identifies whether the message type or version supports this operation

leave
If the message type or version does not support this operation.

operator=(const CSmsHyperLinkOperations &)

voidoperator=(const CSmsHyperLinkOperations &)[protected]

Prevent clients from using the assignment operator by including it in the class definition but making it protected and not exporting it.

capability
None

Parameters

const CSmsHyperLinkOperations &

operator==(const CSmsHyperLinkOperations &)

TBool operator==(const CSmsHyperLinkOperations &)[protected]

Prevent clients from using the equality operator by including it in the class definition but making it protected and not exporting it.

capability
None

Parameters

const CSmsHyperLinkOperations &