← Back to branch summary

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

« back to all changes in this revision

Viewing changes to build/doc/classipe_1_1_document.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2009-12-11 21:22:35 UTC
  • mfrom: (4.1.6 sid)
  • Revision ID: james.westby@ubuntu.com-20091211212235-5iio4nzpra64snab
Tags: 7.0.10-1
http://bugs.debian.org/551192
* New upstream.  Closes: #551192.
  - New build-depends: libcairo2-dev, liblua5.1-0-dev, gsfonts
  - patches/config.diff: Remove.  Upstream build system replaced.
  - Runtime lib package changed to libipe7.0.10 from libipe1c2a
  - Devel package renamed to libipe-dev (from libipe1-dev)
  - Package ipe depends on lua5.1 due to ipe-update-master.

* rules: Re-write to use dh.

Show diffs side-by-side

added added

removed removed

Lines of Context:
build/doc/classipe_1_1_document.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>Ipelib: ipe::Document Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.6.1 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul>
 
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li><a href="modules.html"><span>Modules</span></a></li>
 
16
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
17
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
18
    </ul>
 
19
  </div>
 
20
  <div class="tabs">
 
21
    <ul>
 
22
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
23
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
24
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
25
    </ul>
 
26
  </div>
 
27
  <div class="navpath"><a class="el" href="namespaceipe.html">ipe</a>::<a class="el" href="classipe_1_1_document.html">Document</a>
 
28
  </div>
 
29
</div>
 
30
<div class="contents">
 
31
<h1>ipe::Document Class Reference<br/>
 
32
<small>
 
33
[<a class="el" href="group__doc.html">Ipe Document</a>]</small>
 
34
</h1><!-- doxytag: class="ipe::Document" -->
 
35
<p>The model for an Ipe document.  
 
36
<a href="#_details">More...</a></p>
 
37
 
 
38
<p><code>#include &lt;ipedoc.h&gt;</code></p>
 
39
 
 
40
<p><a href="classipe_1_1_document-members.html">List of all members.</a></p>
 
41
<h2>Classes</h2>
 
42
<ul>
 
43
<li>struct <a class="el" href="structipe_1_1_document_1_1_s_properties.html">SProperties</a>
 
44
<dl class="el"><dd class="mdescRight">Properties of a document.  <a href="structipe_1_1_document_1_1_s_properties.html#_details">More...</a><br/></dl></ul>
 
45
<h2>Public Types</h2>
 
46
<ul>
 
47
<li>enum <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> { <br/>
 
48
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99a7e229a12e07e5a968b56b3d1f8149f9f">EXml</a>, 
 
49
<a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99ac8834689900f4fa773f37a4b99637946">EPdf</a>, 
 
50
<a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99af11ebe09f792e106069537893ee976e1">EEps</a>, 
 
51
<a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99acd05f84a541c1c25c1d5ad870350ff81">EIpe5</a>, 
 
52
<br/>
 
53
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99a12878f933191853cb22cc7f312f8c1ee">EUnknown</a>
 
54
<br/>
 
55
 }
 
56
<li>enum { <br/>
 
57
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a82d5d0b89ace0cc1df18d6e6506ecc6ba3ce55d2ba8982cef7540e43425777284">ESaveNormal</a> =  0, 
 
58
<a class="el" href="classipe_1_1_document.html#a82d5d0b89ace0cc1df18d6e6506ecc6babe2a448fac19c7ed9a2effd474d7fd41">EExport</a> =  1, 
 
59
<a class="el" href="classipe_1_1_document.html#a82d5d0b89ace0cc1df18d6e6506ecc6ba5b59c1c07f53be78faa3ac0d684ecd69">ENoZip</a> =  2, 
 
60
<a class="el" href="classipe_1_1_document.html#a82d5d0b89ace0cc1df18d6e6506ecc6ba24b21179447c8761fb17f02d4f2cb9fc">ELastView</a> =  4, 
 
61
<br/>
 
62
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a82d5d0b89ace0cc1df18d6e6506ecc6ba21901c99cfcb1d5dc8e4821c3b5b6600">ENoColor</a> =  8
 
63
<br/>
 
64
 }
 
65
<li>enum <a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8f">LoadErrors</a> { <a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8fa13c8bbc71da31f41dc5455a5e9200cb3">EVersionTooOld</a> =  -1, 
 
66
<a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8fa1b5c2a2305744ab516b5aa365ef813e8">EVersionTooRecent</a> =  -2, 
 
67
<a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8fa6e15b8768ed4933a1f88118940334aa9">EFileOpenError</a> =  -3
 
68
 }
 
69
<li>enum { <br/>
 
70
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816a258775eb4ae4b5b3c42ecb51d9783d70">ErrNone</a>, 
 
71
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816adab1ee8801bff37533098ce7f128326c">ErrNoText</a>, 
 
72
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816a8dfa9a519cd0bc82e2353fc885831b1e">ErrNoDir</a>, 
 
73
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816a8263ed2dfd350addfc998cee5105b9b4">ErrWritingSource</a>, 
 
74
<br/>
 
75
&nbsp;&nbsp;<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816aca7caefb0d12aa22205fb2f528665f63">ErrOldPdfLatex</a>, 
 
76
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816adce530ecb9db4dd89d47b8bc0a3a54ff">ErrRunLatex</a>, 
 
77
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816a1a007fb027657049ba26ba612a2e3767">ErrLatex</a>, 
 
78
<a class="el" href="classipe_1_1_document.html#a5f11da90725e5b2f5916c5574c350816ae117e96dadbe61384c187802236199ca">ErrLatexOutput</a>
 
79
<br/>
 
80
 }
 
81
</ul>
 
82
<h2>Public Member Functions</h2>
 
83
<ul>
 
84
<li><a class="el" href="classipe_1_1_document.html#acdbcbe550084e8c20f4f67eb229ad66a">Document</a> ()
 
85
<li><a class="el" href="classipe_1_1_document.html#a7d0b29c972b2a15adad143720bcb18a9">Document</a> (const <a class="el" href="classipe_1_1_document.html">Document</a> &amp;rhs)
 
86
<li><a class="el" href="classipe_1_1_document.html#ac2e3f62307dc22baac21ddc10fa1609c">~Document</a> ()
 
87
<li>bool <a class="el" href="classipe_1_1_document.html#af7db148138646754bdcb9ad2a093d379">save</a> (<a class="el" href="classipe_1_1_tell_stream.html">TellStream</a> &amp;stream, <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> format, uint flags) const 
 
88
<li>bool <a class="el" href="classipe_1_1_document.html#add5e54191e6823081998928441fda19a">save</a> (const char *fname, <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> format, uint flags) const 
 
89
<li>bool <a class="el" href="classipe_1_1_document.html#aa2ef1e5c2d89df84bacffddca47a4df6">exportPages</a> (const char *fname, uint flags, int fromPage, int toPage) const 
 
90
<li>bool <a class="el" href="classipe_1_1_document.html#a935954a56b6ff3fa667fab0d74367368">exportView</a> (const char *fname, <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> format, uint flags, int pno, int vno) const 
 
91
<li>void <a class="el" href="classipe_1_1_document.html#ae84fc27ae6ff7c3db16ec0c451d6000e">saveAsXml</a> (<a class="el" href="classipe_1_1_stream.html">Stream</a> &amp;stream, bool usePdfBitmaps=false) const 
 
92
<li>int <a class="el" href="classipe_1_1_document.html#a491cab0f20eebdc074511bc3bb5a0194">countPages</a> () const 
 
93
<li>int <a class="el" href="classipe_1_1_document.html#abe6c68c8a6dfb7d0160c7cd69a67b7d9">countTotalViews</a> () const 
 
94
<li>const <a class="el" href="classipe_1_1_page.html">Page</a> * <a class="el" href="classipe_1_1_document.html#a1cdc78a4ea1687181e1867c65e5c9132">page</a> (int no) const 
 
95
<li><a class="el" href="classipe_1_1_page.html">Page</a> * <a class="el" href="classipe_1_1_document.html#a53987971f80ddd069b0254c64b3621e6">page</a> (int no)
 
96
<li><a class="el" href="classipe_1_1_page.html">Page</a> * <a class="el" href="classipe_1_1_document.html#a947f48ea9bf0c25738cfb7a833958cb5">set</a> (int no, <a class="el" href="classipe_1_1_page.html">Page</a> *page)
 
