Imported Upstream version 2.4.0~rc3

This commit is contained in:
Ari Pollak
2010-08-11 01:23:08 -04:00
parent 4be5597e32
commit f35d8506c6
668 changed files with 59324 additions and 37769 deletions

View File

@ -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="#id2612495" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2588417" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2664985" class="shortcut">Description</a>
<a href="#id2663430" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2664875" class="shortcut">Object Hierarchy</a>
<a href="#id2663319" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2664898" class="shortcut">Implemented Interfaces</a>
<a href="#id2663343" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2664920" class="shortcut">Properties</a>
<a href="#id2663364" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2664960" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2663405" 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="id2612495"></a><span class="refentrytitle">GimpController</span>
<a name="id2588417"></a><span class="refentrytitle">GimpController</span>
</h2>
<p>GimpController &#8212; Pluggable GIMP input controller modules.</p>
</td>
@ -68,27 +68,43 @@ enum <a class="link" href="GimpController.html#GimpControllerEven
<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,
<a class="link" href="GimpController.html" title="GimpController">GimpController</a>* <a class="link" 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 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 <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <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,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <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,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <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="id2664875"></a><h2>Object Hierarchy</h2>
<a name="id2663319"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GimpController
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2664898"></a><h2>Implemented Interfaces</h2>
<a name="id2663343"></a><h2>Implemented Interfaces</h2>
<p>
GimpController implements
<a
@ -96,32 +112,36 @@ href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
>GimpConfigInterface</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2664920"></a><h2>Properties</h2>
<a name="id2663364"></a><h2>Properties</h2>
<pre class="synopsis">
"<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
"<a class="link" href="GimpController.html#GimpController--name">name</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
"<a class="link" href="GimpController.html#GimpController--state">state</a>" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2664960"></a><h2>Signals</h2>
<a name="id2663405"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GimpController.html#GimpController-event">event</a>" : Run Last
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2664985"></a><h2>Description</h2>
<a name="id2663430"></a><h2>Description</h2>
<p>
An abstract interface for implementing arbitrary input controllers.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2665002"></a><h2>Details</h2>
<a name="id2663447"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2665013"></a><h3>
<a name="id2663458"></a><h3>
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
<a class="indexterm" name="id2665024"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2663469"></a><pre class="programlisting">typedef enum
{
GIMP_CONTROLLER_EVENT_TRIGGER,
GIMP_CONTROLLER_EVENT_VALUE
@ -133,9 +153,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665041"></a><h3>
<a name="id2660757"></a><h3>
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
<a class="indexterm" name="id2665052"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2660769"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -147,9 +167,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665070"></a><h3>
<a name="id2660786"></a><h3>
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
<a class="indexterm" name="id2665081"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2660798"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -161,9 +181,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665099"></a><h3>
<a name="id2660815"></a><h3>
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
<a class="indexterm" name="id2665110"></a><pre class="programlisting">typedef struct {
<a class="indexterm" name="id2660826"></a><pre class="programlisting">typedef struct {
GimpControllerEventType type;
GimpController *source;
gint event_id;
@ -176,9 +196,9 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665128"></a><h3>
<a name="id2660845"></a><h3>
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
<a class="indexterm" name="id2665141"></a><pre class="programlisting">union GimpControllerEvent
<a class="indexterm" name="id2660857"></a><pre class="programlisting">union GimpControllerEvent
{
GimpControllerEventType type;
GimpControllerEventAny any;
@ -192,18 +212,20 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665159"></a><h3>
<a name="id2660875"></a><h3>
<a name="GimpController-struct"></a>GimpController</h3>
<a class="indexterm" name="id2665171"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<a class="indexterm" name="id2660887"></a><pre class="programlisting">typedef struct _GimpController GimpController;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665187"></a><h3>
<a name="id2660903"></a><h3>
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
<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>
<a class="indexterm" name="id2660916"></a><pre class="programlisting"><a class="link" href="GimpController.html" title="GimpController">GimpController</a>* gimp_controller_new (<a
href="../gobject/gobject-Type-Information.html#GType"
>GType</a> controller_type);</pre>
<p>
</p>
@ -227,9 +249,11 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665255"></a><h3>
<a name="id2660972"></a><h3>
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
<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>
<a class="indexterm" name="id2660983"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> gimp_controller_get_n_events (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller);</pre>
<p>
</p>
@ -253,10 +277,14 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2665323"></a><h3>
<a name="id2661040"></a><h3>
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
<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>
<a class="indexterm" name="id2664902"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_controller_get_event_name (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);</pre>
<p>
</p>
@ -285,10 +313,14 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2663583"></a><h3>
<a name="id2664981"></a><h3>
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
<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>
<a class="indexterm" name="id2664992"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_controller_get_event_blurb (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> event_id);</pre>
<p>
</p>
@ -317,9 +349,11 @@ An abstract interface for implementing arbitrary input controllers.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2663673"></a><h3>
<a name="id2665071"></a><h3>
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
<a class="indexterm" name="id2663684"></a><pre class="programlisting">gboolean gimp_controller_event (<a class="link" href="GimpController.html" title="GimpController">GimpController</a> *controller,
<a class="indexterm" name="id2665083"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> 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>
@ -349,31 +383,41 @@ An abstract interface for implementing arbitrary input controllers.
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2663764"></a><h2>Property Details</h2>
<a name="id2665162"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2663775"></a><h3>
<a name="id2665173"></a><h3>
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
<a class="indexterm" name="id2663788"></a><pre class="programlisting"> "name" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2665187"></a><pre class="programlisting"> "name" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<p></p>
<p>Default value: "Unnamed Controller"</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2663812"></a><h3>
<a name="id2665210"></a><h3>
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
<a class="indexterm" name="id2663826"></a><pre class="programlisting"> "state" gchararray : Read / Write / Construct</pre>
<a class="indexterm" name="id2665224"></a><pre class="programlisting"> "state" <a
href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write / Construct</pre>
<p></p>
<p>Default value: "Unknown"</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2663850"></a><h2>Signal Details</h2>
<a name="id2665248"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2663861"></a><h3>
<a name="id2665259"></a><h3>
<a name="GimpController-event"></a>The "event" signal</h3>
<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>
<a class="indexterm" name="id2665267"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> user_function (<a class="link" 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>
<p>
</p>