CContactTextField Class Reference
| class CContactTextField : public CContactFieldStorage |
Constructor & Destructor Documentation
~CContactTextField()
| IMPORT_C | ~CContactTextField | ( | ) | |
Deletes the text owned by the object, prior to its destruction.
Member Functions Documentation
CContactFieldStorage_Reserved1()
| IMPORT_C void | CContactFieldStorage_Reserved1 | ( | ) | [private, virtual] |
EncodeL(const TDesC &, TUid)
ExternalizeL(RWriteStream &)
Externalises the field data.
Parameters
| RWriteStream & aStream | Write stream to which the contents of the field should be externalised. |
ExternalizeL(RWriteStream &, TBool, TInt)
InternalizeL(HBufC *, TInt)
| void | InternalizeL | ( | HBufC * | aTextStream, |
| | TInt | aTextFieldIndex |
| | ) | |
InternalizeL(RReadStream &)
Internalises the field data.
Parameters
| RReadStream & aStream | Stream from which the the contents of the field should be internalised. |
IsFull()
|
TBool
| IsFull | ( | ) | const [virtual] |
Tests whether the field storage contains data.
RestoreL(CStreamStore &, RReadStream &)
Parameters
| CStreamStore & aStore | Reference to the store from which the object is to be restored. |
| RReadStream & aStream | Reference to the stream which should be passed to InternalizeL(). |
SetStandardTextArray(MDesCArray *)
| IMPORT_C void | SetStandardTextArray | ( | MDesCArray * | anArray | ) | |
Converts an array of text strings from plain text into Symbian editable text, appends them to a single descriptor, separating them with the new line character, and sets this as the text which is stored in the field. Any existing field text is replaced. The text is truncated to KCntMaxTextFieldLength characters if necessary.
Parameters
| MDesCArray * anArray | Array of descriptors to set as the field data. |
SetStandardTextL(const TDesC &)
| IMPORT_C void | SetStandardTextL | ( | const TDesC & | aText | ) | |
Converts a text string from plain text into Symbian editable text, and sets this as the text which is stored in the field. The text is truncated to KCntMaxTextFieldLength characters if necessary.
Parameters
| const TDesC & aText | The new field data. |
SetText(HBufC *)
| IMPORT_C void | SetText | ( | HBufC * | aHbuf | ) | |
Sets the field text.
The text field object takes ownership of the specified descriptor. The function cannot leave.
Parameters
| HBufC * aHbuf | The new field text. |
SetTextArray(MDesCArray *)
| IMPORT_C void | SetTextArray | ( | MDesCArray * | anArray | ) | |
Sets the field text from a descriptor array. Each descriptor in the array is appended to the text field storage. They are separated by paragraph delimiters (CEditableText::EParagraphDelimiter). Any existing text is replaced.
Parameters
| MDesCArray * anArray | Pointer to array of descriptors to set as the field text. |
SetTextL(const TDesC &)
| IMPORT_C void | SetTextL | ( | const TDesC & | aText | ) | |
Sets the field text.
This function allocates a new HBufC descriptor, deleting any existing one, and copies the new text into it. The function can leave.
Parameters
| const TDesC & aText | The new field text. |
StandardTextLC()
| IMPORT_C TPtrC | StandardTextLC | ( | ) | const |
Converts a copy of the text stored in the field from Symbian editable text format into plain text and returns it as a pointer descriptor.
StoreL(CStreamStore &)
Parameters
| CStreamStore & aStore | Reference to the stream store to which the field data is written. |
Text()
| IMPORT_C TPtrC | Text | ( | ) | const |
Gets a copy of the text which is stored in the field.
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.