#include <mw/AknUtils.h>
| class AknTextUtils |
| Public Member Enumerations | |
|---|---|
| enum | TClipDirection { EDoNotClip, EClipFromEnd, EClipFromBeginning } |
| enum | TDigitModeQueryType { EDigitModeEditorDefault, EDigitModeUserModifiableEditor, EDigitModeShownToUser, EDigitModeNumberEditor, EDigitModeLatinNumberEditor } |
Text utilities. Text truncating and wrapping methods in this class do not support text that requires conversion from logical to visual form, e.g. Arabic/Hebrew, Thai and Hindi text. Code that needs to support that kind of text should use corresponding methods in AknBidiTextUtils instead.
| IMPORT_C TPtrC | ChooseScalableText | ( | const TDesC & | aText, |
| const CFont & | aFont, | |||
| TInt | aMaxWidthInPixels | |||
| ) | [static] | |||
Utility method used in scalable UI for choosing the longest fitting text variant. Truncating and wrapping methods in classes AknTextUtils and AknBidiTextUtils do the choice by themselves, so whenever they are used to process the text, it is not necessary to call this method.
Applications do not need to call this method if they pass their localized texts to Avkon's UI components.
| Parameter | Description |
|---|---|
| aText | Text containing one or many variants with varying text widths, separated with the character 0x0001. The text is supposed to be in logical order. |
| aFont | Font used to render the text. |
| aMaxWidthInPixels | Max width in pixels. |
| IMPORT_C void | ChopToArrayAndClipL | ( | TDes & | aStringToChop, |
| const CArrayFix< TInt > & | aLineWidthArray, | |||
| const CFont & | aFont, | |||
| CArrayFix< TPtrC > & | aChoppedArray | |||
| ) | [static] | |||
Chops a string when a line break character is encountered. Clips at the end of each line if there isn't enough space on that line. When clipping, KEllipsis (shown as 3 dots) is inserted at the end of the line. The number of lines and line widths are specified by aLineWidthArray. The pointers in aChoppedArray point to positions inside aStringToChop.
Expect the string to be modified if clipping is needed (Clipping character KEllipsis is inserted in the end of the lines)
| Parameter | Description |
|---|---|
| aStringToChop | String that needs to be chopped |
| aLineWidthArray | Line widths in pixels |
| aFont | Used font |
| aChoppedArray | Pointers to chopped lines |
| IMPORT_C void | ChopToArrayAndClipL | ( | TDes & | aStringToChop, |
| TInt | aLineWidth, | |||
| const CFont & | aFont, | |||
| CArrayFix< TPtrC > & | aChoppedArray | |||
| ) | [static] | |||
Chops a string when a line break character is encountered. Clips at the end of each line if there isn't enough space on that line. When clipping, KEllipsis (shown as 3 dots) is inserted at the end of the line. Constant line width is given. The pointers in aChoppedArray point to positions inside aStringToChop.
Expect the string to be modified if clipping is needed (Clipping character KEllipsis is inserted in the end of the lines)
| Parameter | Description |
|---|---|
| aStringToChop | String that needs to be chopped |
| aLineWidth | Constant line width in pixels |
| aFont | Used font |
| aChoppedArray | Pointers to chopped lines |
DeprecatedDo not use. This method will be removed.
| IMPORT_C TBool | ClipToFit | ( | TDes & | aBuffer, |
| const CFont & | aFont, | |||
| TInt | aMaxWidthInPixels, | |||
| TClipDirection | aDir = EClipFromEnd, | |||
| TInt | aClipWidth = KDefaultClipWidth , | |||
| const TDesC & | aClipString = _L("...") | |||
| ) | [static] | |||
ClipToFit() Generic clipping
returns true if the text was clipped and 3 dots were added.
| Parameter | Description |
|---|---|
| aBuffer | String that needs to be clipped. will be modified by this call |
| aFont | Font used in the code |
| aMaxWidthInPixels | Maximum length of text that will not be clipped. |
| aDir | Where is the text clipped from. EDoNotClip, EClipFromEnd, EClipFromBeginning. |
| aClipWidth | The length of the text after clipping. KDefaultClipWidth will make it use aMaxWidthInPixels. |
| aClipString | The representation of three dots. (not really used anywhere - use the default value always or "") |
| IMPORT_C TBool | ClipToFit | ( | TDes & | aBuffer, |
| TClipDirection | aDir, | |||
| CEikFormattedCellListBox * | aListBox, | |||
| TInt | aItemIndex, | |||
| TInt | aSubCellNumber | |||
| ) | [static] | |||
ClipToFit() for clipping text inside lists
NOTICE: This method cannot handle situation where the text may dynamically change its size! Especially when you have bitmaps on the right side!
This needs to be done AFTER the listbox has done its SizeChanged()!
| IMPORT_C TBool | ClipToFit | ( | TDes & | aBuffer, |
| TClipDirection | aDir, | |||
| CEikColumnListBox * | aListBox, | |||
| TInt | aItemIndex, | |||
| TInt | aColumnNumber | |||
| ) | [static] | |||
ClipToFit() for clipping text inside lists
NOTICE: This method cannot handle situation where the text may dynamically change its size! Especially when you have bitmaps on the right side!
This needs to be done AFTER the listbox has done its SizeChanged()!
| IMPORT_C void | ConvertDigitsTo | ( | TDes & | aDes, |
| TDigitType | aDigitType | |||
| ) | [static] | |||
This routine is used to convert digits from any digit format to another format eg. from european digits to arabic-indic digits.
| Parameter | Description |
|---|---|
| aDes | Parameter to change. It can contain digits from several digit types. |
| aDigitType | Destination digit type. |
Converts a filename ABCDE.EXT to format which is suitable for display. This method is needed for bi-directional language support. The method adds directionality markers to the filename so that the filename can correctly be rendered to screen.
| Parameter | Description |
|---|---|
| aDes | contains the file name in logical format. |
Returns: file name in logical format with needed directionality markers.
| IMPORT_C TBidiText::TDirectionality | CurrentScriptDirectionality | ( | ) | [static] |
Convenience routine to obtain the directionality of the current input language This routine will attempt to access this information in a system-efficient way.
This is not to be confused with either the directionality of the display text language or (a closely associated concept) the layout direction of the UI (accessed via AknLayoutUtils::LayoutMirrored() )
Returns: TBidiText::ELeftToRight if the current input language is left to right TBidiText::ERightToLeft if the current input langauge is right to left
| IMPORT_C TBool | DigitModeQuery | ( | TDigitModeQueryType | aQueryType = EDigitModeShownToUser | ) | [static] |
This routine can be used to check what modes digits can be on.
It uses input language, display language and the setting from general settings to calculate whether foreign digits need to be used.
This is useful for editor implementation and anyone that needs to convert digits for display.
| Parameter | Description |
|---|---|
| aQueryType | what is the situation where the digits are to be used. |
Returns: ETrue to indicate whether digit conversions need to be used. EFalse to indicate that no conversion is needed.
| TDigitType | DisplayTextLanguageFilteredDigitType | ( | ) | [static] |
Method used to constrain the digit type to use to that consisted with the current display text language
Returns: TDigitType consistent with the current input language
| IMPORT_C void | DisplayTextLanguageSpecificNumberConversion | ( | TDes & | aDes | ) | [static] |
This routine is used to convert between arabic-indic digits and european digits. based on existing language setting. So it'll convert any digit from the string to use either european digits or arabic-indic digits based on current settings.
This routine builds in the constraints imposed by current display text languages.
The number of characters in the buffer is not changed by this routine. It can therefore be safely used easily with existing (modifiable) descriptors.
This method should only be used just before displaying the number as unicode descriptor. Never store the converted string.
| Parameter | Description |
|---|---|
| aDes | Parameter to change |
| TDigitType | InputLanguageFilteredDigitType | ( | ) | [static] |
Method used to constrain the digit type to use to that consisted with the current input language
Returns: TDigitType consistent with the current input language
| IMPORT_C void | LanguageSpecificNumberConversion | ( | TDes & | aDes | ) | [static] |
This routine is used to convert between arabic-indic digits and european digits. based on existing language setting. So it'll convert any digit from the string to use either european digits or arabic-indic digits based on current settings.
NOTE: THis method can be also called in european release. The method is required to do the correct thing with all the languages.
This method should only be used just before displaying the number as unicode string. Also, never store the converted string as unicode.
| Parameter | Description |
|---|---|
| aDes | Parameter to change |
| IMPORT_C TDigitType | NumericEditorDigitType | ( | ) | [static] |
Returns the digit type to be used for editors that are purely numeric in quality.
Returns: TDigitType to use for purely numeric editors
This routine is used to replace all control chars with a single character, usually a whitespace.
KAknReplaceTabs KAknReplaceListControlChars ('s and 's)
| Parameter | Description |
|---|---|
| aDes | Parameter to change |
| aReplacement | a character used as replacement |
This routine is used to strip away a set of characters from a descriptor.
Useful for example for listboxes to make sure strings from network or typed by the end user does not have tab or linefeed characters. (as those will make listbox broken.)
There exists predefined character sets to remove: KAknStripTabs KAknStripListControlChars ('s and 's and 's)
| Parameter | Description |
|---|---|
| aDes | Parameter to change |
| aCharacters | A set of characters to remove |
| IMPORT_C TDigitType | TextEditorDigitType | ( | ) | [static] |
Returns the digit type to be used for editors that are alphanumeric. (Note that these editors may be configurable to be purely numeric - that is have a numeric mode, but they remain alphanumeric editors for the sake of this API.)
This may be useful for instance for input processors that convert numeric key events to the currently set input digit type.
Returns: TDigitType to editors with alphanumeric capability
| IMPORT_C void | WrapToArrayAndClipL | ( | TDes & | aStringToWrap, |
| const CArrayFix< TInt > & | aLineWidthArray, | |||
| const CFont & | aFont, | |||
| CArrayFix< TPtrC > & | aWrappedArray | |||
| ) | [static] | |||
Wraps a string to an array of pointers and clips at the end of the last line if there aren't enough lines to accomodate the entire text. When clipping three dots are inserted at the end of the last line. The number of lines and line widths are specified by aLineWidthArray. The pointers in aWrappedArray point to positions inside aWrappedString.
Expect the string to be modified if clipping is needed. (Clipping character KEllipsis is inserted at the ending point)
| Parameter | Description |
|---|---|
| aStringToWrap | String that needs to be wrapped |
| aLineWidthArray | Line widths in pixels |
| aFont | Used font |
| aWrappedArray | Pointers to wrapped lines |
| IMPORT_C void | WrapToArrayL | ( | const TDesC & | aStringToWrap, |
| const CArrayFix< TInt > & | aLineWidthArray, | |||
| const CFont & | aFont, | |||
| CArrayFix< TPtrC > & | aWrappedArray | |||
| ) | [static] | |||
Wraps a string to an array of pointers. The number of lines and line widths are specified by aLineWidthArray. The pointers in aWrappedArray point to positions inside aWrappedString.
| Parameter | Description |
|---|---|
| aStringToWrap | String that needs to be wrapped |
| aLineWidthArray | Line widths in pixels |
| aFont | Used font |
| aWrappedArray | Pointers to wrapped lines |
| IMPORT_C void | WrapToArrayL | ( | const TDesC & | aStringToWrap, |
| TInt | aLineWidth, | |||
| const CFont & | aFont, | |||
| CArrayFix< TPtrC > & | aWrappedArray | |||
| ) | [static] | |||
Wraps a string to an array of pointers. Constant line width is given. The pointers in aWrappedArray point to positions inside aWrappedString.
| Parameter | Description |
|---|---|
| aStringToWrap | String that needs to be wrapped |
| aLineWidth | Constant line width in pixels |
| aFont | Used font |
| aWrappedArray | Pointers to wrapped lines |
| IMPORT_C void | WrapToStringAndClipL | ( | const TDesC & | aStringToWrap, |
| const CArrayFix< TInt > & | aLineWidthArray, | |||
| const CFont & | aFont, | |||
| TDes & | aWrappedString | |||
| ) | [static] | |||
Wraps a string (aStringToWrap) into lines according to the number of lines and line widths specified in aLineWidthArray. Inserts '' at the end of lines. Clips the last line if there aren't enough lines to fit the entire string. Copies the result into aWrappedString. Leaves if aWrappedString isn't big enough.
| Parameter | Description |
|---|---|
| aStringToWrap | String that needs to be wrapped |
| aLineWidthArray | Width of lines in pixels |
| aFont | Used font |
| aWrappedString | Wrapped string |
| IMPORT_C void | WrapToStringL | ( | const TDesC & | aStringToWrap, |
| const CArrayFix< TInt > & | aLineWidthArray, | |||
| const CFont & | aFont, | |||
| TDes & | aWrappedString | |||
| ) | [static] | |||
Wraps a string (aStringToWrap) into lines according to the number of lines and line widths specified in aLineWidthArray. Inserts '' at the end of lines. Copies the result into aWrappedString. Leaves if aWrappedString isn't big enough.
| Parameter | Description |
|---|---|
| aStringToWrap | String that needs to be wrapped |
| aLineWidthArray | Lines widths in pixels |
| aFont | Used font |
| aWrappedString | Wrapped string |