← Back to branch summary

~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/html/GimpController.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2005-12-09 19:44:52 UTC
  • Revision ID: james.westby@ubuntu.com-20051209194452-yggpemjlofpjqyf4
Tags: upstream-2.2.9
Import upstream version 2.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/GimpController.html
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
 
4
<title>GimpController</title>
 
5
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
7
<link rel="up" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
 
8
<link rel="prev" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
 
9
<link rel="next" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
 
10
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
 
11
<link rel="stylesheet" href="style.css" type="text/css">
 
12
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
 
13
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
 
14
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
 
15
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part&#160;II.&#160;GIMP Display Filters">
 
16
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
 
17
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
 
18
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
 
19
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
 
20
</head>
 
21
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
22
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
 
23
<td><a accesskey="p" href="libgimpwidgets-controller.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="libgimpwidgets-controller.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
26
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
 
27
<td><a accesskey="n" href="libgimpwidgets-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
28
</tr></table>
 
29
<div class="refentry" lang="en">
 
30
<a name="GimpController"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle">GimpController</span></h2>
 
34
<p>GimpController &#8212; Pluggable GIMP input controller modules.</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
 
 
42
 
 
43
 
 
44
enum        <a href="GimpController.html#GimpControllerEventType">GimpControllerEventType</a>;
 
45
            <a href="GimpController.html#GimpControllerEventAny">GimpControllerEventAny</a>;
 
46
            <a href="GimpController.html#GimpControllerEventTrigger">GimpControllerEventTrigger</a>;
 
47
            <a href="GimpController.html#GimpControllerEventValue">GimpControllerEventValue</a>;
 
48
union       <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a>;
 
49
            <a href="GimpController.html#GimpController-struct">GimpController</a>;
 
50
<a href="GimpController.html" title="GimpController">GimpController</a>* <a href="GimpController.html#gimp-controller-new">gimp_controller_new</a>         (GType controller_type);
 
51
gint        <a href="GimpController.html#gimp-controller-get-n-events">gimp_controller_get_n_events</a>    (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);
 
52
const gchar* <a href="GimpController.html#gimp-controller-get-event-name">gimp_controller_get_event_name</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
53
                                             gint event_id);
 
54
const gchar* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a>
 
55
                                            (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
56
                                             gint event_id);
 
57
gboolean    <a href="GimpController.html#gimp-controller-event">gimp_controller_event</a>           (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
58
                                             const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);
 
59
 
 
60
</pre>
 
61
</div>
 
62
<div class="refsect1" lang="en">
 
63
<a name="id2581701"></a><h2>Object Hierarchy</h2>
 
64
<pre class="synopsis">
 
65
 
 
66
  GObject
 
67
   +----GimpController
 
68
</pre>
 
69
</div>
 
70
<div class="refsect1" lang="en">
 
71
<a name="id2581720"></a><h2>Properties</h2>
 
72
<pre class="synopsis">
 
73
 
 
74
  "<a href="GimpController.html#GimpController--name">name</a>"                 gchararray            : Read / Write / Construct
 
75
  "<a href="GimpController.html#GimpController--state">state</a>"                gchararray            : Read / Write / Construct
 
76
</pre>
 
77
</div>
 
78
<div class="refsect1" lang="en">
 
79
<a name="id2579879"></a><h2>Signal Prototypes</h2>
 
80
<pre class="synopsis">
 
81
 
 
82
"<a href="GimpController.html#GimpController-event">event</a>"     gboolean    user_function      (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
 
83
                                            gpointer arg1,
 
84
                                            gpointer user_data);
 
85
</pre>
 
86
</div>
 
87
<div class="refsect1" lang="en">
 
88
<a name="id2579924"></a><h2>Description</h2>
 
89
<p>
 
90
An abstract interface for implementing arbitrary input controllers.
 
91
</p>
 
92
</div>
 
93
<div class="refsect1" lang="en">
 
94
<a name="id2579937"></a><h2>Details</h2>
 
95
<div class="refsect2" lang="en">
 
96
<a name="id2579943"></a><h3>
 
97
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
 
98
<a class="indexterm" name="id2579952"></a><pre class="programlisting">typedef enum
 
99
{
 
100
  GIMP_CONTROLLER_EVENT_TRIGGER,
 
101
  GIMP_CONTROLLER_EVENT_VALUE
 
102
} GimpControllerEventType;
 
103
</pre>
 
104
<p>
 
105
 
 
106
</p>
 
107
</div>
 
108
<hr>
 
109
<div class="refsect2" lang="en">
 
110
<a name="id2579969"></a><h3>
 
111
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
 
112
<a class="indexterm" name="id2579978"></a><pre class="programlisting">typedef struct {
 
113
  GimpControllerEventType  type;
 
114
  GimpController          *source;
 
115
  gint                     event_id;
 
116
} GimpControllerEventAny;
 
117
</pre>
 
118
<p>
 
119
 
 
120
</p>
 
121
</div>
 
122
<hr>
 
123
<div class="refsect2" lang="en">
 
124
<a name="id2579995"></a><h3>
 
125
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
 
126
<a class="indexterm" name="id2580004"></a><pre class="programlisting">typedef struct {
 
127
  GimpControllerEventType  type;
 
128
  GimpController          *source;
 
129
  gint                     event_id;
 
130
} GimpControllerEventTrigger;
 
131
</pre>
 
132
<p>
 
133
 
 
134
</p>
 
135
</div>
 
136
<hr>
 
137
<div class="refsect2" lang="en">
 
138
<a name="id2581080"></a><h3>
 
139
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
 
140
<a class="indexterm" name="id2581089"></a><pre class="programlisting">typedef struct {
 
141
  GimpControllerEventType  type;
 
142
  GimpController          *source;
 
143
  gint                     event_id;
 
144
  GValue                   value;
 
145
} GimpControllerEventValue;
 
146
</pre>
 
147
<p>
 
148
 
 
149
</p>
 
150
</div>
 
151
<hr>
 
152
<div class="refsect2" lang="en">
 
153
<a name="id2581108"></a><h3>
 
154
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
 
155
<a class="indexterm" name="id2581118"></a><pre class="programlisting">union GimpControllerEvent
 
156
{
 
157
  GimpControllerEventType    type;
 
158
  GimpControllerEventAny     any;
 
159
  GimpControllerEventTrigger trigger;
 
160
  GimpControllerEventValue   value;
 
161
};
 
162
</pre>
 
163
<p>
 
164
 
 
165
</p>
 
166
</div>
 
167
<hr>
 
168
<div class="refsect2" lang="en">
 
169
<a name="id2581136"></a><h3>
 
170
<a name="GimpController-struct"></a>GimpController</h3>
 
171
<a class="indexterm" name="id2581145"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
 
172
<p>
 
173
 
 
174
</p>
 
175
</div>
 
176
<hr>
 
177
<div class="refsect2" lang="en">
 
178
<a name="id2581162"></a><h3>
 
179
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
 
180
<a class="indexterm" name="id2581172"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new         (GType controller_type);</pre>
 
181
<p>
 
182
 
 
183
</p>
 
184
<div class="variablelist"><table border="0">
 
185
<col align="left" valign="top">
 
186
<tbody>
 
187
<tr>
 
188
<td>
 
189
<span class="term"><em class="parameter"><code>controller_type</code></em>&#160;:</span></td>
 
190
<td>
 
191
</td>
 
192
</tr>
 
193
<tr>
 
194
<td>
 
195
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
196
<td>
 
197
 
 
198
 
 
199
</td>
 
200
</tr>
 
201
</tbody>
 
202
</table></div>
 
203
</div>
 
204
<hr>
 
205
<div class="refsect2" lang="en">
 
206
<a name="id2581228"></a><h3>
 
207
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
 
208
<a class="indexterm" name="id2581236"></a><pre class="programlisting">gint        gimp_controller_get_n_events    (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
 
209
<p>
 
210
 
 
211
</p>
 
212
<div class="variablelist"><table border="0">
 
213
<col align="left" valign="top">
 
214
<tbody>
 
215
<tr>
 
216
<td>
 
217
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
 
218
<td>
 
219
</td>
 
220
</tr>
 
221
<tr>
 
222
<td>
 
223
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
224
<td>
 
225
 
 
226
 
 
227
</td>
 
228
</tr>
 
229
</tbody>
 
230
</table></div>
 
231
</div>
 
232
<hr>
 
233
<div class="refsect2" lang="en">
 
234
<a name="id2581292"></a><h3>
 
235
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
 
236
<a class="indexterm" name="id2581301"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
237
                                             gint event_id);</pre>
 
238
<p>
 
239
 
 
240
</p>
 
241
<div class="variablelist"><table border="0">
 
242
<col align="left" valign="top">
 
243
<tbody>
 
244
<tr>
 
245
<td>
 
246
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
 
247
<td>
 
248
</td>
 
249
</tr>
 
250
<tr>
 
251
<td>
 
252
<span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
 
253
<td>
 
254
</td>
 
255
</tr>
 
256
<tr>
 
257
<td>
 
258
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
259
<td>
 