97
<li>void <a class="el" href="classipe_1_1_document.html#afa4e0b819ad914ddd7694a397785de69">insert</a> (int no, <a class="el" href="classipe_1_1_page.html">Page</a> *page)
 
98
<li>void <a class="el" href="classipe_1_1_document.html#ad69f7602c4874dfbb28677dac97b6c2b">push_back</a> (<a class="el" href="classipe_1_1_page.html">Page</a> *page)
 
99
<li><a class="el" href="classipe_1_1_page.html">Page</a> * <a class="el" href="classipe_1_1_document.html#a86854654291fba803edc595c9445ad60">remove</a> (int no)
 
100
<li><a class="el" href="structipe_1_1_document_1_1_s_properties.html">SProperties</a> <a class="el" href="classipe_1_1_document.html#a683c97793c04a7babc84b1d59feeddd9">properties</a> () const 
 
101
<li>void <a class="el" href="classipe_1_1_document.html#a96e45a1c46d75f70d51ff7af03b7e358">setProperties</a> (const <a class="el" href="structipe_1_1_document_1_1_s_properties.html">SProperties</a> &amp;info)
 
102
<li><a class="el" href="classipe_1_1_cascade.html">Cascade</a> * <a class="el" href="classipe_1_1_document.html#abe2f2603d55c2cbebced99ec007b4d68">cascade</a> ()
 
103
<li>const <a class="el" href="classipe_1_1_cascade.html">Cascade</a> * <a class="el" href="classipe_1_1_document.html#a358428f5ce3560469745b4642fb7a7a5">cascade</a> () const 
 
104
<li><a class="el" href="classipe_1_1_cascade.html">Cascade</a> * <a class="el" href="classipe_1_1_document.html#ae7c9596d5ebc8bc3d664c6ac24b0dfab">replaceCascade</a> (<a class="el" href="classipe_1_1_cascade.html">Cascade</a> *cascade)
 
105
<li>void <a class="el" href="classipe_1_1_document.html#a14ca545e8d566ce84d2854829bf354a9">setFontPool</a> (FontPool *fontPool)
 
106
<li>const FontPool * <a class="el" href="classipe_1_1_document.html#a20ce860d84e3d8a8d82877b790dd055d">fontPool</a> () const 
 
107
<li>bool <a class="el" href="classipe_1_1_document.html#acbd7893d71e6b0266f28848820672a3b">hasTrueTypeFonts</a> () const 
 
108
<li>bool <a class="el" href="classipe_1_1_document.html#a83cb664fe9e632cb134cb01eedb04900">hasTransparency</a> () const 
 
109
<li>bool <a class="el" href="classipe_1_1_document.html#af2b760380c366aa71ed007c9ce1f1360">hasTilings</a> () const 
 
110
<li>bool <a class="el" href="classipe_1_1_document.html#ac19f0c51327c86febcb3e22290143efd">hasGradients</a> () const 
 
111
<li>void <a class="el" href="classipe_1_1_document.html#a94eaa4c30728cc697c64ae0d14d4cdf5">findBitmaps</a> (<a class="el" href="classipe_1_1_bitmap_finder.html">BitmapFinder</a> &amp;bm) const 
 
112
<li>bool <a class="el" href="classipe_1_1_document.html#ac97b90e5f4008bb3df5632f967728c12">checkStyle</a> (<a class="el" href="group__attr.html#ga724109aa4dbab072ea067cc5ed471e02">AttributeSeq</a> &amp;seq) const 
 
113
<li>int <a class="el" href="classipe_1_1_document.html#a37bb25c828f2ecc0a7fdaa0465356511">runLatex</a> (<a class="el" href="classipe_1_1_string.html">String</a> &amp;logFile)
 
114
<li>int <a class="el" href="classipe_1_1_document.html#a95ebb4e4992ce6afa8a67bf172e0aded">runLatex</a> ()
 
115
</ul>
 
116
<h2>Static Public Member Functions</h2>
 
117
<ul>
 
118
<li>static <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> <a class="el" href="classipe_1_1_document.html#a31da901c35a2fd571c26ca03d589c64d">fileFormat</a> (<a class="el" href="classipe_1_1_data_source.html">DataSource</a> &amp;source)
 
119
<li>static <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> <a class="el" href="classipe_1_1_document.html#af2715b5aa80365078afd8367dd77ec2d">formatFromFilename</a> (<a class="el" href="classipe_1_1_string.html">String</a> fn)
 
120
<li>static <a class="el" href="classipe_1_1_document.html">Document</a> * <a class="el" href="classipe_1_1_document.html#a579e616ce93f7750deb96bc021a37fe0">load</a> (<a class="el" href="classipe_1_1_data_source.html">DataSource</a> &amp;source, <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a> format, int &amp;reason)
 
121
<li>static <a class="el" href="classipe_1_1_document.html">Document</a> * <a class="el" href="classipe_1_1_document.html#abd00e37b2f403d9b47406899fdfb8ccb">load</a> (const char *fname, int &amp;reason)
 
122
<li>static <a class="el" href="classipe_1_1_document.html">Document</a> * <a class="el" href="classipe_1_1_document.html#a45b95023534421ac4158f3a599495a29">loadWithErrorReport</a> (const char *fname)
 
123
</ul>
 
124
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
125
<p>The model for an Ipe document. </p>
 
126
<p>The <a class="el" href="classipe_1_1_document.html" title="The model for an Ipe document.">Document</a> class represents the contents of an Ipe document, and all the methods necessary to load, save, and modify it. </p>
 
127
<hr/><h2>Member Enumeration Documentation</h2>
 
128
<a class="anchor" id="a007132c3412a12d8e7eca62899579c99"></a><!-- doxytag: member="ipe::Document::TFormat" ref="a007132c3412a12d8e7eca62899579c99" args="" -->
 
129
<div class="memitem">
 
130
<div class="memproto">
 
131
      <table class="memname">
 
132
        <tr>
 
133
          <td class="memname">enum <a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">ipe::Document::TFormat</a></td>
 
134
        </tr>
 
135
      </table>
 
136
</div>
 
137
<div class="memdoc">
 
138
 
 
139
<p>There are several Ipe document save formats. </p>
 
140
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 
141
<tr><td valign="top"><em><a class="anchor" id="a007132c3412a12d8e7eca62899579c99a7e229a12e07e5a968b56b3d1f8149f9f"></a><!-- doxytag: member="EXml" ref="a007132c3412a12d8e7eca62899579c99a7e229a12e07e5a968b56b3d1f8149f9f" args="" -->EXml</em>&nbsp;</td><td>
 
142
<p>Save as XML. </p>
 
143
</td></tr>
 
144
<tr><td valign="top"><em><a class="anchor" id="a007132c3412a12d8e7eca62899579c99ac8834689900f4fa773f37a4b99637946"></a><!-- doxytag: member="EPdf" ref="a007132c3412a12d8e7eca62899579c99ac8834689900f4fa773f37a4b99637946" args="" -->EPdf</em>&nbsp;</td><td>
 
145
<p>Save as PDF. </p>
 
146
</td></tr>
 
147
<tr><td valign="top"><em><a class="anchor" id="a007132c3412a12d8e7eca62899579c99af11ebe09f792e106069537893ee976e1"></a><!-- doxytag: member="EEps" ref="a007132c3412a12d8e7eca62899579c99af11ebe09f792e106069537893ee976e1" args="" -->EEps</em>&nbsp;</td><td>
 
148
<p>Save as Encapsulated Postscript. </p>
 
149
</td></tr>
 
150
<tr><td valign="top"><em><a class="anchor" id="a007132c3412a12d8e7eca62899579c99acd05f84a541c1c25c1d5ad870350ff81"></a><!-- doxytag: member="EIpe5" ref="a007132c3412a12d8e7eca62899579c99acd05f84a541c1c25c1d5ad870350ff81" args="" -->EIpe5</em>&nbsp;</td><td>
 
151
<p>Ancient Ipe format. </p>
 
152
</td></tr>
 
153
<tr><td valign="top"><em><a class="anchor" id="a007132c3412a12d8e7eca62899579c99a12878f933191853cb22cc7f312f8c1ee"></a><!-- doxytag: member="EUnknown" ref="a007132c3412a12d8e7eca62899579c99a12878f933191853cb22cc7f312f8c1ee" args="" -->EUnknown</em>&nbsp;</td><td>
 
