diff options
Diffstat (limited to 'docs/tmpl/fonts.sgml')
-rw-r--r-- | docs/tmpl/fonts.sgml | 192 |
1 files changed, 192 insertions, 0 deletions
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml new file mode 100644 index 00000000..70592fed --- /dev/null +++ b/docs/tmpl/fonts.sgml @@ -0,0 +1,192 @@ +<!-- ##### SECTION Title ##### --> +Fonts + +<!-- ##### SECTION Short_Description ##### --> +Structures representing abstract fonts. + +<!-- ##### SECTION Long_Description ##### --> +<para> +Pango supports a flexible architecture where a +particular rendering architecture can supply an +implementation of fonts. The #PangoFont and +#PangoCFont structures represent an abstract +rendering-system-indepent font, and a +<firstterm>component</firstterm> of such a font, +respectively. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT PangoFont ##### --> +<para> +The #PangoFont structure is used to represent +a font in a rendering-system-independent matter. +To create an implementation of a #PangoFont, +the rendering-system specific code should malloc +a larger structure that contains a nested +#PangoFont, fill in the klass member of +the nested #PangoFont with a pointer to +a appropriate #PangoFontClass, then call +pango_font_init() on the structure. +</para> +<para> +The #PangoFont structure contains one member +that may be accessed by derived classes: + +<informaltable pgwide=1 frame="none" role="struct"> +<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> +<tbody> + +<row> +<entry>#PangoFontClass *klass;</entry> +<entry>a pointer to the <firstterm>class structure</firstterm> + for this font.</entry> +</row> +</tbody></tgroup></informaltable> +</para> + + +<!-- ##### STRUCT PangoFontClass ##### --> +<para> +The PangoFontClass structure contains the virtual +functions for an implementation of a a PangoFont. + +It contains the following member: + +<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> + + +<!-- ##### FUNCTION pango_font_init ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION pango_font_ref ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION pango_font_unref ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION pango_font_get_data ##### --> +<para> + +</para> + +@font: +@key: +@Returns: + + +<!-- ##### FUNCTION pango_font_set_data ##### --> +<para> + +</para> + +@font: +@key: +@data: +@destroy_func: + + +<!-- ##### STRUCT PangoCFont ##### --> +<para> +The #PangoCFont structure is used to represent a single componenent +of a font n a rendering-system-independent matter. A component of a +font is an opaque object that makes sense only to the rendering +system. A glyph (the #PangoGlyph structure) is stored as a #PangoCFont +and a numeric glyph index. +</para> +<para> +To create an implementation of a #PangoCFont, +the rendering-system specific code should malloc +a larger structure that contains a nested +#PangoCFont, fill in the klass member of +the nested #PangoCFont with a pointer to +a appropriate #PangoCFontClass, then call +pango_cfont_init() on the structure. +</para> +<para> +The #PangoCFont structure contains one member +that may be accessed by derived classes: + +<informaltable pgwide=1 frame="none" role="struct"> +<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> +<tbody> + +<row> +<entry>#PangoCFontClass *klass;</entry> +<entry>a pointer to the <firstterm>class structure</firstterm> + for this font.</entry> +</row> +</tbody></tgroup></informaltable> +</para> + + +<!-- ##### STRUCT PangoCFontClass ##### --> +<para> +The PangoCFontClass structure contains the virtual +functions for an implementation of a a PangoCFont. + +It contains the following member: + +<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> + + +<!-- ##### FUNCTION pango_cfont_init ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION pango_cfont_ref ##### --> +<para> + +</para> + +@font: + + +<!-- ##### FUNCTION pango_cfont_unref ##### --> +<para> + +</para> + +@font: + + |