1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>cairomm: Cairo::SvgSurface Class Reference</title>
<link href="cairomm.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceCairo.html">Cairo</a>::<a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a>
</div>
</div>
<div class="contents">
<h1>Cairo::SvgSurface Class Reference</h1><!-- doxytag: class="Cairo::SvgSurface" --><!-- doxytag: inherits="Cairo::Surface" -->A <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> provides a way to render Scalable Vector Graphics (SVG) images from cairo.
<a href="#_details">More...</a>
<p>
Inherits <a class="el" href="classCairo_1_1Surface.html">Cairo::Surface</a>.
<p>
<p>
<a href="classCairo_1_1SvgSurface-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#67303207546ee57abfa62d4d0892575f">SvgSurface</a> (cairo_surface_t*<a class="el" href="classCairo_1_1Surface.html#d176eb7343b5902df3c19f9f56e59fb4">cobject</a>, bool has_reference=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a C++ wrapper for the C instance. <a href="#67303207546ee57abfa62d4d0892575f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#f782712407e736ea1d5c4e4c272ff7f1">~SvgSurface</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#4ac854641fe28b16c5e01582d91e22dc">restrict_to_version</a> (<a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a> version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Restricts the generated SVG file to the given version. <a href="#4ac854641fe28b16c5e01582d91e22dc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>< <a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#54d98ee27aa6274627335d8ccbd34a6e">create</a> (<a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00218.html">std::string</a> filename, double width_in_points, double height_in_points)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> with a specified dimensions that will be saved as the given filename. <a href="#54d98ee27aa6274627335d8ccbd34a6e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>< <a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#3cc1ca3b8191ab2366b20fea664c2ce9">create_for_stream</a> (const <a class="el" href="classCairo_1_1Surface.html#02fb9416d466b762bc5845b0ae204f49">SlotWriteFunc</a>& write_func, double width_in_points, double height_in_points)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> with a specified dimensions that will be written to the given write function instead of saved directly to disk. <a href="#3cc1ca3b8191ab2366b20fea664c2ce9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a>< <a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#88fc030bd0b9ffa7f3455fcdf383ea16">create</a> (cairo_write_func_t write_func, void* closure, double width_in_points, double height_in_points)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00599.html">std::vector</a><br class="typebreak">
< <a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#25403772072f28f7c40e6478332babaa">get_versions</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of SVG versions supported by cairo. <a href="#25403772072f28f7c40e6478332babaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00218.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCairo_1_1SvgSurface.html#3a15a5df131a8ef6cc8786342c7e6dfc">version_to_string</a> (<a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a> version)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the string representation of the given version id. <a href="#3a15a5df131a8ef6cc8786342c7e6dfc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> provides a way to render Scalable Vector Graphics (SVG) images from cairo.
<p>
This surface is not rendered to the screen but instead renders the drawing to an SVG file on disk.<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd>For this <a class="el" href="classCairo_1_1Surface.html" title="A cairo surface represents an image, either as the destination of a drawing operation...">Surface</a> to be available, cairo must have been compiled with SVG support </dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="67303207546ee57abfa62d4d0892575f"></a><!-- doxytag: member="Cairo::SvgSurface::SvgSurface" ref="67303207546ee57abfa62d4d0892575f" args="(cairo_surface_t *cobject, bool has_reference=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Cairo::SvgSurface::SvgSurface </td>
<td>(</td>
<td class="paramtype">cairo_surface_t * </td>
<td class="paramname"> <em>cobject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>has_reference</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a C++ wrapper for the C instance.
<p>
This C++ instance should then be given to a <a class="el" href="classCairo_1_1RefPtr.html" title="RefPtr<> is a reference-counting shared smartpointer.">RefPtr</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cobject</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>has_reference</em> </td><td>whether we already have a reference. Otherwise, the constructor will take an extra reference. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f782712407e736ea1d5c4e4c272ff7f1"></a><!-- doxytag: member="Cairo::SvgSurface::~SvgSurface" ref="f782712407e736ea1d5c4e4c272ff7f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Cairo::SvgSurface::~SvgSurface </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="88fc030bd0b9ffa7f3455fcdf383ea16"></a><!-- doxytag: member="Cairo::SvgSurface::create" ref="88fc030bd0b9ffa7f3455fcdf383ea16" args="(cairo_write_func_t write_func, void *closure, double width_in_points, double height_in_points)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a><<a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a>> Cairo::SvgSurface::create </td>
<td>(</td>
<td class="paramtype">cairo_write_func_t </td>
<td class="paramname"> <em>write_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>closure</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>width_in_points</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>height_in_points</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>Use <a class="el" href="classCairo_1_1SvgSurface.html#3cc1ca3b8191ab2366b20fea664c2ce9" title="Creates a SvgSurface with a specified dimensions that will be written to the given...">SvgSurface::create_for_stream()</a> instead </dd></dl>
</div>
</div><p>
<a class="anchor" name="54d98ee27aa6274627335d8ccbd34a6e"></a><!-- doxytag: member="Cairo::SvgSurface::create" ref="54d98ee27aa6274627335d8ccbd34a6e" args="(std::string filename, double width_in_points, double height_in_points)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a><<a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a>> Cairo::SvgSurface::create </td>
<td>(</td>
<td class="paramtype"><a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00218.html">std::string</a> </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>width_in_points</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>height_in_points</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> with a specified dimensions that will be saved as the given filename.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The name of the SVG file to save the surface to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>width_in_points</em> </td><td>The width of the SVG document in points </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height_in_points</em> </td><td>The height of the SVG document in points </td></tr>
</table>
</dl>
<dl compact><dt><b>Examples: </b></dt><dd>
<a class="el" href="svg-surface_8cc-example.html#a2">svg-surface.cc</a>.</dl>
</div>
</div><p>
<a class="anchor" name="3cc1ca3b8191ab2366b20fea664c2ce9"></a><!-- doxytag: member="Cairo::SvgSurface::create_for_stream" ref="3cc1ca3b8191ab2366b20fea664c2ce9" args="(const SlotWriteFunc &write_func, double width_in_points, double height_in_points)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCairo_1_1RefPtr.html">RefPtr</a><<a class="el" href="classCairo_1_1SvgSurface.html">SvgSurface</a>> Cairo::SvgSurface::create_for_stream </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCairo_1_1Surface.html#02fb9416d466b762bc5845b0ae204f49">SlotWriteFunc</a>& </td>
<td class="paramname"> <em>write_func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>width_in_points</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>height_in_points</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a <a class="el" href="classCairo_1_1SvgSurface.html" title="A SvgSurface provides a way to render Scalable Vector Graphics (SVG) images from...">SvgSurface</a> with a specified dimensions that will be written to the given write function instead of saved directly to disk.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>write_func</em> </td><td>The function to be called when the backend needs to write data to an output stream </td></tr>
<tr><td valign="top"></td><td valign="top"><em>width_in_points</em> </td><td>The width of the SVG document in points </td></tr>
<tr><td valign="top"></td><td valign="top"><em>height_in_points</em> </td><td>The height of the SVG document in points</td></tr>
</table>
</dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>1.8 </dd></dl>
</div>
</div><p>
<a class="anchor" name="25403772072f28f7c40e6478332babaa"></a><!-- doxytag: member="Cairo::SvgSurface::get_versions" ref="25403772072f28f7c40e6478332babaa" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00599.html">std::vector</a><<a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a>> Cairo::SvgSurface::get_versions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves the list of SVG versions supported by cairo.
<p>
See <a class="el" href="classCairo_1_1SvgSurface.html#4ac854641fe28b16c5e01582d91e22dc" title="Restricts the generated SVG file to the given version.">restrict_to_version()</a>.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>1.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="4ac854641fe28b16c5e01582d91e22dc"></a><!-- doxytag: member="Cairo::SvgSurface::restrict_to_version" ref="4ac854641fe28b16c5e01582d91e22dc" args="(SvgVersion version)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Cairo::SvgSurface::restrict_to_version </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a> </td>
<td class="paramname"> <em>version</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Restricts the generated SVG file to the given version.
<p>
See <a class="el" href="classCairo_1_1SvgSurface.html#25403772072f28f7c40e6478332babaa" title="Retrieves the list of SVG versions supported by cairo.">get_versions()</a> for a list of available version values that can be used here.<p>
This function should only be called before any drawing operations have been performed on the given surface. The simplest way to do this is to call this function immediately after creating the surface.<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd>1.2 </dd></dl>
</div>
</div><p>
<a class="anchor" name="3a15a5df131a8ef6cc8786342c7e6dfc"></a><!-- doxytag: member="Cairo::SvgSurface::version_to_string" ref="3a15a5df131a8ef6cc8786342c7e6dfc" args="(SvgVersion version)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00218.html">std::string</a> Cairo::SvgSurface::version_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceCairo.html#853a6353847b8cd86001a98d36b245ca">SvgVersion</a> </td>
<td class="paramname"> <em>version</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the string representation of the given version id.
<p>
The returned string will be empty if version isn't valid. See <a class="el" href="classCairo_1_1SvgSurface.html#25403772072f28f7c40e6478332babaa" title="Retrieves the list of SVG versions supported by cairo.">get_versions()</a> for a way to get the list of valid version ids.<p>
since: 1.2
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cairomm/surface.h</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Aug 13 11:40:14 2009 for cairomm by 
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
|