260
 
 
261
 
 
262
</td>
 
263
</tr>
 
264
</tbody>
 
265
</table></div>
 
266
</div>
 
267
<hr>
 
268
<div class="refsect2" lang="en">
 
269
<a name="id2582660"></a><h3>
 
270
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
 
271
<a class="indexterm" name="id2582671"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb
 
272
                                            (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
273
                                             gint event_id);</pre>
 
274
<p>
 
275
 
 
276
</p>
 
277
<div class="variablelist"><table border="0">
 
278
<col align="left" valign="top">
 
279
<tbody>
 
280
<tr>
 
281
<td>
 
282
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
 
283
<td>
 
284
</td>
 
285
</tr>
 
286
<tr>
 
287
<td>
 
288
<span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
 
289
<td>
 
290
</td>
 
291
</tr>
 
292
<tr>
 
293
<td>
 
294
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
295
<td>
 
296
 
 
297
 
 
298
</td>
 
299
</tr>
 
300
</tbody>
 
301
</table></div>
 
302
</div>
 
303
<hr>
 
304
<div class="refsect2" lang="en">
 
305
<a name="id2582751"></a><h3>
 
306
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
 
307
<a class="indexterm" name="id2582760"></a><pre class="programlisting">gboolean    gimp_controller_event           (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
308
                                             const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
 
309
<p>
 
310
 
 
311
</p>
 
312
<div class="variablelist"><table border="0">
 
313
<col align="left" valign="top">
 
314
<tbody>
 
315
<tr>
 
316
<td>
 
317
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
 
318
<td>
 
319
</td>
 
320
</tr>
 
321
<tr>
 
322
<td>
 
323
<span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></td>
 
324
<td>
 
325
</td>
 
326
</tr>
 
327
<tr>
 
328
<td>
 
329
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
330
<td>
 
331
 
 
332
 
 
333
</td>
 
334
</tr>
 
335
</tbody>
 
336
</table></div>
 
337
</div>
 
338
</div>
 
339
<div class="refsect1" lang="en">
 
340
<a name="id2582838"></a><h2>Properties</h2>
 
341
<div class="refsect2" lang="en">
 
342
<a name="id2582845"></a><h3>
 
343
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
 
344
<pre class="programlisting">  "name"                 gchararray            : Read / Write / Construct</pre>
 
345
<p></p>
 
346
<p>Default value: "Unnamed Controller"</p>
 
347
</div>
 
348
<hr>
 
349
<div class="refsect2" lang="en">
 
350
<a name="id2582877"></a><h3>
 
351
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
 
352
<pre class="programlisting">  "state"                gchararray            : Read / Write / Construct</pre>
 
353
<p></p>
 
354
<p>Default value: "Unknown"</p>
 
355
</div>
 
356
</div>
 
357
<div class="refsect1" lang="en">
 
358
<a name="id2582910"></a><h2>Signals</h2>
 
359
<div class="refsect2" lang="en">
 
360
<a name="id2582916"></a><h3>
 
361
<a name="GimpController-event"></a>The "event" signal</h3>
 
362
<pre class="programlisting">gboolean    user_function                  (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
 
363
                                            gpointer arg1,
 
364
                                            gpointer user_data);</pre>
 
365
<p>
 
366
 
 
367
</p>
 
368
<div class="variablelist"><table border="0">
 
369
<col align="left" valign="top">
 
370
<tbody>
 
371
<tr>
 
372
<td>
 
373
<span class="term"><em class="parameter"><code>gimpcontroller</code></em>&#160;:</span></td>
 
374
<td>the object which received the signal.
 
375
</td>
 
376
</tr>
 
377
<tr>
 
378
<td>
 
379
<span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
 
380
<td>
 
381
</td>
 
382
</tr>
 
383
<tr>
 
384
<td>
 
385
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
 
386
<td>user data set when the signal handler was connected.</td>
 
387
</tr>
 
388
<tr>
 
389
<td>
 
390
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
391
<td>
 
392
 
 
393
</td>
 
394
</tr>
 
395
</tbody>
 
396
</table></div>
 
397
</div>
 
398
</div>
 
399
</div>
 
400
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
 
401
<td align="left"><a accesskey="p" href="libgimpwidgets-controller.html"><b>&lt;&lt;&#160;Part&#160;IV.&#160;GIMP Controllers</b></a></td>
 
402
<td align="right"><a accesskey="n" href="libgimpwidgets-utils.html"><b>Part&#160;V.&#160;GIMP Widgets Utilities&#160;&gt;&gt;</b></a></td>
 
403
</tr></table>
 
404
</body>
 
405
</html>