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
|
<!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>Ipelib: IpePdfWriter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<h1>IpePdfWriter Class Reference</h1><!-- doxytag: class="IpePdfWriter" -->Create PDF file.
<a href="#_details">More...</a>
<p>
<a href="class_ipe_pdf_writer-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="class_ipe_pdf_writer.html#a0">IpePdfWriter</a> (<a class="el" href="class_ipe_tell_stream.html">IpeTellStream</a> &stream, const <a class="el" href="class_ipe_document.html">IpeDocument</a> *doc, bool noShading, bool lastView, int compression)
<li><a class="el" href="class_ipe_pdf_writer.html#a1">~IpePdfWriter</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#a2">EmbedFonts</a> (const <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> *pool)
<li>void <a class="el" href="class_ipe_pdf_writer.html#a3">CreatePages</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#a4">CreateBookmarks</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#a5">CreateXmlStream</a> (<a class="el" href="class_ipe_string.html">IpeString</a> xmldata, bool preCompressed)
<li>void <a class="el" href="class_ipe_pdf_writer.html#a6">CreateTrailer</a> (<a class="el" href="class_ipe_string.html">IpeString</a> creator)
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Create PDF file.
<p>
This class is responsible for the creation of a PDF file from the Ipe data. You have to create an IpePdfWriter first, providing a file that has been opened for (binary) writing and is empty. Then call <a class="el" href="class_ipe_pdf_writer.html#a2">EmbedFonts()</a> to embed the <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> and <a class="el" href="class_ipe_pdf_writer.html#a3">CreatePages()</a> to embed the pages. <code>CreateXmlStream</code> embeds a stream with the XML representation of the Ipe document. Finally, call <code>CreateTrailer</code> to complete the PDF document, and close the file.<p>
Some reserved PDF object numbers:<p>
<ul>
<li>0: Must be left empty (a PDF restriction).</li><li>1: Ipe XML stream.</li><li>2: Parent of all pages objects.</li></ul>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="IpePdfWriter::IpePdfWriter" ref="a0" args="(IpeTellStream &stream, const IpeDocument *doc, bool noShading, bool lastView, int compression)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">IpePdfWriter::IpePdfWriter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_tell_stream.html">IpeTellStream</a> & </td>
<td class="mdname" nowrap> <em>stream</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="class_ipe_document.html">IpeDocument</a> * </td>
<td class="mdname" nowrap> <em>doc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>noShading</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>lastView</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>compression</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create PDF writer operating on this (open and empty) file.
<p>
If <em>noShading</em> is <code>true</code>, no background shading will be applied to pages (if such a shading is defined in the document's style sheet. </td>
</tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="IpePdfWriter::~IpePdfWriter" ref="a1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">IpePdfWriter::~IpePdfWriter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2"></a><!-- doxytag: member="IpePdfWriter::EmbedFonts" ref="a2" args="(const IpeFontPool *pool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpePdfWriter::EmbedFonts </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pool</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Write all fonts to the PDF file, and fill in their object numbers. Embeds no fonts if <code>pool</code> is 0, but must be called nevertheless. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="IpePdfWriter::CreatePages" ref="a3" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpePdfWriter::CreatePages </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create all PDF pages.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="IpePdfWriter::CreateBookmarks" ref="a4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpePdfWriter::CreateBookmarks </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create the bookmarks (PDF outline).
<p>
</td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="IpePdfWriter::CreateXmlStream" ref="a5" args="(IpeString xmldata, bool preCompressed)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpePdfWriter::CreateXmlStream </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
<td class="mdname" nowrap> <em>xmldata</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>preCompressed</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a stream containing the XML data.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="IpePdfWriter::CreateTrailer" ref="a6" args="(IpeString creator)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void IpePdfWriter::CreateTrailer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
<td class="mdname1" valign="top" nowrap> <em>creator</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create the root objects and trailer of the PDF file.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipepdfwriter.h<li>ipepdfwriter.cpp</ul>
<hr>
</body></html>
|
