![]() |
![]() |
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.
Public Member Functions | |
void | add_to_cairo_context (const Cairo::RefPtr<Cairo::Context>& context) |
Adds the text in this LayoutLine to the current path in the specified Cairo context. | |
void | context_changed () |
Forces recomputation of any state in the Pango::Layout that might depend on the layout's context. | |
Glib::RefPtr<Layout> | copy () |
Does a deep copy-by-value of the src layout. | |
Alignment | get_alignment () const |
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available. | |
AttrList | get_attributes () const |
Gets the attribute list for the layout, if any. | |
bool | get_auto_dir () const |
Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout. | |
Glib::RefPtr<Context> | get_context () const |
Retrieves the Pango::Context used for this layout. | |
void | get_cursor_pos (int index, Rectangle& strong_pos, Rectangle& weak_pos) const |
Given an index within a layout, determines 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. | |
EllipsizeMode | get_ellipsize () const |
Gets the type of ellipsization being performed for layout . | |
void | get_extents (Rectangle& ink_rect, Rectangle& logical_rect) const |
Compute the logical and ink extents of layout . | |
FontDescription | get_font_description () const |
Gets the font description for the layout, if any. | |
int | get_indent () const |
Gets the paragraph indent width in pango units. | |
Rectangle | get_ink_extents () const |
Compute the ink extents of layout. | |
void | get_iter (LayoutIter& iter) |
Gets an iterator to iterate over the visual extents 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. | |
Glib::RefPtr<const LayoutLine> | get_line (int line) const |
Retrieves a particular line from a Pango::Layout. | |
Glib::RefPtr<LayoutLine> | get_line (int line) |
Retrieves a particular line from a Pango::Layout. | |
int | get_line_count () const |
Retrieves the count of lines for the layout . | |
SListHandle_ConstLayoutLine | get_lines () const |
Returns the lines of the layout as a list. | |
SListHandle_LayoutLine | get_lines () |
Returns the lines of the layout as a list. | |
Glib::ArrayHandle<LogAttr> | get_log_attrs () const |
Retrieve an array of logical attributes for each character in the 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_pixel_size (int& width, int& height) const |
Determines the logical width and height of a Pango::Layout in device units. | |
bool | get_single_paragraph_mode () const |
Obtains the value set by pango_layout_set_single_paragraph_mode(). | |
void | get_size (int& width, int& height) const |
Determines the logical width and height of a Pango::Layout in Pango units. | |
int | get_spacing () const |
Gets the amount of spacing between the lines of the layout. | |
TabArray | get_tabs () const |
Get the current Pango::TabArray used by this layout. | |
Glib::ustring | get_text () const |
Gets the text in the layout. | |
int | get_width () const |
Gets the width to which the lines of the Pango::Layout should be wrapped. | |
WrapMode | get_wrap () const |
Gets the wrap mode for the layout. | |
const PangoLayout* | gobj () const |
Provides access to the underlying C GObject. | |
PangoLayout* | gobj () |
Provides access to the underlying C GObject. | |
PangoLayout* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | index_to_line_x (int index_, bool trailing, int& line, int& x_pos) const |
Converts from byte index within the layout to line and X position. | |
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 | 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. | |
void | set_alignment (Alignment alignment) |
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available. | |
void | set_attributes (AttrList& attrs) |
Sets the text attributes for a layout object. | |
void | set_auto_dir (bool auto_dir=true) |
Sets whether to calculate the bidirectional base direction for the layout according to the contents of the layout; when this flag is on (the default), then paragraphs in layout that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-to-left layout, paragraphs with letters from other scripts will have left-to-right layout. | |
void | set_ellipsize (EllipsizeMode ellipsize) |
Sets the type of ellipsization being performed for layout . | |
void | set_font_description (const FontDescription& desc) |
Set the default font description for the layout. | |
void | set_indent (int indent) |
Sets the width in pango units to indent each paragraph. | |
void | set_justify (bool justify=true) |
Sets whether or not each complete line should be stretched to fill the entire width of the layout. | |
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_markup (const Glib::ustring& markup) |
Sets the layout text and attribute list from marked-up text (see markup format). | |
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. | |
void | set_spacing (int spacing) |
Sets the amount of spacing between the lines of the layout. | |
void | set_tabs (TabArray& tabs) |
Sets the tabs to use for layout , overriding the default tabs (by default, tabs are every 8 spaces). | |
void | set_text (const Glib::ustring& text) |
Set the text of the layout. | |
void | set_width (int width) |
Sets the width to which the lines of the Pango::Layout should be wrapped. | |
void | set_wrap (WrapMode wrap) |
Sets the wrap mode; the wrap mode only has an effect if a width is set on the layout with pango_layout_set_width(). | |
void | unset_font_description () |
void | update_from_cairo_context (const Cairo::RefPtr<Cairo::Context>& context) |
Updates the private Pango Context of a Pango Layout created with create(const Cairo::RefPtr<Cairo::Context>&) to match the current transformation and target surface of a Cairo Context. | |
bool | xy_to_index (int x, int y, int& index, int& trailing) const |
Converts from X and Y position within a layout to the byte index to the character at that logical position. | |
virtual | ~Layout () |
Static Public Member Functions | |
static Glib::RefPtr<Layout> | create (const Cairo::RefPtr<Cairo::Context>& context) |
Creates a layout object set up to match the current transformation and target surface of the Cairo context. | |
static Glib::RefPtr<Layout> | create (const Glib::RefPtr<Context>& context) |
Protected Member Functions | |
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) |
|
|
|
|
|
Adds the text in this LayoutLine to the current path in the specified Cairo context. The origin of the glyphs (the left edge of the line) will be at the current point of the cairo context.
|
|
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. |
|
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.
|
|
Creates a layout object set up to match the current transformation and target surface of the Cairo context. This layout can then be used for text measurement with functions like get_size() or drawing with methods like show_in_cairo_contet(). If you change the transformation or target surface for context, you need to call update_from_cairo_context() This is the most convenient way to use Cairo with Pango. However it is slightly inefficient since it creates a separate Pango Context object for each layout. This might matter in an application that is laying out large amounts of text.
|
|
|
|
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available. )
|
|
Gets the attribute list for the layout, if any.
|
|
Gets whether to calculate the bidirectional base direction for the layout according to the contents of the layout. See pango_layout_set_auto_dir().
|
|
Retrieves the Pango::Context used for this layout.
|
|
Given an index within a layout, determines 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.
|
|
Given an index within the layout, determine the positions that of the strong cursors if the insertion point is at that index.
|
|
Given an index within the layout, determine the positions that of the weak cursors if the insertion point is at that index.
|
|
Gets the type of ellipsization being performed for layout . See pango_layout_set_ellipsize()
|
|
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. |
|
Gets the font description for the layout, if any.
|
|
Gets the paragraph indent width in pango units. A negative value indicates a hanging indent.
|
|
Compute the ink extents of layout.
|
|
Gets an iterator to iterate over the visual extents of the layout.
|
|
Gets whether or not each complete line should be stretched to fill the entire width of the layout.
|
|
Retrieves a particular line from a Pango::Layout.
|
|
Retrieves a particular line from a Pango::Layout.
|
|
Retrieves the count of lines for the layout .
|
|
Returns the lines of the layout as a list.
|
|
Returns the lines of the layout as a list.
|
|
Retrieve an array of logical attributes for each character in the layout.
|
|
Compute the logical extents of layout.
|
|
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. |
|
Compute the ink extents of the layout in device units.
|
|
Compute the logical extents of the layout in device units.
|
|
Determines 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().
|
|
Obtains the value set by pango_layout_set_single_paragraph_mode().
|
|
Determines 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().
|
|
Gets the amount of spacing between the lines of the layout.
|
|
Get the current Pango::TabArray used by this layout. If no Pango::TabArray has been set, then the default tabs are in use and an invalid instance is returned. Default tabs are every 8 spaces.
|
|
Gets the text in the layout. The returned text should not be freed or modified.
|
|
Gets the width to which the lines of the Pango::Layout should be wrapped.
|
|
Gets the wrap mode for the layout.
|
|
Provides access to the underlying C GObject.
Reimplemented from Glib::ObjectBase. |
|
Provides access to the underlying C GObject.
Reimplemented from Glib::ObjectBase. |
|
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
|
Converts from byte index within the layout to line and X position. (X position is measured from the left edge of the line)
|
|
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.
|
|
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.
|
|
Sets the alignment for the layout (how partial lines are positioned within the horizontal space available. )
|
|
Sets the text attributes for a layout object.
|
|
Sets whether to calculate the bidirectional base direction for the layout according to the contents of the layout; when this flag is on (the default), then paragraphs in layout that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-to-left layout, paragraphs with letters from other scripts will have left-to-right layout. Paragraphs with only neutral characters get their direction from the surrounding paragraphs.
When When the auto-computed direction or a paragraph differs from the base direction of the context, then the interpretation of Pango::ALIGN_LEFT and Pango::ALIGN_RIGHT are swapped.
|
|
Sets the type of ellipsization being performed for layout . Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of lines so they fit within the width of layout set with pango_layout_set_width(). If the layout contains characters such as newlines that force it to be layed out in multiple lines, then each line is ellipsized separately. Since: 1.6
|
|
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.
|
|
Sets the width in pango units to indent each paragraph. A negative value of indent will produce a hanging indent. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent .
|
|
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. Note that as of Pango-1.4, this functionality is not yet implemented.
|
|
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.
|
|
Sets the layout text and attribute list from marked-up text (see markup format). Replaces the current text and attribute list.
|
|
If setting is Used when you want to allow editing of newlines on a single text line.
|
|
Sets the amount of spacing between the lines of the layout.
|
|
Sets the tabs to use for layout , overriding the default tabs (by default, tabs are every 8 spaces).
If tabs is
|
|
Set the text of the layout.
|
|
Sets the width to which the lines of the Pango::Layout should be wrapped.
|
|
Sets the wrap mode; the wrap mode 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.
|
|
|
|
Updates the private Pango Context of a Pango Layout created with create(const Cairo::RefPtr<Cairo::Context>&) to match the current transformation and target surface of a Cairo Context.
|
|
Converts from X and Y position within a layout to the byte index to the character at that logical position.
If the Y position is not inside the layout, the closest position is chosen (the position will be clamped inside the layout). If the X position is not within the layout, then the start or the end of the line is chosen as described for pango_layout_x_to_index(). If either the X or Y positions were not inside the layout, then the function returns
|
|
|