summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@src.gnome.org>2000-06-08 18:48:32 +0000
committerOwen Taylor <otaylor@src.gnome.org>2000-06-08 18:48:32 +0000
commit1e916c95bb218660ed34e9d712969462d9d9c161 (patch)
tree61eb5424ddc5f16b9524d0278893797d1e6079ba /docs
parent40bf30500165bd6a5116dc5214890781eb156a8c (diff)
downloadpango-1e916c95bb218660ed34e9d712969462d9d9c161.tar.gz
*** empty log message ***
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am17
-rw-r--r--docs/pango-sections.txt31
-rw-r--r--docs/tmpl/fonts.sgml170
-rw-r--r--docs/tmpl/pango-unused.sgml75
-rw-r--r--docs/tmpl/x-fonts.sgml78
5 files changed, 286 insertions, 85 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 5a3e6d4c..39aa9a03 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,5 +1,19 @@
## Process this file with automake to create Makefile.in.
+pangoheaders = \
+ ../pango/pango.h \
+ ../pango/pango-attributes.h \
+ ../pango/pango-context.h \
+ ../pango/pango-coverage.h \
+ ../pango/pango-engine.h \
+ ../pango/pango-font.h \
+ ../pango/pango-fontmap.h \
+ ../pango/pango-glyph.h \
+ ../pango/pango-item.h \
+ ../pango/pango-layout.h \
+ ../pango/pango-types.h \
+ ../pango/pangox.h
+
if HAVE_GTK_DOC
# The name of the module.
@@ -8,11 +22,10 @@ DOC_MODULE=pango
# The top-level SGML file.
DOC_MAIN_SGML_FILE=pango-docs.sgml
-INCLUDE_DIR=../pango
SOURCE_DIR=../pango
scan:
- gtkdoc-scan --module=$(DOC_MODULE) $(INCLUDE_DIR)/pango*.h
+ gtkdoc-scan --module=$(DOC_MODULE) $(pangoheaders)
templates: scan
gtkdoc-mktmpl --module=$(DOC_MODULE)
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index d7a1b673..458ef2a6 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -94,26 +94,32 @@ pango_font_description_to_string
PangoFont
PangoFontClass
PangoFontMetrics
-pango_font_init
-pango_font_ref
-pango_font_unref
pango_font_find_shaper
pango_font_describe
pango_font_get_coverage
pango_font_get_glyph_extents
pango_font_get_metrics
-pango_font_get_data
-pango_font_set_data
+PANGO_TYPE_FONT
+PANGO_FONT
+PANGO_IS_FONT
+PANGO_FONT_CLASS
+PANGO_IS_FONT_CLASS
+PANGO_FONT_GET_CLASS
+pango_font_get_type
<SUBSECTION>
PangoFontMap
PangoFontMapClass
-pango_font_map_init
-pango_font_map_ref
-pango_font_map_unref
pango_font_map_load_font
pango_font_map_list_families
pango_font_map_free_families
pango_font_map_list_fonts
+PANGO_TYPE_FONT_MAP
+PANGO_FONT_MAP
+PANGO_IS_FONT_MAP
+PANGO_FONT_MAP_CLASS
+PANGO_IS_FONT_MAP_CLASS
+PANGO_FONT_MAP_GET_CLASS
+pango_font_map_get_type
</SECTION>
<SECTION>
@@ -250,4 +256,13 @@ pango_x_load_font
pango_x_get_unknown_glyph
pango_x_has_glyph
pango_x_list_subfonts
+pango_x_font_map_for_display
+pango_x_shutdown_display
+pango_x_font_map_get_font_cache
+pango_x_font_subfont_xlfd
+PangoXFontCache
+pango_x_font_cache_new
+pango_x_font_cache_free
+pango_x_font_cache_load
+pango_x_font_cache_unload
</SECTION>
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index dd6ce068..762be79e 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -36,12 +36,11 @@ the characteristics of a font to load.
<!-- ##### ENUM PangoStyle ##### -->
<para>
-An enumeration specifying the various slant styles possible for a font.
</para>
-@PANGO_STYLE_NORMAL: the font is upright.
-@PANGO_STYLE_OBLIQUE: the font is slanted, but in a roman style.
-@PANGO_STYLE_ITALIC: the font is slanted in an italic style.
+@PANGO_STYLE_NORMAL:
+@PANGO_STYLE_OBLIQUE:
+@PANGO_STYLE_ITALIC:
<!-- ##### ENUM PangoWeight ##### -->
<para>
@@ -148,10 +147,7 @@ The #PangoFont structure contains one member
which the implementation fills in:
</para>
-@klass: a pointer to the <firstterm>class structure</firstterm>
- for this font. People using a #PangoFont should
- not directly access this member; they should use the
- appropriate wrapper functions.
+@parent_instance:
<!-- ##### STRUCT PangoFontClass ##### -->
<para>
@@ -171,7 +167,7 @@ It contains the following members:
</tbody></tgroup></informaltable>
</para>
-@destroy: a function to free the font structure and associated resources.
+@parent_class:
@describe: a function to describe the characteristics of a font. See
pango_font_describe().
@get_coverage: A function to get a coverage map for the font.
@@ -199,30 +195,6 @@ a font. It contains the following members:
as @ascent + @descent. Individual characters may have
extents exceeding this value.
-<!-- ##### FUNCTION pango_font_init ##### -->
-<para>
-
-</para>
-
-@font:
-
-
-<!-- ##### FUNCTION pango_font_ref ##### -->
-<para>
-
-</para>
-
-@font:
-
-
-<!-- ##### FUNCTION pango_font_unref ##### -->
-<para>
-
-</para>
-
-@font:
-
-
<!-- ##### FUNCTION pango_font_find_shaper ##### -->
<para>
@@ -276,25 +248,59 @@ a font. It contains the following members:
@metrics:
-<!-- ##### FUNCTION pango_font_get_data ##### -->
+<!-- ##### MACRO PANGO_TYPE_FONT ##### -->
<para>
</para>
-@font:
-@key:
-@Returns:
-<!-- ##### FUNCTION pango_font_set_data ##### -->
+<!-- ##### MACRO PANGO_FONT ##### -->
<para>
</para>
-@font:
-@key:
-@data:
-@destroy_func:
+@object:
+
+
+<!-- ##### MACRO PANGO_IS_FONT ##### -->
+<para>
+
+</para>
+
+@object:
+
+
+<!-- ##### MACRO PANGO_FONT_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO PANGO_IS_FONT_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO PANGO_FONT_GET_CLASS ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### FUNCTION pango_font_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
<!-- ##### STRUCT PangoFontMap ##### -->
@@ -312,10 +318,7 @@ pango_font_map_init() on the structure.
The #PangoFont structure contains one member which the implementation fills in:
</para>
-@klass: a pointer to the <firstterm>class structure</firstterm>
- for this font map. People using a #PangoFontMap should
- not directly access this member; they should use the
- appropriate wrapper functions.
+@parent_instance:
<!-- ##### STRUCT PangoFontMapClass ##### -->
<para>
@@ -323,76 +326,107 @@ The #PangoFontMapClass structure holds the virtual functions for
a particular #PangoFontMap implementation.
</para>
-@destroy: a function to free the font map structure and associated resources.
+@parent_class:
@load_font: a function to load a font with a given description. See
pango_font_map_load_font()
@list_fonts: A function to list available fonts. See pango_font_map_list_fonts()
@list_families: A function to list available font families. See
pango_font_map_list_families().
-<!-- ##### FUNCTION pango_font_map_init ##### -->
+<!-- ##### FUNCTION pango_font_map_load_font ##### -->
<para>
</para>
@fontmap:
+@desc:
+@Returns:
+<!-- # Unused Parameters # -->
+@size:
-<!-- ##### FUNCTION pango_font_map_ref ##### -->
+<!-- ##### FUNCTION pango_font_map_list_families ##### -->
<para>
</para>
@fontmap:
+@families:
+@n_families:
-<!-- ##### FUNCTION pango_font_map_unref ##### -->
+<!-- ##### FUNCTION pango_font_map_free_families ##### -->
<para>
</para>
-@fontmap:
+@families:
+@n_families:
-<!-- ##### FUNCTION pango_font_map_load_font ##### -->
+<!-- ##### FUNCTION pango_font_map_list_fonts ##### -->
<para>
</para>
@fontmap:
-@desc:
-@Returns:
-<!-- # Unused Parameters # -->
-@size:
+@family:
+@descs:
+@n_descs:
-<!-- ##### FUNCTION pango_font_map_list_families ##### -->
+<!-- ##### MACRO PANGO_TYPE_FONT_MAP ##### -->
<para>
</para>
-@fontmap:
-@families:
-@n_families:
-<!-- ##### FUNCTION pango_font_map_free_families ##### -->
+<!-- ##### MACRO PANGO_FONT_MAP ##### -->
<para>
</para>
-@families:
-@n_families:
+@object:
-<!-- ##### FUNCTION pango_font_map_list_fonts ##### -->
+<!-- ##### MACRO PANGO_IS_FONT_MAP ##### -->
<para>
</para>
-@fontmap:
-@family:
-@descs:
-@n_descs:
+@object:
+
+
+<!-- ##### MACRO PANGO_FONT_MAP_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO PANGO_IS_FONT_MAP_CLASS ##### -->
+<para>
+
+</para>
+
+@klass:
+
+
+<!-- ##### MACRO PANGO_FONT_MAP_GET_CLASS ##### -->
+<para>
+
+</para>
+
+@obj:
+
+
+<!-- ##### FUNCTION pango_font_map_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
diff --git a/docs/tmpl/pango-unused.sgml b/docs/tmpl/pango-unused.sgml
index a2882e7d..d55e95f5 100644
--- a/docs/tmpl/pango-unused.sgml
+++ b/docs/tmpl/pango-unused.sgml
@@ -2,6 +2,13 @@
=======
+<!-- ##### FUNCTION pango_font_ref ##### -->
+<para>
+
+</para>
+
+@font:
+
<!-- ##### FUNCTION pango_x_to_cp ##### -->
=======
@@ -49,6 +56,29 @@ that may be accessed by derived classes:
@font:
+<!-- ##### FUNCTION pango_font_map_unref ##### -->
+<para>
+
+</para>
+
+@fontmap:
+
+<!-- ##### FUNCTION pango_font_unref ##### -->
+<para>
+
+</para>
+
+@font:
+
+<!-- ##### FUNCTION pango_font_get_data ##### -->
+<para>
+
+</para>
+
+@font:
+@key:
+@Returns:
+
<!-- ##### FUNCTION pango_x_xlfd_get_ranges ##### -->
=======
@@ -68,6 +98,13 @@ that may be accessed by derived classes:
@trailing:
@x_pos: >>>>>>> 1.8
+<!-- ##### TYPEDEF PangoGlyphIndex ##### -->
+<para>
+The #PangoGlyphIndex type is an integral type used to store glyph
+indices.
+</para>
+
+
<!-- ##### FUNCTION pango_x_glyph_extents ##### -->
<para>
@@ -83,13 +120,6 @@ that may be accessed by derived classes:
@logical_ascent:
@logical_descent:
-<!-- ##### TYPEDEF PangoGlyphIndex ##### -->
-<para>
-The #PangoGlyphIndex type is an integral type used to store glyph
-indices.
-</para>
-
-
<!-- ##### FUNCTION pango_attribute_register_type ##### -->
<para>
@@ -204,6 +234,13 @@ X Rendering
@char_pos:
@trailing:
+<!-- ##### FUNCTION pango_font_init ##### -->
+<para>
+
+</para>
+
+@font:
+
<!-- ##### FUNCTION pango_x_list_cfonts ##### -->
<para>
@@ -224,6 +261,16 @@ X Rendering
@xlfd:
@Returns:
+<!-- ##### FUNCTION pango_font_set_data ##### -->
+<para>
+
+</para>
+
+@font:
+@key:
+@data:
+@destroy_func:
+
<!-- ##### FUNCTION g_glyph_string_set_size ##### -->
<para>
@@ -241,6 +288,13 @@ X Rendering
@charset:
@Returns:
+<!-- ##### FUNCTION pango_font_map_init ##### -->
+<para>
+
+</para>
+
+@fontmap:
+
<!-- ##### STRUCT PangoXCFont ##### -->
<para>
The PangoXCFont represents a component of a
@@ -305,6 +359,13 @@ the X Window system.
@Returns:
+<!-- ##### FUNCTION pango_font_map_ref ##### -->
+<para>
+
+</para>
+
+@fontmap:
+
<!-- ##### SECTION ./tmpl/pango-x.sgml:Long_Description ##### -->
<para>
diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml
index 2f19e077..ecbc147f 100644
--- a/docs/tmpl/x-fonts.sgml
+++ b/docs/tmpl/x-fonts.sgml
@@ -93,3 +93,81 @@ glyph index.
@Returns:
+<!-- ##### FUNCTION pango_x_font_map_for_display ##### -->
+<para>
+
+</para>
+
+@display:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_shutdown_display ##### -->
+<para>
+
+</para>
+
+@display:
+
+
+<!-- ##### FUNCTION pango_x_font_map_get_font_cache ##### -->
+<para>
+
+</para>
+
+@font_map:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_font_subfont_xlfd ##### -->
+<para>
+
+</para>
+
+@font:
+@subfont_id:
+@Returns:
+
+
+<!-- ##### STRUCT PangoXFontCache ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION pango_x_font_cache_new ##### -->
+<para>
+
+</para>
+
+@display:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_font_cache_free ##### -->
+<para>
+
+</para>
+
+@cache:
+
+
+<!-- ##### FUNCTION pango_x_font_cache_load ##### -->
+<para>
+
+</para>
+
+@cache:
+@xlfd:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_font_cache_unload ##### -->
+<para>
+
+</para>
+
+@cache:
+@fs:
+
+