summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@redhat.com>2000-03-07 02:02:15 +0000
committerOwen Taylor <otaylor@src.gnome.org>2000-03-07 02:02:15 +0000
commitdd0b4a5064c6f60adcfd2ea02e2d61fb60254d20 (patch)
tree39a121f4bd40300bcd67521104db86c12bd33165 /docs
parent6278d373c1a564ae4233a2e4b6d428a9f6202728 (diff)
downloadpango-dd0b4a5064c6f60adcfd2ea02e2d61fb60254d20.tar.gz
Convert log_clusters[] use from char offsets to byte offset - should make
Mon Mar 6 20:55:32 2000 Owen Taylor <otaylor@redhat.com> * libpango/mapping.c example/viewer.c: * modules/hangul/hangul.c modules/basic/basic.c modules/tamil/tamil.c: Convert log_clusters[] use from char offsets to byte offset - should make it easier to have all interface deal with stuff in byte offsets. * libpango/mapping.c libpango/pango-glyph.h: Rename x_to_cp and cp_to_x to make them "member functions" of glyph_string. * libpango/pango-types.h: Add a rectangle type for use in storing glyph/glyph-string extents, plus macros for extracting ascent/descent. * libpango/fonts.c libpango/pango-font.h libpango/pangox.c: Virtualize glyph extents function into the font. * libpango/pangox.c modules/*/*.c examples/viewer.c: Convert over to new rationalized unit system - everything in 1000ths of a point or 1000ths of a glyph unit. * libpango/pango-glyph.h libpango/glyphstring.c: Add function to get extents of a glyph string. (We may want to fastpath the width in the future, since getting the width seems to be a very common and time-critical operation)
Diffstat (limited to 'docs')
-rw-r--r--docs/pango-docs.sgml4
-rw-r--r--docs/pango-sections.txt37
-rw-r--r--docs/tmpl/fonts.sgml34
-rw-r--r--docs/tmpl/glyphs.sgml69
-rw-r--r--docs/tmpl/main.sgml21
-rw-r--r--docs/tmpl/pango-unused.sgml16
6 files changed, 158 insertions, 23 deletions
diff --git a/docs/pango-docs.sgml b/docs/pango-docs.sgml
index a6e75d8c..66fff619 100644
--- a/docs/pango-docs.sgml
+++ b/docs/pango-docs.sgml
@@ -3,6 +3,7 @@
<!entity pango-glyphs SYSTEM "sgml/glyphs.sgml">
<!entity pango-fonts SYSTEM "sgml/fonts.sgml">
<!entity pango-text-attributes SYSTEM "sgml/text-attributes.sgml">
+<!entity pango-layout SYSTEM "sgml/layout.sgml">
<!entity pango-coverage-maps SYSTEM "sgml/coverage-maps.sgml">
<!entity pango-engines SYSTEM "sgml/engines.sgml">
<!entity x-fonts SYSTEM "sgml/x-fonts.sgml">
@@ -19,6 +20,7 @@
&pango-glyphs;
&pango-fonts;
&pango-text-attributes;
+ &pango-layout;
&pango-coverage-maps;
&pango-engines;
</chapter>
@@ -28,4 +30,4 @@
&x-fonts;
&x-rendering;
</chapter>
-</book> \ No newline at end of file
+</book>
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index 251c410e..57809132 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -14,8 +14,6 @@ pango_context_new
pango_context_ref
pango_context_unref
pango_context_add_font_map
-pango_context_get_size
-pango_context_set_size
pango_context_get_font_description
pango_context_set_font_description
pango_context_get_base_dir
@@ -39,6 +37,11 @@ pango_x_to_cp
<SECTION>
<TITLE>Glyph Storage</TITLE>
<FILE>glyphs</FILE>
+PangoRectangle
+PANGO_ASCENT
+PANGO_DESCENT
+PANGO_LBEARING
+PANGO_RBEARING
PangoGlyph
PangoGlyphInfo
PangoGlyphGeometry
@@ -48,6 +51,7 @@ PangoGlyphString
pango_glyph_string_new
pango_glyph_string_set_size
pango_glyph_string_free
+pango_glyph_string_extents
</SECTION>
<SECTION>
@@ -77,6 +81,8 @@ pango_font_description_copy
pango_font_description_compare
pango_font_descriptions_free
pango_font_description_free
+pango_font_description_from_string
+pango_font_description_to_string
<SUBSECTION>
PangoFont
PangoFontClass
@@ -86,6 +92,7 @@ pango_font_unref
pango_font_find_shaper
pango_font_describe
pango_font_get_coverage
+pango_font_get_glyph_extents
pango_font_get_data
pango_font_set_data
<SUBSECTION>
@@ -143,6 +150,32 @@ pango_attr_iterator_destroy
</SECTION>
<SECTION>
+<TITLE>Layout Objects</TITLE>
+<FILE>layout</FILE>
+PangoLayout
+PangoLayoutLine
+PangoLayoutRun
+pango_layout_new
+pango_layout_ref
+pango_layout_unref
+
+pango_layout_set_text
+pango_layout_set_attributes
+pango_layout_set_width
+pango_layout_set_first_line_width
+pango_layout_set_justify
+
+pango_layout_cp_to_line_x
+pango_layout_get_line_count
+pango_layout_get_line
+
+pango_layout_line_ref
+pango_layout_line_unref
+pango_layout_line_x_to_cp
+pango_layout_line_get_extents
+</SECTION>
+
+<SECTION>
<TITLE>Engines</TITLE>
<FILE>engines</FILE>
PangoEngineInfo
diff --git a/docs/tmpl/fonts.sgml b/docs/tmpl/fonts.sgml
index 9b6a3f88..0f20836b 100644
--- a/docs/tmpl/fonts.sgml
+++ b/docs/tmpl/fonts.sgml
@@ -32,6 +32,7 @@ the characteristics of a font to load.
@variant: the variant (normal or small caps) of the font.
@weight: the weight (boldness) of the font.
@stretch: the relative width of the font.
+@size:
<!-- ##### ENUM PangoStyle ##### -->
<para>
@@ -112,6 +113,24 @@ within a family.
@desc:
+<!-- ##### FUNCTION pango_font_description_from_string ##### -->
+<para>
+
+</para>
+
+@str:
+@Returns:
+
+
+<!-- ##### FUNCTION pango_font_description_to_string ##### -->
+<para>
+
+</para>
+
+@desc:
+@Returns:
+
+
<!-- ##### STRUCT PangoFont ##### -->
<para>
The #PangoFont structure is used to represent
@@ -159,6 +178,7 @@ It contains the following member:
See pango_font_get_coverage().
@find_shaper: A function to find the shaper for a particular character
point. See pango_font_find_shaper.
+@get_glyph_extents:
<!-- ##### FUNCTION pango_font_init ##### -->
<para>
@@ -216,6 +236,17 @@ It contains the following member:
@Returns:
+<!-- ##### FUNCTION pango_font_get_glyph_extents ##### -->
+<para>
+
+</para>
+
+@font:
+@glyph:
+@ink_rect:
+@logical_rect:
+
+
<!-- ##### FUNCTION pango_font_get_data ##### -->
<para>
@@ -300,8 +331,9 @@ a particular #PangoFontMap implementation.
@fontmap:
@desc:
-@size:
@Returns:
+<!-- # Unused Parameters # -->
+@size:
<!-- ##### FUNCTION pango_font_map_list_families ##### -->
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index e50472f7..ad3fad44 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -17,6 +17,64 @@ glyphs.
</para>
+<!-- ##### STRUCT PangoRectangle ##### -->
+<para>
+The #PangoRectangle structure represents a rectangle. It is frequently
+used to represent the logical or ink extents of a single glyph or section
+of text. (See, for instance, pango_font_get_glyph_extents())
+</para>
+
+@x: X coordinate of the left side of the rectangle.
+@y: Y coordinate of the the top side of the rectangle.
+@width: width of the rectangle.
+@height: height of the rectangle.
+
+<!-- ##### MACRO PANGO_ASCENT ##### -->
+<para>
+Extracts the <firstterm>ascent</firstterm> from a #PangoRectangle
+representing glyph extents. The ascent is the distance from the
+baseline to the highest point of the character. This is positive if the
+glyph ascends above the baseline.
+</para>
+
+@rect: a #PangoRectangle
+
+
+<!-- ##### MACRO PANGO_DESCENT ##### -->
+<para>
+Extracts the <firstterm>descent</firstterm> from a #PangoRectangle
+representing glyph extents. The descent is the distance from the
+baseline to the lowest point of the character. This is positive if the
+glyph descends below the baseline.
+</para>
+
+@rect: a #PangoRectangle
+
+
+<!-- ##### MACRO PANGO_LBEARING ##### -->
+<para>
+Extracts the <firstterm>left bearing</firstterm> from a #PangoRectangle
+representing glyph extents. The descent is the distance from the
+horizontal origin to the farthest left point of the character.
+This is positive for characters drawn completely to the right of the
+glyph origin.
+</para>
+
+@rect: a #PangoRectangle
+
+
+<!-- ##### MACRO PANGO_RBEARING ##### -->
+<para>
+Extracts the <firstterm>left bearing</firstterm> from a #PangoRectangle
+representing glyph extents. The descent is the distance from the
+horizontal origin to the farthest left point of the character.
+This is positive except for characters drawn completely to the left of the
+horizontal origin.
+</para>
+
+@rect: a #PangoRectangle
+
+
<!-- ##### TYPEDEF PangoGlyph ##### -->
<para>
The #PangoGlyph structure represents a single glyph in the output
@@ -187,3 +245,14 @@ accessible fields
@string:
+<!-- ##### FUNCTION pango_glyph_string_extents ##### -->
+<para>
+
+</para>
+
+@glyphs:
+@font:
+@ink_rect:
+@logical_rect:
+
+
diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml
index 623fe185..748419c4 100644
--- a/docs/tmpl/main.sgml
+++ b/docs/tmpl/main.sgml
@@ -214,24 +214,6 @@ It contains the following fields:
@font_map:
-<!-- ##### FUNCTION pango_context_get_size ##### -->
-<para>
-
-</para>
-
-@context:
-@Returns:
-
-
-<!-- ##### FUNCTION pango_context_set_size ##### -->
-<para>
-
-</para>
-
-@context:
-@size:
-
-
<!-- ##### FUNCTION pango_context_get_font_description ##### -->
<para>
@@ -293,8 +275,9 @@ It contains the following fields:
@context:
@desc:
-@size:
@Returns:
+<!-- # Unused Parameters # -->
+@size:
<!-- ##### FUNCTION pango_context_list_families ##### -->
diff --git a/docs/tmpl/pango-unused.sgml b/docs/tmpl/pango-unused.sgml
index 0420a65d..376bf35b 100644
--- a/docs/tmpl/pango-unused.sgml
+++ b/docs/tmpl/pango-unused.sgml
@@ -19,6 +19,14 @@ indices.
</para>
+<!-- ##### FUNCTION pango_context_get_size ##### -->
+<para>
+
+</para>
+
+@context:
+@Returns:
+
<!-- ##### FUNCTION pango_x_find_cfont ##### -->
<para>
@@ -85,6 +93,14 @@ Functions for rendering and measuring glyphs on
the X Window system.
+<!-- ##### FUNCTION pango_context_set_size ##### -->
+<para>
+
+</para>
+
+@context:
+@size:
+
<!-- ##### FUNCTION pango_attribute_register_type ##### -->
<para>