Pango Reference Manual
<<< PrevHomeUpNext >>>

Text Attributes

Text Attributes — Font and other attributes for annotating text.

Synopsis




enum        PangoAttrType;
#define     PANGO_TYPE_ATTR_TYPE
struct      PangoAttrClass;
struct      PangoAttribute;
struct      PangoAttrString;
struct      PangoAttrLanguage;
struct      PangoAttrColor;
struct      PangoAttrInt;
struct      PangoAttrFloat;
struct      PangoAttrFontDesc;
struct      PangoAttrShape;
gboolean    pango_parse_markup              (const char *markup_text,
                                             int length,
                                             gunichar accel_marker,
                                             PangoAttrList **attr_list,
                                             char **text,
                                             gunichar *accel_char,
                                             GError **error);
PangoAttrType pango_attr_type_register      (const gchar *name);
PangoAttribute* pango_attribute_copy        (const PangoAttribute *attr);
gboolean    pango_attribute_equal           (const PangoAttribute *attr1,
                                             const PangoAttribute *attr2);
void        pango_attribute_destroy         (PangoAttribute *attr);

PangoAttribute* pango_attr_language_new     (PangoLanguage *language);
PangoAttribute* pango_attr_family_new       (const char *family);
PangoAttribute* pango_attr_style_new        (PangoStyle style);
PangoAttribute* pango_attr_variant_new      (PangoVariant variant);
PangoAttribute* pango_attr_stretch_new      (PangoStretch stretch);
PangoAttribute* pango_attr_weight_new       (PangoWeight weight);
PangoAttribute* pango_attr_size_new         (int size);
PangoAttribute* pango_attr_font_desc_new    (const PangoFontDescription *desc);
PangoAttribute* pango_attr_foreground_new   (guint16 red,
                                             guint16 green,
                                             guint16 blue);
PangoAttribute* pango_attr_background_new   (guint16 red,
                                             guint16 green,
                                             guint16 blue);
PangoAttribute* pango_attr_strikethrough_new
                                            (gboolean strikethrough);
PangoAttribute* pango_attr_underline_new    (PangoUnderline underline);
enum        PangoUnderline;
#define     PANGO_TYPE_UNDERLINE
PangoAttribute* pango_attr_shape_new        (const PangoRectangle *ink_rect,
                                             const PangoRectangle *logical_rect);
PangoAttribute* pango_attr_scale_new        (double scale_factor);
#define     PANGO_SCALE_XX_SMALL
#define     PANGO_SCALE_X_SMALL
#define     PANGO_SCALE_SMALL
#define     PANGO_SCALE_MEDIUM
#define     PANGO_SCALE_LARGE
#define     PANGO_SCALE_X_LARGE
#define     PANGO_SCALE_XX_LARGE
PangoAttribute* pango_attr_rise_new         (int rise);
struct      PangoColor;
#define     PANGO_TYPE_COLOR
void        pango_color_free                (PangoColor *color);
gboolean    pango_color_parse               (PangoColor *color,
                                             const char *spec);
PangoColor* pango_color_copy                (const PangoColor *src);
struct      PangoLanguage;
#define     PANGO_TYPE_LANGUAGE
PangoLanguage* pango_language_from_string   (const char *language);
#define     pango_language_to_string        (language)
gboolean    pango_language_matches          (PangoLanguage *language,
                                             const char *range_list);

struct      PangoAttrList;
#define     PANGO_TYPE_ATTR_LIST
PangoAttrList* pango_attr_list_new          (void);
void        pango_attr_list_ref             (PangoAttrList *list);
void        pango_attr_list_unref           (PangoAttrList *list);
PangoAttrList* pango_attr_list_copy         (PangoAttrList *list);
void        pango_attr_list_insert          (PangoAttrList *list,
                                             PangoAttribute *attr);
void        pango_attr_list_insert_before   (PangoAttrList *list,
                                             PangoAttribute *attr);
void        pango_attr_list_change          (PangoAttrList *list,
                                             PangoAttribute *attr);
void        pango_attr_list_splice          (PangoAttrList *list,
                                             PangoAttrList *other,
                                             gint pos,
                                             gint len);
