diff options
author | Matthias Clasen <matthiasc@src.gnome.org> | 2001-11-11 23:36:28 +0000 |
---|---|---|
committer | Matthias Clasen <matthiasc@src.gnome.org> | 2001-11-11 23:36:28 +0000 |
commit | 3c263f0d3b41d8ef99e3143be0763ee0eb7bb5ac (patch) | |
tree | d056daa81d38fa039d93a4b1f49d7eb09b1abc05 /docs | |
parent | d7f86d4ae1dbf2442c130de1abb7d8a121f8daf7 (diff) | |
download | pango-3c263f0d3b41d8ef99e3143be0763ee0eb7bb5ac.tar.gz |
Add pangoxft-private.h.
* docs/Makefile.am (IGNORE_HFILES): Add pangoxft-private.h.
* pango/pango-utils.c (pango_language_from_string): Fix typo in
documentation.
* docs/tmpl/text-attributes.sgml: Document PangoColor, PangoLanguage,
PangoAttrLanguage, PangoAttrFloat and PangoAttrShape.
* docs/tmpl/layout.sgml: Document PangoWrapMode and PangoLayoutIter.
* docs/tmpl/tab-stops.sgml: Document PangoTabAlign and PangoTabArray.
* docs/tmpl/fonts.sgml: Document PangoFontMask.
* pango/fonts.c (pango_font_description_unset_fields): Fix typo in
documentation.
* docs/tmpl/opentype.sgml: Remove documentation templates of the
unimplemented functions pango_ot_ruleset_set_glyph_loader and
pango_ot_ruleset_set_alternate_func and the related typedefs
PangoOTGlyphLoader and PangoOTAlternateFunc.
* docs/tmpl/x-rendering.sgml: Document PangoGetGCFunc and
PangoFreeGCFunc typedefs.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 3 | ||||
-rw-r--r-- | docs/tmpl/fonts.sgml | 15 | ||||
-rw-r--r-- | docs/tmpl/layout.sgml | 14 | ||||
-rw-r--r-- | docs/tmpl/opentype.sgml | 47 | ||||
-rw-r--r-- | docs/tmpl/tab-stops.sgml | 8 | ||||
-rw-r--r-- | docs/tmpl/text-attributes.sgml | 54 | ||||
-rw-r--r-- | docs/tmpl/x-rendering.sgml | 18 |
7 files changed, 68 insertions, 91 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 6087fc47..afef742f 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -31,7 +31,8 @@ IGNORE_HFILES= \ pango-utils.h \ pangoft2-private.h \ pangowin32-private.h \ - pangox-private.h + pangox-private.h \ + pangoxft-private.h # Extra files to add when scanning EXTRA_HFILES= diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index 9ff62359..8d5f2f0e 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -111,15 +111,16 @@ The GObject type for #PangoStretch. <!-- ##### ENUM PangoFontMask ##### --> <para> - +The bits in a #PangoFontMask correspond to fields in a +#PangoFontDescription that have been set. </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: +@PANGO_FONT_MASK_FAMILY: the font family is specified. +@PANGO_FONT_MASK_STYLE: the font style is specified. +@PANGO_FONT_MASK_VARIANT: the font variant is specified. +@PANGO_FONT_MASK_WEIGHT: the font weight is specified. +@PANGO_FONT_MASK_STRETCH: the font stretch is specified. +@PANGO_FONT_MASK_SIZE: the font size is specified. <!-- ##### MACRO PANGO_TYPE_FONT_MASK ##### --> <para> diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml index ea58f3ee..41bae50c 100644 --- a/docs/tmpl/layout.sgml +++ b/docs/tmpl/layout.sgml @@ -50,7 +50,12 @@ fields. <!-- ##### STRUCT PangoLayoutIter ##### --> <para> - +A <structname>PangoLayoutIter</structname> structure can be used to +iterate over the visual extents of a #PangoLayout. +</para> +<para> +The <structname>PangoLayoutIter</structname> structure is opaque, and +has no user-visible fields. </para> @@ -195,11 +200,12 @@ fields. <!-- ##### ENUM PangoWrapMode ##### --> <para> - +describes how to wrap the lines of a #PangoLayout to the desired width. </para> -@PANGO_WRAP_WORD: -@PANGO_WRAP_CHAR: +@PANGO_WRAP_WORD: wrap lines at word boundaries. +@PANGO_WRAP_CHAR: wrap lines at character boundaries. + <!-- ##### MACRO PANGO_TYPE_WRAP_MODE ##### --> <para> diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml index e7aeb733..42656151 100644 --- a/docs/tmpl/opentype.sgml +++ b/docs/tmpl/opentype.sgml @@ -124,31 +124,6 @@ OpenType Font Handling @Returns: -<!-- ##### USER_FUNCTION PangoOTGlyphLoader ##### --> -<para> - -</para> - -@face: -@glyphIndex: -@loadFlags: -@data: -@Returns: - - -<!-- ##### USER_FUNCTION PangoOTAlternateFunc ##### --> -<para> - -</para> - -@pos: -@glyphID: -@num_alternates: -@alternates: -@data: -@Returns: - - <!-- ##### FUNCTION pango_ot_ruleset_new ##### --> <para> @@ -158,28 +133,6 @@ OpenType Font Handling @Returns: -<!-- ##### FUNCTION pango_ot_ruleset_set_glyph_loader ##### --> -<para> - -</para> - -@ruleset: -@func: -@data: -@notify: - - -<!-- ##### FUNCTION pango_ot_ruleset_set_alternate_func ##### --> -<para> - -</para> - -@ruleset: -@func: -@data: -@notify: - - <!-- ##### FUNCTION pango_ot_ruleset_add_feature ##### --> <para> diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml index 702b7912..a6fd1b8b 100644 --- a/docs/tmpl/tab-stops.sgml +++ b/docs/tmpl/tab-stops.sgml @@ -16,7 +16,8 @@ Tab Stops <!-- ##### STRUCT PangoTabArray ##### --> <para> - +A <structname>PangoTabArray</structname> struct contains an array +of tab stops. Each tab stop has an alignment and a position. </para> @@ -29,10 +30,11 @@ The GObject type for #PangoTabArray. <!-- ##### ENUM PangoTabAlign ##### --> <para> - +A #PangoTabAlign specifies where a tab stop appears relative to the text. </para> -@PANGO_TAB_LEFT: +@PANGO_TAB_LEFT: the tab stop appears to the left of the text. + <!-- ##### MACRO PANGO_TYPE_TAB_ALIGN ##### --> <para> diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml index b31a2ba3..3e1f4855 100644 --- a/docs/tmpl/text-attributes.sgml +++ b/docs/tmpl/text-attributes.sgml @@ -28,21 +28,21 @@ attribute is listed in parentheses after the description. </para> @PANGO_ATTR_INVALID: -@PANGO_ATTR_LANGUAGE: +@PANGO_ATTR_LANGUAGE: language (#PangoAttrLanguage) @PANGO_ATTR_FAMILY: font family name list (#PangoAttrString) @PANGO_ATTR_STYLE: font slant style (#PangoAttrInt) @PANGO_ATTR_WEIGHT: font weight (#PangoAttrInt) @PANGO_ATTR_VARIANT: font variant (normal or small caps) (#PangoAttrInt) @PANGO_ATTR_STRETCH: font stretch (#PangoAttrInt) @PANGO_ATTR_SIZE: font size in 1000th's of a point (#PangoAttrInt) -@PANGO_ATTR_FONT_DESC: +@PANGO_ATTR_FONT_DESC: font description (#PangoAttrFontDesc) @PANGO_ATTR_FOREGROUND: foreground color (#PangoAttrColor) @PANGO_ATTR_BACKGROUND: background color (#PangoAttrColor) @PANGO_ATTR_UNDERLINE: whether the text has an underline (#PangoAttrInt) @PANGO_ATTR_STRIKETHROUGH: whether the text is struck-through (#PangoAttrInt) @PANGO_ATTR_RISE: baseline displacement (#PangoAttrInt) -@PANGO_ATTR_SHAPE: -@PANGO_ATTR_SCALE: +@PANGO_ATTR_SHAPE: shape (#PangoAttrShape) +@PANGO_ATTR_SCALE: font size scale factor (#PangoAttrScale) <!-- ##### MACRO PANGO_TYPE_ATTR_TYPE ##### --> <para> @@ -85,15 +85,16 @@ a string value. </para> @attr: the common portion of the attribute -@value: the value of the attribute +@value: the string which is the value of the attribute <!-- ##### STRUCT PangoAttrLanguage ##### --> <para> - +The #PangoAttrColor structure is used to represent attributes that +are languages. </para> -@attr: -@value: +@attr: the common portion of the attribute +@value: the #PangoLanguage which is the value of the attribute <!-- ##### STRUCT PangoAttrColor ##### --> <para> @@ -102,7 +103,7 @@ are colors. </para> @attr: the common portion of the attribute -@color: +@color: the #PangoColor which is the value of the attribute <!-- ##### STRUCT PangoAttrInt ##### --> <para> @@ -115,11 +116,12 @@ a integer or enumeration value. <!-- ##### STRUCT PangoAttrFloat ##### --> <para> - +The #PangoAttrFloat structure is used to represent attributes with +a float or double value. </para> -@attr: -@value: +@attr: the common portion of the attribute +@value: the value of the attribute <!-- ##### STRUCT PangoAttrFontDesc ##### --> <para> @@ -132,12 +134,13 @@ sets all aspects of the font description at once. <!-- ##### STRUCT PangoAttrShape ##### --> <para> - +The #PangoAttrShape structure is used to represent attributes which +impose shape restrictions. </para> -@attr: -@ink_rect: -@logical_rect: +@attr: the common portion of the attribute +@ink_rect: the ink rectangle to restrict to +@logical_rect: the logical rectangle to restrict to <!-- ##### FUNCTION pango_parse_markup ##### --> <para> @@ -405,12 +408,16 @@ The scale factor for three magnification steps (1.2 * 1.2 * 1.2). <!-- ##### STRUCT PangoColor ##### --> <para> - +The <structname>PangoColor</structname> structure is used to +represent a color in an uncalibrated RGB colorspace. </para> -@red: -@green: -@blue: +@red: The red component of the color. This is a value between 0 and 65535, + with 65535 indicating full intensity. +@green: The green component of the color. This is a value between 0 and 65535, + with 65535 indicating full intensity. +@blue: The blue component of the color. This is a value between 0 and 65535, + with 65535 indicating full intensity. <!-- ##### MACRO PANGO_TYPE_COLOR ##### --> <para> @@ -448,7 +455,12 @@ The GObject type for #PangoColor. <!-- ##### STRUCT PangoLanguage ##### --> <para> - +The <structname>PangoLanguage</structname> structure is used to +represent a language. +</para> +<para> +<structname>PangoLanguage</structname> pointers can be efficiently +copied and compared with each other. </para> diff --git a/docs/tmpl/x-rendering.sgml b/docs/tmpl/x-rendering.sgml index 406eb0fe..03d8a395 100644 --- a/docs/tmpl/x-rendering.sgml +++ b/docs/tmpl/x-rendering.sgml @@ -43,22 +43,24 @@ g_quark_from_string()) is used to identify the renderer in pango_find_map(). <!-- ##### USER_FUNCTION PangoGetGCFunc ##### --> <para> - +Specifies the type of the function used to create a new GC for a given +color. </para> -@context: -@color: -@base_gc: -@Returns: +@context: a #PangoContext. +@color: the color to create a new GC for. +@base_gc: the GC to base the new GC on. +@Returns: the new GC. <!-- ##### USER_FUNCTION PangoFreeGCFunc ##### --> <para> - +Specifies the type of the function used to free a GC created with +the corresponding #PangoGetGCFunc function. </para> -@context: -@gc: +@context: a #PangoContext. +@gc: the GC to free. <!-- ##### FUNCTION pango_x_render ##### --> |