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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpController">
<refmeta>
<refentrytitle id="top_of_page">GimpController</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpController</refname>
<refpurpose>Pluggable GIMP input controller modules.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="GimpControllerEventType">GimpControllerEventType</link>;
<link linkend="GimpControllerEventAny">GimpControllerEventAny</link>;
<link linkend="GimpControllerEventTrigger">GimpControllerEventTrigger</link>;
<link linkend="GimpControllerEventValue">GimpControllerEventValue</link>;
union <link linkend="GimpControllerEvent">GimpControllerEvent</link>;
<link linkend="GimpController-struct">GimpController</link>;
<link linkend="GimpController">GimpController</link>* <link linkend="gimp-controller-new">gimp_controller_new</link> (<link linkend="GType">GType</link> controller_type);
<link linkend="gint">gint</link> <link linkend="gimp-controller-get-n-events">gimp_controller_get_n_events</link> (<link linkend="GimpController">GimpController</link> *controller);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-name">gimp_controller_get_event_name</link> (<link linkend="GimpController">GimpController</link> *controller,
<link linkend="gint">gint</link> event_id);
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</link>
(<link linkend="GimpController">GimpController</link> *controller,
<link linkend="gint">gint</link> event_id);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-controller-event">gimp_controller_event</link> (<link linkend="GimpController">GimpController</link> *controller,
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);
</synopsis>
</refsynopsisdiv>
<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----GimpController
</synopsis>
</refsect1>
<refsect1 id="properties">
<title id="properties.title">Properties</title>
<synopsis>
"<link linkend="GimpController--name">name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
"<link linkend="GimpController--state">state</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="signal_proto">
<title id="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GimpController-event">event</link>" <link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run last
</synopsis>
</refsect1>
<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
An abstract interface for implementing arbitrary input controllers.
</para>
</refsect1>
<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpControllerEventType" role="enum"/>enum GimpControllerEventType</title>
<indexterm><primary>GimpControllerEventType</primary></indexterm><programlisting>typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
} GimpControllerEventType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpControllerEventAny" role="struct"/>GimpControllerEventAny</title>
<indexterm><primary>GimpControllerEventAny</primary></indexterm><programlisting>typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
} GimpControllerEventAny;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpControllerEventTrigger" role="struct"/>GimpControllerEventTrigger</title>
<indexterm><primary>GimpControllerEventTrigger</primary></indexterm><programlisting>typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
} GimpControllerEventTrigger;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpControllerEventValue" role="struct"/>GimpControllerEventValue</title>
<indexterm><primary>GimpControllerEventValue</primary></indexterm><programlisting>typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
GValue value;
} GimpControllerEventValue;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpControllerEvent" role="union"/>union GimpControllerEvent</title>
<indexterm><primary>GimpControllerEvent</primary></indexterm><programlisting>union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
GimpControllerEventTrigger trigger;
GimpControllerEventValue value;
};
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpController-struct" role="struct"/>GimpController</title>
<indexterm><primary>GimpController</primary></indexterm><programlisting>typedef struct _GimpController GimpController;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-controller-new" role="function"/>gimp_controller_new ()</title>
<indexterm><primary>gimp_controller_new</primary></indexterm><programlisting><link linkend="GimpController">GimpController</link>* gimp_controller_new (<link linkend="GType">GType</link> controller_type);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>controller_type</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-controller-get-n-events" role="function"/>gimp_controller_get_n_events ()</title>
<indexterm><primary>gimp_controller_get_n_events</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_controller_get_n_events (<link linkend="GimpController">GimpController</link> *controller);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>controller</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-controller-get-event-name" role="function"/>gimp_controller_get_event_name ()</title>
<indexterm><primary>gimp_controller_get_event_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_name (<link linkend="GimpController">GimpController</link> *controller,
<link linkend="gint">gint</link> event_id);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>controller</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event_id</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-controller-get-event-blurb" role="function"/>gimp_controller_get_event_blurb ()</title>
<indexterm><primary>gimp_controller_get_event_blurb</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_blurb
(<link linkend="GimpController">GimpController</link> *controller,
<link linkend="gint">gint</link> event_id);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>controller</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event_id</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-controller-event" role="function"/>gimp_controller_event ()</title>
<indexterm><primary>gimp_controller_event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_controller_event (<link linkend="GimpController">GimpController</link> *controller,
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>controller</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>event</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="property_details">
<title id="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpController--name"/>The "<literal>name</literal>" property</title>
<indexterm><primary>GimpController:name</primary></indexterm><programlisting> "name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para></para><para>Default value: "Unnamed Controller"</para>
</refsect2>
<refsect2><title><anchor id="GimpController--state"/>The "<literal>state</literal>" property</title>
<indexterm><primary>GimpController:state</primary></indexterm><programlisting> "state" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
<para></para><para>Default value: "Unknown"</para>
</refsect2>
</refsect1>
<refsect1 id="signals">
<title id="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpController-event"/>The "event" signal</title>
<indexterm><primary>GimpController::event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
<link linkend="gpointer">gpointer</link> arg1,
<link linkend="gpointer">gpointer</link> user_data) : Run last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpcontroller</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