PangoAttrIterator* pango_attr_list_get_iterator
                                            (PangoAttrList *list);
struct      PangoAttrIterator;
PangoAttrIterator* pango_attr_iterator_copy (PangoAttrIterator *iterator);
gboolean    pango_attr_iterator_next        (PangoAttrIterator *iterator);
void        pango_attr_iterator_range       (PangoAttrIterator *iterator,
                                             gint *start,
                                             gint *end);
PangoAttribute* pango_attr_iterator_get     (PangoAttrIterator *iterator,
                                             PangoAttrType type);
void        pango_attr_iterator_get_font    (PangoAttrIterator *iterator,
                                             PangoFontDescription *desc,
                                             PangoLanguage **language,
                                             GSList **extra_attrs);
void        pango_attr_iterator_destroy     (PangoAttrIterator *iterator);

Description

Attributed text is used in a number of places in Pango. It is used as the input to the itemization process and also when creating a PangoLayout. The data types and functions in this section are used to represent and manipulate sets of attributes applied to a portion of text.

Details

enum PangoAttrType

typedef enum
{
  PANGO_ATTR_INVALID,           /* 0 is an invalid attribute type */
  PANGO_ATTR_LANGUAGE,		/* PangoAttrLanguage */
  PANGO_ATTR_FAMILY,		/* PangoAttrString */
  PANGO_ATTR_STYLE,		/* PangoAttrInt */
  PANGO_ATTR_WEIGHT,		/* PangoAttrInt */
  PANGO_ATTR_VARIANT,		/* PangoAttrInt */
  PANGO_ATTR_STRETCH,		/* PangoAttrInt */
  PANGO_ATTR_SIZE,		/* PangoAttrSize */
  PANGO_ATTR_FONT_DESC,		/* PangoAttrFontDesc */
  PANGO_ATTR_FOREGROUND,	/* PangoAttrColor */
  PANGO_ATTR_BACKGROUND,	/* PangoAttrColor */
  PANGO_ATTR_UNDERLINE,		/* PangoAttrInt */
  PANGO_ATTR_STRIKETHROUGH,	/* PangoAttrInt */
  PANGO_ATTR_RISE,		/* PangoAttrInt */
  PANGO_ATTR_SHAPE,		/* PangoAttrShape */
  PANGO_ATTR_SCALE              /* PangoAttrFloat */
} PangoAttrType;

distinguishes between different types of attributes. Along with the predefined values, it is possible to allocate additional values for custom attributes using pango_attr_register_type(). The predefined values are given below. The type of structure used to store the attribute is listed in parentheses after the description.

PANGO_ATTR_INVALID

PANGO_ATTR_LANGUAGE

language (PangoAttrLanguage)

PANGO_ATTR_FAMILY

font family name list (PangoAttrString)

PANGO_ATTR_STYLE

font slant style (PangoAttrInt)

PANGO_ATTR_WEIGHT

font weight (PangoAttrInt)

PANGO_ATTR_VARIANT

font variant (normal or small caps) (PangoAttrInt)

PANGO_ATTR_STRETCH

font stretch (PangoAttrInt)

PANGO_ATTR_SIZE

font size in 1000th's of a point (PangoAttrInt)

PANGO_ATTR_FONT_DESC

font description (PangoAttrFontDesc)

PANGO_ATTR_FOREGROUND

foreground color (PangoAttrColor)

PANGO_ATTR_BACKGROUND

background color (PangoAttrColor)

PANGO_ATTR_UNDERLINE

whether the text has an underline (PangoAttrInt)

PANGO_ATTR_STRIKETHROUGH

whether the text is struck-through (PangoAttrInt)

PANGO_ATTR_RISE

baseline displacement (PangoAttrInt)

PANGO_ATTR_SHAPE

shape (PangoAttrShape)

PANGO_ATTR_SCALE

font size scale factor (PangoAttrScale)


PANGO_TYPE_ATTR_TYPE

#define PANGO_TYPE_ATTR_TYPE (pango_attr_type_get_type())

The GObject type for PangoAttrType.


struct PangoAttrClass

