Collapse all Symbian^3 Application Developer Library

TextUtils Class Reference

class TextUtils

Provides static functions for truncating and aligning text strings.

Public Member Functions
IMPORT_C void	ClipToFit ( TDes &, const CFont &, TInt , TChar )
IMPORT_C TInt	ColumnText ( TPtrC &, TInt , const TDesC *, TChar )
IMPORT_C void	TruncateToNumChars ( TDes &, TInt )

Member Functions Documentation

ClipToFit(TDes &, const CFont &, TInt, TChar)

IMPORT_C void	ClipToFit	(	TDes &	aBuffer,
			const CFont &	aFont,
			TInt	aMaxWidthInPixels,
			TChar	aAlternativeEnd = KTextUtilClipEndChar
		)	[static]

Clips text to fit into a maximum width.

If the text is too wide to fit in the width when displayed in aFont, it is truncated and the specified character (by default, a horizontal ellipsis) is appended to it.

Parameters

TDes & aBuffer	A buffer containing the text to clip.
const CFont & aFont	The font.
TInt aMaxWidthInPixels	The maximum width in pixels.
TChar aAlternativeEnd = KTextUtilClipEndChar	The Unicode character to append to the buffer if truncated. By default, this is the horizontal ellipsis.

ColumnText(TPtrC &, TInt, const TDesC *, TChar)

IMPORT_C TInt	ColumnText	(	TPtrC &	aColumnText,
			TInt	aColumn,
			const TDesC *	aSourceText,
			TChar	aColumnSeparator = KColumnListSeparator
		)	[static]

Gets a portion of text from a descriptor, corresponding to a requested column.

Parameters

TPtrC & aColumnText	On return, set to the portion of aSourceText that corresponds to the column aColumn.
TInt aColumn	The column to extract. The first column is numbered zero.
const TDesC * aSourceText	The source text string that contains one or more column separators.
TChar aColumnSeparator = KColumnListSeparator	The character used in aSourceText to separate the columns. By default, a tab character.

TruncateToNumChars(TDes &, TInt)

IMPORT_C void	TruncateToNumChars	(	TDes &	aBuffer,
			TInt	numChars
		)	[static]

Truncates text to a number of characters.

If truncation is required (because aBuffer contains more than numChars characters), an ellipsis is added to the text as the last character.

Parameters

TDes & aBuffer	On return, contains the truncated text.
TInt numChars	The number of characters.