← Back to branch summary

~ubuntu-branches/ubuntu/hoary/gimp/hoary

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpcontroller.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-04-04 14:51:23 UTC
  • Revision ID: james.westby@ubuntu.com-20050404145123-9py049eeelfymur8
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcontroller.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="GimpController">
 
6
<refmeta>
 
7
<refentrytitle>GimpController</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpController</refname><refpurpose>Pluggable GIMP input controller modules.</refpurpose>
 
14
</refnamediv>
 
15
 
 
16
<refsynopsisdiv><title>Synopsis</title>
 
17
 
 
18
<synopsis>
 
19
 
 
20
 
 
21
 
 
22
enum        <link linkend="GimpControllerEventType">GimpControllerEventType</link>;
 
23
struct      <link linkend="GimpControllerEventAny">GimpControllerEventAny</link>;
 
24
struct      <link linkend="GimpControllerEventTrigger">GimpControllerEventTrigger</link>;
 
25
struct      <link linkend="GimpControllerEventValue">GimpControllerEventValue</link>;
 
26
union       <link linkend="GimpControllerEvent">GimpControllerEvent</link>;
 
27
struct      <link linkend="GimpController-struct">GimpController</link>;
 
28
<link linkend="GimpController">GimpController</link>* <link linkend="gimp-controller-new">gimp_controller_new</link>         (<link linkend="GType">GType</link> controller_type);
 
29
<link linkend="gint">gint</link>        <link linkend="gimp-controller-get-n-events">gimp_controller_get_n_events</link>    (<link linkend="GimpController">GimpController</link> *controller);
 
30
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,
 
31
                                             <link linkend="gint">gint</link> event_id);
 
32
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</link>
 
33
                                            (<link linkend="GimpController">GimpController</link> *controller,
 
34
                                             <link linkend="gint">gint</link> event_id);
 
35
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-controller-event">gimp_controller_event</link>           (<link linkend="GimpController">GimpController</link> *controller,
 
36
                                             const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);
 
37
 
 
38
</synopsis>
 
39
</refsynopsisdiv>
 
40
 
 
41
<refsect1>
 
42
<title>Object Hierarchy</title>
 
43
<synopsis>
 
44
 
 
45
  <link linkend="GObject">GObject</link>
 
46
   +----GimpController
 
47
</synopsis>
 
48
 
 
49
</refsect1>
 
50
 
 
51
 
 
52
 
 
53
 
 
54
 
 
55
<refsect1>
 
56
<title>Properties</title>
 
57
<synopsis>
 
58
 
 
59
  &quot;<link linkend="GimpController--name">name</link>&quot;                 <link linkend="gchararray">gchararray</link>           : Read / Write / Construct
 
60
  &quot;<link linkend="GimpController--state">state</link>&quot;                <link linkend="gchararray">gchararray</link>           : Read / Write / Construct
 
61
</synopsis>
 
62
</refsect1>
 
63
 
 
64
<refsect1>
 
65
<title>Signal Prototypes</title>
 
66
<synopsis>
 
67
 
 
68
&quot;<link linkend="GimpController-event">event</link>&quot;     <link linkend="gboolean">gboolean</link>    user_function      (<link linkend="GimpController">GimpController</link> *gimpcontroller,
 
69
                                            <link linkend="gpointer">gpointer</link> arg1,
 
70
                                            <link linkend="gpointer">gpointer</link> user_data);
 
71
</synopsis>
 
72
</refsect1>
 
73
 
 
74
 
 
75
<refsect1>
 
76
<title>Description</title>
 
77
<para>
 
78
An abstract interface for implementing arbitrary input controllers.
 
79
</para>
 
80
</refsect1>
 
81
 
 
82
<refsect1>
 
83
<title>Details</title>
 
84
<refsect2>
 
85
<title><anchor id="GimpControllerEventType"/>enum GimpControllerEventType</title>
 
86
<indexterm><primary>GimpControllerEventType</primary></indexterm><programlisting>typedef enum
 
