pangomm r33 - in trunk: . pango/src
- From: murrayc svn gnome org
- To: svn-commits-list gnome org
- Subject: pangomm r33 - in trunk: . pango/src
- Date: Mon, 9 Mar 2009 09:17:50 +0000 (UTC)
Author: murrayc
Date: Mon Mar 9 09:17:50 2009
New Revision: 33
URL: http://svn.gnome.org/viewvc/pangomm?rev=33&view=rev
Log:
2009-03-09 Murray Cumming <murrayc murrayc com>
* pango/src/pango_docs.xml: Regenerated with doxextract_to_xml.py.
Modified:
trunk/ChangeLog
trunk/pango/src/pango_docs.xml
Modified: trunk/pango/src/pango_docs.xml
==============================================================================
--- trunk/pango/src/pango_docs.xml (original)
+++ trunk/pango/src/pango_docs.xml Mon Mar 9 09:17:50 2009
@@ -58,8 +58,8 @@
<function name="pango_renderer_get_layout_line">
<description>
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&lt;!----&gt;() for example.
+Calling this function only makes sense from inside a subclass's
+methods, like in its draw_shape<!---->() for example.
The returned layout line should not be modified while still being
rendered.
@@ -150,7 +150,7 @@
</description>
<parameters>
<parameter name="bitmap">
-<parameter_description> a &lt;type&gt;FT_Bitmap&lt;/type&gt; to render the line onto
+<parameter_description> a <type>FT_Bitmap</type> to render the line onto
</parameter_description>
</parameter>
<parameter name="line">
@@ -214,44 +214,52 @@
</return>
</function>
-<function name="pango_layout_set_text">
+<function name="pango_fc_fontset_key_get_description">
<description>
-Sets the text of the layout.
+Gets the font description of @key.
-Note that if you have used
-pango_layout_set_markup() or pango_layout_set_markup_with_accel() on
- layout before, you may want to call pango_layout_set_attributes() to clear
-the attributes set on the layout from the markup as this function does not
-clear attributes.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> a valid UTF-8 string
+<parameter name="key">
+<parameter_description> the fontset key
</parameter_description>
</parameter>
-<parameter name="length">
-<parameter_description> 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.
+</parameters>
+<return> the font description, which is owned by @key and should not be modified.
+
+Since: 1.24
+</return>
+</function>
+
+<function name="pango_layout_get_auto_dir">
+<description>
+Gets whether to calculate the bidirectional base direction
+for the layout according to the contents of the layout.
+See pango_layout_set_auto_dir().
+
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #PangoLayout
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the bidirectional base direction
+is computed from the layout's contents, %FALSE otherwise.
+
+Since: 1.4
+</return>
</function>
<function name="pango_parse_enum">
<description>
-Parses an enum type and stored the result in @value.
+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, %FALSE is returned, a warning is issued if @warn is %TRUE, and a
+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,
@@ -387,7 +395,7 @@
<function name="pango_layout_iter_get_baseline">
<description>
-Gets the Y position of the current line's baseline, in layout
+Gets the Y position of the current line's baseline, in layout
coordinates (origin at top left of the entire layout).
@@ -544,9 +552,16 @@
<function name="pango_font_description_better_match">
<description>
Determines if the style attributes of @new_match are a closer match
-for @desc than @old_match, or if @old_match is %NULL, determines if
- new_match is a match at all. Approximate matching is done for
-weight and style; other attributes must match exactly.
+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.
</description>
@@ -602,11 +617,11 @@
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
<parameter name="dpi">
-<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
+<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.) A 0 or negative value
means to use the resolution from the font map.
</parameter_description>
@@ -658,7 +673,7 @@
<function name="pango_layout_iter_get_run">
<description>
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
+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.
@@ -763,16 +778,16 @@
</parameter_description>
</parameter>
<parameter name="desc">
-<parameter_description> a #PangoFontDescription structure
+<parameter_description> a #PangoFontDescription structure. %NULL means that the font
+description from the context will be used.
</parameter_description>
</parameter>
<parameter name="language">
<parameter_description> 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
-large enough to cover a range of languages will be returned.
-The process of determining such metrics is slow, so it is best
-to always make sure some real language tag will be used.
+for the default language (as determined by
+pango_language_get_default()) will be returned.
</parameter_description>
</parameter>
</parameters>
@@ -1009,8 +1024,23 @@
<function name="pango_language_get_sample_string">
<description>
Get a string that is representative of the characters needed to
-render a particular language. This function is a bad hack for
-internal use by renderers and Pango.
+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
+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:
+<informalexample><programlisting>
+pango_language_get_sample_string (pango_language_from_string ("xx"))
+</programlisting></informalexample>
</description>
@@ -1021,33 +1051,25 @@
</parameter>
</parameters>
<return> the sample string. This value is owned by Pango
-and must not be freed.
+and should not be freed.
</return>
</function>
-<function name="_pango_glyph_item_iter_init_start">
+<function name="pango_fc_font_key_get_context_key">
<description>
-Initializes a #PangoGlyphItemIter structure to point to the
-first cluster in a glyph item.
+Gets the context key member of @key.
</description>
<parameters>
-<parameter name="iter">
-<parameter_description> pointer to a #PangoGlyphItemIter structure
-</parameter_description>
-</parameter>
-<parameter name="glyph_item">
-<parameter_description> the glyph item that @iter points into
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> text corresponding to the glyph item
+<parameter name="key">
+<parameter_description> the font key
</parameter_description>
</parameter>
</parameters>
-<return> %FALSE if there are no clusters in the glyph item;
-in this case, the state of @iter is undefined.
+<return> the context key, which is owned by @key and should not be modified.
+
+Since: 1.24
</return>
</function>
@@ -1155,10 +1177,9 @@
<function name="pango_get_lib_subdirectory">
<description>
On Unix, returns the name of the "pango" subdirectory of LIBDIR
-(which is set at compile time). On Win32, returns the Pango
-installation directory (which is deduced at run time from the DLL's
-location, or stored in the Registry). The returned string should
-not be freed.
+(which is set at compile time). On Windows, returns the lib\pango
+subdirectory of the Pango installation directory (which is deduced
+at run time from the DLL's location).
</description>
@@ -1199,7 +1220,7 @@
</description>
<parameters>
<parameter name="bitmap">
-<parameter_description> a &lt;type&gt;FT_Bitmap&lt;/type&gt; to render the layout onto
+<parameter_description> a <type>FT_Bitmap</type> to render the layout onto
</parameter_description>
</parameter>
<parameter name="layout">
@@ -1286,20 +1307,22 @@
</return>
</function>
-<function name="pango_layout_get_text">
+<function name="pango_fc_fontset_key_get_absolute_size">
<description>
-Gets the text in the layout. The returned text should not
-be freed or modified.
+Gets the absolute font size of @key in Pango units. This is adjusted
+for both resolution and transformation matrix.
</description>
<parameters>
-<parameter name="layout">
-<parameter_description> a #PangoLayout
+<parameter name="key">
+<parameter_description> the fontset key
</parameter_description>
</parameter>
</parameters>
-<return> the text in the @layout.
+<return> the pixel size of @key.
+
+Since: 1.24
</return>
</function>
@@ -1405,8 +1428,10 @@
<function name="pango_attribute_init">
<description>
-Initializes @attr's klass to @klass, it's start_index to zero,
-and end_index to %G_MAXUINT such that the attribute applies
+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.
Since: 1.20
@@ -1440,6 +1465,8 @@
<return> the newly created context; free with g_object_unref().
Since: 1.10
+
+Deprecated: 1.22: Use pango_font_map_create_context() instead.
</return>
</function>
@@ -1546,6 +1573,8 @@
<return> the newly created context; free with g_object_unref().
Since: 1.2
+
+Deprecated: 1.22: Use pango_font_map_create_context() instead.
</return>
</function>
@@ -1562,7 +1591,7 @@
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 pango_context_set_base_dir()).
+of the layout's #PangoContext. (See pango_context_set_base_dir()).
When the auto-computed direction of a paragraph differs from the
base direction of the context, the interpretation of
@@ -1578,7 +1607,7 @@
</parameter>
<parameter name="auto_dir">
<parameter_description> if %TRUE, compute the bidirectional base direction
-from the layout's contents.
+from the layout's contents.
</parameter_description>
</parameter>
</parameters>
@@ -1676,7 +1705,7 @@
<function name="pango_ft2_font_get_face">
<description>
-Return value: a pointer to a &lt;type&gt;FT_Face&lt;/type&gt; structure, with the size set correctly,
+Return value: a pointer to a <type>FT_Face</type> structure, with the size set correctly,
</description>
<parameters>
@@ -1685,7 +1714,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to a &lt;type&gt;FT_Face&lt;/type&gt; structure, with the size set correctly,
+<return> a pointer to a <type>FT_Face</type> structure, with the size set correctly,
or %NULL if @font is %NULL.
</return>
</function>
@@ -1699,7 +1728,7 @@
the LOGFONTA contains non-ASCII characters the font is temporarily
loaded (using CreateFontIndirect()) and an ASCII (usually English)
name for it is looked up from the font name tables in the font
-data. If that doesn't work, the face name is converted from the
+data. If that doesn't work, the face name is converted from the
system codepage to UTF-8 and that is used.
@@ -1781,7 +1810,7 @@
<description>
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
+string with '"'. Instead a quoted string, '\"' represents
a literal quote. Leading white space outside of quotes is skipped.
@@ -1800,12 +1829,15 @@
</return>
</function>
-<function name="pango_layout_get_auto_dir">
+<function name="pango_layout_set_text">
<description>
-Gets whether to calculate the bidirectional base direction
-for the layout according to the contents of the layout.
-See pango_layout_set_auto_dir().
+Sets the text of the layout.
+Note that if you have used
+pango_layout_set_markup() or pango_layout_set_markup_with_accel() on
+ layout before, you may want to call pango_layout_set_attributes() to clear
+the attributes set on the layout from the markup as this function does not
+clear attributes.
</description>
<parameters>
@@ -1813,12 +1845,20 @@
<parameter_description> a #PangoLayout
</parameter_description>
</parameter>
+<parameter name="text">
+<parameter_description> a valid UTF-8 string
+</parameter_description>
+</parameter>
+<parameter name="length">
+<parameter_description> 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.
+</parameter_description>
+</parameter>
</parameters>
-<return> %TRUE if the bidirectional base direction
-is computed from the layout's contents, %FALSE otherwise.
-
-Since: 1.4
-</return>
+<return></return>
</function>
<function name="pango_attribute_equal">
@@ -1958,7 +1998,7 @@
</parameter>
<parameter name="old_trailing">
<parameter_description> if 0, the cursor was at the trailing edge of the
-grapheme indicated by @old_index, if &gt; 0, the cursor
+grapheme indicated by @old_index, if > 0, the cursor
was at the leading edge.
</parameter_description>
</parameter>
@@ -2037,7 +2077,7 @@
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
<parameter name="func">
@@ -2083,6 +2123,9 @@
<parameters>
</parameters>
<return> the new #PangoContext
+
+Deprecated: 1.22: Use pango_win32_font_map_for_display() followed by
+pango_font_map_create_context() instead.
</return>
</function>
@@ -2159,23 +2202,6 @@
</return>
</function>
-<function name="_pango_glyph_item_iter_prev_cluster">
-<description>
-Moves the iterator to the preceding cluster in the glyph item.
-
-
-</description>
-<parameters>
-<parameter name="iter">
-<parameter_description> a #PangoGlyphItemIter
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the iterator was moved, %FALSE if we were already on the
-first cluster.
-</return>
-</function>
-
<function name="pango_cairo_show_layout_line">
<description>
Draws a #PangoLayoutLine in the specified cairo context.
@@ -2258,6 +2284,22 @@
<return></return>
</function>
+<function name="pango_glyph_item_iter_free">
+<description>
+Frees a #PangoGlyphItemIter created by pango_glyph_item_iter_copy().
+
+Since: 1.22
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #PangoGlyphItemIter, may be %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="pango_font_description_merge_static">
<description>
Like pango_font_description_merge(), but only a shallow copy is made
@@ -2285,6 +2327,32 @@
<return></return>
</function>
+<function name="pango_font_map_create_context">
+<description>
+Creates a #PangoContext connected to @fontmap. This is equivalent
+to pango_context_new() followed by 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,
+gdk_pango_context_get_for_screen(), and
+gtk_widget_get_pango_context(). Use those instead.
+
+
+</description>
+<parameters>
+<parameter name="fontmap">
+<parameter_description> a #PangoFontMap
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly allocated #PangoContext, which should
+be freed with g_object_unref().
+
+Since: 1.22
+</return>
+</function>
+
<function name="pango_attr_font_desc_new">
<description>
Create a new font description attribute. This attribute
@@ -2308,7 +2376,7 @@
<description>
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
+that don't affect shaping, such as color or underline, to avoid
affecting shaping, you filter them out (pango_attr_list_filter()),
apply the shaping process and then reapply them to the result using
this function.
@@ -2317,7 +2385,7 @@
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-&gt;extra_attrs for some of the
+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
@@ -2487,8 +2555,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the layout's font description,
-or %NULL if the font description from the layout's
+<return> a pointer to the layout's font description,
+or %NULL if the font description from the layout's
context is inherited. This value is owned by the layout
and must not be modified or freed.
@@ -2637,7 +2705,7 @@
<function name="pango_glyph_item_free">
<description>
-Frees a #PangoGlyphItem and memory to which it points.
+Frees a #PangoGlyphItem and resources to which it points.
Since: 1.6
@@ -2729,13 +2797,57 @@
</return>
</function>
+<function name="pango_language_get_scripts">
+<description>
+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 pango_language_includes_script() function uses this function
+internally.
+
+
+</description>
+<parameters>
+<parameter name="language">
+<parameter_description> a #PangoLanguage, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="num_scripts">
+<parameter_description> location to return number of scripts, or %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> 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).
+The returned array is owned by Pango and should not be modified
+or freed.
+
+Since: 1.22
+</return>
+</function>
+
<function name="pango_default_break">
<description>
This is the default break algorithm, used if no language
engine overrides it. Normally you should use pango_break()
instead. Unlike pango_break(),
@analysis can be %NULL, but only do that if you know what
-you're doing. If you need an analysis to pass to pango_break(),
+you're doing. If you need an analysis to pass to pango_break(),
you need to pango_itemize(). In most cases however you should
simply use pango_get_log_attrs().
@@ -2849,7 +2961,7 @@
<function name="pango_layout_get_lines_readonly">
<description>
-Return value: a #GSList containing the lines in the layout. This
+Return value: (element-type Pango.LayoutLine): (transfer none): a #GSList containing
</description>
<parameters>
@@ -2858,9 +2970,9 @@
</parameter_description>
</parameter>
</parameters>
-<return> 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
+<return> (element-type Pango.LayoutLine): (transfer none): 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.
Since: 1.16
@@ -3033,7 +3145,7 @@
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
<parameter name="data">
@@ -3048,6 +3160,24 @@
</return>
</function>
+<function name="pango_fc_fontset_key_get_resolution">
+<description>
+Gets the resolution of @key
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> the fontset key
+</parameter_description>
+</parameter>
+</parameters>
+<return> the resolution of @key
+
+Since: 1.24
+</return>
+</function>
+
<function name="pango_font_description_to_string">
<description>
Creates a string representation of a font description. See
@@ -3127,7 +3257,7 @@
</parameter_description>
</parameter>
<parameter name="dpi">
-<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
+<parameter_description> the resolution in "dots per inch". (Physical inches aren't actually
involved; the terminology is conventional.)
</parameter_description>
</parameter>
@@ -3139,7 +3269,7 @@
<description>
Obtains the extents of the #PangoLayout being iterated
over. @ink_rect or @logical_rect can be %NULL if you
-aren't interested in them.
+aren't interested in them.
</description>
@@ -3292,6 +3422,50 @@
<return></return>
</function>
+<function name="pango_renderer_draw_glyph_item">
+<description>
+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 (PDF for example).
+
+Note that @text is the start of the text for layout, which is then
+indexed by <literal>@glyph_item->item->offset</literal>.
+
+If @text is %NULL, this simply calls pango_renderer_draw_glyphs().
+
+The default implementation of this method simply falls back to
+pango_renderer_draw_glyphs().
+
+Since: 1.22
+
+</description>
+<parameters>
+<parameter name="renderer">
+<parameter_description> a #PangoRenderer
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the UTF-8 text that @glyph_item refers to, or %NULL
+</parameter_description>
+</parameter>
+<parameter name="glyph_item">
+<parameter_description> a #PangoGlyphItem
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> X position of left edge of baseline, in user space coordinates
+in Pango units.
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> Y position of left edge of baseline, in user space coordinates
+in Pango units.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="pango_renderer_get_color">
<description>
Gets the current rendering color for the specified part.
@@ -3309,7 +3483,7 @@
</parameter>
</parameters>
<return> the color for the specified part, or %NULL
-if it hasn't been set and should be inherited from the
+if it hasn't been set and should be inherited from the
environment.
Since: 1.8
@@ -3318,7 +3492,7 @@
<function name="pango_glyph_item_copy">
<description>
-Make a deep copy an existing #PangoGlyphItem structure.
+Make a deep copy of an existing #PangoGlyphItem structure.
</description>
@@ -3347,7 +3521,7 @@
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
<parameter name="options">
@@ -3509,7 +3683,7 @@
</description>
<parameters>
<parameter name="size">
-<parameter_description> the font size, in %PANGO_SCALE&lt;!-- --&gt;ths of a point.
+<parameter_description> the font size, in %PANGO_SCALE<!-- -->ths of a point.
</parameter_description>
</parameter>
</parameters>
@@ -3548,7 +3722,7 @@
For better accuracy, you should use pango_matrix_transform_rectangle() on
original rectangle in Pango units and convert to pixels afterward
-using pango_extents_to_pixels()'s first argument.
+using pango_extents_to_pixels()'s first argument.
Since: 1.16
@@ -3657,7 +3831,7 @@
<description>
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.
+the layout's context is used.
</description>
<parameters>
@@ -3951,7 +4125,7 @@
Long term, this functionality probably belongs in the default
implementation of the get_glyph_extents() virtual function.
The other possibility would be to to make it public in something
-like it's current form, and also expose glyph information
+like it's current form, and also expose glyph information
caching functionality similar to pango_ft2_font_set_glyph_info().
Since: 1.6
@@ -3984,15 +4158,15 @@
<function name="pango_ot_info_find_script">
<description>
-Finds the index of a script. If not found, tries to find the 'DFLT'
-and then 'dflt' scripts and return the index of that in @script_index.
+Finds the index of a script. If not found, tries to find the 'DFLT'
+and then 'dflt' scripts and return the index of that in @script_index.
If none of those is found either, %PANGO_OT_NO_SCRIPT is placed in
@script_index.
All other functions taking an input script_index parameter know
how to handle %PANGO_OT_NO_SCRIPT, so one can ignore the return
value of this function completely and proceed, to enjoy the automatic
-fallback to the 'DFLT'/'dflt' script.
+fallback to the 'DFLT'/'dflt' script.
</description>
@@ -4083,7 +4257,7 @@
<function name="pango_layout_set_markup_with_accel">
<description>
Sets the layout text and attribute list from marked-up text (see
-&lt;link linkend="PangoMarkupFormat"&gt;markup format&lt;/link&gt;). Replaces
+<link linkend="PangoMarkupFormat">markup format</link>). Replaces
the current text and attribute list.
If @accel_marker is nonzero, the given character will mark the
@@ -4102,7 +4276,7 @@
</parameter>
<parameter name="markup">
<parameter_description> marked-up text
-(see &lt;link linkend="PangoMarkupFormat"&gt;markup format&lt;/link&gt;)
+(see <link linkend="PangoMarkupFormat">markup format</link>)
</parameter_description>
</parameter>
<parameter name="length">
@@ -4125,7 +4299,7 @@
<function name="pango_font_metrics_get_strikethrough_position">
<description>
Gets the suggested position to draw the strikethrough.
-The value returned is the distance &lt;emphasis&gt;above&lt;/emphasis&gt; the
+The value returned is the distance <emphasis>above</emphasis> the
baseline of the top of the strikethrough.
@@ -4202,7 +4376,7 @@
<function name="pango_layout_iter_get_run_readonly">
<description>
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
+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.
@@ -4277,7 +4451,7 @@
</description>
<parameters>
<parameter name="bitmap">
-<parameter_description> a &lt;type&gt;FT_Bitmap&lt;/type&gt; to render the line onto
+<parameter_description> a <type>FT_Bitmap</type> to render the line onto
</parameter_description>
</parameter>
<parameter name="line">
@@ -4313,8 +4487,8 @@
this value if the layout contains multiple paragraphs of text.
The default value of -1 means that first line of each paragraph is ellipsized.
This behvaior may be changed in the future to act per layout instead of per
-paragraph. File a bug against pango at &lt;ulink
-url="http://bugzilla.gnome.org/"&gt;http://bugzilla.gnome.org/&lt;/ulink&gt; if your
+paragraph. File a bug against pango at <ulink
+url="http://bugzilla.gnome.org/">http://bugzilla.gnome.org/</ulink> if your
code relies on this behavior.
Height setting only has effect if a positive width is set on
@@ -4352,7 +4526,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> a pointer to the context's default font description.
+<return> a pointer to the context's default font description.
This value must not be modified or freed.
</return>
</function>
@@ -4480,28 +4654,42 @@
<return></return>
</function>
-<function name="pango_context_load_fontset">
+<function name="pango_font_describe_with_absolute_size">
<description>
-Load a set of fonts in the context that can be used to render
-a font matching @desc.
-
+Return value: a newly-allocated #PangoFontDescription object.
</description>
<parameters>
-<parameter name="context">
-<parameter_description> a #PangoContext
+<parameter name="font">
+<parameter_description> a #PangoFont
</parameter_description>
</parameter>
+</parameters>
+<return> a newly-allocated #PangoFontDescription object.
+
+Since: 1.14
+</return>
+</function>
+
+<function name="pango_ot_ruleset_description_copy">
+<description>
+Creates a copy of @desc, which should be freed with
+pango_ot_ruleset_description_free(). Primarily used internally
+by pango_ot_ruleset_get_for_description() to cache rulesets for
+ruleset descriptions.
+
+
+</description>
+<parameters>
<parameter name="desc">
-<parameter_description> a #PangoFontDescription describing the fonts to load
-</parameter_description>
-</parameter>
-<parameter name="language">
-<parameter_description> a #PangoLanguage the fonts will be used for
+<parameter_description> ruleset description to copy
</parameter_description>
</parameter>
</parameters>
-<return> the fontset, or %NULL if no font matched.
+<return> the newly allocated #PangoOTRulesetDescription, which
+should be freed with pango_ot_ruleset_description_free().
+
+Since: 1.18
</return>
</function>
@@ -4610,7 +4798,7 @@
<function name="pango_x_context_set_funcs">
<description>
-Sets the functions that will be used to get GC's in various colors when
+Sets the functions that will be used to get GC's in various colors when
rendering layouts with this context.
</description>
@@ -4648,7 +4836,7 @@
</parameter>
<parameter name="trailing">
<parameter_description> an integer indicating the edge of the grapheme to retrieve
-the position of. If &gt; 0, the trailing edge of the grapheme,
+the position of. If > 0, the trailing edge of the grapheme,
if 0, the leading of the grapheme.
</parameter_description>
</parameter>
@@ -4723,7 +4911,7 @@
</parameter>
</parameters>
<return> %FALSE if skipping the white space leaves
-the position at a '\0' character.
+the position at a '\0' character.
</return>
</function>
@@ -4762,11 +4950,13 @@
%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
+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 pango_language_get_scripts() internally.
+
</description>
<parameters>
@@ -4834,22 +5024,22 @@
<description>
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,
+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 '-'.
+in the tag is '-'.
</description>
<parameters>
<parameter name="language">
<parameter_description> a language tag (see pango_language_from_string()),
-%NULL is allowed and matches nothing but '*'
+%NULL is allowed and matches nothing but '*'
</parameter_description>
</parameter>
<parameter name="range_list">
-<parameter_description> a list of language ranges, separated by ';', ':',
-',', or space characters.
-Each element must either be '*', or a RFC 3066 language range
+<parameter_description> a list of language ranges, separated by ';', ':',
+',', or space characters.
+Each element must either be '*', or a RFC 3066 language range
canonicalized as by pango_language_from_string()
</parameter_description>
</parameter>
@@ -4870,7 +5060,7 @@
</parameter_description>
</parameter>
</parameters>
-<return>
+<return> the renderer.
</return>
</function>
@@ -5027,7 +5217,7 @@
<description>
Computes a hash of a #PangoFontDescription structure suitable
to be used, for example, as an argument to g_hash_table_new().
-The hash value is independent of @desc-&gt;mask.
+The hash value is independent of @desc->mask.
</description>
@@ -5101,7 +5291,7 @@
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
+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).
@@ -5190,7 +5380,7 @@
<description>
Creates a #PangoFontDescription that matches the specified
Fontconfig pattern as closely as possible. Many possible Fontconfig
-pattern values, such as %FC_RASTERIZER or %FC_DPI, don't make sense in
+pattern values, such as %FC_RASTERIZER or %FC_DPI, don't make sense in
the context of #PangoFontDescription, so will be ignored.
@@ -5234,31 +5424,37 @@
</return>
</function>
-<function name="pango_ot_ruleset_description_copy">
+<function name="pango_glyph_item_iter_init_end">
<description>
-Creates a copy of @desc, which should be freed with
-pango_ot_ruleset_description_free(). Primarily used internally
-by pango_ot_ruleset_get_for_description() to cache rulesets for
-ruleset descriptions.
-
+Initializes a #PangoGlyphItemIter structure to point to the
+last cluster in a glyph item.
+See #PangoGlyphItemIter for details of cluster orders.
+
</description>
<parameters>
-<parameter name="desc">
-<parameter_description> ruleset description to copy
+<parameter name="iter">
+<parameter_description> a #PangoGlyphItemIter
+</parameter_description>
+</parameter>
+<parameter name="glyph_item">
+<parameter_description> the glyph item to iterate over
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> text corresponding to the glyph item
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocated #PangoOTRulesetDescription, which
-should be freed with pango_ot_ruleset_description_free().
+<return> %FALSE if there are no clusters in the glyph item
-Since: 1.18
+Since: 1.22
</return>
</function>
<function name="pango_layout_get_lines">
<description>
-Return value: a #GSList containing the lines in the layout. This
+Return value: (element-type Pango.LayoutLine): (transfer none): a #GSList containing
</description>
<parameters>
@@ -5267,9 +5463,9 @@
</parameter_description>
</parameter>
</parameters>
-<return> 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
+<return> (element-type Pango.LayoutLine): (transfer none): 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.
</return>
</function>
@@ -5308,7 +5504,7 @@
<description>
Computes the logical width of the glyph string as can also be computed
using pango_glyph_string_extents(). However, since this only computes the
-width, it's much faster. This is in fact only a convenience function that
+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.
@@ -5328,7 +5524,7 @@
<function name="pango_layout_set_markup">
<description>
Same as pango_layout_set_markup_with_accel(), but
-the markup text isn't scanned for accelerators.
+the markup text isn't scanned for accelerators.
</description>
@@ -5471,9 +5667,9 @@
instance, if a subclass of #PangoRenderer was to add a stipple
option for drawing underlines, it needs to call
-&lt;informalexample&gt;&lt;programlisting&gt;
+<informalexample><programlisting>
pango_renderer_part_changed (render, PANGO_RENDER_PART_UNDERLINE);
-&lt;/programlisting&gt;&lt;/informalexample&gt;
+</programlisting></informalexample>
When the stipple changes or underlines with different stipples
might be joined together. Pango automatically calls this for
@@ -5527,17 +5723,17 @@
<description>
Fill in the fields of a color from a string specification. The
string can either one of a large set of standard names. (Taken
-from the X11 &lt;filename&gt;rgb.txt&lt;/filename&gt; file), or it can be a hex value in the
-form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where
-'r', 'g' and 'b' are hex digits of the red, green, and blue
+from the X11 rgb.txt</filename> file), or it can be a hex value in the
+form '#rgb' '#rrggbb' '#rrrgggbbb' or '#rrrrggggbbbb' where
+'r', 'g' and 'b' are hex digits of the red, green, and blue
components of the color, respectively. (White in the four
-forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')
+forms is '#fff' '#ffffff' '#fffffffff' and '#ffffffffffff')
</description>
<parameters>
<parameter name="color">
-<parameter_description> a #PangoColor structure in which to store the result
+<parameter_description> a #PangoColor structure in which to store the result, or %NULL
</parameter_description>
</parameter>
<parameter name="spec">
@@ -5563,7 +5759,8 @@
</parameter_description>
</parameter>
</parameters>
-<return> a list of all attributes for the current range.
+<return> (element-type Pango.Attribute): (transfer full): a list of
+all attributes for the current range.
To free this value, call pango_attribute_destroy() on
each value and g_slist_free() on the list.
@@ -5711,7 +5908,7 @@
</description>
<parameters>
<parameter name="face">
-<parameter_description> a &lt;type&gt;FT_Face&lt;/type&gt;.
+<parameter_description> a <type>FT_Face</type>.
</parameter_description>
</parameter>
</parameters>
@@ -5905,6 +6102,26 @@
<return></return>
</function>
+<function name="pango_glyph_item_iter_next_cluster">
+<description>
+Advances the iterator to the next cluster in the glyph item.
+See #PangoGlyphItemIter for details of cluster orders.
+
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #PangoGlyphItemIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the iterator was advanced, %FALSE if we were already on the
+last cluster.
+
+Since: 1.22
+</return>
+</function>
+
<function name="pango_x_get_context">
<description>
Retrieves a #PangoContext appropriate for rendering with X fonts on the
@@ -5919,6 +6136,9 @@
</parameter>
</parameters>
<return> the new #PangoContext.
+
+Deprecated: 1.22: Use pango_x_font_map_for_display() followed by
+pango_font_map_create_context() instead.
</return>
</function>
@@ -6094,6 +6314,24 @@
<return></return>
</function>
+<function name="pango_fc_font_key_get_pattern">
+<description>
+Gets the fontconfig pattern member of @key.
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> the font key
+</parameter_description>
+</parameter>
+</parameters>
+<return> the pattern, which is owned by @key and should not be modified.
+
+Since: 1.24
+</return>
+</function>
+
<function name="pango_coverage_set">
<description>
Modify a particular index within @coverage
@@ -6118,7 +6356,7 @@
<function name="pango_fc_font_lock_face">
<description>
-Gets the FreeType &lt;type&gt;FT_Face&lt;/type&gt; associated with a font,
+Gets the FreeType <type>FT_Face</type> associated with a font,
This face will be kept around until you call
pango_fc_font_unlock_face().
@@ -6130,7 +6368,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> the FreeType &lt;type&gt;FT_Face&lt;/type&gt; associated with @font.
+<return> the FreeType <type>FT_Face</type> associated with @font.
Since: 1.4
</return>
@@ -6184,7 +6422,7 @@
</description>
<parameters>
<parameter name="bitmap">
-<parameter_description> a &lt;type&gt;FT_Bitmap&lt;/type&gt; to render the layout onto
+<parameter_description> a <type>FT_Bitmap</type> to render the layout onto
</parameter_description>
</parameter>
<parameter name="layout">
@@ -6221,6 +6459,9 @@
</parameter>
</parameters>
<return> the new #PangoContext.
+
+Deprecated: 1.22: Use pango_xft_get_font_map() followed by
+pango_font_map_create_context() instead.
</return>
</function>
@@ -6272,7 +6513,7 @@
</parameter>
<parameter name="text">
<parameter_description> text that @glyph_item corresponds to
-(glyph_item-&gt;item-&gt;offset is an offset from the
+(glyph_item->item->offset is an offset from the
start of @text)
</parameter_description>
</parameter>
@@ -6339,7 +6580,7 @@
<function name="pango_parse_markup">
<description>
Parses marked-up text (see
-&lt;link linkend="PangoMarkupFormat"&gt;markup format&lt;/link&gt;) to create
+<link linkend="PangoMarkupFormat">markup format</link>) to create
a plain-text string and an attribute list.
If @accel_marker is nonzero, the given character will mark the
@@ -6357,7 +6598,7 @@
</description>
<parameters>
<parameter name="markup_text">
-<parameter_description> markup to parse (see &lt;link linkend="PangoMarkupFormat"&gt;markup format&lt;/link&gt;)
+<parameter_description> markup to parse (see <link linkend="PangoMarkupFormat">markup format</link>)
</parameter_description>
</parameter>
<parameter name="length">
@@ -6460,9 +6701,9 @@
<function name="pango_get_sysconf_subdirectory">
<description>
On Unix, returns the name of the "pango" subdirectory of SYSCONFDIR
-(which is set at compile time). On Win32, returns a subdirectory of
-the Pango installation directory (which is deduced at run time from
-the DLL's location, or stored in the Registry).
+(which is set at compile time). On Windows, returns the etc\pango
+subdirectory of the Pango installation directory (which is deduced
+at run time from the DLL's location).
</description>
@@ -6481,7 +6722,8 @@
default fontmap uses for example. The old default font map
is unreffed and the new font map referenced.
-A value of %NULL for @fontmap will cause a new default font
+A value of %NULL for @fontmap will cause the current default
+font map to be released and a new default font
map to be created on demand, using pango_cairo_font_map_new().
Since: 1.22
@@ -6674,6 +6916,24 @@
<return></return>
</function>
+<function name="pango_fc_fontset_key_get_language">
+<description>
+Gets the language member of @key.
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> the fontset key
+</parameter_description>
+</parameter>
+</parameters>
+<return> the language
+
+Since: 1.24
+</return>
+</function>
+
<function name="_pango_xft_font_get_mini_font">
<description>
Gets the font used for drawing the digits in the
@@ -6717,6 +6977,23 @@
<return></return>
</function>
+<function name="pango_layout_get_text">
+<description>
+Gets the text in the layout. The returned text should not
+be freed or modified.
+
+
+</description>
+<parameters>
+<parameter name="layout">
+<parameter_description> a #PangoLayout
+</parameter_description>
+</parameter>
+</parameters>
+<return> the text in the @layout.
+</return>
+</function>
+
<function name="_pango_fc_font_map_fc_to_coverage">
<description>
Convert the given #FcCharSet into a new #PangoCoverage object. The
@@ -6790,7 +7067,7 @@
</parameter>
</parameters>
<return> the glyph index, or 0, if the Unicode
-character doesn't exist in the font.
+character doesn't exist in the font.
Since: 1.4
</return>
@@ -6831,14 +7108,14 @@
<function name="pango_cairo_context_get_font_options">
<description>
Retrieves any font rendering options previously set with
-pango_cairo_font_map_set_font_options(). This functions not report options
+pango_cairo_font_map_set_font_options(). This function does not report options
that are derived from the target surface by pango_cairo_update_context()
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
</parameters>
@@ -6946,8 +7223,8 @@
<function name="pango_script_iter_get_range">
<description>
Gets information about the range to which @iter currently points.
-The range is the set of locations p where *start &lt;= p &lt; *end.
-(That is, it doesn't include the character stored at *end)
+The range is the set of locations p where *start <= p < *end.
+(That is, it doesn't include the character stored at *end)
Since: 1.4
@@ -7000,7 +7277,7 @@
If the language is not found, sets @language_index to
PANGO_OT_DEFAULT_LANGUAGE and the required feature of the default language
system is returned in required_feature_index. For best compatibility with
-some fonts, also searches the language system tag 'dflt' before falling
+some fonts, also searches the language system tag 'dflt' before falling
back to the default language system, but that is transparent to the user.
The user can simply ignore the return value of this function to
automatically fall back to the default language system.
@@ -7153,7 +7430,7 @@
</parameter_description>
</parameter>
</parameters>
-<return>
+<return> the renderer.
</return>
</function>
@@ -7178,7 +7455,7 @@
<description>
This is a convenience function that creates a #PangoTabArray
and allows you to specify the alignment and position of each
-tab stop. You &lt;emphasis&gt;must&lt;/emphasis&gt; provide an alignment
+tab stop. You <emphasis>must</emphasis> provide an alignment
and position for @size tab stops.
@@ -7259,8 +7536,8 @@
representative of that script. This will usually be the
most widely spoken or used language written in that script:
for instance, the sample language for %PANGO_SCRIPT_CYRILLIC
-is &lt;literal&gt;ru&lt;/literal&gt; (Russian), the sample language
-for %PANGO_SCRIPT_ARABIC is &lt;literal&gt;ar&lt;/literal&gt;.
+is <literal>ru</literal> (Russian), the sample language
+for %PANGO_SCRIPT_ARABIC is <literal>ar</literal>.
For some
scripts, no sample language will be returned because there
@@ -7278,7 +7555,7 @@
will return the first language in the parsed list that Pango
believes may use @script for writing. This last predicate
is tested using pango_language_includes_script(). This can
-be used to control Pango's font selection for non-primary
+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
@@ -7364,6 +7641,8 @@
<return> a new #PangoContext
Since: 1.4
+
+Deprecated: 1.22: Use pango_font_map_create_context() instead.
</return>
</function>
@@ -7436,7 +7715,7 @@
</parameter>
<parameter name="end">
<parameter_description> end index (the range is the set of bytes with
- indices such that start &lt;= index &lt; end)
+ indices such that start <= index < end)
</parameter_description>
</parameter>
<parameter name="font">
@@ -7459,7 +7738,7 @@
<function name="pango_layout_iter_free">
<description>
-Frees an iterator that's no longer in use.
+Frees an iterator that's no longer in use.
</description>
<parameters>
@@ -7520,19 +7799,37 @@
<return></return>
</function>
+<function name="pango_fc_font_key_get_matrix">
+<description>
+Gets the matrix member of @key.
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> the font key
+</parameter_description>
+</parameter>
+</parameters>
+<return> the matrix, which is owned by @key and should not be modified.
+
+Since: 1.24
+</return>
+</function>
+
<function name="pango_ot_tag_to_script">
<description>
Finds the #PangoScript corresponding to @script_tag.
-The 'DFLT' script tag is mapped to %PANGO_SCRIPT_COMMON.
+The 'DFLT' script tag is mapped to %PANGO_SCRIPT_COMMON.
Note that an OpenType script tag may correspond to multiple
#PangoScript values. In such cases, the #PangoScript value
with the smallest value is returned.
In particular, %PANGO_SCRIPT_HIRAGANA
-and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'.
+and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'.
This function will return %PANGO_SCRIPT_HIRAGANA for
-'kana'.
+'kana'.
</description>
@@ -7607,10 +7904,10 @@
components of the transformation are ignored. The calculation of
the returned vector is as follows:
-&lt;programlisting&gt;
+<programlisting>
dx2 = dx1 * xx + dy1 * xy;
dy2 = dx1 * yx + dy1 * yy;
-&lt;/programlisting&gt;
+</programlisting>
Affine transformations are position invariant, so the same vector
always transforms to the same vector. If (@x1,@y1) transforms
@@ -7733,13 +8030,13 @@
</parameter>
<parameter name="line">
<parameter_description> the index of a line, which must be between 0 and
-&lt;literal&gt;pango_layout_get_line_count(layout) - 1&lt;/literal&gt;, inclusive.
+<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
</parameter_description>
</parameter>
</parameters>
<return> 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
+be ref'ed and retained, but will become invalid
if changes are made to the #PangoLayout.
No changes should be made to the line.
@@ -7764,7 +8061,7 @@
</parameter>
<parameter name="trailing">
<parameter_description> an integer indicating the edge of the grapheme to retrieve the
-position of. If 0, the trailing edge of the grapheme, if &gt; 0,
+position of. If 0, the trailing edge of the grapheme, if > 0,
the leading of the grapheme.
</parameter_description>
</parameter>
@@ -7813,7 +8110,7 @@
</description>
<parameters>
<parameter name="size">
-<parameter_description> the font size, in %PANGO_SCALE&lt;!-- --&gt;ths of a device unit.
+<parameter_description> the font size, in %PANGO_SCALE<!-- -->ths of a device unit.
</parameter_description>
</parameter>
</parameters>
@@ -7944,7 +8241,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> the glyph index, or 0 if the glyph isn't
+<return> the glyph index, or 0 if the glyph isn't
covered by the font.
Since: 1.6
@@ -7954,10 +8251,10 @@
<function name="pango_read_line">
<description>
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
+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.
@@ -7975,7 +8272,7 @@
</parameters>
<return> 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 line number counter which doesn't combine lines with '\')
</return>
</function>
@@ -8027,6 +8324,39 @@
</return>
</function>
+<function name="pango_cairo_show_glyph_item">
+<description>
+Draws the glyphs in @glyph_item in the specified cairo context,
+embedding the text associated with the glyphs in the output if the
+output format supports it (PDF for example), otherwise it acts
+similar to pango_cairo_show_glyph_string().
+
+The origin of the glyphs (the left edge of the baseline) will
+be drawn at the current point of the cairo context.
+
+Note that @text is the start of the text for layout, which is then
+indexed by <literal>@glyph_item->item->offset</literal>.
+
+Since: 1.22
+
+</description>
+<parameters>
+<parameter name="cr">
+<parameter_description> a Cairo context
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> the UTF-8 text that @glyph_item refers to
+</parameter_description>
+</parameter>
+<parameter name="glyph_item">
+<parameter_description> a #PangoGlyphItem
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="pango_renderer_draw_layout">
<description>
Draws @layout with the specified #PangoRenderer.
@@ -8083,10 +8413,10 @@
<description>
Converts from an index within a #PangoLayout to the onscreen position
corresponding to the grapheme at that index, which is represented
-as rectangle. Note that &lt;literal&gt;pos-&gt;x&lt;/literal&gt; is always the leading
-edge of the grapheme and &lt;literal&gt;pos-&gt;x + pos-&gt;width&lt;/literal&gt; the trailing
+as rectangle. Note that <literal>pos->x</literal> is always the leading
+edge of the grapheme and <literal>pos->x + pos->width</literal> the trailing
edge of the grapheme. If the directionality of the grapheme is right-to-left,
-then &lt;literal&gt;pos-&gt;width&lt;/literal&gt; will be negative.
+then <literal>pos->width</literal> will be negative.
</description>
<parameters>
@@ -8251,12 +8581,12 @@
<function name="pango_xft_render">
<description>
-Renders a #PangoGlyphString onto an &lt;type&gt;XftDraw&lt;/type&gt; object wrapping an X drawable.
+Renders a #PangoGlyphString onto an <type>XftDraw</type> object wrapping an X drawable.
</description>
<parameters>
<parameter name="draw">
-<parameter_description> the &lt;type&gt;XftDraw&lt;/type&gt; object.
+<parameter_description> the <type>XftDraw</type> object.
</parameter_description>
</parameter>
<parameter name="color">
@@ -8482,33 +8812,33 @@
script, language, or feature indices manually.
In excess to what pango_ot_ruleset_new() does, this function will:
-&lt;itemizedlist&gt;
-&lt;listitem&gt;
+<itemizedlist>
+<listitem>
Find the #PangoOTTag script and language tags associated with
@script and @language using pango_ot_tag_from_script() and
pango_ot_tag_from_language(),
-&lt;/listitem&gt;
-&lt;listitem&gt;
+</listitem>
+<listitem>
For each of table types %PANGO_OT_TABLE_GSUB and %PANGO_OT_TABLE_GPOS,
find the script index of the script tag found and the language
system index of the language tag found in that script system, using
pango_ot_info_find_script() and pango_ot_info_find_language(),
-&lt;/listitem&gt;
-&lt;listitem&gt;
+</listitem>
+<listitem>
For found language-systems, if they have required feature
index, add that feature to the ruleset using
pango_ot_ruleset_add_feature(),
-&lt;/listitem&gt;
-&lt;listitem&gt;
+</listitem>
+<listitem>
Remember found script and language indices for both table types,
and use them in future pango_ot_ruleset_maybe_add_feature() and
pango_ot_ruleset_maybe_add_features().
-&lt;/listitem&gt;
-&lt;/itemizedlist&gt;
+</listitem>
+</itemizedlist>
Because of the way return values of pango_ot_info_find_script() and
pango_ot_info_find_language() are ignored, this function automatically
-finds and uses the 'DFLT' script and the default language-system.
+finds and uses the 'DFLT' script and the default language-system.
</description>
@@ -8671,7 +9001,7 @@
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
+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.
@@ -8742,8 +9072,8 @@
<function name="pango_renderer_get_layout">
<description>
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&lt;!----&gt;() for example.
+Calling this function only makes sense from inside a subclass's
+methods, like in its draw_shape<!---->() for example.
The returned layout should not be modified while still being
rendered.
@@ -8779,7 +9109,7 @@
pango_font_description_set_family_static() using values from
an attribute in the #PangoAttrList associated with the iterator,
so if you plan to keep it around, you must call:
-&lt;literal&gt;pango_font_description_set_family (desc, pango_font_description_get_family (desc))&lt;/literal&gt;.
+<literal>pango_font_description_set_family (desc, pango_font_description_get_family (desc))</literal>.
</parameter_description>
</parameter>
<parameter name="language">
@@ -8788,7 +9118,8 @@
</parameter_description>
</parameter>
<parameter name="extra_attrs">
-<parameter_description> if non-%NULL, location in which to store a list of non-font
+<parameter_description> (element type Pango.Attribute): (transfer full): if non-%NULL,
+location in which to store a list of non-font
attributes at the the current position; only the highest priority
value of each attribute will be added to this list. In order
to free this value, you must call pango_attribute_destroy() on
@@ -8901,7 +9232,7 @@
"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.
+ignored and the '_' characters may be omitted.
</description>
@@ -8967,8 +9298,8 @@
pointer.)
This function first canonicalizes the string by converting it to
-lowercase, mapping '_' to '-', and stripping all characters other
-than letters and '-'.
+lowercase, mapping '_' to '-', and stripping all characters other
+than letters and '-'.
Use pango_language_get_default() if you want to get the #PangoLanguage for
the current locale of the process.
@@ -8992,7 +9323,7 @@
Finds engines in the map that handle the given script. The returned
lists should be freed with g_slist_free, but the engines in the
lists are owned by GLib and will be kept around permanently, so
-they should not be unref'ed.
+they should not be unref'ed.
Since: 1.4
@@ -9084,7 +9415,7 @@
<description>
Return the Unix-style locale string for the language currently in
effect. On Unix systems, this is the return value from
-&lt;literal&gt;setlocale(LC_CTYPE, NULL)&lt;/literal&gt;, and the user can
+<literal>setlocale(LC_CTYPE, NULL)</literal>, and the user can
affect this through the environment variables LC_ALL, LC_CTYPE or
LANG (checked in that order). The locale strings typically is in
the form lang_COUNTRY, where lang is an ISO-639 language code, and
@@ -9092,15 +9423,15 @@
Swedish as written in Finland or pt_BR for Portuguese as written in
Brazil.
-On Windows, the C library doesn't use any such environment
-variables, and setting them won't affect the behavior of functions
+On Windows, the C library doesn't 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.
+either said environment variables or the thread's current locale.
</description>
@@ -9161,7 +9492,7 @@
<function name="pango_font_descriptions_free">
<description>
-Frees a list of font descriptions from pango_font_map_list_fonts()
+Frees an array of font descriptions.
</description>
<parameters>
@@ -9340,6 +9671,23 @@
<return></return>
</function>
+<function name="pango_fc_font_unlock_face">
+<description>
+Releases a font previously obtained with
+pango_fc_font_lock_face().
+
+Since: 1.4
+
+</description>
+<parameters>
+<parameter name="font">
+<parameter_description> a #PangoFcFont.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
<function name="pango_attr_background_new">
<description>
Create a new background color attribute.
@@ -9371,9 +9719,6 @@
(see pango_ft2_fontmap_get_for_display()) and sets the resolution
for the default fontmap to @dpi_x by @dpi_y.
-Use of this function is deprecated; see pango_ft2_fontmap_create_context()
-instead.
-
</description>
<parameters>
@@ -9387,6 +9732,8 @@
</parameter>
</parameters>
<return> the new #PangoContext
+
+Deprecated: 1.22: Use pango_font_map_create_context() instead.
</return>
</function>
@@ -9408,7 +9755,7 @@
<function name="pango_xft_font_lock_face">
<description>
-Gets the FreeType &lt;type&gt;FT_Face&lt;/type&gt; associated with a font,
+Gets the FreeType <type>FT_Face</type> associated with a font,
This face will be kept around until you call
pango_xft_font_unlock_face().
@@ -9422,7 +9769,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> the FreeType &lt;type&gt;FT_Face&lt;/type&gt; associated with @font.
+<return> the FreeType <type>FT_Face</type> associated with @font.
Since: 1.2
</return>
@@ -9431,7 +9778,7 @@
<function name="pango_x_load_font">
<description>
Loads up a logical font based on a "fontset" style text
-specification. This is not remotely useful (Pango API's generally
+specification. This is not remotely useful (Pango API's generally
work in terms of #PangoFontDescription) and the result may not
work correctly in all circumstances. Use of this function should
be avoided.
@@ -9444,7 +9791,7 @@
</parameter_description>
</parameter>
<parameter name="spec">
-<parameter_description> a comma-separated list of XLFD's.
+<parameter_description> a comma-separated list of XLFD's.
</parameter_description>
</parameter>
</parameters>
@@ -9761,21 +10108,22 @@
<return></return>
</function>
-<function name="pango_fc_font_unlock_face">
+<function name="pango_fc_fontset_key_get_matrix">
<description>
-Releases a font previously obtained with
-pango_fc_font_lock_face().
+Gets the matrix member of @key.
-Since: 1.4
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #PangoFcFont.
+<parameter name="key">
+<parameter_description> the fontset key
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> the matrix, which is owned by @key and should not be modified.
+
+Since: 1.24
+</return>
</function>
<function name="pango_tab_array_get_tab">
@@ -9862,6 +10210,24 @@
<return></return>
</function>
+<function name="pango_fc_fontset_key_get_context_key">
+<description>
+Gets the context key member of @key.
+
+
+</description>
+<parameters>
+<parameter name="key">
+<parameter_description> the font key
+</parameter_description>
+</parameter>
+</parameters>
+<return> the context key, which is owned by @key and should not be modified.
+
+Since: 1.24
+</return>
+</function>
+
<function name="pango_font_description_get_family">
<description>
Gets the family name field of a font description. See
@@ -9901,7 +10267,7 @@
all fonts open for the fontmap as dead. (See the shutdown()
virtual function of #PangoFcFont.) This function might be used
by a backend when the underlying windowing system for the font
-map exits. This function is only intended to be called from
+map exits. This function is only intended to be called
only for backend implementations deriving from #PangoFcFontmap.
Since: 1.4
@@ -9916,6 +10282,34 @@
<return></return>
</function>
+<function name="pango_glyph_item_iter_init_start">
+<description>
+Initializes a #PangoGlyphItemIter structure to point to the
+first cluster in a glyph item.
+See #PangoGlyphItemIter for details of cluster orders.
+
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #PangoGlyphItemIter
+</parameter_description>
+</parameter>
+<parameter name="glyph_item">
+<parameter_description> the glyph item to iterate over
+</parameter_description>
+</parameter>
+<parameter name="text">
+<parameter_description> text corresponding to the glyph item
+</parameter_description>
+</parameter>
+</parameters>
+<return> %FALSE if there are no clusters in the glyph item
+
+Since: 1.22
+</return>
+</function>
+
<function name="pango_itemize">
<description>
Breaks a piece of text into segments with consistent
@@ -9948,7 +10342,7 @@
<parameter name="length">
<parameter_description> the number of bytes (not characters) to process
after @start_index.
-This must be &gt;= 0.
+This must be >= 0.
</parameter_description>
</parameter>
<parameter name="attrs">
@@ -10103,7 +10497,7 @@
face name in the LOGFONTW struct to system codepage fails, the
returned LOGFONTA will have an emppty face name. To get the
LOGFONTW of a PangoFont, use pango_win32_font_logfontw(). It
-is recommended to do that always even if you don't expect
+is recommended to do that always even if you don't expect
to come across fonts with odd names.
@@ -10174,7 +10568,7 @@
</parameters>
<return> the best engine, if one is listed for the script,
or %NULL. The lookup may cause the engine to be loaded;
-once an engine is loaded, it won't be unloaded. If multiple
+once an engine is loaded, it won't be unloaded. If multiple
engines are exact for the script, the choice of which is
returned is arbitrary.
</return>
@@ -10397,7 +10791,7 @@
<function name="pango_get_mirror_char">
<description>
If @ch has the Unicode mirrored property and there is another Unicode
-character that typically has a glyph that is the mirror image of @ch's
+character that typically has a glyph that is the mirror image of @ch's
glyph, puts that character in the address pointed to by @mirrored_ch.
Use g_unichar_get_mirror_char() instead; the docs for that function
@@ -10443,23 +10837,6 @@
<return></return>
</function>
-<function name="_pango_glyph_item_iter_next_cluster">
-<description>
-Advances the iterator to the next cluster in the glyph item.
-
-
-</description>
-<parameters>
-<parameter name="iter">
-<parameter_description> a #PangoGlyphItemIter
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the iterator was advanced, %FALSE if we were already on the
-last cluster.
-</return>
-</function>
-
<function name="pango_font_description_get_stretch">
<description>
Gets the stretch field of a font description.
@@ -10632,7 +11009,7 @@
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
+oversight, stored return values that wouldn't fit into
a signed integer are clamped to %G_MAXINT.
</description>
@@ -10653,32 +11030,6 @@
<return></return>
</function>
-<function name="_pango_glyph_item_iter_init_end">
-<description>
-Initializes a #PangoGlyphItemIter structure to point to the
-last cluster in a glyph item.
-
-
-</description>
-<parameters>
-<parameter name="iter">
-<parameter_description> pointer to a #PangoGlyphItemIter structure
-</parameter_description>
-</parameter>
-<parameter name="glyph_item">
-<parameter_description> the glyph item that @iter points into
-</parameter_description>
-</parameter>
-<parameter name="text">
-<parameter_description> text corresponding to the glyph item
-</parameter_description>
-</parameter>
-</parameters>
-<return> %FALSE if there are no clusters in the glyph item;
-in this case, the state of @iter is undefined.
-</return>
-</function>
-
<function name="pango_x_font_cache_unload">
<description>
Frees a font structure previously loaded with pango_x_font_cache_load().
@@ -10829,7 +11180,7 @@
<function name="_pango_layout_line_ellipsize">
<description>
Given a #PangoLayoutLine with the runs still in logical order, ellipsize
-it according the layout's policy to fit within the set width of the layout.
+it according the layout's policy to fit within the set width of the layout.
</description>
@@ -10903,10 +11254,12 @@
<return></return>
</function>
-<function name="pango_layout_get_single_paragraph_mode">
+<function name="pango_layout_context_changed">
<description>
-Obtains the value set by pango_layout_set_single_paragraph_mode().
-
+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.
</description>
<parameters>
@@ -10915,9 +11268,7 @@
</parameter_description>
</parameter>
</parameters>
-<return> %TRUE if the layout does not break paragraphs at
-paragraph separator characters, %FALSE otherwise.
-</return>
+<return></return>
</function>
<function name="pango_cairo_context_get_resolution">
@@ -10928,7 +11279,7 @@
</description>
<parameters>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
</parameters>
@@ -11015,19 +11366,18 @@
<function name="pango_context_new">
<description>
-Creates a new #PangoContext initialized to default value.
+Creates a new #PangoContext initialized to default values.
-This function is only useful when implementing a new backend
-for Pango, something applications won't do. You should use
-the context creation function for the backend you are using,
-for example, pango_cairo_font_map_create_context(), pango_xft_get_context(),
-pango_win32_get_context() or, pango_ft2_font_map_create_context().
+This function is not particularly useful as it should always
+be followed by a pango_context_set_font_map() call, and the
+function pango_font_map_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 ways of create a #PangoContext.
+that system may have it's own way of create a #PangoContext.
For instance, the GTK+ toolkit has, among others,
gdk_pango_context_get_for_screen(), and
-gtk_widget_get_pango_context().
+gtk_widget_get_pango_context(). Use those instead.
</description>
@@ -11063,7 +11413,7 @@
<parameter name="length">
<parameter_description> the number of bytes (not characters) to process
after @start_index.
-This must be &gt;= 0.
+This must be >= 0.
</parameter_description>
</parameter>
<parameter name="base_dir">
@@ -11089,7 +11439,7 @@
<function name="pango_xft_picture_render">
<description>
-Renders a #PangoGlyphString onto an Xrender &lt;type&gt;Picture&lt;/type&gt; object.
+Renders a #PangoGlyphString onto an Xrender <type>Picture</type> object.
</description>
<parameters>
@@ -11156,10 +11506,11 @@
</parameter_description>
</parameter>
<parameter name="ranges">
-<parameter_description> location to store a pointer to an array of ranges.
-The array will be of length &lt;literal&gt;2*n_ranges&lt;/literal&gt;,
-with each range starting at &lt;literal&gt;(*ranges)[2*n]&lt;/literal&gt;
-and of width &lt;literal&gt;(*ranges)[2*n + 1] - (*ranges)[2*n]&lt;/literal&gt;.
+<parameter_description> (out): (array length=n_ranges): (transfer=full):
+location to store a pointer to an array of ranges.
+The array will be of length <literal>2*n_ranges</literal>,
+with each range starting at <literal>(*ranges)[2*n]</literal>
+and of width <literal>(*ranges)[2*n + 1] - (*ranges)[2*n]</literal>.
This array must be freed with g_free(). The coordinates are relative
to the layout and are in Pango units.
</parameter_description>
@@ -11287,25 +11638,30 @@
<return></return>
</function>
-<function name="pango_font_metrics_get_underline_position">
+<function name="pango_win32_font_description_from_logfontw">
<description>
-Gets the suggested position to draw the underline.
-The value returned is the distance &lt;emphasis&gt;above&lt;/emphasis&gt; the
-baseline of the top of the underline. Since most fonts have
-underline positions beneath the baseline, this value is typically
-negative.
+Creates a #PangoFontDescription that matches the specified LOGFONTW.
+
+The face name, italicness and weight fields in the LOGFONTW are used
+to set up the resulting #PangoFontDescription. If the face name in
+the LOGFONTW contains non-ASCII characters the font is temporarily
+loaded (using CreateFontIndirect()) and an ASCII (usually English)
+name for it is looked up from the font name tables in the font
+data. If that doesn't work, the face name is converted from UTF-16
+to UTF-8 and that is used.
</description>
<parameters>
-<parameter name="metrics">
-<parameter_description> a #PangoFontMetrics structure
+<parameter name="lfp">
+<parameter_description> a LOGFONTW
</parameter_description>
</parameter>
</parameters>
-<return> the suggested underline position, in Pango units.
+<return> the newly allocated #PangoFontDescription, which
+should be freed using pango_font_description_free()
-Since: 1.6
+Since: 1.16
</return>
</function>
@@ -11355,7 +11711,7 @@
<description>
Checks @ch to see if it is a character that should not be
normally rendered on the screen. This includes all Unicode characters
-with "ZERO WIDTH" in their name, as well as &lt;firstterm&gt;bidi&lt;/firstterm&gt; formatting characters, and
+with "ZERO WIDTH" in their name, as well as <firstterm>bidi</firstterm> formatting characters, and
a few other ones. This is totally different from g_unichar_iszerowidth()
and is at best misnamed.
@@ -11390,15 +11746,63 @@
</return>
</function>
+<function name="pango_glyph_item_iter_prev_cluster">
+<description>
+Moves the iterator to the preceding cluster in the glyph item.
+See #PangoGlyphItemIter for details of cluster orders.
+
+
+</description>
+<parameters>
+<parameter name="iter">
+<parameter_description> a #PangoGlyphItemIter
+</parameter_description>
+</parameter>
+</parameters>
+<return> %TRUE if the iterator was moved, %FALSE if we were already on the
+first cluster.
+
+Since: 1.22
+</return>
+</function>
+
+<function name="pango_glyph_item_iter_copy">
+<description>
+Make a shallow copy of an existing #PangoGlyphItemIter structure.
+
+
+</description>
+<parameters>
+<parameter name="orig">
+<parameter_description> a #PangoGlyphItemIter, may be %NULL
+</parameter_description>
+</parameter>
+</parameters>
+<return> the newly allocated #PangoGlyphItemIter, which should
+be freed with pango_glyph_item_iter_free(), or %NULL
+if @orig was %NULL.
+
+Since: 1.22
+</return>
+</function>
+
<function name="pango_font_get_font_map">
<description>
Gets the font map for which the font was created.
+Note that the font maintains a <firstterm>weak</firstterm> 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.
+
</description>
<parameters>
<parameter name="font">
-<parameter_description> a #PangoFont
+<parameter_description> a #PangoFont, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -11430,7 +11834,7 @@
Updates a #PangoContext previously created for use with Cairo to
match the current transformation and target surface of a Cairo
context. If any layouts have been created for the context,
-it's necessary to call pango_layout_context_changed() on those
+it's necessary to call pango_layout_context_changed() on those
layouts.
Since: 1.10
@@ -11442,7 +11846,7 @@
</parameter_description>
</parameter>
<parameter name="context">
-<parameter_description> a #PangoContext, from pango_cairo_font_map_create_context()
+<parameter_description> a #PangoContext, from a pangocairo font map
</parameter_description>
</parameter>
</parameters>
@@ -11572,7 +11976,7 @@
<description>
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
+the current line. A line's range includes the line's logical
extents, plus half of the spacing above and below the line, if
pango_layout_set_spacing() has been called to set layout spacing.
The Y positions are in layout coordinates (origin at top left of the
@@ -11719,7 +12123,7 @@
<function name="pango_layout_iter_get_line_extents">
<description>
Obtains the extents of the current line. @ink_rect or @logical_rect
-can be %NULL if you aren't interested in them. Extents are in layout
+can be %NULL if you aren't interested in them. 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
@@ -11856,12 +12260,12 @@
The %PANGO_SCRIPT_COMMON, %PANGO_SCRIPT_INHERITED, and
%PANGO_SCRIPT_UNKNOWN scripts are mapped to the OpenType
-'DFLT' script tag that is also defined as
+'DFLT' script tag that is also defined as
%PANGO_OT_TAG_DEFAULT_SCRIPT.
Note that multiple #PangoScript values may map to the same
OpenType script tag. In particular, %PANGO_SCRIPT_HIRAGANA
-and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'.
+and %PANGO_SCRIPT_KATAKANA both map to the OT tag 'kana'.
</description>
@@ -11904,12 +12308,10 @@
<return></return>
</function>
-<function name="pango_layout_context_changed">
+<function name="pango_layout_get_single_paragraph_mode">
<description>
-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.
+Obtains the value set by pango_layout_set_single_paragraph_mode().
+
</description>
<parameters>
@@ -11918,7 +12320,9 @@
</parameter_description>
</parameter>
</parameters>
-<return></return>
+<return> %TRUE if the layout does not break paragraphs at
+paragraph separator characters, %FALSE otherwise.
+</return>
</function>
<function name="pango_layout_set_tabs">
@@ -11935,7 +12339,7 @@
</parameter_description>
</parameter>
<parameter name="tabs">
-<parameter_description> a #PangoTabArray
+<parameter_description> a #PangoTabArray, or %NULL
</parameter_description>
</parameter>
</parameters>
@@ -11959,30 +12363,25 @@
</return>
</function>
-<function name="pango_win32_font_description_from_logfontw">
+<function name="pango_font_metrics_get_underline_position">
<description>
-Creates a #PangoFontDescription that matches the specified LOGFONTW.
-
-The face name, italicness and weight fields in the LOGFONTW are used
-to set up the resulting #PangoFontDescription. If the face name in
-the LOGFONTW contains non-ASCII characters the font is temporarily
-loaded (using CreateFontIndirect()) and an ASCII (usually English)
-name for it is looked up from the font name tables in the font
-data. If that doesn't work, the face name is converted from UTF-16
-to UTF-8 and that is used.
+Gets the suggested position to draw the underline.
+The value returned is the distance <emphasis>above</emphasis> the
+baseline of the top of the underline. Since most fonts have
+underline positions beneath the baseline, this value is typically
+negative.
</description>
<parameters>
-<parameter name="lfp">
-<parameter_description> a LOGFONTW
+<parameter name="metrics">
+<parameter_description> a #PangoFontMetrics structure
</parameter_description>
</parameter>
</parameters>
-<return> the newly allocated #PangoFontDescription, which
-should be freed using pango_font_description_free()
+<return> the suggested underline position, in Pango units.
-Since: 1.16
+Since: 1.6
</return>
</function>
@@ -12027,31 +12426,39 @@
</parameter>
<parameter name="line">
<parameter_description> the index of a line, which must be between 0 and
-&lt;literal&gt;pango_layout_get_line_count(layout) - 1&lt;/literal&gt;, inclusive.
+<literal>pango_layout_get_line_count(layout) - 1</literal>, inclusive.
</parameter_description>
</parameter>
</parameters>
<return> 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
+be ref'ed and retained, but will become invalid
if changes are made to the #PangoLayout.
</return>
</function>
-<function name="pango_font_describe_with_absolute_size">
+<function name="pango_context_load_fontset">
<description>
-Return value: a newly-allocated #PangoFontDescription object.
+Load a set of fonts in the context that can be used to render
+a font matching @desc.
+
</description>
<parameters>
-<parameter name="font">
-<parameter_description> a #PangoFont
+<parameter name="context">
+<parameter_description> a #PangoContext
+</parameter_description>
+</parameter>
+<parameter name="desc">
+<parameter_description> a #PangoFontDescription describing the fonts to load
+</parameter_description>
+</parameter>
+<parameter name="language">
+<parameter_description> a #PangoLanguage the fonts will be used for
</parameter_description>
</parameter>
</parameters>
-<return> a newly-allocated #PangoFontDescription object.
-
-Since: 1.14
+<return> the fontset, or %NULL if no font matched.
</return>
</function>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
