diff options
author | Owen Taylor <otaylor@redhat.com> | 2001-01-25 19:48:02 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2001-01-25 19:48:02 +0000 |
commit | 7c1e55d216ee484443e4377491114430a9e046bc (patch) | |
tree | d1d961de79056449722f6500c7f36828b9e6183e /docs | |
parent | 672500d6a122f7b546d6fb795fe0e5cd03d9f244 (diff) | |
download | pango-7c1e55d216ee484443e4377491114430a9e046bc.tar.gz |
Updates for new functions.
Thu Jan 25 14:47:17 2001 Owen Taylor <otaylor@redhat.com>
* pango/pango-sections.txt pango/pango-docs.sgml pango/tmpl/*:
Updates for new functions.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/pango-docs.sgml | 6 | ||||
-rw-r--r-- | docs/pango-sections.txt | 82 | ||||
-rw-r--r-- | docs/tmpl/coverage-maps.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/fonts.sgml | 37 | ||||
-rw-r--r-- | docs/tmpl/freetype-fonts.sgml | 20 | ||||
-rw-r--r-- | docs/tmpl/layout.sgml | 42 | ||||
-rw-r--r-- | docs/tmpl/main.sgml | 43 | ||||
-rw-r--r-- | docs/tmpl/opentype.sgml | 203 | ||||
-rw-r--r-- | docs/tmpl/tab-stops.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/text-attributes.sgml | 14 | ||||
-rw-r--r-- | docs/tmpl/xft-fonts.sgml | 110 |
11 files changed, 568 insertions, 3 deletions
diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index a51705c3..bf67d361 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -13,6 +13,8 @@ <!entity pango-X-Fonts SYSTEM "sgml/x-fonts.sgml"> <!entity pango-Win32-Fonts-and-Rendering SYSTEM "sgml/win32-fonts.sgml"> <!entity pango-FreeType-Fonts-and-Rendering SYSTEM "sgml/freetype-fonts.sgml"> +<!entity pango-Xft-Fonts-and-Rendering SYSTEM "sgml/xft-fonts.sgml"> +<!entity pango-OpenType-Font-Handling SYSTEM "sgml/opentype.sgml"> <!entity markup-format SYSTEM "pango_markup.sgml"> ]> <book id="index"> @@ -37,7 +39,9 @@ &pango-X-Rendering; &pango-Win32-Fonts-and-Rendering; &pango-FreeType-Fonts-and-Rendering; - </chapter> + &pango-Xft-Fonts-and-Rendering; + &pango-OpenType-Font-Handling; + </chapter> <chapter id="lowlevel"> <title>Low Level Functionality</title> diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt index 16ea9a91..b5e049db 100644 --- a/docs/pango-sections.txt +++ b/docs/pango-sections.txt @@ -7,11 +7,13 @@ PangoItem PangoAnalysis PangoLangRange PangoDirection +PANGO_TYPE_DIRECTION <SUBSECTION> pango_itemize pango_item_free pango_item_copy pango_item_new +pango_item_split pango_reorder_items <SUBSECTION> pango_context_new @@ -37,10 +39,15 @@ PANGO_CONTEXT_GET_CLASS <SUBSECTION> pango_break pango_get_log_attrs +pango_find_paragraph_boundary +pango_default_break PangoLogAttr <SUBSECTION> pango_shape pango_justify + +<SUBSECTION Private> +pango_direction_get_type </SECTION> <SECTION> @@ -73,6 +80,7 @@ pango_glyph_string_get_logical_widths <TITLE>Coverage Maps</TITLE> <FILE>coverage-maps</FILE> PangoCoverageLevel +PANGO_TYPE_COVERAGE_LEVEL PangoCoverage <SUBSECTION> pango_coverage_new @@ -84,6 +92,9 @@ pango_coverage_max pango_coverage_set pango_coverage_to_bytes pango_coverage_from_bytes + +<SUBSECTION Private> +pango_coverage_level_get_type </SECTION> <SECTION> @@ -91,15 +102,20 @@ pango_coverage_from_bytes <FILE>fonts</FILE> PangoFontDescription PangoStyle +PANGO_TYPE_STYLE PangoWeight +PANGO_TYPE_WEIGHT PangoVariant +PANGO_TYPE_VARIANT PangoStretch +PANGO_TYPE_STRETCH pango_font_description_copy pango_font_description_equal pango_font_descriptions_free pango_font_description_free pango_font_description_from_string pango_font_description_to_string +pango_font_description_to_filename <SUBSECTION> PangoFont PangoFontClass @@ -130,12 +146,19 @@ PANGO_FONT_MAP_CLASS PANGO_IS_FONT_MAP_CLASS PANGO_FONT_MAP_GET_CLASS pango_font_map_get_type + +<SUBSECTION Private> +pango_stretch_get_type +pango_style_get_type +pango_variant_get_type +pango_weight_get_type </SECTION> <SECTION> <TITLE>Text Attributes</TITLE> <FILE>text-attributes</FILE> PangoAttrType +PANGO_TYPE_ATTR_TYPE PangoAttrClass PangoAttribute PangoAttrString @@ -165,6 +188,7 @@ pango_attr_underline_new pango_attr_shape_new pango_attr_scale_new PangoUnderline +PANGO_TYPE_UNDERLINE pango_attr_rise_new <SUBSECTION> PangoAttrList @@ -184,6 +208,9 @@ pango_attr_iterator_range pango_attr_iterator_get pango_attr_iterator_get_font pango_attr_iterator_destroy +<SUBSECTION Private> +pango_attr_type_get_type +pango_underline_get_type </SECTION> <SECTION> @@ -191,6 +218,7 @@ pango_attr_iterator_destroy <FILE>tab-stops</FILE> PangoTabArray PangoTabAlign +PANGO_TYPE_TAB_ALIGN pango_tab_array_new pango_tab_array_new_with_positions pango_tab_array_copy @@ -201,6 +229,9 @@ pango_tab_array_set_tab pango_tab_array_get_tab pango_tab_array_get_tabs pango_tab_array_get_positions_in_pixels + +<SUBSECTION Private> +pango_tab_align_get_type </SECTION> <SECTION> @@ -209,6 +240,7 @@ pango_tab_array_get_positions_in_pixels PangoLayout PangoLayoutIter pango_layout_new +pango_layout_copy pango_layout_get_context pango_layout_context_changed @@ -222,6 +254,9 @@ pango_layout_get_attributes pango_layout_set_font_description pango_layout_set_width pango_layout_get_width +pango_layout_set_wrap +pango_layout_get_wrap +PangoWrapMode pango_layout_set_indent pango_layout_get_indent pango_layout_get_spacing @@ -233,6 +268,7 @@ pango_layout_get_alignment pango_layout_set_tabs pango_layout_get_tabs PangoAlignment +PANGO_TYPE_ALIGNMENT pango_layout_get_log_attrs @@ -288,6 +324,7 @@ PANGO_IS_LAYOUT PANGO_LAYOUT_CLASS PANGO_IS_LAYOUT_CLASS PANGO_LAYOUT_GET_CLASS +pango_alignment_get_type </SECTION> <SECTION> @@ -415,9 +452,10 @@ PANGO_FT2_MAKE_GLYPH PANGO_FT2_GLYPH_SUBFONT PANGO_FT2_GLYPH_INDEX pango_ft2_n_subfonts -pango_ft2_has_glyph pango_ft2_get_unknown_glyph pango_ft2_font_get_kerning +pango_ft2_get_coverage +pango_ft2_get_face PangoFT2FontCache pango_ft2_font_cache_new pango_ft2_font_cache_free @@ -431,3 +469,45 @@ pango_ft2_fontmap_dump <SUBSECTION Private> STRICT </SECTION> + +<SECTION> +<TITLE>Xft Fonts and Rendering</TITLE> +<FILE>xft-fonts</FILE> +PANGO_RENDER_TYPE_XFT +PangoXftFont +pango_xft_get_context +pango_xft_render +pango_xft_font_get_font +pango_xft_font_get_face +pango_xft_font_get_ot_info +pango_xft_font_get_display +pango_xft_font_get_unknown_glyph +<SUBSECTION Standard> +PANGO_TYPE_XFT_FONT +PANGO_XFT_IS_FONT +pango_xft_font_get_type +</SECTION> + +<SECTION> +<TITLE>OpenType Font Handling</TITLE> +<FILE>opentype</FILE> +PangoOTTag +PangoOTInfo +PangoOTRuleset +PangoOTTableType +pango_ot_info_new +pango_ot_info_find_script +pango_ot_info_find_language +pango_ot_info_find_feature +pango_ot_info_list_scripts +pango_ot_info_list_languages +pango_ot_info_list_features +PangoOTGlyphLoader +PangoOTAlternateFunc +pango_ot_ruleset_new +pango_ot_ruleset_set_glyph_loader +pango_ot_ruleset_set_alternate_func +pango_ot_ruleset_add_feature +pango_ot_ruleset_shape +</SECTION> + diff --git a/docs/tmpl/coverage-maps.sgml b/docs/tmpl/coverage-maps.sgml index 8cde2ac9..0169a82c 100644 --- a/docs/tmpl/coverage-maps.sgml +++ b/docs/tmpl/coverage-maps.sgml @@ -34,6 +34,13 @@ character point for a particular scrpt. the current script. @PANGO_COVERAGE_EXACT: The character is represented as the correct graphical form. +<!-- ##### MACRO PANGO_TYPE_COVERAGE_LEVEL ##### --> +<para> + +</para> + + + <!-- ##### STRUCT PangoCoverage ##### --> <para> The #PangoCoverage structure represents a map from ISO-10646 character diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index 9db61d79..bfd67fe6 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -42,6 +42,13 @@ the characteristics of a font to load. @PANGO_STYLE_OBLIQUE: @PANGO_STYLE_ITALIC: +<!-- ##### MACRO PANGO_TYPE_STYLE ##### --> +<para> + +</para> + + + <!-- ##### ENUM PangoWeight ##### --> <para> An enumeration specifying the weight (boldness) of a font. This is a numerical @@ -55,6 +62,13 @@ value ranging from 100 to 900, but there are two predefined values: @PANGO_WEIGHT_ULTRABOLD: @PANGO_WEIGHT_HEAVY: +<!-- ##### MACRO PANGO_TYPE_WEIGHT ##### --> +<para> + +</para> + + + <!-- ##### ENUM PangoVariant ##### --> <para> An enumeration specifying capitalization variant of the font. @@ -64,6 +78,13 @@ An enumeration specifying capitalization variant of the font. @PANGO_VARIANT_SMALL_CAPS: A font with the lower case characters replaced by smaller variants of the capital characters. +<!-- ##### MACRO PANGO_TYPE_VARIANT ##### --> +<para> + +</para> + + + <!-- ##### ENUM PangoStretch ##### --> <para> An enumeration specifying the width of the font relative to other designs @@ -80,6 +101,13 @@ within a family. @PANGO_STRETCH_EXTRA_EXPANDED: @PANGO_STRETCH_ULTRA_EXPANDED: +<!-- ##### MACRO PANGO_TYPE_STRETCH ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION pango_font_description_copy ##### --> <para> @@ -134,6 +162,15 @@ within a family. @Returns: +<!-- ##### FUNCTION pango_font_description_to_filename ##### --> +<para> + +</para> + +@desc: +@Returns: + + <!-- ##### STRUCT PangoFont ##### --> <para> The #PangoFont structure is used to represent diff --git a/docs/tmpl/freetype-fonts.sgml b/docs/tmpl/freetype-fonts.sgml index e535f153..1847ec0d 100644 --- a/docs/tmpl/freetype-fonts.sgml +++ b/docs/tmpl/freetype-fonts.sgml @@ -138,6 +138,26 @@ FreeType Fonts and Rendering @Returns: +<!-- ##### FUNCTION pango_ft2_get_coverage ##### --> +<para> + +</para> + +@font: +@lang: +@Returns: + + +<!-- ##### FUNCTION pango_ft2_get_face ##### --> +<para> + +</para> + +@font: +@subfont_index: +@Returns: + + <!-- ##### STRUCT PangoFT2FontCache ##### --> <para> diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml index a21fffef..9d8356ea 100644 --- a/docs/tmpl/layout.sgml +++ b/docs/tmpl/layout.sgml @@ -63,6 +63,15 @@ fields. @Returns: +<!-- ##### FUNCTION pango_layout_copy ##### --> +<para> + +</para> + +@src: +@Returns: + + <!-- ##### FUNCTION pango_layout_get_context ##### --> <para> @@ -166,6 +175,32 @@ fields. @Returns: +<!-- ##### FUNCTION pango_layout_set_wrap ##### --> +<para> + +</para> + +@layout: +@wrap: + + +<!-- ##### FUNCTION pango_layout_get_wrap ##### --> +<para> + +</para> + +@layout: +@Returns: + + +<!-- ##### ENUM PangoWrapMode ##### --> +<para> + +</para> + +@PANGO_WRAP_WORD: +@PANGO_WRAP_CHAR: + <!-- ##### FUNCTION pango_layout_set_indent ##### --> <para> @@ -268,6 +303,13 @@ for partial lines. @PANGO_ALIGN_CENTER: Center the line within the available space @PANGO_ALIGN_RIGHT: Put all available space on the left +<!-- ##### MACRO PANGO_TYPE_ALIGNMENT ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION pango_layout_get_log_attrs ##### --> <para> diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index ead7b037..c746f137 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -164,6 +164,13 @@ for text. top-to-bottom, with the rows ordered from right to left. +<!-- ##### MACRO PANGO_TYPE_DIRECTION ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION pango_itemize ##### --> <para> @@ -206,6 +213,17 @@ for text. @Returns: +<!-- ##### FUNCTION pango_item_split ##### --> +<para> + +</para> + +@orig: +@split_index: +@split_offset: +@Returns: + + <!-- ##### FUNCTION pango_reorder_items ##### --> <para> @@ -342,14 +360,37 @@ for text. @log_attrs: +<!-- ##### FUNCTION pango_find_paragraph_boundary ##### --> +<para> + +</para> + +@text: +@length: +@paragraph_delimiter_index: +@next_paragraph_start: + + +<!-- ##### FUNCTION pango_default_break ##### --> +<para> + +</para> + +@text: +@length: +@analysis: +@attrs: + + <!-- ##### STRUCT PangoLogAttr ##### --> <para> The #PangoLogAttr structure stores information about the attributes of a single character. </para> -@is_break: +@is_line_break: @is_mandatory_break: +@is_char_break: @is_white: @is_cursor_position: @is_word_start: diff --git a/docs/tmpl/opentype.sgml b/docs/tmpl/opentype.sgml new file mode 100644 index 00000000..e7aeb733 --- /dev/null +++ b/docs/tmpl/opentype.sgml @@ -0,0 +1,203 @@ +<!-- ##### SECTION Title ##### --> +OpenType Font Handling + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### TYPEDEF PangoOTTag ##### --> +<para> + +</para> + + +<!-- ##### STRUCT PangoOTInfo ##### --> +<para> + +</para> + + +<!-- ##### STRUCT PangoOTRuleset ##### --> +<para> + +</para> + + +<!-- ##### ENUM PangoOTTableType ##### --> +<para> + +</para> + +@PANGO_OT_TABLE_GSUB: +@PANGO_OT_TABLE_GPOS: + +<!-- ##### FUNCTION pango_ot_info_new ##### --> +<para> + +</para> + +@face: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_find_script ##### --> +<para> + +</para> + +@info: +@table_type: +@script_tag: +@script_index: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_find_language ##### --> +<para> + +</para> + +@info: +@table_type: +@script_index: +@language_tag: +@language_index: +@required_feature_index: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_find_feature ##### --> +<para> + +</para> + +@info: +@table_type: +@feature_tag: +@script_index: +@language_index: +@feature_index: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_list_scripts ##### --> +<para> + +</para> + +@info: +@table_type: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_list_languages ##### --> +<para> + +</para> + +@info: +@table_type: +@script_index: +@language_tag: +@Returns: + + +<!-- ##### FUNCTION pango_ot_info_list_features ##### --> +<para> + +</para> + +@info: +@table_type: +@tag: +@script_index: +@language_index: +@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> + +</para> + +@info: +@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> + +</para> + +@ruleset: +@table_type: +@feature_index: +@property_bit: + + +<!-- ##### FUNCTION pango_ot_ruleset_shape ##### --> +<para> + +</para> + +@ruleset: +@glyphs: +@properties: + + diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml index aa13ced2..5f929876 100644 --- a/docs/tmpl/tab-stops.sgml +++ b/docs/tmpl/tab-stops.sgml @@ -27,6 +27,13 @@ Tab Stops @PANGO_TAB_LEFT: +<!-- ##### MACRO PANGO_TYPE_TAB_ALIGN ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION pango_tab_array_new ##### --> <para> diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml index bd0546f6..aaab14a3 100644 --- a/docs/tmpl/text-attributes.sgml +++ b/docs/tmpl/text-attributes.sgml @@ -43,6 +43,13 @@ attribute is listed in parentheses after the description. @PANGO_ATTR_SHAPE: @PANGO_ATTR_SCALE: +<!-- ##### MACRO PANGO_TYPE_ATTR_TYPE ##### --> +<para> + +</para> + + + <!-- ##### STRUCT PangoAttrClass ##### --> <para> The #PangoAttrClass structure stores the type and operations for @@ -324,6 +331,13 @@ of underlining. accelerators. %PANGO_UNDERLINE_SINGLE should be used for extended portions of text. +<!-- ##### MACRO PANGO_TYPE_UNDERLINE ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION pango_attr_rise_new ##### --> <para> diff --git a/docs/tmpl/xft-fonts.sgml b/docs/tmpl/xft-fonts.sgml new file mode 100644 index 00000000..fa1a95e4 --- /dev/null +++ b/docs/tmpl/xft-fonts.sgml @@ -0,0 +1,110 @@ +<!-- ##### SECTION Title ##### --> +Xft Fonts and Rendering + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + + +<!-- ##### MACRO PANGO_RENDER_TYPE_XFT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT PangoXftFont ##### --> +<para> + +</para> + +@parent_instance: +@xft_font: +@mini_font: +@fontmap: +@description: +@ot_info: +@mini_width: +@mini_height: +@mini_pad: +@in_cache: + +<!-- ##### FUNCTION pango_xft_get_context ##### --> +<para> + +</para> + +@display: +@screen: +@Returns: + + +<!-- ##### FUNCTION pango_xft_render ##### --> +<para> + +</para> + +@draw: +@color: +@font: +@glyphs: +@x: +@y: + + +<!-- ##### FUNCTION pango_xft_font_get_font ##### --> +<para> + +</para> + +@font: +@Returns: + + +<!-- ##### FUNCTION pango_xft_font_get_face ##### --> +<para> + +</para> + +@font: +@Returns: + + +<!-- ##### FUNCTION pango_xft_font_get_ot_info ##### --> +<para> + +</para> + +@font: +@Returns: + + +<!-- ##### FUNCTION pango_xft_font_get_display ##### --> +<para> + +</para> + +@font: +@Returns: + + +<!-- ##### FUNCTION pango_xft_font_get_unknown_glyph ##### --> +<para> + +</para> + +@font: +@wc: +@Returns: + + |