File: class_ipe_latex.html

package info (click to toggle)
ipe 6.0pre30-5
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 5,100 kB
  • ctags: 5,419
  • sloc: cpp: 30,430; ansic: 1,045; xml: 845; makefile: 78; sh: 5
file content (226 lines) | stat: -rw-r--r-- 9,381 bytes parent folder | download
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
<!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: IpeLatex 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&nbsp;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&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>IpeLatex Class Reference</h1><!-- doxytag: class="IpeLatex" -->Object that converts latex source to PDF format.  
<a href="#_details">More...</a>
<p>
<a href="class_ipe_latex-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="class_ipe_latex.html#2e05bf16883d726814c3b895bdc48d23">IpeLatex</a> (const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a> *sheet)
<li><a class="el" href="class_ipe_latex.html#2d2b387ac0bd1fe097fd47b748721249">~IpeLatex</a> ()
<li>int <a class="el" href="class_ipe_latex.html#6977290846aebc3e817d1f708355887b">ScanObject</a> (const <a class="el" href="class_ipe_object.html">IpeObject</a> *obj)
<li>int <a class="el" href="class_ipe_latex.html#bb307ac2abb712e4b92ba483b3a4dcc2">ScanPage</a> (<a class="el" href="class_ipe_page.html">IpePage</a> *page)
<li>int <a class="el" href="class_ipe_latex.html#e23ccc9587345bd83da1d910c68413a9">CreateLatexSource</a> (<a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;stream, <a class="el" href="class_ipe_string.html">IpeString</a> preamble)
<li>bool <a class="el" href="class_ipe_latex.html#b375acebea641dcca3970c9d00ddec14">ReadPdf</a> (<a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;source)
<li>bool <a class="el" href="class_ipe_latex.html#d890d41d6e14e51198b2314d7be27e2d">UpdateTextObjects</a> ()
<li><a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * <a class="el" href="class_ipe_latex.html#96d67ec96e42ee0d145a760aeb0f1f2e">TakeFontPool</a> ()
</ul>
<h2>Friends</h2>
<ul>
<li><a class="anchor" name="e3673d9067c964883aba5fb5dbbee114"></a><!-- doxytag: member="IpeLatex::TextCollectingVisitor" ref="e3673d9067c964883aba5fb5dbbee114" args="" -->
class <b>TextCollectingVisitor</b>
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Object that converts latex source to PDF format. 
<p>
This object is responsible for creating the PDF representation of text objects. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2e05bf16883d726814c3b895bdc48d23"></a><!-- doxytag: member="IpeLatex::IpeLatex" ref="2e05bf16883d726814c3b895bdc48d23" args="(const IpeStyleSheet *sheet)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IpeLatex::IpeLatex           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a> *&nbsp;</td>
          <td class="paramname"> <em>sheet</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a converter object. 
<p>

</div>
</div><p>
<a class="anchor" name="2d2b387ac0bd1fe097fd47b748721249"></a><!-- doxytag: member="IpeLatex::~IpeLatex" ref="2d2b387ac0bd1fe097fd47b748721249" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IpeLatex::~IpeLatex           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="6977290846aebc3e817d1f708355887b"></a><!-- doxytag: member="IpeLatex::ScanObject" ref="6977290846aebc3e817d1f708355887b" args="(const IpeObject *obj)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int IpeLatex::ScanObject           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_ipe_object.html">IpeObject</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Scan an object and insert all text objects into IpeLatex's list. Returns total number of text objects found so far. 
</div>
</div><p>
<a class="anchor" name="bb307ac2abb712e4b92ba483b3a4dcc2"></a><!-- doxytag: member="IpeLatex::ScanPage" ref="bb307ac2abb712e4b92ba483b3a4dcc2" args="(IpePage *page)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int IpeLatex::ScanPage           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_ipe_page.html">IpePage</a> *&nbsp;</td>
          <td class="paramname"> <em>page</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Scan a page and insert all text objects into IpeLatex's list. Returns total number of text objects found so far. 
</div>
</div><p>
<a class="anchor" name="e23ccc9587345bd83da1d910c68413a9"></a><!-- doxytag: member="IpeLatex::CreateLatexSource" ref="e23ccc9587345bd83da1d910c68413a9" args="(IpeStream &amp;stream, IpeString preamble)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int IpeLatex::CreateLatexSource           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>stream</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
          <td class="paramname"> <em>preamble</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a Latex source file with all the text objects collected before. The client should have prepared a directory for the Pdflatex run, and pass the name of the Latex source file to be written by <a class="el" href="class_ipe_latex.html">IpeLatex</a>.<p>
Returns the number of text objects that did not yet have an XForm, or a negative error code. 
</div>
</div><p>
<a class="anchor" name="b375acebea641dcca3970c9d00ddec14"></a><!-- doxytag: member="IpeLatex::ReadPdf" ref="b375acebea641dcca3970c9d00ddec14" args="(IpeDataSource &amp;source)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool IpeLatex::ReadPdf           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>source</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read the PDF file created by Pdflatex. 
<p>
Must have performed the call to Pdflatex, and pass the name of the resulting output file. 
</div>
</div><p>
<a class="anchor" name="d890d41d6e14e51198b2314d7be27e2d"></a><!-- doxytag: member="IpeLatex::UpdateTextObjects" ref="d890d41d6e14e51198b2314d7be27e2d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool IpeLatex::UpdateTextObjects           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Notify all text objects about their updated PDF code. 
<p>
Returns true if successful. 
</div>
</div><p>
<a class="anchor" name="96d67ec96e42ee0d145a760aeb0f1f2e"></a><!-- doxytag: member="IpeLatex::TakeFontPool" ref="96d67ec96e42ee0d145a760aeb0f1f2e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * IpeLatex::TakeFontPool           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the newly created font pool and pass ownership of pool to caller. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipelatex.h<li>ipelatex.cpp</ul>
<hr>
</body></html>