154
<p>Unknown file format. </p>
 
155
</td></tr>
 
156
</table>
 
157
</dd>
 
158
</dl>
 
159
 
 
160
</div>
 
161
</div>
 
162
<a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6b"></a><!-- doxytag: member="ipe::Document::@1" ref="a82d5d0b89ace0cc1df18d6e6506ecc6b" args="" -->
 
163
<div class="memitem">
 
164
<div class="memproto">
 
165
      <table class="memname">
 
166
        <tr>
 
167
          <td class="memname">anonymous enum</td>
 
168
        </tr>
 
169
      </table>
 
170
</div>
 
171
<div class="memdoc">
 
172
 
 
173
<p>Options for saving Ipe documents (to PDF and Postscript). </p>
 
174
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 
175
<tr><td valign="top"><em><a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6ba3ce55d2ba8982cef7540e43425777284"></a><!-- doxytag: member="ESaveNormal" ref="a82d5d0b89ace0cc1df18d6e6506ecc6ba3ce55d2ba8982cef7540e43425777284" args="" -->ESaveNormal</em>&nbsp;</td><td>
 
176
<p>Nothing special. </p>
 
177
</td></tr>
 
178
<tr><td valign="top"><em><a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6babe2a448fac19c7ed9a2effd474d7fd41"></a><!-- doxytag: member="EExport" ref="a82d5d0b89ace0cc1df18d6e6506ecc6babe2a448fac19c7ed9a2effd474d7fd41" args="" -->EExport</em>&nbsp;</td><td>
 
179
<p>Don't include Ipe markup. </p>
 
180
</td></tr>
 
181
<tr><td valign="top"><em><a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6ba5b59c1c07f53be78faa3ac0d684ecd69"></a><!-- doxytag: member="ENoZip" ref="a82d5d0b89ace0cc1df18d6e6506ecc6ba5b59c1c07f53be78faa3ac0d684ecd69" args="" -->ENoZip</em>&nbsp;</td><td>
 
182
<p>Do not compress streams. </p>
 
183
</td></tr>
 
184
<tr><td valign="top"><em><a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6ba24b21179447c8761fb17f02d4f2cb9fc"></a><!-- doxytag: member="ELastView" ref="a82d5d0b89ace0cc1df18d6e6506ecc6ba24b21179447c8761fb17f02d4f2cb9fc" args="" -->ELastView</em>&nbsp;</td><td>
 
185
<p>Create last view of each page only. </p>
 
186
</td></tr>
 
187
<tr><td valign="top"><em><a class="anchor" id="a82d5d0b89ace0cc1df18d6e6506ecc6ba21901c99cfcb1d5dc8e4821c3b5b6600"></a><!-- doxytag: member="ENoColor" ref="a82d5d0b89ace0cc1df18d6e6506ecc6ba21901c99cfcb1d5dc8e4821c3b5b6600" args="" -->ENoColor</em>&nbsp;</td><td>
 
188
<p>No color commands in EPS output. </p>
 
189
</td></tr>
 
190
</table>
 
191
</dd>
 
192
</dl>
 
193
 
 
194
</div>
 
195
</div>
 
196
<a class="anchor" id="aba010fd2d95f249b29a3604164b51d8f"></a><!-- doxytag: member="ipe::Document::LoadErrors" ref="aba010fd2d95f249b29a3604164b51d8f" args="" -->
 
197
<div class="memitem">
 
198
<div class="memproto">
 
199
      <table class="memname">
 
200
        <tr>
 
201
          <td class="memname">enum <a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8f">ipe::Document::LoadErrors</a></td>
 
202
        </tr>
 
203
      </table>
 
204
</div>
 
205
<div class="memdoc">
 
206
 
 
207
<p>Errors that can happen while loading documents. </p>
 
208
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 
209
<tr><td valign="top"><em><a class="anchor" id="aba010fd2d95f249b29a3604164b51d8fa13c8bbc71da31f41dc5455a5e9200cb3"></a><!-- doxytag: member="EVersionTooOld" ref="aba010fd2d95f249b29a3604164b51d8fa13c8bbc71da31f41dc5455a5e9200cb3" args="" -->EVersionTooOld</em>&nbsp;</td><td>
 
210
<p>The version of the file is too old. </p>
 
211
</td></tr>
 
212
<tr><td valign="top"><em><a class="anchor" id="aba010fd2d95f249b29a3604164b51d8fa1b5c2a2305744ab516b5aa365ef813e8"></a><!-- doxytag: member="EVersionTooRecent" ref="aba010fd2d95f249b29a3604164b51d8fa1b5c2a2305744ab516b5aa365ef813e8" args="" -->EVersionTooRecent</em>&nbsp;</td><td>
 
213
<p>The file version is newer than this Ipelib. </p>
 
214
</td></tr>
 
215
<tr><td valign="top"><em><a class="anchor" id="aba010fd2d95f249b29a3604164b51d8fa6e15b8768ed4933a1f88118940334aa9"></a><!-- doxytag: member="EFileOpenError" ref="aba010fd2d95f249b29a3604164b51d8fa6e15b8768ed4933a1f88118940334aa9" args="" -->EFileOpenError</em>&nbsp;</td><td>
 
216
<p>Error opening the file. </p>
 
217
</td></tr>
 
218
</table>
 
219
</dd>
 
220
</dl>
 
221
 
 
222
</div>
 
223
</div>
 
224
<a class="anchor" id="a5f11da90725e5b2f5916c5574c350816"></a><!-- doxytag: member="ipe::Document::@2" ref="a5f11da90725e5b2f5916c5574c350816" args="" -->
 
225
<div class="memitem">
 
226
<div class="memproto">
 
227
      <table class="memname">
 
228
        <tr>
 
229
          <td class="memname">anonymous enum</td>
 
230
        </tr>
 
231
      </table>
 
232
</div>
 
233
<div class="memdoc">
 
234
 
 
235
<p>Error codes returned by RunLatex. </p>
 
236
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
 
237
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816a258775eb4ae4b5b3c42ecb51d9783d70"></a><!-- doxytag: member="ErrNone" ref="a5f11da90725e5b2f5916c5574c350816a258775eb4ae4b5b3c42ecb51d9783d70" args="" -->ErrNone</em>&nbsp;</td><td>
 
238
</td></tr>
 
239
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816adab1ee8801bff37533098ce7f128326c"></a><!-- doxytag: member="ErrNoText" ref="a5f11da90725e5b2f5916c5574c350816adab1ee8801bff37533098ce7f128326c" args="" -->ErrNoText</em>&nbsp;</td><td>
 
240
</td></tr>
 
241
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816a8dfa9a519cd0bc82e2353fc885831b1e"></a><!-- doxytag: member="ErrNoDir" ref="a5f11da90725e5b2f5916c5574c350816a8dfa9a519cd0bc82e2353fc885831b1e" args="" -->ErrNoDir</em>&nbsp;</td><td>
 
242
</td></tr>
 
243
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816a8263ed2dfd350addfc998cee5105b9b4"></a><!-- doxytag: member="ErrWritingSource" ref="a5f11da90725e5b2f5916c5574c350816a8263ed2dfd350addfc998cee5105b9b4" args="" -->ErrWritingSource</em>&nbsp;</td><td>
 
244
</td></tr>
 
245
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816aca7caefb0d12aa22205fb2f528665f63"></a><!-- doxytag: member="ErrOldPdfLatex" ref="a5f11da90725e5b2f5916c5574c350816aca7caefb0d12aa22205fb2f528665f63" args="" -->ErrOldPdfLatex</em>&nbsp;</td><td>
 
246
</td></tr>
 
247
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816adce530ecb9db4dd89d47b8bc0a3a54ff"></a><!-- doxytag: member="ErrRunLatex" ref="a5f11da90725e5b2f5916c5574c350816adce530ecb9db4dd89d47b8bc0a3a54ff" args="" -->ErrRunLatex</em>&nbsp;</td><td>
 
248
</td></tr>
 
249
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816a1a007fb027657049ba26ba612a2e3767"></a><!-- doxytag: member="ErrLatex" ref="a5f11da90725e5b2f5916c5574c350816a1a007fb027657049ba26ba612a2e3767" args="" -->ErrLatex</em>&nbsp;</td><td>
 
250
</td></tr>
 
