Imported Upstream version 2.3.11

This commit is contained in:
Ari Pollak
2010-08-11 01:20:03 -04:00
parent efbc58ed09
commit 79785b4adf
1382 changed files with 88625 additions and 63323 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.70.1">
<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">
@ -33,27 +33,31 @@
<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="#id2592579" class="shortcut">Top</a>
&#160;|&#160;
<a href="#desc" class="shortcut">Description</a>
<a href="#id2642622" class="shortcut">Description</a>
&#160;|&#160;
<a href="#object_hierarchy" class="shortcut">Object Hierarchy</a>
<a href="#id2642486" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#properties" class="shortcut">Properties</a>
<a href="#id2642510" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#signal_proto" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2642531" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2642573" 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="id2592579"></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">
@ -77,7 +81,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="id2642486"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
@ -85,7 +89,7 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="impl_interfaces"></a><h2>Implemented Interfaces</h2>
<a name="id2642510"></a><h2>Implemented Interfaces</h2>
<p>
GimpController implements
<a
@ -93,7 +97,7 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
>GimpConfigInterface</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="properties"></a><h2>Properties</h2>
<a name="id2642531"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
@ -101,7 +105,7 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
</pre>
</div>
<div class="refsect1" lang="en">
<a name="signal_proto"></a><h2>Signals</h2>
<a name="id2642573"></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,
@ -110,17 +114,17 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
</pre>
</div>
<div class="refsect1" lang="en">
<a name="desc"></a><h2>Description</h2>
<a name="id2642622"></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="id2637992"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2605158"></a><h3>
<a name="id2638002"></a><h3>
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
<a class="indexterm" name="id2605170"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2638014"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
@ -132,9 +136,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604253"></a><h3>
<a name="id2638031"></a><h3>
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
<a class="indexterm" name="id2604264"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2638042"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -146,9 +150,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604281"></a><h3>
<a name="id2638060"></a><h3>
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
<a class="indexterm" name="id2604292"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2638071"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -160,9 +164,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604310"></a><h3>
<a name="id2638088"></a><h3>
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
<a class="indexterm" name="id2604321"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2638100"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -175,9 +179,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604339"></a><h3>
<a name="id2638118"></a><h3>
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
<a class="indexterm" name="id2604352"></a><pre class="programlisting">union GimpControllerEvent
<a class="indexterm" name="id2638130"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
@ -191,18 +195,18 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604370"></a><h3>
<a name="id2638148"></a><h3>
<a name="GimpController-struct"></a>GimpController</h3>
<a class="indexterm" name="id2604381"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<a class="indexterm" name="id2638160"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604398"></a><h3>
<a name="id2638176"></a><h3>
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
<a class="indexterm" name="id2604410"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<a class="indexterm" name="id2638189"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<p>
</p>
@ -228,9 +232,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604466"></a><h3>
<a name="id2638245"></a><h3>
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
<a class="indexterm" name="id2604477"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<a class="indexterm" name="id2639610"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<p>
</p>
@ -256,9 +260,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607130"></a><h3>
<a name="id2639667"></a><h3>
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
<a class="indexterm" name="id2607141"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a class="indexterm" name="id2639678"></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>
@ -291,9 +295,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607219"></a><h3>
<a name="id2639756"></a><h3>
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
<a class="indexterm" name="id2607231"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb
<a class="indexterm" name="id2639767"></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>
@ -327,9 +331,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607311"></a><h3>
<a name="id2639847"></a><h3>
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
<a class="indexterm" name="id2607322"></a><pre class="programlisting">gboolean gimp_controller_event (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a class="indexterm" name="id2639858"></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>
@ -362,29 +366,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="id2640870"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2607413"></a><h3>
<a name="id2640881"></a><h3>
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2607427"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2640895"></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="id2607451"></a><h3>
<a name="id2640919"></a><h3>
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
<a class="indexterm" name="id2607465"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2640933"></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="id2640958"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2607501"></a><h3>
<a name="id2640969"></a><h3>
<a name="GimpController-event"></a>The "event" signal</h3>
<a class="indexterm" name="id2607509"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
<a class="indexterm" name="id2640977"></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>