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

« back to all changes in this revision

Viewing changes to doc/class_ipe_latex.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2005-02-24 22:09:16 UTC
  • mfrom: (2.1.1 hoary)
  • Revision ID: james.westby@ubuntu.com-20050224220916-9vxiiqjz066r5489
Tags: 6.0pre23-2
debian/control: Ipe should depend on exact version of libipe.
Closes: #296771.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
 
3
<title>Ipelib: IpeLatex class Reference</title>
 
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
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>IpeLatex Class Reference</h1>Object that converts latex source to PDF format.  
 
9
<a href="#_details">More...</a>
 
10
<p>
 
11
<a href="class_ipe_latex-members.html">List of all members.</a><h2>Public Member Functions</h2>
 
12
<ul>
 
13
<li><a class="el" href="class_ipe_latex.html#a0">IpeLatex</a> ()
 
14
<li><a class="el" href="class_ipe_latex.html#a1">~IpeLatex</a> ()
 
15
<li>int <a class="el" href="class_ipe_latex.html#a2">ScanPage</a> (<a class="el" href="class_ipe_page.html">IpePage</a> *page)
 
16
<li>int <a class="el" href="class_ipe_latex.html#a3">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, const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a> *sheet)
 
17
<li>bool <a class="el" href="class_ipe_latex.html#a4">ReadPdf</a> (<a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;source)
 
18
<li>bool <a class="el" href="class_ipe_latex.html#a5">UpdateTextObjects</a> ()
 
19
<li><a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * <a class="el" href="class_ipe_latex.html#a6">TakeFontPool</a> ()
 
20
</ul>
 
21
<h2>Friends</h2>
 
22
<ul>
 
23
<li><a class="anchor" name="n0" doxytag="IpeLatex::TextCollectingVisitor" ></a>
 
24
class <b>TextCollectingVisitor</b>
 
25
</ul>
 
26
<hr><a name="_details"></a><h2>Detailed Description</h2>
 
27
Object that converts latex source to PDF format. 
 
28
<p>
 
29
This object is responsible for creating the PDF representation of text objects. 
 
30
<p>
 
31
<hr><h2>Constructor &amp; Destructor Documentation</h2>
 
32
<a class="anchor" name="a0" doxytag="IpeLatex::IpeLatex" ></a><p>
 
33
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
34
  <tr>
 
35
    <td class="mdRow">
 
36
      <table cellpadding="0" cellspacing="0" border="0">
 
37
        <tr>
 
38
          <td class="md" nowrap valign="top"> IpeLatex::IpeLatex </td>
 