struct PangoAttrClass
{
  PangoAttrType type;
  PangoAttribute * (*copy) (const PangoAttribute *attr);
  void             (*destroy) (PangoAttribute *attr);
  gboolean         (*equal) (const PangoAttribute *attr1, const PangoAttribute *attr2);
};

The PangoAttrClass structure stores the type and operations for a particular type of attribute. The functions in this structure should not be called directly. Instead, one should use the wrapper functions provided for PangoAttribute.

PangoAttrType type

the type ID for this attribute

PangoAttribute* (*copy) (const PangoAttribute *attr)

function to duplicate an attribute of this type (see pango_attribute_copy())

void (*destroy) (PangoAttribute *attr)

function to free an attribute of this type (see pango_attribute_destroy())

gboolean (*equal) (const PangoAttribute *attr1, const PangoAttribute *attr2)


struct PangoAttribute

struct PangoAttribute
{
  const PangoAttrClass *klass;
  guint start_index;
  guint end_index;
};

The PangoAttribute structure represents the common portions of all attributes. Particular types of attributes include this structure as their initial portion. The common portion of the attribute holds the range to which the value in the type-specific part of the attribute applies.

const PangoAttrClass *klass

the class structure holding information about the type of the attribute

guint start_index

the start index of the range.

guint end_index

end index of the range. The character at this index is not included in the range.


struct PangoAttrString

struct PangoAttrString
{
  PangoAttribute attr;
  char *value;
};

The PangoAttrString structure is used to represent attributes with a string value.

PangoAttribute attr

the common portion of the attribute

char *value

the string which is the value of the attribute


struct PangoAttrLanguage

struct PangoAttrLanguage
{
  PangoAttribute attr;
  PangoLanguage *value;
};

The PangoAttrColor structure is used to represent attributes that are languages.

PangoAttribute attr

the common portion of the attribute

PangoLanguage *value

the PangoLanguage which is the value of the attribute


struct PangoAttrColor

struct PangoAttrColor
{
  PangoAttribute attr;
  PangoColor color;
};

The PangoAttrColor structure is used to represent attributes that are colors.

PangoAttribute attr

the common portion of the attribute

PangoColor color

the PangoColor which is the value of the attribute


struct PangoAttrInt

struct PangoAttrInt
{
  PangoAttribute attr;
  int value;
};

The PangoAttrInt structure is used to represent attributes with a integer or enumeration value.

PangoAttribute attr

the common portion of the attribute

int value

the value of the attribute


struct PangoAttrFloat

struct PangoAttrFloat
{
  PangoAttribute attr;
  double value;
};

The PangoAttrFloat structure is used to represent attributes with a float or double value.

PangoAttribute attr

the common portion of the attribute

double value

the value of the attribute


struct PangoAttrFontDesc

struct PangoAttrFontDesc
{
  PangoAttribute attr;
  PangoFontDescription *desc;
};

The PangoAttrFontDesc structure is used to store an attribute that sets all aspects of the font description at once.

PangoAttribute attr

the common portion of the attribute

PangoFontDescription *desc

the font description which is the value of this attribute


struct PangoAttrShape

struct PangoAttrShape
{
  PangoAttribute attr;
  PangoRectangle ink_rect;
  PangoRectangle logical_rect;
};

The PangoAttrShape structure is used to represent attributes which impose shape restrictions.

PangoAttribute attr

the common portion of the attribute

PangoRectangle ink_rect

the ink rectangle to restrict to

PangoRectangle logical_rect

the logical rectangle to restrict to


pango_parse_markup ()

gboolean    pango_parse_markup              (const char *markup_text,
                                             int length,
                                             gunichar accel_marker,
                                             PangoAttrList **attr_list,
                                             char **text,
                                             gunichar *accel_char,
                                             GError **error);

Parses marked-up text (see markup format) to create a plaintext string and an 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.

markup_text :

markup to parse (see markup format)

length :

length of markup_text, or -1 if nul-terminated

accel_marker :

character that precedes an accelerator, or 0 for none

attr_list :

address of return location for a PangoAttrList, or NULL

text :

address of return location for text with tags stripped, or NULL

