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
|
<!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: Ipelet 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>Ipelet Class Reference<br>
<small>
[<a class="el" href="group__ipelet.html">The Ipelet interface</a>]</small>
</h1><!-- doxytag: class="Ipelet" -->Abstract base class for Ipelets.
<a href="#_details">More...</a>
<p>
<a href="class_ipelet-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="class_ipelet.html#a0">~Ipelet</a> ()=0
<li>virtual int <a class="el" href="class_ipelet.html#a1">IpelibVersion</a> () const =0
<li>virtual int <a class="el" href="class_ipelet.html#a2">NumFunctions</a> () const
<li>virtual const char * <a class="el" href="class_ipelet.html#a3">Label</a> () const =0
<li>virtual const char * <a class="el" href="class_ipelet.html#a4">SubLabel</a> (int function) const
<li>virtual const char * <a class="el" href="class_ipelet.html#a5">About</a> () const
<li>virtual void <a class="el" href="class_ipelet.html#a6">Run</a> (int function, <a class="el" href="class_ipe_page.html">IpePage</a> *page, <a class="el" href="class_ipelet_helper.html">IpeletHelper</a> *helper)=0
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract base class for Ipelets.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="Ipelet::~Ipelet" ref="a0" 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">Ipelet::~Ipelet </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>
Pure virtual destructor.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1"></a><!-- doxytag: member="Ipelet::IpelibVersion" ref="a1" 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 Ipelet::IpelibVersion </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 version of Ipelib the Ipelet was linked against.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="Ipelet::NumFunctions" ref="a2" args="() const " --><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">int Ipelet::NumFunctions </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the number of functions implemented by this Ipelet.
<p>
The default implementation returns 1. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="Ipelet::Label" ref="a3" 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 char* Ipelet::Label </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 label of the Ipelet (to be shown in the menu).
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="Ipelet::SubLabel" ref="a4" args="(int function) const " --><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">const char * Ipelet::SubLabel </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>function</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return a label for each function implemented by this Ipelet.
<p>
This is not called if NumFunctions returns 1. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="Ipelet::About" ref="a5" args="() const " --><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">const char * Ipelet::About </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> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return an 'about' or copyright notice for this ipelet.
<p>
Ipe displays this in the ipelet About box. </td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="Ipelet::Run" ref="a6" args="(int function, IpePage *page, IpeletHelper *helper)=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 Ipelet::Run </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>function</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_page.html">IpePage</a> * </td>
<td class="mdname" nowrap> <em>page</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="class_ipelet_helper.html">IpeletHelper</a> * </td>
<td class="mdname" nowrap> <em>helper</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>
Run a function from the Ipelet.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipelet.h<li>ipelet.cpp</ul>
<hr>
</body></html>
|
