A Pango::AttrList represents a list of attributes that apply to a section of text.
More...
|
| AttrList () |
|
| AttrList (PangoAttrList * gobject, bool make_a_copy=true) |
|
| AttrList (const AttrList & other) |
|
AttrList & | operator= (const AttrList & other) |
|
| AttrList (AttrList && other) noexcept |
|
AttrList & | operator= (AttrList && other) noexcept |
|
| ~AttrList () noexcept |
|
void | swap (AttrList & other) noexcept |
|
PangoAttrList * | gobj () |
| Provides access to the underlying C instance.
|
|
const PangoAttrList * | gobj () const |
| Provides access to the underlying C instance.
|
|
PangoAttrList * | gobj_copy () const |
| Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
|
|
| AttrList (const Glib::ustring & markup_text, gunichar accel_marker=0) |
| Constructs an attribute list by parsing a marked-up text (see markup format).
|
|
| AttrList (const Glib::ustring & markup_text, gunichar accel_marker, Glib::ustring & text, gunichar & accel_char) |
| Constructs an attribute list by parsing a marked-up text (see markup format).
|
|
| operator bool () const |
| Tests whether the AttrList is valid.
|
|
void | insert (Attribute & attr) |
|
void | insert_before (Attribute & attr) |
|
void | change (Attribute & attr) |
|
void | splice (AttrList & other, int pos, int len) |
| This function opens up a hole in list, fills it in with attributes from the left, and then merges other on top of the hole.
|
|
void | update (int pos, int remove, int add) |
| Update indices of attributes in list for a change in the text they refer to.
|
|
std::vector< Attribute > | get_attributes () const |
| Gets a list of all attributes in list.
|
|
bool | equal (const AttrList & other_list) const |
| Checks whether list and other_list contain the same attributes and whether those attributes apply to the same ranges.
|
|
Glib::ustring | to_string () const |
| Serializes a Pango::AttrList to a string.
|
|
AttrIter | get_iter () |
| Create a iterator initialized to the beginning of the list.
|
|
A Pango::AttrList represents a list of attributes that apply to a section of text.
The attributes are, in general, allowed to overlap in an arbitrary fashion, however, if the attributes are manipulated only through Pango::AttrList::change(), the overlap between properties will meet stricter criteria.
Since the Pango::AttrList structure is stored as a linear list, it is not suitable for storing attributes for large amounts of text. In general, you should not use a single Pango::AttrList for more than one paragraph of text.
When obtaining an AttrList, you should check that it is valid. For instance, if(attrlist).
void Pango::AttrList::splice |
( |
AttrList & |
other, |
|
|
int |
pos, |
|
|
int |
len |
|
) |
| |
This function opens up a hole in list, fills it in with attributes from the left, and then merges other on top of the hole.
This operation is equivalent to stretching every attribute that applies at position pos in list by an amount len, and then calling change() with a copy of each attribute in other in sequence (offset in position by pos, and limited in length to len).
This operation proves useful for, for instance, inserting a pre-edit string in the middle of an edit buffer.
For backwards compatibility, the function behaves differently when len is 0. In this case, the attributes from other are not imited to len, and are just overlayed on top of list.
This mode is useful for merging two lists of attributes together.
- Parameters
-
other | Another Pango::AttrList . |
pos | The position in list at which to insert other. |
len | The length of the spliced segment. (Note that this must be specified since the attributes in other may only be present at some subsection of this range). |
Glib::ustring Pango::AttrList::to_string |
( |
| ) |
const |
Serializes a Pango::AttrList
to a string.
In the resulting string, serialized attributes are separated by newlines or commas. Individual attributes are serialized to a string of the form
START END TYPE VALUE
Where START and END are the indices (with -1 being accepted in place of MAXUINT), TYPE is the nickname of the attribute value type, e.g. weight or stretch, and the value is serialized according to its type:
- enum values as nick or numeric value
- boolean values as true or false
- integers and floats as numbers
- strings as string, optionally quoted
- font features as quoted string
- PangoLanguage as string
- PangoFontDescription as serialized by Pango::FontDescription::to_string(), quoted
- PangoColor as serialized by Pango::Color::to_string()
Examples:
0 10 foreground red, 5 15 weight bold, 0 200 font-desc "Sans 10"
0 -1 weight 700
0 100 family Times
To parse the returned value, use from_string().
Note that shape attributes can not be serialized.
- Since pangomm 2.50:
- Returns
- A newly allocated string.
void Pango::AttrList::update |
( |
int |
pos, |
|
|
int |
remove, |
|
|
int |
add |
|
) |
| |
Update indices of attributes in list for a change in the text they refer to.
The change that this function applies is removing remove bytes at position pos and inserting add bytes instead.
Attributes that fall entirely in the ( pos, pos + remove) range are removed.
Attributes that start or end inside the ( pos, pos + remove) range are shortened to reflect the removal.
Attributes start and end positions are updated if they are behind pos + remove.
- Since pangomm 2.50:
- Parameters
-
pos | The position of the change. |
remove | The number of removed bytes. |
add | The number of added bytes. |