← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/html/GimpController.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>GimpController</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual">
8
8
<link rel="up" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
9
9
<link rel="prev" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
10
10
<link rel="next" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
14
14
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
34
34
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
35
35
<td><a accesskey="n" href="libgimpwidgets-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
36
36
</tr>
37
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#GimpController.synopsis" class="shortcut">Top</a>
38
 
                   | 
39
 
                  <a href="#GimpController.description" class="shortcut">Description</a>
40
 
                   | 
41
 
                  <a href="#GimpController.object-hierarchy" class="shortcut">Object Hierarchy</a>
42
 
                   | 
43
 
                  <a href="#GimpController.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
44
 
                   | 
45
 
                  <a href="#GimpController.properties" class="shortcut">Properties</a>
46
 
                   | 
47
 
                  <a href="#GimpController.signals" class="shortcut">Signals</a></nobr></td></tr>
 
37
<tr><td colspan="5" class="shortcuts">
 
38
<a href="#GimpController.synopsis" class="shortcut">Top</a>
 
39
                 | 
 
40
                <a href="#GimpController.description" class="shortcut">Description</a>
 
41
                 | 
 
42
                <a href="#GimpController.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
43
                 | 
 
44
                <a href="#GimpController.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
45
                 | 
 
46
                <a href="#GimpController.properties" class="shortcut">Properties</a>
 
47
                 | 
 
48
                <a href="#GimpController.signals" class="shortcut">Signals</a>
 
49
</td></tr>
48
50
</table>
49
 
<div class="refentry" lang="en">
 
51
<div class="refentry" title="GimpController">
50
52
<a name="GimpController"></a><div class="titlepage"></div>
51
53
<div class="refnamediv"><table width="100%"><tr>
52
54
<td valign="top">
55
57
</td>
56
58
<td valign="top" align="right"></td>
57
59
</tr></table></div>
58
 
<div class="refsynopsisdiv">
 
60
<div class="refsynopsisdiv" title="Synopsis">
59
61
<a name="GimpController.synopsis"></a><h2>Synopsis</h2>
60
62
<pre class="synopsis">
61
63
enum                <a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType">GimpControllerEventType</a>;
64
66
                    <a class="link" href="GimpController.html#GimpControllerEventValue" title="GimpControllerEventValue">GimpControllerEventValue</a>;
65
67
union               <a class="link" href="GimpController.html#GimpControllerEvent" title="union GimpControllerEvent">GimpControllerEvent</a>;
66
68
                    <a class="link" href="GimpController.html#GimpController-struct" title="GimpController">GimpController</a>;
67
 
<a class="link" href="GimpController.html" title="GimpController">GimpController</a>*     <a class="link" href="GimpController.html#gimp-controller-new" title="gimp_controller_new ()">gimp_controller_new</a>                 (<a
 
69
<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *    <a class="link" href="GimpController.html#gimp-controller-new" title="gimp_controller_new ()">gimp_controller_new</a>                 (<a
68
70
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
69
71
>GType</a> controller_type);
70
72
<a
72
74
>gint</a>                <a class="link" href="GimpController.html#gimp-controller-get-n-events" title="gimp_controller_get_n_events ()">gimp_controller_get_n_events</a>        (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller);
73
75
const <a
74
76
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
75
 
>gchar</a>*        <a class="link" href="GimpController.html#gimp-controller-get-event-name" title="gimp_controller_get_event_name ()">gimp_controller_get_event_name</a>      (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
77
>gchar</a> *       <a class="link" href="GimpController.html#gimp-controller-get-event-name" title="gimp_controller_get_event_name ()">gimp_controller_get_event_name</a>      (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
76
78
                                                         <a
77
79
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
78
80
>gint</a> event_id);
79
81
const <a
80
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
81
 
>gchar</a>*        <a class="link" href="GimpController.html#gimp-controller-get-event-blurb" title="gimp_controller_get_event_blurb ()">gimp_controller_get_event_blurb</a>     (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
83
>gchar</a> *       <a class="link" href="GimpController.html#gimp-controller-get-event-blurb" title="gimp_controller_get_event_blurb ()">gimp_controller_get_event_blurb</a>     (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
82
84
                                                         <a
83
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
84
86
>gint</a> event_id);
88
90
                                                         const <a class="link" href="GimpController.html#GimpControllerEvent" title="union GimpControllerEvent">GimpControllerEvent</a> *event);
89
91
</pre>
90
92
</div>
91
 
<div class="refsect1" lang="en">
 
93
<div class="refsect1" title="Object Hierarchy">
92
94
<a name="GimpController.object-hierarchy"></a><h2>Object Hierarchy</h2>
93
95
<pre class="synopsis">
94
96
  <a
97
99
   +----GimpController
98
100
</pre>
99
101
</div>
100
 
<div class="refsect1" lang="en">
 
102
<div class="refsect1" title="Implemented Interfaces">
101
103
<a name="GimpController.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
102
104
<p>
103
105
GimpController implements
105
107
href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
106
108
>GimpConfigInterface</a>.</p>
107
109
</div>
108
 
<div class="refsect1" lang="en">
 
110
<div class="refsect1" title="Properties">
109
111
<a name="GimpController.properties"></a><h2>Properties</h2>
110
112
<pre class="synopsis">
111
113
  "<a class="link" href="GimpController.html#GimpController--name" title='The "name" property'>name</a>"                     <a
116
118
>gchar</a>*                : Read / Write / Construct
117
119
</pre>
118
120
</div>
119
 
<div class="refsect1" lang="en">
 
121
<div class="refsect1" title="Signals">
120
122
<a name="GimpController.signals"></a><h2>Signals</h2>
121
123
<pre class="synopsis">
122
124
  "<a class="link" href="GimpController.html#GimpController-event" title='The "event" signal'>event</a>"                                          : Run Last
123
125
</pre>
124
126
</div>
125
 
<div class="refsect1" lang="en">
 
127
<div class="refsect1" title="Description">
126
128
<a name="GimpController.description"></a><h2>Description</h2>
127
129
<p>
128
130
An abstract interface for implementing arbitrary input controllers.
129
131
</p>
130
132
</div>
131
 
<div class="refsect1" lang="en">
 
133
<div class="refsect1" title="Details">
132
134
<a name="GimpController.details"></a><h2>Details</h2>
133
 
<div class="refsect2" lang="en">
 
135
<div class="refsect2" title="enum GimpControllerEventType">
134
136
<a name="GimpControllerEventType"></a><h3>enum GimpControllerEventType</h3>
135
137
<pre class="programlisting">typedef enum
136
138
{
139
141
} GimpControllerEventType;
140
142
</pre>
141
143
<p>
142
 
 
143
144
</p>
144
145
</div>
145
146
<hr>
146
 
<div class="refsect2" lang="en">
 
147
<div class="refsect2" title="GimpControllerEventAny">
147
148
<a name="GimpControllerEventAny"></a><h3>GimpControllerEventAny</h3>
148
149
<pre class="programlisting">typedef struct {
149
150
  GimpControllerEventType  type;
152
153
} GimpControllerEventAny;
153
154
</pre>
154
155
<p>
155
 
 
156
156
</p>
157
157
</div>
158
158
<hr>
159
 
<div class="refsect2" lang="en">
 
159
<div class="refsect2" title="GimpControllerEventTrigger">
160
160
<a name="GimpControllerEventTrigger"></a><h3>GimpControllerEventTrigger</h3>
161
161
<pre class="programlisting">typedef struct {
162
162
  GimpControllerEventType  type;
165
165
} GimpControllerEventTrigger;
166
166
</pre>
167
167
<p>
168
 
 
169
168
</p>
170
169
</div>
171
170
<hr>
172
 
<div class="refsect2" lang="en">
 
171
<div class="refsect2" title="GimpControllerEventValue">
173
172
<a name="GimpControllerEventValue"></a><h3>GimpControllerEventValue</h3>
174
173
<pre class="programlisting">typedef struct {
175
174
  GimpControllerEventType  type;
179
178
} GimpControllerEventValue;
180
179
</pre>
181
180
<p>
182
 
 
183
181
</p>
184
182
</div>
185
183
<hr>
186
 
<div class="refsect2" lang="en">
 
184
<div class="refsect2" title="union GimpControllerEvent">
187
185
<a name="GimpControllerEvent"></a><h3>union GimpControllerEvent</h3>
188
186
<pre class="programlisting">union GimpControllerEvent
189
187
{
194
192
};
195
193
</pre>
196
194
<p>
197
 
 
198
195
</p>
199
196
</div>
200
197
<hr>
201
 
<div class="refsect2" lang="en">
 
198
<div class="refsect2" title="GimpController">
202
199
<a name="GimpController-struct"></a><h3>GimpController</h3>
203
200
<pre class="programlisting">typedef struct _GimpController GimpController;</pre>
204
201
<p>
205
 
 
206
202
</p>
207
203
</div>
208
204
<hr>
209
 
<div class="refsect2" lang="en">
 
205
<div class="refsect2" title="gimp_controller_new ()">
210
206
<a name="gimp-controller-new"></a><h3>gimp_controller_new ()</h3>
211
 
<pre class="programlisting"><a class="link" href="GimpController.html" title="GimpController">GimpController</a>*     gimp_controller_new                 (<a
 
207
<pre class="programlisting"><a class="link" href="GimpController.html" title="GimpController">GimpController</a> *    gimp_controller_new                 (<a
212
208
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
213
209
>GType</a> controller_type);</pre>
214
210
<p>
215
 
 
216
211
</p>
217
212
<div class="variablelist"><table border="0">
218
213
<col align="left" valign="top">
225
220
<tr>
226
221
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
227
222
<td>
228
 
 
229
 
 
230
223
</td>
231
224
</tr>
232
225
</tbody>
233
226
</table></div>
234
227
</div>
235
228
<hr>
236
 
<div class="refsect2" lang="en">
 
229
<div class="refsect2" title="gimp_controller_get_n_events ()">
237
230
<a name="gimp-controller-get-n-events"></a><h3>gimp_controller_get_n_events ()</h3>
238
231
<pre class="programlisting"><a
239
232
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
240
233
>gint</a>                gimp_controller_get_n_events        (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
241
234
<p>
242
 
 
243
235
</p>
244
236
<div class="variablelist"><table border="0">
245
237
<col align="left" valign="top">
252
244
<tr>
253
245
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
254
246
<td>
255
 
 
256
 
 
257
247
</td>
258
248
</tr>
259
249
</tbody>
260
250
</table></div>
261
251
</div>
262
252
<hr>
263
 
<div class="refsect2" lang="en">
 
253
<div class="refsect2" title="gimp_controller_get_event_name ()">
264
254
<a name="gimp-controller-get-event-name"></a><h3>gimp_controller_get_event_name ()</h3>
265
255
<pre class="programlisting">const <a
266
256
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
267
 
>gchar</a>*        gimp_controller_get_event_name      (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
257
>gchar</a> *       gimp_controller_get_event_name      (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
268
258
                                                         <a
269
259
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
270
260
>gint</a> event_id);</pre>
271
261
<p>
272
 
 
273
262
</p>
274
263
<div class="variablelist"><table border="0">
275
264
<col align="left" valign="top">
287
276
<tr>
288
277
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
289
278
<td>
290
 
 
291
 
 
292
279
</td>
293
280
</tr>
294
281
</tbody>
295
282
</table></div>
296
283
</div>
297
284
<hr>
298
 
<div class="refsect2" lang="en">
 
285
<div class="refsect2" title="gimp_controller_get_event_blurb ()">
299
286
<a name="gimp-controller-get-event-blurb"></a><h3>gimp_controller_get_event_blurb ()</h3>
300
287
<pre class="programlisting">const <a
301
288
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
302
 
>gchar</a>*        gimp_controller_get_event_blurb     (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
 
289
>gchar</a> *       gimp_controller_get_event_blurb     (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
303
290
                                                         <a
304
291
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
305
292
>gint</a> event_id);</pre>
306
293
<p>
307
 
 
308
294
</p>
309
295
<div class="variablelist"><table border="0">
310
296
<col align="left" valign="top">
322
308
<tr>
323
309
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
324
310
<td>
325
 
 
326
 
 
327
311
</td>
328
312
</tr>
329
313
</tbody>
330
314
</table></div>
331
315
</div>
332
316
<hr>
333
 
<div class="refsect2" lang="en">
 
317
<div class="refsect2" title="gimp_controller_event ()">
334
318
<a name="gimp-controller-event"></a><h3>gimp_controller_event ()</h3>
335
319
<pre class="programlisting"><a
336
320
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
337
321
>gboolean</a>            gimp_controller_event               (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
338
322
                                                         const <a class="link" href="GimpController.html#GimpControllerEvent" title="union GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
339
323
<p>
340
 
 
341
324
</p>
342
325
<div class="variablelist"><table border="0">
343
326
<col align="left" valign="top">
355
338
<tr>
356
339
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
357
340
<td>
358
 
 
359
 
 
360
341
</td>
361
342
</tr>
362
343
</tbody>
363
344
</table></div>
364
345
</div>
365
346
</div>
366
 
<div class="refsect1" lang="en">
 
347
<div class="refsect1" title="Property Details">
367
348
<a name="GimpController.property-details"></a><h2>Property Details</h2>
368
 
<div class="refsect2" lang="en">
 
349
<div class="refsect2" title='The "name" property'>
369
350
<a name="GimpController--name"></a><h3>The <code class="literal">"name"</code> property</h3>
370
351
<pre class="programlisting">  "name"                     <a
371
352
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
374
355
<p>Default value: "Unnamed Controller"</p>
375
356
</div>
376
357
<hr>
377
 
<div class="refsect2" lang="en">
 
358
<div class="refsect2" title='The "state" property'>
378
359
<a name="GimpController--state"></a><h3>The <code class="literal">"state"</code> property</h3>
379
360
<pre class="programlisting">  "state"                    <a
380
361
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
383
364
<p>Default value: "Unknown"</p>
384
365
</div>
385
366
</div>
386
 
<div class="refsect1" lang="en">
 
367
<div class="refsect1" title="Signal Details">
387
368
<a name="GimpController.signal-details"></a><h2>Signal Details</h2>
388
 
<div class="refsect2" lang="en">
 
369
<div class="refsect2" title='The "event" signal'>
389
370
<a name="GimpController-event"></a><h3>The <code class="literal">"event"</code> signal</h3>
390
371
<pre class="programlisting"><a
391
372
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
397
378
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
398
379
>gpointer</a>        user_data)           : Run Last</pre>
399
380
<p>
400
 
 
401
381
</p>
402
382
<div class="variablelist"><table border="0">
403
383
<col align="left" valign="top">
419
399
<tr>
420
400
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
421
401
<td>
422
 
 
423
402
</td>
424
403
</tr>
425
404
</tbody>
429
408
</div>
430
409
<div class="footer">
431
410
<hr>
432
 
          Generated by GTK-Doc V1.10</div>
 
411
          Generated by GTK-Doc V1.11</div>
433
412
</body>
434
413
</html>