The destructor frees the object's text storage and field set, prior to its destruction.

Finds the length and the start position of a paragraph identified by its paragraph number the first paragraph is numbered zero.

Notes:

if aParaOffset is invalid, (equal to or greater than the total number of paragraphs), the function's return value is EScanEndOfData

Gets information about the number of components contained in the text object. For plain text, only the field count has relevance.

Allocates storage of CBufFlat or CBufSeg , according to the parameter aStorage. Creates & initializes the field set.

Allocates storage of CBufFlat or CBufSeg , according to the parameter aStorage, restoring contents from the specified read-stream aStream.

Removes all fields from the text object's field set, leaving their current text value in the text object. Does not update the fields beforehand.

Converts the field containing the specified document position into text, leaving its current value in the text object. Does not update the field beforehand.

Copies plain text including fields, if present, to the clipboard.

A panic occurs in any of the following circumstances:

aPos is invalid

aLength is invalid (zero or less)

the sum of aPos and aLength is greater than or equal to the number of characters in the document

Deletes one or more characters beginning at, and including, the character at a specified document position. Updates the page table. Any fields wholly contained in the range of characters to delete are removed from the field set.

Allocates storage of CBufFlat or CBufSeg , according to the parameter aStorage. Creates & initializes the field set.

Write to the stream, the T.V. representing the field set.

Write to the stream, the T.V. representing the plain text.

Copies aLength characters, commencing at aPos, into the specified buffer aBuf. If aLength is greater than the amount of data left, then all remaining characters are written.

Read from the stream until the field data is identified, and consume it.

Read from the stream until the character data is found, and consume it.

Deletes aLength number of characters from the document, commencing at, and including, position aPos. The return value indicates if 2 paragraphs have been merged together as a result of the delete, indicating that the resulting paragraph must be reformatted. In global text, this clearly has no reasonable meaning, so always returns EFalse, so no reformatting occurs.

Inserts the contents a aBuf into the document at position aInsertPos. Maintain field set.

Gets the the number of characters in the text object.

Note: the count includes all non-printing characters but excludes the end of text paragraph delimiter, so that the smallest possible return value is zero.

Writes the contents of the plain text object to a text file.

The filename is given by aFileName. Any existing file with that name is replaced. A wrap width can be specified. This is only used when exporting by line (aTextOrganisation is EOrganiseByLine).

The function leaves if there is any problem in creating or replacing the file.

Writes plain text to a stream, optionally converting it from Unicode into a foreign encoding.

Writes plain text to a stream, optionally converting it from Unicode into a foreign encoding.

CPlainText::TImportExportParam CPlainText::TImportExportResult

Returns the interface corresponding to the specified UID if it exists, or 0 if not. Overridden versions should base call rather than returning 0.

Externalises the plain text object's field set.

Externalises a plain text object to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Externalises the plain text object's text content (preceded by a length count) to a write stream.

Externalises the plain text object's text content to a write stream.

This function differs from ExternalizePlainTextL() in that it does not precede the text content with a length count. This function is not intended for general use and is deprecated. void CPlainText::ExternalizePlainTextL(RWriteStream& aStream)const

Copies the contents of the text object into a descriptor overloaded function. The function copies all characters from and including the document position specified, to the end of the document or the end of the range of characters, if specified.

The buffer's maximum length must be greater than or equal to the number of characters to extract, or a panic occurs.

Copies the contents of the text object into a descriptor-overloaded function. The function copies all characters from and including the document position specified, to the end of the document or the end of the range of characters, if specified.

The buffer's maximum length must be greater than or equal to aLength, or a panic ocurs.

Gets a count of the number of fields in the text object's field set.

Gets a pointer to the field factory used by the text object. The field factory may be set up using SetFieldFactory() , or may be specified in the NewL() .

Tests whether a document position is located within a field overloaded function.

The second overload extracts information about all fields located within a range of characters.

Gets the start position and length of the word that contains the document position specified.

Imports a plain text file into this text object.

Translates non-printing characters in the source text file into Symbian OS special characters, for instance tabs are converted into CEditableText::ETabCharacters, and form feeds into CEditableText::EPageBreaks. Line feeds in the source text file are translated according to the aTextOrganisation argument.

The function leaves if there is any problem in opening the file.

Imports plain text from a stream into this text object.

Translates line feeds in the source text according to the aTextOrganisation argument.

Imports plain text from a stream into this text object, optionally converting it from a foreign encoding into Unicode.

CPlainText::TImportExportParam CPlainText::TImportExportResult

Inserts the end-of-document character upon document construction.

Inserts a field into the text object at a specified document position. creating a zero-length field record. Maintain the field set.

Note: After insertion, the field should be evaluated in order to make its contents visible; use UpdateFieldL() .

Inserts either a single character or a descriptor into the text object at a specified document position.

Updates the page table.

