diff options
author | Thomas Hunger <info@teh-web.de> | 2004-01-23 14:13:20 +0000 |
---|---|---|
committer | Thomas Hunger <info@teh-web.de> | 2004-01-23 14:13:20 +0000 |
commit | 6d465f4e439f2b01214618040af7a5cf7e230c2a (patch) | |
tree | 2020b5fc97353aa00ade754d5cb90119fcce4710 /doc/reference/xml | |
parent | 077fcb36da9d7edf8f7689ca913abce2c311925f (diff) |
added and updated documentation concerning text handling
Diffstat (limited to 'doc/reference/xml')
-rw-r--r-- | doc/reference/xml/cairo_arc.xml | 40 | ||||
-rw-r--r-- | doc/reference/xml/cairo_arc_negative.xml | 40 | ||||
-rw-r--r-- | doc/reference/xml/cairo_current_font.xml | 37 | ||||
-rw-r--r-- | doc/reference/xml/cairo_current_font_extents.xml | 40 | ||||
-rw-r--r-- | doc/reference/xml/cairo_curve_to.xml | 70 | ||||
-rw-r--r-- | doc/reference/xml/cairo_operator_t.xml | 54 | ||||
-rw-r--r-- | doc/reference/xml/cairo_rectangle.xml | 47 | ||||
-rw-r--r-- | doc/reference/xml/cairo_rel_curve_to.xml | 70 | ||||
-rw-r--r-- | doc/reference/xml/cairo_select_font.xml | 18 | ||||
-rw-r--r-- | doc/reference/xml/cairo_set_font.xml | 40 | ||||
-rw-r--r-- | doc/reference/xml/cairo_show_glyphs.xml | 46 | ||||
-rw-r--r-- | doc/reference/xml/cairo_show_text.xml | 4 | ||||
-rw-r--r-- | doc/reference/xml/cairo_transform_font.xml | 41 |
13 files changed, 502 insertions, 45 deletions
diff --git a/doc/reference/xml/cairo_arc.xml b/doc/reference/xml/cairo_arc.xml new file mode 100644 index 00000000..4b485918 --- /dev/null +++ b/doc/reference/xml/cairo_arc.xml @@ -0,0 +1,40 @@ +<refentry id="cairo_arc"> + <refmeta> + <refentrytitle>cairo_arc</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_arc</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_arc (cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>xc, yc</parameter> :</term> + <listitem> + <simpara>center of arc (a full arc makes a circle)</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_arc</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_arc_negative.xml b/doc/reference/xml/cairo_arc_negative.xml new file mode 100644 index 00000000..c7c1ec6b --- /dev/null +++ b/doc/reference/xml/cairo_arc_negative.xml @@ -0,0 +1,40 @@ +<refentry id="cairo_arc_negative"> + <refmeta> + <refentrytitle>cairo_arc_negative</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_arc_negative</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_arc_negative (cairo_t *cr, double xc, double yc, double radius, double angle1, double angle2);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>xc, yc</parameter> :</term> + <listitem> + <simpara>center of the arc</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_arc_negative</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_current_font.xml b/doc/reference/xml/cairo_current_font.xml new file mode 100644 index 00000000..b0c57e0d --- /dev/null +++ b/doc/reference/xml/cairo_current_font.xml @@ -0,0 +1,37 @@ + +<refentry id="cairo_current_font"> + <refmeta> + <refentrytitle>cairo_current_font</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_current_font</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + cairo_font_t * + cairo_current_font (<link linkend="cairo_t">cairo_t</link> *cr)</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_current_font</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + returns pointer to the current cairo_font_t object in the cairo_t + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_current_font_extents.xml b/doc/reference/xml/cairo_current_font_extents.xml new file mode 100644 index 00000000..3c3f9ad9 --- /dev/null +++ b/doc/reference/xml/cairo_current_font_extents.xml @@ -0,0 +1,40 @@ +<refentry id="cairo_current_font_extents"> + <refmeta> + <refentrytitle>cairo_current_font_extents</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_current_font_extents</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> +void cairo_current_font_extents (<link linkend="cairo_t">cairo_t</link> *cr, cairo_font_extents_t *extents)</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>extents</parameter> :</term> + <listitem> + <simpara>fills in a provided cairo_font_extents_t object</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_current_font_extents</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_curve_to.xml b/doc/reference/xml/cairo_curve_to.xml new file mode 100644 index 00000000..814771f2 --- /dev/null +++ b/doc/reference/xml/cairo_curve_to.xml @@ -0,0 +1,70 @@ +<refentry id="cairo_curve_to"> + <refmeta> + <refentrytitle>cairo_curve_to</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_curve_to</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_curve_to (cairo_t *cr, double x1, double y1, double x2, double y2, double x3, double y3);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x1</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y1</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x2</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y2</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x3</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>y3</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_curve_to</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_operator_t.xml b/doc/reference/xml/cairo_operator_t.xml index d8baf170..b659bb9b 100644 --- a/doc/reference/xml/cairo_operator_t.xml +++ b/doc/reference/xml/cairo_operator_t.xml @@ -14,46 +14,20 @@ <indexterm><primary>enums</primary> <secondary>cairo_operator_t</secondary></indexterm> <programlisting>typedef enum cairo_operator { - CAIRO_OPERATOR_CLEAR = PictOpClear, - CAIRO_OPERATOR_SRC = PictOpSrc, - CAIRO_OPERATOR_DST = PictOpDst, - CAIRO_OPERATOR_OVER = PictOpOver, - CAIRO_OPERATOR_OVER_REVERSE = PictOpOverReverse, - CAIRO_OPERATOR_IN = PictOpIn, - CAIRO_OPERATOR_IN_REVERSE = PictOpInReverse, - CAIRO_OPERATOR_OUT = PictOpOut, - CAIRO_OPERATOR_OUT_REVERSE = PictOpOutReverse, - CAIRO_OPERATOR_ATOP = PictOpAtop, - CAIRO_OPERATOR_ATOP_REVERSE = PictOpAtopReverse, - CAIRO_OPERATOR_XOR = PictOpXor, - CAIRO_OPERATOR_ADD = PictOpAdd, - CAIRO_OPERATOR_SATURATE = PictOpSaturate, - - CAIRO_OPERATOR_DISJOINT_CLEAR = PictOpDisjointClear, - CAIRO_OPERATOR_DISJOINT_SRC = PictOpDisjointSrc, - CAIRO_OPERATOR_DISJOINT_DST = PictOpDisjointDst, - CAIRO_OPERATOR_DISJOINT_OVER = PictOpDisjointOver, - CAIRO_OPERATOR_DISJOINT_OVER_REVERSE = PictOpDisjointOverReverse, - CAIRO_OPERATOR_DISJOINT_IN = PictOpDisjointIn, - CAIRO_OPERATOR_DISJOINT_IN_REVERSE = PictOpDisjointInReverse, - CAIRO_OPERATOR_DISJOINT_OUT = PictOpDisjointOut, - CAIRO_OPERATOR_DISJOINT_OUT_REVERSE = PictOpDisjointOutReverse, - CAIRO_OPERATOR_DISJOINT_ATOP = PictOpDisjointAtop, - CAIRO_OPERATOR_DISJOINT_ATOP_REVERSE = PictOpDisjointAtopReverse, - CAIRO_OPERATOR_DISJOINT_XOR = PictOpDisjointXor, - - CAIRO_OPERATOR_CONJOINT_CLEAR = PictOpConjointClear, - CAIRO_OPERATOR_CONJOINT_SRC = PictOpConjointSrc, - CAIRO_OPERATOR_CONJOINT_DST = PictOpConjointDst, - CAIRO_OPERATOR_CONJOINT_OVER = PictOpConjointOver, - CAIRO_OPERATOR_CONJOINT_OVER_REVERSE = PictOpConjointOverReverse, - CAIRO_OPERATOR_CONJOINT_IN = PictOpConjointIn, - CAIRO_OPERATOR_CONJOINT_IN_REVERSE = PictOpConjointInReverse, - CAIRO_OPERATOR_CONJOINT_OUT = PictOpConjointOut, - CAIRO_OPERATOR_CONJOINT_OUT_REVERSE = PictOpConjointOutReverse, - CAIRO_OPERATOR_CONJOINT_ATOP = PictOpConjointAtop, - CAIRO_OPERATOR_CONJOINT_ATOP_REVERSE = PictOpConjointAtopReverse, - CAIRO_OPERATOR_CONJOINT_XOR = PictOpConjointXor + CAIRO_OPERATOR_CLEAR, + CAIRO_OPERATOR_SRC, + CAIRO_OPERATOR_DST, + CAIRO_OPERATOR_OVER, + CAIRO_OPERATOR_OVER_REVERSE, + CAIRO_OPERATOR_IN, + CAIRO_OPERATOR_IN_REVERSE, + CAIRO_OPERATOR_OUT, + CAIRO_OPERATOR_OUT_REVERSE, + CAIRO_OPERATOR_ATOP, + CAIRO_OPERATOR_ATOP_REVERSE, + CAIRO_OPERATOR_XOR, + CAIRO_OPERATOR_ADD, + CAIRO_OPERATOR_SATURATE } cairo_operator_t; </programlisting> <para> diff --git a/doc/reference/xml/cairo_rectangle.xml b/doc/reference/xml/cairo_rectangle.xml new file mode 100644 index 00000000..ae7b76cc --- /dev/null +++ b/doc/reference/xml/cairo_rectangle.xml @@ -0,0 +1,47 @@ +<refentry id="cairo_rectangle"> + <refmeta> + <refentrytitle>cairo_rectangle</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_rectangle</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_rectangle (cairo_t *cr, double x, double y, double width, double height);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>x, y</parameter> :</term> + <listitem> + <simpara>coordinates of the left top corner</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>width, height</parameter> :</term> + <listitem> + <simpara>width and height of the rectangle</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_rectangle</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + The current line style applies to the lines of the rectangle. + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_rel_curve_to.xml b/doc/reference/xml/cairo_rel_curve_to.xml new file mode 100644 index 00000000..800e457b --- /dev/null +++ b/doc/reference/xml/cairo_rel_curve_to.xml @@ -0,0 +1,70 @@ +<refentry id="cairo_curve_to"> + <refmeta> + <refentrytitle>cairo_curve_to</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_curve_to</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_curve_to (cairo_t *cr, double dx1, double dy1, double dx2, double dy2, double dx3, double dy3);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dx1</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dy1</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dx2</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dy2</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dx3</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>dy3</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_curve_to</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_select_font.xml b/doc/reference/xml/cairo_select_font.xml index 09d55925..36bd782f 100644 --- a/doc/reference/xml/cairo_select_font.xml +++ b/doc/reference/xml/cairo_select_font.xml @@ -10,7 +10,7 @@ </refnamediv> <refsynopsisdiv> <programlisting> -void cairo_select_font (<link linkend="cairo_t">cairo_t</link> *cr, const char *key)</programlisting> +void cairo_select_font (<link linkend="cairo_t">cairo_t</link> *cr, const char *family, cairo_font_slant_t slant, cairo_font_weight_t weight);</programlisting> <variablelist role="params"> <varlistentry> <term><parameter>cr</parameter> :</term> @@ -19,9 +19,21 @@ void cairo_select_font (<link linkend="cairo_t">cairo_t</link> *cr, const char * </listitem> </varlistentry> <varlistentry> - <term><parameter>key</parameter> :</term> + <term><parameter>family</parameter> :</term> <listitem> - <simpara>description</simpara> + <simpara>name for the font family (e.g. XXX)</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>slant</parameter> :</term> + <listitem> + <simpara>see cairo_font_slant_t for valid values</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>weight</parameter> :</term> + <listitem> + <simpara>see cairo_font_weight_t for valid values</simpara> </listitem> </varlistentry> </variablelist> diff --git a/doc/reference/xml/cairo_set_font.xml b/doc/reference/xml/cairo_set_font.xml new file mode 100644 index 00000000..81946e08 --- /dev/null +++ b/doc/reference/xml/cairo_set_font.xml @@ -0,0 +1,40 @@ +<refentry id="cairo_set_font"> + <refmeta> + <refentrytitle>cairo_set_font</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_set_font</refname> + <refpurpose>replace the font in the current state</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> +void cairo_set_font (<link linkend="cairo_t">cairo_t</link> *cr, cairo_font_t *font)</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>font</parameter> :</term> + <listitem> + <simpara>replaces the current cairo_font_t object in the cairo_t with font. The replaced font in the cairo_t will be destroyed if there are no other references to it.</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_set_font</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_show_glyphs.xml b/doc/reference/xml/cairo_show_glyphs.xml new file mode 100644 index 00000000..9b4a3112 --- /dev/null +++ b/doc/reference/xml/cairo_show_glyphs.xml @@ -0,0 +1,46 @@ +<refentry id="cairo_show_glyphs"> + <refmeta> + <refentrytitle>cairo_show_glyphs</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_show_glyphs</refname> + <refpurpose>some description</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> +void cairo_show_glyphs (<link linkend="cairo_t">cairo_t</link> *cr, cairo_glyph_t *glyphs, int num_glyphs);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>a cairo_t</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>glyphs</parameter> :</term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>num_glyphs</parameter> :</term> + <listitem> + <simpara></simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_show_glyphs</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> diff --git a/doc/reference/xml/cairo_show_text.xml b/doc/reference/xml/cairo_show_text.xml index 22eaef4d..484bc7e4 100644 --- a/doc/reference/xml/cairo_show_text.xml +++ b/doc/reference/xml/cairo_show_text.xml @@ -15,13 +15,13 @@ void cairo_show_text (<link linkend="cairo_t">cairo_t</link> *cr, const unsigned <varlistentry> <term><parameter>cr</parameter> :</term> <listitem> - <simpara>description</simpara> + <simpara>a cairo_t</simpara> </listitem> </varlistentry> <varlistentry> <term><parameter>utf8</parameter> :</term> <listitem> - <simpara>description</simpara> + <simpara>text to show</simpara> </listitem> </varlistentry> </variablelist> diff --git a/doc/reference/xml/cairo_transform_font.xml b/doc/reference/xml/cairo_transform_font.xml new file mode 100644 index 00000000..2767cf57 --- /dev/null +++ b/doc/reference/xml/cairo_transform_font.xml @@ -0,0 +1,41 @@ + +<refentry id="cairo_transform_font"> + <refmeta> + <refentrytitle>cairo_transform_font</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + <refnamediv> + <refname>cairo_transform_font</refname> + <refpurpose>set transformation matrix for individual glyphs</refpurpose> + </refnamediv> + <refsynopsisdiv> + <programlisting> + void cairo_transform_font (<link linkend="cairo_t">cairo_t</link> *cr, cairo_matrix_t *matrix);</programlisting> + <variablelist role="params"> + <varlistentry> + <term><parameter>cr</parameter> :</term> + <listitem> + <simpara>description</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>matrix</parameter> :</term> + <listitem> + <simpara>an affine transformation matrix</simpara> + </listitem> + </varlistentry> + </variablelist> + </refsynopsisdiv> + <refsect1> + <title>Description</title> + <para> + <indexterm> + <primary>functions</primary> + <secondary>cairo_transform_font</secondary> + </indexterm> + <indexterm> + <primary/> + </indexterm> + </para> + </refsect1> +</refentry> |