accel_char :

address of return location for accelerator char, or NULL

error :

address of return location for errors, or NULL

Returns :

FALSE if error is set, otherwise TRUE


pango_attr_type_register ()

PangoAttrType pango_attr_type_register      (const gchar *name);

Allocate a new attribute type ID.

name :

an identifier for the type. (Currently unused.)

Returns :

the new type ID.


pango_attribute_copy ()

PangoAttribute* pango_attribute_copy        (const PangoAttribute *attr);

Make a copy of an attribute.

attr :

a PangoAttribute.

Returns :

a newly allocated PangoAttribute.


pango_attribute_equal ()

gboolean    pango_attribute_equal           (const PangoAttribute *attr1,
                                             const PangoAttribute *attr2);

Compare two attributes for equality. This compares only the actual value of the two attributes and not the ranges that the attributes apply to.

attr1 :

a PangoAttribute

attr2 :

another PangoAttribute

Returns :

TRUE if the two attributes have the same value.


pango_attribute_destroy ()

void        pango_attribute_destroy         (PangoAttribute *attr);

Destroy a PangoAttribute and free all associated memory.

attr :

a PangoAttribute.


pango_attr_language_new ()

PangoAttribute* pango_attr_language_new     (PangoLanguage *language);

Create a new language tag attribute.

language :

language tag

Returns :

the new PangoAttribute.


pango_attr_family_new ()

PangoAttribute* pango_attr_family_new       (const char *family);

Create a new font family attribute.

family :

the family or comma separated list of families

Returns :

the new PangoAttribute.


pango_attr_style_new ()

PangoAttribute* pango_attr_style_new        (PangoStyle style);

Create a new font slant style attribute.

style :

the slant style

Returns :

the new PangoAttribute.


pango_attr_variant_new ()

PangoAttribute* pango_attr_variant_new      (PangoVariant variant);

Create a new font variant attribute (normal or small caps)

variant :

the variant

Returns :

the new PangoAttribute.


pango_attr_stretch_new ()

PangoAttribute* pango_attr_stretch_new      (PangoStretch stretch);

Create a new font stretch attribute

stretch :

the stretch

Returns :

the new PangoAttribute.


pango_attr_weight_new ()

PangoAttribute* pango_attr_weight_new       (PangoWeight weight);

Create a new font weight attribute.

weight :

the weight

Returns :

the new PangoAttribute.


pango_attr_size_new ()

PangoAttribute* pango_attr_size_new         (int size);

Create a new font-size attribute.

size :

the font size, in 1000ths of a point.

Returns :

the new PangoAttribute.


pango_attr_font_desc_new ()

PangoAttribute* pango_attr_font_desc_new    (const PangoFontDescription *desc);

Create a new font description attribute. (This attribute allows setting family, style, weight, variant, stretch, and size simultaneously.)

desc :

Returns :


pango_attr_foreground_new ()

PangoAttribute* pango_attr_foreground_new   (guint16 red,
                                             guint16 green,
                                             guint16 blue);

Create a new foreground color attribute.

red :

the red value (ranging from 0 to 65535)

green :

the green value

blue :

the blue value

Returns :

the new PangoAttribute.


pango_attr_background_new ()

PangoAttribute* pango_attr_background_new   (guint16 red,
                                             guint16 green,
                                             guint16 blue);

Create a new background color attribute.

red :

the red value (ranging from 0 to 65535)

green :

the green value

blue :

the blue value

Returns :

the new PangoAttribute.


pango_attr_strikethrough_new ()

PangoAttribute* pango_attr_strikethrough_new
                                            (gboolean strikethrough);

Create a new font strike-through attribute.

strikethrough :

TRUE if the text should be struck-through.

Returns :

the new PangoAttribute.


pango_attr_underline_new ()

PangoAttribute* pango_attr_underline_new    (PangoUnderline underline);

Create a new underline-style object.

underline :

the underline style.

Returns :

the new PangoAttribute.


enum PangoUnderline

typedef enum {
  PANGO_UNDERLINE_NONE,
  PANGO_UNDERLINE_SINGLE,
  PANGO_UNDERLINE_DOUBLE,
  PANGO_UNDERLINE_LOW
} PangoUnderline;

