summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@src.gnome.org>2000-02-09 22:49:39 +0000
committerOwen Taylor <otaylor@src.gnome.org>2000-02-09 22:49:39 +0000
commit11884d20295c2aea6dfeb8a915dd02b48ec60d9c (patch)
treeac464ac218c4fd13fe61b2575bdc02d7106327de /docs
parent74ae6a352aab559117ad0c376753ef3e6afba55d (diff)
downloadpango-11884d20295c2aea6dfeb8a915dd02b48ec60d9c.tar.gz
added some docs files
Diffstat (limited to 'docs')
-rw-r--r--docs/.cvsignore1
-rw-r--r--docs/tmpl/x-fonts.sgml95
-rw-r--r--docs/tmpl/x-rendering.sgml81
3 files changed, 177 insertions, 0 deletions
diff --git a/docs/.cvsignore b/docs/.cvsignore
index e4476fa2..ca1374a6 100644
--- a/docs/.cvsignore
+++ b/docs/.cvsignore
@@ -1,5 +1,6 @@
sgml
html
+pango-unused.txt
pango-decl-list.txt
pango-decl.txt
Makefile.in
diff --git a/docs/tmpl/x-fonts.sgml b/docs/tmpl/x-fonts.sgml
new file mode 100644
index 00000000..2f19e077
--- /dev/null
+++ b/docs/tmpl/x-fonts.sgml
@@ -0,0 +1,95 @@
+<!-- ##### SECTION Title ##### -->
+X Fonts
+
+<!-- ##### SECTION Short_Description ##### -->
+Functions for shape engines to manipulate X fonts.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The functions and macros in this section are used by shape
+engines to look up glyphs for particular character
+sets within an #PangoFont for the X rendering system.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### TYPEDEF PangoXSubfont ##### -->
+<para>
+The #PangXSubFont type is an integer ID that identifies one
+particular X font within the fonts referenced in a
+a #PangoFont.
+</para>
+
+
+<!-- ##### MACRO PANGO_X_MAKE_GLYPH ##### -->
+<para>
+Make a glyph index from a #PangoXSubFont index and a index
+of a character with the corresponding X font.
+</para>
+
+@subfont: a #PangoXSubfont index
+@index: the index of a character within an X font.
+
+
+<!-- ##### MACRO PANGO_X_GLYPH_SUBFONT ##### -->
+<para>
+Extract the subfont index from a glyph index.
+</para>
+
+@glyph: a #PangoGlyphIndex
+
+
+<!-- ##### MACRO PANGO_X_GLYPH_INDEX ##### -->
+<para>
+Extract the character index within the X font from a
+glyph index.
+</para>
+
+@glyph: a #PangoGlyphIndex
+
+
+<!-- ##### FUNCTION pango_x_load_font ##### -->
+<para>
+
+</para>
+
+@display:
+@spec:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_get_unknown_glyph ##### -->
+<para>
+
+</para>
+
+@font:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_has_glyph ##### -->
+<para>
+
+</para>
+
+@font:
+@glyph:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_list_subfonts ##### -->
+<para>
+
+</para>
+
+@font:
+@charsets:
+@n_charsets:
+@subfont_ids:
+@subfont_charsets:
+@Returns:
+
+
diff --git a/docs/tmpl/x-rendering.sgml b/docs/tmpl/x-rendering.sgml
new file mode 100644
index 00000000..3c4d10d7
--- /dev/null
+++ b/docs/tmpl/x-rendering.sgml
@@ -0,0 +1,81 @@
+<!-- ##### SECTION Title ##### -->
+X Rendering
+
+<!-- ##### SECTION Short_Description ##### -->
+Functions for measuring glyphs and rendering X fonts.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+The functions in thjis system are used to take the output
+of the shaping modules and render that on the screen.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### MACRO PANGO_RENDER_TYPE_X ##### -->
+<para>
+%PANGO_RENDER_TYPE_X is a string constant that
+is used to identify shaping modules for the
+X Window System.
+</para>
+
+
+
+<!-- ##### FUNCTION pango_x_get_context ##### -->
+<para>
+
+</para>
+
+@display:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_x_render ##### -->
+<para>
+
+</para>
+
+@display:
+@d:
+@gc:
+@font:
+@glyphs:
+@x:
+@y:
+
+
+<!-- ##### FUNCTION pango_x_extents ##### -->
+<para>
+
+</para>
+
+@font:
+@glyphs:
+@lbearing:
+@rbearing:
+@width:
+@ascent:
+@descent:
+@logical_ascent:
+@logical_descent:
+
+
+<!-- ##### FUNCTION pango_x_glyph_extents ##### -->
+<para>
+
+</para>
+
+@font:
+@glyph:
+@lbearing:
+@rbearing:
+@width:
+@ascent:
+@descent:
+@logical_ascent:
+@logical_descent:
+
+