diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.am | 31 | ||||
| -rw-r--r-- | docs/pango-docs.sgml | 157 | ||||
| -rw-r--r-- | docs/pango-querymodules.xml | 4 | ||||
| -rw-r--r-- | docs/pango_markup.sgml | 12 | ||||
| -rw-r--r-- | docs/tmpl/atsui-fonts.sgml | 25 | ||||
| -rw-r--r-- | docs/tmpl/coretext-fonts.sgml | 40 | ||||
| -rw-r--r-- | docs/tmpl/fonts.sgml | 11 | ||||
| -rw-r--r-- | docs/tmpl/glyphs.sgml | 19 | ||||
| -rw-r--r-- | docs/tmpl/layout.sgml | 6 | ||||
| -rw-r--r-- | docs/tmpl/main.sgml | 4 | ||||
| -rw-r--r-- | docs/tmpl/tab-stops.sgml | 2 | ||||
| -rw-r--r-- | docs/tmpl/text-attributes.sgml | 11 |
12 files changed, 207 insertions, 115 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index 129f2cb3..0a6c53cc 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -7,7 +7,10 @@ DOC_MODULE=pango DOC_MAIN_SGML_FILE=pango-docs.sgml # Extra options to supply to gtkdoc-scan -SCAN_OPTIONS=--deprecated-guards="PANGO_DISABLE_DEPRECATED" --rebuild-types +SCAN_OPTIONS=--deprecated-guards="PANGO_DISABLE_DEPRECATED" + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml # The directory containing the source code. Relative to $(srcdir) DOC_SOURCE_DIR=../pango @@ -43,25 +46,9 @@ IGNORE_HFILES= \ pangoxft-private.h \ pango-ot-private.h \ pango-script-lang-table.h \ - pango-language-sample-table.h - -if HAVE_CORE_TEXT -else -IGNORE_HFILES+= \ - pangocoretext.h \ + pango-language-sample-table.h \ pangocoretext-private.h \ - pangocairo-coretext.h \ - pangocairo-coretextfont.h -endif - -if HAVE_CAIRO_ATSUI -else -IGNORE_HFILES+= \ - pangoatsui.h \ - pangoatsui-private.h \ - pangocairo-atsui.h \ - pangocairo-atsuifont.h -endif + pangoatsui-private.h # CFLAGS and LDFLAGS for compiling scan program. Only needed # if $(DOC_MODULE).types is non-empty. @@ -95,10 +82,6 @@ endif GTKDOC_LIBS += $(GLIB_LIBS) -# Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS=--sgml-mode --output-format=xml - - # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ pango_markup.sgml \ @@ -123,7 +106,7 @@ $(REPORT_FILES): sgml-build.stamp pango.types: @echo "Rebuilding $@" - @LANG=C; LIST=$$(grep 'pango_[_a-zA-Z0-9]*_get_type' $(HFILE_GLOB) | grep -v '\(private\|atsui\|win32\)' | sed 's/\([^:]*:\).*\(pango[_a-zA-Z0-9]*_get_type\).*/\1\2/') && \ + @LANG=C; LIST=$$(grep 'pango_[_a-zA-Z0-9]*_get_type' $(HFILE_GLOB) | grep -v '\(private\|atsui\|core_text\|win32\)' | sed 's/\([^:]*:\).*\(pango[_a-zA-Z0-9]*_get_type\).*/\1\2/') && \ echo "$$LIST" | sed 's/.*\/\(pango\/.*\):.*/#include <\1>/' | sort -u > $@.tmp && \ echo >> $@.tmp && \ echo "$$LIST" | cut -d : -f 2 | sort -u >> $@.tmp && \ diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml index a94cb2bc..15f19730 100644 --- a/docs/pango-docs.sgml +++ b/docs/pango-docs.sgml @@ -1,39 +1,11 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" - "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ -<!ENTITY pango-Text-Processing SYSTEM "xml/main.xml"> -<!ENTITY pango-Glyph-Storage SYSTEM "xml/glyphs.xml"> -<!ENTITY pango-Coverage-Maps SYSTEM "xml/coverage-maps.xml"> -<!ENTITY pango-Fonts SYSTEM "xml/fonts.xml"> -<!ENTITY pango-Text-Attributes SYSTEM "xml/text-attributes.xml"> -<!ENTITY pango-Tab-Stops SYSTEM "xml/tab-stops.xml"> -<!ENTITY pango-Layout-Objects SYSTEM "xml/layout.xml"> -<!ENTITY pango-Scripts SYSTEM "xml/scripts.xml"> -<!ENTITY pango-Engines SYSTEM "xml/engines.xml"> -<!ENTITY PangoEngineLang SYSTEM "xml/pango-engine-lang.xml"> -<!ENTITY PangoEngineShape SYSTEM "xml/pango-engine-shape.xml"> -<!ENTITY PangoRenderer SYSTEM "xml/pango-renderer.xml"> -<!ENTITY pango-Modules SYSTEM "xml/modules.xml"> -<!ENTITY pango-X-Fonts-and-Rendering SYSTEM "xml/x-fonts.xml"> -<!ENTITY pango-Win32-Fonts-and-Rendering SYSTEM "xml/win32-fonts.xml"> -<!ENTITY pango-FreeType-Fonts-and-Rendering SYSTEM "xml/freetype-fonts.xml"> -<!ENTITY pango-Xft-Fonts-and-Rendering SYSTEM "xml/xft-fonts.xml"> -<!ENTITY pango-ATSUI-Fonts SYSTEM "xml/atsui-fonts.xml"> -<!ENTITY pangocairo SYSTEM "xml/pangocairo.xml"> -<!ENTITY PangoFcFontMap SYSTEM "xml/pangofc-fontmap.xml"> -<!ENTITY PangoFcFont SYSTEM "xml/pangofc-font.xml"> -<!ENTITY PangoFcDecoder SYSTEM "xml/pangofc-decoder.xml"> -<!ENTITY pango-OpenType-Font-Handling SYSTEM "xml/opentype.xml"> -<!ENTITY pango-Misc-Utils SYSTEM "xml/utils.xml"> -<!ENTITY markup-format SYSTEM "pango_markup.sgml"> -<!ENTITY pango-querymodules SYSTEM "pango-querymodules.xml"> -<!ENTITY pango-Version SYSTEM "xml/pango-version.xml"> -<!ENTITY pango-Vertical-Text SYSTEM "xml/vertical.xml"> -<!ENTITY pango-Bidi-Text SYSTEM "xml/bidi.xml"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ +<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> <!ENTITY version SYSTEM "version.xml"> -<!ENTITY pango-tree-index SYSTEM "xml/tree_index.sgml"> ]> -<book id="index"> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> <bookinfo> <title>Pango Reference Manual</title> <releaseinfo>for Pango &version;</releaseinfo> @@ -41,104 +13,125 @@ <chapter id="pango"> <title>Basic Pango Interfaces</title> - &pango-Text-Processing; - &pango-Glyph-Storage; - &pango-Fonts; - &pango-Text-Attributes; - &pango-Tab-Stops; - &markup-format; - &pango-Layout-Objects; - &pango-Scripts; - &pango-Bidi-Text; - &pango-Vertical-Text; + <xi:include href="xml/main.xml"/> + <xi:include href="xml/glyphs.xml"/> + <xi:include href="xml/fonts.xml"/> + <xi:include href="xml/text-attributes.xml"/> + <xi:include href="xml/tab-stops.xml"/> + <xi:include href="pango_markup.sgml"/> + <xi:include href="xml/layout.xml"/> + <xi:include href="xml/scripts.xml"/> + <xi:include href="xml/bidi.xml"/> + <xi:include href="xml/vertical.xml"/> </chapter> <chapter id="rendering"> <title>Rendering with Pango</title> - &pango-Win32-Fonts-and-Rendering; - &pango-FreeType-Fonts-and-Rendering; - &pango-Xft-Fonts-and-Rendering; - &pangocairo; - &pango-ATSUI-Fonts; - &pango-X-Fonts-and-Rendering; + <xi:include href="xml/win32-fonts.xml"/> + <xi:include href="xml/freetype-fonts.xml"/> + <xi:include href="xml/xft-fonts.xml"/> + <xi:include href="xml/pangocairo.xml"/> + <xi:include href="xml/atsui-fonts.xml"/> + <xi:include href="xml/coretext-fonts.xml"/> + <xi:include href="xml/x-fonts.xml"/> </chapter> <chapter id="lowlevel"> <title>Low Level Functionality</title> - &PangoRenderer; - &PangoFcFontMap; - &PangoFcFont; - &PangoFcDecoder; - &pango-OpenType-Font-Handling; - &pango-Coverage-Maps; - &pango-Engines; - &PangoEngineLang; - &PangoEngineShape; - &pango-Modules; - &pango-Misc-Utils; - &pango-Version; + <xi:include href="xml/pango-renderer.xml"/> + <xi:include href="xml/pangofc-fontmap.xml"/> + <xi:include href="xml/pangofc-font.xml"/> + <xi:include href="xml/pangofc-decoder.xml"/> + <xi:include href="xml/opentype.xml"/> + <xi:include href="xml/coverage-maps.xml"/> + <xi:include href="xml/engines.xml"/> + <xi:include href="xml/pango-engine-lang.xml"/> + <xi:include href="xml/pango-engine-shape.xml"/> + <xi:include href="xml/modules.xml"/> + <xi:include href="xml/utils.xml"/> + <xi:include href="xml/pango-version.xml"/> </chapter> <chapter id="tools"> <title>Pango Tools</title> - - &pango-querymodules; + <xi:include href="pango-querymodules.xml"/> </chapter> <chapter id="pango-hierarchy"> <title>Object Hierarchy</title> - &pango-tree-index; + <xi:include href="xml/tree_index.sgml"/> </chapter> - <index id="index-all"> - <title>Index</title> + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> + + + <index id="api-index-full"> + <title>Index of all symbols</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> </index> - <index id="index-deprecated" role="deprecated"> + <index id="api-index-deprecated" role="deprecated"> <title>Index of deprecated symbols</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.2" role="1.2"> + <index id="api-index-1-2" role="1.2"> <title>Index of new symbols in 1.2</title> + <xi:include href="xml/api-index-1.2.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.4" role="1.4"> + <index id="api-index-1-4" role="1.4"> <title>Index of new symbols in 1.4</title> + <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.6" role="1.6"> + <index id="api-index-1-6" role="1.6"> <title>Index of new symbols in 1.6</title> + <xi:include href="xml/api-index-1.6.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.8" role="1.8"> + <index id="api-index-1-8" role="1.8"> <title>Index of new symbols in 1.8</title> + <xi:include href="xml/api-index-1.8.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.10" role="1.10"> + <index id="api-index-1-10" role="1.10"> <title>Index of new symbols in 1.10</title> + <xi:include href="xml/api-index-1.10.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.12" role="1.12"> + <index id="api-index-1-12" role="1.12"> <title>Index of new symbols in 1.12</title> + <xi:include href="xml/api-index-1.12.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.14" role="1.14"> + <index id="api-index-1-14" role="1.14"> <title>Index of new symbols in 1.14</title> + <xi:include href="xml/api-index-1.14.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.16" role="1.16"> + <index id="api-index-1-16" role="1.16"> <title>Index of new symbols in 1.16</title> + <xi:include href="xml/api-index-1.16.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.18" role="1.18"> + <index id="api-index-1-18" role="1.18"> <title>Index of new symbols in 1.18</title> + <xi:include href="xml/api-index-1.18.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.20" role="1.20"> + <index id="api-index-1-20" role="1.20"> <title>Index of new symbols in 1.20</title> + <xi:include href="xml/api-index-1.20.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.22" role="1.22"> + <index id="api-index-1-22" role="1.22"> <title>Index of new symbols in 1.22</title> + <xi:include href="xml/api-index-1.22.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.24" role="1.24"> + <index id="api-index-1-24" role="1.24"> <title>Index of new symbols in 1.24</title> + <xi:include href="xml/api-index-1.24.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.26" role="1.26"> + <index id="api-index-1-26" role="1.26"> <title>Index of new symbols in 1.26</title> + <xi:include href="xml/api-index-1.26.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.28" role="1.28"> + <index id="api-index-1-28" role="1.28"> <title>Index of new symbols in 1.28</title> + <xi:include href="xml/api-index-1.28.xml"><xi:fallback /></xi:include> </index> - <index id="index-1.30" role="1.30"> + <index id="api-index-1-30" role="1.30"> <title>Index of new symbols in 1.30</title> + <xi:include href="xml/api-index-1.30.xml"><xi:fallback /></xi:include> </index> + </book> diff --git a/docs/pango-querymodules.xml b/docs/pango-querymodules.xml index ee4030b2..38b482c3 100644 --- a/docs/pango-querymodules.xml +++ b/docs/pango-querymodules.xml @@ -37,8 +37,8 @@ The Pango module path is specified by the key <literal>Pango/ModulesPath</literal> in the Pango config database, which is read from <filename><replaceable>sysconfdir</replaceable>/pango/pangorc</filename>, - <filename>~/.pangorc</filename> and the file specified in the environment - variable <envar>PANGO_RC_FILE</envar>. + <filename>~/.config/pango/pangorc</filename> and the file specified in + the environment variable <envar>PANGO_RC_FILE</envar>. </para> </refsect1> diff --git a/docs/pango_markup.sgml b/docs/pango_markup.sgml index 0460ccbe..68d2901b 100644 --- a/docs/pango_markup.sgml +++ b/docs/pango_markup.sgml @@ -29,7 +29,7 @@ position. The solution is to include the text attributes in the string to be translated. Pango provides this feature with a small markup language. You can parse a marked-up string into the string text plus a -<link linkend="PangoAttrList">PangoAttrList</link> using the function +<link linkend="PangoAttrList">PangoAttrList</link> using the function <link linkend="pango-parse-markup">pango_parse_markup()</link>. </para> @@ -39,6 +39,12 @@ A simple example of a marked-up string might be: </para> <para> +Pango uses #GMarkup to parse this language, which means that XML features +such as numeric character entities such as &#169; for © can +be used too. +</para> + +<para> The root tag of a marked-up document is <markup>, but <link linkend="pango-parse-markup">pango_parse_markup()</link> allows you to omit this tag, so you will most likely never need to use it. The most @@ -50,8 +56,8 @@ tags. <span> has the following attributes: <term>font<footnote id='since_1_21'><para>Since 1.21</para></footnote></term> <term>font_desc</term> <listitem><para> -A font description string, such as "Sans Italic 12". See -<link linkend="pango-font-description-from-string">pango_font_description_from_string()</link> +A font description string, such as "Sans Italic 12". See +<link linkend="pango-font-description-from-string">pango_font_description_from_string()</link> for a description of the format of the string representation . Note that any other span attributes will override this description. So if you have "Sans Italic" and also a style="normal" attribute, you will get Sans normal, diff --git a/docs/tmpl/atsui-fonts.sgml b/docs/tmpl/atsui-fonts.sgml index 7f3c9dd3..f19081bd 100644 --- a/docs/tmpl/atsui-fonts.sgml +++ b/docs/tmpl/atsui-fonts.sgml @@ -21,3 +21,28 @@ MacOS systems using the ATSUI text rendering subsystem. <!-- ##### SECTION Image ##### --> +<!-- ##### MACRO PANGO_RENDER_TYPE_ATSUI ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION pango_atsui_font_get_cgfont ##### --> +<para> + +</para> + +@font: +@Returns: + + +<!-- ##### FUNCTION pango_atsui_font_get_atsfont ##### --> +<para> + +</para> + +@font: +@Returns: + + diff --git a/docs/tmpl/coretext-fonts.sgml b/docs/tmpl/coretext-fonts.sgml new file mode 100644 index 00000000..69d5d029 --- /dev/null +++ b/docs/tmpl/coretext-fonts.sgml @@ -0,0 +1,40 @@ +<!-- ##### SECTION Title ##### --> +CoreText Fonts + +<!-- ##### SECTION Short_Description ##### --> +Font handling with CoreText fonts + +<!-- ##### SECTION Long_Description ##### --> +<para> +The macros and functions in this section are used to access fonts natively on +OS X using the CoreText text rendering subsystem. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### SECTION Image ##### --> + + +<!-- ##### MACRO PANGO_RENDER_TYPE_CORE_TEXT ##### --> +<para> +A string constant identifying the CoreText renderer. The associated quark (see +g_quark_from_string()) is used to identify the renderer in pango_find_map(). +</para> + + + +<!-- ##### FUNCTION pango_core_text_font_get_ctfont ##### --> +<para> + +</para> + +@font: +@Returns: + + diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml index 16ca84f1..d4ce3160 100644 --- a/docs/tmpl/fonts.sgml +++ b/docs/tmpl/fonts.sgml @@ -442,6 +442,15 @@ the documentation of the corresponding getters for documentation of their meaning. </para> +@ref_count: +@ascent: +@descent: +@approximate_char_width: +@approximate_digit_width: +@underline_position: +@underline_thickness: +@strikethrough_position: +@strikethrough_thickness: <!-- ##### MACRO PANGO_TYPE_FONT_METRICS ##### --> <para> @@ -966,7 +975,7 @@ a particular #PangoFontset implementation. @fontset: @font: -@data: +@user_data: @Returns: diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml index 926bf539..5d4be350 100644 --- a/docs/tmpl/glyphs.sgml +++ b/docs/tmpl/glyphs.sgml @@ -168,6 +168,12 @@ horizontal origin. </para> +@xx: +@xy: +@yx: +@yy: +@x0: +@y0: <!-- ##### MACRO PANGO_TYPE_MATRIX ##### --> <para> @@ -389,6 +395,9 @@ The storage for the glyph information is owned by the structure which simplifies memory management. </para> +@num_glyphs: +@glyphs: +@log_clusters: <!-- ##### STRUCT PangoGlyphItem ##### --> <para> @@ -399,6 +408,8 @@ of shaping text with #PangoLayout is a list of #PangoLayoutLine, each of which contains a list of #PangoGlyphItem. </para> +@item: +@glyphs: <!-- ##### STRUCT PangoGlyphItemIter ##### --> <para> @@ -442,6 +453,14 @@ None of the members of a #PangoGlyphItemIter should be modified manually. </para> +@glyph_item: +@text: +@start_glyph: +@start_index: +@start_char: +@end_glyph: +@end_index: +@end_char: @Since: 1.22 <!-- ##### MACRO PANGO_TYPE_GLYPH_STRING ##### --> diff --git a/docs/tmpl/layout.sgml b/docs/tmpl/layout.sgml index 997507df..a3f22a03 100644 --- a/docs/tmpl/layout.sgml +++ b/docs/tmpl/layout.sgml @@ -845,6 +845,12 @@ Routines for rendering PangoLayout objects are provided in code specific to each rendering system. </para> +@layout: +@start_index: +@length: +@runs: +@is_paragraph_start: +@resolved_dir: <!-- ##### TYPEDEF PangoLayoutRun ##### --> <para> diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index 112baaaf..f3759cec 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -36,6 +36,10 @@ The #PangoItem structure stores information about a segment of text. It contains the following fields: </para> +@offset: +@length: +@num_chars: +@analysis: <!-- ##### STRUCT PangoAnalysis ##### --> <para> diff --git a/docs/tmpl/tab-stops.sgml b/docs/tmpl/tab-stops.sgml index 0e28a72e..62b02020 100644 --- a/docs/tmpl/tab-stops.sgml +++ b/docs/tmpl/tab-stops.sgml @@ -68,7 +68,7 @@ The #GObject type for #PangoTabAlign. @positions_in_pixels: @first_alignment: @first_position: -@...: +@Varargs: @Returns: diff --git a/docs/tmpl/text-attributes.sgml b/docs/tmpl/text-attributes.sgml index d7b5cb51..edcd3ec9 100644 --- a/docs/tmpl/text-attributes.sgml +++ b/docs/tmpl/text-attributes.sgml @@ -465,8 +465,10 @@ A copy function passed to attribute new functions that take user data. </para> -@data: the user data +@user_data: @Returns: a new copy of @data. +<!-- # Unused Parameters # --> +@data: the user data <!-- ##### FUNCTION pango_attr_scale_new ##### --> @@ -578,6 +580,9 @@ The #PangoColor structure is used to represent a color in an uncalibrated RGB color-space. </para> +@red: +@green: +@blue: <!-- ##### MACRO PANGO_TYPE_COLOR ##### --> <para> @@ -736,8 +741,10 @@ to filter out a subset of attributes for a list. </para> @attribute: a #PangoAttribute -@data: callback data passed to pango_attr_list_filter() +@user_data: @Returns: %TRUE if the attribute should be filtered out +<!-- # Unused Parameters # --> +@data: callback data passed to pango_attr_list_filter() <!-- ##### FUNCTION pango_attr_list_get_iterator ##### --> |