the PangoUnderline enumeration is used to specify whether text should be underlined, and if so, the type of underlining.

PANGO_UNDERLINE_NONE

no underline should be drawn.

PANGO_UNDERLINE_SINGLE

a single underline should be drawn.

PANGO_UNDERLINE_DOUBLE

a double underline should be drawn.

PANGO_UNDERLINE_LOW

a single underline should be drawn at a position beneath the ink extents of the text being underlined. This should be used only for underlining single characters, such as for keyboard accelerators. PANGO_UNDERLINE_SINGLE should be used for extended portions of text.


PANGO_TYPE_UNDERLINE

#define PANGO_TYPE_UNDERLINE (pango_underline_get_type())

The GObject type for PangoUnderline.


pango_attr_shape_new ()

PangoAttribute* pango_attr_shape_new        (const PangoRectangle *ink_rect,
                                             const PangoRectangle *logical_rect);

Create a new shape attribute. A shape is used to impose a particular ink and logical rect on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a PangoLayout.

ink_rect :

ink rectangle to assign to each character

logical_rect :

logical rectangle assign to each character

Returns :

the newly created attribute


pango_attr_scale_new ()

PangoAttribute* pango_attr_scale_new        (double scale_factor);

Create a new font size scale attribute. The base font for the affected text will have its size multiplied by scale_factor.

scale_factor :

factor to scale the font

Returns :

the new PangoAttribute.


PANGO_SCALE_XX_SMALL

#define PANGO_SCALE_XX_SMALL ((double)0.5787037037037)

The scale factor for three shrinking steps (1 / (1.2 * 1.2 * 1.2)).


PANGO_SCALE_X_SMALL

#define PANGO_SCALE_X_SMALL  ((double)0.6444444444444)

The scale factor for two shrinking steps (1 / (1.2 * 1.2)).


PANGO_SCALE_SMALL

#define PANGO_SCALE_SMALL    ((double)0.8333333333333)

The scale factor for one shrinking step (1 / 1.2).


PANGO_SCALE_MEDIUM

#define PANGO_SCALE_MEDIUM   ((double)1.0)

The scale factor for normal size (1.0).


PANGO_SCALE_LARGE

#define PANGO_SCALE_LARGE    ((double)1.2)

The scale factor for one magnification step (1.2).


PANGO_SCALE_X_LARGE

#define PANGO_SCALE_X_LARGE  ((double)1.4399999999999)

The scale factor for two magnification steps (1.2 * 1.2).


PANGO_SCALE_XX_LARGE

#define PANGO_SCALE_XX_LARGE ((double)1.728)

The scale factor for three magnification steps (1.2 * 1.2 * 1.2).


pango_attr_rise_new ()

PangoAttribute* pango_attr_rise_new         (int rise);

Create a new baseline displacement attribute.

rise :

the amount that the text should be displaced vertically, in 10'000ths of an em. Positive values displace the text upwards.

Returns :

the new PangoAttribute.


struct PangoColor

struct PangoColor
{
  guint16 red;
  guint16 green;
  guint16 blue;
};

The PangoColor structure is used to represent a color in an uncalibrated RGB colorspace.

guint16 red

The red component of the color. This is a value between 0 and 65535, with 65535 indicating full intensity.

guint16 green

The green component of the color. This is a value between 0 and 65535, with 65535 indicating full intensity.

guint16 blue

The blue component of the color. This is a value between 0 and 65535, with 65535 indicating full intensity.


PANGO_TYPE_COLOR

#define PANGO_TYPE_COLOR pango_color_get_type ()

The GObject type for PangoColor.


pango_color_free ()

void        pango_color_free                (PangoColor *color);

Frees a color allocated by pango_color_copy().

color :

an allocated PangoColor


pango_color_parse ()

gboolean    pango_color_parse               (PangoColor *color,
                                             const char *spec);

Fill in the fields of a color from a string specification. The string can either one of a large set of standard names. (Taken from the X11 rgb.txt file), or it can be a hex value in the form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb' where 'r', 'g' and 'b' are hex digits of the red, green, and blue components of the color, respectively. (White in the four forms is '#fff' '#ffffff' '#fffffffff' and '#ffffffffffff')

