logo top
Main Page   Widgets   Namespaces   Book  

Pango::LayoutIter Class Reference

A Pango::LayoutIter can be used to iterate over the visual extents of a Pango::Layout. More...

List of all members.

Public Member Functions

 LayoutIter ()
 ~LayoutIter ()
int get_index () const
LayoutRun get_run () const
Glib::RefPtr<LayoutLineget_line () const
bool at_last_line () const
bool next_char ()
bool next_cluster ()
bool next_run ()
bool next_line ()
Rectangle get_char_extents () const
 Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout).

void get_cluster_extents (Rectangle& ink_rect, Rectangle& logical_rect) const
Rectangle get_cluster_ink_extents () const
 Gets the ink extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).

Rectangle get_cluster_logical_extents () const
 Gets the logical extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).

void get_run_extents (Rectangle& ink_rect, Rectangle& logical_rect) const
Rectangle get_run_ink_extents () const
 Gets the ink extents of the current run in layout coordinates (origin is the top left of the entire layout).

Rectangle get_run_logical_extents () const
 Gets the logical extents of the current run in layout coordinates (origin is the top left of the entire layout).

void get_line_extents (Rectangle& ink_rect, Rectangle& logical_rect) const
Rectangle get_line_ink_extents () const
 Obtains the ink extents of the current line.

Rectangle get_line_logical_extents () const
 Obtains the logical extents of the current line.

void get_line_yrange (int& y0, int& y1) const
void get_layout_extents (Rectangle& ink_rect, Rectangle& logical_rect) const
Rectangle get_layout_ink_extents () const
 Obtains the ink extents of the Pango::Layout being iterated over.

Rectangle get_layout_logical_extents () const
 Obtains the logical extents of the Pango::Layout being iterated over.

int get_baseline () const
PangoLayoutIter* gobj ()
const PangoLayoutIter* gobj () const

Protected Attributes

PangoLayoutIter* gobject_


Detailed Description

A Pango::LayoutIter can be used to iterate over the visual extents of a Pango::Layout.


Constructor & Destructor Documentation

Pango::LayoutIter::LayoutIter (  ) 
 

Pango::LayoutIter::~LayoutIter (  ) 
 


Member Function Documentation

bool Pango::LayoutIter::at_last_line (  )  const
 

int Pango::LayoutIter::get_baseline (  )  const
 

Rectangle Pango::LayoutIter::get_char_extents (  )  const
 

Gets the extents of the current character, in layout coordinates (origin is the top left of the entire layout).

Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters.

Returns:
The logical extents of the current character.

void Pango::LayoutIter::get_cluster_extents ( Rectangle ink_rect,
Rectangle logical_rect
const
 

Rectangle Pango::LayoutIter::get_cluster_ink_extents (  )  const
 

Gets the ink extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).

Returns:
The extents of the current cluster as drawn.

Rectangle Pango::LayoutIter::get_cluster_logical_extents (  )  const
 

Gets the logical extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).

Returns:
The logical extents of the current cluster.

int Pango::LayoutIter::get_index (  )  const
 

void Pango::LayoutIter::get_layout_extents ( Rectangle ink_rect,
Rectangle logical_rect
const
 

Rectangle Pango::LayoutIter::get_layout_ink_extents (  )  const
 

Obtains the ink extents of the Pango::Layout being iterated over.

Returns:
The extents of the layout as drawn.

Rectangle Pango::LayoutIter::get_layout_logical_extents (  )  const
 

Obtains the logical extents of the Pango::Layout being iterated over.

Returns:
The logical extents of the layout.

Glib::RefPtr<LayoutLine> Pango::LayoutIter::get_line (  )  const
 

void Pango::LayoutIter::get_line_extents ( Rectangle ink_rect,
Rectangle logical_rect
const
 

Rectangle Pango::LayoutIter::get_line_ink_extents (  )  const
 

Obtains the ink extents of the current line.

Returns:
The extents of the current line as drawn.

Rectangle Pango::LayoutIter::get_line_logical_extents (  )  const
 

Obtains the logical extents of the current line.

Returns:
The logical extents of the current line.

void Pango::LayoutIter::get_line_yrange ( int&  y0,
int&  y1
const
 

LayoutRun Pango::LayoutIter::get_run (  )  const
 

void Pango::LayoutIter::get_run_extents ( Rectangle ink_rect,
Rectangle logical_rect
const
 

Rectangle Pango::LayoutIter::get_run_ink_extents (  )  const
 

Gets the ink extents of the current run in layout coordinates (origin is the top left of the entire layout).

Returns:
The extents of the current run as drawn.

Rectangle Pango::LayoutIter::get_run_logical_extents (  )  const
 

Gets the logical extents of the current run in layout coordinates (origin is the top left of the entire layout).

Returns:
The logical extents of the current run.

const PangoLayoutIter* Pango::LayoutIter::gobj (  )  const [inline]
 

PangoLayoutIter* Pango::LayoutIter::gobj (  )  [inline]
 

bool Pango::LayoutIter::next_char (  ) 
 

bool Pango::LayoutIter::next_cluster (  ) 
 

bool Pango::LayoutIter::next_line (  ) 
 

bool Pango::LayoutIter::next_run (  ) 
 


Member Data Documentation

PangoLayoutIter* Pango::LayoutIter::gobject_ [protected]
 


The documentation for this class was generated from the following file:
Generated for gtkmm2.2 by Doxygen 1.3.3 © 1997-2001