1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
<!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: IpeletHelper Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<h1>IpeletHelper Class Reference<br>
<small>
[<a class="el" href="group__ipelet.html">The Ipelet interface</a>]</small>
</h1><!-- doxytag: class="IpeletHelper" -->Service provider for Ipelets.
<a href="#_details">More...</a>
<p>
<a href="class_ipelet_helper-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>virtual void <a class="el" href="class_ipelet_helper.html#a1">Message</a> (const char *msg)=0
<li>virtual int <a class="el" href="class_ipelet_helper.html#a2">MessageBox</a> (const char *text, const char *button1, const char *button2, const char *button3)=0
<li>virtual bool <a class="el" href="class_ipelet_helper.html#a3">GetString</a> (const char *prompt, <a class="el" href="class_ipe_string.html">IpeString</a> &str)=0
<li>virtual const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a> * <a class="el" href="class_ipelet_helper.html#a4">StyleSheet</a> ()=0
<li>virtual const <a class="el" href="class_ipe_document.html">IpeDocument</a> * <a class="el" href="class_ipelet_helper.html#a5">Document</a> ()=0
<li>virtual <a class="el" href="class_ipe_document.html">IpeDocument</a> * <a class="el" href="class_ipelet_helper.html#a6">EditDocument</a> ()=0
<li>virtual int <a class="el" href="class_ipelet_helper.html#a7">CurrentPage</a> () const =0
<li>virtual int <a class="el" href="class_ipelet_helper.html#a8">CurrentView</a> () const =0
<li>virtual int <a class="el" href="class_ipelet_helper.html#a9">CurrentLayer</a> () const =0
<li>virtual const <a class="el" href="class_ipe_all_attributes.html">IpeAllAttributes</a> & <a class="el" href="class_ipelet_helper.html#a10">Attributes</a> () const =0
<li>virtual const <a class="el" href="class_ipe_snap_data.html">IpeSnapData</a> & <a class="el" href="class_ipelet_helper.html#a11">SnapData</a> () const =0
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Service provider for Ipelets.
<p>
Ipelets can ask Ipe to perform various services and request information using this class.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1"></a><!-- doxytag: member="IpeletHelper::Message" ref="a1" args="(const char *msg)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void IpeletHelper::Message </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname1" valign="top" nowrap> <em>msg</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Show a message in the status bar.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="IpeletHelper::MessageBox" ref="a2" args="(const char *text, const char *button1, const char *button2, const char *button3)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int IpeletHelper::MessageBox </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>button1</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>button2</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>button3</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Pop up a modal message box with the <em>text</em>, and up to three buttons (Use 0 pointer to remove a button). Returns index (0 to 2) of button pressed. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="IpeletHelper::GetString" ref="a3" args="(const char *prompt, IpeString &str)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual bool IpeletHelper::GetString </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>prompt</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="class_ipe_string.html">IpeString</a> & </td>
<td class="mdname" nowrap> <em>str</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Pop up a modal dialog asking the user to enter a string. Returns true if the user didn't cancel the dialog. </td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="IpeletHelper::StyleSheet" ref="a4" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const <a class="el" href="class_ipe_style_sheet.html">IpeStyleSheet</a>* IpeletHelper::StyleSheet </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the style sheet. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="IpeletHelper::Document" ref="a5" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const <a class="el" href="class_ipe_document.html">IpeDocument</a>* IpeletHelper::Document </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return read-only document. </td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="IpeletHelper::EditDocument" ref="a6" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="class_ipe_document.html">IpeDocument</a>* IpeletHelper::EditDocument </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get read-write access to the entire document. Marks the document as edited, and resets undo. </td>
</tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="IpeletHelper::CurrentPage" ref="a7" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int IpeletHelper::CurrentPage </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return index of current page (starting with 0).
<p>
</td>
</tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="IpeletHelper::CurrentView" ref="a8" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int IpeletHelper::CurrentView </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return index of current page view (starting with 0).
<p>
</td>
</tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="IpeletHelper::CurrentLayer" ref="a9" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual int IpeletHelper::CurrentLayer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return index of current layer in the page.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="IpeletHelper::Attributes" ref="a10" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const <a class="el" href="class_ipe_all_attributes.html">IpeAllAttributes</a>& IpeletHelper::Attributes </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the attributes currently set in the UI.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="IpeletHelper::SnapData" ref="a11" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual const <a class="el" href="class_ipe_snap_data.html">IpeSnapData</a>& IpeletHelper::SnapData </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the current snapping situation in Ipe. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>ipelet.h</ul>
<hr>
</body></html>
|
