4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>GimpController</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" 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.6 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.8 (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">
15
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
15
16
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
16
17
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
17
18
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
18
19
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
19
20
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
20
21
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
22
<link rel="index" href="libgimpwidgets-index.html" title="Index">
23
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
24
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
25
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
22
27
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
28
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
33
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
29
34
<td><a accesskey="n" href="libgimpwidgets-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
31
<tr><td colspan="5" class="shortcuts"><nobr><a href="#top_of_page" class="shortcut">Top</a>
33
<a href="#desc" class="shortcut">Description</a>
35
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
37
<a href="#properties" class="shortcut">Properties</a>
39
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
36
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2580514" class="shortcut">Top</a>
38
<a href="#id2639271" class="shortcut">Description</a>
40
<a href="#id2639160" class="shortcut">Object Hierarchy</a>
42
<a href="#id2639184" class="shortcut">Implemented Interfaces</a>
44
<a href="#id2639205" class="shortcut">Properties</a>
46
<a href="#id2639246" class="shortcut">Signals</a></nobr></td></tr>
41
48
<div class="refentry" lang="en">
42
49
<a name="GimpController"></a><div class="titlepage"></div>
43
50
<div class="refnamediv"><table width="100%"><tr>
45
<h2><span class="refentrytitle"><a name="top_of_page"></a>GimpController</span></h2>
53
<a name="id2580514"></a><span class="refentrytitle">GimpController</span>
46
55
<p>GimpController — Pluggable GIMP input controller modules.</p>
48
57
<td valign="top" align="right"></td>
49
58
</tr></table></div>
50
59
<div class="refsynopsisdiv">
51
<a name="synopsis"></a><h2>Synopsis</h2>
52
61
<pre class="synopsis">
56
enum <a href="GimpController.html#GimpControllerEventType">GimpControllerEventType</a>;
57
<a href="GimpController.html#GimpControllerEventAny">GimpControllerEventAny</a>;
58
<a href="GimpController.html#GimpControllerEventTrigger">GimpControllerEventTrigger</a>;
59
<a href="GimpController.html#GimpControllerEventValue">GimpControllerEventValue</a>;
60
union <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a>;
61
<a href="GimpController.html#GimpController-struct">GimpController</a>;
62
<a href="GimpController.html" title="GimpController">GimpController</a>* <a href="GimpController.html#gimp-controller-new">gimp_controller_new</a> (GType controller_type);
63
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);
64
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,
66
const gchar* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a>
67
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
69
gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_event</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
70
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);
65
enum <a href="GimpController.html#GimpControllerEventType">GimpControllerEventType</a>;
66
<a href="GimpController.html#GimpControllerEventAny">GimpControllerEventAny</a>;
67
<a href="GimpController.html#GimpControllerEventTrigger">GimpControllerEventTrigger</a>;
68
<a href="GimpController.html#GimpControllerEventValue">GimpControllerEventValue</a>;
69
union <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a>;
70
<a href="GimpController.html#GimpController-struct">GimpController</a>;
71
<a href="GimpController.html" title="GimpController">GimpController</a>* <a href="GimpController.html#gimp-controller-new">gimp_controller_new</a> (GType controller_type);
72
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);
73
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,
75
const gchar* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
77
gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_event</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
78
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);
74
82
<div class="refsect1" lang="en">
75
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
83
<a name="id2639160"></a><h2>Object Hierarchy</h2>
76
84
<pre class="synopsis">
82
90
<div class="refsect1" lang="en">
83
<a name="properties"></a><h2>Properties</h2>
84
<pre class="synopsis">
86
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
87
"<a href="GimpController.html#GimpController--state">state</a>" gchararray : Read / Write / Construct
90
<div class="refsect1" lang="en">
91
<a name="signal_proto"></a><h2>Signals</h2>
92
<pre class="synopsis">
94
"<a href="GimpController.html#GimpController-event">event</a>" gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
96
gpointer user_data) : Run last
99
<div class="refsect1" lang="en">
100
<a name="desc"></a><h2>Description</h2>
91
<a name="id2639184"></a><h2>Implemented Interfaces</h2>
93
GimpController implements
95
href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
96
>GimpConfigInterface</a>.</p>
98
<div class="refsect1" lang="en">
99
<a name="id2639205"></a><h2>Properties</h2>
100
<pre class="synopsis">
102
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
103
"<a href="GimpController.html#GimpController--state">state</a>" gchararray : Read / Write / Construct
106
<div class="refsect1" lang="en">
107
<a name="id2639246"></a><h2>Signals</h2>
108
<pre class="synopsis">
110
"<a href="GimpController.html#GimpController-event">event</a>" : Run Last
113
<div class="refsect1" lang="en">
114
<a name="id2639271"></a><h2>Description</h2>
102
116
An abstract interface for implementing arbitrary input controllers.
105
119
<div class="refsect1" lang="en">
106
<a name="details"></a><h2>Details</h2>
120
<a name="id2639288"></a><h2>Details</h2>
107
121
<div class="refsect2" lang="en">
108
<a name="id2592344"></a><h3>
122
<a name="id2639299"></a><h3>
109
123
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
110
<a class="indexterm" name="id2592356"></a><pre class="programlisting">typedef enum
124
<a class="indexterm" name="id2639310"></a><pre class="programlisting">typedef enum
112
126
GIMP_CONTROLLER_EVENT_TRIGGER,
113
127
GIMP_CONTROLLER_EVENT_VALUE
180
194
<div class="refsect2" lang="en">
181
<a name="id2592490"></a><h3>
195
<a name="id2640841"></a><h3>
182
196
<a name="GimpController-struct"></a>GimpController</h3>
183
<a class="indexterm" name="id2588644"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
197
<a class="indexterm" name="id2640852"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
189
203
<div class="refsect2" lang="en">
190
<a name="id2588660"></a><h3>
204
<a name="id2640869"></a><h3>
191
205
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
192
<a class="indexterm" name="id2588672"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
206
<a class="indexterm" name="id2640881"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
316
319
<div class="refsect2" lang="en">
317
<a name="id2588976"></a><h3>
320
<a name="id2642097"></a><h3>
318
321
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
319
<a class="indexterm" name="id2588987"></a><pre class="programlisting">gboolean gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
320
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
322
<a class="indexterm" name="id2642108"></a><pre class="programlisting">gboolean gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
323
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
351
351
<div class="refsect1" lang="en">
352
<a name="property_details"></a><h2>Property Details</h2>
352
<a name="id2642188"></a><h2>Property Details</h2>
353
353
<div class="refsect2" lang="en">
354
<a name="id2589077"></a><h3>
354
<a name="id2642198"></a><h3>
355
355
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
356
<a class="indexterm" name="id2589091"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
356
<a class="indexterm" name="id2642212"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
358
358
<p>Default value: "Unnamed Controller"</p>
361
361
<div class="refsect2" lang="en">
362
<a name="id2589116"></a><h3>
362
<a name="id2642236"></a><h3>
363
363
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
364
<a class="indexterm" name="id2589130"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
364
<a class="indexterm" name="id2642250"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
366
366
<p>Default value: "Unknown"</p>
369
369
<div class="refsect1" lang="en">
370
<a name="signals"></a><h2>Signal Details</h2>
370
<a name="id2642274"></a><h2>Signal Details</h2>
371
371
<div class="refsect2" lang="en">
372
<a name="id2589166"></a><h3>
372
<a name="id2642285"></a><h3>
373
373
<a name="GimpController-event"></a>The "event" signal</h3>
374
<a class="indexterm" name="id2589174"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
376
gpointer user_data) : Run last</pre>
374
<a class="indexterm" name="id2642293"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
376
gpointer user_data) : Run Last</pre>
381
381
<col align="left" valign="top">
385
<span class="term"><em class="parameter"><code>gimpcontroller</code></em> :</span></td>
384
<td><span class="term"><em class="parameter"><code>gimpcontroller</code></em> :</span></td>
386
385
<td>the object which received the signal.
391
<span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
389
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
397
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
394
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
398
395
<td>user data set when the signal handler was connected.</td>
402
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
398
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>