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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>GimpController</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual"><link rel="up" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="prev" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="next" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><meta name="generator" content="GTK-Doc V1.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="libgimpwidgets-widgets.html" title="PartI.GIMP Widgets"><link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy"><link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView"><link rel="part" href="libgimpwidgets-colordisplay.html" title="PartII.GIMP Display Filters"><link rel="part" href="libgimpwidgets-colorselector.html" title="PartIII.GIMP Color Selectors"><link rel="part" href="libgimpwidgets-controller.html" title="PartIV.GIMP Controllers"><link rel="part" href="libgimpwidgets-utils.html" title="PartV.GIMP Widgets Utilities"><link rel="part" href="libgimpwidgets-deprecated.html" title="PartVI.Deprecated API"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimpwidgets-controller.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpwidgets-controller.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Widgets Library Reference Manual</th><td><a accesskey="n" href="libgimpwidgets-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="GimpController"></a><div class="titlepage"></div><div class="refnamediv"><table width="100%"><tr><td valign="top"><h2><span class="refentrytitle">GimpController</span></h2><p>GimpController — Pluggable GIMP input controller modules.</p></td><td valign="top" align="right"></td></tr></table></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
enum <a href="GimpController.html#GimpControllerEventType">GimpControllerEventType</a>;
<a href="GimpController.html#GimpControllerEventAny">GimpControllerEventAny</a>;
<a href="GimpController.html#GimpControllerEventTrigger">GimpControllerEventTrigger</a>;
<a href="GimpController.html#GimpControllerEventValue">GimpControllerEventValue</a>;
union <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a>;
<a href="GimpController.html#GimpController-struct">GimpController</a>;
<a href="GimpController.html" title="GimpController">GimpController</a>* <a href="GimpController.html#gimp-controller-new">gimp_controller_new</a> (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> controller_type);
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> <a href="GimpController.html#gimp-controller-get-n-events">gimp_controller_get_n_events</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GimpController.html#gimp-controller-get-event-name">gimp_controller_get_event_name</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a>
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GimpController.html#gimp-controller-event">gimp_controller_event</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);
</pre></div><div class="refsect1" lang="en"><a name="id2599306"></a><h2>Object Hierarchy</h2><pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GimpController
</pre></div><div class="refsect1" lang="en"><a name="id2599321"></a><h2>Properties</h2><pre class="synopsis">
"<a href="GimpController.html#GimpController--name">name</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
"<a href="GimpController.html#GimpController--state">state</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
</pre></div><div class="refsect1" lang="en"><a name="id2602406"></a><h2>Signal Prototypes</h2><pre class="synopsis">
"<a href="GimpController.html#GimpController-event">event</a>" <a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
</pre></div><div class="refsect1" lang="en"><a name="id2602444"></a><h2>Description</h2><p>
An abstract interface for implementing arbitrary input controllers.
</p></div><div class="refsect1" lang="en"><a name="id2602455"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2602460"></a><h3><a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3><a class="indexterm" name="id2602468"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
} GimpControllerEventType;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2602480"></a><h3><a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3><a class="indexterm" name="id2602488"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
} GimpControllerEventAny;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2602501"></a><h3><a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3><a class="indexterm" name="id2602509"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
} GimpControllerEventTrigger;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2602521"></a><h3><a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3><a class="indexterm" name="id2595009"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
GValue value;
} GimpControllerEventValue;
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2595022"></a><h3><a name="GimpControllerEvent"></a>union GimpControllerEvent</h3><a class="indexterm" name="id2595030"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
GimpControllerEventTrigger trigger;
GimpControllerEventValue value;
};
</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2595043"></a><h3><a name="GimpController-struct"></a>GimpController</h3><a class="indexterm" name="id2595051"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre><p>
</p></div><hr><div class="refsect2" lang="en"><a name="id2595062"></a><h3><a name="gimp-controller-new"></a>gimp_controller_new ()</h3><a class="indexterm" name="id2595070"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> controller_type);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>controller_type</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2595113"></a><h3><a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3><a class="indexterm" name="id2595122"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>controller</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2603290"></a><h3><a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3><a class="indexterm" name="id2603301"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>controller</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>event_id</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2603363"></a><h3><a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3><a class="indexterm" name="id2603374"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_controller_get_event_blurb
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>controller</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>event_id</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2603438"></a><h3><a name="gimp-controller-event"></a>gimp_controller_event ()</h3><a class="indexterm" name="id2603446"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>controller</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>event</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2603508"></a><h2>Properties</h2><div class="refsect2" lang="en"><a name="id2603513"></a><h3><a name="GimpController--name"></a>The "<tt class="literal">name</tt>" property</h3><pre class="programlisting"> "name" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre><p></p><p>Default value: "Unnamed Controller"</p></div><hr><div class="refsect2" lang="en"><a name="id2601430"></a><h3><a name="GimpController--state"></a>The "<tt class="literal">state</tt>" property</h3><pre class="programlisting"> "state" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre><p></p><p>Default value: "Unknown"</p></div></div><div class="refsect1" lang="en"><a name="id2601456"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="id2601461"></a><h3><a name="GimpController-event"></a>The "event" signal</h3><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> arg1,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>gimpcontroller</tt></i>:</span></td><td>the object which received the signal.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>arg1</tt></i>:</span></td><td>
</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_data</tt></i>:</span></td><td>user data set when the signal handler was connected.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpwidgets-controller.html"><b><<PartIV.GIMP Controllers</b></a></td><td align="right"><a accesskey="n" href="libgimpwidgets-utils.html"><b>PartV.GIMP Widgets Utilities>></b></a></td></tr></table></body></html>
|
