Imported Upstream version 2.2.14

This commit is contained in:
Ari Pollak
2010-08-11 01:17:12 -04:00
parent 70ad8213cf
commit a2f097051e
490 changed files with 35329 additions and 58398 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpController</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
<link rel="next" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<meta name="generator" content="GTK-Doc V1.6 (XML mode)">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
@ -28,27 +28,29 @@
<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="#top_of_page" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2582469" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a>
<a href="#id2623428" class="shortcut">Description</a>
&#160;|&#160;
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
<a href="#id2623313" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#properties" class="shortcut">Properties</a>
<a href="#id2623337" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2623379" 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><span class="refentrytitle"><a name="top_of_page"></a>GimpController</span></h2>
<h2>
<a name="id2582469"></a><span class="refentrytitle">GimpController</span>
</h2>
<p>GimpController &#8212; Pluggable GIMP input controller modules.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="synopsis"></a><h2>Synopsis</h2>
<h2>Synopsis</h2>
<pre class="synopsis">
@ -72,7 +74,7 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="object_hierarchy"></a><h2>Object Hierarchy</h2>
<a name="id2623313"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
@ -80,7 +82,7 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="properties"></a><h2>Properties</h2>
<a name="id2623337"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
@ -88,7 +90,7 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="signal_proto"></a><h2>Signals</h2>
<a name="id2623379"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpController.html#GimpController-event">event</a>" gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
@ -97,17 +99,17 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<a name="id2623428"></a><h2>Description</h2>
<p>
An abstract interface for implementing arbitrary input controllers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="details"></a><h2>Details</h2>
<a name="id2623445"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2592344"></a><h3>
<a name="id2623456"></a><h3>
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
<a class="indexterm" name="id2592356"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2623467"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
@ -119,9 +121,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592372"></a><h3>
<a name="id2623484"></a><h3>
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
<a class="indexterm" name="id2592383"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2623495"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -133,9 +135,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592401"></a><h3>
<a name="id2623513"></a><h3>
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
<a class="indexterm" name="id2592412"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2623524"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -147,9 +149,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592430"></a><h3>
<a name="id2623542"></a><h3>
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
<a class="indexterm" name="id2592441"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2623553"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -162,9 +164,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592459"></a><h3>
<a name="id2623571"></a><h3>
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
<a class="indexterm" name="id2592471"></a><pre class="programlisting">union GimpControllerEvent
<a class="indexterm" name="id2623584"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
@ -178,18 +180,18 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592490"></a><h3>
<a name="id2623602"></a><h3>
<a name="GimpController-struct"></a>GimpController</h3>
<a class="indexterm" name="id2588644"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<a class="indexterm" name="id2623613"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588660"></a><h3>
<a name="id2623630"></a><h3>
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
<a class="indexterm" name="id2588672"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<a class="indexterm" name="id2623642"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<p>
</p>
@ -197,14 +199,12 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>controller_type</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>controller_type</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -215,9 +215,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588728"></a><h3>
<a name="id2624718"></a><h3>
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
<a class="indexterm" name="id2588740"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<a class="indexterm" name="id2624729"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<p>
</p>
@ -225,14 +225,12 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -243,9 +241,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588796"></a><h3>
<a name="id2624784"></a><h3>
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
<a class="indexterm" name="id2588807"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a class="indexterm" name="id2624796"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<p>
@ -254,20 +252,17 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -278,9 +273,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588885"></a><h3>
<a name="id2624875"></a><h3>
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
<a class="indexterm" name="id2588896"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb
<a class="indexterm" name="id2624888"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<p>
@ -290,20 +285,17 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>event_id</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -314,9 +306,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588976"></a><h3>
<a name="id2624968"></a><h3>
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
<a class="indexterm" name="id2588987"></a><pre class="programlisting">gboolean gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a class="indexterm" name="id2624980"></a><pre class="programlisting">gboolean gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
const <a href="GimpController.html#GimpControllerEvent">GimpControllerEvent</a> *event);</pre>
<p>
@ -325,20 +317,17 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>controller</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
@ -349,29 +338,29 @@ An abstract interface for implementing arbitrary input controllers.
</div>
</div>
<div class="refsect1" lang="en">
<a name="property_details"></a><h2>Property Details</h2>
<a name="id2625058"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2589077"></a><h3>
<a name="id2625069"></a><h3>
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2589091"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2625082"></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="id2589116"></a><h3>
<a name="id2625107"></a><h3>
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
<a class="indexterm" name="id2589130"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2625121"></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="signals"></a><h2>Signal Details</h2>
<a name="id2625146"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2589166"></a><h3>
<a name="id2625157"></a><h3>
<a name="GimpController-event"></a>The "event" signal</h3>
<a class="indexterm" name="id2589174"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
<a class="indexterm" name="id2625165"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
gpointer arg1,
gpointer user_data) : Run last</pre>
<p>
@ -381,25 +370,21 @@ An abstract interface for implementing arbitrary input controllers.
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>gimpcontroller</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>gimpcontroller</code></em>&#160;:</span></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><span class="term"><em class="parameter"><code>arg1</code></em>&#160;:</span></td>
<td>
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</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>&#160;:</span></td>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td>
</td>