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
|
<!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">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.1 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</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>
<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#d6b915824c134e5b4c1366c06bc71caa">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 fromPage, int toPage, int compression)
<li><a class="el" href="class_ipe_pdf_writer.html#1670eea93cfd17494c601eb25d59de2c">~IpePdfWriter</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#6743e378f11913eb470b90c9efd547eb">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#d38eecd2d2de23a06be79d4ed2414c02">CreatePages</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#53155d596d94511df95449e91fe5c2cf">CreateBookmarks</a> ()
<li>void <a class="el" href="class_ipe_pdf_writer.html#abe2532f19c543084cc2127752eb2102">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#45f636f58b9079fadf06dc09568af160">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 <a class="el" href="class_ipe_pdf_writer.html">IpePdfWriter</a> 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#6743e378f11913eb470b90c9efd547eb">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#d38eecd2d2de23a06be79d4ed2414c02">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="d6b915824c134e5b4c1366c06bc71caa"></a><!-- doxytag: member="IpePdfWriter::IpePdfWriter" ref="d6b915824c134e5b4c1366c06bc71caa" args="(IpeTellStream &stream, const IpeDocument *doc, bool noShading, bool lastView, int fromPage, int toPage, int compression)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IpePdfWriter::IpePdfWriter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_ipe_tell_stream.html">IpeTellStream</a> & </td>
<td class="paramname"> <em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="class_ipe_document.html">IpeDocument</a> * </td>
<td class="paramname"> <em>doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>noShading</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>lastView</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fromPage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>toPage</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>compression</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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.
</div>
</div><p>
<a class="anchor" name="1670eea93cfd17494c601eb25d59de2c"></a><!-- doxytag: member="IpePdfWriter::~IpePdfWriter" ref="1670eea93cfd17494c601eb25d59de2c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IpePdfWriter::~IpePdfWriter </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6743e378f11913eb470b90c9efd547eb"></a><!-- doxytag: member="IpePdfWriter::EmbedFonts" ref="6743e378f11913eb470b90c9efd547eb" args="(const IpeFontPool *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpePdfWriter::EmbedFonts </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * </td>
<td class="paramname"> <em>pool</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<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.
</div>
</div><p>
<a class="anchor" name="d38eecd2d2de23a06be79d4ed2414c02"></a><!-- doxytag: member="IpePdfWriter::CreatePages" ref="d38eecd2d2de23a06be79d4ed2414c02" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpePdfWriter::CreatePages </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create all PDF pages.
<p>
</div>
</div><p>
<a class="anchor" name="53155d596d94511df95449e91fe5c2cf"></a><!-- doxytag: member="IpePdfWriter::CreateBookmarks" ref="53155d596d94511df95449e91fe5c2cf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpePdfWriter::CreateBookmarks </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the bookmarks (PDF outline).
<p>
</div>
</div><p>
<a class="anchor" name="abe2532f19c543084cc2127752eb2102"></a><!-- doxytag: member="IpePdfWriter::CreateXmlStream" ref="abe2532f19c543084cc2127752eb2102" args="(IpeString xmldata, bool preCompressed)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpePdfWriter::CreateXmlStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
<td class="paramname"> <em>xmldata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>preCompressed</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a stream containing the XML data.
<p>
</div>
</div><p>
<a class="anchor" name="45f636f58b9079fadf06dc09568af160"></a><!-- doxytag: member="IpePdfWriter::CreateTrailer" ref="45f636f58b9079fadf06dc09568af160" args="(IpeString creator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IpePdfWriter::CreateTrailer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a> </td>
<td class="paramname"> <em>creator</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the root objects and trailer of the PDF file.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipepdfwriter.h<li>ipepdfwriter.cpp</ul>
<hr>
</body></html>
|