251
<tr><td valign="top"><em><a class="anchor" id="a5f11da90725e5b2f5916c5574c350816ae117e96dadbe61384c187802236199ca"></a><!-- doxytag: member="ErrLatexOutput" ref="a5f11da90725e5b2f5916c5574c350816ae117e96dadbe61384c187802236199ca" args="" -->ErrLatexOutput</em>&nbsp;</td><td>
 
252
</td></tr>
 
253
</table>
 
254
</dd>
 
255
</dl>
 
256
 
 
257
</div>
 
258
</div>
 
259
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
260
<a class="anchor" id="acdbcbe550084e8c20f4f67eb229ad66a"></a><!-- doxytag: member="ipe::Document::Document" ref="acdbcbe550084e8c20f4f67eb229ad66a" args="()" -->
 
261
<div class="memitem">
 
262
<div class="memproto">
 
263
      <table class="memname">
 
264
        <tr>
 
265
          <td class="memname">Document::Document </td>
 
266
          <td>(</td>
 
267
          <td class="paramname"></td>
 
268
          <td>&nbsp;)&nbsp;</td>
 
269
          <td></td>
 
270
        </tr>
 
271
      </table>
 
272
</div>
 
273
<div class="memdoc">
 
274
 
 
275
<p>Construct an empty document for filling by a client. </p>
 
276
<p>As constructed, it has no pages, A4 media, and only the standard style sheet. </p>
 
277
 
 
278
</div>
 
279
</div>
 
280
<a class="anchor" id="a7d0b29c972b2a15adad143720bcb18a9"></a><!-- doxytag: member="ipe::Document::Document" ref="a7d0b29c972b2a15adad143720bcb18a9" args="(const Document &amp;rhs)" -->
 
281
<div class="memitem">
 
282
<div class="memproto">
 
283
      <table class="memname">
 
284
        <tr>
 
285
          <td class="memname">Document::Document </td>
 
286
          <td>(</td>
 
287
          <td class="paramtype">const <a class="el" href="classipe_1_1_document.html">Document</a> &amp;&nbsp;</td>
 
288
          <td class="paramname"> <em>rhs</em></td>
 
289
          <td>&nbsp;)&nbsp;</td>
 
290
          <td></td>
 
291
        </tr>
 
292
      </table>
 
293
</div>
 
294
<div class="memdoc">
 
295
 
 
296
<p>Copy constructor. </p>
 
297
 
 
298
</div>
 
299
</div>
 
300
<a class="anchor" id="ac2e3f62307dc22baac21ddc10fa1609c"></a><!-- doxytag: member="ipe::Document::~Document" ref="ac2e3f62307dc22baac21ddc10fa1609c" args="()" -->
 
301
<div class="memitem">
 
302
<div class="memproto">
 
303
      <table class="memname">
 
304
        <tr>
 
305
          <td class="memname">Document::~Document </td>
 
306
          <td>(</td>
 
307
          <td class="paramname"></td>
 
308
          <td>&nbsp;)&nbsp;</td>
 
309
          <td></td>
 
310
        </tr>
 
311
      </table>
 
312
</div>
 
313
<div class="memdoc">
 
314
 
 
315
<p>Destructor. </p>
 
316
 
 
317
</div>
 
318
</div>
 
319
<hr/><h2>Member Function Documentation</h2>
 
320
<a class="anchor" id="a31da901c35a2fd571c26ca03d589c64d"></a><!-- doxytag: member="ipe::Document::fileFormat" ref="a31da901c35a2fd571c26ca03d589c64d" args="(DataSource &amp;source)" -->
 
321
<div class="memitem">
 
322
<div class="memproto">
 
323
      <table class="memname">
 
324
        <tr>
 
325
          <td class="memname"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">Document::TFormat</a> Document::fileFormat </td>
 
326
          <td>(</td>
 
327
          <td class="paramtype"><a class="el" href="classipe_1_1_data_source.html">DataSource</a> &amp;&nbsp;</td>
 
328
          <td class="paramname"> <em>source</em></td>
 
329
          <td>&nbsp;)&nbsp;</td>
 
330
          <td><code> [static]</code></td>
 
331
        </tr>
 
332
      </table>
 
333
</div>
 
334
<div class="memdoc">
 
335
 
 
336
<p>Determine format of file in <em>source</em>. </p>
 
337
 
 
338
</div>
 
339
</div>
 
340
<a class="anchor" id="af2715b5aa80365078afd8367dd77ec2d"></a><!-- doxytag: member="ipe::Document::formatFromFilename" ref="af2715b5aa80365078afd8367dd77ec2d" args="(String fn)" -->
 
341
<div class="memitem">
 
342
<div class="memproto">
 
343
      <table class="memname">
 
344
        <tr>
 
345
          <td class="memname"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">Document::TFormat</a> Document::formatFromFilename </td>
 
346
          <td>(</td>
 
347
          <td class="paramtype"><a class="el" href="classipe_1_1_string.html">String</a>&nbsp;</td>
 
348
          <td class="paramname"> <em>fn</em></td>
 
349
          <td>&nbsp;)&nbsp;</td>
 
350
          <td><code> [static]</code></td>
 
351
        </tr>
 
352
      </table>
 
353
</div>
 
354
<div class="memdoc">
 
355
 
 
356
<p>Determine format of file from filename <em>fn</em>. </p>
 
357
 
 
358
</div>
 
359
</div>
 
360
<a class="anchor" id="a579e616ce93f7750deb96bc021a37fe0"></a><!-- doxytag: member="ipe::Document::load" ref="a579e616ce93f7750deb96bc021a37fe0" args="(DataSource &amp;source, TFormat format, int &amp;reason)" -->
 
361
<div class="memitem">
 
362
<div class="memproto">
 
363
      <table class="memname">
 
364
        <tr>
 
365
          <td class="memname"><a class="el" href="classipe_1_1_document.html">Document</a> * Document::load </td>
 
366
          <td>(</td>
 
367
          <td class="paramtype"><a class="el" href="classipe_1_1_data_source.html">DataSource</a> &amp;&nbsp;</td>
 
368
          <td class="paramname"> <em>source</em>, </td>
 
369
        </tr>
 
370
        <tr>
 
371
          <td class="paramkey"></td>
 
372
          <td></td>
 
373
          <td class="paramtype"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a>&nbsp;</td>
 
374
          <td class="paramname"> <em>format</em>, </td>
 
375
        </tr>
 
376
        <tr>
 
377
          <td class="paramkey"></td>
 
378
          <td></td>
 
379
          <td class="paramtype">int &amp;&nbsp;</td>
 
380
          <td class="paramname"> <em>reason</em></td><td>&nbsp;</td>
 
381
        </tr>
 
382
        <tr>
 
383
          <td></td>
 
384
          <td>)</td>
 
385
          <td></td><td></td><td><code> [static]</code></td>
 
386
        </tr>
 
387
      </table>
 
388
</div>
 
389
<div class="memdoc">
 
390
 
 
391
<p>Construct a document from an input stream. </p>
 
392
<p>Returns 0 if the stream couldn't be parsed, and a reason explaining that in <em>reason</em>. If <em>reason</em> is positive, it is a file (stream) offset where parsing failed. If <em>reason</em> is negative, it is an error code, see <a class="el" href="classipe_1_1_document.html#aba010fd2d95f249b29a3604164b51d8f" title="Errors that can happen while loading documents.">Document::LoadErrors</a>. </p>
 
393
 
 
394
</div>
 
395
</div>
 
396
<a class="anchor" id="abd00e37b2f403d9b47406899fdfb8ccb"></a><!-- doxytag: member="ipe::Document::load" ref="abd00e37b2f403d9b47406899fdfb8ccb" args="(const char *fname, int &amp;reason)" -->
 
397
<div class="memitem">
 
398
<div class="memproto">
 
399
      <table class="memname">
 
400
        <tr>
 
401
          <td class="memname"><a class="el" href="classipe_1_1_document.html">Document</a> * Document::load </td>
 
402
          <td>(</td>
 
403
          <td class="paramtype">const char *&nbsp;</td>
 
404
          <td class="paramname"> <em>fname</em>, </td>
 
405
        </tr>
 
406
        <tr>
 
407
          <td class="paramkey"></td>
 
408
          <td></td>
 
409
          <td class="paramtype">int &amp;&nbsp;</td>
 
410
          <td class="paramname"> <em>reason</em></td><td>&nbsp;</td>
 
411
        </tr>
 
412
        <tr>
 
413
          <td></td>
 
414
          <td>)</td>
 
