← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/class_ipelet_helper.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve M. Robbins
  • Date: 2004-06-08 00:44:02 UTC
  • Revision ID: james.westby@ubuntu.com-20040608004402-72yu51xlh7vt6p9m
Tags: upstream-6.0pre16
Import upstream version 6.0pre16

Show diffs side-by-side

added added

removed removed

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