Imported Upstream version 2.3.16

This commit is contained in:
Ari Pollak
2010-08-11 01:21:23 -04:00
parent d694295a3e
commit 2e1d89b96f
944 changed files with 103935 additions and 69090 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.71.0">
<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.7 (XML mode)">
<meta name="generator" content="GTK-Doc V1.8 (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,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="#id2594242" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2580514" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2630742" class="shortcut">Description</a>
<a href="#id2639271" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2630606" class="shortcut">Object Hierarchy</a>
<a href="#id2639160" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2630630" class="shortcut">Implemented Interfaces</a>
<a href="#id2639184" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2630651" class="shortcut">Properties</a>
<a href="#id2639205" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2630693" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2639246" 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="id2594242"></a><span class="refentrytitle">GimpController</span>
<a name="id2580514"></a><span class="refentrytitle">GimpController</span>
</h2>
<p>GimpController &#8212; Pluggable GIMP input controller modules.</p>
</td>
@ -62,26 +62,25 @@
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> (GType controller_type);
gint <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 gchar* <a href="GimpController.html#gimp-controller-get-event-name">gimp_controller_get_event_name</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
const gchar* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a>
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
gboolean <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 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> (GType controller_type);
gint <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 gchar* <a href="GimpController.html#gimp-controller-get-event-name">gimp_controller_get_event_name</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
const gchar* <a href="GimpController.html#gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</a> (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);
gboolean <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);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2630606"></a><h2>Object Hierarchy</h2>
<a name="id2639160"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
@ -89,7 +88,7 @@ gboolean <a href="GimpController.html#gimp-controller-event">gimp_controller_
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2630630"></a><h2>Implemented Interfaces</h2>
<a name="id2639184"></a><h2>Implemented Interfaces</h2>
<p>
GimpController implements
<a
@ -97,34 +96,32 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
>GimpConfigInterface</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2630651"></a><h2>Properties</h2>
<a name="id2639205"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
"<a href="GimpController.html#GimpController--state">state</a>" gchararray : Read / Write / Construct
"<a href="GimpController.html#GimpController--name">name</a>" gchararray : Read / Write / Construct
"<a href="GimpController.html#GimpController--state">state</a>" gchararray : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2630693"></a><h2>Signals</h2>
<a name="id2639246"></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,
gpointer arg1,
gpointer user_data) : Run last
"<a href="GimpController.html#GimpController-event">event</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2630742"></a><h2>Description</h2>
<a name="id2639271"></a><h2>Description</h2>
<p>
An abstract interface for implementing arbitrary input controllers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2630759"></a><h2>Details</h2>
<a name="id2639288"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2631108"></a><h3>
<a name="id2639299"></a><h3>
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
<a class="indexterm" name="id2631120"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2639310"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
@ -136,9 +133,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631137"></a><h3>
<a name="id2640723"></a><h3>
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
<a class="indexterm" name="id2631148"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2640734"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -150,9 +147,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631166"></a><h3>
<a name="id2640752"></a><h3>
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
<a class="indexterm" name="id2631177"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2640763"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -164,9 +161,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631194"></a><h3>
<a name="id2640781"></a><h3>
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
<a class="indexterm" name="id2631206"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2640792"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -179,9 +176,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631224"></a><h3>
<a name="id2640810"></a><h3>
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
<a class="indexterm" name="id2631236"></a><pre class="programlisting">union GimpControllerEvent
<a class="indexterm" name="id2640823"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
@ -195,18 +192,18 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631254"></a><h3>
<a name="id2640841"></a><h3>
<a name="GimpController-struct"></a>GimpController</h3>
<a class="indexterm" name="id2631266"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<a class="indexterm" name="id2640852"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631282"></a><h3>
<a name="id2640869"></a><h3>
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
<a class="indexterm" name="id2631295"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<a class="indexterm" name="id2640881"></a><pre class="programlisting"><a href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (GType controller_type);</pre>
<p>
</p>
@ -230,9 +227,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631351"></a><h3>
<a name="id2640937"></a><h3>
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
<a class="indexterm" name="id2631362"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<a class="indexterm" name="id2640948"></a><pre class="programlisting">gint gimp_controller_get_n_events (<a href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<p>
</p>
@ -256,10 +253,10 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2634018"></a><h3>
<a name="id2641005"></a><h3>
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
<a class="indexterm" name="id2634030"></a><pre class="programlisting">const gchar* gimp_controller_get_event_name (<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<a class="indexterm" name="id2641927"></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>
</p>
@ -288,11 +285,10 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2634108"></a><h3>
<a name="id2642007"></a><h3>
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
<a class="indexterm" name="id2634119"></a><pre class="programlisting">const gchar* gimp_controller_get_event_blurb
(<a href="GimpController.html" title="GimpController">GimpController</a> *controller,
gint event_id);</pre>
<a class="indexterm" name="id2642018"></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>
</p>
@ -321,10 +317,10 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2634198"></a><h3>
<a name="id2642097"></a><h3>
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
<a class="indexterm" name="id2634209"></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>
<a class="indexterm" name="id2642108"></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>
</p>
@ -353,31 +349,31 @@ An abstract interface for implementing arbitrary input controllers.
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2634289"></a><h2>Property Details</h2>
<a name="id2642188"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2634299"></a><h3>
<a name="id2642198"></a><h3>
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2634313"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2642212"></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="id2634337"></a><h3>
<a name="id2642236"></a><h3>
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
<a class="indexterm" name="id2634351"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2642250"></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="id2634376"></a><h2>Signal Details</h2>
<a name="id2642274"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2634387"></a><h3>
<a name="id2642285"></a><h3>
<a name="GimpController-event"></a>The "event" signal</h3>
<a class="indexterm" name="id2634395"></a><pre class="programlisting">gboolean user_function (<a href="GimpController.html" title="GimpController">GimpController</a> *gimpcontroller,
gpointer arg1,
gpointer user_data) : Run last</pre>
<a class="indexterm" name="id2642293"></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>
</p>