← Back to branch summary

~ubuntu-branches/ubuntu/precise/ipe/precise

« back to all changes in this revision

Viewing changes to doc/class_ipe_pdf_writer.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2007-01-09 23:14:51 UTC
  • mfrom: (3.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20070109231451-3nd095g7ishc108l
Tags: 6.0pre27-3
http://bugs.debian.org/378537
* debian/gsfonts-fontmap.xml: New.  Fontmap for fonts from gsfonts package.
* debian/rules: Use gsfonts-fontmap.xml instead of tetex-fontmap.xml.
* debian/control: Add texlive-latex-base dependency as alternative to
  tetex-bin (for pdflatex) and replace tetex-extra by gsfonts (for font
  files).  Patch courtesy of Norbert Preining.  Closes: #378537.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/class_ipe_pdf_writer.html
1
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>Ipelib: IpePdfWriter class Reference</title>
 
3
<title>Ipelib: IpePdfWriter Class Reference</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
</head><body>
6
 
<!-- Generated by Doxygen 1.3.6 -->
7
 
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
8
 
<h1>IpePdfWriter Class Reference</h1>Create PDF file.  
 
6
<!-- Generated by Doxygen 1.4.4 -->
 
7
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
 
8
<h1>IpePdfWriter Class Reference</h1><!-- doxytag: class="IpePdfWriter" -->Create PDF file.  
9
9
<a href="#_details">More...</a>
10
10
<p>
11
11
<a href="class_ipe_pdf_writer-members.html">List of all members.</a><h2>Public Member Functions</h2>
12
12
<ul>
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> &amp;stream, const <a class="el" href="class_ipe_document.html">IpeDocument</a> *doc, bool noShading, int compression)
 
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> &amp;stream, const <a class="el" href="class_ipe_document.html">IpeDocument</a> *doc, bool noShading, bool lastView, int compression)
14
14
<li><a class="el" href="class_ipe_pdf_writer.html#a1">~IpePdfWriter</a> ()
15
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)
 
16
<li>void <a class="el" href="class_ipe_pdf_writer.html#a3">CreatePages</a> ()
17
17
<li>void <a class="el" href="class_ipe_pdf_writer.html#a4">CreateBookmarks</a> ()
18
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
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
21
<hr><a name="_details"></a><h2>Detailed Description</h2>
22
22
Create PDF file. 
23
23
<p>
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>
 
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> 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
25
Some reserved PDF object numbers:<p>
26
26
<ul>
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>
 
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>
28
28
 
29
29
<p>
30
30
<hr><h2>Constructor &amp; Destructor Documentation</h2>
31
 
<a class="anchor" name="a0" doxytag="IpePdfWriter::IpePdfWriter" ></a><p>
32
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
31
<a class="anchor" name="a0"></a><!-- doxytag: member="IpePdfWriter::IpePdfWriter" ref="a0" args="(IpeTellStream &amp;stream, const IpeDocument *doc, bool noShading, bool lastView, int compression)" --><p>
 
32
<table class="mdTable" cellpadding="2" cellspacing="0">
33
33
  <tr>
34
34
    <td class="mdRow">
35
35
      <table cellpadding="0" cellspacing="0" border="0">
36
36
        <tr>
37
 
          <td class="md" nowrap valign="top"> IpePdfWriter::IpePdfWriter </td>
 
37
          <td class="md" nowrap valign="top">IpePdfWriter::IpePdfWriter           </td>
38
38
          <td class="md" valign="top">(&nbsp;</td>
39
39
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_tell_stream.html">IpeTellStream</a> &amp;&nbsp;</td>
40
40
          <td class="mdname" nowrap> <em>stream</em>, </td>
41
41
        </tr>
42
42
        <tr>
43
43
          <td class="md" nowrap align="right"></td>
44
 
          <td></td>
 
44
          <td class="md"></td>
45
45
          <td class="md" nowrap>const <a class="el" href="class_ipe_document.html">IpeDocument</a> *&nbsp;</td>
46
46
          <td class="mdname" nowrap> <em>doc</em>, </td>
47
47
        </tr>
48
48
        <tr>
49
49
          <td class="md" nowrap align="right"></td>
50
 
          <td></td>
 
50
          <td class="md"></td>
51
51
          <td class="md" nowrap>bool&nbsp;</td>
52
52
          <td class="mdname" nowrap> <em>noShading</em>, </td>
53
53
        </tr>
54
54
        <tr>
55
55
          <td class="md" nowrap align="right"></td>
56
 
          <td></td>
 
56
          <td class="md"></td>
 
57
          <td class="md" nowrap>bool&nbsp;</td>
 
58
          <td class="mdname" nowrap> <em>lastView</em>, </td>
 
59
        </tr>
 
60
        <tr>
 
61
          <td class="md" nowrap align="right"></td>
 
62
          <td class="md"></td>
57
63
          <td class="md" nowrap>int&nbsp;</td>
58
64
          <td class="mdname" nowrap> <em>compression</em></td>
59
65
        </tr>
60
66
        <tr>
61
 
          <td></td>
 
67
          <td class="md"></td>
62
68
          <td class="md">)&nbsp;</td>
