A `PangoGlyph` represents a single glyph in the output form of a string.
The `PangoGlyphUnit` type is used to store dimensions within
Pango.
Dimensions are stored in 1/PANGO_SCALE of a device unit.
(A device unit might be a pixel for screen display, or
a point on a printer.) PANGO_SCALE is currently 1024, and
may change in the future (unlikely though), but you should not
depend on its exact value.
The PANGO_PIXELS() macro can be used to convert from glyph units
into device units with correct rounding.
A `PangoLayoutRun` represents a single run within a `PangoLayoutLine`.
It is simply an alternate name for [struct@Pango.GlyphItem].
See the [struct@Pango.GlyphItem] docs for details on the fields.
Whether the segment should be shifted to center around the baseline.
This is mainly used in vertical writing directions.
Whether this run holds ellipsized text.
Whether to add a hyphen at the end of the run during shaping.
Extracts the *ascent* from a `PangoRectangle`
representing glyph extents.
The ascent is the distance from the baseline to the
highest point of the character. This is positive if the
glyph ascends above the baseline.
a `PangoRectangle`
Value for @start_index in `PangoAttribute` that indicates
the beginning of the text.
Value for @end_index in `PangoAttribute` that indicates
the end of the text.
`PangoAlignment` describes how to align the lines of a `PangoLayout`
within the available space.
If the `PangoLayout` is set to justify using [method@Pango.Layout.set_justify],
this only affects partial lines.
See [method@Pango.Layout.set_auto_dir] for how text direction affects
the interpretation of `PangoAlignment` values.
Put all available space on the right
Center the line within the available space
Put all available space on the left
The `PangoAnalysis` structure stores information about
the properties of a segment of text.
unused, reserved
unused, reserved
the font for this segment.
the bidirectional level for this segment.
the glyph orientation for this segment (A `PangoGravity`).
boolean flags for this segment (Since: 1.16).
the detected script for this segment (A `PangoScript`) (Since: 1.18).
the detected language for this segment.
extra attributes for this segment.
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`.
the type ID for this attribute
The `PangoAttrColor` structure is used to represent attributes that
are colors.
the common portion of the attribute
the `PangoColor` which is the value of the attribute
Type of a function that can duplicate user data for an attribute.
new copy of @user_data.
user data to copy
Type of a function filtering a list of attributes.
%TRUE if the attribute should be selected for
filtering, %FALSE otherwise.
a Pango attribute
user data passed to the function
The `PangoAttrFloat` structure is used to represent attributes with
a float or double value.
the common portion of the attribute
the value of the attribute
The `PangoAttrFontDesc` structure is used to store an attribute that
sets all aspects of the font description at once.
the common portion of the attribute
the font description which is the value of this attribute
Create a new font description attribute.
This attribute allows setting family, style, weight, variant,
stretch, and size simultaneously.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font description
The `PangoAttrFontFeatures` structure is used to represent OpenType
font features as an attribute.
the common portion of the attribute
the features, as a string in CSS syntax
Create a new font features tag attribute.
You can use this attribute to select OpenType font features like small-caps,
alternative glyphs, ligatures, etc. for fonts that support them.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
a string with OpenType font features, with the syntax of the [CSS
font-feature-settings property](https://www.w3.org/TR/css-fonts-4/#font-rend-desc)
The `PangoAttrInt` structure is used to represent attributes with
an integer or enumeration value.
the common portion of the attribute
the value of the attribute
A `PangoAttrIterator` is used to iterate through a `PangoAttrList`.
A new iterator is created with [method@Pango.AttrList.get_iterator].
Once the iterator is created, it can be advanced through the style
changes in the text using [method@Pango.AttrIterator.next]. At each
style change, the range of the current style segment and the attributes
currently in effect can be queried.
Copy a `PangoAttrIterator`.
the newly allocated
`PangoAttrIterator`, which should be freed with
[method@Pango.AttrIterator.destroy]
a `PangoAttrIterator`
Destroy a `PangoAttrIterator` and free all associated memory.
a `PangoAttrIterator`
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.
the current
attribute of the given type, or %NULL if no attribute
of that type applies to the current location.
a `PangoAttrIterator`
the type of attribute to find
Gets a list of all attributes at the current position of the
iterator.
a list of all attributes for the current range. To free
this value, call [method@Pango.Attribute.destroy] on each
value and g_slist_free() on the list.
a `PangoAttrIterator`
Get the font and other attributes at the current
iterator position.
a `PangoAttrIterator`
a `PangoFontDescription` to fill in with the current
values. The family name in this structure will be set using
[method@Pango.FontDescription.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))`.
location to store language tag
for item, or %NULL if none is found.
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
[method@Pango.Attribute.destroy] on each member.
Advance the iterator until the next change of style.
%FALSE if the iterator is at the end
of the list, otherwise %TRUE
a `PangoAttrIterator`
Get the range of the current segment.
Note that the stored return values are signed, not unsigned
like the values in `PangoAttribute`. To deal with this API
oversight, stored return values that wouldn't fit into
a signed integer are clamped to %G_MAXINT.
a PangoAttrIterator
location to store the start of the range
location to store the end of the range
The `PangoAttrLanguage` structure is used to represent attributes that
are languages.
the common portion of the attribute
the `PangoLanguage` which is the value of the attribute
Create a new language tag attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
language tag
A `PangoAttrList` represents a list of attributes that apply to a section
of text.
The attributes in a `PangoAttrList` are, in general, allowed to overlap in
an arbitrary fashion. However, if the attributes are manipulated only through
[method@Pango.AttrList.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.
Create a new empty attribute list with a reference
count of one.
the newly allocated
`PangoAttrList`, which should be freed with
[method@Pango.AttrList.unref]
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 [method@Pango.AttrList.insert]
for creating an attribute list in order (potentially
much slower for large lists). However,
[method@Pango.AttrList.insert] is not suitable for
continually changing a set of attributes since it
never removes or combines existing attributes.
a `PangoAttrList`
the attribute to insert
Copy @list and return an identical new list.
the newly allocated
`PangoAttrList`, with a reference count of one,
which should be freed with [method@Pango.AttrList.unref].
Returns %NULL if @list was %NULL.
a `PangoAttrList`
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.
%TRUE if the lists are equal, %FALSE if
they aren't
a `PangoAttrList`
the other `PangoAttrList`
Given a `PangoAttrList` and callback function, removes
any elements of @list for which @func returns %TRUE and
inserts them into a new list.
the new
`PangoAttrList` or %NULL if no attributes of the
given types were found
a `PangoAttrList`
callback function;
returns %TRUE if an attribute should be filtered out
Data to be passed to @func
Gets a list of all attributes in @list.
a list of all attributes in @list. To free this value,
call [method@Pango.Attribute.destroy] on each value and
g_slist_free() on the list.
a `PangoAttrList`
Create a iterator initialized to the beginning of the list.
@list must not be modified until this iterator is freed.
the newly allocated
`PangoAttrIterator`, which should be freed with
[method@Pango.AttrIterator.destroy]
a `PangoAttrList`
Insert the given attribute into the `PangoAttrList`.
It will be inserted after all other attributes with a
matching @start_index.
a `PangoAttrList`
the attribute to insert
Insert the given attribute into the `PangoAttrList`.
It will be inserted before all other attributes with a
matching @start_index.
a `PangoAttrList`
the attribute to insert
Increase the reference count of the given attribute
list by one.
The attribute list passed in
a `PangoAttrList`
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 [method@Pango.AttrList.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.
a `PangoAttrList`
another `PangoAttrList`
the position in @list at which to insert @other
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)
Serializes a `PangoAttrList` to a string.
No guarantees are made about the format of the string,
it may change between Pango versions.
The intended use of this function is testing and
debugging. The format is not meant as a permanent
storage format.
a newly allocated string
a `PangoAttrList`
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.
a `PangoAttrList`
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.
a `PangoAttrList`
the position of the change
the number of removed bytes
the number of added bytes
Deserializes a `PangoAttrList` from a string.
This is the counterpart to [method@Pango.AttrList.to_string].
See that functions for details about the format.
a new `PangoAttrList`
a string
The `PangoAttrShape` structure is used to represent attributes which
impose shape restrictions.
the common portion of the attribute
the ink rectangle to restrict to
the logical rectangle to restrict to
user data set (see [func@Pango.AttrShape.new_with_data])
copy function for the user data
destroy function for the user data
Create a new shape attribute.
A shape is used to impose a particular ink and logical
rectangle on the result of shaping a particular glyph.
This might be used, for instance, for embedding a picture
or a widget inside a `PangoLayout`.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
ink rectangle to assign to each character
logical rectangle to assign to each character
Creates a new shape attribute.
Like [func@Pango.AttrShape.new], but a user data pointer
is also provided; this pointer can be accessed when later
rendering the glyph.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
ink rectangle to assign to each character
logical rectangle to assign to each character
user data pointer
function to copy @data when the
attribute is copied. If %NULL, @data is simply copied
as a pointer
function to free @data when the
attribute is freed
The `PangoAttrSize` structure is used to represent attributes which
set font size.
the common portion of the attribute
size of font, in units of 1/%PANGO_SCALE of a point (for
%PANGO_ATTR_SIZE) or of a device unit (for %PANGO_ATTR_ABSOLUTE_SIZE)
whether the font size is in device units or points.
This field is only present for compatibility with Pango-1.8.0
(%PANGO_ATTR_ABSOLUTE_SIZE was added in 1.8.1); and always will
be %FALSE for %PANGO_ATTR_SIZE and %TRUE for %PANGO_ATTR_ABSOLUTE_SIZE.
Create a new font-size attribute in fractional points.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font size, in %PANGO_SCALE-ths of a point
Create a new font-size attribute in device units.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font size, in %PANGO_SCALE-ths of a device unit
The `PangoAttrString` structure is used to represent attributes with
a string value.
the common portion of the attribute
the string which is the value of the attribute
The `PangoAttrType` distinguishes between different types of attributes.
Along with the predefined values, it is possible to allocate additional
values for custom attributes using [func@AttrType.register]. The predefined
values are given below. The type of structure used to store the attribute is
listed in parentheses after the description.
does not happen
language ([struct@Pango.AttrLanguage])
font family name list ([struct@Pango.AttrString])
font slant style ([struct@Pango.AttrInt])
font weight ([struct@Pango.AttrInt])
font variant (normal or small caps) ([struct@Pango.AttrInt])
font stretch ([struct@Pango.AttrInt])
font size in points scaled by %PANGO_SCALE ([struct@Pango.AttrInt])
font description ([struct@Pango.AttrFontDesc])
foreground color ([struct@Pango.AttrColor])
background color ([struct@Pango.AttrColor])
whether the text has an underline ([struct@Pango.AttrInt])
whether the text is struck-through ([struct@Pango.AttrInt])
baseline displacement ([struct@Pango.AttrInt])
shape ([struct@Pango.AttrShape])
font size scale factor ([struct@Pango.AttrFloat])
whether fallback is enabled ([struct@Pango.AttrInt])
letter spacing ([struct@PangoAttrInt])
underline color ([struct@Pango.AttrColor])
strikethrough color ([struct@Pango.AttrColor])
font size in pixels scaled by %PANGO_SCALE ([struct@Pango.AttrInt])
base text gravity ([struct@Pango.AttrInt])
gravity hint ([struct@Pango.AttrInt])
OpenType font features ([struct@Pango.AttrFontFeatures]). Since 1.38
foreground alpha ([struct@Pango.AttrInt]). Since 1.38
background alpha ([struct@Pango.AttrInt]). Since 1.38
whether breaks are allowed ([struct@Pango.AttrInt]). Since 1.44
how to render invisible characters ([struct@Pango.AttrInt]). Since 1.44
whether to insert hyphens at intra-word line breaks ([struct@Pango.AttrInt]). Since 1.44
whether the text has an overline ([struct@Pango.AttrInt]). Since 1.46
overline color ([struct@Pango.AttrColor]). Since 1.46
line height factor ([struct@Pango.AttrFloat]). Since: 1.50
line height ([struct@Pango.AttrInt]). Since: 1.50
override segmentation to classify the range of the attribute as a single word ([struct@Pango.AttrInt]). Since 1.50
override segmentation to classify the range of the attribute as a single sentence ([struct@Pango.AttrInt]). Since 1.50
baseline displacement ([struct@Pango.AttrInt]). Since 1.50
font-relative size change ([struct@Pango.AttrInt]). Since 1.50
Fetches the attribute type name.
The attribute type name is the string passed in
when registering the type using
[func@Pango.AttrType.register].
The returned value is an interned string (see
g_intern_string() for what that means) that should
not be modified or freed.
the type ID name (which
may be %NULL), or %NULL if @type is a built-in Pango
attribute type or invalid.
an attribute type ID to fetch the name for
Allocate a new attribute type ID.
The attribute type name can be accessed later
by using [func@Pango.AttrType.get_name].
the new type ID.
an identifier for the type
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 and should
be initialized using [method@Pango.Attribute.init]. By default, an attribute
will have an all-inclusive range of [0,%G_MAXUINT].
the class structure holding information about the type of the attribute
the start index of the range (in bytes).
end index of the range (in bytes). The character at this index
is not included in the range.
Returns the attribute cast to `PangoAttrColor`.
This is mainly useful for language bindings.
The attribute as `PangoAttrColor`,
or %NULL if it's not a color attribute
A `PangoAttribute` such as foreground
Returns the attribute cast to `PangoAttrFloat`.
This is mainly useful for language bindings.
The attribute as `PangoAttrFloat`,
or %NULL if it's not a floating point attribute
A `PangoAttribute` such as scale
Returns the attribute cast to `PangoAttrFontDesc`.
This is mainly useful for language bindings.
The attribute as `PangoAttrFontDesc`,
or %NULL if it's not a font description attribute
A `PangoAttribute` representing a font description
Returns the attribute cast to `PangoAttrFontFeatures`.
This is mainly useful for language bindings.
The attribute as `PangoAttrFontFeatures`,
or %NULL if it's not a font features attribute
A `PangoAttribute` representing font features
Returns the attribute cast to `PangoAttrInt`.
This is mainly useful for language bindings.
The attribute as `PangoAttrInt`,
or %NULL if it's not an integer attribute
A `PangoAttribute` such as weight
Returns the attribute cast to `PangoAttrLanguage`.
This is mainly useful for language bindings.
The attribute as `PangoAttrLanguage`,
or %NULL if it's not a language attribute
A `PangoAttribute` representing a language
Returns the attribute cast to `PangoAttrShape`.
This is mainly useful for language bindings.
The attribute as `PangoAttrShape`,
or %NULL if it's not a shape attribute
A `PangoAttribute` representing a shape
Returns the attribute cast to `PangoAttrSize`.
This is mainly useful for language bindings.
The attribute as `PangoAttrSize`,
or NULL if it's not a size attribute
A `PangoAttribute` representing a size
Returns the attribute cast to `PangoAttrString`.
This is mainly useful for language bindings.
The attribute as `PangoAttrString`,
or %NULL if it's not a string attribute
A `PangoAttribute` such as family
Make a copy of an attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy].
a `PangoAttribute`
Destroy a `PangoAttribute` and free all associated memory.
a `PangoAttribute`.
Compare two attributes for equality.
This compares only the actual value of the two
attributes and not the ranges that the attributes
apply to.
%TRUE if the two attributes have the same value
a `PangoAttribute`
another `PangoAttribute`
Initializes @attr's klass to @klass, it's start_index to
%PANGO_ATTR_INDEX_FROM_TEXT_BEGINNING and end_index to
%PANGO_ATTR_INDEX_TO_TEXT_END such that the attribute applies
to the entire text by default.
a `PangoAttribute`
a `PangoAttrClass`
An enumeration that affects baseline shifts between runs.
Leave the baseline unchanged
Shift the baseline to the superscript position,
relative to the previous run
Shift the baseline to the subscript position,
relative to the previous run
`PangoBidiType` represents the bidirectional character
type of a Unicode character.
The values in this enumeration are specified by the
[Unicode bidirectional algorithm](http://www.unicode.org/reports/tr9/).
Use fribidi for this information
Left-to-Right
Left-to-Right Embedding
Left-to-Right Override
Right-to-Left
Right-to-Left Arabic
Right-to-Left Embedding
Right-to-Left Override
Pop Directional Format
European Number
European Number Separator
European Number Terminator
Arabic Number
Common Number Separator
Nonspacing Mark
Boundary Neutral
Paragraph Separator
Segment Separator
Whitespace
Other Neutrals
Left-to-Right isolate. Since 1.48.6
Right-to-Left isolate. Since 1.48.6
First strong isolate. Since 1.48.6
Pop directional isolate. Since 1.48.6
Determines the bidirectional type of a character.
The bidirectional type is specified in the Unicode Character Database.
A simplified version of this function is available as [func@unichar_direction].
the bidirectional character type, as used in the
Unicode bidirectional algorithm.
a Unicode character
The `PangoColor` structure is used to
represent a color in an uncalibrated RGB color-space.
value of red component
value of green component
value of blue component
Creates a copy of @src.
The copy should be freed with [method@Pango.Color.free].
Primarily used by language bindings, not that useful
otherwise (since colors can just be copied by assignment
in C).
the newly allocated `PangoColor`,
which should be freed with [method@Pango.Color.free]
color to copy
Frees a color allocated by [method@Pango.Color.copy].
an allocated `PangoColor`
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 CSS Color [specification](https://www.w3.org/TR/css-color-4/#named-colors),
or it can be a 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`.)
%TRUE if parsing of the specifier succeeded,
otherwise %FALSE
a `PangoColor` structure in which
to store the result
a string specifying the new color
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 CSS Color [specification](https://www.w3.org/TR/css-color-4/#named-colors),
or it can be a hexadecimal 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`.)
Additionally, parse strings of the form `#rgba`, `#rrggbbaa`,
`#rrrrggggbbbbaaaa`, if @alpha is not %NULL, and set @alpha
to the value specified by the hex digits for `a`. If no alpha
component is found in @spec, @alpha is set to 0xffff (for a
solid color).
%TRUE if parsing of the specifier succeeded,
otherwise %FALSE
a `PangoColor` structure in which
to store the result
return location for alpha
a string specifying the new color
Returns a textual specification of @color.
The string is in the hexadecimal form `#rrrrggggbbbb`,
where `r`, `g` and `b` are hex digits representing the
red, green, and blue components respectively.
a newly-allocated text string that must
be freed with g_free().
a `PangoColor`
A `PangoContext` stores global information used to control the
itemization process.
The information stored by `PangoContext` includes the fontmap used
to look up fonts, and default values such as the default language,
default gravity, or default font.
To obtain a `PangoContext`, use [method@Pango.FontMap.create_context].
Creates a new `PangoContext` initialized to default values.
This function is not particularly useful as it should always
be followed by a [method@Pango.Context.set_font_map] call, and the
function [method@Pango.FontMap.create_context] does these two steps
together and hence users are recommended to use that.
If you are using Pango as part of a higher-level system,
that system may have it's own way of create a `PangoContext`.
For instance, the GTK toolkit has, among others,
`gtk_widget_get_pango_context()`. Use those instead.
the newly allocated `PangoContext`, which should
be freed with g_object_unref().
Forces a change in the context, which will cause any `PangoLayout`
using this context to re-layout.
This function is only useful when implementing a new backend
for Pango, something applications won't do. Backends should
call this function if they have attached extra data to the context
and such data is changed.
a `PangoContext`
Retrieves the base direction for the context.
See [method@Pango.Context.set_base_dir].
the base direction for the context.
a `PangoContext`
Retrieves the base gravity for the context.
See [method@Pango.Context.set_base_gravity].
the base gravity for the context.
a `PangoContext`
Retrieve the default font description for the context.
a pointer to the context's default font
description. This value must not be modified or freed.
a `PangoContext`
Gets the `PangoFontMap` used to look up fonts for this context.
the font map for the `PangoContext`.
This value is owned by Pango and should not be unreferenced.
a `PangoContext`
Retrieves the gravity for the context.
This is similar to [method@Pango.Context.get_base_gravity],
except for when the base gravity is %PANGO_GRAVITY_AUTO for
which [func@Pango.Gravity.get_for_matrix] is used to return the
gravity from the current context matrix.
the resolved gravity for the context.
a `PangoContext`
Retrieves the gravity hint for the context.
See [method@Pango.Context.set_gravity_hint] for details.
the gravity hint for the context.
a `PangoContext`
Retrieves the global language tag for the context.
the global language tag.
a `PangoContext`
Gets the transformation matrix that will be applied when
rendering with this context.
See [method@Pango.Context.set_matrix].
the matrix, or %NULL if no matrix has
been set (which is the same as the identity matrix). The returned
matrix is owned by Pango and must not be modified or freed.
a `PangoContext`
Get overall metric information for a particular font description.
Since the metrics may be substantially different for different scripts,
a language tag can be provided to indicate that the metrics should be
retrieved that correspond to the script(s) used by that language.
The `PangoFontDescription` is interpreted in the same way as by [func@itemize],
and the family name may be a comma separated list of names. If characters
from multiple of these families would be used to render the string, then
the returned fonts would be a composite of the metrics for the fonts loaded
for the individual families.
a `PangoFontMetrics` object. The caller must call
[method@Pango.FontMetrics.unref] when finished using the object.
a `PangoContext`
a `PangoFontDescription` structure. %NULL means that the
font description from the context will be used.
language tag used to determine which script to get
the metrics for. %NULL means that the language tag from the context
will be used. If no language tag is set on the context, metrics
for the default language (as determined by [func@Pango.Language.get_default]
will be returned.
Returns whether font rendering with this context should
round glyph positions and widths.
a `PangoContext`
Returns the current serial number of @context.
The serial number is initialized to an small number larger than zero
when a new context is created and is increased whenever the context
is changed using any of the setter functions, or the `PangoFontMap` it
uses to find fonts has changed. The serial may wrap, but will never
have the value 0. Since it can wrap, never compare it with "less than",
always use "not equals".
This can be used to automatically detect changes to a `PangoContext`,
and is only useful when implementing objects that need update when their
`PangoContext` changes, like `PangoLayout`.
The current serial number of @context.
a `PangoContext`
List all families for a context.
a `PangoContext`
location
to store a pointer to an array of `PangoFontFamily`. This array should
be freed with g_free().
location to store the number of elements in @descs
Loads the font in one of the fontmaps in the context
that is the closest match for @desc.
the newly allocated `PangoFont`
that was loaded, or %NULL if no font matched.
a `PangoContext`
a `PangoFontDescription` describing the font to load
Load a set of fonts in the context that can be used to render
a font matching @desc.
the newly allocated
`PangoFontset` loaded, or %NULL if no font matched.
a `PangoContext`
a `PangoFontDescription` describing the fonts to load
a `PangoLanguage` the fonts will be used for
Sets the base direction for the context.
The base direction is used in applying the Unicode bidirectional
algorithm; if the @direction is %PANGO_DIRECTION_LTR or
%PANGO_DIRECTION_RTL, then the value will be used as the paragraph
direction in the Unicode bidirectional algorithm. A value of
%PANGO_DIRECTION_WEAK_LTR or %PANGO_DIRECTION_WEAK_RTL is used only
for paragraphs that do not contain any strong characters themselves.
a `PangoContext`
the new base direction
Sets the base gravity for the context.
The base gravity is used in laying vertical text out.
a `PangoContext`
the new base gravity
Set the default font description for the context
a `PangoContext`
the new pango font description
Sets the font map to be searched when fonts are looked-up
in this context.
This is only for internal use by Pango backends, a `PangoContext`
obtained via one of the recommended methods should already have a
suitable font map.
a `PangoContext`
the `PangoFontMap` to set.
Sets the gravity hint for the context.
The gravity hint is used in laying vertical text out, and
is only relevant if gravity of the context as returned by
[method@Pango.Context.get_gravity] is set to %PANGO_GRAVITY_EAST
or %PANGO_GRAVITY_WEST.
a `PangoContext`
the new gravity hint
Sets the global language tag for the context.
The default language for the locale of the running process
can be found using [func@Pango.Language.get_default].
a `PangoContext`
the new language tag.
Sets the transformation matrix that will be applied when rendering
with this context.
Note that reported metrics are in the user space coordinates before
the application of the matrix, not device-space coordinates after the
application of the matrix. So, they don't scale with the matrix, though
they may change slightly for different matrices, depending on how the
text is fit to the pixel grid.
a `PangoContext`
a `PangoMatrix`, or %NULL to unset any existing
matrix. (No matrix set is the same as setting the identity matrix.)
Sets whether font rendering with this context should
round glyph positions and widths to integral positions,
in device units.
This is useful when the renderer can't handle subpixel
positioning of glyphs.
The default value is to round glyph positions, to remain
compatible with previous Pango behavior.
a `PangoContext`
whether to round glyph positions
A `PangoCoverage` structure is a map from Unicode characters
to [enum@Pango.CoverageLevel] values.
It is often necessary in Pango to determine if a particular
font can represent a particular character, and also how well
it can represent that character. The `PangoCoverage` is a data
structure that is used to represent that information. It is an
opaque structure with no public fields.
Create a new `PangoCoverage`
the newly allocated `PangoCoverage`, initialized
to %PANGO_COVERAGE_NONE with a reference count of one, which
should be freed with [method@Pango.Coverage.unref].
Convert data generated from [method@Pango.Coverage.to_bytes]
back to a `PangoCoverage`.
This returns %NULL
a newly allocated `PangoCoverage`
binary data
representing a `PangoCoverage`
the size of @bytes in bytes
Copy an existing `PangoCoverage`.
the newly allocated `PangoCoverage`,
with a reference count of one, which should be freed with
[method@Pango.Coverage.unref].
a `PangoCoverage`
Determine whether a particular index is covered by @coverage.
the coverage level of @coverage for character @index_.
a `PangoCoverage`
the index to check
Set the coverage for each index in @coverage to be the max (better)
value of the current coverage for the index and the coverage for
the corresponding index in @other.
This function does nothing
a `PangoCoverage`
another `PangoCoverage`
Increase the reference count on the `PangoCoverage` by one.
Use g_object_ref instead
@coverage
a `PangoCoverage`
Modify a particular index within @coverage
a `PangoCoverage`
the index to modify
the new level for @index_
Convert a `PangoCoverage` structure into a flat binary format.
This returns %NULL
a `PangoCoverage`
location to store result (must be freed with g_free())
location to store size of result
Decrease the reference count on the `PangoCoverage` by one.
If the result is zero, free the coverage and all associated memory.
Use g_object_unref instead
a `PangoCoverage`
`PangoCoverageLevel` is used to indicate how well a font can
represent a particular Unicode character for a particular script.
Since 1.44, only %PANGO_COVERAGE_NONE and %PANGO_COVERAGE_EXACT
will be returned.
The character is not representable with
the font.
The character is represented in a
way that may be comprehensible but is not the correct
graphical form. For instance, a Hangul character represented
as a a sequence of Jamos, or a Latin transliteration of a
Cyrillic word.
The character is represented as
basically the correct graphical form, but with a stylistic
variant inappropriate for the current script.
The character is represented as the
correct graphical form.
Extracts the *descent* from a `PangoRectangle`
representing glyph extents.
The descent is the distance from the baseline to the
lowest point of the character. This is positive if the
glyph descends below the baseline.
a `PangoRectangle`
`PangoDirection` represents a direction in the Unicode bidirectional
algorithm.
Not every value in this enumeration makes sense for every usage of
`PangoDirection`; for example, the return value of [func@unichar_direction]
and [func@find_base_dir] cannot be `PANGO_DIRECTION_WEAK_LTR` or
`PANGO_DIRECTION_WEAK_RTL`, since every character is either neutral
or has a strong direction; on the other hand `PANGO_DIRECTION_NEUTRAL`
doesn't make sense to pass to [func@itemize_with_base_dir].
The `PANGO_DIRECTION_TTB_LTR`, `PANGO_DIRECTION_TTB_RTL` values come from
an earlier interpretation of this enumeration as the writing direction
of a block of text and are no longer used. See `PangoGravity` for how
vertical text is handled in Pango.
If you are interested in text direction, you should really use fribidi
directly. `PangoDirection` is only retained because it is used in some
public apis.
A strong left-to-right direction
A strong right-to-left direction
Deprecated value; treated the
same as `PANGO_DIRECTION_RTL`.
Deprecated value; treated the
same as `PANGO_DIRECTION_LTR`
A weak left-to-right direction
A weak right-to-left direction
No direction specified
`PangoEllipsizeMode` describes what sort of ellipsization
should be applied to text.
In the ellipsization process characters are removed from the
text in order to make it fit to a given width and replaced
with an ellipsis.
No ellipsization
Omit characters at the start of the text
Omit characters in the middle of the text
Omit characters at the end of the text
A `PangoFont` is used to represent a font in a
rendering-system-independent manner.
Frees an array of font descriptions.
a pointer
to an array of `PangoFontDescription`, may be %NULL
number of font descriptions in @descs
Loads data previously created via [method@Pango.Font.serialize].
For a discussion of the supported format, see that function.
Note: to verify that the returned font is identical to
the one that was serialized, you can compare @bytes to the
result of serializing the font again.
a new `PangoFont`
a `PangoContext`
the bytes containing the data
Returns a description of the font, with font size set in points.
Use [method@Pango.Font.describe_with_absolute_size] if you want
the font size in device units.
a newly-allocated `PangoFontDescription` object.
a `PangoFont`
Computes the coverage map for a given font and language tag.
a newly-allocated `PangoCoverage`
object.
a `PangoFont`
the language tag
Obtain the OpenType features that are provided by the font.
These are passed to the rendering system, together with features
that have been explicitly set via attributes.
Note that this does not include OpenType features which the
rendering system enables by default.
a `PangoFont`
Array to features in
the length of @features
the number of used items in @features
Gets the font map for which the font was created.
Note that the font maintains a *weak* reference to
the font map, so if all references to font map are
dropped, the font map will be finalized even if there
are fonts created with the font map that are still alive.
In that case this function will return %NULL.
It is the responsibility of the user to ensure that the
font map is kept alive. In most uses this is not an issue
as a `PangoContext` holds a reference to the font map.
the `PangoFontMap`
for the font
a `PangoFont`
Gets the logical and ink extents of a glyph within a font.
The coordinate system for each rectangle has its origin at the
base line and horizontal origin of the character with increasing
coordinates extending to the right and down. The macros PANGO_ASCENT(),
PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING() can be used to convert
from the extents rectangle to more traditional font metrics. The units
of the rectangles are in 1/PANGO_SCALE of a device unit.
If @font is %NULL, this function gracefully sets some sane values in the
output variables and returns.
a `PangoFont`
the glyph index
rectangle used to store the extents of the glyph as drawn
rectangle used to store the logical extents of the glyph
Gets overall metric information for a font.
Since the metrics may be substantially different for different scripts,
a language tag can be provided to indicate that the metrics should be
retrieved that correspond to the script(s) used by that language.
If @font is %NULL, this function gracefully sets some sane values in the
output variables and returns.
a `PangoFontMetrics` object. The caller must call
[method@Pango.FontMetrics.unref] when finished using the object.
a `PangoFont`
language tag used to determine which script
to get the metrics for, or %NULL to indicate to get the metrics for
the entire font.
Returns a description of the font, with font size set in points.
Use [method@Pango.Font.describe_with_absolute_size] if you want
the font size in device units.
a newly-allocated `PangoFontDescription` object.
a `PangoFont`
Returns a description of the font, with absolute font size set
in device units.
Use [method@Pango.Font.describe] if you want the font size in points.
a newly-allocated `PangoFontDescription` object.
a `PangoFont`
Computes the coverage map for a given font and language tag.
a newly-allocated `PangoCoverage`
object.
a `PangoFont`
the language tag
Gets the `PangoFontFace` to which @font belongs.
the `PangoFontFace`
a `PangoFont`
Obtain the OpenType features that are provided by the font.
These are passed to the rendering system, together with features
that have been explicitly set via attributes.
Note that this does not include OpenType features which the
rendering system enables by default.
a `PangoFont`
Array to features in
the length of @features
the number of used items in @features
Gets the font map for which the font was created.
Note that the font maintains a *weak* reference to
the font map, so if all references to font map are
dropped, the font map will be finalized even if there
are fonts created with the font map that are still alive.
In that case this function will return %NULL.
It is the responsibility of the user to ensure that the
font map is kept alive. In most uses this is not an issue
as a `PangoContext` holds a reference to the font map.
the `PangoFontMap`
for the font
a `PangoFont`
Gets the logical and ink extents of a glyph within a font.
The coordinate system for each rectangle has its origin at the
base line and horizontal origin of the character with increasing
coordinates extending to the right and down. The macros PANGO_ASCENT(),
PANGO_DESCENT(), PANGO_LBEARING(), and PANGO_RBEARING() can be used to convert
from the extents rectangle to more traditional font metrics. The units
of the rectangles are in 1/PANGO_SCALE of a device unit.
If @font is %NULL, this function gracefully sets some sane values in the
output variables and returns.
a `PangoFont`
the glyph index
rectangle used to store the extents of the glyph as drawn
rectangle used to store the logical extents of the glyph
Get a `hb_font_t` object backing this font.
Note that the objects returned by this function are cached
and immutable. If you need to make changes to the `hb_font_t`,
use [hb_font_create_sub_font()](https://harfbuzz.github.io/harfbuzz-hb-font.html#hb-font-create-sub-font).
the `hb_font_t` object
backing the font
a `PangoFont`
Returns the languages that are supported by @font.
If the font backend does not provide this information,
%NULL is returned. For the fontconfig backend, this
corresponds to the FC_LANG member of the FcPattern.
The returned array is only valid as long as the font
and its fontmap are valid.
an array of `PangoLanguage`
a `PangoFont`
Gets overall metric information for a font.
Since the metrics may be substantially different for different scripts,
a language tag can be provided to indicate that the metrics should be
retrieved that correspond to the script(s) used by that language.
If @font is %NULL, this function gracefully sets some sane values in the
output variables and returns.
a `PangoFontMetrics` object. The caller must call
[method@Pango.FontMetrics.unref] when finished using the object.
a `PangoFont`
language tag used to determine which script
to get the metrics for, or %NULL to indicate to get the metrics for
the entire font.
Returns whether the font provides a glyph for this character.
`TRUE` if @font can render @wc
a `PangoFont`
a Unicode character
Serializes the @font in a way that can be uniquely identified.
There are no guarantees about the format of the output across different
versions of Pango.
The intended use of this function is testing, benchmarking and debugging.
The format is not meant as a permanent storage format.
To recreate a font from its serialized form, use [func@Pango.Font.deserialize].
a `GBytes` containing the serialized form of @font
a `PangoFont`
a newly-allocated `PangoFontDescription` object.
a `PangoFont`
a newly-allocated `PangoCoverage`
object.
a `PangoFont`
the language tag
a `PangoFont`
the glyph index
rectangle used to store the extents of the glyph as drawn
rectangle used to store the logical extents of the glyph
a `PangoFontMetrics` object. The caller must call
[method@Pango.FontMetrics.unref] when finished using the object.
a `PangoFont`
language tag used to determine which script
to get the metrics for, or %NULL to indicate to get the metrics for
the entire font.
the `PangoFontMap`
for the font
a `PangoFont`
a `PangoFont`
Array to features in
the length of @features
the number of used items in @features
A `PangoFontDescription` describes a font in an implementation-independent
manner.
`PangoFontDescription` structures are used both to list what fonts are
available on the system and also for specifying the characteristics of
a font to load.
Creates a new font description structure with all fields unset.
the newly allocated `PangoFontDescription`, which
should be freed using [method@Pango.FontDescription.free].
Determines if the style attributes of @new_match are a closer match
for @desc than those of @old_match are, or if @old_match is %NULL,
determines if @new_match is a match at all.
Approximate matching is done for weight and style; other style attributes
must match exactly. Style attributes are all attributes other than family
and size-related attributes. Approximate matching for style considers
%PANGO_STYLE_OBLIQUE and %PANGO_STYLE_ITALIC as matches, but not as good
a match as when the styles are equal.
Note that @old_match must match @desc.
%TRUE if @new_match is a better match
a `PangoFontDescription`
a `PangoFontDescription`, or %NULL
a `PangoFontDescription`
Make a copy of a `PangoFontDescription`.
the newly allocated `PangoFontDescription`,
which should be freed with [method@Pango.FontDescription.free],
or %NULL if @desc was %NULL.
a `PangoFontDescription`, may be %NULL
Make a copy of a `PangoFontDescription`, but don't duplicate
allocated fields.
This is like [method@Pango.FontDescription.copy], but only a shallow
copy is made of the family name and other allocated fields. The result
can only be used until @desc is modified or freed. This is meant
to be used when the copy is only needed temporarily.
the newly allocated `PangoFontDescription`,
which should be freed with [method@Pango.FontDescription.free],
or %NULL if @desc was %NULL.
a `PangoFontDescription`, may be %NULL
Compares two font descriptions for equality.
Two font descriptions are considered equal if the fonts they describe
are provably identical. This means that their masks do not have to match,
as long as other fields are all the same. (Two font descriptions may
result in identical fonts being loaded, but still compare %FALSE.)
%TRUE if the two font descriptions are identical,
%FALSE otherwise.
a `PangoFontDescription`
another `PangoFontDescription`
Frees a font description.
a `PangoFontDescription`, may be %NULL
Gets the family name field of a font description.
See [method@Pango.FontDescription.set_family].
the family name field for the font
description, or %NULL if not previously set. This has the same
life-time as the font description itself and should not be freed.
a `PangoFontDescription`.
Gets the gravity field of a font description.
See [method@Pango.FontDescription.set_gravity].
the gravity field for the font description.
Use [method@Pango.FontDescription.get_set_fields] to find out
if the field was explicitly set or not.
a `PangoFontDescription`
Determines which fields in a font description have been set.
a bitmask with bits set corresponding to the
fields in @desc that have been set.
a `PangoFontDescription`
Gets the size field of a font description.
See [method@Pango.FontDescription.set_size].
the size field for the font description in points
or device units. You must call
[method@Pango.FontDescription.get_size_is_absolute] to find out
which is the case. Returns 0 if the size field has not previously
been set or it has been set to 0 explicitly.
Use [method@Pango.FontDescription.get_set_fields] to find out
if the field was explicitly set or not.
a `PangoFontDescription`
Determines whether the size of the font is in points (not absolute)
or device units (absolute).
See [method@Pango.FontDescription.set_size]
and [method@Pango.FontDescription.set_absolute_size].
whether the size for the font description is in
points or device units. Use [method@Pango.FontDescription.get_set_fields]
to find out if the size field of the font description was explicitly
set or not.
a `PangoFontDescription`
Gets the stretch field of a font description.
See [method@Pango.FontDescription.set_stretch].
the stretch field for the font description.
Use [method@Pango.FontDescription.get_set_fields] to find
out if the field was explicitly set or not.
a `PangoFontDescription`.
Gets the style field of a `PangoFontDescription`.
See [method@Pango.FontDescription.set_style].
the style field for the font description.
Use [method@Pango.FontDescription.get_set_fields] to
find out if the field was explicitly set or not.
a `PangoFontDescription`
Gets the variant field of a `PangoFontDescription`.
See [method@Pango.FontDescription.set_variant].
the variant field for the font description.
Use [method@Pango.FontDescription.get_set_fields] to find
out if the field was explicitly set or not.
a `PangoFontDescription`.
Gets the variations field of a font description.
See [method@Pango.FontDescription.set_variations].
the variations field for the font
description, or %NULL if not previously set. This has the same
life-time as the font description itself and should not be freed.
a `PangoFontDescription`
Gets the weight field of a font description.
See [method@Pango.FontDescription.set_weight].
the weight field for the font description.
Use [method@Pango.FontDescription.get_set_fields] to find
out if the field was explicitly set or not.
a `PangoFontDescription`
Computes a hash of a `PangoFontDescription` structure.
This is suitable to be used, for example, as an argument
to g_hash_table_new(). The hash value is independent of @desc->mask.
the hash value.
a `PangoFontDescription`
Merges the fields that are set in @desc_to_merge into the fields in
@desc.
If @replace_existing is %FALSE, only fields in @desc that
are not already set are affected. If %TRUE, then fields that are
already set will be replaced as well.
If @desc_to_merge is %NULL, this function performs nothing.
a `PangoFontDescription`
the `PangoFontDescription` to merge from,
or %NULL
if %TRUE, replace fields in @desc with the
corresponding values from @desc_to_merge, even if they
are already exist.
Merges the fields that are set in @desc_to_merge into the fields in
@desc, without copying allocated fields.
This is like [method@Pango.FontDescription.merge], but only a shallow copy
is made of the family name and other allocated fields. @desc can only
be used until @desc_to_merge is modified or freed. This is meant to
be used when the merged font description is only needed temporarily.
a `PangoFontDescription`
the `PangoFontDescription` to merge from
if %TRUE, replace fields in @desc with the
corresponding values from @desc_to_merge, even if they
are already exist.
Sets the size field of a font description, in device units.
This is mutually exclusive with [method@Pango.FontDescription.set_size]
which sets the font size in points.
a `PangoFontDescription`
the new size, in Pango units. There are %PANGO_SCALE Pango units
in one device unit. For an output backend where a device unit is a pixel,
a @size value of 10 * PANGO_SCALE gives a 10 pixel font.
Sets the family name field of a font description.
The family
name represents a family of related font styles, and will
resolve to a particular `PangoFontFamily`. In some uses of
`PangoFontDescription`, it is also possible to use a comma
separated list of family names for this field.
a `PangoFontDescription`.
a string representing the family name.
Sets the family name field of a font description, without copying the string.
This is like [method@Pango.FontDescription.set_family], except that no
copy of @family is made. The caller must make sure that the
string passed in stays around until @desc has been freed or the
name is set again. This function can be used if @family is a static
string such as a C string literal, or if @desc is only needed temporarily.
a `PangoFontDescription`
a string representing the family name
Sets the gravity field of a font description.
The gravity field
specifies how the glyphs should be rotated. If @gravity is
%PANGO_GRAVITY_AUTO, this actually unsets the gravity mask on
the font description.
This function is seldom useful to the user. Gravity should normally
be set on a `PangoContext`.
a `PangoFontDescription`
the gravity for the font description.
Sets the size field of a font description in fractional points.
This is mutually exclusive with
[method@Pango.FontDescription.set_absolute_size].
a `PangoFontDescription`
the size of the font in points, scaled by %PANGO_SCALE.
(That is, a @size value of 10 * PANGO_SCALE is a 10 point font.
The conversion factor between points and device units depends on
system configuration and the output device. For screen display, a
logical DPI of 96 is common, in which case a 10 point font corresponds
to a 10 * (96 / 72) = 13.3 pixel font.
Use [method@Pango.FontDescription.set_absolute_size] if you need
a particular size in device units.
Sets the stretch field of a font description.
The [enum@Pango.Stretch] field specifies how narrow or
wide the font should be.
a `PangoFontDescription`
the stretch for the font description
Sets the style field of a `PangoFontDescription`.
The [enum@Pango.Style] enumeration describes whether the font is
slanted and the manner in which it is slanted; it can be either
%PANGO_STYLE_NORMAL, %PANGO_STYLE_ITALIC, or %PANGO_STYLE_OBLIQUE.
Most fonts will either have a italic style or an oblique style,
but not both, and font matching in Pango will match italic
specifications with oblique fonts and vice-versa if an exact
match is not found.
a `PangoFontDescription`
the style for the font description
Sets the variant field of a font description.
The [enum@Pango.Variant] can either be %PANGO_VARIANT_NORMAL
or %PANGO_VARIANT_SMALL_CAPS.
a `PangoFontDescription`
the variant type for the font description.
Sets the variations field of a font description.
OpenType font variations allow to select a font instance by
specifying values for a number of axes, such as width or weight.
The format of the variations string is
AXIS1=VALUE,AXIS2=VALUE...
with each AXIS a 4 character tag that identifies a font axis,
and each VALUE a floating point number. Unknown axes are ignored,
and values are clamped to their allowed range.
Pango does not currently have a way to find supported axes of
a font. Both harfbuzz and freetype have API for this. See
for example [hb_ot_var_get_axis_infos](https://harfbuzz.github.io/harfbuzz-hb-ot-var.html#hb-ot-var-get-axis-infos).
a `PangoFontDescription`.
a string representing the variations
Sets the variations field of a font description.
This is like [method@Pango.FontDescription.set_variations], except
that no copy of @variations is made. The caller must make sure that
the string passed in stays around until @desc has been freed
or the name is set again. This function can be used if
@variations is a static string such as a C string literal,
or if @desc is only needed temporarily.
a `PangoFontDescription`
a string representing the variations
Sets the weight field of a font description.
The weight field
specifies how bold or light the font should be. In addition
to the values of the [enum@Pango.Weight] enumeration, other
intermediate numeric values are possible.
a `PangoFontDescription`
the weight for the font description.
Creates a filename representation of a font description.
The filename is identical to the result from calling
[method@Pango.FontDescription.to_string], but with underscores
instead of characters that are untypical in filenames, and in
lower case only.
a new string that must be freed with g_free().
a `PangoFontDescription`
Creates a string representation of a font description.
See [func@Pango.FontDescription.from_string] for a description
of the format of the string representation. The family list in
the string description will only have a terminating comma if
the last word of the list is a valid style option.
a new string that must be freed with g_free().
a `PangoFontDescription`
Unsets some of the fields in a `PangoFontDescription`.
The unset fields will get back to their default values.
a `PangoFontDescription`
bitmask of fields in the @desc to unset.
Creates a new font description from a string representation.
The string must have the form
"\[FAMILY-LIST] \[STYLE-OPTIONS] \[SIZE] \[VARIATIONS]",
where FAMILY-LIST is a comma-separated list of families optionally
terminated by a comma, STYLE_OPTIONS is a whitespace-separated list
of words where each word describes one of style, variant, weight,
stretch, or gravity, and SIZE is a decimal number (size in points)
or optionally followed by the unit modifier "px" for absolute size.
VARIATIONS is a comma-separated list of font variation
specifications of the form "\@axis=value" (the = sign is optional).
The following words are understood as styles:
"Normal", "Roman", "Oblique", "Italic".
The following words are understood as variants:
"Small-Caps", "All-Small-Caps", "Petite-Caps", "All-Petite-Caps",
"Unicase", "Title-Caps".
The following words are understood as weights:
"Thin", "Ultra-Light", "Extra-Light", "Light", "Semi-Light",
"Demi-Light", "Book", "Regular", "Medium", "Semi-Bold", "Demi-Bold",
"Bold", "Ultra-Bold", "Extra-Bold", "Heavy", "Black", "Ultra-Black",
"Extra-Black".
The following words are understood as stretch values:
"Ultra-Condensed", "Extra-Condensed", "Condensed", "Semi-Condensed",
"Semi-Expanded", "Expanded", "Extra-Expanded", "Ultra-Expanded".
The following words are understood as gravity values:
"Not-Rotated", "South", "Upside-Down", "North", "Rotated-Left",
"East", "Rotated-Right", "West".
Any one of the options may be absent. If FAMILY-LIST is absent, then
the family_name field of the resulting font description will be
initialized to %NULL. If STYLE-OPTIONS is missing, then all style
options will be set to the default values. If SIZE is missing, the
size in the resulting font description will be set to 0.
A typical example:
"Cantarell Italic Light 15 \@wght=200"
a new `PangoFontDescription`.
string representation of a font description.
A `PangoFontFace` is used to represent a group of fonts with
the same family, slant, weight, and width, but varying sizes.
Returns a font description that matches the face.
The resulting font description will have the family, style,
variant, weight and stretch of the face, but its size field
will be unset.
a newly-created `PangoFontDescription` structure
holding the description of the face. Use [method@Pango.FontDescription.free]
to free the result.
a `PangoFontFace`
Gets a name representing the style of this face.
Note that a font family may contain multiple faces
with the same name (e.g. a variable and a non-variable
face for the same style).
the face name for the face. This string is
owned by the face object and must not be modified or freed.
a `PangoFontFace`.
Gets the `PangoFontFamily` that @face belongs to.
the `PangoFontFamily`
a `PangoFontFace`
Returns whether a `PangoFontFace` is synthesized.
This will be the case if the underlying font rendering engine
creates this face from another face, by shearing, emboldening,
lightening or modifying it in some other way.
whether @face is synthesized
a `PangoFontFace`
List the available sizes for a font.
This is only applicable to bitmap fonts. For scalable fonts, stores
%NULL at the location pointed to by @sizes and 0 at the location pointed
to by @n_sizes. The sizes returned are in Pango units and are sorted
in ascending order.
a `PangoFontFace`.
location to store a pointer to an array of int. This array
should be freed with g_free().
location to store the number of elements in @sizes
Returns a font description that matches the face.
The resulting font description will have the family, style,
variant, weight and stretch of the face, but its size field
will be unset.
a newly-created `PangoFontDescription` structure
holding the description of the face. Use [method@Pango.FontDescription.free]
to free the result.
a `PangoFontFace`
Gets a name representing the style of this face.
Note that a font family may contain multiple faces
with the same name (e.g. a variable and a non-variable
face for the same style).
the face name for the face. This string is
owned by the face object and must not be modified or freed.
a `PangoFontFace`.
Gets the `PangoFontFamily` that @face belongs to.
the `PangoFontFamily`
a `PangoFontFace`
Returns whether a `PangoFontFace` is synthesized.
This will be the case if the underlying font rendering engine
creates this face from another face, by shearing, emboldening,
lightening or modifying it in some other way.
whether @face is synthesized
a `PangoFontFace`
List the available sizes for a font.
This is only applicable to bitmap fonts. For scalable fonts, stores
%NULL at the location pointed to by @sizes and 0 at the location pointed
to by @n_sizes. The sizes returned are in Pango units and are sorted
in ascending order.
a `PangoFontFace`.
location to store a pointer to an array of int. This array
should be freed with g_free().
location to store the number of elements in @sizes
the face name for the face. This string is
owned by the face object and must not be modified or freed.
a `PangoFontFace`.
a newly-created `PangoFontDescription` structure
holding the description of the face. Use [method@Pango.FontDescription.free]
to free the result.
a `PangoFontFace`
a `PangoFontFace`.
location to store a pointer to an array of int. This array
should be freed with g_free().
location to store the number of elements in @sizes
whether @face is synthesized
a `PangoFontFace`
the `PangoFontFamily`
a `PangoFontFace`
A `PangoFontFamily` is used to represent a family of related
font faces.
The font faces in a family share a common design, but differ in
slant, weight, width or other aspects.
Gets the `PangoFontFace` of @family with the given name.
the `PangoFontFace`,
or %NULL if no face with the given name exists.
a `PangoFontFamily`
the name of a face. If the name is %NULL,
the family's default face (fontconfig calls it "Regular")
will be returned.
Gets the name of the family.
The name is unique among all fonts for the font backend and can
be used in a `PangoFontDescription` to specify that a face from
this family is desired.
the name of the family. This string is owned
by the family object and must not be modified or freed.
a `PangoFontFamily`
A monospace font is a font designed for text display where the the
characters form a regular grid.
For Western languages this would
mean that the advance width of all characters are the same, but
this categorization also includes Asian fonts which include
double-width characters: characters that occupy two grid cells.
g_unichar_iswide() returns a result that indicates whether a
character is typically double-width in a monospace font.
The best way to find out the grid-cell size is to call
[method@Pango.FontMetrics.get_approximate_digit_width], since the
results of [method@Pango.FontMetrics.get_approximate_char_width] may
be affected by double-width characters.
%TRUE if the family is monospace.
a `PangoFontFamily`
A variable font is a font which has axes that can be modified to
produce different faces.
Such axes are also known as _variations_; see
[method@Pango.FontDescription.set_variations] for more information.
%TRUE if the family is variable
a `PangoFontFamily`
Lists the different font faces that make up @family.
The faces in a family share a common design, but differ in slant, weight,
width and other aspects.
Note that the returned faces are not in any particular order, and
multiple faces may have the same name or characteristics.
`PangoFontFamily` also implemented the [iface@Gio.ListModel] interface
for enumerating faces.
a `PangoFontFamily`
location to store an array of pointers to `PangoFontFace` objects,
or %NULL. This array should be freed with g_free() when it is no
longer needed.
location to store number of elements in @faces.
Gets the `PangoFontFace` of @family with the given name.
the `PangoFontFace`,
or %NULL if no face with the given name exists.
a `PangoFontFamily`
the name of a face. If the name is %NULL,
the family's default face (fontconfig calls it "Regular")
will be returned.
Gets the name of the family.
The name is unique among all fonts for the font backend and can
be used in a `PangoFontDescription` to specify that a face from
this family is desired.
the name of the family. This string is owned
by the family object and must not be modified or freed.
a `PangoFontFamily`
A monospace font is a font designed for text display where the the
characters form a regular grid.
For Western languages this would
mean that the advance width of all characters are the same, but
this categorization also includes Asian fonts which include
double-width characters: characters that occupy two grid cells.
g_unichar_iswide() returns a result that indicates whether a
character is typically double-width in a monospace font.
The best way to find out the grid-cell size is to call
[method@Pango.FontMetrics.get_approximate_digit_width], since the
results of [method@Pango.FontMetrics.get_approximate_char_width] may
be affected by double-width characters.
%TRUE if the family is monospace.
a `PangoFontFamily`
A variable font is a font which has axes that can be modified to
produce different faces.
Such axes are also known as _variations_; see
[method@Pango.FontDescription.set_variations] for more information.
%TRUE if the family is variable
a `PangoFontFamily`
Lists the different font faces that make up @family.
The faces in a family share a common design, but differ in slant, weight,
width and other aspects.
Note that the returned faces are not in any particular order, and
multiple faces may have the same name or characteristics.
`PangoFontFamily` also implemented the [iface@Gio.ListModel] interface
for enumerating faces.
a `PangoFontFamily`
location to store an array of pointers to `PangoFontFace` objects,
or %NULL. This array should be freed with g_free() when it is no
longer needed.
location to store number of elements in @faces.
The type of items contained in this list.
The number of items contained in this list.
a `PangoFontFamily`
location to store an array of pointers to `PangoFontFace` objects,
or %NULL. This array should be freed with g_free() when it is no
longer needed.
location to store number of elements in @faces.
the name of the family. This string is owned
by the family object and must not be modified or freed.
a `PangoFontFamily`
%TRUE if the family is monospace.
a `PangoFontFamily`
%TRUE if the family is variable
a `PangoFontFamily`
the `PangoFontFace`,
or %NULL if no face with the given name exists.
a `PangoFontFamily`
the name of a face. If the name is %NULL,
the family's default face (fontconfig calls it "Regular")
will be returned.
A `PangoFontMap` represents the set of fonts available for a
particular rendering system.
This is a virtual object with implementations being specific to
particular rendering systems.
Forces a change in the context, which will cause any `PangoContext`
using this fontmap to change.
This function is only useful when implementing a new backend
for Pango, something applications won't do. Backends should
call this function if they have attached extra data to the
context and such data is changed.
a `PangoFontMap`
Gets a font family by name.
the `PangoFontFamily`
a `PangoFontMap`
a family name
Returns the current serial number of @fontmap.
The serial number is initialized to an small number larger than zero
when a new fontmap is created and is increased whenever the fontmap
is changed. It may wrap, but will never have the value 0. Since it can
wrap, never compare it with "less than", always use "not equals".
The fontmap can only be changed using backend-specific API, like changing
fontmap resolution.
This can be used to automatically detect changes to a `PangoFontMap`,
like in `PangoContext`.
The current serial number of @fontmap.
a `PangoFontMap`
List all families for a fontmap.
Note that the returned families are not in any particular order.
`PangoFontMap` also implemented the [iface@Gio.ListModel] interface
for enumerating families.
a `PangoFontMap`
location to
store a pointer to an array of `PangoFontFamily` *.
This array should be freed with g_free().
location to store the number of elements in @families
Load the font in the fontmap that is the closest match for @desc.
the newly allocated `PangoFont`
loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
Load a set of fonts in the fontmap that can be used to render
a font matching @desc.
the newly allocated
`PangoFontset` loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
a `PangoLanguage` the fonts will be used for
Forces a change in the context, which will cause any `PangoContext`
using this fontmap to change.
This function is only useful when implementing a new backend
for Pango, something applications won't do. Backends should
call this function if they have attached extra data to the
context and such data is changed.
a `PangoFontMap`
Creates a `PangoContext` connected to @fontmap.
This is equivalent to [ctor@Pango.Context.new] followed by
[method@Pango.Context.set_font_map].
If you are using Pango as part of a higher-level system,
that system may have it's own way of create a `PangoContext`.
For instance, the GTK toolkit has, among others,
gtk_widget_get_pango_context(). Use those instead.
the newly allocated `PangoContext`,
which should be freed with g_object_unref().
a `PangoFontMap`
Gets a font family by name.
the `PangoFontFamily`
a `PangoFontMap`
a family name
Returns the current serial number of @fontmap.
The serial number is initialized to an small number larger than zero
when a new fontmap is created and is increased whenever the fontmap
is changed. It may wrap, but will never have the value 0. Since it can
wrap, never compare it with "less than", always use "not equals".
The fontmap can only be changed using backend-specific API, like changing
fontmap resolution.
This can be used to automatically detect changes to a `PangoFontMap`,
like in `PangoContext`.
The current serial number of @fontmap.
a `PangoFontMap`
List all families for a fontmap.
Note that the returned families are not in any particular order.
`PangoFontMap` also implemented the [iface@Gio.ListModel] interface
for enumerating families.
a `PangoFontMap`
location to
store a pointer to an array of `PangoFontFamily` *.
This array should be freed with g_free().
location to store the number of elements in @families
Load the font in the fontmap that is the closest match for @desc.
the newly allocated `PangoFont`
loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
Load a set of fonts in the fontmap that can be used to render
a font matching @desc.
the newly allocated
`PangoFontset` loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
a `PangoLanguage` the fonts will be used for
The type of items contained in this list.
The number of items contained in this list.
The `PangoFontMapClass` structure holds the virtual functions for
a particular `PangoFontMap` implementation.
parent `GObjectClass`
the newly allocated `PangoFont`
loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
a `PangoFontMap`
location to
store a pointer to an array of `PangoFontFamily` *.
This array should be freed with g_free().
location to store the number of elements in @families
the newly allocated
`PangoFontset` loaded, or %NULL if no font matched.
a `PangoFontMap`
the `PangoContext` the font will be used with
a `PangoFontDescription` describing the font to load
a `PangoLanguage` the fonts will be used for
the type of rendering-system-dependent engines that
can handle fonts of this fonts loaded with this fontmap.
The current serial number of @fontmap.
a `PangoFontMap`
a `PangoFontMap`
the `PangoFontFamily`
a `PangoFontMap`
a family name
The bits in a `PangoFontMask` correspond to the set fields in a
`PangoFontDescription`.
the font family is specified.
the font style is specified.
the font variant is specified.
the font weight is specified.
the font stretch is specified.
the font size is specified.
the font gravity is specified (Since: 1.16.)
OpenType font variations are specified (Since: 1.42)
A `PangoFontMetrics` structure holds the overall metric information
for a font.
The information in a `PangoFontMetrics` structure may be restricted
to a script. The fields of this structure are private to implementations
of a font backend. See the documentation of the corresponding getters
for documentation of their meaning.
For an overview of the most important metrics, see:
<picture>
<source srcset="fontmetrics-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Font metrics" src="fontmetrics-light.png">
</picture>
Gets the approximate character width for a font metrics structure.
This is merely a representative value useful, for example, for
determining the initial size for a window. Actual characters in
text will be wider and narrower than this.
the character width, in Pango units.
a `PangoFontMetrics` structure
Gets the approximate digit width for a font metrics structure.
This is merely a representative value useful, for example, for
determining the initial size for a window. Actual digits in
text can be wider or narrower than this, though this value
is generally somewhat more accurate than the result of
pango_font_metrics_get_approximate_char_width() for digits.
the digit width, in Pango units.
a `PangoFontMetrics` structure
Gets the ascent from a font metrics structure.
The ascent is the distance from the baseline to the logical top
of a line of text. (The logical top may be above or below the top
of the actual drawn ink. It is necessary to lay out the text to
figure where the ink will be.)
the ascent, in Pango units.
a `PangoFontMetrics` structure
Gets the descent from a font metrics structure.
The descent is the distance from the baseline to the logical bottom
of a line of text. (The logical bottom may be above or below the
bottom of the actual drawn ink. It is necessary to lay out the text
to figure where the ink will be.)
the descent, in Pango units.
a `PangoFontMetrics` structure
Gets the line height from a font metrics structure.
The line height is the recommended distance between successive
baselines in wrapped text using this font.
If the line height is not available, 0 is returned.
the height, in Pango units
a `PangoFontMetrics` structure
Gets the suggested position to draw the strikethrough.
The value returned is the distance *above* the
baseline of the top of the strikethrough.
the suggested strikethrough position, in Pango units.
a `PangoFontMetrics` structure
Gets the suggested thickness to draw for the strikethrough.
the suggested strikethrough thickness, in Pango units.
a `PangoFontMetrics` structure
Gets the suggested position to draw the underline.
The value returned is the distance *above* the baseline of the top
of the underline. Since most fonts have underline positions beneath
the baseline, this value is typically negative.
the suggested underline position, in Pango units.
a `PangoFontMetrics` structure
Gets the suggested thickness to draw for the underline.
the suggested underline thickness, in Pango units.
a `PangoFontMetrics` structure
Increase the reference count of a font metrics structure by one.
@metrics
a `PangoFontMetrics` structure, may be %NULL
Decrease the reference count of a font metrics structure by one.
If the result is zero, frees the structure and any associated memory.
a `PangoFontMetrics` structure, may be %NULL
An enumeration that affects font sizes for superscript
and subscript positioning and for (emulated) Small Caps.
Leave the font size unchanged
Change the font to a size suitable for superscripts
Change the font to a size suitable for subscripts
Change the font to a size suitable for Small Caps
A `PangoFontset` represents a set of `PangoFont` to use when rendering text.
A `PangoFontset` is the result of resolving a `PangoFontDescription`
against a particular `PangoContext`. It has operations for finding the
component font for a particular Unicode character, and for finding a
composite set of metrics for the entire fontset.
Iterates through all the fonts in a fontset, calling @func for
each one.
If @func returns %TRUE, that stops the iteration.
a `PangoFontset`
Callback function
data to pass to the callback function
Returns the font in the fontset that contains the best
glyph for a Unicode character.
a `PangoFont`
a `PangoFontset`
a Unicode character
Get overall metric information for the fonts in the fontset.
a `PangoFontMetrics` object
a `PangoFontset`
Iterates through all the fonts in a fontset, calling @func for
each one.
If @func returns %TRUE, that stops the iteration.
a `PangoFontset`
Callback function
data to pass to the callback function
Returns the font in the fontset that contains the best
glyph for a Unicode character.
a `PangoFont`
a `PangoFontset`
a Unicode character
Get overall metric information for the fonts in the fontset.
a `PangoFontMetrics` object
a `PangoFontset`
The `PangoFontsetClass` structure holds the virtual functions for
a particular `PangoFontset` implementation.
parent `GObjectClass`
a `PangoFont`
a `PangoFontset`
a Unicode character
a `PangoFontMetrics` object
a `PangoFontset`
a `PangoFontset`
Callback function
data to pass to the callback function
Callback used when enumerating fonts in a fontset.
See [method@Pango.Fontset.foreach].
if %TRUE, stop iteration and return immediately.
a `PangoFontset`
a font from @fontset
callback data
`PangoFontsetSimple` is a implementation of the abstract
`PangoFontset` base class as an array of fonts.
When creating a `PangoFontsetSimple`, you have to provide
the array of fonts that make up the fontset.
Creates a new `PangoFontsetSimple` for the given language.
the newly allocated `PangoFontsetSimple`
a `PangoLanguage` tag
Adds a font to the fontset.
The fontset takes ownership of @font.
a `PangoFontsetSimple`.
a `PangoFont`.
Returns the number of fonts in the fontset.
the size of @fontset
a `PangoFontsetSimple`.
The way this unknown glyphs are rendered is backend specific. For example,
a box with the hexadecimal Unicode code-point of the character written in it
is what is done in the most common backends.
a Unicode character
A `PangoGlyph` value that indicates a zero-width empty glpyh.
This is useful for example in shaper modules, to use as the glyph for
various zero-width Unicode characters (those passing [func@is_zero_width]).
A `PangoGlyph` value for invalid input.
`PangoLayout` produces one such glyph per invalid input UTF-8 byte and such
a glyph is rendered as a crossed box.
Note that this value is defined such that it has the %PANGO_GLYPH_UNKNOWN_FLAG
set.
Flag used in `PangoGlyph` to turn a `gunichar` value of a valid Unicode
character into an unknown-character glyph for that `gunichar`.
Such unknown-character glyphs may be rendered as a 'hex box'.
Whether a `PangoGravity` represents a gravity that results in reversal
of text direction.
the `PangoGravity` to check
Whether a `PangoGravity` represents vertical writing directions.
the `PangoGravity` to check
The `PangoGlyphGeometry` structure contains width and positioning
information for a single glyph.
Note that @width is not guaranteed to be the same as the glyph
extents. Kerning and other positioning applied during shaping will
affect both the @width and the @x_offset for the glyphs in the
glyph string that results from shaping.
The information in this struct is intended for rendering the glyphs,
as follows:
1. Assume the current point is (x, y)
2. Render the current glyph at (x + x_offset, y + y_offset),
3. Advance the current point to (x + width, y)
4. Render the next glyph
the logical width to use for the the character.
horizontal offset from nominal character position.
vertical offset from nominal character position.
A `PangoGlyphInfo` structure represents a single glyph with
positioning information and visual attributes.
the glyph itself.
the positional information about the glyph.
the visual attributes of the glyph.
A `PangoGlyphItem` is a pair of a `PangoItem` and the glyphs
resulting from shaping the items text.
As an example of the usage of `PangoGlyphItem`, the results
of shaping text with `PangoLayout` is a list of `PangoLayoutLine`,
each of which contains a list of `PangoGlyphItem`.
corresponding `PangoItem`
corresponding `PangoGlyphString`
shift of the baseline, relative to the baseline
of the containing line. Positive values shift upwards
horizontal displacement to apply before the
glyph item. Positive values shift right
horizontal displacement to apply after th
glyph item. Positive values shift right
Splits a shaped item (`PangoGlyphItem`) into multiple items based
on an attribute list.
The idea is that if you have attributes that don't affect shaping,
such as color or underline, to avoid affecting shaping, you filter
them out ([method@Pango.AttrList.filter]), apply the shaping process
and then reapply them to the result using this function.
All attributes that start or end inside a cluster are applied
to that cluster; for instance, if half of a cluster is underlined
and the other-half strikethrough, then the cluster will end
up with both underline and strikethrough attributes. In these
cases, it may happen that @item->extra_attrs for some of the
result items can have multiple attributes of the same type.
This function takes ownership of @glyph_item; it will be reused
as one of the elements in the list.
a
list of glyph items resulting from splitting @glyph_item. Free
the elements using [method@Pango.GlyphItem.free], the list using
g_slist_free().
a shaped item
text that @list applies to
a `PangoAttrList`
Make a deep copy of an existing `PangoGlyphItem` structure.
the newly allocated `PangoGlyphItem`
a `PangoGlyphItem`
Frees a `PangoGlyphItem` and resources to which it points.
a `PangoGlyphItem`
Given a `PangoGlyphItem` and the corresponding text, determine the
width corresponding to each character.
When multiple characters compose a single cluster, the width of the
entire cluster is divided equally among the characters.
See also [method@Pango.GlyphString.get_logical_widths].
a `PangoGlyphItem`
text that @glyph_item corresponds to
(glyph_item->item->offset is an offset from the
start of @text)
an array whose length is the number of
characters in glyph_item (equal to glyph_item->item->num_chars)
to be filled in with the resulting character widths.
Adds spacing between the graphemes of @glyph_item to
give the effect of typographic letter spacing.
a `PangoGlyphItem`
text that @glyph_item corresponds to
(glyph_item->item->offset is an offset from the
start of @text)
logical attributes for the item
(the first logical attribute refers to the position
before the first character in the item)
amount of letter spacing to add
in Pango units. May be negative, though too large
negative values will give ugly results.
Modifies @orig to cover only the text after @split_index, and
returns a new item that covers the text before @split_index that
used to be in @orig.
You can think of @split_index as the length of the returned item.
@split_index may not be 0, and it may not be greater than or equal
to the length of @orig (that is, there must be at least one byte
assigned to each item, you can't create a zero-length item).
This function is similar in function to pango_item_split() (and uses
it internally.)
the newly allocated item representing text before
@split_index, which should be freed
with pango_glyph_item_free().
a `PangoItem`
text to which positions in @orig apply
byte index of position to split item, relative to the
start of the item
A `PangoGlyphItemIter` is an iterator over the clusters in a
`PangoGlyphItem`.
The *forward direction* of the iterator is the logical direction of text.
That is, with increasing @start_index and @start_char values. If @glyph_item
is right-to-left (that is, if `glyph_item->item->analysis.level` is odd),
then @start_glyph decreases as the iterator moves forward. Moreover,
in right-to-left cases, @start_glyph is greater than @end_glyph.
An iterator should be initialized using either
pango_glyph_item_iter_init_start() or
pango_glyph_item_iter_init_end(), for forward and backward iteration
respectively, and walked over using any desired mixture of
pango_glyph_item_iter_next_cluster() and
pango_glyph_item_iter_prev_cluster().
A common idiom for doing a forward iteration over the clusters is:
```
PangoGlyphItemIter cluster_iter;
gboolean have_cluster;
for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter,
glyph_item, text);
have_cluster;
have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter))
{
...
}
```
Note that @text is the start of the text for layout, which is then
indexed by `glyph_item->item->offset` to get to the text of @glyph_item.
The @start_index and @end_index values can directly index into @text. The
@start_glyph, @end_glyph, @start_char, and @end_char values however are
zero-based for the @glyph_item. For each cluster, the item pointed at by
the start variables is included in the cluster while the one pointed at by
end variables is not.
None of the members of a `PangoGlyphItemIter` should be modified manually.
Make a shallow copy of an existing `PangoGlyphItemIter` structure.
the newly allocated `PangoGlyphItemIter`
a `PangoGlyphItem`Iter
Frees a `PangoGlyphItem`Iter.
a `PangoGlyphItemIter`
Initializes a `PangoGlyphItemIter` structure to point to the
last cluster in a glyph item.
See `PangoGlyphItemIter` for details of cluster orders.
%FALSE if there are no clusters in the glyph item
a `PangoGlyphItemIter`
the glyph item to iterate over
text corresponding to the glyph item
Initializes a `PangoGlyphItemIter` structure to point to the
first cluster in a glyph item.
See `PangoGlyphItemIter` for details of cluster orders.
%FALSE if there are no clusters in the glyph item
a `PangoGlyphItemIter`
the glyph item to iterate over
text corresponding to the glyph item
Advances the iterator to the next cluster in the glyph item.
See `PangoGlyphItemIter` for details of cluster orders.
%TRUE if the iterator was advanced,
%FALSE if we were already on the last cluster.
a `PangoGlyphItemIter`
Moves the iterator to the preceding cluster in the glyph item.
See `PangoGlyphItemIter` for details of cluster orders.
%TRUE if the iterator was moved,
%FALSE if we were already on the first cluster.
a `PangoGlyphItemIter`
A `PangoGlyphString` is used to store strings of glyphs with geometry
and visual attribute information.
The storage for the glyph information is owned by the structure
which simplifies memory management.
number of glyphs in this glyph string
array of glyph information
logical cluster info, indexed by the byte index
within the text corresponding to the glyph string
Create a new `PangoGlyphString`.
the newly allocated `PangoGlyphString`, which
should be freed with [method@Pango.GlyphString.free].
Copy a glyph string and associated storage.
the newly allocated `PangoGlyphString`
a `PangoGlyphString`
Compute the logical and ink extents of a glyph string.
See the documentation for [method@Pango.Font.get_glyph_extents] for details
about the interpretation of the rectangles.
Examples of logical (red) and ink (green) rects:
![](rects1.png) ![](rects2.png)
a `PangoGlyphString`
a `PangoFont`
rectangle used to store the extents of the glyph string as drawn
rectangle used to store the logical extents of the glyph string
Computes the extents of a sub-portion of a glyph string.
The extents are relative to the start of the glyph string range
(the origin of their coordinate system is at the start of the range,
not at the start of the entire glyph string).
a `PangoGlyphString`
start index
end index (the range is the set of bytes with
indices such that start <= index < end)
a `PangoFont`
rectangle used to
store the extents of the glyph string range as drawn
rectangle used to
store the logical extents of the glyph string range
Free a glyph string and associated storage.
a `PangoGlyphString`, may be %NULL
Given a `PangoGlyphString` and corresponding text, determine the width
corresponding to each character.
When multiple characters compose a single cluster, the width of the
entire cluster is divided equally among the characters.
See also [method@Pango.GlyphItem.get_logical_widths].
a `PangoGlyphString`
the text corresponding to the glyphs
the length of @text, in bytes
the embedding level of the string
an array whose length is the number of
characters in text (equal to `g_utf8_strlen (text, length)` unless
text has `NUL` bytes) to be filled in with the resulting character widths.
Computes the logical width of the glyph string.
This can also be computed using [method@Pango.GlyphString.extents].
However, since this only computes the width, it's much faster. This
is in fact only a convenience function that computes the sum of
@geometry.width for each glyph in the @glyphs.
the logical width of the glyph string.
a `PangoGlyphString`
Converts from character position to x position.
The X position is measured from the left edge of the run.
Character positions are obtained using font metrics for ligatures
where available, and computed by dividing up each cluster
into equal portions, otherwise.
<picture>
<source srcset="glyphstring-positions-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Glyph positions" src="glyphstring-positions-light.png">
</picture>
the glyphs return from [func@shape]
the text for the run
the number of bytes (not characters) in @text.
the analysis information return from [func@itemize]
the byte index within @text
whether we should compute the result for the beginning (%FALSE)
or end (%TRUE) of the character.
location to store result
Converts from character position to x position.
This variant of [method@Pango.GlyphString.index_to_x] additionally
accepts a `PangoLogAttr` array. The grapheme boundary information
in it can be used to disambiguate positioning inside some complex
clusters.
the glyphs return from [func@shape]
the text for the run
the number of bytes (not characters) in @text.
the analysis information return from [func@itemize]
`PangoLogAttr` array for @text
the byte index within @text
whether we should compute the result for the beginning (%FALSE)
or end (%TRUE) of the character.
location to store result
Resize a glyph string to the given length.
a `PangoGlyphString`.
the new length of the string
Convert from x offset to character position.
Character positions are computed by dividing up each cluster into
equal portions. In scripts where positioning within a cluster is
not allowed (such as Thai), the returned value may not be a valid
cursor position; the caller must combine the result with the logical
attributes for the text to compute the valid cursor position.
the glyphs returned from [func@shape]
the text for the run
the number of bytes (not characters) in text.
the analysis information return from [func@itemize]
the x offset (in Pango units)
location to store calculated byte index within @text
location to store a boolean indicating whether the
user clicked on the leading or trailing edge of the character
A `PangoGlyphVisAttr` structure communicates information between
the shaping and rendering phases.
Currently, it contains cluster start and color information.
More attributes may be added in the future.
Clusters are stored in visual order, within the cluster, glyphs
are always ordered in logical order, since visual order is meaningless;
that is, in Arabic text, accent glyphs follow the glyphs for the
base character.
set for the first logical glyph in each cluster.
set if the the font will render this glyph with color. Since 1.50
`PangoGravity` represents the orientation of glyphs in a segment
of text.
This is useful when rendering vertical text layouts. In those situations,
the layout is rotated using a non-identity [struct@Pango.Matrix], and then
glyph orientation is controlled using `PangoGravity`.
Not every value in this enumeration makes sense for every usage of
`PangoGravity`; for example, %PANGO_GRAVITY_AUTO only can be passed to
[method@Pango.Context.set_base_gravity] and can only be returned by
[method@Pango.Context.get_base_gravity].
See also: [enum@Pango.GravityHint]
Glyphs stand upright (default) <img align="right" valign="center" src="m-south.png">
Glyphs are rotated 90 degrees counter-clockwise. <img align="right" valign="center" src="m-east.png">
Glyphs are upside-down. <img align="right" valign="cener" src="m-north.png">
Glyphs are rotated 90 degrees clockwise. <img align="right" valign="center" src="m-west.png">
Gravity is resolved from the context matrix
Finds the gravity that best matches the rotation component
in a `PangoMatrix`.
the gravity of @matrix, which will never be
%PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL
a `PangoMatrix`
Returns the gravity to use in laying out a `PangoItem`.
The gravity is determined based on the script, base gravity, and hint.
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of @script. To get the preferred gravity of a script,
pass %PANGO_GRAVITY_AUTO and %PANGO_GRAVITY_HINT_STRONG in.
resolved gravity suitable to use for a run of text
with @script
`PangoScript` to query
base gravity of the paragraph
orientation hint
Returns the gravity to use in laying out a single character
or `PangoItem`.
The gravity is determined based on the script, East Asian width,
base gravity, and hint,
This function is similar to [func@Pango.Gravity.get_for_script] except
that this function makes a distinction between narrow/half-width and
wide/full-width characters also. Wide/full-width characters always
stand *upright*, that is, they always take the base gravity,
whereas narrow/full-width characters are always rotated in vertical
context.
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of @script.
resolved gravity suitable to use for a run of text
with @script and @wide.
`PangoScript` to query
%TRUE for wide characters as returned by g_unichar_iswide()
base gravity of the paragraph
orientation hint
Converts a `PangoGravity` value to its natural rotation in radians.
Note that [method@Pango.Matrix.rotate] takes angle in degrees, not radians.
So, to call [method@Pango.Matrix,rotate] with the output of this function
you should multiply it by (180. / G_PI).
the rotation value corresponding to @gravity.
gravity to query, should not be %PANGO_GRAVITY_AUTO
`PangoGravityHint` defines how horizontal scripts should behave in a
vertical context.
That is, English excerpts in a vertical paragraph for example.
See also [enum@Pango.Gravity]
scripts will take their natural gravity based
on the base gravity and the script. This is the default.
always use the base gravity set, regardless of
the script.
for scripts not in their natural direction (eg.
Latin in East gravity), choose per-script gravity such that every script
respects the line progression. This means, Latin and Arabic will take
opposite gravities and both flow top-to-bottom for example.
The `PangoItem` structure stores information about a segment of text.
You typically obtain `PangoItems` by itemizing a piece of text
with [func@itemize].
byte offset of the start of this item in text.
length of this item in bytes.
number of Unicode characters in the item.
analysis results for the item.
Creates a new `PangoItem` structure initialized to default values.
the newly allocated `PangoItem`, which should
be freed with [method@Pango.Item.free].
Add attributes to a `PangoItem`.
The idea is that you have attributes that don't affect itemization,
such as font features, so you filter them out using
[method@Pango.AttrList.filter], itemize your text, then reapply the
attributes to the resulting items using this function.
The @iter should be positioned before the range of the item,
and will be advanced past it. This function is meant to be called
in a loop over the items resulting from itemization, while passing
the iter to each call.
a `PangoItem`
a `PangoAttrIterator`
Copy an existing `PangoItem` structure.
the newly allocated `PangoItem`
a `PangoItem`
Free a `PangoItem` and all associated memory.
a `PangoItem`, may be %NULL
Modifies @orig to cover only the text after @split_index, and
returns a new item that covers the text before @split_index that
used to be in @orig.
You can think of @split_index as the length of the returned item.
@split_index may not be 0, and it may not be greater than or equal
to the length of @orig (that is, there must be at least one byte
assigned to each item, you can't create a zero-length item).
@split_offset is the length of the first item in chars, and must be
provided because the text used to generate the item isn't available,
so `pango_item_split()` can't count the char length of the split items
itself.
new item representing text before @split_index, which
should be freed with [method@Pango.Item.free].
a `PangoItem`
byte index of position to split item, relative to the
start of the item
number of chars between start of @orig and @split_index
Extracts the *left bearing* from a `PangoRectangle`
representing glyph extents.
The left bearing is the distance from the horizontal
origin to the farthest left point of the character.
This is positive for characters drawn completely to
the right of the glyph origin.
a `PangoRectangle`
The `PangoLanguage` structure is used to
represent a language.
`PangoLanguage` pointers can be efficiently
copied and compared with each other.
Get a string that is representative of the characters needed to
render a particular language.
The sample text may be a pangram, but is not necessarily. It is chosen
to be demonstrative of normal text in the language, as well as exposing
font feature requirements unique to the language. It is suitable for use
as sample text in a font selection dialog.
If @language is %NULL, the default language as found by
[func@Pango.Language.get_default] is used.
If Pango does not have a sample string for @language, the classic
"The quick brown fox..." is returned. This can be detected by
comparing the returned pointer value to that returned for (non-existent)
language code "xx". That is, compare to:
```
pango_language_get_sample_string (pango_language_from_string ("xx"))
```
the sample string
a `PangoLanguage`
Determines the scripts used to to write @language.
If nothing is known about the language tag @language,
or if @language is %NULL, then %NULL is returned.
The list of scripts returned starts with the script that the
language uses most and continues to the one it uses least.
The value @num_script points at will be set to the number
of scripts in the returned array (or zero if %NULL is returned).
Most languages use only one script for writing, but there are
some that use two (Latin and Cyrillic for example), and a few
use three (Japanese for example). Applications should not make
any assumptions on the maximum number of scripts returned
though, except that it is positive if the return value is not
%NULL, and it is a small number.
The [method@Pango.Language.includes_script] function uses this
function internally.
Note: while the return value is declared as `PangoScript`, the
returned values are from the `GUnicodeScript` enumeration, which
may have more values. Callers need to handle unknown values.
An array of `PangoScript` values, with the number of entries in
the array stored in @num_scripts, or %NULL if Pango does not have
any information about this particular language tag (also the case
if @language is %NULL).
a `PangoLanguage`
location to
return number of scripts
Determines if @script is one of the scripts used to
write @language.
The returned value is conservative; if nothing is known about
the language tag @language, %TRUE will be returned, since, as
far as Pango knows, @script might be used to write @language.
This routine is used in Pango's itemization process when
determining if a supplied language tag is relevant to
a particular section of text. It probably is not useful
for applications in most circumstances.
This function uses [method@Pango.Language.get_scripts] internally.
%TRUE if @script is one of the scripts used
to write @language or if nothing is known about @language
(including the case that @language is %NULL), %FALSE otherwise.
a `PangoLanguage`
a `PangoScript`
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 it in the tag is '-'.
%TRUE if a match was found
a language tag (see [func@Pango.Language.from_string]),
%NULL is allowed and matches nothing but '*'
a list of language ranges, separated by ';', ':',
',', or space characters.
Each element must either be '*', or a RFC 3066 language range
canonicalized as by [func@Pango.Language.from_string]
Gets the RFC-3066 format string representing the given language tag.
Returns (transfer none): a string representing the language tag
a language tag.
Convert a language tag to a `PangoLanguage`.
The language tag must be in a RFC-3066 format. `PangoLanguage` pointers
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 '-'.
Use [func@Pango.Language.get_default] if you want to get the
`PangoLanguage` for the current locale of the process.
a `PangoLanguage`
a string representing a language tag
Returns the `PangoLanguage` for the current locale of the process.
On Unix systems, this is the return value is derived from
`setlocale (LC_CTYPE, NULL)`, and the user can
affect this through the environment variables LC_ALL, LC_CTYPE or
LANG (checked in that order). The locale string typically is in
the form lang_COUNTRY, where lang is an ISO-639 language code, and
COUNTRY is an ISO-3166 country code. For instance, sv_FI for
Swedish as written in Finland or pt_BR for Portuguese as written in
Brazil.
On Windows, the C library does not use any such environment
variables, and setting them won't affect the behavior of functions
like ctime(). The user sets the locale through the Regional Options
in the Control Panel. The C library (in the setlocale() function)
does not use country and language codes, but country and language
names spelled out in English.
However, this function does check the above environment
variables, and does return a Unix-style locale string based on
either said environment variables or the thread's current locale.
Your application should call `setlocale(LC_ALL, "")` for the user
settings to take effect. GTK does this in its initialization
functions automatically (by calling gtk_set_locale()).
See the setlocale() manpage for more details.
Note that the default language can change over the life of an application.
Also note that this function will not do the right thing if you
use per-thread locales with uselocale(). In that case, you should
just call pango_language_from_string() yourself.
the default language as a `PangoLanguage`
Returns the list of languages that the user prefers.
The list is specified by the `PANGO_LANGUAGE` or `LANGUAGE`
environment variables, in order of preference. Note that this
list does not necessarily include the language returned by
[func@Pango.Language.get_default].
When choosing language-specific resources, such as the sample
text returned by [method@Pango.Language.get_sample_string],
you should first try the default language, followed by the
languages returned by this function.
a %NULL-terminated array
of `PangoLanguage`*
A `PangoLayout` structure represents an entire paragraph of text.
While complete access to the layout capabilities of Pango is provided
using the detailed interfaces for itemization and shaping, using
that functionality directly involves writing a fairly large amount
of code. `PangoLayout` provides a high-level driver for formatting
entire paragraphs of text at once. This includes paragraph-level
functionality such as line breaking, justification, alignment and
ellipsization.
A `PangoLayout` is initialized with a `PangoContext`, 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.
There are a number of parameters to adjust the formatting of a
`PangoLayout`. The following image shows adjustable parameters
(on the left) and font metrics (on the right):
<picture>
<source srcset="layout-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Pango Layout Parameters" src="layout-light.png">
</picture>
The following images demonstrate the effect of alignment and
justification on the layout of text:
| | |
| --- | --- |
| ![align=left](align-left.png) | ![align=left, justify](align-left-justify.png) |
| ![align=center](align-center.png) | ![align=center, justify](align-center-justify.png) |
| ![align=right](align-right.png) | ![align=right, justify](align-right-justify.png) |
It is possible, as well, to ignore the 2-D setup,
and simply treat the results of a `PangoLayout` as a list of lines.
Create a new `PangoLayout` object with attributes initialized to
default values for a particular `PangoContext`.
the newly allocated `PangoLayout`
a `PangoContext`
Loads data previously created via [method@Pango.Layout.serialize].
For a discussion of the supported format, see that function.
Note: to verify that the returned layout is identical to
the one that was serialized, you can compare @bytes to the
result of serializing the layout again.
a new `PangoLayout`
a `PangoContext`
the bytes containing the data
`PangoLayoutDeserializeFlags`
Forces recomputation of any state in the `PangoLayout` 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.
a `PangoLayout`
Creates a deep copy-by-value of the layout.
The attribute list, tab array, and text from the original layout
are all copied by value.
the newly allocated `PangoLayout`
a `PangoLayout`
Gets the alignment for the layout: how partial lines are
positioned within the horizontal space available.
the alignment
a `PangoLayout`
Gets the attribute list for the layout, if any.
a `PangoAttrList`
a `PangoLayout`
Gets whether to calculate the base direction for the layout
according to its contents.
See [method@Pango.Layout.set_auto_dir].
%TRUE if the bidirectional base direction
is computed from the layout's contents, %FALSE otherwise
a `PangoLayout`
Gets the Y position of baseline of the first line in @layout.
baseline of first line, from top of @layout
a `PangoLayout`
Given an index within a layout, determines the positions that of the
strong and weak cursors if the insertion point is at that index.
This is a variant of [method@Pango.Layout.get_cursor_pos] that applies
font metric information about caret slope and offset to the positions
it returns.
<picture>
<source srcset="caret-metrics-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Caret metrics" src="caret-metrics-light.png">
</picture>
a `PangoLayout`
the byte index of the cursor
location to store the strong cursor position
location to store the weak cursor position
Returns the number of Unicode characters in the
the text of @layout.
the number of Unicode characters
in the text of @layout
a `PangoLayout`
Retrieves the `PangoContext` used for this layout.
the `PangoContext` for the layout
a `PangoLayout`
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
with the height of the run extents.
<picture>
<source srcset="cursor-positions-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Cursor positions" src="cursor-positions-light.png">
</picture>
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.
The following example shows text with both a strong and a weak cursor.
<picture>
<source srcset="split-cursor-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Strong and weak cursors" src="split-cursor-light.png">
</picture>
The strong cursor has a little arrow pointing to the right, the weak
cursor to the left. Typing a 'c' in this situation will insert the
character after the 'b', and typing another Hebrew character, like '×’',
will insert it at the end.
a `PangoLayout`
the byte index of the cursor
location to store the strong cursor position
location to store the weak cursor position
Gets the text direction at the given character position in @layout.
the text direction at @index
a `PangoLayout`
the byte index of the char
Gets the type of ellipsization being performed for @layout.
See [method@Pango.Layout.set_ellipsize].
Use [method@Pango.Layout.is_ellipsized] to query whether any
paragraphs were actually ellipsized.
the current ellipsization mode for @layout
a `PangoLayout`
Computes the logical and ink extents of @layout.
Logical extents are usually what you want for positioning things. Note
that both extents may have non-zero x and y. You may want to use those
to offset where you render the layout. Not doing that is a very typical
bug that shows up as right-to-left layouts not being correctly positioned
in a layout with a set width.
The extents are given in layout coordinates and in Pango units; layout
coordinates begin at the top left corner of the layout.
a `PangoLayout`
rectangle used to store the extents of the
layout as drawn
rectangle used to store the logical
extents of the layout
Gets the font description for the layout, if any.
a pointer to the
layout's font description, or %NULL if the font description
from the layout's context is inherited.
a `PangoLayout`
Gets the height of layout used for ellipsization.
See [method@Pango.Layout.set_height] for details.
the height, in Pango units if positive,
or number of lines if negative.
a `PangoLayout`
Gets the paragraph indent width in Pango units.
A negative value indicates a hanging indentation.
the indent in Pango units
a `PangoLayout`
Returns an iterator to iterate over the visual extents of the layout.
the new `PangoLayoutIter`
a `PangoLayout`
Gets whether each complete line should be stretched to fill the entire
width of the layout.
the justify value
a `PangoLayout`
Gets whether the last line should be stretched
to fill the entire width of the layout.
the justify value
a `PangoLayout`
Retrieves a particular line from a `PangoLayout`.
Use the faster [method@Pango.Layout.get_line_readonly] if you do not
plan to modify the contents of the line (glyphs, glyph widths, etc.).
the requested `PangoLayoutLine`,
or %NULL 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
`PangoLayout`.
a `PangoLayout`
the index of a line, which must be between 0 and
`pango_layout_get_line_count(layout) - 1`, inclusive.
Retrieves the count of lines for the @layout.
the line count
`PangoLayout`
Retrieves a particular line from a `PangoLayout`.
This is a faster alternative to [method@Pango.Layout.get_line],
but the user is not expected to modify the contents of the line
(glyphs, glyph widths, etc.).
the requested `PangoLayoutLine`,
or %NULL 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
`PangoLayout`. No changes should be made to the line.
a `PangoLayout`
the index of a line, which must be between 0 and
`pango_layout_get_line_count(layout) - 1`, inclusive.
Gets the line spacing factor of @layout.
See [method@Pango.Layout.set_line_spacing].
a `PangoLayout`
Returns the lines of the @layout as a list.
Use the faster [method@Pango.Layout.get_lines_readonly] if you do not
plan to modify the contents of the lines (glyphs, glyph widths, etc.).
a `GSList`
containing the lines in the layout. This points to internal data of the
`PangoLayout` and must be used with care. It will become invalid on any
change to the layout's text or properties.
a `PangoLayout`
Returns the lines of the @layout as a list.
This is a faster alternative to [method@Pango.Layout.get_lines],
but the user is not expected to modify the contents of the lines
(glyphs, glyph widths, etc.).
a `GSList`
containing the lines in the layout. This points to internal data of the
`PangoLayout` and must be used with care. It will become invalid on any
change to the layout's text or properties. No changes should be made to
the lines.
a `PangoLayout`
Retrieves an array of logical attributes for each character in
the @layout.
a `PangoLayout`
location to store a pointer to an array of logical attributes.
This value must be freed with g_free().
location to store the number of the attributes in the
array. (The stored value will be one more than the total number
of characters in the layout, since there need to be attributes
corresponding to both the position before the first character
and the position after the last character.)
Retrieves an array of logical attributes for each character in
the @layout.
This is a faster alternative to [method@Pango.Layout.get_log_attrs].
The returned array is part of @layout and must not be modified.
Modifying the layout will invalidate the returned array.
The number of attributes returned in @n_attrs will be one more
than the total number of characters in the layout, since there
need to be attributes corresponding to both the position before
the first character and the position after the last character.
an array of logical attributes
a `PangoLayout`
location to store the number of the attributes in
the array
Computes the logical and ink extents of @layout in device units.
This function just calls [method@Pango.Layout.get_extents] followed by
two [func@extents_to_pixels] calls, rounding @ink_rect and @logical_rect
such that the rounded rectangles fully contain the unrounded one (that is,
passes them as first argument to [func@Pango.extents_to_pixels]).
a `PangoLayout`
rectangle used to store the extents of the
layout as drawn
rectangle used to store the logical
extents of the layout
Determines the logical width and height of a `PangoLayout` in device
units.
[method@Pango.Layout.get_size] returns the width and height
scaled by %PANGO_SCALE. This is simply a convenience function
around [method@Pango.Layout.get_pixel_extents].
a `PangoLayout`
location to store the logical width
location to store the logical height
Returns the current serial number of @layout.
The serial number is initialized to an small number larger than zero
when a new layout is created and is increased whenever the layout is
changed using any of the setter functions, or the `PangoContext` it
uses has changed. The serial may wrap, but will never have the value 0.
Since it can wrap, never compare it with "less than", always use "not equals".
This can be used to automatically detect changes to a `PangoLayout`,
and is useful for example to decide whether a layout needs redrawing.
To force the serial to be increased, use
[method@Pango.Layout.context_changed].
The current serial number of @layout.
a `PangoLayout`
Obtains whether @layout is in single paragraph mode.
See [method@Pango.Layout.set_single_paragraph_mode].
%TRUE if the layout does not break paragraphs
at paragraph separator characters, %FALSE otherwise
a `PangoLayout`
Determines the logical width and height of a `PangoLayout` in Pango
units.
This is simply a convenience function around [method@Pango.Layout.get_extents].
a `PangoLayout`
location to store the logical width
location to store the logical height
Gets the amount of spacing between the lines of the layout.
the spacing in Pango units
a `PangoLayout`
Gets the current `PangoTabArray` used by this layout.
If no `PangoTabArray` has been set, then the default tabs are
in use and %NULL is returned. Default tabs are every 8 spaces.
The return value should be freed with [method@Pango.TabArray.free].
a copy of the tabs for this layout
a `PangoLayout`
Gets the text in the layout.
The returned text should not be freed or modified.
the text in the @layout
a `PangoLayout`
Counts the number of unknown glyphs in @layout.
This function can be used to determine if there are any fonts
available to render all characters in a certain string, or when
used in combination with %PANGO_ATTR_FALLBACK, to check if a
certain font supports all the characters in the string.
The number of unknown glyphs in @layout
a `PangoLayout`
Gets the width to which the lines of the `PangoLayout` should wrap.
the width in Pango units, or -1 if no width set.
a `PangoLayout`
Gets the wrap mode for the layout.
Use [method@Pango.Layout.is_wrapped] to query whether
any paragraphs were actually wrapped.
active wrap mode.
a `PangoLayout`
Converts from byte @index_ within the @layout to line and X position.
The X position is measured from the left edge of the line.
a `PangoLayout`
the byte index of a grapheme within the layout
an integer indicating the edge of the grapheme to retrieve the
position of. If > 0, the trailing edge of the grapheme, if 0,
the leading of the grapheme
location to store resulting line index. (which will
between 0 and pango_layout_get_line_count(layout) - 1)
location to store resulting position within line
(%PANGO_SCALE units per device unit)
Converts from an index within a `PangoLayout` to the onscreen position
corresponding to the grapheme at that index.
The return value is represented as rectangle. Note that `pos->x` is
always the leading edge of the grapheme and `pos->x + pos->width` the
trailing edge of the grapheme. If the directionality of the grapheme
is right-to-left, then `pos->width` will be negative.
a `PangoLayout`
byte index within @layout
rectangle in which to store the position of the grapheme
Queries whether the layout had to ellipsize any paragraphs.
This returns %TRUE if the ellipsization mode for @layout
is not %PANGO_ELLIPSIZE_NONE, a positive width is set on @layout,
and there are paragraphs exceeding that width that have to be
ellipsized.
%TRUE if any paragraphs had to be ellipsized,
%FALSE otherwise
a `PangoLayout`
Queries whether the layout had to wrap any paragraphs.
This returns %TRUE if a positive width is set on @layout,
ellipsization mode of @layout is set to %PANGO_ELLIPSIZE_NONE,
and there are paragraphs exceeding the layout width that have
to be wrapped.
%TRUE if any paragraphs had to be wrapped, %FALSE
otherwise
a `PangoLayout`
Computes a new cursor position from an old position and a direction.
If @direction is positive, then the new position will cause the strong
or weak cursor to be displayed one position to right of where it was
with the old cursor position. If @direction is negative, it will be
moved to the left.
In the presence of bidirectional 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 this function may move the cursor over multiple characters
when multiple characters combine to form a single grapheme.
a `PangoLayout`
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.
the byte index of the current cursor position
if 0, the cursor was at the leading edge of the
grapheme indicated by @old_index, if > 0, the cursor
was at the trailing edge.
direction to move cursor. A negative
value indicates motion to the left
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.
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.
Serializes the @layout for later deserialization via [func@Pango.Layout.deserialize].
There are no guarantees about the format of the output across different
versions of Pango and [func@Pango.Layout.deserialize] will reject data
that it cannot parse.
The intended use of this function is testing, benchmarking and debugging.
The format is not meant as a permanent storage format.
a `GBytes` containing the serialized form of @layout
a `PangoLayout`
`PangoLayoutSerializeFlags`
Sets the alignment for the layout: how partial lines are
positioned within the horizontal space available.
The default alignment is %PANGO_ALIGN_LEFT.
a `PangoLayout`
the alignment
Sets the text attributes for a layout object.
References @attrs, so the caller can unref its reference.
a `PangoLayout`
a `PangoAttrList`
Sets whether to calculate the base direction
for the layout according to its contents.
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 %FALSE, the choice between left-to-right and right-to-left
layout is done according to the base direction of the layout's
`PangoContext`. (See [method@Pango.Context.set_base_dir]).
When the auto-computed direction of a paragraph differs from the
base direction of the context, the interpretation of
%PANGO_ALIGN_LEFT and %PANGO_ALIGN_RIGHT are swapped.
a `PangoLayout`
if %TRUE, compute the bidirectional base direction
from the layout's contents
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 text so they
fit within the width and height of layout set with
[method@Pango.Layout.set_width] and [method@Pango.Layout.set_height].
If the layout contains characters such as newlines that
force it to be layed out in multiple paragraphs, then whether
each paragraph is ellipsized separately or the entire layout
is ellipsized as a whole depends on the set height of the layout.
The default value is %PANGO_ELLIPSIZE_NONE.
See [method@Pango.Layout.set_height] for details.
a `PangoLayout`
the new ellipsization mode for @layout
Sets 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.
a `PangoLayout`
the new `PangoFontDescription`
to unset the current font description
Sets the height to which the `PangoLayout` should be ellipsized at.
There are two different behaviors, based on whether @height is positive
or negative.
If @height is positive, it will be the maximum height of the layout. Only
lines would be shown that would fit, and if there is any text omitted,
an ellipsis added. At least one line is included in each paragraph regardless
of how small the height value is. A value of zero will render exactly one
line for the entire layout.
If @height is negative, it will be the (negative of) maximum number of lines
per paragraph. That is, the total number of lines shown may well be more than
this value if the layout contains multiple paragraphs of text.
The default value of -1 means that the first line of each paragraph is ellipsized.
This behavior may be changed in the future to act per layout instead of per
paragraph. File a bug against pango at
[https://gitlab.gnome.org/gnome/pango](https://gitlab.gnome.org/gnome/pango)
if your code relies on this behavior.
Height setting only has effect if a positive width is set on
@layout and ellipsization mode of @layout is not %PANGO_ELLIPSIZE_NONE.
The behavior is undefined if a height other than -1 is set and
ellipsization mode is set to %PANGO_ELLIPSIZE_NONE, and may change in the
future.
a `PangoLayout`.
the desired height of the layout in Pango units if positive,
or desired number of lines if negative.
Sets the width in Pango units to indent each paragraph.
A negative value of @indent will produce a hanging indentation.
That is, the first line will have the full width, and subsequent
lines will be indented by the absolute value of @indent.
The indent setting is ignored if layout alignment is set to
%PANGO_ALIGN_CENTER.
The default value is 0.
a `PangoLayout`
the amount by which to indent
Sets whether each complete line should be stretched to fill the
entire width of the layout.
Stretching is typically done by adding whitespace, but for some scripts
(such as Arabic), the justification may be done in more complex ways,
like extending the characters.
Note that this setting is not implemented and so is ignored in
Pango older than 1.18.
Note that tabs and justification conflict with each other:
Justification will move content away from its tab-aligned
positions.
The default value is %FALSE.
Also see [method@Pango.Layout.set_justify_last_line].
a `PangoLayout`
whether the lines in the layout should be justified
Sets whether the last line should be stretched to fill the
entire width of the layout.
This only has an effect if [method@Pango.Layout.set_justify] has
been called as well.
The default value is %FALSE.
a `PangoLayout`
whether the last line in the layout should be justified
Sets a factor for line spacing.
Typical values are: 0, 1, 1.5, 2. The default values is 0.
If @factor is non-zero, lines are placed so that
baseline2 = baseline1 + factor * height2
where height2 is the line height of the second line
(as determined by the font(s)). In this case, the spacing
set with [method@Pango.Layout.set_spacing] is ignored.
If @factor is zero (the default), spacing is applied as before.
Note: for semantics that are closer to the CSS line-height
property, see [func@Pango.attr_line_height_new].
a `PangoLayout`
the new line spacing factor
Sets the layout text and attribute list from marked-up text.
See [Pango Markup](pango_markup.html)).
Replaces the current text and attribute list.
This is the same as [method@Pango.Layout.set_markup_with_accel],
but the markup text isn't scanned for accelerators.
a `PangoLayout`
marked-up text
length of marked-up text in bytes, or -1 if @markup is
`NUL`-terminated
Sets the layout text and attribute list from marked-up text.
See [Pango Markup](pango_markup.html)).
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, @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.
a `PangoLayout`
marked-up text (see [Pango Markup](pango_markup.html))
length of marked-up text in bytes, or -1 if @markup is
`NUL`-terminated
marker for accelerators in the text
return location
for first located accelerator
Sets the single paragraph mode of @layout.
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.
The default value is %FALSE.
a `PangoLayout`
new setting
Sets the amount of spacing in Pango units between
the lines of the layout.
When placing lines with spacing, Pango arranges things so that
line2.top = line1.bottom + spacing
The default value is 0.
Note: Since 1.44, Pango is using the line height (as determined
by the font) for placing lines when the line spacing factor is set
to a non-zero value with [method@Pango.Layout.set_line_spacing].
In that case, the @spacing set with this function is ignored.
Note: for semantics that are closer to the CSS line-height
property, see [func@Pango.attr_line_height_new].
a `PangoLayout`
the amount of spacing
Sets the tabs to use for @layout, overriding the default tabs.
`PangoLayout` will place content at the next tab position
whenever it meets a Tab character (U+0009).
By default, tabs are every 8 spaces. If @tabs is %NULL, the
default tabs are reinstated. @tabs is copied into the layout;
you must free your copy of @tabs yourself.
Note that tabs and justification conflict with each other:
Justification will move content away from its tab-aligned
positions. The same is true for alignments other than
%PANGO_ALIGN_LEFT.
a `PangoLayout`
a `PangoTabArray`
Sets the text of the layout.
This function validates @text and renders invalid UTF-8
with a placeholder glyph.
Note that if you have used [method@Pango.Layout.set_markup] or
[method@Pango.Layout.set_markup_with_accel] on @layout before, you
may want to call [method@Pango.Layout.set_attributes] to clear the
attributes set on the layout from the markup as this function does
not clear attributes.
a `PangoLayout`
the text
maximum length of @text, in bytes. -1 indicates that
the string is nul-terminated and the length should be calculated.
The text will also be truncated on encountering a nul-termination
even when @length is positive.
Sets the width to which the lines of the `PangoLayout` should wrap or
ellipsized.
The default value is -1: no width set.
a `PangoLayout`.
the desired width in Pango units, or -1 to indicate that no
wrapping or ellipsization should be performed.
Sets the wrap mode.
The wrap mode only has effect if a width is set on the layout
with [method@Pango.Layout.set_width]. To turn off wrapping,
set the width to -1.
The default value is %PANGO_WRAP_WORD.
a `PangoLayout`
the wrap mode
A convenience method to serialize a layout to a file.
It is equivalent to calling [method@Pango.Layout.serialize]
followed by [func@GLib.file_set_contents].
See those two functions for details on the arguments.
It is mostly intended for use inside a debugger to quickly dump
a layout to a file for later inspection.
%TRUE if saving was successful
a `PangoLayout`
`PangoLayoutSerializeFlags`
the file to save it to
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 [method@Pango.LayoutLine.x_to_index]. If either
the X or Y positions were not inside the layout, then the function returns
%FALSE; on an exact hit, it returns %TRUE.
%TRUE if the coordinates were inside text, %FALSE otherwise
a `PangoLayout`
the X offset (in Pango units) from the left edge of the layout
the Y offset (in Pango units) from the top edge of the layout
location to store calculated byte index
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 leading edge
of the grapheme.
Errors that can be returned by [func@Pango.Layout.deserialize].
Unspecified error
A JSon value could not be
interpreted
A required JSon member was
not found
Flags that influence the behavior of [func@Pango.Layout.deserialize].
New members may be added to this enumeration over time.
Default behavior
Apply context information
from the serialization to the `PangoContext`
A `PangoLayoutIter` can be used to iterate over the visual
extents of a `PangoLayout`.
To obtain a `PangoLayoutIter`, use [method@Pango.Layout.get_iter].
The `PangoLayoutIter` structure is opaque, and has no user-visible fields.
Determines whether @iter is on the last line of the layout.
%TRUE if @iter is on the last line
a `PangoLayoutIter`
Copies a `PangoLayoutIter`.
the newly allocated `PangoLayoutIter`
a `PangoLayoutIter`
Frees an iterator that's no longer in use.
a `PangoLayoutIter`, may be %NULL
Gets the Y position of the current line's baseline, in layout
coordinates.
Layout coordinates have the origin at the top left of the entire layout.
baseline of current line
a `PangoLayoutIter`
Gets the extents of the current character, in layout coordinates.
Layout coordinates have the origin at the top left of the entire layout.
Only logical extents can sensibly be obtained for characters;
ink extents make sense only down to the level of clusters.
a `PangoLayoutIter`
rectangle to fill with
logical extents
Gets the extents of the current cluster, in layout coordinates.
Layout coordinates have the origin at the top left of the entire layout.
a `PangoLayoutIter`
rectangle to fill with ink extents
rectangle to fill with logical extents
Gets the current byte index.
Note that iterating forward by char moves in visual order,
not logical order, so indexes may not be sequential. Also,
the index may be equal to the length of the text in the
layout, if on the %NULL run (see [method@Pango.LayoutIter.get_run]).
current byte index
a `PangoLayoutIter`
Gets the layout associated with a `PangoLayoutIter`.
the layout associated with @iter
a `PangoLayoutIter`
Obtains the extents of the `PangoLayout` being iterated over.
a `PangoLayoutIter`
rectangle to fill with ink extents
rectangle to fill with logical extents
Gets the current line.
Use the faster [method@Pango.LayoutIter.get_line_readonly] if
you do not plan to modify the contents of the line (glyphs,
glyph widths, etc.).
the current line
a `PangoLayoutIter`
Obtains the extents of the current line.
Extents are in layout coordinates (origin is the top-left corner
of the entire `PangoLayout`). Thus the extents returned by this
function will be the same width/height but not at the same x/y
as the extents returned from [method@Pango.LayoutLine.get_extents].
a `PangoLayoutIter`
rectangle to fill with ink extents
rectangle to fill with logical extents
Gets the current line for read-only access.
This is a faster alternative to [method@Pango.LayoutIter.get_line],
but the user is not expected to modify the contents of the line
(glyphs, glyph widths, etc.).
the current line, that should not be
modified
a `PangoLayoutIter`
Divides the vertical space in the `PangoLayout` being iterated over
between the lines in the layout, and returns the space belonging to
the current line.
A line's range includes the line's logical extents. plus half of the
spacing above and below the line, if [method@Pango.Layout.set_spacing]
has been called to set layout spacing. The Y positions are in layout
coordinates (origin at top left of the entire layout).
Note: Since 1.44, Pango uses line heights for placing lines, and there
may be gaps between the ranges returned by this function.
a `PangoLayoutIter`
start of line
end of line
Gets the current run.
When iterating by run, at the end of each line, there's a position
with a %NULL run, so this function can return %NULL. The %NULL run
at the end of each line ensures that all lines have at least one run,
even lines consisting of only a newline.
Use the faster [method@Pango.LayoutIter.get_run_readonly] if you do not
plan to modify the contents of the run (glyphs, glyph widths, etc.).
the current run
a `PangoLayoutIter`
Gets the Y position of the current run's baseline, in layout
coordinates.
Layout coordinates have the origin at the top left of the entire layout.
The run baseline can be different from the line baseline, for
example due to superscript or subscript positioning.
a `PangoLayoutIter`
Gets the extents of the current run in layout coordinates.
Layout coordinates have the origin at the top left of the entire layout.
a `PangoLayoutIter`
rectangle to fill with ink extents
rectangle to fill with logical extents
Gets the current run for read-only access.
When iterating by run, at the end of each line, there's a position
with a %NULL run, so this function can return %NULL. The %NULL run
at the end of each line ensures that all lines have at least one run,
even lines consisting of only a newline.
This is a faster alternative to [method@Pango.LayoutIter.get_run],
but the user is not expected to modify the contents of the run (glyphs,
glyph widths, etc.).
the current run, that
should not be modified
a `PangoLayoutIter`
Moves @iter forward to the next character in visual order.
If @iter was already at the end of the layout, returns %FALSE.
whether motion was possible
a `PangoLayoutIter`
Moves @iter forward to the next cluster in visual order.
If @iter was already at the end of the layout, returns %FALSE.
whether motion was possible
a `PangoLayoutIter`
Moves @iter forward to the start of the next line.
If @iter is already on the last line, returns %FALSE.
whether motion was possible
a `PangoLayoutIter`
Moves @iter forward to the next run in visual order.
If @iter was already at the end of the layout, returns %FALSE.
whether motion was possible
a `PangoLayoutIter`
A `PangoLayoutLine` represents one of the lines resulting from laying
out a paragraph via `PangoLayout`.
`PangoLayoutLine` structures are obtained by calling
[method@Pango.Layout.get_line] and are only valid until the text,
attributes, or settings of the parent `PangoLayout` are modified.
the layout this line belongs to, might be %NULL
start of line as byte index into layout->text
length of line in bytes
list of runs in the
line, from left to right
#TRUE if this is the first line of the paragraph
#Resolved PangoDirection of line
Computes the logical and ink extents of a layout line.
See [method@Pango.Font.get_glyph_extents] for details
about the interpretation of the rectangles.
a `PangoLayoutLine`
rectangle used to store the extents of
the glyph string as drawn
rectangle used to store the logical
extents of the glyph string
Computes the height of the line, as the maximum of the heights
of fonts used in this line.
Note that the actual baseline-to-baseline distance between lines
of text is influenced by other factors, such as
[method@Pango.Layout.set_spacing] and
[method@Pango.Layout.set_line_spacing].
a `PangoLayoutLine`
return location for the line height
Returns the length of the line, in bytes.
the length of the line
a `PangoLayoutLine`
Computes the logical and ink extents of @layout_line in device units.
This function just calls [method@Pango.LayoutLine.get_extents] followed by
two [func@extents_to_pixels] calls, rounding @ink_rect and @logical_rect
such that the rounded rectangles fully contain the unrounded one (that is,
passes them as first argument to [func@extents_to_pixels]).
a `PangoLayoutLine`
rectangle used to store the extents of
the glyph string as drawn
rectangle used to store the logical
extents of the glyph string
Returns the resolved direction of the line.
the resolved direction of the line
a `PangoLayoutLine`
Returns the start index of the line, as byte index
into the text of the layout.
the start index of the line
a `PangoLayoutLine`
Gets a list of visual ranges corresponding to a given logical range.
This list is not necessarily minimal - there may be consecutive
ranges which are adjacent. The ranges will be sorted from left to
right. The ranges are with respect to the left edge of the entire
layout, not with respect to the line.
a `PangoLayoutLine`
Start byte index of the logical range. If this value
is less than the start index for the line, then the first range
will extend all the way to the leading edge of the layout. Otherwise,
it will start at the leading edge of the first character.
Ending byte index of the logical range. If this value is
greater than the end index for the line, then the last range will
extend all the way to the trailing edge of the layout. Otherwise,
it will end at the trailing edge of the last character.
location to
store a pointer to an array of ranges. The array will be of length
`2*n_ranges`, with each range starting at `(*ranges)[2*n]` and of
width `(*ranges)[2*n + 1] - (*ranges)[2*n]`. This array must be freed
with g_free(). The coordinates are relative to the layout and are in
Pango units.
The number of ranges stored in @ranges
Converts an index within a line to a X position.
a `PangoLayoutLine`
byte offset of a grapheme within the layout
an integer indicating the edge of the grapheme to retrieve
the position of. If > 0, the trailing edge of the grapheme,
if 0, the leading of the grapheme
location to store the x_offset (in Pango units)
Returns whether this is the first line of the paragraph.
%TRUE if this is the first line
a `PangoLayoutLine`
Increase the reference count of a `PangoLayoutLine` by one.
the line passed in.
a `PangoLayoutLine`
Decrease the reference count of a `PangoLayoutLine` by one.
If the result is zero, the line and all associated memory
will be freed.
a `PangoLayoutLine`
Converts from x offset to the byte index of the corresponding character
within the text of the layout.
If @x_pos is outside the line, @index_ and @trailing will point to the very
first or very last position in the line. This determination is based on the
resolved direction of the paragraph; for example, if the resolved direction
is right-to-left, then an X position to the right of the line (after it)
results in 0 being stored in @index_ and @trailing. An X position to the
left of the line results in @index_ pointing to the (logical) last grapheme
in the line and @trailing being set to the number of characters in that
grapheme. The reverse is true for a left-to-right line.
%FALSE if @x_pos was outside the line, %TRUE if inside
a `PangoLayoutLine`
the X offset (in Pango units) from the left edge of the line.
location to store calculated byte index for the grapheme
in which the user clicked
location to store an 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 leading edge of the grapheme.
Flags that influence the behavior of [method@Pango.Layout.serialize].
New members may be added to this enumeration over time.
Default behavior
Include context information
Include information about the formatted output
The `PangoLogAttr` structure stores information about the attributes of a
single character.
if set, can break line in front of character
if set, must break line in front of character
if set, can break here when doing character wrapping
is whitespace character
if set, cursor can appear in front of character.
i.e. this is a grapheme boundary, or the first character in the text.
This flag implements Unicode's
[Grapheme Cluster Boundaries](http://www.unicode.org/reports/tr29/)
semantics.
is first character in a word
is first non-word char after a word
Note that in degenerate cases, you could have both @is_word_start
and @is_word_end set for some character.
is a sentence boundary.
There are two ways to divide sentences. The first assigns all
inter-sentence whitespace/control/format chars to some sentence,
so all chars are in some sentence; @is_sentence_boundary denotes
the boundaries there. The second way doesn't assign
between-sentence spaces, etc. to any sentence, so
@is_sentence_start/@is_sentence_end mark the boundaries of those sentences.
is first character in a sentence
is first char after a sentence.
Note that in degenerate cases, you could have both @is_sentence_start
and @is_sentence_end set for some character. (e.g. no space after a
period, so the next sentence starts right away)
if set, backspace deletes one character
rather than the entire grapheme cluster. This field is only meaningful
on grapheme boundaries (where @is_cursor_position is set). In some languages,
the full grapheme (e.g. letter + diacritics) is considered a unit, while in
others, each decomposed character in the grapheme is a unit. In the default
implementation of [func@break], this bit is set on all grapheme boundaries
except those following Latin, Cyrillic or Greek base characters.
is a whitespace character that can possibly be
expanded for justification purposes. (Since: 1.18)
is a word boundary, as defined by UAX#29.
More specifically, means that this is not a position in the middle of a word.
For example, both sides of a punctuation mark are considered word boundaries.
This flag is particularly useful when selecting text word-by-word. This flag
implements Unicode's [Word Boundaries](http://www.unicode.org/reports/tr29/)
semantics. (Since: 1.22)
when breaking lines before this char, insert a hyphen.
Since: 1.50
when breaking lines before this char, remove the
preceding char. Since 1.50
A `PangoMatrix` specifies a transformation between user-space
and device coordinates.
The transformation is given by
```
x_device = x_user * matrix->xx + y_user * matrix->xy + matrix->x0;
y_device = x_user * matrix->yx + y_user * matrix->yy + matrix->y0;
```
1st component of the transformation matrix
2nd component of the transformation matrix
3rd component of the transformation matrix
4th component of the transformation matrix
x translation
y translation
Changes the transformation represented by @matrix to be the
transformation given by first applying transformation
given by @new_matrix then applying the original transformation.
a `PangoMatrix`
a `PangoMatrix`
Copies a `PangoMatrix`.
the newly allocated `PangoMatrix`
a `PangoMatrix`
Free a `PangoMatrix`.
a `PangoMatrix`, may be %NULL
Returns the scale factor of a matrix on the height of the font.
That is, the scale factor in the direction perpendicular to the
vector that the X coordinate is mapped to. If the scale in the X
coordinate is needed as well, use [method@Pango.Matrix.get_font_scale_factors].
the scale factor of @matrix on the height of the font,
or 1.0 if @matrix is %NULL.
a `PangoMatrix`, may be %NULL
Calculates the scale factor of a matrix on the width and height of the font.
That is, @xscale is the scale factor in the direction of the X coordinate,
and @yscale is the scale factor in the direction perpendicular to the
vector that the X coordinate is mapped to.
Note that output numbers will always be non-negative.
a `PangoMatrix`
output scale factor in the x direction
output scale factor perpendicular to the x direction
Gets the slant ratio of a matrix.
For a simple shear matrix in the form:
1 λ
0 1
this is simply λ.
the slant ratio of @matrix
a `PangoMatrix`
Changes the transformation represented by @matrix to be the
transformation given by first rotating by @degrees degrees
counter-clockwise then applying the original transformation.
a `PangoMatrix`
degrees to rotate counter-clockwise
Changes the transformation represented by @matrix to be the
transformation given by first scaling by @sx in the X direction
and @sy in the Y direction then applying the original
transformation.
a `PangoMatrix`
amount to scale by in X direction
amount to scale by in Y direction
Transforms the distance vector (@dx,@dy) by @matrix.
This is similar to [method@Pango.Matrix.transform_point],
except that the translation components of the transformation
are ignored. The calculation of the returned vector is as follows:
```
dx2 = dx1 * xx + dy1 * xy;
dy2 = dx1 * yx + dy1 * yy;
```
Affine transformations are position invariant, so the same vector
always transforms to the same vector. If (@x1,@y1) transforms
to (@x2,@y2) then (@x1+@dx1,@y1+@dy1) will transform to
(@x1+@dx2,@y1+@dy2) for all values of @x1 and @x2.
a `PangoMatrix`
in/out X component of a distance vector
in/out Y component of a distance vector
First transforms the @rect using @matrix, then calculates the bounding box
of the transformed rectangle.
This function is useful for example when you want to draw a rotated
@PangoLayout to an image buffer, and want to know how large the image
should be and how much you should shift the layout when rendering.
For better accuracy, you should use [method@Pango.Matrix.transform_rectangle]
on original rectangle in Pango units and convert to pixels afterward
using [func@extents_to_pixels]'s first argument.
a `PangoMatrix`
in/out bounding box in device units
Transforms the point (@x, @y) by @matrix.
a `PangoMatrix`
in/out X position
in/out Y position
First transforms @rect using @matrix, then calculates the bounding box
of the transformed rectangle.
This function is useful for example when you want to draw a rotated
@PangoLayout to an image buffer, and want to know how large the image
should be and how much you should shift the layout when rendering.
If you have a rectangle in device units (pixels), use
[method@Pango.Matrix.transform_pixel_rectangle].
If you have the rectangle in Pango units and want to convert to
transformed pixel bounding box, it is more accurate to transform it first
(using this function) and pass the result to pango_extents_to_pixels(),
first argument, for an inclusive rounded rectangle.
However, there are valid reasons that you may want to convert
to pixels first and then transform, for example when the transformed
coordinates may overflow in Pango units (large matrix translation for
example).
a `PangoMatrix`
in/out bounding box in Pango units
Changes the transformation represented by @matrix to be the
transformation given by first translating by (@tx, @ty)
then applying the original transformation.
a `PangoMatrix`
amount to translate in the X direction
amount to translate in the Y direction
The `PangoOverline` enumeration is used to specify whether text
should be overlined, and if so, the type of line.
no overline should be drawn
Draw a single line above the ink
extents of the text being underlined.
Converts a dimension to device units by rounding.
a dimension in Pango units.
Converts a dimension to device units by ceiling.
a dimension in Pango units.
Converts a dimension to device units by flooring.
a dimension in Pango units.
Extracts the *right bearing* from a `PangoRectangle`
representing glyph extents.
The right bearing is the distance from the horizontal
origin to the farthest right point of the character.
This is positive except for characters drawn completely
to the left of the horizontal origin.
a `PangoRectangle`
The `PangoRectangle` structure represents a rectangle.
`PangoRectangle` is frequently used to represent the logical or ink
extents of a single glyph or section of text. (See, for instance,
[method@Pango.Font.get_glyph_extents].)
X coordinate of the left side of the rectangle.
Y coordinate of the the top side of the rectangle.
width of the rectangle.
height of the rectangle.
`PangoRenderPart` defines different items to render for such
purposes as setting colors.
the text itself
the area behind the text
underlines
strikethrough lines
overlines
`PangoRenderer` is a base class for objects that can render text
provided as `PangoGlyphString` or `PangoLayout`.
By subclassing `PangoRenderer` and overriding operations such as
@draw_glyphs and @draw_rectangle, renderers for particular font
backends and destinations can be created.
Draw a squiggly line that approximately covers the given rectangle
in the style of an underline used to indicate a spelling error.
The width of the underline is rounded to an integer number
of up/down segments and the resulting rectangle is centered
in the original rectangle.
This should be called while @renderer is already active.
Use [method@Pango.Renderer.activate] to activate a renderer.
a `PangoRenderer`
X coordinate of underline, in Pango units in user coordinate system
Y coordinate of underline, in Pango units in user coordinate system
width of underline, in Pango units in user coordinate system
height of underline, in Pango units in user coordinate system
Draws a single glyph with coordinates in device space.
a `PangoRenderer`
a `PangoFont`
the glyph index of a single glyph
X coordinate of left edge of baseline of glyph
Y coordinate of left edge of baseline of glyph
Draws the glyphs in @glyph_item with the specified `PangoRenderer`,
embedding the text associated with the glyphs in the output if the
output format supports it.
This is useful for rendering text in PDF.
Note that this method does not handle attributes in @glyph_item.
If you want colors, shapes and lines handled automatically according
to those attributes, you need to use pango_renderer_draw_layout_line()
or pango_renderer_draw_layout().
Note that @text is the start of the text for layout, which is then
indexed by `glyph_item->item->offset`.
If @text is %NULL, this simply calls [method@Pango.Renderer.draw_glyphs].
The default implementation of this method simply falls back to
[method@Pango.Renderer.draw_glyphs].
a `PangoRenderer`
the UTF-8 text that @glyph_item refers to
a `PangoGlyphItem`
X position of left edge of baseline, in user space coordinates
in Pango units
Y position of left edge of baseline, in user space coordinates
in Pango units
Draws the glyphs in @glyphs with the specified `PangoRenderer`.
a `PangoRenderer`
a `PangoFont`
a `PangoGlyphString`
X position of left edge of baseline, in user space coordinates
in Pango units.
Y position of left edge of baseline, in user space coordinates
in Pango units.
Draws an axis-aligned rectangle in user space coordinates with the
specified `PangoRenderer`.
This should be called while @renderer is already active.
Use [method@Pango.Renderer.activate] to activate a renderer.
a `PangoRenderer`
type of object this rectangle is part of
X position at which to draw rectangle, in user space coordinates
in Pango units
Y position at which to draw rectangle, in user space coordinates
in Pango units
width of rectangle in Pango units
height of rectangle in Pango units
Draws a trapezoid with the parallel sides aligned with the X axis
using the given `PangoRenderer`; coordinates are in device space.
a `PangoRenderer`
type of object this trapezoid is part of
Y coordinate of top of trapezoid
X coordinate of left end of top of trapezoid
X coordinate of right end of top of trapezoid
Y coordinate of bottom of trapezoid
X coordinate of left end of bottom of trapezoid
X coordinate of right end of bottom of trapezoid
Informs Pango that the way that the rendering is done
for @part has changed.
This should be called if the rendering changes in a way that would
prevent multiple pieces being joined together into one drawing call.
For instance, if a subclass of `PangoRenderer` was to add a stipple
option for drawing underlines, it needs to call
```
pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
```
When the stipple changes or underlines with different stipples
might be joined together. Pango automatically calls this for
changes to colors. (See [method@Pango.Renderer.set_color])
a `PangoRenderer`
the part for which rendering has changed.
Does initial setup before rendering operations on @renderer.
[method@Pango.Renderer.deactivate] should be called when done drawing.
Calls such as [method@Pango.Renderer.draw_layout] automatically
activate the layout before drawing on it.
Calls to [method@Pango.Renderer.activate] and
[method@Pango.Renderer.deactivate] can be nested and the
renderer will only be initialized and deinitialized once.
a `PangoRenderer`
Cleans up after rendering operations on @renderer.
See docs for [method@Pango.Renderer.activate].
a `PangoRenderer`
Draw a squiggly line that approximately covers the given rectangle
in the style of an underline used to indicate a spelling error.
The width of the underline is rounded to an integer number
of up/down segments and the resulting rectangle is centered
in the original rectangle.
This should be called while @renderer is already active.
Use [method@Pango.Renderer.activate] to activate a renderer.
a `PangoRenderer`
X coordinate of underline, in Pango units in user coordinate system
Y coordinate of underline, in Pango units in user coordinate system
width of underline, in Pango units in user coordinate system
height of underline, in Pango units in user coordinate system
Draws a single glyph with coordinates in device space.
a `PangoRenderer`
a `PangoFont`
the glyph index of a single glyph
X coordinate of left edge of baseline of glyph
Y coordinate of left edge of baseline of glyph
Draws the glyphs in @glyph_item with the specified `PangoRenderer`,
embedding the text associated with the glyphs in the output if the
output format supports it.
This is useful for rendering text in PDF.
Note that this method does not handle attributes in @glyph_item.
If you want colors, shapes and lines handled automatically according
to those attributes, you need to use pango_renderer_draw_layout_line()
or pango_renderer_draw_layout().
Note that @text is the start of the text for layout, which is then
indexed by `glyph_item->item->offset`.
If @text is %NULL, this simply calls [method@Pango.Renderer.draw_glyphs].
The default implementation of this method simply falls back to
[method@Pango.Renderer.draw_glyphs].
a `PangoRenderer`
the UTF-8 text that @glyph_item refers to
a `PangoGlyphItem`
X position of left edge of baseline, in user space coordinates
in Pango units
Y position of left edge of baseline, in user space coordinates
in Pango units
Draws the glyphs in @glyphs with the specified `PangoRenderer`.
a `PangoRenderer`
a `PangoFont`
a `PangoGlyphString`
X position of left edge of baseline, in user space coordinates
in Pango units.
Y position of left edge of baseline, in user space coordinates
in Pango units.
Draws @layout with the specified `PangoRenderer`.
This is equivalent to drawing the lines of the layout, at their
respective positions relative to @x, @y.
a `PangoRenderer`
a `PangoLayout`
X position of left edge of baseline, in user space coordinates
in Pango units.
Y position of left edge of baseline, in user space coordinates
in Pango units.
Draws @line with the specified `PangoRenderer`.
This draws the glyph items that make up the line, as well as
shapes, backgrounds and lines that are specified by the attributes
of those items.
a `PangoRenderer`
a `PangoLayoutLine`
X position of left edge of baseline, in user space coordinates
in Pango units.
Y position of left edge of baseline, in user space coordinates
in Pango units.
Draws an axis-aligned rectangle in user space coordinates with the
specified `PangoRenderer`.
This should be called while @renderer is already active.
Use [method@Pango.Renderer.activate] to activate a renderer.
a `PangoRenderer`
type of object this rectangle is part of
X position at which to draw rectangle, in user space coordinates
in Pango units
Y position at which to draw rectangle, in user space coordinates
in Pango units
width of rectangle in Pango units
height of rectangle in Pango units
Draws a trapezoid with the parallel sides aligned with the X axis
using the given `PangoRenderer`; coordinates are in device space.
a `PangoRenderer`
type of object this trapezoid is part of
Y coordinate of top of trapezoid
X coordinate of left end of top of trapezoid
X coordinate of right end of top of trapezoid
Y coordinate of bottom of trapezoid
X coordinate of left end of bottom of trapezoid
X coordinate of right end of bottom of trapezoid
Gets the current alpha for the specified part.
the alpha for the specified part,
or 0 if it hasn't been set and should be
inherited from the environment.
a `PangoRenderer`
the part to get the alpha for
Gets the current rendering color for the specified part.
the color for the
specified part, or %NULL if it hasn't been set and should be
inherited from the environment.
a `PangoRenderer`
the part to get the color for
Gets the layout currently being rendered using @renderer.
Calling this function only makes sense from inside a subclass's
methods, like in its draw_shape vfunc, for example.
The returned layout should not be modified while still being
rendered.
the layout, or %NULL if
no layout is being rendered using @renderer at this time.
a `PangoRenderer`
Gets the layout line currently being rendered using @renderer.
Calling this function only makes sense from inside a subclass's
methods, like in its draw_shape vfunc, for example.
The returned layout line should not be modified while still being
rendered.
the layout line, or %NULL
if no layout line is being rendered using @renderer at this time.
a `PangoRenderer`
Gets the transformation matrix that will be applied when
rendering.
See [method@Pango.Renderer.set_matrix].
the matrix, or %NULL if no matrix has
been set (which is the same as the identity matrix). The returned
matrix is owned by Pango and must not be modified or freed.
a `PangoRenderer`
Informs Pango that the way that the rendering is done
for @part has changed.
This should be called if the rendering changes in a way that would
prevent multiple pieces being joined together into one drawing call.
For instance, if a subclass of `PangoRenderer` was to add a stipple
option for drawing underlines, it needs to call
```
pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
```
When the stipple changes or underlines with different stipples
might be joined together. Pango automatically calls this for
changes to colors. (See [method@Pango.Renderer.set_color])
a `PangoRenderer`
the part for which rendering has changed.
Sets the alpha for part of the rendering.
Note that the alpha may only be used if a color is
specified for @part as well.
a `PangoRenderer`
the part to set the alpha for
an alpha value between 1 and 65536, or 0 to unset the alpha
Sets the color for part of the rendering.
Also see [method@Pango.Renderer.set_alpha].
a `PangoRenderer`
the part to change the color of
the new color or %NULL to unset the current color
Sets the transformation matrix that will be applied when rendering.
a `PangoRenderer`
a `PangoMatrix`, or %NULL to unset any existing matrix
(No matrix set is the same as setting the identity matrix.)
the current transformation matrix for
the Renderer; may be %NULL, which should be treated the
same as the identity matrix.
Class structure for `PangoRenderer`.
The following vfuncs take user space coordinates in Pango units
and have default implementations:
- draw_glyphs
- draw_rectangle
- draw_error_underline
- draw_shape
- draw_glyph_item
The default draw_shape implementation draws nothing.
The following vfuncs take device space coordinates as doubles
and must be implemented:
- draw_trapezoid
- draw_glyph
a `PangoRenderer`
a `PangoFont`
a `PangoGlyphString`
X position of left edge of baseline, in user space coordinates
in Pango units.
Y position of left edge of baseline, in user space coordinates
in Pango units.
a `PangoRenderer`
type of object this rectangle is part of
X position at which to draw rectangle, in user space coordinates
in Pango units
Y position at which to draw rectangle, in user space coordinates
in Pango units
width of rectangle in Pango units
height of rectangle in Pango units
a `PangoRenderer`
X coordinate of underline, in Pango units in user coordinate system
Y coordinate of underline, in Pango units in user coordinate system
width of underline, in Pango units in user coordinate system
height of underline, in Pango units in user coordinate system
a `PangoRenderer`
type of object this trapezoid is part of
Y coordinate of top of trapezoid
X coordinate of left end of top of trapezoid
X coordinate of right end of top of trapezoid
Y coordinate of bottom of trapezoid
X coordinate of left end of bottom of trapezoid
X coordinate of right end of bottom of trapezoid
a `PangoRenderer`
a `PangoFont`
the glyph index of a single glyph
X coordinate of left edge of baseline of glyph
Y coordinate of left edge of baseline of glyph
a `PangoRenderer`
the part for which rendering has changed.
a `PangoRenderer`
the UTF-8 text that @glyph_item refers to
a `PangoGlyphItem`
X position of left edge of baseline, in user space coordinates
in Pango units
Y position of left edge of baseline, in user space coordinates
in Pango units
The scale between dimensions used for Pango distances and device units.
The definition of device units is dependent on the output device; it will
typically be pixels for a screen, and points for a printer. %PANGO_SCALE is
currently 1024, but this may be changed in the future.
When setting font sizes, device units are always considered to be
points (as in "12 point font"), rather than pixels.
The `PangoScript` enumeration identifies different writing
systems.
The values correspond to the names as defined in the Unicode standard. See
[Unicode Standard Annex 24: Script names](http://www.unicode.org/reports/tr24/)
Note that this enumeration is deprecated and will not be updated to include values
in newer versions of the Unicode standard. Applications should use the
[enum@GLib.UnicodeScript] enumeration instead,
whose values are interchangeable with `PangoScript`.
a value never returned from pango_script_for_unichar()
a character used by multiple different scripts
a mark glyph that takes its script from the
base glyph to which it is attached
Arabic
Armenian
Bengali
Bopomofo
Cherokee
Coptic
Cyrillic
Deseret
Devanagari
Ethiopic
Georgian
Gothic
Greek
Gujarati
Gurmukhi
Han
Hangul
Hebrew
Hiragana
Kannada
Katakana
Khmer
Lao
Latin
Malayalam
Mongolian
Myanmar
Ogham
Old Italic
Oriya
Runic
Sinhala
Syriac
Tamil
Telugu
Thaana
Thai
Tibetan
Canadian Aboriginal
Yi
Tagalog
Hanunoo
Buhid
Tagbanwa
Braille
Cypriot
Limbu
Osmanya
Shavian
Linear B
Tai Le
Ugaritic
New Tai Lue. Since 1.10
Buginese. Since 1.10
Glagolitic. Since 1.10
Tifinagh. Since 1.10
Syloti Nagri. Since 1.10
Old Persian. Since 1.10
Kharoshthi. Since 1.10
an unassigned code point. Since 1.14
Balinese. Since 1.14
Cuneiform. Since 1.14
Phoenician. Since 1.14
Phags-pa. Since 1.14
N'Ko. Since 1.14
Kayah Li. Since 1.20.1
Lepcha. Since 1.20.1
Rejang. Since 1.20.1
Sundanese. Since 1.20.1
Saurashtra. Since 1.20.1
Cham. Since 1.20.1
Ol Chiki. Since 1.20.1
Vai. Since 1.20.1
Carian. Since 1.20.1
Lycian. Since 1.20.1
Lydian. Since 1.20.1
Batak. Since 1.32
Brahmi. Since 1.32
Mandaic. Since 1.32
Chakma. Since: 1.32
Meroitic Cursive. Since: 1.32
Meroitic Hieroglyphs. Since: 1.32
Miao. Since: 1.32
Sharada. Since: 1.32
Sora Sompeng. Since: 1.32
Takri. Since: 1.32
Bassa. Since: 1.40
Caucasian Albanian. Since: 1.40
Duployan. Since: 1.40
Elbasan. Since: 1.40
Grantha. Since: 1.40
Kjohki. Since: 1.40
Khudawadi, Sindhi. Since: 1.40
Linear A. Since: 1.40
Mahajani. Since: 1.40
Manichaean. Since: 1.40
Mende Kikakui. Since: 1.40
Modi. Since: 1.40
Mro. Since: 1.40
Nabataean. Since: 1.40
Old North Arabian. Since: 1.40
Old Permic. Since: 1.40
Pahawh Hmong. Since: 1.40
Palmyrene. Since: 1.40
Pau Cin Hau. Since: 1.40
Psalter Pahlavi. Since: 1.40
Siddham. Since: 1.40
Tirhuta. Since: 1.40
Warang Citi. Since: 1.40
Ahom. Since: 1.40
Anatolian Hieroglyphs. Since: 1.40
Hatran. Since: 1.40
Multani. Since: 1.40
Old Hungarian. Since: 1.40
Signwriting. Since: 1.40
Looks up the script for a particular character.
The script of a character is defined by
[Unicode Standard Annex 24: Script names](http://www.unicode.org/reports/tr24/).
No check is made for @ch being a valid Unicode character; if you pass
in invalid character, the result is undefined.
Note that while the return type of this function is declared
as `PangoScript`, as of Pango 1.18, this function simply returns
the return value of [func@GLib.unichar_get_script]. Callers must be
prepared to handle unknown values.
Use g_unichar_get_script()
the `PangoScript` for the character.
a Unicode character
Finds a language tag that is reasonably representative of @script.
The language will usually be the most widely spoken or used language
written in that script: for instance, the sample language for
%PANGO_SCRIPT_CYRILLIC is ru (Russian), the sample language for
%PANGO_SCRIPT_ARABIC is ar.
For some scripts, no sample language will be returned because
there is no language that is sufficiently representative. The
best example of this is %PANGO_SCRIPT_HAN, where various different
variants of written Chinese, Japanese, and Korean all use
significantly different sets of Han characters and forms
of shared characters. No sample language can be provided
for many historical scripts as well.
As of 1.18, this function checks the environment variables
`PANGO_LANGUAGE` and `LANGUAGE` (checked in that order) first.
If one of them is set, it is parsed as a list of language tags
separated by colons or other separators. This function
will return the first language in the parsed list that Pango
believes may use @script for writing. This last predicate
is tested using [method@Pango.Language.includes_script]. This can
be used to control Pango's font selection for non-primary
languages. For example, a `PANGO_LANGUAGE` enviroment variable
set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
instead of Arabic (ar) when a segment of Arabic text is found
in an otherwise non-Arabic text. The same trick can be used to
choose a default language for %PANGO_SCRIPT_HAN when setting
context language is not feasible.
a `PangoLanguage` that is representative
of the script
a `PangoScript`
A `PangoScriptIter` is used to iterate through a string
and identify ranges in different scripts.
Create a new `PangoScriptIter`, used to break a string of
Unicode text into runs by Unicode script.
No copy is made of @text, so the caller needs to make
sure it remains valid until the iterator is freed with
[method@Pango.ScriptIter.free].
the new script iterator, initialized
to point at the first range in the text, which should be
freed with [method@Pango.ScriptIter.free]. If the string is
empty, it will point at an empty range.
a UTF-8 string
length of @text, or -1 if @text is nul-terminated
Frees a `PangoScriptIter`.
a `PangoScriptIter`
Gets information about the range to which @iter currently points.
The range is the set of locations p where *start <= p < *end.
(That is, it doesn't include the character stored at *end)
Note that while the type of the @script argument is declared
as `PangoScript`, as of Pango 1.18, this function simply returns
`GUnicodeScript` values. Callers must be prepared to handle unknown
values.
a `PangoScriptIter`
location to store start position of the range
location to store end position of the range
location to store script for range
Advances a `PangoScriptIter` to the next range.
If @iter is already at the end, it is left unchanged
and %FALSE is returned.
%TRUE if @iter was successfully advanced
a `PangoScriptIter`
Flags influencing the shaping process.
`PangoShapeFlags` can be passed to [func@Pango.shape_with_flags].
Default value
Round glyph positions and widths to whole device units
This option should be set if the target renderer can't do subpixel positioning of glyphs
These flags affect how Pango treats characters that are normally
not visible in the output.
No special treatment for invisible characters
Render spaces, tabs and newlines visibly
Render line breaks visibly
Render default-ignorable Unicode
characters visibly
An enumeration specifying the width of the font relative to other designs
within a family.
ultra condensed width
extra condensed width
condensed width
semi condensed width
the normal width
semi expanded width
expanded width
extra expanded width
ultra expanded width
An enumeration specifying the various slant styles possible for a font.
the font is upright.
the font is slanted, but in a roman style.
the font is slanted in an italic style.
`PangoTabAlign` specifies where the text appears relative to the tab stop
position.
the text appears to the right of the tab stop position
the text appears to the left of the tab stop position
until the available space is filled. Since: 1.50
the text is centered at the tab stop position
until the available space is filled. Since: 1.50
text before the first occurrence of the decimal point
character appears to the left of the tab stop position (until the available
space is filled), the rest to the right. Since: 1.50
A `PangoTabArray` contains an array of tab stops.
`PangoTabArray` can be used to set tab stops in a `PangoLayout`.
Each tab stop has an alignment, a position, and optionally
a character to use as decimal point.
Creates an array of @initial_size tab stops.
Tab stops are specified in pixel units if @positions_in_pixels is %TRUE,
otherwise in Pango units. All stops are initially at position 0.
the newly allocated `PangoTabArray`, which should
be freed with [method@Pango.TabArray.free].
Initial number of tab stops to allocate, can be 0
whether positions are in pixel units
Creates a `PangoTabArray` and allows you to specify the alignment
and position of each tab stop.
You **must** provide an alignment and position for @size tab stops.
the newly allocated `PangoTabArray`, which should
be freed with [method@Pango.TabArray.free].
number of tab stops in the array
whether positions are in pixel units
alignment of first tab stop
position of first tab stop
additional alignment/position pairs
Copies a `PangoTabArray`.
the newly allocated `PangoTabArray`, which should
be freed with [method@Pango.TabArray.free].
`PangoTabArray` to copy
Frees a tab array and associated resources.
a `PangoTabArray`
Gets the Unicode character to use as decimal point.
This is only relevant for tabs with %PANGO_TAB_DECIMAL alignment,
which align content at the first occurrence of the decimal point
character.
The default value of 0 means that Pango will use the
decimal point according to the current locale.
a `PangoTabArray`
the index of a tab stop
Returns %TRUE if the tab positions are in pixels,
%FALSE if they are in Pango units.
whether positions are in pixels.
a `PangoTabArray`
Gets the number of tab stops in @tab_array.
the number of tab stops in the array.
a `PangoTabArray`
Gets the alignment and position of a tab stop.
a `PangoTabArray`
tab stop index
location to store alignment
location to store tab position
If non-%NULL, @alignments and @locations are filled with allocated
arrays.
The arrays are of length [method@Pango.TabArray.get_size].
You must free the returned array.
a `PangoTabArray`
location to store an array of tab
stop alignments
location to store an array
of tab positions
Resizes a tab array.
You must subsequently initialize any tabs
that were added as a result of growing the array.
a `PangoTabArray`
new size of the array
Sets the Unicode character to use as decimal point.
This is only relevant for tabs with %PANGO_TAB_DECIMAL alignment,
which align content at the first occurrence of the decimal point
character.
By default, Pango uses the decimal point according
to the current locale.
a `PangoTabArray`
the index of a tab stop
the decimal point to use
Sets whether positions in this array are specified in
pixels.
a `PangoTabArray`
whether positions are in pixels
Sets the alignment and location of a tab stop.
a `PangoTabArray`
the index of a tab stop
tab alignment
tab location in Pango units
Utility function to ensure that the tab stops are in increasing order.
a `PangoTabArray`
Serializes a `PangoTabArray` to a string.
No guarantees are made about the format of the string,
it may change between Pango versions.
The intended use of this function is testing and
debugging. The format is not meant as a permanent
storage format.
a newly allocated string
a `PangoTabArray`
Deserializes a `PangoTabArray` from a string.
This is the counterpart to [method@Pango.TabArray.to_string].
See that functions for details about the format.
a new `PangoTabArray`
a string
An enumeration that affects how Pango treats characters during shaping.
Leave text unchanged
Display letters and numbers as lowercase
Display letters and numbers as uppercase
Display the first character of a word
in titlecase
Rounds a dimension up to whole device units, but does not
convert it to device units.
a dimension in Pango units.
Rounds a dimension down to whole device units, but does not
convert it to device units.
a dimension in Pango units.
Rounds a dimension to whole device units, but does not
convert it to device units.
a dimension in Pango units.
The `PangoUnderline` enumeration is used to specify whether text
should be underlined, and if so, the type of underlining.
no underline should be drawn
a single underline should be drawn
a double underline should be drawn
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.
an underline indicating an error should
be drawn below. The exact style of rendering is up to the
`PangoRenderer` in use, but typical styles include wavy
or dotted lines.
This underline is typically used to indicate an error such
as a possible mispelling; in some cases a contrasting color
may automatically be used. This type of underlining is
available since Pango 1.4.
Like @PANGO_UNDERLINE_SINGLE, but
drawn continuously across multiple runs. This type
of underlining is available since Pango 1.46.
Like @PANGO_UNDERLINE_DOUBLE, but
drawn continuously across multiple runs. This type
of underlining is available since Pango 1.46.
Like @PANGO_UNDERLINE_ERROR, but
drawn continuously across multiple runs. This type
of underlining is available since Pango 1.46.
Checks that the version of Pango available at compile-time is not older than
the provided version number.
the major component of the version number
the minor component of the version number
the micro component of the version number
This macro encodes the given Pango version into an integer. The numbers
returned by %PANGO_VERSION and pango_version() are encoded using this macro.
Two encoded version numbers can be compared as integers.
the major component of the version number
the minor component of the version number
the micro component of the version number
The major component of the version of Pango available at compile-time.
The micro component of the version of Pango available at compile-time.
The minor component of the version of Pango available at compile-time.
A string literal containing the version of Pango available at compile-time.
An enumeration specifying capitalization variant of the font.
A normal font.
A font with the lower case characters
replaced by smaller variants of the capital characters.
A font with all characters
replaced by smaller variants of the capital characters. Since: 1.50
A font with the lower case characters
replaced by smaller variants of the capital characters.
Petite Caps can be even smaller than Small Caps. Since: 1.50
A font with all characters
replaced by smaller variants of the capital characters.
Petite Caps can be even smaller than Small Caps. Since: 1.50
A font with the upper case characters
replaced by smaller variants of the capital letters. Since: 1.50
A font with capital letters that
are more suitable for all-uppercase titles. Since: 1.50
An enumeration specifying the weight (boldness) of a font.
Weight is specified as a numeric value ranging from 100 to 1000.
This enumeration simply provides some common, predefined values.
the thin weight (= 100) Since: 1.24
the ultralight weight (= 200)
the light weight (= 300)
the semilight weight (= 350) Since: 1.36.7
the book weight (= 380) Since: 1.24)
the default weight (= 400)
the medium weight (= 500) Since: 1.24
the semibold weight (= 600)
the bold weight (= 700)
the ultrabold weight (= 800)
the heavy weight (= 900)
the ultraheavy weight (= 1000) Since: 1.24
`PangoWrapMode` describes how to wrap the lines of a `PangoLayout`
to the desired width.
For @PANGO_WRAP_WORD, Pango uses break opportunities that are determined
by the Unicode line breaking algorithm. For @PANGO_WRAP_CHAR, Pango allows
breaking at grapheme boundaries that are determined by the Unicode text
segmentation algorithm.
wrap lines at word boundaries.
wrap lines at character boundaries.
wrap lines at word boundaries, but fall back to
character boundaries if there is not enough space for a full word.
Create a new allow-breaks attribute.
If breaks are disabled, the range will be kept in a
single run, as far as possible.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
%TRUE if we line breaks are allowed
Create a new background alpha attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the alpha value, between 1 and 65536
Create a new background color attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the red value (ranging from 0 to 65535)
the green value
the blue value
Create a new baseline displacement attribute.
The effect of this attribute is to shift the baseline of a run,
relative to the run of preceding run.
<picture>
<source srcset="baseline-shift-dark.png" media="(prefers-color-scheme: dark)">
<img alt="Baseline Shift" src="baseline-shift-light.png">
</picture>
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
either a `PangoBaselineShift` enumeration value or an absolute value (> 1024)
in Pango units, relative to the baseline of the previous run.
Positive values displace the text upwards.
Apply customization from attributes to the breaks in @attrs.
The line breaks are assumed to have been produced
by [func@Pango.default_break] and [func@Pango.tailor_break].
text to break. Must be valid UTF-8
length of text in bytes (may be -1 if @text is nul-terminated)
`PangoAttrList` to apply
Byte offset of @text from the beginning of the paragraph
array with one `PangoLogAttr`
per character in @text, plus one extra, to be filled in
length of @attrs array
Create a new font fallback attribute.
If fallback is disabled, characters will only be
used from the closest matching font on the system.
No fallback will be done to other fonts on the system
that might contain the characters in the text.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
%TRUE if we should fall back on other fonts
for characters the active font is missing
Create a new font family attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the family or comma-separated list of families
Create a new font description attribute.
This attribute allows setting family, style, weight, variant,
stretch, and size simultaneously.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font description
Create a new font features tag attribute.
You can use this attribute to select OpenType font features like small-caps,
alternative glyphs, ligatures, etc. for fonts that support them.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
a string with OpenType font features, with the syntax of the [CSS
font-feature-settings property](https://www.w3.org/TR/css-fonts-4/#font-rend-desc)
Create a new font scale attribute.
The effect of this attribute is to change the font size of a run,
relative to the size of preceding run.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
a `PangoFontScale` value, which indicates font size change relative
to the size of the previous run.
Create a new foreground alpha attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the alpha value, between 1 and 65536
Create a new foreground color attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the red value (ranging from 0 to 65535)
the green value
the blue value
Create a new gravity hint attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the gravity hint value
Create a new gravity attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the gravity value; should not be %PANGO_GRAVITY_AUTO
Create a new insert-hyphens attribute.
Pango will insert hyphens when breaking lines in
the middle of a word. This attribute can be used
to suppress the hyphen.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
%TRUE if hyphens should be inserted
Create a new language tag attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
language tag
Create a new letter-spacing attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
amount of extra space to add between
graphemes of the text, in Pango units
Modify the height of logical line extents by a factor.
This affects the values returned by
[method@Pango.LayoutLine.get_extents],
[method@Pango.LayoutLine.get_pixel_extents] and
[method@Pango.LayoutIter.get_line_extents].
the scaling factor to apply to the logical height
Override the height of logical line extents to be @height.
This affects the values returned by
[method@Pango.LayoutLine.get_extents],
[method@Pango.LayoutLine.get_pixel_extents] and
[method@Pango.LayoutIter.get_line_extents].
the line height, in %PANGO_SCALE-ths of a point
Deserializes a `PangoAttrList` from a string.
This is the counterpart to [method@Pango.AttrList.to_string].
See that functions for details about the format.
a new `PangoAttrList`
a string
Create a new overline color attribute.
This attribute modifies the color of overlines.
If not set, overlines will use the foreground color.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the red value (ranging from 0 to 65535)
the green value
the blue value
Create a new overline-style attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the overline style
Create a new baseline displacement attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the amount that the text should be displaced vertically,
in Pango units. Positive values displace the text upwards.
Create a new font size scale attribute.
The base font for the affected text will have
its size multiplied by @scale_factor.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
factor to scale the font
Marks the range of the attribute as a single sentence.
Note that this may require adjustments to word and
sentence classification around the range.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
Create a new shape attribute.
A shape is used to impose a particular ink and logical
rectangle on the result of shaping a particular glyph.
This might be used, for instance, for embedding a picture
or a widget inside a `PangoLayout`.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
ink rectangle to assign to each character
logical rectangle to assign to each character
Creates a new shape attribute.
Like [func@Pango.AttrShape.new], but a user data pointer
is also provided; this pointer can be accessed when later
rendering the glyph.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
ink rectangle to assign to each character
logical rectangle to assign to each character
user data pointer
function to copy @data when the
attribute is copied. If %NULL, @data is simply copied
as a pointer
function to free @data when the
attribute is freed
Create a new attribute that influences how invisible
characters are rendered.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
`PangoShowFlags` to apply
Create a new font-size attribute in fractional points.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font size, in %PANGO_SCALE-ths of a point
Create a new font-size attribute in device units.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the font size, in %PANGO_SCALE-ths of a device unit
Create a new font stretch attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the stretch
Create a new strikethrough color attribute.
This attribute modifies the color of strikethrough lines.
If not set, strikethrough lines will use the foreground color.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the red value (ranging from 0 to 65535)
the green value
the blue value
Create a new strike-through attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
%TRUE if the text should be struck-through
Create a new font slant style attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the slant style
Create a new attribute that influences how characters
are transformed during shaping.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
`PangoTextTransform` to apply
Fetches the attribute type name.
The attribute type name is the string passed in
when registering the type using
[func@Pango.AttrType.register].
The returned value is an interned string (see
g_intern_string() for what that means) that should
not be modified or freed.
the type ID name (which
may be %NULL), or %NULL if @type is a built-in Pango
attribute type or invalid.
an attribute type ID to fetch the name for
Allocate a new attribute type ID.
The attribute type name can be accessed later
by using [func@Pango.AttrType.get_name].
the new type ID.
an identifier for the type
Create a new underline color attribute.
This attribute modifies the color of underlines.
If not set, underlines will use the foreground color.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the red value (ranging from 0 to 65535)
the green value
the blue value
Create a new underline-style attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the underline style
Create a new font variant attribute (normal or small caps).
the newly allocated `PangoAttribute`,
which should be freed with [method@Pango.Attribute.destroy].
the variant
Create a new font weight attribute.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
the weight
Marks the range of the attribute as a single word.
Note that this may require adjustments to word and
sentence classification around the range.
the newly allocated
`PangoAttribute`, which should be freed with
[method@Pango.Attribute.destroy]
Determines the bidirectional type of a character.
The bidirectional type is specified in the Unicode Character Database.
A simplified version of this function is available as [func@unichar_direction].
the bidirectional character type, as used in the
Unicode bidirectional algorithm.
a Unicode character
Determines possible line, word, and character breaks
for a string of Unicode text with a single analysis.
For most purposes you may want to use [func@Pango.get_log_attrs].
Use [func@Pango.default_break],
[func@Pango.tailor_break] and [func@Pango.attr_break].
the text to process. Must be valid UTF-8
length of @text in bytes (may be -1 if @text is nul-terminated)
`PangoAnalysis` structure for @text
an array to store character information in
size of the array passed as @attrs
This is the default break algorithm.
It applies rules from the [Unicode Line Breaking Algorithm](http://www.unicode.org/unicode/reports/tr14/)
without language-specific tailoring, therefore the @analyis argument is unused
and can be %NULL.
See [func@Pango.tailor_break] for language-specific breaks.
See [func@Pango.attr_break] for attribute-based customization.
text to break. Must be valid UTF-8
length of text in bytes (may be -1 if @text is nul-terminated)
a `PangoAnalysis` structure for the @text
logical attributes to fill in
size of the array passed as @attrs
Converts extents from Pango units to device units.
The conversion is done by dividing by the %PANGO_SCALE factor and
performing rounding.
The @inclusive rectangle is converted by flooring the x/y coordinates
and extending width/height, such that the final rectangle completely
includes the original rectangle.
The @nearest rectangle is converted by rounding the coordinates
of the rectangle to the nearest device unit (pixel).
The rule to which argument to use is: if you want the resulting device-space
rectangle to completely contain the original rectangle, pass it in as
@inclusive. If you want two touching-but-not-overlapping rectangles stay
touching-but-not-overlapping after rounding to device units, pass them in
as @nearest.
rectangle to round to pixels inclusively
rectangle to round to nearest pixels
Searches a string the first character that has a strong
direction, according to the Unicode bidirectional algorithm.
The direction corresponding to the first strong character.
If no such character is found, then %PANGO_DIRECTION_NEUTRAL is returned.
the text to process. Must be valid UTF-8
length of @text in bytes (may be -1 if @text is nul-terminated)
Locates a paragraph boundary in @text.
A boundary is caused by delimiter characters, such as
a newline, carriage return, carriage return-newline pair,
or Unicode paragraph separator character.
The index of the run of delimiters is returned in
@paragraph_delimiter_index. The index of the start of the
next paragraph (index after all delimiters) is stored n
@next_paragraph_start.
If no delimiters are found, both @paragraph_delimiter_index
and @next_paragraph_start are filled with the length of @text
(an index one off the end).
UTF-8 text
length of @text in bytes, or -1 if nul-terminated
return location for index of
delimiter
return location for start of next
paragraph
Creates a new font description from a string representation.
The string must have the form
"\[FAMILY-LIST] \[STYLE-OPTIONS] \[SIZE] \[VARIATIONS]",
where FAMILY-LIST is a comma-separated list of families optionally
terminated by a comma, STYLE_OPTIONS is a whitespace-separated list
of words where each word describes one of style, variant, weight,
stretch, or gravity, and SIZE is a decimal number (size in points)
or optionally followed by the unit modifier "px" for absolute size.
VARIATIONS is a comma-separated list of font variation
specifications of the form "\@axis=value" (the = sign is optional).
The following words are understood as styles:
"Normal", "Roman", "Oblique", "Italic".
The following words are understood as variants:
"Small-Caps", "All-Small-Caps", "Petite-Caps", "All-Petite-Caps",
"Unicase", "Title-Caps".
The following words are understood as weights:
"Thin", "Ultra-Light", "Extra-Light", "Light", "Semi-Light",
"Demi-Light", "Book", "Regular", "Medium", "Semi-Bold", "Demi-Bold",
"Bold", "Ultra-Bold", "Extra-Bold", "Heavy", "Black", "Ultra-Black",
"Extra-Black".
The following words are understood as stretch values:
"Ultra-Condensed", "Extra-Condensed", "Condensed", "Semi-Condensed",
"Semi-Expanded", "Expanded", "Extra-Expanded", "Ultra-Expanded".
The following words are understood as gravity values:
"Not-Rotated", "South", "Upside-Down", "North", "Rotated-Left",
"East", "Rotated-Right", "West".
Any one of the options may be absent. If FAMILY-LIST is absent, then
the family_name field of the resulting font description will be
initialized to %NULL. If STYLE-OPTIONS is missing, then all style
options will be set to the default values. If SIZE is missing, the
size in the resulting font description will be set to 0.
A typical example:
"Cantarell Italic Light 15 \@wght=200"
a new `PangoFontDescription`.
string representation of a font description.
Computes a `PangoLogAttr` for each character in @text.
The @attrs array must have one `PangoLogAttr` for
each position in @text; if @text contains N characters,
it has N+1 positions, including the last position at the
end of the text. @text should be an entire paragraph;
logical attributes can't be computed without context
(for example you need to see spaces on either side of
a word to know the word is a word).
text to process. Must be valid UTF-8
length in bytes of @text
embedding level, or -1 if unknown
language tag
array with one `PangoLogAttr`
per character in @text, plus one extra, to be filled in
length of @attrs array
Returns the mirrored character of a Unicode character.
Mirror characters are determined by the Unicode mirrored property.
Use [func@GLib.unichar_get_mirror_char] instead;
the docs for that function provide full details.
%TRUE if @ch has a mirrored character and @mirrored_ch is
filled in, %FALSE otherwise
a Unicode character
location to store the mirrored character
Finds the gravity that best matches the rotation component
in a `PangoMatrix`.
the gravity of @matrix, which will never be
%PANGO_GRAVITY_AUTO, or %PANGO_GRAVITY_SOUTH if @matrix is %NULL
a `PangoMatrix`
Returns the gravity to use in laying out a `PangoItem`.
The gravity is determined based on the script, base gravity, and hint.
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of @script. To get the preferred gravity of a script,
pass %PANGO_GRAVITY_AUTO and %PANGO_GRAVITY_HINT_STRONG in.
resolved gravity suitable to use for a run of text
with @script
`PangoScript` to query
base gravity of the paragraph
orientation hint
Returns the gravity to use in laying out a single character
or `PangoItem`.
The gravity is determined based on the script, East Asian width,
base gravity, and hint,
This function is similar to [func@Pango.Gravity.get_for_script] except
that this function makes a distinction between narrow/half-width and
wide/full-width characters also. Wide/full-width characters always
stand *upright*, that is, they always take the base gravity,
whereas narrow/full-width characters are always rotated in vertical
context.
If @base_gravity is %PANGO_GRAVITY_AUTO, it is first replaced with the
preferred gravity of @script.
resolved gravity suitable to use for a run of text
with @script and @wide.
`PangoScript` to query
%TRUE for wide characters as returned by g_unichar_iswide()
base gravity of the paragraph
orientation hint
Converts a `PangoGravity` value to its natural rotation in radians.
Note that [method@Pango.Matrix.rotate] takes angle in degrees, not radians.
So, to call [method@Pango.Matrix,rotate] with the output of this function
you should multiply it by (180. / G_PI).
the rotation value corresponding to @gravity.
gravity to query, should not be %PANGO_GRAVITY_AUTO
Checks if a character that should not be normally rendered.
This includes all Unicode characters with "ZERO WIDTH" in their name,
as well as *bidi* formatting characters, and a few other ones.
This is totally different from [func@GLib.unichar_iszerowidth] and is at best misnamed.
%TRUE if @ch is a zero-width character, %FALSE otherwise
a Unicode character
Breaks a piece of text into segments with consistent directional
level and font.
Each byte of @text will be contained in exactly one of the items in the
returned list; the generated list of items will be in logical order (the
start offsets of the items are ascending).
@cached_iter should be an iterator over @attrs currently positioned
at a range before or containing @start_index; @cached_iter will be
advanced to the range covering the position just after
@start_index + @length. (i.e. if itemizing in a loop, just keep passing
in the same @cached_iter).
a `GList` of
[struct@Pango.Item] structures. The items should be freed using
[method@Pango.Item.free] in combination with [func@GLib.List.free_full].
a structure holding information that affects
the itemization process.
the text to itemize. Must be valid UTF-8
first byte in @text to process
the number of bytes (not characters) to process
after @start_index. This must be >= 0.
the set of attributes that apply to @text.
Cached attribute iterator
Like `pango_itemize()`, but with an explicitly specified base direction.
The base direction is used when computing bidirectional levels.
[func@itemize] gets the base direction from the `PangoContext`
(see [method@Pango.Context.set_base_dir]).
a `GList` of
[struct@Pango.Item] structures. The items should be freed using
[method@Pango.Item.free] probably in combination with [func@GLib.List.free_full].
a structure holding information that affects
the itemization process.
base direction to use for bidirectional processing
the text to itemize.
first byte in @text to process
the number of bytes (not characters) to process
after @start_index. This must be >= 0.
the set of attributes that apply to @text.
Cached attribute iterator
Convert a language tag to a `PangoLanguage`.
The language tag must be in a RFC-3066 format. `PangoLanguage` pointers
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 '-'.
Use [func@Pango.Language.get_default] if you want to get the
`PangoLanguage` for the current locale of the process.
a `PangoLanguage`
a string representing a language tag
Returns the `PangoLanguage` for the current locale of the process.
On Unix systems, this is the return value is derived from
`setlocale (LC_CTYPE, NULL)`, and the user can
affect this through the environment variables LC_ALL, LC_CTYPE or
LANG (checked in that order). The locale string typically is in
the form lang_COUNTRY, where lang is an ISO-639 language code, and
COUNTRY is an ISO-3166 country code. For instance, sv_FI for
Swedish as written in Finland or pt_BR for Portuguese as written in
Brazil.
On Windows, the C library does not use any such environment
variables, and setting them won't affect the behavior of functions
like ctime(). The user sets the locale through the Regional Options
in the Control Panel. The C library (in the setlocale() function)
does not use country and language codes, but country and language
names spelled out in English.
However, this function does check the above environment
variables, and does return a Unix-style locale string based on
either said environment variables or the thread's current locale.
Your application should call `setlocale(LC_ALL, "")` for the user
settings to take effect. GTK does this in its initialization
functions automatically (by calling gtk_set_locale()).
See the setlocale() manpage for more details.
Note that the default language can change over the life of an application.
Also note that this function will not do the right thing if you
use per-thread locales with uselocale(). In that case, you should
just call pango_language_from_string() yourself.
the default language as a `PangoLanguage`
Returns the list of languages that the user prefers.
The list is specified by the `PANGO_LANGUAGE` or `LANGUAGE`
environment variables, in order of preference. Note that this
list does not necessarily include the language returned by
[func@Pango.Language.get_default].
When choosing language-specific resources, such as the sample
text returned by [method@Pango.Language.get_sample_string],
you should first try the default language, followed by the
languages returned by this function.
a %NULL-terminated array
of `PangoLanguage`*
Return the bidirectional embedding levels of the input paragraph.
The bidirectional embedding levels are defined by the [Unicode Bidirectional
Algorithm](http://www.unicode.org/reports/tr9/).
If the input base direction is a weak direction, the direction of the
characters in the text will determine the final resolved direction.
a newly allocated array of embedding levels, one item per
character (not byte), that should be freed using [func@GLib.free].
the text to itemize.
the number of bytes (not characters) to process, or -1
if @text is nul-terminated and the length should be calculated.
input base direction, and output resolved direction.
Finishes parsing markup.
After feeding a Pango markup parser some data with [method@GLib.MarkupParseContext.parse],
use this function to get the list of attributes and text out of the
markup. This function will not free @context, use [method@GLib.MarkupParseContext.free]
to do so.
%FALSE if @error is set, otherwise %TRUE
A valid parse context that was returned from [func@markup_parser_new]
address of return location for a `PangoAttrList`
address of return location for text with tags stripped
address of return location for accelerator char
Incrementally parses marked-up text to create a plain-text string
and an attribute list.
See the [Pango Markup](pango_markup.html) docs for details about the
supported markup.
If @accel_marker is nonzero, the given character will mark the
character following it as an accelerator. For example, @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,
when calling [func@markup_parser_finish]. Two @accel_marker characters
following each other produce a single literal @accel_marker character.
To feed markup to the parser, use [method@GLib.MarkupParseContext.parse]
on the returned [struct@GLib.MarkupParseContext]. When done with feeding markup
to the parser, use [func@markup_parser_finish] to get the data out
of it, and then use [method@GLib.MarkupParseContext.free] to free it.
This function is designed for applications that read Pango markup
from streams. To simply parse a string containing Pango markup,
the [func@Pango.parse_markup] API is recommended instead.
a `GMarkupParseContext` that should be
destroyed with [method@GLib.MarkupParseContext.free].
character that precedes an accelerator, or 0 for none
Parses an enum type and stores the result in @value.
If @str does not match the nick name of any of the possible values
for the enum and is not an integer, %FALSE is returned, a warning
is issued if @warn is %TRUE, and a string representing the list of
possible values is stored in @possible_values. The list is
slash-separated, eg. "none/start/middle/end".
If failed and @possible_values is not %NULL, returned string should
be freed using g_free().
%TRUE if @str was successfully parsed
enum type to parse, eg. %PANGO_TYPE_ELLIPSIZE_MODE
string to parse
integer to store the result in
if %TRUE, issue a g_warning() on bad input
place to store list of possible
values on failure
Parses marked-up text to create a plain-text string and an attribute list.
See the [Pango Markup](pango_markup.html) docs for details about the
supported markup.
If @accel_marker is nonzero, the given character will mark the
character following it as an accelerator. For example, @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.
To parse a stream of pango markup incrementally, use [func@markup_parser_new].
If any error happens, none of the output arguments are touched except
for @error.
%FALSE if @error is set, otherwise %TRUE
markup to parse (see the [Pango Markup](pango_markup.html) docs)
length of @markup_text, or -1 if nul-terminated
character that precedes an accelerator, or 0 for none
address of return location for a `PangoAttrList`
address of return location for text with tags stripped
address of return location for accelerator char
Parses a font stretch.
The allowed values are
"ultra_condensed", "extra_condensed", "condensed",
"semi_condensed", "normal", "semi_expanded", "expanded",
"extra_expanded" and "ultra_expanded". Case variations are
ignored and the '_' characters may be omitted.
%TRUE if @str was successfully parsed.
a string to parse.
a `PangoStretch` to store the result in.
if %TRUE, issue a g_warning() on bad input.
Parses a font style.
The allowed values are "normal", "italic" and "oblique", case
variations being
ignored.
%TRUE if @str was successfully parsed.
a string to parse.
a `PangoStyle` to store the result in.
if %TRUE, issue a g_warning() on bad input.
Parses a font variant.
The allowed values are "normal", "small-caps", "all-small-caps",
"petite-caps", "all-petite-caps", "unicase" and "title-caps",
case variations being ignored.
%TRUE if @str was successfully parsed.
a string to parse.
a `PangoVariant` to store the result in.
if %TRUE, issue a g_warning() on bad input.
Parses a font weight.
The allowed values are "heavy",
"ultrabold", "bold", "normal", "light", "ultraleight"
and integers. Case variations are ignored.
%TRUE if @str was successfully parsed.
a string to parse.
a `PangoWeight` to store the result in.
if %TRUE, issue a g_warning() on bad input.
Quantizes the thickness and position of a line to whole device pixels.
This is typically used for underline or strikethrough. The purpose of
this function is to avoid such lines looking blurry.
Care is taken to make sure @thickness is at least one pixel when this
function returns, but returned @position may become zero as a result
of rounding.
pointer to the thickness of a line, in Pango units
corresponding position
Reads an entire line from a file into a buffer.
Lines may be delimited with '\n', '\r', '\n\r', or '\r\n'. The delimiter
is not written into the buffer. Text after a '#' character is treated as
a comment and skipped. '\' can be used to escape a # character.
'\' proceeding a line delimiter combines adjacent lines. A '\' proceeding
any other character is ignored and written into the output buffer
unmodified.
0 if the stream was already at an %EOF character,
otherwise the number of lines read (this is useful for maintaining
a line number counter which doesn't combine lines with '\')
a stdio stream
`GString` buffer into which to write the result
Reorder items from logical order to visual order.
The visual order is determined from the associated directional
levels of the items. The original list is unmodified.
(Please open a bug if you use this function.
It is not a particularly convenient interface, and the code
is duplicated elsewhere in Pango for that reason.)
a `GList`
of `PangoItem` structures in visual order.
a `GList` of `PangoItem`
in logical order.
Scans an integer.
Leading white space is skipped.
%FALSE if a parse error occurred
in/out string position
an int into which to write the result
Scans a string into a `GString` buffer.
The string may either be a sequence of non-white-space characters,
or a quoted string with '"'. Instead a quoted string, '\"' represents
a literal quote. Leading white space outside of quotes is skipped.
%FALSE if a parse error occurred
in/out string position
a `GString` into which to write the result
Scans a word into a `GString` buffer.
A word consists of [A-Za-z_] followed by zero or more
[A-Za-z_0-9]. Leading white space is skipped.
%FALSE if a parse error occurred
in/out string position
a `GString` into which to write the result
Looks up the script for a particular character.
The script of a character is defined by
[Unicode Standard Annex 24: Script names](http://www.unicode.org/reports/tr24/).
No check is made for @ch being a valid Unicode character; if you pass
in invalid character, the result is undefined.
Note that while the return type of this function is declared
as `PangoScript`, as of Pango 1.18, this function simply returns
the return value of [func@GLib.unichar_get_script]. Callers must be
prepared to handle unknown values.
Use g_unichar_get_script()
the `PangoScript` for the character.
a Unicode character
Finds a language tag that is reasonably representative of @script.
The language will usually be the most widely spoken or used language
written in that script: for instance, the sample language for
%PANGO_SCRIPT_CYRILLIC is ru (Russian), the sample language for
%PANGO_SCRIPT_ARABIC is ar.
For some scripts, no sample language will be returned because
there is no language that is sufficiently representative. The
best example of this is %PANGO_SCRIPT_HAN, where various different
variants of written Chinese, Japanese, and Korean all use
significantly different sets of Han characters and forms
of shared characters. No sample language can be provided
for many historical scripts as well.
As of 1.18, this function checks the environment variables
`PANGO_LANGUAGE` and `LANGUAGE` (checked in that order) first.
If one of them is set, it is parsed as a list of language tags
separated by colons or other separators. This function
will return the first language in the parsed list that Pango
believes may use @script for writing. This last predicate
is tested using [method@Pango.Language.includes_script]. This can
be used to control Pango's font selection for non-primary
languages. For example, a `PANGO_LANGUAGE` enviroment variable
set to "en:fa" makes Pango choose fonts suitable for Persian (fa)
instead of Arabic (ar) when a segment of Arabic text is found
in an otherwise non-Arabic text. The same trick can be used to
choose a default language for %PANGO_SCRIPT_HAN when setting
context language is not feasible.
a `PangoLanguage` that is representative
of the script
a `PangoScript`
Convert the characters in @text into glyphs.
Given a segment of text and the corresponding `PangoAnalysis` structure
returned from [func@Pango.itemize], convert the characters into glyphs. You
may also pass in only a substring of the item from [func@Pango.itemize].
It is recommended that you use [func@Pango.shape_full] instead, since
that API allows for shaping interaction happening across text item
boundaries.
Note that the extra attributes in the @analyis that is returned from
[func@Pango.itemize] have indices that are relative to the entire paragraph,
so you need to subtract the item offset from their indices before
calling [func@Pango.shape].
the text to process
the length (in bytes) of @text
`PangoAnalysis` structure from [func@Pango.itemize]
glyph string in which to store results
Convert the characters in @text into glyphs.
Given a segment of text and the corresponding `PangoAnalysis` structure
returned from [func@Pango.itemize], convert the characters into glyphs.
You may also pass in only a substring of the item from [func@Pango.itemize].
This is similar to [func@Pango.shape], except it also can optionally take
the full paragraph text as input, which will then be used to perform
certain cross-item shaping interactions. If you have access to the broader
text of which @item_text is part of, provide the broader text as
@paragraph_text. If @paragraph_text is %NULL, item text is used instead.
Note that the extra attributes in the @analyis that is returned from
[func@Pango.itemize] have indices that are relative to the entire paragraph,
so you do not pass the full paragraph text as @paragraph_text, you need
to subtract the item offset from their indices before calling
[func@Pango.shape_full].
valid UTF-8 text to shape.
the length (in bytes) of @item_text. -1 means nul-terminated text.
text of the paragraph (see details).
the length (in bytes) of @paragraph_text. -1 means nul-terminated text.
`PangoAnalysis` structure from [func@Pango.itemize].
glyph string in which to store results.
Convert the characters in @item into glyphs.
This is similar to [func@Pango.shape_with_flags], except it takes a
`PangoItem` instead of separate @item_text and @analysis arguments.
It also takes @log_attrs, which may be used in implementing text
transforms.
Note that the extra attributes in the @analyis that is returned from
[func@Pango.itemize] have indices that are relative to the entire paragraph,
so you do not pass the full paragraph text as @paragraph_text, you need
to subtract the item offset from their indices before calling
[func@Pango.shape_with_flags].
`PangoItem` to shape
text of the paragraph (see details).
the length (in bytes) of @paragraph_text.
-1 means nul-terminated text.
array of `PangoLogAttr` for @item
glyph string in which to store results
flags influencing the shaping process
Convert the characters in @text into glyphs.
Given a segment of text and the corresponding `PangoAnalysis` structure
returned from [func@Pango.itemize], convert the characters into glyphs.
You may also pass in only a substring of the item from [func@Pango.itemize].
This is similar to [func@Pango.shape_full], except it also takes flags
that can influence the shaping process.
Note that the extra attributes in the @analyis that is returned from
[func@Pango.itemize] have indices that are relative to the entire paragraph,
so you do not pass the full paragraph text as @paragraph_text, you need
to subtract the item offset from their indices before calling
[func@Pango.shape_with_flags].
valid UTF-8 text to shape
the length (in bytes) of @item_text.
-1 means nul-terminated text.
text of the paragraph (see details).
the length (in bytes) of @paragraph_text.
-1 means nul-terminated text.
`PangoAnalysis` structure from [func@Pango.itemize]
glyph string in which to store results
flags influencing the shaping process
Skips 0 or more characters of white space.
%FALSE if skipping the white space leaves
the position at a '\0' character.
in/out string position
Splits a %G_SEARCHPATH_SEPARATOR-separated list of files, stripping
white space and substituting ~/ with $HOME/.
a list of
strings to be freed with g_strfreev()
a %G_SEARCHPATH_SEPARATOR separated list of filenames
Deserializes a `PangoTabArray` from a string.
This is the counterpart to [method@Pango.TabArray.to_string].
See that functions for details about the format.
a new `PangoTabArray`
a string
Apply language-specific tailoring to the breaks in @attrs.
The line breaks are assumed to have been produced by [func@Pango.default_break].
If @offset is not -1, it is used to apply attributes from @analysis that are
relevant to line breaking.
Note that it is better to pass -1 for @offset and use [func@Pango.attr_break]
to apply attributes to the whole paragraph.
text to process. Must be valid UTF-8
length in bytes of @text
`PangoAnalysis` for @text
Byte offset of @text from the beginning of the
paragraph, or -1 to ignore attributes from @analysis
array with one `PangoLogAttr`
per character in @text, plus one extra, to be filled in
length of @attrs array
Trims leading and trailing whitespace from a string.
A newly-allocated string that must be freed with g_free()
a string
Determines the inherent direction of a character.
The inherent direction is either `PANGO_DIRECTION_LTR`, `PANGO_DIRECTION_RTL`,
or `PANGO_DIRECTION_NEUTRAL`.
This function is useful to categorize characters into left-to-right
letters, right-to-left letters, and everything else. If full Unicode
bidirectional type of a character is needed, [func@Pango.BidiType.for_unichar]
can be used instead.
the direction of the character.
a Unicode character
Converts a floating-point number to Pango units.
The conversion is done by multiplying @d by %PANGO_SCALE and
rounding the result to nearest integer.
the value in Pango units.
double floating-point value
Converts a number in Pango units to floating-point.
The conversion is done by dividing @i by %PANGO_SCALE.
the double value.
value in Pango units
Returns the encoded version of Pango available at run-time.
This is similar to the macro %PANGO_VERSION except that the macro
returns the encoded version available at compile-time. A version
number can be encoded into an integer using PANGO_VERSION_ENCODE().
The encoded version of Pango library available at run time.
Checks that the Pango library in use is compatible with the
given version.
Generally you would pass in the constants %PANGO_VERSION_MAJOR,
%PANGO_VERSION_MINOR, %PANGO_VERSION_MICRO as the three arguments
to this function; that produces a check that the library in use at
run-time is compatible with the version of Pango the application or
module was compiled against.
Compatibility is defined by two things: first the version
of the running library is newer than the version
@required_major.required_minor.@required_micro. Second
the running library must be binary compatible with the
version @required_major.required_minor.@required_micro
(same major version.)
For compile-time version checking use PANGO_VERSION_CHECK().
%NULL if the Pango library is compatible
with the given version, or a string describing the version
mismatch. The returned string is owned by Pango and should not
be modified or freed.
the required major version
the required minor version
the required major version
Returns the version of Pango available at run-time.
This is similar to the macro %PANGO_VERSION_STRING except that the
macro returns the version available at compile-time.
A string containing the version of Pango library available
at run time. The returned string is owned by Pango and should not
be modified or freed.