pangomm 2.54.0
Public Member Functions | Static Public Member Functions | Protected Attributes | Related Symbols | List of all members
Pango::AttrList Class Reference

A Pango::AttrList represents a list of attributes that apply to a section of text. More...

#include <pangomm/attrlist.h>

Public Member Functions

 AttrList ()
 
 AttrList (PangoAttrList * gobject, bool make_a_copy=true)
 
 AttrList (const AttrList & other)
 
AttrListoperator= (const AttrList & other)
 
 AttrList (AttrList && other) noexcept
 
AttrListoperator= (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< Attributeget_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.
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static AttrList from_string (const Glib::ustring & text)
 Deserializes a Pango::AttrList from a string.
 

Protected Attributes

PangoAttrList * gobject_
 

Related Symbols

(Note that these are not member symbols.)

void swap (AttrList & lhs, AttrList & rhs) noexcept
 
Pango::AttrList wrap (PangoAttrList * object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

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).

Constructor & Destructor Documentation

◆ AttrList() [1/6]

Pango::AttrList::AttrList ( )

◆ AttrList() [2/6]

Pango::AttrList::AttrList ( PangoAttrList *  gobject,
bool  make_a_copy = true 
)
explicit

◆ AttrList() [3/6]

Pango::AttrList::AttrList ( const AttrList other)

◆ AttrList() [4/6]

Pango::AttrList::AttrList ( AttrList &&  other)
noexcept

◆ ~AttrList()

Pango::AttrList::~AttrList ( )
noexcept

◆ AttrList() [5/6]

Pango::AttrList::AttrList ( const Glib::ustring &  markup_text,
gunichar  accel_marker = 0 
)
explicit

Constructs an attribute list by parsing a marked-up text (see markup format).

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. Two accel_marker characters following each other produce a single literal accel_marker character.

Parameters
markup_textMarkup to parse (see markup format).
accel_markerCharacter that precedes an accelerator, or 0 for none.

◆ AttrList() [6/6]

Pango::AttrList::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).

text is set to the plaintext string. 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. 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_textMarkup to parse (see markup format).
accel_markerCharacter that precedes an accelerator, or 0 for none.
textReturn location for text with tags stripped.
accel_charReturn location for accelerator char.

Member Function Documentation

◆ change()

void Pango::AttrList::change ( Attribute attr)

◆ equal()

bool Pango::AttrList::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.

Beware that this will return wrong values if any list contains duplicates.

Since pangomm 2.50:
Parameters
other_listThe other Pango::AttrList.
Returns
true if the lists are equal, false if they aren't.

◆ from_string()

static AttrList Pango::AttrList::from_string ( const Glib::ustring &  text)
static

Deserializes a Pango::AttrList from a string.

This is the counterpart to to_string(). See that functions for details about the format.

Since pangomm 2.50:
Parameters
textA string.
Returns
A new Pango::AttrList.

◆ get_attributes()

std::vector< Attribute > Pango::AttrList::get_attributes ( ) const

Gets a list of all attributes in list.

Since pangomm 2.50:
Returns
A list of all attributes in list. To free this value, call [method Pango.Attribute.

◆ get_iter()

AttrIter Pango::AttrList::get_iter ( )

Create a iterator initialized to the beginning of the list.

list must not be modified until this iterator is freed.

Returns
The newly allocated Pango::AttrIterator, which should be freed with Pango::AttrIterator::destroy().

◆ get_type()

static GType Pango::AttrList::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

PangoAttrList * Pango::AttrList::gobj ( )
inline

Provides access to the underlying C instance.

◆ gobj() [2/2]

const PangoAttrList * Pango::AttrList::gobj ( ) const
inline

Provides access to the underlying C instance.

◆ gobj_copy()

PangoAttrList * Pango::AttrList::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

◆ insert()

void Pango::AttrList::insert ( Attribute attr)

◆ insert_before()

void Pango::AttrList::insert_before ( Attribute attr)

◆ operator bool()

Pango::AttrList::operator bool ( ) const
explicit

Tests whether the AttrList is valid.

◆ operator=() [1/2]

AttrList & Pango::AttrList::operator= ( AttrList &&  other)
noexcept

◆ operator=() [2/2]

AttrList & Pango::AttrList::operator= ( const AttrList other)

◆ splice()

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
otherAnother Pango::AttrList.
posThe position in list at which to insert other.
lenThe 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).

◆ swap()

void Pango::AttrList::swap ( AttrList other)
noexcept

◆ to_string()

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.

◆ update()

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
posThe position of the change.
removeThe number of removed bytes.
addThe number of added bytes.

Friends And Related Symbol Documentation

◆ swap()

void swap ( AttrList lhs,
AttrList rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side

◆ wrap()

Pango::AttrList wrap ( PangoAttrList *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

Member Data Documentation

◆ gobject_

PangoAttrList* Pango::AttrList::gobject_
protected