87
{
 
88
  GIMP_CONTROLLER_EVENT_TRIGGER,
 
89
  GIMP_CONTROLLER_EVENT_VALUE
 
90
} GimpControllerEventType;
 
91
</programlisting>
 
92
<para>
 
93
 
 
94
</para></refsect2>
 
95
<refsect2>
 
96
<title><anchor id="GimpControllerEventAny"/>struct GimpControllerEventAny</title>
 
97
<indexterm><primary>GimpControllerEventAny</primary></indexterm><programlisting>struct GimpControllerEventAny {
 
98
 
 
99
  GimpControllerEventType  type;
 
100
  GimpController          *source;
 
101
  gint                     event_id;
 
102
};
 
103
</programlisting>
 
104
<para>
 
105
 
 
106
</para></refsect2>
 
107
<refsect2>
 
108
<title><anchor id="GimpControllerEventTrigger"/>struct GimpControllerEventTrigger</title>
 
109
<indexterm><primary>GimpControllerEventTrigger</primary></indexterm><programlisting>struct GimpControllerEventTrigger {
 
110
 
 
111
  GimpControllerEventType  type;
 
112
  GimpController          *source;
 
113
  gint                     event_id;
 
114
};
 
115
</programlisting>
 
116
<para>
 
117
 
 
118
</para></refsect2>
 
119
<refsect2>
 
120
<title><anchor id="GimpControllerEventValue"/>struct GimpControllerEventValue</title>
 
121
<indexterm><primary>GimpControllerEventValue</primary></indexterm><programlisting>struct GimpControllerEventValue {
 
122
 
 
123
  GimpControllerEventType  type;
 
124
  GimpController          *source;
 
125
  gint                     event_id;
 
126
  GValue                   value;
 
127
};
 
128
</programlisting>
 
129
<para>
 
130
 
 
131
</para></refsect2>
 
132
<refsect2>
 
133
<title><anchor id="GimpControllerEvent"/>union GimpControllerEvent</title>
 
134
<indexterm><primary>GimpControllerEvent</primary></indexterm><programlisting>union GimpControllerEvent
 
135
{
 
136
  GimpControllerEventType    type;
 
137
  GimpControllerEventAny     any;
 
138
  GimpControllerEventTrigger trigger;
 
139
  GimpControllerEventValue   value;
 
140
};
 
141
</programlisting>
 
142
<para>
 
143
 
 
144
</para></refsect2>
 
145
<refsect2>
 
146
<title><anchor id="GimpController-struct"/>struct GimpController</title>
 
147
<indexterm><primary>GimpController</primary></indexterm><programlisting>struct GimpController;</programlisting>
 
148
<para>
 
149
 
 
150
</para></refsect2>
 
151
<refsect2>
 
152
<title><anchor id="gimp-controller-new"/>gimp_controller_new ()</title>
 
153
<indexterm><primary>gimp_controller_new</primary></indexterm><programlisting><link linkend="GimpController">GimpController</link>* gimp_controller_new         (<link linkend="GType">GType</link> controller_type);</programlisting>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>controller_type</parameter>&nbsp;:</term>
 
158
<listitem><simpara>
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
161
 
 
162
 
 
163
</simpara></listitem></varlistentry>
 
164
</variablelist></refsect2>
 
165
<refsect2>
 
166
<title><anchor id="gimp-controller-get-n-events"/>gimp_controller_get_n_events ()</title>
 
167
<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>
 
168
<para>
 
169
 
 
170
</para><variablelist role="params">
 
171
<varlistentry><term><parameter>controller</parameter>&nbsp;:</term>
 
172
<listitem><simpara>
 
173
</simpara></listitem></varlistentry>
 
174
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
175
 
 
176
 
 
177
</simpara></listitem></varlistentry>
 
178
</variablelist></refsect2>
 
179
<refsect2>
 
180
<title><anchor id="gimp-controller-get-event-name"/>gimp_controller_get_event_name ()</title>
 
181
<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,
 
182
                                             <link linkend="gint">gint</link> event_id);</programlisting>
 
183
<para>
 
184
 
 
185
</para><variablelist role="params">
 
