summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@gnome.org>2006-02-05 03:11:58 +0000
committerBehdad Esfahbod <behdad@src.gnome.org>2006-02-05 03:11:58 +0000
commit6cddbd51fe9e616847a17be379149822c88104bf (patch)
tree1bcecc7d9210c334829b439ef515585ebe297624 /docs
parent8adcead819b6bb6781f0b01c6b17175b2918af8f (diff)
downloadpango-6cddbd51fe9e616847a17be379149822c88104bf.tar.gz
Change PANGO_GLYPH_EMPTY to 0x0FFFFFFF, to not overlap with
2006-02-04 Behdad Esfahbod <behdad@gnome.org> * pango/pango-types.h: Change PANGO_GLYPH_EMPTY to 0x0FFFFFFF, to not overlap with PANGO_GLYPH_UNKNOWN_FLAG (0x10000000). Define PANGO_GET_UNKNOWN_GLYPH(wc) that simply returns wc|PANGO_GLYPH_UNKNOWN_FLAG. * docs/pango-sections.txt, docs/tmpl/glyphs.sgml: Document new symbols. * modules/*/*.c: Use PANGO_GET_UNKNOWN_GLYPH instead of various backend-specific functions. * pango/pangofc-font.c, pango/pangoft.c, pango/pangoxft-font.c, * pango/pangowin32.c, pango/pangox.c: Suggest using PANGO_GET_UNKNOWN_GLYPH in docs. * pango/pangofc-font.h: Deprecate pango_fc_font_get_unknown_glyph(). * pango/pangowin32.h: Deprecate pango_win32_get_unknown_glyph().
Diffstat (limited to 'docs')
-rw-r--r--docs/pango-sections.txt3
-rw-r--r--docs/tmpl/glyphs.sgml30
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/pango-sections.txt b/docs/pango-sections.txt
index ce994e94..a960ea32 100644
--- a/docs/pango-sections.txt
+++ b/docs/pango-sections.txt
@@ -80,6 +80,9 @@ pango_matrix_rotate
pango_matrix_concat
pango_matrix_get_font_scale_factor
PangoGlyph
+PANGO_GLYPH_EMPTY
+PANGO_GLYPH_UNKNOWN_FLAG
+PANGO_GET_UNKNOWN_GLYPH
PangoGlyphInfo
PangoGlyphGeometry
PangoGlyphUnit
diff --git a/docs/tmpl/glyphs.sgml b/docs/tmpl/glyphs.sgml
index 1232cd36..ebf5fafa 100644
--- a/docs/tmpl/glyphs.sgml
+++ b/docs/tmpl/glyphs.sgml
@@ -194,6 +194,36 @@ A #PangoGlyph represents a single glyph in the output form of a string.
</para>
+<!-- ##### MACRO PANGO_GLYPH_EMPTY ##### -->
+<para>
+The %PANGO_GLYPH_EMPTY macro represents a #PangoGlyph value that has a
+special meaning, which is a zero-width empty glyph. This is useful for
+example in shaper modules, to use as the glyph for various zero-width
+Unicode characters (those passing pango_is_zero_width()).
+</para>
+
+
+
+<!-- ##### MACRO PANGO_GLYPH_UNKNOWN_FLAG ##### -->
+<para>
+The %PANGO_GLYPH_UNKNOWN_FLAG macro is a flag value that can be added to
+a #gunichar value of a valid Unicode character, to produce a #PangoGlyph
+value, representing an unknown-character glyph for the respective #gunichar.
+</para>
+
+
+
+<!-- ##### MACRO PANGO_GET_UNKNOWN_GLYPH ##### -->
+<para>
+Returns a #PangoGlyph value that means no glyph was found for @wc.
+The way this unknown glyphs are rendered is backend specific. For example,
+a box with the hexadecimal Unicode code-point of the character written in it
+is what is done in the most common backends.
+</para>
+
+@wc: a Unicode character
+
+
<!-- ##### STRUCT PangoGlyphInfo ##### -->
<para>
The #PangoGlyphInfo structure represents a single glyph together with