summaryrefslogtreecommitdiff
path: root/docs/tmpl
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>2001-09-18 20:05:20 +0000
committerOwen Taylor <otaylor@src.gnome.org>2001-09-18 20:05:20 +0000
commita49e070d24242c0297e6325587c4bc135e13e26c (patch)
tree0510d066cc185e9d0b1b736736da5266d259878e /docs/tmpl
parent39f3626e34e0522e0bdec591f6c0334307d39625 (diff)
downloadpango-a49e070d24242c0297e6325587c4bc135e13e26c.tar.gz
Up to 0.19.
Tue Sep 18 15:47:08 2001 Owen Taylor <otaylor@redhat.com> * configure.in (PANGO_MINOR_VERSION): Up to 0.19. * pango/pango-font.h pango/pango-fontmap.[ch] pango/fonts.c pango/pangoxft-fontmap.c pango/pangoft-fontmap.c pango/pango-context.[ch] pango/pangox-fontmap.c: Add new PangoFontFace and PangoFontFamily object types, and change the font listing API to list faces and families, instead of face names and font descriptions. * pango/pango-font.h pango/fonts.c: Make PangoFontDescription an opaque heap-allocated structure, add accessors and convenience functions. * pango/pango-font.h pango/pango-private.h: Make PangoFontMetrics heap allocated, protect the structure definition with #ifdef PANGO_ENABLE_BACKEND, and add getters for the fields. * pango/pango-attributes.[ch] ( pango_attr_iterator_get_font): instead of providing a base font description and one to fill in, provide a single font description to modify based on the attributes. * pango/pango-attributes.[ch]: Fix PangoAttrFontDesc to have a PangoFontDescription by reference, not by value. * pango/pango-utils.[ch]: make pango_parse_style() and friends take pointers to individual enumerations instead of to a PangoFontDescription structure. * pango/*.c: Fix for the PangoFontDescription and PangoFontMetrics changes. * pango/pango-{break,engine,indic,ot,xft}.h pango/Makefile.am pango/opentype/Makefile.am: Protect portions with PANGO_ENABLE_ENGINE to shrink the public API. * modules/*/Makefile.am: -DPANGO_ENABLE_ENGINE. * pango/{pangox.h,pangox-private.h} modules/basic/basic-x.c: Move pango_x_font_get_unknown_glyph() into public header since it is used from modules. * pango/pango-{context,font,fontmap,modules.utils}.h pango/Makefile.am: Protect portions with PANGO_ENABLE_BACKEND to shrink the public API. * pango/*.h: Use G_BEGIN/END_DECLS * examples/viewer-qt.[cc,h]: Fix for changes to font listing API, PangoFontDescription. * pango/pango-indic.h modules/indic/*: Since we install this header fix it up to Pango conventions, namespece ZERO_WIDTH_JOINER, ZERO_WIDTH_NON_JOINER. * docs/pango-sections.txt: Updated.
Diffstat (limited to 'docs/tmpl')
-rw-r--r--docs/tmpl/fonts.sgml450
-rw-r--r--docs/tmpl/glyphs.sgml16
-rw-r--r--docs/tmpl/main.sgml62
-rw-r--r--docs/tmpl/pango-indic.sgml72
-rw-r--r--docs/tmpl/tab-stops.sgml7
-rw-r--r--docs/tmpl/text-attributes.sgml72
-rw-r--r--docs/tmpl/win32-fonts.sgml29
7 files changed, 504 insertions, 204 deletions
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index 4efada71..cd2cdd55 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -27,12 +27,13 @@ what fonts are available on the system and also for specifying
the characteristics of a font to load.
</para>
-@family_name: the name of the font family.
-@style: the style (slant) of the font.
-@variant: the variant (normal or small caps) of the font.
-@weight: the weight (boldness) of the font.
-@stretch: the relative width of the font.
-@size:
+
+<!-- ##### MACRO PANGO_TYPE_FONT_DESCRIPTION ##### -->
+<para>
+
+</para>
+
+
<!-- ##### ENUM PangoStyle ##### -->
<para>
@@ -108,6 +109,33 @@ within a family.
+<!-- ##### ENUM PangoFontMask ##### -->
+<para>
+
+</para>
+
+@PANGO_FONT_MASK_FAMILY:
+@PANGO_FONT_MASK_STYLE:
+@PANGO_FONT_MASK_VARIANT:
+@PANGO_FONT_MASK_WEIGHT:
+@PANGO_FONT_MASK_STRETCH:
+@PANGO_FONT_MASK_SIZE:
+
+<!-- ##### MACRO PANGO_TYPE_FONT_MASK ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION pango_font_description_new ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
<!-- ##### FUNCTION pango_font_description_copy ##### -->
<para>
@@ -117,6 +145,24 @@ within a family.
@Returns:
+<!-- ##### FUNCTION pango_font_description_copy_static ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_hash ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
<!-- ##### FUNCTION pango_font_description_equal ##### -->
<para>
@@ -127,6 +173,14 @@ within a family.
@Returns:
+<!-- ##### FUNCTION pango_font_description_free ##### -->
+<para>
+
+</para>
+
+@desc:
+
+
<!-- ##### FUNCTION pango_font_descriptions_free ##### -->
<para>
@@ -136,12 +190,170 @@ within a family.
@n_descs:
-<!-- ##### FUNCTION pango_font_description_free ##### -->
+<!-- ##### FUNCTION pango_font_description_set_family ##### -->
+<para>
+
+</para>
+
+@desc:
+@family:
+
+
+<!-- ##### FUNCTION pango_font_description_set_family_static ##### -->
+<para>
+
+</para>
+
+@desc:
+@family:
+
+
+<!-- ##### FUNCTION pango_font_description_get_family ##### -->
<para>
</para>
@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_set_style ##### -->
+<para>
+
+</para>
+
+@desc:
+@style:
+
+
+<!-- ##### FUNCTION pango_font_description_get_style ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_set_variant ##### -->
+<para>
+
+</para>
+
+@desc:
+@variant:
+
+
+<!-- ##### FUNCTION pango_font_description_get_variant ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_set_weight ##### -->
+<para>
+
+</para>
+
+@desc:
+@weight:
+
+
+<!-- ##### FUNCTION pango_font_description_get_weight ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_set_stretch ##### -->
+<para>
+
+</para>
+
+@desc:
+@stretch:
+
+
+<!-- ##### FUNCTION pango_font_description_get_stretch ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_set_size ##### -->
+<para>
+
+</para>
+
+@desc:
+@size:
+
+
+<!-- ##### FUNCTION pango_font_description_get_size ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_get_set_fields ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_unset_fields ##### -->
+<para>
+
+</para>
+
+@desc:
+@to_unset:
+
+
+<!-- ##### FUNCTION pango_font_description_merge ##### -->
+<para>
+
+</para>
+
+@desc:
+@desc_to_merge:
+@replace_existing:
+
+
+<!-- ##### FUNCTION pango_font_description_merge_static ##### -->
+<para>
+
+</para>
+
+@desc:
+@desc_to_merge:
+@replace_existing:
+
+
+<!-- ##### FUNCTION pango_font_description_better_match ##### -->
+<para>
+
+</para>
+
+@desc:
+@old_match:
+@new_match:
+@Returns:
<!-- ##### FUNCTION pango_font_description_from_string ##### -->
@@ -171,6 +383,70 @@ within a family.
@Returns:
+<!-- ##### STRUCT PangoFontMetrics ##### -->
+<para>
+
+</para>
+
+@ref_count:
+@ascent:
+@descent:
+@approximate_char_width:
+@approximate_digit_width:
+
+<!-- ##### FUNCTION pango_font_metrics_ref ##### -->
+<para>
+
+</para>
+
+@metrics:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_metrics_unref ##### -->
+<para>
+
+</para>
+
+@metrics:
+
+
+<!-- ##### FUNCTION pango_font_metrics_get_ascent ##### -->
+<para>
+
+</para>
+
+@metrics:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_metrics_get_descent ##### -->
+<para>
+
+</para>
+
+@metrics:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_metrics_get_approximate_char_width ##### -->
+<para>
+
+</para>
+
+@metrics:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_metrics_get_approximate_digit_width ##### -->
+<para>
+
+</para>
+
+@metrics:
+@Returns:
+
+
<!-- ##### STRUCT PangoFont ##### -->
<para>
The #PangoFont structure is used to represent
@@ -190,55 +466,6 @@ which the implementation fills in:
@parent_instance:
-<!-- ##### STRUCT PangoFontClass ##### -->
-<para>
-The #PangoFontClass structure contains the virtual
-functions for an implementation of a PangoFont.
-
-It contains the following members:
-
-<informaltable pgwide=1 frame="none" role="struct">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-
-<row>
-<entry>void (*destroy) (#PangoFont *font);</entry>
-<entry>a function to free the font structure and associated resources.</entry>
-</row>
-</tbody></tgroup></informaltable>
-</para>
-
-@parent_class:
-@describe: a function to describe the characteristics of a font. See
- pango_font_describe().
-@get_coverage: A function to get a coverage map for the font.
- See pango_font_get_coverage().
-@find_shaper: A function to find the shaper for a particular character
- point. See pango_font_find_shaper().
-@get_glyph_extents: A function called to find out the logical and ink
- extents of a glyph within the fonts. See
- pango_font_get_glyph_extents().
-@get_metrics: A function called to find the overall metric information
- for the font or the metric information appropriate to
- a particular language. See pango_font_get_metrics().
-
-<!-- ##### STRUCT PangoFontMetrics ##### -->
-<para>
-The #PangoFontMetrics structure represents the overall metrics for
-a font. It contains the following members:
-</para>
-
-@ascent: the logical extent of the font upwards from the baseline.
- The spacing between lines of text should be calculated
- as @ascent + @descent. Individual characters may have
- extents exceeding this value.
-@descent: the logical extent of the font beneath the baseline.
- The spacing between lines of text should be calculated
- as @ascent + @descent. Individual characters may have
- extents exceeding this value.
-@approximate_char_width:
-@approximate_digit_width:
-
<!-- ##### FUNCTION pango_font_find_shaper ##### -->
<para>
@@ -292,8 +519,9 @@ a font. It contains the following members:
@font:
@language:
-@metrics:
+@Returns:
<!-- # Unused Parameters # -->
+@metrics:
@lang:
@@ -320,35 +548,100 @@ a font. It contains the following members:
@object:
-<!-- ##### MACRO PANGO_FONT_CLASS ##### -->
+<!-- ##### STRUCT PangoFontFamily ##### -->
<para>
</para>
-@klass:
+@parent_instance:
+
+<!-- ##### MACRO PANGO_TYPE_FONT_FAMILY ##### -->
+<para>
+
+</para>
-<!-- ##### MACRO PANGO_IS_FONT_CLASS ##### -->
+
+<!-- ##### MACRO PANGO_FONT_FAMILY ##### -->
<para>
</para>
-@klass:
+@object:
-<!-- ##### MACRO PANGO_FONT_GET_CLASS ##### -->
+<!-- ##### MACRO PANGO_IS_FONT_FAMILY ##### -->
<para>
</para>
-@obj:
+@object:
+
+
+<!-- ##### FUNCTION pango_font_family_get_name ##### -->
+<para>
+
+</para>
+
+@family:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_family_list_faces ##### -->
+<para>
+
+</para>
+
+@family:
+@faces:
+@n_faces:
+
+
+<!-- ##### STRUCT PangoFontFace ##### -->
+<para>
+
+</para>
+
+@parent_instance:
+
+<!-- ##### MACRO PANGO_TYPE_FONT_FACE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO PANGO_FONT_FACE ##### -->
+<para>
+
+</para>
+
+@object:
-<!-- ##### FUNCTION pango_font_get_type ##### -->
+<!-- ##### MACRO PANGO_IS_FONT_FACE ##### -->
<para>
</para>
+@object:
+
+
+<!-- ##### FUNCTION pango_font_face_get_face_name ##### -->
+<para>
+
+</para>
+
+@face:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_face_describe ##### -->
+<para>
+
+</para>
+
+@face:
@Returns:
@@ -378,7 +671,6 @@ a particular #PangoFontMap implementation.
@parent_class:
@load_font: a function to load a font with a given description. See
pango_font_map_load_font()
-@list_fonts: A function to list available fonts. See pango_font_map_list_fonts()
@list_families: A function to list available font families. See
pango_font_map_list_families().
@@ -404,26 +696,6 @@ a particular #PangoFontMap implementation.
@n_families:
-<!-- ##### FUNCTION pango_font_map_free_families ##### -->
-<para>
-
-</para>
-
-@families:
-@n_families:
-
-
-<!-- ##### FUNCTION pango_font_map_list_fonts ##### -->
-<para>
-
-</para>
-
-@fontmap:
-@family:
-@descs:
-@n_descs:
-
-
<!-- ##### MACRO PANGO_TYPE_FONT_MAP ##### -->
<para>
@@ -471,11 +743,3 @@ a particular #PangoFontMap implementation.
@obj:
-<!-- ##### FUNCTION pango_font_map_get_type ##### -->
-<para>
-
-</para>
-
-@Returns:
-
-
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index f6a4969d..079696c4 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -239,6 +239,13 @@ accessible fields
@glyphs:
@log_clusters:
+<!-- ##### MACRO PANGO_TYPE_GLYPH_STRING ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### FUNCTION pango_glyph_string_new ##### -->
<para>
@@ -247,6 +254,15 @@ accessible fields
@Returns:
+<!-- ##### FUNCTION pango_glyph_string_copy ##### -->
+<para>
+
+</para>
+
+@string:
+@Returns:
+
+
<!-- ##### FUNCTION pango_glyph_string_set_size ##### -->
<para>
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index e9fc6b12..1e0950f0 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -117,36 +117,6 @@ fields:
@language:
@extra_attrs:
-<!-- ##### STRUCT PangoLangRange ##### -->
-<para>
-The #PangoLangRange structure stores language tagging
-information for a range of character positions of text.
-It contains the following fields:
-
-<informaltable pgwide=1 frame="none" role="struct">
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
-<tbody>
-
-<row>
-<entry>gint start;</entry>
-<entry>the start position of this tagged range in bytes.</entry>
-</row>
-
-<row>
-<entry>gint length;</entry>
-<entry>the length of this tagged range in bytes.</entry>
-</row>
-
-<row>
-<entry>gchar *lang;</entry>
-<entry>the language for this range, in the standard form
- "fr" or "fr_FR".</entry>
-</row>
-
-</tbody></tgroup></informaltable>
-</para>
-
-
<!-- ##### ENUM PangoDirection ##### -->
<para>
The #PangoDirection type represents the direction of writing
@@ -266,6 +236,24 @@ for text.
@desc:
+<!-- ##### FUNCTION pango_context_get_language ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_context_set_language ##### -->
+<para>
+
+</para>
+
+@context:
+@language:
+
+
<!-- ##### FUNCTION pango_context_get_base_dir ##### -->
<para>
@@ -296,25 +284,25 @@ for text.
@size:
-<!-- ##### FUNCTION pango_context_list_families ##### -->
+<!-- ##### FUNCTION pango_context_get_metrics ##### -->
<para>
</para>
@context:
-@families:
-@n_families:
+@desc:
+@language:
+@Returns:
-<!-- ##### FUNCTION pango_context_list_fonts ##### -->
+<!-- ##### FUNCTION pango_context_list_families ##### -->
<para>
</para>
@context:
-@family:
-@descs:
-@n_descs:
+@families:
+@n_families:
<!-- ##### FUNCTION pango_break ##### -->
diff --git a/docs/tmpl/pango-indic.sgml b/docs/tmpl/pango-indic.sgml
index 24c5fae3..cddc77f9 100644
--- a/docs/tmpl/pango-indic.sgml
+++ b/docs/tmpl/pango-indic.sgml
@@ -14,75 +14,3 @@ Indic Engine Support
</para>
-<!-- ##### MACRO ZERO_WIDTH_NON_JOINER ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### MACRO ZERO_WIDTH_JOINER ##### -->
-<para>
-
-</para>
-
-
-
-<!-- ##### STRUCT PangoIndicScript ##### -->
-<para>
-
-</para>
-
-@name:
-@is_prefixing_vowel:
-@is_vowel_sign:
-@vowel_sign_to_matra:
-@is_vowel_half:
-@vowel_split:
-
-<!-- ##### FUNCTION pango_indic_shift_vowels ##### -->
-<para>
-
-</para>
-
-@script:
-@chars:
-@end:
-
-
-<!-- ##### FUNCTION pango_indic_compact ##### -->
-<para>
-
-</para>
-
-@script:
-@num:
-@chars:
-@cluster:
-
-
-<!-- ##### FUNCTION pango_indic_convert_vowels ##### -->
-<para>
-
-</para>
-
-@script:
-@in_middle:
-@num:
-@chars:
-@has_standalone_vowels:
-
-
-<!-- ##### FUNCTION pango_indic_split_out_characters ##### -->
-<para>
-
-</para>
-
-@script:
-@text:
-@n_chars:
-@wc:
-@n_glyph:
-@glyphs:
-
-
diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml
index 5f929876..2d2359d8 100644
--- a/docs/tmpl/tab-stops.sgml
+++ b/docs/tmpl/tab-stops.sgml
@@ -20,6 +20,13 @@ Tab Stops
</para>
+<!-- ##### MACRO PANGO_TYPE_TAB_ARRAY ##### -->
+<para>
+
+</para>
+
+
+
<!-- ##### ENUM PangoTabAlign ##### -->
<para>
diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml
index 70256d69..7bfb1cdd 100644
--- a/docs/tmpl/text-attributes.sgml
+++ b/docs/tmpl/text-attributes.sgml
@@ -87,6 +87,14 @@ a string value.
@attr: the common portion of the attribute
@value: the value of the attribute
+<!-- ##### STRUCT PangoAttrLanguage ##### -->
+<para>
+
+</para>
+
+@attr:
+@value:
+
<!-- ##### STRUCT PangoAttrColor ##### -->
<para>
The #PangoAttrColor structure is used to represent attributes that
@@ -182,6 +190,15 @@ sets all aspects of the font description at once.
@attr:
+<!-- ##### FUNCTION pango_attr_language_new ##### -->
+<para>
+
+</para>
+
+@language:
+@Returns:
+
+
<!-- ##### FUNCTION pango_attr_family_new ##### -->
<para>
@@ -410,6 +427,16 @@ of underlining.
@color:
+<!-- ##### FUNCTION pango_color_parse ##### -->
+<para>
+
+</para>
+
+@color:
+@spec:
+@Returns:
+
+
<!-- ##### FUNCTION pango_color_copy ##### -->
<para>
@@ -419,6 +446,46 @@ of underlining.
@Returns:
+<!-- ##### STRUCT PangoLanguage ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO PANGO_TYPE_LANGUAGE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION pango_language_from_string ##### -->
+<para>
+
+</para>
+
+@language:
+@Returns:
+
+
+<!-- ##### MACRO pango_language_to_string ##### -->
+<para>
+
+</para>
+
+@language:
+
+
+<!-- ##### FUNCTION pango_language_matches ##### -->
+<para>
+
+</para>
+
+@language:
+@range_list:
+@Returns:
+
+
<!-- ##### STRUCT PangoAttrList ##### -->
<para>
The #PangoAttrList structure represents a list of attributes
@@ -578,11 +645,12 @@ attributes currently in effect can be queried.
</para>
@iterator:
-@base:
-@current:
+@desc:
@language:
@extra_attrs:
<!-- # Unused Parameters # -->
+@base:
+@current:
@lang:
diff --git a/docs/tmpl/win32-fonts.sgml b/docs/tmpl/win32-fonts.sgml
index 2d554078..2df9f614 100644
--- a/docs/tmpl/win32-fonts.sgml
+++ b/docs/tmpl/win32-fonts.sgml
@@ -72,6 +72,26 @@ Win32 Fonts and Rendering
@Returns:
+<!-- ##### FUNCTION pango_win32_font_get_coverage ##### -->
+<para>
+
+</para>
+
+@font:
+@lang:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_win32_font_get_glyph_index ##### -->
+<para>
+
+</para>
+
+@font:
+@wc:
+@Returns:
+
+
<!-- ##### STRUCT PangoWin32FontCache ##### -->
<para>
@@ -139,3 +159,12 @@ Win32 Fonts and Rendering
@Returns:
+<!-- ##### FUNCTION pango_win32_font_logfont ##### -->
+<para>
+
+</para>
+
+@font:
+@Returns:
+
+