Enter your search terms GNU-Darwin Web Submit search form

Widgets     Book   Pango::Layout Class Reference A Pango::Layout represents and entire paragraph of text. More... Inheritance diagram for Pango::Layout: [legend]List of all members. Public Methods virtual  ~Layout () PangoLayout*  gobj () const PangoLayout*  gobj () const PangoLayout*  gobj_copy () Glib::RefPtr<Layout>  copy ()   Does a deep copy-by-value of the src layout. Glib::RefPtr<Context>  get_context () const   Retrieves the Pango::Context used for this layout. void  set_attributes (AttrList& attrs)   Sets the text attributes for a layout object. AttrList  get_attributes () const   Gets the attribute list for the layout, if any. void  set_text (const Glib::ustring& text)   Set the text of the layout. Glib::ustring  get_text () const   Gets the text in the layout. void  set_markup (const Glib::ustring& markup)   Sets the layout text and attribute list from marked-up text (see markup format). void  set_markup (const Glib::ustring& markup, gunichar accel_marker, gunichar& accel_char)   Sets the layout text and attribute list from marked-up text (see markup format). void  set_font_description (const FontDescription& desc)   Set the default font description for the layout. void  set_width (int width)   Sets the width to which the lines of the Pango::Layout should be wrapped. int  get_width () const   Gets the width to which the lines of the Pango::Layout should be wrapped. void  set_wrap (WrapMode wrap)   Sets the wrap style; the wrap style only has an effect if a width is set on the layout with pango_layout_set_width(). WrapMode  get_wrap () const   Get the wrap mode for the layout. void  set_indent (int indent)   Sets the amount by which the first line should be shorter than the rest of the lines. int  get_indent () const   Gets the amount by which the first line should be shorter than the rest of the lines. void  set_spacing (int spacing)   Sets the amount of spacing between the lines of the layout. int  get_spacing () const   Gets the amount of spacing between the lines of the layout. void  set_justify (bool justify=true)   Sets whether or not each complete line should be stretched to fill the entire width of the layout. bool  get_justify () const   Gets whether or not each complete line should be stretched to fill the entire width of the layout. void  set_alignment (Alignment alignment)   Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.). Alignment  get_alignment () const   Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.). void  set_tabs (TabArray& tabs)   Sets the tabs to use for layout , overriding the default tabs (by default, tabs are every 8 spaces). TabArray  get_tabs () const   Get the current Pango::TabArray used by this layout. void  set_single_paragraph_mode (bool setting=true)   If setting is true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. bool  get_single_paragraph_mode () const   Obtains the value set by pango_layout_set_single_paragraph_mode(). void  context_changed ()   Forces recomputation of any state in the Pango::Layout that might depend on the layout's context. Glib::ArrayHandle<LogAttr>  get_log_attrs () const   Retrieve an array of logical attributes for each character in the layout. Rectangle  index_to_pos (int index) const   Convert from an index within the layout to the onscreen position corresponding to the grapheme at that index, which is represented as rectangle. void  get_cursor_pos (int index, Rectangle& strong_pos, Rectangle& weak_pos) const   Given an index within a layout, determine the positions that of the strong and weak cursors if the insertion point is at that index. Rectangle  get_cursor_strong_pos (int index) const   Given an index within the layout, determine the positions that of the strong cursors if the insertion point is at that index. Rectangle  get_cursor_weak_pos (int index) const   Given an index within the layout, determine the positions that of the weak cursors if the insertion point is at that index. void  move_cursor_visually (bool strong, int old_index, int old_trailing, int direction, int& new_index, int& new_trailing) const   Computes a new cursor position from an old position and a count of positions to move visually. bool  xy_to_index (int x, int y, int& index, int& trailing) const   Convert from X and Y position within a layout to the byte index to the character at that logical position. void  get_extents (Rectangle& ink_rect, Rectangle& logical_rect) const   Compute the logical and ink extents of layout . Rectangle  get_ink_extents () const   Compute the ink extents of layout. Rectangle  get_logical_extents () const   Compute the logical extents of layout. void  get_pixel_extents (Rectangle& ink_rect, Rectangle& logical_rect) const   Compute the logical and ink extents of layout in device units. Rectangle  get_pixel_ink_extents () const   Compute the ink extents of the layout in device units. Rectangle  get_pixel_logical_extents () const   Compute the logical extents of the layout in device units. void  get_size (int& width, int& height) const   Determine the logical width and height of a Pango::Layout in Pango units. void  get_pixel_size (int& width, int& height) const   Determine the logical width and height of a Pango::Layout in device units. int  get_line_count () const   Retrieve the count of lines for the layout . Glib::RefPtr<LayoutLine>  get_line (int line) const   Retrieves a particular line from a Pango::Layout. SListHandle_LayoutLine  get_lines () const   Return the lines of the layout as a list. void  get_iter (LayoutIter& iter)   Gets an iterator to iterate over the visual extents of the layout. Static Public Methods Glib::RefPtr<Layout>  create (const Glib::RefPtr<Context>& context) Protected Methods   Layout (const Glib::RefPtr<Context>& context) Related Functions (Note that these are not member functions.) Glib::RefPtr<Pango::Layout>  wrap (PangoLayout* object, bool take_copy=false) Detailed Description A Pango::Layout represents and entire paragraph of text. It is initialized with a Pango::Context, UTF-8 string and set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made. Constructor & Destructor Documentation virtual Pango::Layout::~Layout (   )  [virtual] Pango::Layout::Layout ( const Glib::RefPtr<Context>&    context )  [explicit, protected] Member Function Documentation void Pango::Layout::context_changed (   )    Forces recomputation of any state in the Pango::Layout that might depend on the layout's context. This function should be called if you make changes to the context subsequent to creating the layout. Glib::RefPtr<Layout> Pango::Layout::copy (   )    Does a deep copy-by-value of the src layout. The attribute list, tab array, and text from the original layout are all copied by value. Returns: A new Pango::Layout identical to src . Glib::RefPtr<Layout> Pango::Layout::create ( const Glib::RefPtr<Context>&    context )  [static] Alignment Pango::Layout::get_alignment (   )  const   Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.). Returns: The alignment value. AttrList Pango::Layout::get_attributes (   )  const   Gets the attribute list for the layout, if any. Returns: A Pango::AttrList. Glib::RefPtr<Context> Pango::Layout::get_context (   )  const   Retrieves the Pango::Context used for this layout. Returns: The Pango::Context for the layout. This does not have an additional refcount added, so if you want to keep a copy of this around, you must reference it yourself. void Pango::Layout::get_cursor_pos ( int    index, Rectangle&    strong_pos, Rectangle&    weak_pos )  const   Given an index within a layout, determine the positions that of the strong and weak cursors if the insertion point is at that index. The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted. Parameters: index_  The byte index of the cursor. strong_pos  Location to store the strong cursor position (may be 0). weak_pos  Location to store the weak cursor position (may be 0). Rectangle Pango::Layout::get_cursor_strong_pos ( int    index )  const   Given an index within the layout, determine the positions that of the strong cursors if the insertion point is at that index. Parameters: index  The byte index of the cursor. Returns: The strong cursor position. Rectangle Pango::Layout::get_cursor_weak_pos ( int    index )  const   Given an index within the layout, determine the positions that of the weak cursors if the insertion point is at that index. Parameters: index  The byte index of the cursor. Returns: The weak cursor position. void Pango::Layout::get_extents ( Rectangle&    ink_rect, Rectangle&    logical_rect )  const   Compute the logical and ink extents of layout . Logical extents are usually what you want for positioning things. The extents are given in layout coordinates; layout coordinates begin at the top left corner of the layout. Parameters: ink_rect  Rectangle used to store the extents of the layout as drawn or 0 to indicate that the result is not needed. logical_rect  Rectangle used to store the logical extents of the layout or 0 to indicate that the result is not needed. int Pango::Layout::get_indent (   )  const   Gets the amount by which the first line should be shorter than the rest of the lines. Returns: The indent. Rectangle Pango::Layout::get_ink_extents (   )  const   Compute the ink extents of layout. Returns: The extents of the layout as drawn. void Pango::Layout::get_iter ( LayoutIter&    iter )    Gets an iterator to iterate over the visual extents of the layout. Parameters: iter  Location to store the iterator. bool Pango::Layout::get_justify (   )  const   Gets whether or not each complete line should be stretched to fill the entire width of the layout. Returns: The justify. Glib::RefPtr<LayoutLine> Pango::Layout::get_line ( int    line )  const   Retrieves a particular line from a Pango::Layout. Parameters: line  The index of a line, which must be between 0 and pango_layout_get_line_count(layout) - 1, inclusive. Returns: The requested Pango::LayoutLine, or 0 if the index is out of range. This layout line can be ref'ed and retained, but will become invalid if changes are made to the Pango::Layout. int Pango::Layout::get_line_count (   )  const   Retrieve the count of lines for the layout . Returns: The line count. SListHandle_LayoutLine Pango::Layout::get_lines (   )  const   Return the lines of the layout as a list. Returns: A G::SList containing the lines in the layout. This points to internal data of the Pango::Layout and must be used with care. It will become invalid on any change to the layout's text or properties. Glib::ArrayHandle<LogAttr> Pango::Layout::get_log_attrs (   )  const   Retrieve an array of logical attributes for each character in the layout. Returns: An array of logical attributes. Rectangle Pango::Layout::get_logical_extents (   )  const   Compute the logical extents of layout. Returns: The logical extents of the layout. void Pango::Layout::get_pixel_extents ( Rectangle&    ink_rect, Rectangle&    logical_rect )  const   Compute the logical and ink extents of layout in device units. See pango_layout_get_extents(); this function just calls pango_layout_get_extents() and then converts the extents to pixels using the Pango::SCALE factor. Parameters: ink_rect  Rectangle used to store the extents of the layout as drawn or 0 to indicate that the result is not needed. logical_rect  Rectangle used to store the logical extents of the layout or 0 to indicate that the result is not needed. Rectangle Pango::Layout::get_pixel_ink_extents (   )  const   Compute the ink extents of the layout in device units. Returns: The extents of the layout as drawn. Rectangle Pango::Layout::get_pixel_logical_extents (   )  const   Compute the logical extents of the layout in device units. Returns: The logical extents of the layout. void Pango::Layout::get_pixel_size ( int&    width, int&    height )  const   Determine the logical width and height of a Pango::Layout in device units. (pango_layout_get_size() returns the width and height in thousandths of a device unit.) This is simply a convenience function around pango_layout_get_extents. Parameters: width  Location to store the logical width, or 0. height  Location to store the logical height, or 0. bool Pango::Layout::get_single_paragraph_mode (   )  const   Obtains the value set by pango_layout_set_single_paragraph_mode(). Returns: true if the layout does not break paragraphs at paragraph separator characters. void Pango::Layout::get_size ( int&    width, int&    height )  const   Determine the logical width and height of a Pango::Layout in Pango units. (device units divided by PANGO_SCALE). This is simply a convenience function around pango_layout_get_extents. Parameters: width  Location to store the logical width, or 0. height  Location to store the logical height, or 0. int Pango::Layout::get_spacing (   )  const   Gets the amount of spacing between the lines of the layout. Returns: The spacing (in thousandths of a device unit). TabArray Pango::Layout::get_tabs (   )  const   Get the current Pango::TabArray used by this layout. If no Pango::TabArray has been set, then the default tabs are in use and 0 is returned. Default tabs are every 8 spaces. The return value should be freed with pango_tab_array_free(). Returns: A copy of the tabs for this layout, or 0. Glib::ustring Pango::Layout::get_text (   )  const   Gets the text in the layout. The returned text should not be freed or modified. Returns: The text in the layout . int Pango::Layout::get_width (   )  const   Gets the width to which the lines of the Pango::Layout should be wrapped. Returns: The width. WrapMode Pango::Layout::get_wrap (   )  const   Get the wrap mode for the layout. Returns: Active wrap mode. const PangoLayout* Pango::Layout::gobj (   )  const [inline]   Reimplemented from Glib::ObjectBase. PangoLayout* Pango::Layout::gobj (   )  [inline]   Reimplemented from Glib::ObjectBase. PangoLayout* Pango::Layout::gobj_copy (   )  Rectangle Pango::Layout::index_to_pos ( int    index )  const   Convert from an index within the layout to the onscreen position corresponding to the grapheme at that index, which is represented as rectangle. Note that x in the returned rectangle is always the leading edge of the grapheme and x + width the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then width will be negative. Parameters: index  Byte index within layout. Returns: The position of the grapheme. void Pango::Layout::move_cursor_visually ( bool    strong, int    old_index, int    old_trailing, int    direction, int&    new_index, int&    new_trailing )  const   Computes a new cursor position from an old position and a count of positions to move visually. If count is positive, then the new strong cursor position will be one position to the right of the old cursor position. If count is position then the new strong cursor position will be one position to the left of the old cursor position. In the presence of bidirection text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run. Motion here is in cursor positions, not in characters, so a single call to pango_layout_move_cursor_visually() may move the cursor over multiple characters when multiple characters combine to form a single grapheme. Parameters: strong  Whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout. old_index  The byte index of the grapheme for the old index. old_trailing  If 0, the cursor was at the trailing edge of the grapheme indicated by old_index , if > 0, the cursor was at the leading edge. direction  Direction to move cursor. A negative value indicates motion to the left. new_index  Location to store the new cursor byte index. A value of -1 indicates that the cursor has been moved off the beginning of the layout. A value of G_MAXINT indicates that the cursor has been moved off the end of the layout. new_trailing  Number of characters to move forward from the location returned for new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. new_index is always on the line where the cursor should be displayed. void Pango::Layout::set_alignment ( Alignment    alignment )    Sets the alignment for the layout (how partial lines are positioned within the horizontal space available.). Parameters: alignment  The new alignment. void Pango::Layout::set_attributes ( AttrList&    attrs )    Sets the text attributes for a layout object. Parameters: attrs  A Pango::AttrList. void Pango::Layout::set_font_description ( const FontDescription&    desc )    Set the default font description for the layout. If no font description is set on the layout, the font description from the layout's context is used. Parameters: desc  The new pango font description, or 0 to unset the current font description. void Pango::Layout::set_indent ( int    indent )    Sets the amount by which the first line should be shorter than the rest of the lines. This may be negative, in which case the subsequent lines will be shorter than the first line. (However, in either case, the entire width of the layout will be given by the value Parameters: indent  The amount by which to indent. void Pango::Layout::set_justify ( bool    justify = true )    Sets whether or not each complete line should be stretched to fill the entire width of the layout. This stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification is done by extending the characters. Parameters: justify  Whether the lines in the layout should be justified. void Pango::Layout::set_markup ( const Glib::ustring&    markup, gunichar    accel_marker, gunichar&    accel_char )    Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list. If accel_marker is nonzero, the given character will mark the character following it as an accelerator. For example, the accel marker might be an ampersand or underscore. All characters marked as an accelerator will receive a Pango::UNDERLINE_LOW attribute, and the first character so marked will be returned in accel_char. Two accel_marker characters following each other produce a single literal accel_marker character. Parameters: markup  Some marked-up text. accel_marker  Marker for accelerators in the text. accel_char  Return location for any located accelerators. void Pango::Layout::set_markup ( const Glib::ustring&    markup )    Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list. Parameters: markup  Some marked-up text. void Pango::Layout::set_single_paragraph_mode ( bool    setting = true )    If setting is true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line. Parameters: setting  New setting. void Pango::Layout::set_spacing ( int    spacing )    Sets the amount of spacing between the lines of the layout. Parameters: spacing  The amount of spacing. void Pango::Layout::set_tabs ( TabArray&    tabs )    Sets the tabs to use for layout , overriding the default tabs (by default, tabs are every 8 spaces). If tabs is 0, the default tabs are reinstated. tabs is copied into the layout; you must free your copy of tabs yourself. Parameters: tabs  A Pango::TabArray. void Pango::Layout::set_text ( const Glib::ustring&    text )    Set the text of the layout. Parameters: text  The text for the layout. void Pango::Layout::set_width ( int    width )    Sets the width to which the lines of the Pango::Layout should be wrapped. Parameters: width  The desired width, or -1 to indicate that no wrapping should be performed. void Pango::Layout::set_wrap ( WrapMode    wrap )    Sets the wrap style; the wrap style only has an effect if a width is set on the layout with pango_layout_set_width(). To turn off wrapping, set the width to -1. Parameters: wrap  Wrap mode. bool Pango::Layout::xy_to_index ( int    x, int    y, int&    index, int&    trailing )  const   Convert from X and Y position within a layout to the byte index to the character at that logical position. If the position is not inside the layout, the closest position is chosen (the x/y position will be clamped inside the layout). If a closest position is chosen, then the function returns false; on an exact hit, it returns true. Parameters: x  The X offset (in thousandths of a device unit) from the left edge of the layout. y  The Y offset (in thousandths of a device unit) from the top edge of the layout. index_  Location to store calculated byte index. trailing  Location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the trailing edge of the grapheme. Returns: true if the coordinates were inside text. Friends And Related Function Documentation Glib::RefPtr<Pango::Layout> wrap ( PangoLayout*    object, bool    take_copy = false )  [related] The documentation for this class was generated from the following file: pango/pangomm/layout.h