1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
<title>Ipelib: IpePdfWriter class Reference</title>
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
6
<!-- Generated by Doxygen 1.3.6 -->
7
<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="functions.html">Class Members</a></div>
8
<h1>IpePdfWriter Class Reference</h1>Create PDF file.
9
<a href="#_details">More...</a>
11
<a href="class_ipe_pdf_writer-members.html">List of all members.</a><h2>Public Member Functions</h2>
13
<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, int compression)
14
<li><a class="el" href="class_ipe_pdf_writer.html#a1">~IpePdfWriter</a> ()
15
<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)
16
<li>void <a class="el" href="class_ipe_pdf_writer.html#a3">CreatePages</a> (bool lastView)
17
<li>void <a class="el" href="class_ipe_pdf_writer.html#a4">CreateBookmarks</a> ()
18
<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)
19
<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)
21
<hr><a name="_details"></a><h2>Detailed Description</h2>
24
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>, EmbedBitmaps() to embed the bitmaps, 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>
25
Some reserved PDF object numbers:<p>
27
<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>
30
<hr><h2>Constructor & Destructor Documentation</h2>
31
<a class="anchor" name="a0" doxytag="IpePdfWriter::IpePdfWriter" ></a><p>
32
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
35
<table cellpadding="0" cellspacing="0" border="0">
37
<td class="md" nowrap valign="top"> IpePdfWriter::IpePdfWriter </td>
38
<td class="md" valign="top">( </td>
39
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_tell_stream.html">IpeTellStream</a> & </td>
40
<td class="mdname" nowrap> <em>stream</em>, </td>
43
<td class="md" nowrap align="right"></td>
45
<td class="md" nowrap>const <a class="el" href="class_ipe_document.html">IpeDocument</a> * </td>
46
<td class="mdname" nowrap> <em>doc</em>, </td>
49
<td class="md" nowrap align="right"></td>
51
<td class="md" nowrap>bool </td>
52
<td class="mdname" nowrap> <em>noShading</em>, </td>
55
<td class="md" nowrap align="right"></td>
57
<td class="md" nowrap>int </td>
58
<td class="mdname" nowrap> <em>compression</em></td>
62
<td class="md">) </td>
63
<td class="md" colspan="2"></td>
70
<table cellspacing=5 cellpadding=0 border=0>
78
Create PDF writer operating on this (open and empty) file.
80
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>
83
<a class="anchor" name="a1" doxytag="IpePdfWriter::~IpePdfWriter" ></a><p>
84
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
87
<table cellpadding="0" cellspacing="0" border="0">
89
<td class="md" nowrap valign="top"> IpePdfWriter::~<a class="el" href="class_ipe_pdf_writer.html">IpePdfWriter</a> </td>
90
<td class="md" valign="top">( </td>
91
<td class="mdname1" valign="top" nowrap> </td>
92
<td class="md" valign="top"> ) </td>
93
<td class="md" nowrap></td>
100
<table cellspacing=5 cellpadding=0 border=0>
113
<hr><h2>Member Function Documentation</h2>
114
<a class="anchor" name="a2" doxytag="IpePdfWriter::EmbedFonts" ></a><p>
115
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
118
<table cellpadding="0" cellspacing="0" border="0">
120
<td class="md" nowrap valign="top"> void IpePdfWriter::EmbedFonts </td>
121
<td class="md" valign="top">( </td>
122
<td class="md" nowrap valign="top">const <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * </td>
123
<td class="mdname1" valign="top" nowrap> <em>pool</em> </td>
124
<td class="md" valign="top"> ) </td>
125
<td class="md" nowrap></td>
132
<table cellspacing=5 cellpadding=0 border=0>
140
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>
143
<a class="anchor" name="a3" doxytag="IpePdfWriter::CreatePages" ></a><p>
144
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
147
<table cellpadding="0" cellspacing="0" border="0">
149
<td class="md" nowrap valign="top"> void IpePdfWriter::CreatePages </td>
150
<td class="md" valign="top">( </td>
151
<td class="md" nowrap valign="top">bool </td>
152
<td class="mdname1" valign="top" nowrap> <em>lastView</em> </td>
153
<td class="md" valign="top"> ) </td>
154
<td class="md" nowrap></td>
161
<table cellspacing=5 cellpadding=0 border=0>
169
Create all PDF pages.
174
<a class="anchor" name="a4" doxytag="IpePdfWriter::CreateBookmarks" ></a><p>
175
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
178
<table cellpadding="0" cellspacing="0" border="0">
180
<td class="md" nowrap valign="top"> void IpePdfWriter::CreateBookmarks </td>
181
<td class="md" valign="top">( </td>
182
<td class="mdname1" valign="top" nowrap> </td>
183
<td class="md" valign="top"> ) </td>
184
<td class="md" nowrap></td>
191
<table cellspacing=5 cellpadding=0 border=0>
199
Create the bookmarks (PDF outline).
204
<a class="anchor" name="a5" doxytag="IpePdfWriter::CreateXmlStream" ></a><p>
205
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
208
<table cellpadding="0" cellspacing="0" border="0">
210
<td class="md" nowrap valign="top"> void IpePdfWriter::CreateXmlStream </td>
211
<td class="md" valign="top">( </td>
212
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
213
<td class="mdname" nowrap> <em>xmldata</em>, </td>
216
<td class="md" nowrap align="right"></td>
218
<td class="md" nowrap>bool </td>
219
<td class="mdname" nowrap> <em>preCompressed</em></td>
223
<td class="md">) </td>
224
<td class="md" colspan="2"></td>
231
<table cellspacing=5 cellpadding=0 border=0>
239
Create a stream containing the XML data.
244
<a class="anchor" name="a6" doxytag="IpePdfWriter::CreateTrailer" ></a><p>
245
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
248
<table cellpadding="0" cellspacing="0" border="0">
250
<td class="md" nowrap valign="top"> void IpePdfWriter::CreateTrailer </td>
251
<td class="md" valign="top">( </td>
252
<td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
253
<td class="mdname1" valign="top" nowrap> <em>creator</em> </td>
254
<td class="md" valign="top"> ) </td>
255
<td class="md" nowrap></td>
262
<table cellspacing=5 cellpadding=0 border=0>
270
Create the root objects and trailer of the PDF file.
275
<hr>The documentation for this class was generated from the following files:<ul>
276
<li>ipepdfwriter.h<li>ipepdfwriter.cpp</ul>
added
removed
doc/class_ipe_pdf_writer.html
