Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
CFont::TMeasureTextInput Class Reference

Input parameter block. More...

#include <gdi.h>

Public Types

enum  TFlags { EFVisualOrder = 1 , EFVisualOrderRightToLeft = 2 , EFIncludePenPositionInBoundsCheck = 4 }
 Flags for TMeasureTextInput::iFlags. More...
 

Public Member Functions

 TMeasureTextInput ()
 

Public Attributes

TInt iStartInputChar
 Starting index specifying first input character in iText.
 
TInt iEndInputChar
 Index specifying the final input character.
 
TUint16 iDirection
 The direction in which to draw the text.
 
TUint16 iFlags
 Flags from TFlags.
 
TInt iMaxAdvance
 The maximum advance.
 
TInt iMaxBounds
 The maximum width (or height if drawing vertically) of bounds.
 
TInt iCharJustNum
 The number of glyph groups to be letter-spaced.
 
TInt iCharJustExcess
 The amount of space to be used for letter spacing.
 
TInt iWordJustNum
 The number of spaces to be used for word spacing.
 
TInt iWordJustExcess
 The amount of space to be used for word spacing.
 

Detailed Description

Input parameter block.

This is optionally used by CFont::MeasureText(), which is the powerful text measurement function underlying all the other text measurement functions.

See also
CFont::MeasureText()
API status
Published to all clients. Released API.

Definition at line 1463 of file gdi.h.

Member Enumeration Documentation

◆ TFlags

Flags for TMeasureTextInput::iFlags.

Enumerator
EFVisualOrder 

Input text is visually ordered left-to-right.

EFVisualOrderRightToLeft 

Input text is visually ordered right-to-left.

Overrides EFVisualOrder.

EFIncludePenPositionInBoundsCheck 

Flag to consider side bearings when checking bounds for line-break.

Definition at line 1481 of file gdi.h.

Constructor & Destructor Documentation

◆ TMeasureTextInput()

CFont::TMeasureTextInput::TMeasureTextInput ( )
inline

Definition at line 1466 of file gdi.h.

Member Data Documentation

◆ iCharJustExcess

TInt CFont::TMeasureTextInput::iCharJustExcess

The amount of space to be used for letter spacing.

Definition at line 1522 of file gdi.h.

◆ iCharJustNum

TInt CFont::TMeasureTextInput::iCharJustNum

The number of glyph groups to be letter-spaced.

Definition at line 1519 of file gdi.h.

◆ iDirection

TUint16 CFont::TMeasureTextInput::iDirection

The direction in which to draw the text.

Definition at line 1507 of file gdi.h.

◆ iEndInputChar

TInt CFont::TMeasureTextInput::iEndInputChar

Index specifying the final input character.

Together with iStartInputChar, this allows some context before and after the measured text to be supplied so that shaping can work properly.

Definition at line 1504 of file gdi.h.

◆ iFlags

TUint16 CFont::TMeasureTextInput::iFlags

Flags from TFlags.

Definition at line 1510 of file gdi.h.

◆ iMaxAdvance

TInt CFont::TMeasureTextInput::iMaxAdvance

The maximum advance.

Definition at line 1513 of file gdi.h.

◆ iMaxBounds

TInt CFont::TMeasureTextInput::iMaxBounds

The maximum width (or height if drawing vertically) of bounds.

Definition at line 1516 of file gdi.h.

◆ iStartInputChar

TInt CFont::TMeasureTextInput::iStartInputChar

Starting index specifying first input character in iText.

Together with iEndInputChar, this allows some context before and after the measured text to be supplied so that shaping can work properly.

Definition at line 1497 of file gdi.h.

◆ iWordJustExcess

TInt CFont::TMeasureTextInput::iWordJustExcess

The amount of space to be used for word spacing.

Definition at line 1528 of file gdi.h.

◆ iWordJustNum

TInt CFont::TMeasureTextInput::iWordJustNum

The number of spaces to be used for word spacing.

Definition at line 1525 of file gdi.h.


The documentation for this class was generated from the following file: