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
|
<!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">
<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 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 List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></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#b82f135f3b97f6b513889a74fc05ea4d">~Ipelet</a> ()=0
<li>virtual int <a class="el" href="class_ipelet.html#363cafe3a47e4160fdb61700f2cbbd56">IpelibVersion</a> () const=0
<li>virtual int <a class="el" href="class_ipelet.html#df3fd50fdee579ae804f870e142f005b">NumFunctions</a> () const
<li>virtual const char * <a class="el" href="class_ipelet.html#e9a662b589c911f25d944f6f46cbef31">Label</a> () const=0
<li>virtual const char * <a class="el" href="class_ipelet.html#816edb21c79c61ecfb875c6faa790600">SubLabel</a> (int function) const
<li>virtual const char * <a class="el" href="class_ipelet.html#cf652cc77d7e7600c50bb833f20033cf">About</a> () const
<li>virtual void <a class="el" href="class_ipelet.html#35e69a34f6afd9b2b16f685251dce24f">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="b82f135f3b97f6b513889a74fc05ea4d"></a><!-- doxytag: member="Ipelet::~Ipelet" ref="b82f135f3b97f6b513889a74fc05ea4d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Ipelet::~Ipelet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pure virtual destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="363cafe3a47e4160fdb61700f2cbbd56"></a><!-- doxytag: member="Ipelet::IpelibVersion" ref="363cafe3a47e4160fdb61700f2cbbd56" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int Ipelet::IpelibVersion </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the version of Ipelib the <a class="el" href="class_ipelet.html">Ipelet</a> was linked against.
<p>
</div>
</div><p>
<a class="anchor" name="df3fd50fdee579ae804f870e142f005b"></a><!-- doxytag: member="Ipelet::NumFunctions" ref="df3fd50fdee579ae804f870e142f005b" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Ipelet::NumFunctions </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of functions implemented by this <a class="el" href="class_ipelet.html">Ipelet</a>.
<p>
The default implementation returns 1.
</div>
</div><p>
<a class="anchor" name="e9a662b589c911f25d944f6f46cbef31"></a><!-- doxytag: member="Ipelet::Label" ref="e9a662b589c911f25d944f6f46cbef31" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Ipelet::Label </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the label of the <a class="el" href="class_ipelet.html">Ipelet</a> (to be shown in the menu).
<p>
</div>
</div><p>
<a class="anchor" name="816edb21c79c61ecfb875c6faa790600"></a><!-- doxytag: member="Ipelet::SubLabel" ref="816edb21c79c61ecfb875c6faa790600" args="(int function) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Ipelet::SubLabel </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>function</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a label for each function implemented by this <a class="el" href="class_ipelet.html">Ipelet</a>.
<p>
This is not called if NumFunctions returns 1.
</div>
</div><p>
<a class="anchor" name="cf652cc77d7e7600c50bb833f20033cf"></a><!-- doxytag: member="Ipelet::About" ref="cf652cc77d7e7600c50bb833f20033cf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * Ipelet::About </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an 'about' or copyright notice for this ipelet.
<p>
Ipe displays this in the ipelet About box.
</div>
</div><p>
<a class="anchor" name="35e69a34f6afd9b2b16f685251dce24f"></a><!-- doxytag: member="Ipelet::Run" ref="35e69a34f6afd9b2b16f685251dce24f" args="(int function, IpePage *page, IpeletHelper *helper)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Ipelet::Run </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>function</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_ipe_page.html">IpePage</a> * </td>
<td class="paramname"> <em>page</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_ipelet_helper.html">IpeletHelper</a> * </td>
<td class="paramname"> <em>helper</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run a function from the <a class="el" href="class_ipelet.html">Ipelet</a>.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>ipelet.h<li>ipelet.cpp</ul>
<hr>
</body></html>
|