415
          <td></td><td></td><td><code> [static]</code></td>
 
416
        </tr>
 
417
      </table>
 
418
</div>
 
419
<div class="memdoc">
 
420
 
 
421
</div>
 
422
</div>
 
423
<a class="anchor" id="a45b95023534421ac4158f3a599495a29"></a><!-- doxytag: member="ipe::Document::loadWithErrorReport" ref="a45b95023534421ac4158f3a599495a29" args="(const char *fname)" -->
 
424
<div class="memitem">
 
425
<div class="memproto">
 
426
      <table class="memname">
 
427
        <tr>
 
428
          <td class="memname"><a class="el" href="classipe_1_1_document.html">Document</a> * Document::loadWithErrorReport </td>
 
429
          <td>(</td>
 
430
          <td class="paramtype">const char *&nbsp;</td>
 
431
          <td class="paramname"> <em>fname</em></td>
 
432
          <td>&nbsp;)&nbsp;</td>
 
433
          <td><code> [static]</code></td>
 
434
        </tr>
 
435
      </table>
 
436
</div>
 
437
<div class="memdoc">
 
438
 
 
439
</div>
 
440
</div>
 
441
<a class="anchor" id="af7db148138646754bdcb9ad2a093d379"></a><!-- doxytag: member="ipe::Document::save" ref="af7db148138646754bdcb9ad2a093d379" args="(TellStream &amp;stream, TFormat format, uint flags) const " -->
 
442
<div class="memitem">
 
443
<div class="memproto">
 
444
      <table class="memname">
 
445
        <tr>
 
446
          <td class="memname">bool Document::save </td>
 
447
          <td>(</td>
 
448
          <td class="paramtype"><a class="el" href="classipe_1_1_tell_stream.html">TellStream</a> &amp;&nbsp;</td>
 
449
          <td class="paramname"> <em>stream</em>, </td>
 
450
        </tr>
 
451
        <tr>
 
452
          <td class="paramkey"></td>
 
453
          <td></td>
 
454
          <td class="paramtype"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a>&nbsp;</td>
 
455
          <td class="paramname"> <em>format</em>, </td>
 
456
        </tr>
 
457
        <tr>
 
458
          <td class="paramkey"></td>
 
459
          <td></td>
 
460
          <td class="paramtype">uint&nbsp;</td>
 
461
          <td class="paramname"> <em>flags</em></td><td>&nbsp;</td>
 
462
        </tr>
 
463
        <tr>
 
464
          <td></td>
 
465
          <td>)</td>
 
466
          <td></td><td></td><td> const</td>
 
467
        </tr>
 
468
      </table>
 
469
</div>
 
470
<div class="memdoc">
 
471
 
 
472
<p>Save in a stream. </p>
 
473
<p>Returns true if sucessful. </p>
 
474
 
 
475
</div>
 
476
</div>
 
477
<a class="anchor" id="add5e54191e6823081998928441fda19a"></a><!-- doxytag: member="ipe::Document::save" ref="add5e54191e6823081998928441fda19a" args="(const char *fname, TFormat format, uint flags) const " -->
 
478
<div class="memitem">
 
479
<div class="memproto">
 
480
      <table class="memname">
 
481
        <tr>
 
482
          <td class="memname">bool Document::save </td>
 
483
          <td>(</td>
 
484
          <td class="paramtype">const char *&nbsp;</td>
 
485
          <td class="paramname"> <em>fname</em>, </td>
 
486
        </tr>
 
487
        <tr>
 
488
          <td class="paramkey"></td>
 
489
          <td></td>
 
490
          <td class="paramtype"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a>&nbsp;</td>
 
491
          <td class="paramname"> <em>format</em>, </td>
 
492
        </tr>
 
493
        <tr>
 
494
          <td class="paramkey"></td>
 
495
          <td></td>
 
496
          <td class="paramtype">uint&nbsp;</td>
 
497
          <td class="paramname"> <em>flags</em></td><td>&nbsp;</td>
 
498
        </tr>
 
499
        <tr>
 
500
          <td></td>
 
501
          <td>)</td>
 
502
          <td></td><td></td><td> const</td>
 
503
        </tr>
 
504
      </table>
 
505
</div>
 
506
<div class="memdoc">
 
507
 
 
508
</div>
 
509
</div>
 
510
<a class="anchor" id="aa2ef1e5c2d89df84bacffddca47a4df6"></a><!-- doxytag: member="ipe::Document::exportPages" ref="aa2ef1e5c2d89df84bacffddca47a4df6" args="(const char *fname, uint flags, int fromPage, int toPage) const " -->
 
511
<div class="memitem">
 
512
<div class="memproto">
 
513
      <table class="memname">
 
514
        <tr>
 
515
          <td class="memname">bool Document::exportPages </td>
 
516
          <td>(</td>
 
517
          <td class="paramtype">const char *&nbsp;</td>
 
518
          <td class="paramname"> <em>fname</em>, </td>
 
519
        </tr>
 
520
        <tr>
 
521
          <td class="paramkey"></td>
 
522
          <td></td>
 
523
          <td class="paramtype">uint&nbsp;</td>
 
524
          <td class="paramname"> <em>flags</em>, </td>
 
525
        </tr>
 
526
        <tr>
 
527
          <td class="paramkey"></td>
 
528
          <td></td>
 
529
          <td class="paramtype">int&nbsp;</td>
 
530
          <td class="paramname"> <em>fromPage</em>, </td>
 
531
        </tr>
 
532
        <tr>
 
533
          <td class="paramkey"></td>
 
534
          <td></td>
 
535
          <td class="paramtype">int&nbsp;</td>
 
536
          <td class="paramname"> <em>toPage</em></td><td>&nbsp;</td>
 
537
        </tr>
 
538
        <tr>
 
539
          <td></td>
 
540
          <td>)</td>
 
541
          <td></td><td></td><td> const</td>
 
542
        </tr>
 
543
      </table>
 
544
</div>
 
545
<div class="memdoc">
 
546
 
 
547
<p>Export a range of pages to PDF. </p>
 
548
 
 
549
</div>
 
550
</div>
 
551
<a class="anchor" id="a935954a56b6ff3fa667fab0d74367368"></a><!-- doxytag: member="ipe::Document::exportView" ref="a935954a56b6ff3fa667fab0d74367368" args="(const char *fname, TFormat format, uint flags, int pno, int vno) const " -->
 
552
<div class="memitem">
 
553
<div class="memproto">
 
554
      <table class="memname">
 
555
        <tr>
 
556
          <td class="memname">bool Document::exportView </td>
 
557
          <td>(</td>
 
558
          <td class="paramtype">const char *&nbsp;</td>
 
559
          <td class="paramname"> <em>fname</em>, </td>
 
560
        </tr>
 
561
        <tr>
 
562
          <td class="paramkey"></td>
 
563
          <td></td>
 
564
          <td class="paramtype"><a class="el" href="classipe_1_1_document.html#a007132c3412a12d8e7eca62899579c99">TFormat</a>&nbsp;</td>
 
565
          <td class="paramname"> <em>format</em>, </td>
 
566
        </tr>
 
567
        <tr>
 
568
          <td class="paramkey"></td>
 
569
          <td></td>
 
570
          <td class="paramtype">uint&nbsp;</td>
 
571
          <td class="paramname"> <em>flags</em>, </td>
 
572
        </tr>
 
573
        <tr>
 
574
          <td class="paramkey"></td>
 
575
          <td></td>
 
576
          <td class="paramtype">int&nbsp;</td>
 
577
          <td class="paramname"> <em>pno</em>, </td>
 
578
        </tr>
 
579
        <tr>
 
580
          <td class="paramkey"></td>
 
581
          <td></td>
 
582
          <td class="paramtype">int&nbsp;</td>
 
583
          <td class="paramname"> <em>vno</em></td><td>&nbsp;</td>
 
584
        </tr>
 
585
        <tr>
 
586
          <td></td>
 
587
          <td>)</td>
 
588
          <td></td><td></td><td> const</td>
 
589
        </tr>
 
590
      </table>
 
591
</div>
 
592
<div class="memdoc">
 
593
 
 
594
<p>Export a single view to PDF or EPS. </p>
 