color :

a PangoColor structure in which to store the result

spec :

a string specifying the new color

Returns :

TRUE if parsing of the specifier succeeded, otherwise false.


pango_color_copy ()

PangoColor* pango_color_copy                (const PangoColor *src);

Creates a copy of src, which should be freed with pango_color_free(). Primarily used by language bindings, not that useful otherwise (since colors can just be copied by assignment in C).

src :

color to copy

Returns :

an allocated PangoColor


struct PangoLanguage

struct PangoLanguage;

The PangoLanguage structure is used to represent a language.

PangoLanguage pointers can be efficiently copied and compared with each other.


PANGO_TYPE_LANGUAGE

#define PANGO_TYPE_LANGUAGE (pango_language_get_type ())

The GObject type for PangoLanguage.


pango_language_from_string ()

PangoLanguage* pango_language_from_string   (const char *language);

Take a RFC-3066 format language tag as a string and convert it to a PangoLanguage pointer that can be efficiently copied (copy the pointer) and compared with other language tags (compare the pointer.)

This function first canonicalizes the string by converting it to lowercase, mapping '_' to '-', and stripping all characters other than letters and '-'.

language :

a string representing a language tag

Returns :

an opaque pointer to a PangoLanguage structure. this will be valid forever after.


pango_language_to_string()

#define pango_language_to_string(language) ((const char *)language)

Returns a RFC-3066 format string representing the given language tag.

language :

a language tag.

Returns :

a string representing the language tag.


pango_language_matches ()

gboolean    pango_language_matches          (PangoLanguage *language,
                                             const char *range_list);

Checks if a language tag matches one of the elements in a list of language ranges. A language tag is considered to match a range in the list if the range is '*', the range is exactly the tag, or the range is a prefix of the tag, and the character after the tag is '-'.

language :

a language tag (see pango_language_from_string()), NULL is allowed and matches nothing but '*'

range_list :

a list of language ranges, separated by ';' characters. each element must either be '*', or a RFC 3066 language range canonicalized as by pango_language_from_string().

Returns :

TRUE if a match was found.


struct PangoAttrList

struct PangoAttrList;

The PangoAttrList structure 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_attr_list_change(), the overlap between properties will meet stricter criteria.

Since the PangoAttrList 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 PangoAttrList for more than one paragraph of text.


PANGO_TYPE_ATTR_LIST

#define PANGO_TYPE_ATTR_LIST pango_attr_list_get_type ()

The GObject type for PangoAttrList.


pango_attr_list_new ()

PangoAttrList* pango_attr_list_new          (void);

Create a new empty attribute list with a reference count of 1.

Returns :

the newly allocated PangoAttrList.


pango_attr_list_ref ()

void        pango_attr_list_ref             (PangoAttrList *list);

Increase the reference count of the given attribute list by one.

list :

a PangoAttrList


pango_attr_list_unref ()

void        pango_attr_list_unref           (PangoAttrList *list);

Decrease the reference count of the given attribute list by one. If the result is zero, free the attribute list and the attributes it contains.

list :

a PangoAttrList


pango_attr_list_copy ()

PangoAttrList* pango_attr_list_copy         (PangoAttrList *list);

Copy list and return an identical, new list.

list :

a PangoAttrList

Returns :

new attribute list


pango_attr_list_insert ()

void        pango_attr_list_insert          (PangoAttrList *list,
                                             PangoAttribute *attr);

Insert the given attribute into the PangoAttrList. It will be inserted after all other attributes with a matching start_index.

list :

a PangoAttrList

attr :

the attribute to insert. Ownership of this value is assumed by the list.


pango_attr_list_insert_before ()

void        pango_attr_list_insert_before   (PangoAttrList *list,
                                             PangoAttribute *attr);

Insert the given attribute into the PangoAttrList. It will be inserted before all other attributes with a matching start_index.

list :

a PangoAttrList

attr :

the attribute to insert. Ownership of this value is assumed by the list.


pango_attr_list_change ()

