454 lines
17 KiB
HTML
454 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GimpController</title>
|
|
<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 IV. GIMP Controllers">
|
|
<link rel="prev" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
|
|
<link rel="next" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
|
|
<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 I. GIMP Widgets">
|
|
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
|
|
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
|
|
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
|
|
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
|
|
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
|
|
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
|
|
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
|
|
<link rel="index" href="libgimpwidgets-index.html" title="Index">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
|
|
<tr valign="middle">
|
|
<td><a accesskey="p" href="libgimpwidgets-controller.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimpwidgets-controller.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
|
|
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
|
|
<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="#id2588417" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2663430" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2663319" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2663343" class="shortcut">Implemented Interfaces</a>
|
|
 | 
|
|
<a href="#id2663364" class="shortcut">Properties</a>
|
|
 | 
|
|
<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="id2588417"></a><span class="refentrytitle">GimpController</span>
|
|
</h2>
|
|
<p>GimpController — Pluggable GIMP input controller modules.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
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> (<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="id2663319"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
|
|
>GObject</a>
|
|
+----GimpController
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2663343"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpController implements
|
|
<a
|
|
href="../libgimpconfig/libgimpconfig-GimpConfig.html#GimpConfigInterface"
|
|
>GimpConfigInterface</a>.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2663364"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<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="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="id2663430"></a><h2>Description</h2>
|
|
<p>
|
|
An abstract interface for implementing arbitrary input controllers.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2663447"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2663458"></a><h3>
|
|
<a name="GimpControllerEventType"></a>enum GimpControllerEventType</h3>
|
|
<a class="indexterm" name="id2663469"></a><pre class="programlisting">typedef enum
|
|
{
|
|
GIMP_CONTROLLER_EVENT_TRIGGER,
|
|
GIMP_CONTROLLER_EVENT_VALUE
|
|
} GimpControllerEventType;
|
|
</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660757"></a><h3>
|
|
<a name="GimpControllerEventAny"></a>GimpControllerEventAny</h3>
|
|
<a class="indexterm" name="id2660769"></a><pre class="programlisting">typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
} GimpControllerEventAny;
|
|
</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660786"></a><h3>
|
|
<a name="GimpControllerEventTrigger"></a>GimpControllerEventTrigger</h3>
|
|
<a class="indexterm" name="id2660798"></a><pre class="programlisting">typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
} GimpControllerEventTrigger;
|
|
</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660815"></a><h3>
|
|
<a name="GimpControllerEventValue"></a>GimpControllerEventValue</h3>
|
|
<a class="indexterm" name="id2660826"></a><pre class="programlisting">typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
GValue value;
|
|
} GimpControllerEventValue;
|
|
</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660845"></a><h3>
|
|
<a name="GimpControllerEvent"></a>union GimpControllerEvent</h3>
|
|
<a class="indexterm" name="id2660857"></a><pre class="programlisting">union GimpControllerEvent
|
|
{
|
|
GimpControllerEventType type;
|
|
GimpControllerEventAny any;
|
|
GimpControllerEventTrigger trigger;
|
|
GimpControllerEventValue value;
|
|
};
|
|
</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660875"></a><h3>
|
|
<a name="GimpController-struct"></a>GimpController</h3>
|
|
<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="id2660903"></a><h3>
|
|
<a name="gimp-controller-new"></a>gimp_controller_new ()</h3>
|
|
<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>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>controller_type</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2660972"></a><h3>
|
|
<a name="gimp-controller-get-n-events"></a>gimp_controller_get_n_events ()</h3>
|
|
<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>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>controller</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2661040"></a><h3>
|
|
<a name="gimp-controller-get-event-name"></a>gimp_controller_get_event_name ()</h3>
|
|
<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>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>controller</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>event_id</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2664981"></a><h3>
|
|
<a name="gimp-controller-get-event-blurb"></a>gimp_controller_get_event_blurb ()</h3>
|
|
<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>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>controller</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>event_id</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2665071"></a><h3>
|
|
<a name="gimp-controller-event"></a>gimp_controller_event ()</h3>
|
|
<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>
|
|
|
|
</p>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>controller</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2665162"></a><h2>Property Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2665173"></a><h3>
|
|
<a name="GimpController--name"></a>The "<code class="literal">name</code>" property</h3>
|
|
<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="id2665210"></a><h3>
|
|
<a name="GimpController--state"></a>The "<code class="literal">state</code>" property</h3>
|
|
<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="id2665248"></a><h2>Signal Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2665259"></a><h3>
|
|
<a name="GimpController-event"></a>The "event" signal</h3>
|
|
<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>
|
|
<div class="variablelist"><table border="0">
|
|
<col align="left" valign="top">
|
|
<tbody>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>gimpcontroller</code></em> :</span></p></td>
|
|
<td>the object which received the signal.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
|
|
<td>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
|
|
<td>user data set when the signal handler was connected.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td>
|
|
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|