39
          <td class="md" valign="top">(&nbsp;</td>
 
40
          <td class="mdname1" valign="top" nowrap>          </td>
 
41
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
42
          <td class="md" nowrap></td>
 
43
        </tr>
 
44
 
 
45
      </table>
 
46
    </td>
 
47
  </tr>
 
48
</table>
 
49
<table cellspacing=5 cellpadding=0 border=0>
 
50
  <tr>
 
51
    <td>
 
52
      &nbsp;
 
53
    </td>
 
54
    <td>
 
55
 
 
56
<p>
 
57
Create a converter object. 
 
58
<p>
 
59
    </td>
 
60
  </tr>
 
61
</table>
 
62
<a class="anchor" name="a1" doxytag="IpeLatex::~IpeLatex" ></a><p>
 
63
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
64
  <tr>
 
65
    <td class="mdRow">
 
66
      <table cellpadding="0" cellspacing="0" border="0">
 
67
        <tr>
 
68
          <td class="md" nowrap valign="top"> IpeLatex::~<a class="el" href="class_ipe_latex.html">IpeLatex</a> </td>
 
69
          <td class="md" valign="top">(&nbsp;</td>
 
70
          <td class="mdname1" valign="top" nowrap>          </td>
 
71
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
72
          <td class="md" nowrap></td>
 
73
        </tr>
 
74
 
 
75
      </table>
 
76
    </td>
 
77
  </tr>
 
78
</table>
 
79
<table cellspacing=5 cellpadding=0 border=0>
 
80
  <tr>
 
81
    <td>
 
82
      &nbsp;
 
83
    </td>
 
84
    <td>
 
85
 
 
86
<p>
 
87
Destructor. 
 
88
<p>
 
89
    </td>
 
90
  </tr>
 
91
</table>
 
92
<hr><h2>Member Function Documentation</h2>
 
93
<a class="anchor" name="a2" doxytag="IpeLatex::ScanPage" ></a><p>
 
94
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
95
  <tr>
 
96
    <td class="mdRow">
 
97
      <table cellpadding="0" cellspacing="0" border="0">
 
98
        <tr>
 
99
          <td class="md" nowrap valign="top"> int IpeLatex::ScanPage </td>
 
100
          <td class="md" valign="top">(&nbsp;</td>
 
101
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_page.html">IpePage</a> *&nbsp;</td>
 
102
          <td class="mdname1" valign="top" nowrap> <em>page</em>          </td>
 
103
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
104
          <td class="md" nowrap></td>
 
105
        </tr>
 
106
 
 
107
      </table>
 
108
    </td>
 
109
  </tr>
 
110
</table>
 
111
<table cellspacing=5 cellpadding=0 border=0>
 
112
  <tr>
 
113
    <td>
 
114
      &nbsp;
 
115
    </td>
 
116
    <td>
 
117
 
 
118
<p>
 
119
Scan a page and insert all text objects into IpeLatex's list. Returns total number of text objects found so far.     </td>
 
120
  </tr>
 
121
</table>
 
122
<a class="anchor" name="a3" doxytag="IpeLatex::CreateLatexSource" ></a><p>
 
123
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
124
  <tr>
 
125
    <td class="mdRow">
 
126
      <table cellpadding="0" cellspacing="0" border="0">
 
127
        <tr>
 
128
          <td class="md" nowrap valign="top"> int IpeLatex::CreateLatexSource </td>
 
129
          <td class="md" valign="top">(&nbsp;</td>
 
130
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_stream.html">IpeStream</a> &amp;&nbsp;</td>
 
131
          <td class="mdname" nowrap> <em>stream</em>, </td>
 
132
        </tr>
 
133
        <tr>
 
134
          <td class="md" nowrap align="right"></td>
 
135
          <td></td>
 
136
          <td class="md" nowrap><a class="el" href="class_ipe_string.html">IpeString</a>&nbsp;</td>
 
137
          <td class="mdname" nowrap> <em>preamble</em>, </td>
 
138
        </tr>
 
139
        <tr>
 
140
          <td class="md" nowrap align="right"></td>
 
141
          <td></td>
 
142
          <td class="md" nowrap>const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a> *&nbsp;</td>
 
143
          <td class="mdname" nowrap> <em>sheet</em></td>
 
144
        </tr>
 
145
        <tr>
 
146
          <td></td>
 
147
          <td class="md">)&nbsp;</td>
 
148
          <td class="md" colspan="2"></td>
 
149
        </tr>
 
150
 
 
151
      </table>
 
152
    </td>
 
153
  </tr>
 
154
</table>
 
155
<table cellspacing=5 cellpadding=0 border=0>
 
156
  <tr>
 
157
    <td>
 
158
      &nbsp;
 
159
    </td>
 
160
    <td>
 
161
 
 
162
<p>
 
163
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 IpeLatex.<p>
 
164
Returns the number of text objects that did not yet have an XForm, or a negative error code.     </td>
 
165
  </tr>
 
166
</table>
 
167
<a class="anchor" name="a4" doxytag="IpeLatex::ReadPdf" ></a><p>
 
168
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
169
  <tr>
 
170
    <td class="mdRow">
 
171
      <table cellpadding="0" cellspacing="0" border="0">
 
172
        <tr>
 
173
          <td class="md" nowrap valign="top"> bool IpeLatex::ReadPdf </td>
 
174
          <td class="md" valign="top">(&nbsp;</td>
 
175
          <td class="md" nowrap valign="top"><a class="el" href="class_ipe_data_source.html">IpeDataSource</a> &amp;&nbsp;</td>
 
176
          <td class="mdname1" valign="top" nowrap> <em>source</em>          </td>
 
177
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
178
          <td class="md" nowrap></td>
 
179
        </tr>
 
180
 
 
181
      </table>
 
182
    </td>
 
183
  </tr>
 
184
</table>
 
185
<table cellspacing=5 cellpadding=0 border=0>
 
186
  <tr>
 
187
    <td>
 
188
      &nbsp;
 
189
    </td>
 
190
    <td>
 
191
 
 
192
<p>
 
193
Read the PDF file created by Pdflatex. 
 
194
<p>
 
195
Must have performed the call to Pdflatex, and pass the name of the resulting output file.     </td>
 
196
  </tr>
 
197
</table>
 
198
<a class="anchor" name="a5" doxytag="IpeLatex::UpdateTextObjects" ></a><p>
 
199
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
200
  <tr>
 
201
    <td class="mdRow">
 
202
      <table cellpadding="0" cellspacing="0" border="0">
 
203
        <tr>
 
204
          <td class="md" nowrap valign="top"> bool IpeLatex::UpdateTextObjects </td>
 
205
          <td class="md" valign="top">(&nbsp;</td>
 
206
          <td class="mdname1" valign="top" nowrap>          </td>
 
207
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
208
          <td class="md" nowrap></td>
 
209
        </tr>
 
210
 
 
211
      </table>
 
212
    </td>
 
213
  </tr>
 
214
</table>
 
215
<table cellspacing=5 cellpadding=0 border=0>
 
216
  <tr>
 
217
    <td>
 
218
      &nbsp;
 
219
    </td>
 
220
    <td>
 
221
 
 
222
<p>
 
223
Notify all text objects about their updated PDF code. 
 
224
<p>
 
225
Returns true if successful.     </td>
 
226
  </tr>
 
227
</table>
 
228
<a class="anchor" name="a6" doxytag="IpeLatex::TakeFontPool" ></a><p>
 
229
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 
230
  <tr>
 
231
    <td class="mdRow">
 
232
      <table cellpadding="0" cellspacing="0" border="0">
 
233
        <tr>
 
234
          <td class="md" nowrap valign="top"> <a class="el" href="class_ipe_font_pool.html">IpeFontPool</a> * IpeLatex::TakeFontPool </td>
 
235
          <td class="md" valign="top">(&nbsp;</td>
 
236
          <td class="mdname1" valign="top" nowrap>          </td>
 
237
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
238
          <td class="md" nowrap></td>
 
239
        </tr>
 
240
 
 
241
      </table>
 
242
    </td>
 
243
  </tr>
 
244
</table>
 
245
<table cellspacing=5 cellpadding=0 border=0>
 
246
  <tr>
 
247
    <td>
 
248
      &nbsp;
 
249
    </td>
 
250
    <td>
 
251
 
 
252
<p>
 
253
Return the newly created font pool and pass ownership of pool to caller. 
 
254
<p>
 
255
    </td>
 
256
  </tr>
 
257
</table>
 
258
<hr>The documentation for this class was generated from the following files:<ul>
 
259
<li>ipelatex.h<li>ipelatex.cpp</ul>
 
260
<hr>
 
261
</body></html>