void        pango_attr_list_change          (PangoAttrList *list,
                                             PangoAttribute *attr);

Insert the given attribute into the PangoAttrList. It will replace any attributes of the same type on that segment and be merged with any adjoining attributes that are identical.

This function is slower than pango_attr_list_insert() for creating a attribute list in order (potentially much slower for large lists). However, pango_attr_list_insert() is not suitable for continually changing a set of attributes since it never removes or combines existing attributes.

list :

a PangoAttrList

attr :

the attribute to insert. Ownership of this value is assumed by the list.


pango_attr_list_splice ()

void        pango_attr_list_splice          (PangoAttrList *list,
                                             PangoAttrList *other,
                                             gint pos,
                                             gint len);

This function splices attribute list other into list. This operation is equivalent to stretching every attribute applies at position pos in list by an amount len, and then calling pango_attr_list_change() with a copy of each attributes in other in sequence (offset in position by pos).

This operation proves useful for, for instance, inserting a preedit string in the middle of an edit buffer.

list :

a PangoAttrList

other :

another PangoAttrList

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)


pango_attr_list_get_iterator ()

PangoAttrIterator* pango_attr_list_get_iterator
                                            (PangoAttrList *list);

Create a iterator initialized to the beginning of the list.

list :

a PangoAttrList

Returns :

a new PangoIterator. list must not be modified until this iterator is freed with pango_attr_iterator_destroy().


struct PangoAttrIterator

struct PangoAttrIterator;

The PangoAttrIterator structure is used to represent an iterator through a PangoList. A new iterator is created with pango_attr_list_get_iterator(). Once the iterator is created, it can be advanced through the style changes in the text using pango_attr_iterator_next(). At each style change, the range of the current style segment and the attributes currently in effect can be queried.


pango_attr_iterator_copy ()

PangoAttrIterator* pango_attr_iterator_copy (PangoAttrIterator *iterator);

Copy a PangoAttrIterator

iterator :

a PangoAttrIterator.

Returns :

Copy of iterator


pango_attr_iterator_next ()

gboolean    pango_attr_iterator_next        (PangoAttrIterator *iterator);

Advance the iterator until the next change of style.

iterator :

a PangoAttrIterator

Returns :

FALSE if the iterator is at the end of the list, otherwise TRUE


pango_attr_iterator_range ()

void        pango_attr_iterator_range       (PangoAttrIterator *iterator,
                                             gint *start,
                                             gint *end);

Get the range of the current segment.

iterator :

a PangoAttrIterator

start :

location to store the start of the range

end :

location to store the end of the range


pango_attr_iterator_get ()

PangoAttribute* pango_attr_iterator_get     (PangoAttrIterator *iterator,
                                             PangoAttrType type);

Find the current attribute of a particular type at the iterator location. When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is used.

iterator :

a PangoAttrIterator

type :

the type of attribute to find.

Returns :

the current attribute of the given type, or NULL if no attribute of that type applies to the current location.


pango_attr_iterator_get_font ()

void        pango_attr_iterator_get_font    (PangoAttrIterator *iterator,
                                             PangoFontDescription *desc,
                                             PangoLanguage **language,
                                             GSList **extra_attrs);

Get the font and other attributes at the current iterator position.

iterator :

a PangoAttrIterator

desc :

a PangoFontDescription to fill in with the current values. The family name in this structure will be set using pango_font_description_set_family_static using values from an attribute in the PangoAttrList associated with the iterator, so if you plan to keep it around, you must call: pango_font_description_set_family (desc, pango_font_description_get_family (desc)).

language :

if non-NULL, location to store language tag for item, or NULL if non is found.

extra_attrs :

if non-NULL, location in which to store a list of non-font attributes at the the current position; only the highest priority value of each attribute will be added to this list. In order to free this value, you must call pango_attribute_destroy() on each member.


pango_attr_iterator_destroy ()

void        pango_attr_iterator_destroy     (PangoAttrIterator *iterator);

Destroy a PangoAttrIterator and free all associated memory.

iterator :

a PangoAttrIterator.

<<< PrevHomeUpNext >>>
FontsTab Stops