Inserts the contents of aBuf into the document at position aPos.

Insert the specified plain text object at the specified character position. (Called by CRichText::Insert()

Internalizes the field set.

Internalises the text object's text content and field set from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class. InternalizeL() has construct rather than assignment semantics. You should not use it for fully initialised objects.

Internalises an empty text object's text content from a read stream overloaded function.

This function has construct rather than assignment semantics. You should not use it for fully initialised objects.NoteThe overload which takes a length argument is not intended for general use and its use is deprecated.

Internalises an empty text object's text content from a read stream's overloaded function.

This function has construct rather than assignment semantics. You should not use it for fully initialised objects.

Note

The overload which takes a length argument is not intended for general use and its use is deprecated.

Delete the field set if it is resident in memory.

Allocates and constructs a plain text object overloaded function.

The text object's contents may be restored from a stream store. If the text object supports fields, a field factory should be specified.

Returns a handle to a new instance of this class, restored from the specified read stream.

Creates and returns a new field. Before calling this function, a field factory should have been set up, either by calling SetFieldFactory() , or by specifying one in the NewL() . The field factory's NewFieldL() function is called to create a field of the type specified in the argument. A NULL field is returned if no field factory has been set up.

Gets the number of the page which contains the specified document position. If no page table has been set up, the function returns a value of zero. Use SetPageTable() to set up the page table.

Gets a count of the number of paragraphs in the text object.

Note: the paragraph delimiter which terminates every text object means this function always returns a count of at least one.

Gets the number of the paragraph which contains a document position. Paragraph numbering begins at zero.

Pastes plain text and fields, if present, from the clipboard into the current text object at the specified document position. The entire contents of the store are pasted.

Inserts the contents a aBuf into the document at position aInsertPos. Maintain field set.

Gets a read-only view of a portion of the text object.

The extent of the view is the range of characters starting at aStartPos and ending at whichever of the following document positions is reached first:

Therefore, when using a segmented buffer to store the document, the length of the resultant view may be less than the requested length. In this case multiple calls to Read() may be necessary.

Gets a read-only view of a portion of the text object.

The extent of the view is the range of characters starting at aStartPos and ending at whichever of the following document positions is reached first:

Therefore, when using a segmented buffer to store the document, the length of the resultant view may be less than the requested length. In this case multiple calls to Read() may be necessary.

Removes the field covering the document position specified from the field set, and deletes all text content associated with the field from the text object.

Deletes all text content, formatting and fields from the document, leaving the single paragraph delimiter which terminates the text object.

Restores the plain text object's field set from a stream store.

Restores the plain text object's field set.

Scans from a document position to the beginning or end of a paragraph. The destination is determined by a scan mask. The scan can either be forwards (the default) or backwards, and the destination may be the first or last character in the paragraph containing the position, or the first character in the next paragraph.

Note: if an attempt is made to scan beyond the end of text delimiter, on return, aPos is set to EScanEndOfData ) and the function's return value indicates the number of characters skipped in passing the end of text delimiter.

Scans from a document position to the beginning or end of a word. The destination is determined by a scan mask. The scan can either be forwards (the default) or backwards, and the destination may be the first or last character in the word containing the position, or the first character in the next word.

Note: If an attempt is made to scan beyond the end of text delimiter, on return, aPos is set to EScanEndOfData and the function's return value indicates the number of characters skipped in passing the end of text delimiter.

Sets up a field factory. A field factory is an instance of a class deriving from MTextFieldFactory . It must implement a NewFieldL() function to create and return fields of the desired type. The field factory's NewFieldL() function is called by CPlainText::NewTextFieldL() . A field factory must be set up if you intend to add any fields to the text object.

Links the text object to a page table. A page table is an array of integers; each integer represents the number of characters on a page. It is required for pagination. The page table is updated when changes are made to the document, e.g. after pasting from the clipboard, inserting, importing or deleting text.

The text object does not take ownership of the page table specified.

Stores the plain text object's components to the stream store specified.

Stores the plain text object's field components to a stream store.

Return ETrue if a character was read successfully. Set EIsDelimiter flag if the character read is a delimiter of the appropriate type.

Returns a pointer to the field located at the specified document position.

Gets the document position of the start of the paragraph containing the specified document position.

Re-evaluates all of the fields in the text object. Re-evaluating a field means calculating the field's new value, then inserting that value into the text object, replacing the previous value.

Note: Fields have a maximum length of 20 characters.

Re-evaluates the field which covers the document position specified. Re-evaluating a field means calculating the field's new value, then inserting that value into the text object, replacing the previous value.

Notes:

fields have a maximum length of 20 characters.

the first time a field is updated, the position specified should be the position at which the field was inserted.

Gets a count of the number of words in the text object.

Scan mask values.

Used in text scanning functions to indicate the end of the document has been passed.

Line delimiter translation.