~ubuntu-branches/debian/squeeze/librsvg/squeeze

« back to all changes in this revision

Viewing changes to doc/xml/rsvg-cairo.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-05-01 14:23:09 UTC
  • mfrom: (1.1.22 upstream) (25.1.2 sid)
  • Revision ID: james.westby@ubuntu.com-20100501142309-f0otyldu6gyratt9
Tags: 2.26.3-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<refnamediv>
9
9
<refname>Cairo</refname>
10
10
<refpurpose></refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
13
<refsynopsisdiv id="rsvg-Cairo.synopsis" role="synopsis">
34
33
<refsect1 id="rsvg-Cairo.description" role="desc">
35
34
<title role="desc.title">Description</title>
36
35
<para>
37
 
 
38
36
</para>
39
37
</refsect1>
40
38
 
42
40
<title role="details.title">Details</title>
43
41
<refsect2 id="rsvg-handle-render-cairo" role="function" condition="since:2.14">
44
42
<title>rsvg_handle_render_cairo ()</title>
45
 
<indexterm zone="rsvg-handle-render-cairo" role="2.14"><primary>rsvg_handle_render_cairo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rsvg_handle_render_cairo            (<link linkend="RsvgHandle">RsvgHandle</link> *handle,
 
43
<indexterm zone="rsvg-handle-render-cairo" role="2.14"><primary sortas="rsvg_handle_render_cairo">rsvg_handle_render_cairo</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rsvg_handle_render_cairo            (<link linkend="RsvgHandle">RsvgHandle</link> *handle,
46
44
                                                         <link linkend="cairo-t">cairo_t</link> *cr);</programlisting>
47
45
<para>
48
46
Draws a SVG to a Cairo surface</para>
49
47
<para>
50
 
 
51
48
</para><variablelist role="params">
52
 
<varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
 
49
<varlistentry><term><parameter>handle</parameter>&#160;:</term>
53
50
<listitem><simpara> A RsvgHandle
54
51
</simpara></listitem></varlistentry>
55
 
<varlistentry><term><parameter>cr</parameter>&nbsp;:</term>
 
52
<varlistentry><term><parameter>cr</parameter>&#160;:</term>
56
53
<listitem><simpara> A Cairo renderer
57
54
</simpara></listitem></varlistentry>
58
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
59
 
 
60
 
 
 
55
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if drawing succeeded.
61
56
</simpara></listitem></varlistentry>
62
 
</variablelist><para role="since">Since  2.14
63
 
</para></refsect2>
 
57
</variablelist><para role="since">Since 2.14</para></refsect2>
64
58
<refsect2 id="rsvg-handle-render-cairo-sub" role="function" condition="since:2.14">
65
59
<title>rsvg_handle_render_cairo_sub ()</title>
66
 
<indexterm zone="rsvg-handle-render-cairo-sub" role="2.14"><primary>rsvg_handle_render_cairo_sub</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rsvg_handle_render_cairo_sub        (<link linkend="RsvgHandle">RsvgHandle</link> *handle,
 
60
<indexterm zone="rsvg-handle-render-cairo-sub" role="2.14"><primary sortas="rsvg_handle_render_cairo_sub">rsvg_handle_render_cairo_sub</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            rsvg_handle_render_cairo_sub        (<link linkend="RsvgHandle">RsvgHandle</link> *handle,
67
61
                                                         <link linkend="cairo-t">cairo_t</link> *cr,
68
62
                                                         const <link linkend="char">char</link> *id);</programlisting>
69
63
<para>
70
64
Draws a subset of a SVG to a Cairo surface</para>
71
65
<para>
72
 
 
73
66
</para><variablelist role="params">
74
 
<varlistentry><term><parameter>handle</parameter>&nbsp;:</term>
 
67
<varlistentry><term><parameter>handle</parameter>&#160;:</term>
75
68
<listitem><simpara> A RsvgHandle
76
69
</simpara></listitem></varlistentry>
77
 
<varlistentry><term><parameter>cr</parameter>&nbsp;:</term>
 
70
<varlistentry><term><parameter>cr</parameter>&#160;:</term>
78
71
<listitem><simpara> A Cairo renderer
79
72
</simpara></listitem></varlistentry>
80
 
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
81
 
<listitem><simpara> An element's id within the SVG, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to render the whole SVG. For
 
73
<varlistentry><term><parameter>id</parameter>&#160;:</term>
 
74
<listitem><simpara> An element's id within the SVG, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to render the whole SVG. For
82
75
example, if you have a layer called "layer1" that you wish to render, pass 
83
76
"#<link linkend="layer1"><type>layer1</type></link>" as the id.
84
77
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
86
 
 
 
78
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if drawing succeeded.
87
79
 
88
80
</simpara></listitem></varlistentry>
89
 
</variablelist><para role="since">Since  2.14
90
 
</para></refsect2>
 
81
</variablelist><para role="since">Since 2.14</para></refsect2>
91
82
 
92
83
</refsect1>
93
84