CSmsHyperLinkOperations Class Reference
#include
"gsmuieoperations.h"
| class CSmsHyperLinkOperations : public CSmsCtrlOperation |
| 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() |
Detailed Description
Clients use this class to configure a CSmsMessage with hyperlinks per 23.040 v6.5.0 section 9.2.3.24.12.
Constructor & Destructor Documentation
CSmsHyperLinkOperations ( CSmsInformationElement::TSmsInformationElementIdentifier, CSmsMessage & )
~CSmsHyperLinkOperations ( )
| ~CSmsHyperLinkOperations | ( | ) | [inline] |
Member Function Documentation
AddHyperLinkL ( TUint, TUint8, TUint8 )
| IMPORT_C void | AddHyperLinkL | ( | TUint | aPosition, |
| | TUint8 | aTitleLength, |
| | TUint8 | aURLLength |
| | ) | const |
This method adds a HyperLink to the CSmsMessage.
-
leave
- KErrNotSupported If the message version or type does not support hyperlinks.
-
capability
- None
| Parameter | Description | | aPosition | The absolute character position within the message text. |
CopyHyperLinkAtIndexL ( TUint, TUint &, TUint8 &, TUint8 & )
| IMPORT_C void | CopyHyperLinkAtIndexL | ( | TUint | index, |
| | 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
| Parameter | Description | | index | Identifies the hyperlink to extract. Has the range [0..[n-1]] where n is the value returned by NumberOfHyperLinks(). |
NumberOfHyperLinksL ( )
| IMPORT_C TUint | NumberOfHyperLinksL | ( | ) | 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
Returns: The number of hyper links contained in this message.
RemoveAllHyperLinksL ( )
| IMPORT_C void | RemoveAllHyperLinksL | ( | ) | 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 void | RemoveHyperLinkL | ( | TUint | aIndex | ) | 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
| Parameter | Description | | aIndex | aIndex has the range [0..[n-1]] where n is the value returned by NumberOfHyperLinks() |
ValidateOperationL ( )
| void | ValidateOperationL | ( | ) | 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 & )
Prevent clients from using the assignment operator by including it in the class definition but making it protected and not exporting it.
operator== ( const CSmsHyperLinkOperations & )
Prevent clients from using the equality operator by including it in the class definition but making it protected and not exporting it.