595
 
 
596
</div>
 
597
</div>
 
598
<a class="anchor" id="ae84fc27ae6ff7c3db16ec0c451d6000e"></a><!-- doxytag: member="ipe::Document::saveAsXml" ref="ae84fc27ae6ff7c3db16ec0c451d6000e" args="(Stream &amp;stream, bool usePdfBitmaps=false) const " -->
 
599
<div class="memitem">
 
600
<div class="memproto">
 
601
      <table class="memname">
 
602
        <tr>
 
603
          <td class="memname">void Document::saveAsXml </td>
 
604
          <td>(</td>
 
605
          <td class="paramtype"><a class="el" href="classipe_1_1_stream.html">Stream</a> &amp;&nbsp;</td>
 
606
          <td class="paramname"> <em>stream</em>, </td>
 
607
        </tr>
 
608
        <tr>
 
609
          <td class="paramkey"></td>
 
610
          <td></td>
 
611
          <td class="paramtype">bool&nbsp;</td>
 
612
          <td class="paramname"> <em>usePdfBitmaps</em> = <code>false</code></td><td>&nbsp;</td>
 
613
        </tr>
 
614
        <tr>
 
615
          <td></td>
 
616
          <td>)</td>
 
617
          <td></td><td></td><td> const</td>
 
618
        </tr>
 
619
      </table>
 
620
</div>
 
621
<div class="memdoc">
 
622
 
 
623
<p>Save in XML format into an <a class="el" href="classipe_1_1_stream.html" title="Abstract base class for output streams.">Stream</a>. </p>
 
624
 
 
625
</div>
 
626
</div>
 
627
<a class="anchor" id="a491cab0f20eebdc074511bc3bb5a0194"></a><!-- doxytag: member="ipe::Document::countPages" ref="a491cab0f20eebdc074511bc3bb5a0194" args="() const " -->
 
628
<div class="memitem">
 
629
<div class="memproto">
 
630
      <table class="memname">
 
631
        <tr>
 
632
          <td class="memname">int ipe::Document::countPages </td>
 
633
          <td>(</td>
 
634
          <td class="paramname"></td>
 
635
          <td>&nbsp;)&nbsp;</td>
 
636
          <td> const<code> [inline]</code></td>
 
637
        </tr>
 
638
      </table>
 
639
</div>
 
640
<div class="memdoc">
 
641
 
 
642
<p>Return number of pages of document. </p>
 
643
 
 
644
</div>
 
645
</div>
 
646
<a class="anchor" id="abe6c68c8a6dfb7d0160c7cd69a67b7d9"></a><!-- doxytag: member="ipe::Document::countTotalViews" ref="abe6c68c8a6dfb7d0160c7cd69a67b7d9" args="() const " -->
 
647
<div class="memitem">
 
648
<div class="memproto">
 
649
      <table class="memname">
 
650
        <tr>
 
651
          <td class="memname">int Document::countTotalViews </td>
 
652
          <td>(</td>
 
653
          <td class="paramname"></td>
 
654
          <td>&nbsp;)&nbsp;</td>
 
655
          <td> const</td>
 
656
        </tr>
 
657
      </table>
 
658
</div>
 
659
<div class="memdoc">
 
660
 
 
661
<p>Return total number of views in all pages. </p>
 
662
 
 
663
</div>
 
664
</div>
 
665
<a class="anchor" id="a1cdc78a4ea1687181e1867c65e5c9132"></a><!-- doxytag: member="ipe::Document::page" ref="a1cdc78a4ea1687181e1867c65e5c9132" args="(int no) const " -->
 
666
<div class="memitem">
 
667
<div class="memproto">
 
668
      <table class="memname">
 
669
        <tr>
 
670
          <td class="memname">const <a class="el" href="classipe_1_1_page.html">Page</a>* ipe::Document::page </td>
 
671
          <td>(</td>
 
672
          <td class="paramtype">int&nbsp;</td>
 
673
          <td class="paramname"> <em>no</em></td>
 
674
          <td>&nbsp;)&nbsp;</td>
 
675
          <td> const<code> [inline]</code></td>
 
676
        </tr>
 
677
      </table>
 
678
</div>
 
679
<div class="memdoc">
 
680
 
 
681
<p>Return page (const version). </p>
 
682
<p>The first page is no 0. </p>
 
683
 
 
684
</div>
 
685
</div>
 
686
<a class="anchor" id="a53987971f80ddd069b0254c64b3621e6"></a><!-- doxytag: member="ipe::Document::page" ref="a53987971f80ddd069b0254c64b3621e6" args="(int no)" -->
 
687
<div class="memitem">
 
688
<div class="memproto">
 
689
      <table class="memname">
 
690
        <tr>
 
691
          <td class="memname"><a class="el" href="classipe_1_1_page.html">Page</a>* ipe::Document::page </td>
 
692
          <td>(</td>
 
693
          <td class="paramtype">int&nbsp;</td>
 
694
          <td class="paramname"> <em>no</em></td>
 
695
          <td>&nbsp;)&nbsp;</td>
 
696
          <td><code> [inline]</code></td>
 
697
        </tr>
 
698
      </table>
 
699
</div>
 
700
<div class="memdoc">
 
701
 
 
702
<p>Return page. </p>
 
703
<p>The first page is no 0. </p>
 
704
 
 
705
</div>
 
706
</div>
 
707
<a class="anchor" id="a947f48ea9bf0c25738cfb7a833958cb5"></a><!-- doxytag: member="ipe::Document::set" ref="a947f48ea9bf0c25738cfb7a833958cb5" args="(int no, Page *page)" -->
 
708
<div class="memitem">
 
709
<div class="memproto">
 
710
      <table class="memname">
 
711
        <tr>
 
712
          <td class="memname"><a class="el" href="classipe_1_1_page.html">Page</a> * Document::set </td>
 
713
          <td>(</td>
 
714
          <td class="paramtype">int&nbsp;</td>
 
715
          <td class="paramname"> <em>no</em>, </td>
 
716
        </tr>
 
717
        <tr>
 
718
          <td class="paramkey"></td>
 
719
          <td></td>
 
720
          <td class="paramtype"><a class="el" href="classipe_1_1_page.html">Page</a> *&nbsp;</td>
 
721
          <td class="paramname"> <em>page</em></td><td>&nbsp;</td>
 
722
        </tr>
 
723
        <tr>
 
724
          <td></td>
 
725
          <td>)</td>
 
726
          <td></td><td></td><td></td>
 
727
        </tr>
 
728
      </table>
 
729
</div>
 
730
<div class="memdoc">
 
731
 
 
732
<p>Replace page. </p>
 
733
<p>Returns the original page. </p>
 
734
 
 
735
</div>
 
736
</div>
 
737
<a class="anchor" id="afa4e0b819ad914ddd7694a397785de69"></a><!-- doxytag: member="ipe::Document::insert" ref="afa4e0b819ad914ddd7694a397785de69" args="(int no, Page *page)" -->
 
738
<div class="memitem">
 
739
<div class="memproto">
 
740
      <table class="memname">
 
741
        <tr>
 
742
          <td class="memname">void Document::insert </td>
 
743
          <td>(</td>
 
744
          <td class="paramtype">int&nbsp;</td>
 
745
          <td class="paramname"> <em>no</em>, </td>
 
746
        </tr>
 
747
        <tr>
 
748
          <td class="paramkey"></td>
 
749
          <td></td>
 
750
          <td class="paramtype"><a class="el" href="classipe_1_1_page.html">Page</a> *&nbsp;</td>
 
751
          <td class="paramname"> <em>page</em></td><td>&nbsp;</td>
 
752
        </tr>
 
753
        <tr>
 
754
          <td></td>
 
755
          <td>)</td>
 
756
          <td></td><td></td><td></td>
 
757
        </tr>
 
758
      </table>
 
759
</div>
 
760
<div class="memdoc">
 
761
 
 
762
<p>Insert a new page. </p>
 
763
<p>The page is inserted at index <em>no</em>. </p>
 
764
 
 
765
</div>
 
766
</div>
 
767
<a class="anchor" id="ad69f7602c4874dfbb28677dac97b6c2b"></a><!-- doxytag: member="ipe::Document::push_back" ref="ad69f7602c4874dfbb28677dac97b6c2b" args="(Page *page)" -->
 
768
<div class="memitem">
 
