ParagraphLayout::Line Class Reference

This class represents a single line of text in a ParagraphLayout. More...

#include <ParagraphLayout.h>

Inheritance diagram for ParagraphLayout::Line:
UObject UMemory

Public Member Functions

 ~Line ()
 The constructor is private since these objects can only be created by ParagraphLayout.
le_int32 countRuns () const
 Count the number of visual runs in the line.
le_int32 getAscent () const
 Get the ascent of the line.
le_int32 getDescent () const
 Get the descent of the line.
le_int32 getLeading () const
 Get the leading of the line.
le_int32 getWidth () const
 Get the width of the line.
const VisualRungetVisualRun (le_int32 runIndex) const
 Get a ParagraphLayout::VisualRun object for a given visual run in the line.
virtual UClassID getDynamicClassID () const
 ICU "poor man's RTTI", returns a UClassID for the actual class.

Static Public Member Functions

static UClassID getStaticClassID ()
 ICU "poor man's RTTI", returns a UClassID for this class.

Friends

class ParagraphLayout

Detailed Description

This class represents a single line of text in a ParagraphLayout.

They can only be created by calling ParagraphLayout::nextLine(). Each line consists of multiple visual runs, represented by ParagraphLayout::VisualRun objects.

See also:
ParagraphLayout
ParagraphLayout::VisualRun
Stable:
ICU 3.2

Definition at line 60 of file ParagraphLayout.h.


Constructor & Destructor Documentation

ParagraphLayout::Line::~Line (  ) 

The constructor is private since these objects can only be created by ParagraphLayout.

However, it is the clients responsibility to destroy the objects, so the destructor is public.

Stable:
ICU 3.2

Member Function Documentation

le_int32 ParagraphLayout::Line::countRuns (  )  const [inline]

Count the number of visual runs in the line.

Returns:
the number of visual runs.
Stable:
ICU 3.2

Definition at line 665 of file ParagraphLayout.h.

le_int32 ParagraphLayout::Line::getAscent (  )  const

Get the ascent of the line.

This is the maximum ascent of all the fonts on the line.

Returns:
the ascent of the line.
Stable:
ICU 3.2
le_int32 ParagraphLayout::Line::getDescent (  )  const

Get the descent of the line.

This is the maximum descent of all the fonts on the line.

Returns:
the descent of the line.
Stable:
ICU 3.2
virtual UClassID ParagraphLayout::Line::getDynamicClassID ( void   )  const [inline, virtual]

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:
ICU 3.2

Implements UObject.

Definition at line 152 of file ParagraphLayout.h.

le_int32 ParagraphLayout::Line::getLeading (  )  const

Get the leading of the line.

This is the maximum leading of all the fonts on the line.

Returns:
the leading of the line.
Stable:
ICU 3.2
static UClassID ParagraphLayout::Line::getStaticClassID ( void   )  [inline, static]

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:
ICU 3.2

Definition at line 145 of file ParagraphLayout.h.

const VisualRun* ParagraphLayout::Line::getVisualRun ( le_int32  runIndex  )  const

Get a ParagraphLayout::VisualRun object for a given visual run in the line.

Parameters:
runIndex is the index of the run, in visual order.
Returns:
the ParagraphLayout::VisualRun object representing the visual run. This object is owned by the Line object which created it, and will remain valid for as long as the Line object is valid.
See also:
ParagraphLayout::VisualRun
Stable:
ICU 3.2
le_int32 ParagraphLayout::Line::getWidth (  )  const

Get the width of the line.

This is a convenience method which returns the last X position of the last visual run in the line.

Returns:
the width of the line.
Stable:
ICU 2.8

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sat Jan 23 15:17:43 2010 for ICU 4.3.4 by  doxygen 1.6.1