callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.4.0~rc2

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
devel-docs/libgimpwidgets/html/GimpController.html
View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpController</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="prev" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
@ -33,24 +33,24 @@
<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>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2581265" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2612495" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2644486" class="shortcut">Description</a>
<a href="#id2664985" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2644376" class="shortcut">Object Hierarchy</a>
<a href="#id2664875" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2644400" class="shortcut">Implemented Interfaces</a>
<a href="#id2664898" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2644421" class="shortcut">Properties</a>
<a href="#id2664920" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2644462" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2664960" class="shortcut">Signals</a></nobr></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>
<a name="id2581265"></a><span class="refentrytitle">GimpController</span>
<a name="id2612495"></a><span class="refentrytitle">GimpController</span>
</h2>
<p>GimpController &#8212; Pluggable GIMP input controller modules.</p>
</td>
@ -62,49 +62,33 @@
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);
enum <a class="link" href="GimpController.html#GimpControllerEventType">GimpControllerEventType</a>;
<a class="link" href="GimpController.html#GimpControllerEventAny">GimpControllerEventAny</a>;
<a class="link" href="GimpController.html#GimpControllerEventTrigger">GimpControllerEventTrigger</a>;
<a class="link" href="GimpController.html#GimpControllerEventValue">GimpControllerEventValue</a>;
union <a class="link" href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a>;
<a class="link" href="GimpController.html#GimpController-struct">GimpController</a>;
<a class="link" href="GimpController.html" title="GimpController">GimpController</a>* <a class="link" href="GimpController.html#gimp-controller-new">gimp_controller_new</a> (GType controller_type);
gint <a class="link" href="GimpController.html#gimp-controller-get-n-events">gimp_controller_get_n_events</a> (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller);
const gchar* <a class="link" href="GimpController.html#gimp-controller-get-event-name">gimp_controller_get_event_name</a> (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
const gchar* <a class="link" href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a> (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
gboolean <a class="link" href="GimpController.html#gimp-controller-event">gimp_controller_event</a> (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
const <a class="link" href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2644376"></a><h2>Object Hierarchy</h2>
<a name="id2664875"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
GObject
+----GimpController
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2644400"></a><h2>Implemented Interfaces</h2>
<a name="id2664898"></a><h2>Implemented Interfaces</h2>
<p>
GimpController implements
<a
@ -112,36 +96,32 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
>GimpConfigInterface</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2644421"></a><h2>Properties</h2>
<a name="id2664920"></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
"<a class="link" href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
"<a class="link" href="GimpController.html#GimpController--state">state</a>" gchararray : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2644462"></a><h2>Signals</h2>
<a name="id2664960"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpController.html#GimpController-event">event</a>" : Run Last
"<a class="link" href="GimpController.html#GimpController-event">event</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2644486"></a><h2>Description</h2>
<a name="id2664985"></a><h2>Description</h2>
<p>
An abstract interface for implementing arbitrary input controllers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2644503"></a><h2>Details</h2>
<a name="id2665002"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2644514"></a><h3>
<a name="id2665013"></a><h3>
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
<a class="indexterm" name="id2644525"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2665024"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
@ -153,9 +133,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645770"></a><h3>
<a name="id2665041"></a><h3>
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
<a class="indexterm" name="id2645781"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2665052"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -167,9 +147,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645799"></a><h3>
<a name="id2665070"></a><h3>
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
<a class="indexterm" name="id2645810"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2665081"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -181,9 +161,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645828"></a><h3>
<a name="id2665099"></a><h3>
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
<a class="indexterm" name="id2645839"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2665110"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -196,9 +176,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645857"></a><h3>
<a name="id2665128"></a><h3>
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
<a class="indexterm" name="id2645870"></a><pre class="programlisting">union GimpControllerEvent
<a class="indexterm" name="id2665141"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
@ -212,20 +192,18 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645888"></a><h3>
<a name="id2665159"></a><h3>
<a name="GimpController-struct"></a>GimpController</h3>
<a class="indexterm" name="id2645899"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<a class="indexterm" name="id2665171"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645916"></a><h3>
<a name="id2665187"></a><h3>
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
<a class="indexterm" name="id2645928"></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>
<a class="indexterm" name="id2665199"></a><pre class="programlisting"><a class="link" href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<p>
</p>
@ -233,12 +211,12 @@ href="../gobject/gobject-Type-Information.html#GType"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>controller_type</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>controller_type</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
@ -249,11 +227,9 @@ href="../gobject/gobject-Type-Information.html#GType"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2645984"></a><h3>
<a name="id2665255"></a><h3>
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
<a class="indexterm" name="id2645995"></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>
<a class="indexterm" name="id2665266"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<p>
</p>
@ -261,12 +237,12 @@ href="../glib/glib-Basic-Types.html#gint"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
@ -277,14 +253,10 @@ href="../glib/glib-Basic-Types.html#gint"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2646052"></a><h3>
<a name="id2665323"></a><h3>
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
<a class="indexterm" name="id2647603"></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>
<a class="indexterm" name="id2663504"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<p>
</p>
@ -292,17 +264,17 @@ href="../glib/glib-Basic-Types.html#gint"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
@ -313,14 +285,10 @@ href="../glib/glib-Basic-Types.html#gint"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647682"></a><h3>
<a name="id2663583"></a><h3>
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
<a class="indexterm" name="id2647693"></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>
<a class="indexterm" name="id2663594"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<p>
</p>
@ -328,17 +296,17 @@ href="../glib/glib-Basic-Types.html#gint"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
@ -349,12 +317,10 @@ href="../glib/glib-Basic-Types.html#gint"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647772"></a><h3>
<a name="id2663673"></a><h3>
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
<a class="indexterm" name="id2647784"></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>
<a class="indexterm" name="id2663684"></a><pre class="programlisting">gboolean gimp_controller_event (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
const <a class="link" href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
<p>
</p>
@ -362,17 +328,17 @@ href="../glib/glib-Basic-Types.html#gboolean"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
@ -383,41 +349,31 @@ href="../glib/glib-Basic-Types.html#gboolean"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2647863"></a><h2>Property Details</h2>
<a name="id2663764"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2647874"></a><h3>
<a name="id2663775"></a><h3>
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2647888"></a><pre class="programlisting"> "name" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<a class="indexterm" name="id2663788"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
<p></p>
<p>Default value: "Unnamed Controller"</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2647911"></a><h3>
<a name="id2663812"></a><h3>
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
<a class="indexterm" name="id2647925"></a><pre class="programlisting"> "state" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<a class="indexterm" name="id2663826"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
<p></p>
<p>Default value: "Unknown"</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2647949"></a><h2>Signal Details</h2>
<a name="id2663850"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2647960"></a><h3>
<a name="id2663861"></a><h3>
<a name="GimpController-event"></a>The "event" signal</h3>
<a class="indexterm" name="id2647968"></a><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) : Run Last</pre>
<a class="indexterm" name="id2663869"></a><pre class="programlisting">gboolean user_function (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
gpointer arg1,
gpointer user_data) : Run Last</pre>
<p>
</p>
@ -425,21 +381,21 @@ href="../glib/glib-Basic-Types.html#gpointer"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gimpcontroller</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>gimpcontroller</code></em>&#160;:</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></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>&#160;:</span></td>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
</td>