769
<div class="memproto">
 
770
      <table class="memname">
 
771
        <tr>
 
772
          <td class="memname">void Document::push_back </td>
 
773
          <td>(</td>
 
774
          <td class="paramtype"><a class="el" href="classipe_1_1_page.html">Page</a> *&nbsp;</td>
 
775
          <td class="paramname"> <em>page</em></td>
 
776
          <td>&nbsp;)&nbsp;</td>
 
777
          <td></td>
 
778
        </tr>
 
779
      </table>
 
780
</div>
 
781
<div class="memdoc">
 
782
 
 
783
<p>Append a new page. </p>
 
784
 
 
785
</div>
 
786
</div>
 
787
<a class="anchor" id="a86854654291fba803edc595c9445ad60"></a><!-- doxytag: member="ipe::Document::remove" ref="a86854654291fba803edc595c9445ad60" args="(int no)" -->
 
788
<div class="memitem">
 
789
<div class="memproto">
 
790
      <table class="memname">
 
791
        <tr>
 
792
          <td class="memname"><a class="el" href="classipe_1_1_page.html">Page</a> * Document::remove </td>
 
793
          <td>(</td>
 
794
          <td class="paramtype">int&nbsp;</td>
 
795
          <td class="paramname"> <em>no</em></td>
 
796
          <td>&nbsp;)&nbsp;</td>
 
797
          <td></td>
 
798
        </tr>
 
799
      </table>
 
800
</div>
 
801
<div class="memdoc">
 
802
 
 
803
<p>Remove a page. </p>
 
804
<p>Returns the page that has been removed. </p>
 
805
 
 
806
</div>
 
807
</div>
 
808
<a class="anchor" id="a683c97793c04a7babc84b1d59feeddd9"></a><!-- doxytag: member="ipe::Document::properties" ref="a683c97793c04a7babc84b1d59feeddd9" args="() const " -->
 
809
<div class="memitem">
 
810
<div class="memproto">
 
811
      <table class="memname">
 
812
        <tr>
 
813
          <td class="memname"><a class="el" href="structipe_1_1_document_1_1_s_properties.html">SProperties</a> ipe::Document::properties </td>
 
814
          <td>(</td>
 
815
          <td class="paramname"></td>
 
816
          <td>&nbsp;)&nbsp;</td>
 
817
          <td> const<code> [inline]</code></td>
 
818
        </tr>
 
819
      </table>
 
820
</div>
 
821
<div class="memdoc">
 
822
 
 
823
<p>Return document properties. </p>
 
824
 
 
825
</div>
 
826
</div>
 
827
<a class="anchor" id="a96e45a1c46d75f70d51ff7af03b7e358"></a><!-- doxytag: member="ipe::Document::setProperties" ref="a96e45a1c46d75f70d51ff7af03b7e358" args="(const SProperties &amp;info)" -->
 
828
<div class="memitem">
 
829
<div class="memproto">
 
830
      <table class="memname">
 
831
        <tr>
 
832
          <td class="memname">void Document::setProperties </td>
 
833
          <td>(</td>
 
834
          <td class="paramtype">const <a class="el" href="structipe_1_1_document_1_1_s_properties.html">SProperties</a> &amp;&nbsp;</td>
 
835
          <td class="paramname"> <em>info</em></td>
 
836
          <td>&nbsp;)&nbsp;</td>
 
837
          <td></td>
 
838
        </tr>
 
839
      </table>
 
840
</div>
 
841
<div class="memdoc">
 
842
 
 
843
<p>Set document properties. </p>
 
844
 
 
845
</div>
 
846
</div>
 
847
<a class="anchor" id="abe2f2603d55c2cbebced99ec007b4d68"></a><!-- doxytag: member="ipe::Document::cascade" ref="abe2f2603d55c2cbebced99ec007b4d68" args="()" -->
 
848
<div class="memitem">
 
849
<div class="memproto">
 
850
      <table class="memname">
 
851
        <tr>
 
852
          <td class="memname"><a class="el" href="classipe_1_1_cascade.html">Cascade</a>* ipe::Document::cascade </td>
 
853
          <td>(</td>
 
854
          <td class="paramname"></td>
 
855
          <td>&nbsp;)&nbsp;</td>
 
856
          <td><code> [inline]</code></td>
 
857
        </tr>
 
858
      </table>
 
859
</div>
 
860
<div class="memdoc">
 
861
 
 
862
<p>Return stylesheet cascade. </p>
 
863
 
 
864
</div>
 
865
</div>
 
866
<a class="anchor" id="a358428f5ce3560469745b4642fb7a7a5"></a><!-- doxytag: member="ipe::Document::cascade" ref="a358428f5ce3560469745b4642fb7a7a5" args="() const " -->
 
867
<div class="memitem">
 
868
<div class="memproto">
 
869
      <table class="memname">
 
870
        <tr>
 
871
          <td class="memname">const <a class="el" href="classipe_1_1_cascade.html">Cascade</a>* ipe::Document::cascade </td>
 
872
          <td>(</td>
 
873
          <td class="paramname"></td>
 
874
          <td>&nbsp;)&nbsp;</td>
 
875
          <td> const<code> [inline]</code></td>
 
876
        </tr>
 
877
      </table>
 
878
</div>
 
879
<div class="memdoc">
 
880
 
 
881
<p>Return stylesheet cascade (const version). </p>
 
882
 
 
883
</div>
 
884
</div>
 
885
<a class="anchor" id="ae7c9596d5ebc8bc3d664c6ac24b0dfab"></a><!-- doxytag: member="ipe::Document::replaceCascade" ref="ae7c9596d5ebc8bc3d664c6ac24b0dfab" args="(Cascade *cascade)" -->
 
886
<div class="memitem">
 
887
<div class="memproto">
 
888
      <table class="memname">
 
889
        <tr>
 
890
          <td class="memname"><a class="el" href="classipe_1_1_cascade.html">Cascade</a> * Document::replaceCascade </td>
 
891
          <td>(</td>
 
892
          <td class="paramtype"><a class="el" href="classipe_1_1_cascade.html">Cascade</a> *&nbsp;</td>
 
893
          <td class="paramname"> <em>sheets</em></td>
 
894
          <td>&nbsp;)&nbsp;</td>
 
895
          <td></td>
 
896
        </tr>
 
897
      </table>
 
898
</div>
 
899
<div class="memdoc">
 
900
 
 
901
<p>Replace the entire style sheet cascade. </p>
 
902
<p>Takes ownership of <em>cascade</em>, and returns the original cascade. </p>
 
903
 
 
904
</div>
 
905
</div>
 
906
<a class="anchor" id="a14ca545e8d566ce84d2854829bf354a9"></a><!-- doxytag: member="ipe::Document::setFontPool" ref="a14ca545e8d566ce84d2854829bf354a9" args="(FontPool *fontPool)" -->
 
907
<div class="memitem">
 
908
<div class="memproto">
 
909
      <table class="memname">
 
910
        <tr>
 
911
          <td class="memname">void Document::setFontPool </td>
 
912
          <td>(</td>
 
913
          <td class="paramtype">FontPool *&nbsp;</td>
 
914
          <td class="paramname"> <em>fontPool</em></td>
 
915
          <td>&nbsp;)&nbsp;</td>
 
916
          <td></td>
 
917
        </tr>
 
918
      </table>
 
919
</div>
 
920
<div class="memdoc">
 
921
 
 
922
<p>Update the font pool (after running Pdflatex). </p>
 
923
<p>Takes ownership of the font pool. </p>
 
924
 
 
925
</div>
 
926
</div>
 
927
<a class="anchor" id="a20ce860d84e3d8a8d82877b790dd055d"></a><!-- doxytag: member="ipe::Document::fontPool" ref="a20ce860d84e3d8a8d82877b790dd055d" args="() const " -->
 
928
<div class="memitem">
 
929
<div class="memproto">
 
930
      <table class="memname">
 
931
        <tr>
 
932
          <td class="memname">const FontPool* ipe::Document::fontPool </td>
 
933
          <td>(</td>
 
934
          <td class="paramname"></td>
 
935
          <td>&nbsp;)&nbsp;</td>
 
936
          <td> const<code> [inline]</code></td>
 
937
        </tr>
 
938
      </table>
 
939
</div>
 
940
<div class="memdoc">
 
941
 
 
942
<p>Return the current FontPool. </p>
 