186
<varlistentry><term><parameter>controller</parameter>&nbsp;:</term>
 
187
<listitem><simpara>
 
188
</simpara></listitem></varlistentry>
 
189
<varlistentry><term><parameter>event_id</parameter>&nbsp;:</term>
 
190
<listitem><simpara>
 
191
</simpara></listitem></varlistentry>
 
192
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
193
 
 
194
 
 
195
</simpara></listitem></varlistentry>
 
196
</variablelist></refsect2>
 
197
<refsect2>
 
198
<title><anchor id="gimp-controller-get-event-blurb"/>gimp_controller_get_event_blurb ()</title>
 
199
<indexterm><primary>gimp_controller_get_event_blurb</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_blurb
 
200
                                            (<link linkend="GimpController">GimpController</link> *controller,
 
201
                                             <link linkend="gint">gint</link> event_id);</programlisting>
 
202
<para>
 
203
 
 
204
</para><variablelist role="params">
 
205
<varlistentry><term><parameter>controller</parameter>&nbsp;:</term>
 
206
<listitem><simpara>
 
207
</simpara></listitem></varlistentry>
 
208
<varlistentry><term><parameter>event_id</parameter>&nbsp;:</term>
 
209
<listitem><simpara>
 
210
</simpara></listitem></varlistentry>
 
211
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
212
 
 
213
 
 
214
</simpara></listitem></varlistentry>
 
215
</variablelist></refsect2>
 
216
<refsect2>
 
217
<title><anchor id="gimp-controller-event"/>gimp_controller_event ()</title>
 
218
<indexterm><primary>gimp_controller_event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_controller_event           (<link linkend="GimpController">GimpController</link> *controller,
 
219
                                             const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);</programlisting>
 
220
<para>
 
221
 
 
222
</para><variablelist role="params">
 
223
<varlistentry><term><parameter>controller</parameter>&nbsp;:</term>
 
224
<listitem><simpara>
 
225
</simpara></listitem></varlistentry>
 
226
<varlistentry><term><parameter>event</parameter>&nbsp;:</term>
 
227
<listitem><simpara>
 
228
</simpara></listitem></varlistentry>
 
229
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
230
 
 
231
 
 
232
</simpara></listitem></varlistentry>
 
233
</variablelist></refsect2>
 
234
 
 
235
</refsect1>
 
236
<refsect1>
 
237
<title>Properties</title>
 
238
<variablelist>
 
239
<varlistentry><term><anchor id="GimpController--name"/>&quot;<literal>name</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write / Construct)</term>
 
240
<listitem>
 
241
<para></para>
 
242
</listitem></varlistentry>
 
243
<varlistentry><term><anchor id="GimpController--state"/>&quot;<literal>state</literal>&quot; (<link linkend="gchararray">gchararray</link> : Read / Write / Construct)</term>
 
244
<listitem>
 
245
<para></para>
 
246
</listitem></varlistentry>
 
247
 
 
248
</variablelist>
 
249
</refsect1>
 
250
 
 
251
<refsect1>
 
252
<title>Signals</title>
 
253
<refsect2><title><anchor id="GimpController-event"/>The &quot;event&quot; signal</title>
 
254
<programlisting><link linkend="gboolean">gboolean</link>    user_function                  (<link linkend="GimpController">GimpController</link> *gimpcontroller,
 
255
                                            <link linkend="gpointer">gpointer</link> arg1,
 
256
                                            <link linkend="gpointer">gpointer</link> user_data);</programlisting>
 
257
<para>
 
258
 
 
259
</para><variablelist role="params">
 
260
<varlistentry><term><parameter>gimpcontroller</parameter>&nbsp;:</term>
 
261
<listitem><simpara>the object which received the signal.
 
262
</simpara></listitem></varlistentry>
 
263
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
264
<listitem><simpara>
 
265
</simpara></listitem></varlistentry>
 
266
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
267
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
268
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
 
269
 
 
270
</simpara></listitem></varlistentry>
 
271
</variablelist></refsect2>
 
272
</refsect1>
 
273
 
 
274
 
 
275
 
 
276
</refentry>