summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2008-09-18 00:26:07 -0400
committerBehdad Esfahbod <behdad@behdad.org>2008-09-18 00:26:07 -0400
commit1fe7088a113f8a9cb40d436f10af4967662cd02a (patch)
treec4174320064ac9c9e3b77ce5ae6db93106f98c29 /doc
parenta8cd426a4c79a7165b312f550ecc6a87b61303a3 (diff)
[show_text_glyphs] Replace the bool backward with cairo_text_cluster_flags
Chris rightfully complained that having a boolean function argument is new in cairo_show_text_glyphs, and indeed avoiding them has been one of the API design criteria for cairo. Trying to come up with alternatives, Owen suggested using a flag type which nicely solves the problem AND future-proofs such a complex API. Please welcome _flags_t APIs to cairo.h
Diffstat (limited to 'doc')
-rw-r--r--doc/public/cairo-sections.txt1
-rw-r--r--doc/public/tmpl/cairo-scaled-font.sgml2
-rw-r--r--doc/public/tmpl/cairo-text.sgml9
-rw-r--r--doc/public/tmpl/cairo-user-fonts.sgml2
4 files changed, 11 insertions, 3 deletions
diff --git a/doc/public/cairo-sections.txt b/doc/public/cairo-sections.txt
index 160de465d..c179e9229 100644
--- a/doc/public/cairo-sections.txt
+++ b/doc/public/cairo-sections.txt
@@ -398,6 +398,7 @@ cairo_glyph_t
cairo_font_slant_t
cairo_font_weight_t
cairo_text_cluster_t
+cairo_text_cluster_flags_t
cairo_select_font_face
cairo_set_font_size
cairo_set_font_matrix
diff --git a/doc/public/tmpl/cairo-scaled-font.sgml b/doc/public/tmpl/cairo-scaled-font.sgml
index 1abf0f3b7..0a0599a59 100644
--- a/doc/public/tmpl/cairo-scaled-font.sgml
+++ b/doc/public/tmpl/cairo-scaled-font.sgml
@@ -133,7 +133,7 @@ size and transformation and a certain set of font options.
@num_glyphs:
@clusters:
@num_clusters:
-@backward:
+@cluster_flags:
@Returns:
diff --git a/doc/public/tmpl/cairo-text.sgml b/doc/public/tmpl/cairo-text.sgml
index 0883f270a..64c63dae1 100644
--- a/doc/public/tmpl/cairo-text.sgml
+++ b/doc/public/tmpl/cairo-text.sgml
@@ -79,6 +79,13 @@ Cairo has two sets of text rendering capabilities:
@num_bytes:
@num_glyphs:
+<!-- ##### ENUM cairo_text_cluster_flags_t ##### -->
+<para>
+
+</para>
+
+@CAIRO_TEXT_CLUSTER_FLAG_BACKWARD:
+
<!-- ##### FUNCTION cairo_select_font_face ##### -->
<para>
@@ -211,7 +218,7 @@ Cairo has two sets of text rendering capabilities:
@num_glyphs:
@clusters:
@num_clusters:
-@backward:
+@cluster_flags:
<!-- ##### FUNCTION cairo_font_extents ##### -->
diff --git a/doc/public/tmpl/cairo-user-fonts.sgml b/doc/public/tmpl/cairo-user-fonts.sgml
index c8f353461..5b6dc5820 100644
--- a/doc/public/tmpl/cairo-user-fonts.sgml
+++ b/doc/public/tmpl/cairo-user-fonts.sgml
@@ -68,7 +68,7 @@ this feature (1.8 and later).
@num_glyphs:
@clusters:
@num_clusters:
-@backward:
+@cluster_flags:
@Returns: