diff options
author | Owen Taylor <otaylor@redhat.com> | 2000-01-26 23:56:36 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2000-01-26 23:56:36 +0000 |
commit | 635469870a2b1375105cb305b9f4b09fa05d2208 (patch) | |
tree | 955085c1d08a8101cbf0fdc0275790e5b7b1a540 /docs | |
parent | dc428426c9c618412eae117d7cc542e64b7babe3 (diff) | |
download | pango-635469870a2b1375105cb305b9f4b09fa05d2208.tar.gz |
Updates to match recent API changes.
Thu Jan 27 16:50:51 2000 Owen Taylor <otaylor@redhat.com>
* docs/**: Updates to match recent API changes.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/pango-sections.txt | 19 | ||||
-rw-r--r-- | docs/tmpl/engines.sgml | 23 | ||||
-rw-r--r-- | docs/tmpl/fonts.sgml | 78 | ||||
-rw-r--r-- | docs/tmpl/glyphs.sgml | 23 | ||||
-rw-r--r-- | docs/tmpl/main.sgml | 26 | ||||
-rw-r--r-- | docs/tmpl/pango-unused.sgml | 170 | ||||
-rw-r--r-- | docs/tmpl/pango-x.sgml | 73 |
7 files changed, 275 insertions, 137 deletions
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index f4e41f2f..09c7836b 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -7,6 +7,7 @@ PangoContext PangoItem PangoAnalysis PangoLangRange +PangoDirection pango_reorder_items <SUBSECTION> pango_break @@ -23,7 +24,7 @@ pango_x_to_cp <TITLE>Glyph Storage</TITLE> <FILE>glyphs</FILE> PangoGlyph -PangoGlyphIndex +PangoGlyphInfo PangoGlyphGeometry PangoGlyphUnit PangoGlyphVisAttr @@ -43,11 +44,6 @@ pango_font_ref pango_font_unref pango_font_get_data pango_font_set_data -PangoCFont -PangoCFontClass -pango_cfont_init -pango_cfont_ref -pango_cfont_unref </SECTION> <SECTION> @@ -69,15 +65,16 @@ script_engine_unload <SECTION> <FILE>pango-x</FILE> <TITLE>X Rendering</TITLE> +PangoXSubfont PANGO_RENDER_TYPE_X -PangoXCFont +PANGO_X_MAKE_GLYPH +PANGO_X_GLYPH_SUBFONT +PANGO_X_GLYPH_INDEX pango_x_load_font pango_x_render pango_x_extents pango_x_glyph_extents -pango_x_find_cfont -pango_x_list_cfonts -pango_x_load_xlfd -pango_x_xlfd_get_ranges +pango_x_has_glyph +pango_x_list_subfonts </SECTION> diff --git a/docs/tmpl/engines.sgml b/docs/tmpl/engines.sgml index 17402dfd..6cb37917 100644 --- a/docs/tmpl/engines.sgml +++ b/docs/tmpl/engines.sgml @@ -73,6 +73,12 @@ contains the following fields: </tbody></tgroup></informaltable> </para> +@id: +@engine_type: +@render_type: +@ranges: +@n_ranges: + <!-- ##### STRUCT PangoEngineRange ##### --> <para> The PangoEngineRange structure contains @@ -109,6 +115,10 @@ points. It contains the following fields: </tbody></tgroup></informaltable> </para> +@start: +@end: +@langs: + <!-- ##### STRUCT PangoEngine ##### --> <para> The #PangoEngine structure contains basic @@ -140,6 +150,10 @@ contains the following fields: </tbody></tgroup></informaltable> </para> +@id: +@type: +@length: + <!-- ##### STRUCT PangoEngineLang ##### --> <para> The #PangoEngineLang structure extents the @@ -165,6 +179,9 @@ of of the rendering pipeline. It contains the following fields: </tbody></tgroup></informaltable> </para> +@engine: +@script_break: + <!-- ##### STRUCT PangoEngineShape ##### --> <para> The #PangoEngineShape structure extents the @@ -190,6 +207,8 @@ of of the rendering pipeline. It contains the following fields: </tbody></tgroup></informaltable> </para> +@engine: +@script_shape: <!-- ##### MACRO PANGO_ENGINE_TYPE_LANG ##### --> <para> @@ -209,6 +228,8 @@ These engines have a engine structure of type #PangoEngineShape. </para> + + <!-- ##### MACRO PANGO_RENDER_TYPE_NONE ##### --> <para> A string constant defining the render type @@ -216,6 +237,8 @@ for engines that are not rendering-system specific. </para> + + <!-- ##### FUNCTION script_engine_list ##### --> <para> Function to be provided by a module to list diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index 70592fed..715fbe6f 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -48,6 +48,7 @@ that may be accessed by derived classes: </tbody></tgroup></informaltable> </para> +@klass: <!-- ##### STRUCT PangoFontClass ##### --> <para> @@ -113,80 +114,3 @@ It contains the following member: @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: - - diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index a764f2ef..e50472f7 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -17,7 +17,7 @@ glyphs. </para> -<!-- ##### STRUCT PangoGlyph ##### --> +<!-- ##### TYPEDEF PangoGlyph ##### --> <para> The #PangoGlyph structure represents a single glyph in the output form of a string. It contains the following fields. @@ -41,12 +41,14 @@ form of a string. It contains the following fields. </para> -<!-- ##### TYPEDEF PangoGlyphIndex ##### --> +<!-- ##### STRUCT PangoGlyphInfo ##### --> <para> -The #PangoGlyphIndex type is an integral type used to store glyph -indices. + </para> +@glyph: +@geometry: +@attr: <!-- ##### STRUCT PangoGlyphGeometry ##### --> <para> @@ -76,6 +78,9 @@ information for a single glyph. Distances are in </tbody></tgroup></informaltable> </para> +@width: +@x_offset: +@y_offset: <!-- ##### TYPEDEF PangoGlyphUnit ##### --> <para> @@ -107,6 +112,7 @@ are still evolving. </tbody></tgroup></informaltable> </para> +@is_cluster_start: <!-- ##### STRUCT PangoGlyphString ##### --> <para> @@ -152,8 +158,11 @@ accessible fields </tbody></tgroup></informaltable> </para> +@num_glyphs: +@glyphs: +@log_clusters: -<!-- ##### FUNCTION g_glyph_string_new ##### --> +<!-- ##### FUNCTION pango_glyph_string_new ##### --> <para> </para> @@ -161,7 +170,7 @@ accessible fields @Returns: -<!-- ##### FUNCTION g_glyph_string_set_size ##### --> +<!-- ##### FUNCTION pango_glyph_string_set_size ##### --> <para> </para> @@ -170,7 +179,7 @@ accessible fields @new_len: -<!-- ##### FUNCTION g_glyph_string_free ##### --> +<!-- ##### FUNCTION pango_glyph_string_free ##### --> <para> </para> diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index f251783b..2ce87e0e 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -56,6 +56,9 @@ the following fields: </tbody></tgroup></informaltable> </para> +@lang: +@render_type: +@direction: <!-- ##### STRUCT PangoItem ##### --> <para> @@ -90,6 +93,10 @@ a segment of text. It contains the following fields: </tbody></tgroup></informaltable> </para> +@offset: +@length: +@num_chars: +@analysis: <!-- ##### STRUCT PangoAnalysis ##### --> <para> @@ -119,6 +126,9 @@ fields: </tbody></tgroup></informaltable> </para> +@shape_engine: +@lang_engine: +@level: <!-- ##### STRUCT PangoLangRange ##### --> <para> @@ -149,6 +159,18 @@ It contains the following fields: </tbody></tgroup></informaltable> </para> +@start: +@length: +@lang: + +<!-- ##### ENUM PangoDirection ##### --> +<para> + +</para> + +@PANGO_DIRECTION_LTR: +@PANGO_DIRECTION_RTL: +@PANGO_DIRECTION_TTB: <!-- ##### FUNCTION pango_reorder_items ##### --> <para> @@ -176,6 +198,10 @@ The #PangoLogAttr structure stores information about the attributes of a single character. </para> +@is_break: +@is_white: +@is_char_stop: +@is_word_stop: <!-- ##### FUNCTION pango_shape ##### --> <para> diff --git a/docs/tmpl/pango-unused.sgml b/docs/tmpl/pango-unused.sgml index e69de29b..b17053da 100644 --- a/docs/tmpl/pango-unused.sgml +++ b/docs/tmpl/pango-unused.sgml @@ -0,0 +1,170 @@ +<!-- ##### FUNCTION pango_cfont_init ##### --> +<para> + +</para> + +@font: + +<!-- ##### FUNCTION pango_cfont_ref ##### --> +<para> + +</para> + +@font: + +<!-- ##### TYPEDEF PangoGlyphIndex ##### --> +<para> +The #PangoGlyphIndex type is an integral type used to store glyph +indices. +</para> + + +<!-- ##### FUNCTION pango_x_find_cfont ##### --> +<para> + +</para> + +@font: +@charset: +@Returns: + +<!-- ##### FUNCTION g_glyph_string_set_size ##### --> +<para> + +</para> + +@string: +@new_len: + +<!-- ##### FUNCTION pango_x_xlfd_get_ranges ##### --> +<para> + +</para> + +@font: +@xlfd: +@ranges: +@n_ranges: +@Returns: + +<!-- ##### FUNCTION g_glyph_string_free ##### --> +<para> + +</para> + +@string: + +<!-- ##### FUNCTION g_glyph_string_new ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION pango_x_list_cfonts ##### --> +<para> + +</para> + +@font: +@charsets: +@n_charsets: +@xlfds: +@n_xlfds: + +<!-- ##### FUNCTION pango_x_load_xlfd ##### --> +<para> + +</para> + +@font: +@xlfd: +@Returns: + +<!-- ##### 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> + + +<!-- ##### STRUCT PangoXCFont ##### --> +<para> +The PangoXCFont represents a component of a +composite font for the X window system. It +has the following publically accessible fields: + +<informaltable pgwide=1 frame="none" role="struct"> +<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> +<tbody> + +<row> +<entry><structname>Display</structname> *display;</entry> +<entry>the X Display for which this font component was created.</entry> +</row> + +<row> +<entry><structname>XFontStruct</structname> *font_struct;</entry> +<entry>the X font information for the corresponding X font.</entry> +</row> + +</tbody></tgroup></informaltable> +</para> + +@display: +@font_struct: + +<!-- ##### FUNCTION pango_cfont_unref ##### --> +<para> + +</para> + +@font: + +<!-- ##### 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> + +@klass: + diff --git a/docs/tmpl/pango-x.sgml b/docs/tmpl/pango-x.sgml index b3f18eed..a92c36e8 100644 --- a/docs/tmpl/pango-x.sgml +++ b/docs/tmpl/pango-x.sgml @@ -15,6 +15,12 @@ the X Window system. </para> +<!-- ##### TYPEDEF PangoXSubfont ##### --> +<para> + +</para> + + <!-- ##### MACRO PANGO_RENDER_TYPE_X ##### --> <para> %PANGO_RENDER_TYPE_X is a string constant that @@ -24,29 +30,30 @@ X Window System. -<!-- ##### STRUCT PangoXCFont ##### --> +<!-- ##### MACRO PANGO_X_MAKE_GLYPH ##### --> +<para> + +</para> + +@subfont: +@index: + + +<!-- ##### MACRO PANGO_X_GLYPH_SUBFONT ##### --> <para> -The PangoXCFont represents a component of a -composite font for the X window system. It -has the following publically accessible fields: -<informaltable pgwide=1 frame="none" role="struct"> -<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*"> -<tbody> +</para> -<row> -<entry><structname>Display</structname> *display;</entry> -<entry>the X Display for which this font component was created.</entry> -</row> +@glyph: -<row> -<entry><structname>XFontStruct</structname> *font_struct;</entry> -<entry>the X font information for the corresponding X font.</entry> -</row> -</tbody></tgroup></informaltable> +<!-- ##### MACRO PANGO_X_GLYPH_INDEX ##### --> +<para> + </para> +@glyph: + <!-- ##### FUNCTION pango_x_load_font ##### --> <para> @@ -66,6 +73,7 @@ has the following publically accessible fields: @display: @d: @gc: +@font: @glyphs: @x: @y: @@ -76,6 +84,7 @@ has the following publically accessible fields: </para> +@font: @glyphs: @lbearing: @rbearing: @@ -91,6 +100,7 @@ has the following publically accessible fields: </para> +@font: @glyph: @lbearing: @rbearing: @@ -101,17 +111,17 @@ has the following publically accessible fields: @logical_descent: -<!-- ##### FUNCTION pango_x_find_cfont ##### --> +<!-- ##### FUNCTION pango_x_has_glyph ##### --> <para> </para> @font: -@charset: +@glyph: @Returns: -<!-- ##### FUNCTION pango_x_list_cfonts ##### --> +<!-- ##### FUNCTION pango_x_list_subfonts ##### --> <para> </para> @@ -119,29 +129,8 @@ has the following publically accessible fields: @font: @charsets: @n_charsets: -@xlfds: -@n_xlfds: - - -<!-- ##### FUNCTION pango_x_load_xlfd ##### --> -<para> - -</para> - -@font: -@xlfd: -@Returns: - - -<!-- ##### FUNCTION pango_x_xlfd_get_ranges ##### --> -<para> - -</para> - -@font: -@xlfd: -@ranges: -@n_ranges: +@subfont_ids: +@subfont_charsets: @Returns: |