From 635469870a2b1375105cb305b9f4b09fa05d2208 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Wed, 26 Jan 2000 23:56:36 +0000 Subject: Updates to match recent API changes. Thu Jan 27 16:50:51 2000 Owen Taylor * docs/**: Updates to match recent API changes. --- docs/pango-sections.txt | 19 +++-- docs/tmpl/engines.sgml | 23 ++++++ docs/tmpl/fonts.sgml | 78 +------------------- docs/tmpl/glyphs.sgml | 23 ++++-- docs/tmpl/main.sgml | 26 +++++++ docs/tmpl/pango-unused.sgml | 170 ++++++++++++++++++++++++++++++++++++++++++++ docs/tmpl/pango-x.sgml | 73 ++++++++----------- 7 files changed, 275 insertions(+), 137 deletions(-) (limited to 'docs') 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 pango_break @@ -23,7 +24,7 @@ pango_x_to_cp Glyph Storage glyphs 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
@@ -69,15 +65,16 @@ script_engine_unload
pango-x X Rendering +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
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: +@id: +@engine_type: +@render_type: +@ranges: +@n_ranges: + The PangoEngineRange structure contains @@ -109,6 +115,10 @@ points. It contains the following fields: +@start: +@end: +@langs: + The #PangoEngine structure contains basic @@ -140,6 +150,10 @@ contains the following fields: +@id: +@type: +@length: + The #PangoEngineLang structure extents the @@ -165,6 +179,9 @@ of of the rendering pipeline. It contains the following fields: +@engine: +@script_break: + The #PangoEngineShape structure extents the @@ -190,6 +207,8 @@ of of the rendering pipeline. It contains the following fields: +@engine: +@script_shape: @@ -209,6 +228,8 @@ These engines have a engine structure of type #PangoEngineShape. + + A string constant defining the render type @@ -216,6 +237,8 @@ for engines that are not rendering-system specific. + + 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: +@klass: @@ -113,80 +114,3 @@ It contains the following member: @destroy_func: - - -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. - - -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. - - -The #PangoCFont structure contains one member -that may be accessed by derived classes: - - - - - - -#PangoCFontClass *klass; -a pointer to the class structure - for this font. - - - - - - - -The PangoCFontClass structure contains the virtual -functions for an implementation of a a PangoCFont. - -It contains the following member: - - - - - - -void (*destroy) (#PangoFont *font); -a function to free the font structure and associated resources. - - - - - - - - - - -@font: - - - - - - - -@font: - - - - - - - -@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. - + 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. - + -The #PangoGlyphIndex type is an integral type used to store glyph -indices. + +@glyph: +@geometry: +@attr: @@ -76,6 +78,9 @@ information for a single glyph. Distances are in +@width: +@x_offset: +@y_offset: @@ -107,6 +112,7 @@ are still evolving. +@is_cluster_start: @@ -152,8 +158,11 @@ accessible fields +@num_glyphs: +@glyphs: +@log_clusters: - + @@ -161,7 +170,7 @@ accessible fields @Returns: - + @@ -170,7 +179,7 @@ accessible fields @new_len: - + 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: +@lang: +@render_type: +@direction: @@ -90,6 +93,10 @@ a segment of text. It contains the following fields: +@offset: +@length: +@num_chars: +@analysis: @@ -119,6 +126,9 @@ fields: +@shape_engine: +@lang_engine: +@level: @@ -149,6 +159,18 @@ It contains the following fields: +@start: +@length: +@lang: + + + + + + +@PANGO_DIRECTION_LTR: +@PANGO_DIRECTION_RTL: +@PANGO_DIRECTION_TTB: @@ -176,6 +198,10 @@ The #PangoLogAttr structure stores information about the attributes of a single character. +@is_break: +@is_white: +@is_char_stop: +@is_word_stop: 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 @@ + + + + + +@font: + + + + + + +@font: + + + +The #PangoGlyphIndex type is an integral type used to store glyph +indices. + + + + + + + + +@font: +@charset: +@Returns: + + + + + + +@string: +@new_len: + + + + + + +@font: +@xlfd: +@ranges: +@n_ranges: +@Returns: + + + + + + +@string: + + + + + + +@Returns: + + + + + + +@font: +@charsets: +@n_charsets: +@xlfds: +@n_xlfds: + + + + + + +@font: +@xlfd: +@Returns: + + + +The PangoCFontClass structure contains the virtual +functions for an implementation of a a PangoCFont. + +It contains the following member: + + + + + + +void (*destroy) (#PangoFont *font); +a function to free the font structure and associated resources. + + + + + + + +The PangoXCFont represents a component of a +composite font for the X window system. It +has the following publically accessible fields: + + + + + + +Display *display; +the X Display for which this font component was created. + + + +XFontStruct *font_struct; +the X font information for the corresponding X font. + + + + + +@display: +@font_struct: + + + + + + +@font: + + + +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. + + +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. + + +The #PangoCFont structure contains one member +that may be accessed by derived classes: + + + + + + +#PangoCFontClass *klass; +a pointer to the class structure + for this font. + + + + +@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. + + + + + + %PANGO_RENDER_TYPE_X is a string constant that @@ -24,29 +30,30 @@ X Window System. - + + + + + +@subfont: +@index: + + + -The PangoXCFont represents a component of a -composite font for the X window system. It -has the following publically accessible fields: - - - + - -Display *display; -the X Display for which this font component was created. - +@glyph: - -XFontStruct *font_struct; -the X font information for the corresponding X font. - - + + + +@glyph: + @@ -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: +@font: @glyphs: @lbearing: @rbearing: @@ -91,6 +100,7 @@ has the following publically accessible fields: +@font: @glyph: @lbearing: @rbearing: @@ -101,17 +111,17 @@ has the following publically accessible fields: @logical_descent: - + @font: -@charset: +@glyph: @Returns: - + @@ -119,29 +129,8 @@ has the following publically accessible fields: @font: @charsets: @n_charsets: -@xlfds: -@n_xlfds: - - - - - - - -@font: -@xlfd: -@Returns: - - - - - - - -@font: -@xlfd: -@ranges: -@n_ranges: +@subfont_ids: +@subfont_charsets: @Returns: -- cgit v1.2.1