943
 
 
944
</div>
 
945
</div>
 
946
<a class="anchor" id="acbd7893d71e6b0266f28848820672a3b"></a><!-- doxytag: member="ipe::Document::hasTrueTypeFonts" ref="acbd7893d71e6b0266f28848820672a3b" args="() const " -->
 
947
<div class="memitem">
 
948
<div class="memproto">
 
949
      <table class="memname">
 
950
        <tr>
 
951
          <td class="memname">bool Document::hasTrueTypeFonts </td>
 
952
          <td>(</td>
 
953
          <td class="paramname"></td>
 
954
          <td>&nbsp;)&nbsp;</td>
 
955
          <td> const</td>
 
956
        </tr>
 
957
      </table>
 
958
</div>
 
959
<div class="memdoc">
 
960
 
 
961
<p>Return whether this document uses any Truetype fonts. </p>
 
962
 
 
963
</div>
 
964
</div>
 
965
<a class="anchor" id="a83cb664fe9e632cb134cb01eedb04900"></a><!-- doxytag: member="ipe::Document::hasTransparency" ref="a83cb664fe9e632cb134cb01eedb04900" args="() const " -->
 
966
<div class="memitem">
 
967
<div class="memproto">
 
968
      <table class="memname">
 
969
        <tr>
 
970
          <td class="memname">bool Document::hasTransparency </td>
 
971
          <td>(</td>
 
972
          <td class="paramname"></td>
 
973
          <td>&nbsp;)&nbsp;</td>
 
974
          <td> const</td>
 
975
        </tr>
 
976
      </table>
 
977
</div>
 
978
<div class="memdoc">
 
979
 
 
980
<p>Does this document make any use of transparency? </p>
 
981
<p>The document is considered to make use of transparency if its style sheets define any opacities whose value is not 1.0. </p>
 
982
 
 
983
</div>
 
984
</div>
 
985
<a class="anchor" id="af2b760380c366aa71ed007c9ce1f1360"></a><!-- doxytag: member="ipe::Document::hasTilings" ref="af2b760380c366aa71ed007c9ce1f1360" args="() const " -->
 
986
<div class="memitem">
 
987
<div class="memproto">
 
988
      <table class="memname">
 
989
        <tr>
 
990
          <td class="memname">bool Document::hasTilings </td>
 
991
          <td>(</td>
 
992
          <td class="paramname"></td>
 
993
          <td>&nbsp;)&nbsp;</td>
 
994
          <td> const</td>
 
995
        </tr>
 
996
      </table>
 
997
</div>
 
998
<div class="memdoc">
 
999
 
 
1000
<p>Does this document contain any tiling patterns? </p>
 
1001
 
 
1002
</div>
 
1003
</div>
 
1004
<a class="anchor" id="ac19f0c51327c86febcb3e22290143efd"></a><!-- doxytag: member="ipe::Document::hasGradients" ref="ac19f0c51327c86febcb3e22290143efd" args="() const " -->
 
1005
<div class="memitem">
 
1006
<div class="memproto">
 
1007
      <table class="memname">
 
1008
        <tr>
 
1009
          <td class="memname">bool Document::hasGradients </td>
 
1010
          <td>(</td>
 
1011
          <td class="paramname"></td>
 
1012
          <td>&nbsp;)&nbsp;</td>
 
1013
          <td> const</td>
 
1014
        </tr>
 
1015
      </table>
 
1016
</div>
 
1017
<div class="memdoc">
 
1018
 
 
1019
<p>Does this document contain any gradients? </p>
 
1020
 
 
1021
</div>
 
1022
</div>
 
1023
<a class="anchor" id="a94eaa4c30728cc697c64ae0d14d4cdf5"></a><!-- doxytag: member="ipe::Document::findBitmaps" ref="a94eaa4c30728cc697c64ae0d14d4cdf5" args="(BitmapFinder &amp;bm) const " -->
 
1024
<div class="memitem">
 
1025
<div class="memproto">
 
1026
      <table class="memname">
 
1027
        <tr>
 
1028
          <td class="memname">void Document::findBitmaps </td>
 
1029
          <td>(</td>
 
1030
          <td class="paramtype"><a class="el" href="classipe_1_1_bitmap_finder.html">BitmapFinder</a> &amp;&nbsp;</td>
 
1031
          <td class="paramname"> <em>bm</em></td>
 
1032
          <td>&nbsp;)&nbsp;</td>
 
1033
          <td> const</td>
 
1034
        </tr>
 
1035
      </table>
 
1036
</div>
 
1037
<div class="memdoc">
 
1038
 
 
1039
<p>Create a list of all bitmaps in the document. </p>
 
1040
 
 
1041
</div>
 
1042
</div>
 
1043
<a class="anchor" id="ac97b90e5f4008bb3df5632f967728c12"></a><!-- doxytag: member="ipe::Document::checkStyle" ref="ac97b90e5f4008bb3df5632f967728c12" args="(AttributeSeq &amp;seq) const " -->
 
1044
<div class="memitem">
 
1045
<div class="memproto">
 
1046
      <table class="memname">
 
1047
        <tr>
 
1048
          <td class="memname">bool Document::checkStyle </td>
 
1049
          <td>(</td>
 
1050
          <td class="paramtype"><a class="el" href="group__attr.html#ga724109aa4dbab072ea067cc5ed471e02">AttributeSeq</a> &amp;&nbsp;</td>
 
1051
          <td class="paramname"> <em>seq</em></td>
 
1052
          <td>&nbsp;)&nbsp;</td>
 
1053
          <td> const</td>
 
1054
        </tr>
 
1055
      </table>
 
1056
</div>
 
1057
<div class="memdoc">
 
1058
 
 
1059
<p>Check all symbolic attributes in the document. </p>
 
1060
<p>This function verifies that all symbolic attributes in the document are defined in the style sheet. It appends to <em>seq</em> all symbolic attributes (in no particular order, but without duplicates) that are NOT defined.</p>
 
1061
<p>Returns <code>true</code> if there are no undefined symbolic attributes in the document. </p>
 
1062
 
 
1063
</div>
 
1064
</div>
 
1065
<a class="anchor" id="a37bb25c828f2ecc0a7fdaa0465356511"></a><!-- doxytag: member="ipe::Document::runLatex" ref="a37bb25c828f2ecc0a7fdaa0465356511" args="(String &amp;logFile)" -->
 
1066
<div class="memitem">
 
1067
<div class="memproto">
 
1068
      <table class="memname">
 
1069
        <tr>
 
1070
          <td class="memname">int Document::runLatex </td>
 
1071
          <td>(</td>
 
1072
          <td class="paramtype"><a class="el" href="classipe_1_1_string.html">String</a> &amp;&nbsp;</td>
 
1073
          <td class="paramname"> <em>logFile</em></td>
 
1074
          <td>&nbsp;)&nbsp;</td>
 
1075
          <td></td>
 
1076
        </tr>
 
1077
      </table>
 
1078
</div>
 
1079
<div class="memdoc">
 
1080
 
 
1081
<p>Run PdfLatex. </p>
 
1082
 
 
1083
</div>
 
1084
</div>
 
1085
<a class="anchor" id="a95ebb4e4992ce6afa8a67bf172e0aded"></a><!-- doxytag: member="ipe::Document::runLatex" ref="a95ebb4e4992ce6afa8a67bf172e0aded" args="()" -->
 
1086
<div class="memitem">
 
1087
<div class="memproto">
 
1088
      <table class="memname">
 
1089
        <tr>
 
1090
          <td class="memname">int Document::runLatex </td>
 
1091
          <td>(</td>
 
1092
          <td class="paramname"></td>
 
1093
          <td>&nbsp;)&nbsp;</td>
 
1094
          <td></td>
 
1095
        </tr>
 
1096
      </table>
 
1097
</div>
 
1098
<div class="memdoc">
 
1099
 
 
1100
<p>Run Pdflatex (suitable for console applications). </p>
 
1101
<p>Success/error is reported on stderr. </p>
 
1102
 
 
1103
</div>
 
1104
</div>
 
1105
<hr/>The documentation for this class was generated from the following files:<ul>
 
1106
<li>ipedoc.h</li>
 
1107
<li>ipedoc.cpp</li>
 
1108
</ul>
 
1109
</div>
 
1110
<hr>
 
1111
</body></html>