63
69
          <td class="md" colspan="2"></td>
64
70
        </tr>
65
 
 
66
71
      </table>
67
72
    </td>
68
73
  </tr>
69
74
</table>
70
 
<table cellspacing=5 cellpadding=0 border=0>
 
75
<table cellspacing="5" cellpadding="0" border="0">
71
76
  <tr>
72
77
    <td>
73
78
      &nbsp;
80
85
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>
81
86
  </tr>
82
87
</table>
83
 
<a class="anchor" name="a1" doxytag="IpePdfWriter::~IpePdfWriter" ></a><p>
84
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
88
<a class="anchor" name="a1"></a><!-- doxytag: member="IpePdfWriter::~IpePdfWriter" ref="a1" args="()" --><p>
 
89
<table class="mdTable" cellpadding="2" cellspacing="0">
85
90
  <tr>
86
91
    <td class="mdRow">
87
92
      <table cellpadding="0" cellspacing="0" border="0">
88
93
        <tr>
89
 
          <td class="md" nowrap valign="top"> IpePdfWriter::~<a class="el" href="class_ipe_pdf_writer.html">IpePdfWriter</a> </td>
 
94
          <td class="md" nowrap valign="top">IpePdfWriter::~IpePdfWriter           </td>
90
95
          <td class="md" valign="top">(&nbsp;</td>
91
96
          <td class="mdname1" valign="top" nowrap>          </td>
92
97
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
93
98
          <td class="md" nowrap></td>
94
99
        </tr>
95
 
 
96
100
      </table>
97
101
    </td>
98
102
  </tr>
99
103
</table>
100
 
<table cellspacing=5 cellpadding=0 border=0>
 
104
<table cellspacing="5" cellpadding="0" border="0">
101
105
  <tr>
102
106
    <td>
103
107
      &nbsp;
111
115
  </tr>
112
116
</table>
113
117
<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
<a class="anchor" name="a2"></a><!-- doxytag: member="IpePdfWriter::EmbedFonts" ref="a2" args="(const IpeFontPool *pool)" --><p>
 
119
<table class="mdTable" cellpadding="2" cellspacing="0">
116
120
  <tr>
117
121
    <td class="mdRow">
118
122
      <table cellpadding="0" cellspacing="0" border="0">
119
123
        <tr>
120
 
          <td class="md" nowrap valign="top"> void IpePdfWriter::EmbedFonts </td>
 
124
          <td class="md" nowrap valign="top">void IpePdfWriter::EmbedFonts           </td>
121
125
          <td class="md" valign="top">(&nbsp;</td>
122
126
          <td class="md" nowrap valign="top">const <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> *&nbsp;</td>
123
127
          <td class="mdname1" valign="top" nowrap> <em>pool</em>          </td>
124
128
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125
129
          <td class="md" nowrap></td>
126
130
        </tr>
127
 
 
128
131
      </table>
129
132
    </td>
130
133
  </tr>
131
134
</table>
132
 
<table cellspacing=5 cellpadding=0 border=0>
 
135
<table cellspacing="5" cellpadding="0" border="0">
133
136
  <tr>
134
137
    <td>
135
138
      &nbsp;
140
143
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>
141
144
  </tr>
142
145
</table>
143
 
<a class="anchor" name="a3" doxytag="IpePdfWriter::CreatePages" ></a><p>
144
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
146
<a class="anchor" name="a3"></a><!-- doxytag: member="IpePdfWriter::CreatePages" ref="a3" args="()" --><p>
 
147
<table class="mdTable" cellpadding="2" cellspacing="0">
145
148
  <tr>
146
149
    <td class="mdRow">
147
150
      <table cellpadding="0" cellspacing="0" border="0">
148
151
        <tr>
149
 
          <td class="md" nowrap valign="top"> void IpePdfWriter::CreatePages </td>
 
152
          <td class="md" nowrap valign="top">void IpePdfWriter::CreatePages           </td>
150
153
          <td class="md" valign="top">(&nbsp;</td>
151
 
          <td class="md" nowrap valign="top">bool&nbsp;</td>
152
 
          <td class="mdname1" valign="top" nowrap> <em>lastView</em>          </td>
 
154
          <td class="mdname1" valign="top" nowrap>          </td>
153
155
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
154
156
          <td class="md" nowrap></td>
155
157
        </tr>
156
 
 
157
158
      </table>
158
159
    </td>
159
160
  </tr>
160
161
</table>
161
 
<table cellspacing=5 cellpadding=0 border=0>
 
162
<table cellspacing="5" cellpadding="0" border="0">
162
163
  <tr>
163
164
    <td>
164
165
      &nbsp;
171
172
    </td>
172
173
  </tr>
173
174
</table>
174
 
<a class="anchor" name="a4" doxytag="IpePdfWriter::CreateBookmarks" ></a><p>
175
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
175
<a class="anchor" name="a4"></a><!-- doxytag: member="IpePdfWriter::CreateBookmarks" ref="a4" args="()" --><p>
 
176
<table class="mdTable" cellpadding="2" cellspacing="0">
176
177
  <tr>
177
178
    <td class="mdRow">
178
179
      <table cellpadding="0" cellspacing="0" border="0">
179
180
        <tr>
180
 
          <td class="md" nowrap valign="top"> void IpePdfWriter::CreateBookmarks </td>
 
181
          <td class="md" nowrap valign="top">void IpePdfWriter::CreateBookmarks           </td>
181
182
          <td class="md" valign="top">(&nbsp;</td>
182
183
          <td class="mdname1" valign="top" nowrap>          </td>
183
184
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
184
185
          <td class="md" nowrap></td>
185
186
        </tr>
186
 
 
187
187
      </table>
188
188
    </td>
189
189
  </tr>
190
190
</table>
191
 
<table cellspacing=5 cellpadding=0 border=0>
 
191
<table cellspacing="5" cellpadding="0" border="0">
192
192
  <tr>
193
193
    <td>
194
194
      &nbsp;
201
201
    </td>
202
202
  </tr>
203
203
</table>
204
 
<a class="anchor" name="a5" doxytag="IpePdfWriter::CreateXmlStream" ></a><p>
205
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
204
<a class="anchor" name="a5"></a><!-- doxytag: member="IpePdfWriter::CreateXmlStream" ref="a5" args="(IpeString xmldata, bool preCompressed)" --><p>
 
205
<table class="mdTable" cellpadding="2" cellspacing="0">
206
206
  <tr>
207
207
    <td class="mdRow">
208
208
      <table cellpadding="0" cellspacing="0" border="0">
209
209
        <tr>
210
 
          <td class="md" nowrap valign="top"> void IpePdfWriter::CreateXmlStream </td>
 
210
          <td class="md" nowrap valign="top">void IpePdfWriter::CreateXmlStream           </td>
211
211
          <td class="md" valign="top">(&nbsp;</td>
212
212
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
213
213
          <td class="mdname" nowrap> <em>xmldata</em>, </td>
214
214
        </tr>
215
215
        <tr>
216
216
          <td class="md" nowrap align="right"></td>
217
 
          <td></td>
 
217
          <td class="md"></td>
218
218
          <td class="md" nowrap>bool&nbsp;</td>
219
219
          <td class="mdname" nowrap> <em>preCompressed</em></td>
220
220
        </tr>
221
221
        <tr>
222
 
          <td></td>
 
222
          <td class="md"></td>
223
223
          <td class="md">)&nbsp;</td>
224
224
          <td class="md" colspan="2"></td>
225
225
        </tr>
226
 
 
227
226
      </table>
228
227
    </td>
229
228
  </tr>
230
229
</table>
231
 
<table cellspacing=5 cellpadding=0 border=0>
 
230
<table cellspacing="5" cellpadding="0" border="0">
232
231
  <tr>
233
232
    <td>
234
233
      &nbsp;
241
240
    </td>
242
241
  </tr>
243
242
</table>
244
 
<a class="anchor" name="a6" doxytag="IpePdfWriter::CreateTrailer" ></a><p>
245
 
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
243
<a class="anchor" name="a6"></a><!-- doxytag: member="IpePdfWriter::CreateTrailer" ref="a6" args="(IpeString creator)" --><p>
 
244
<table class="mdTable" cellpadding="2" cellspacing="0">
246
245
  <tr>
247
246
    <td class="mdRow">
248
247
      <table cellpadding="0" cellspacing="0" border="0">
249
248
        <tr>
250
 
          <td class="md" nowrap valign="top"> void IpePdfWriter::CreateTrailer </td>
 
249
          <td class="md" nowrap valign="top">void IpePdfWriter::CreateTrailer           </td>
251
250
          <td class="md" valign="top">(&nbsp;</td>
252
251
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
253
252
          <td class="mdname1" valign="top" nowrap> <em>creator</em>          </td>
254
253
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
255
254
          <td class="md" nowrap></td>
256
255
        </tr>
257
 
 
258
256
      </table>
259
257
    </td>
260
258
  </tr>
261
259
</table>
262
 
<table cellspacing=5 cellpadding=0 border=0>
 
260
<table cellspacing="5" cellpadding="0" border="0">
263
261
  <tr>
264
262
    <td>
265
263
      &nbsp;