diff options
Diffstat (limited to 'devel-docs/libgimpwidgets/html/GimpController.html')
| -rw-r--r-- | devel-docs/libgimpwidgets/html/GimpController.html | 443 |
1 files changed, 443 insertions, 0 deletions
diff --git a/devel-docs/libgimpwidgets/html/GimpController.html b/devel-docs/libgimpwidgets/html/GimpController.html new file mode 100644 index 0000000..0101ccb --- /dev/null +++ b/devel-docs/libgimpwidgets/html/GimpController.html @@ -0,0 +1,443 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>GimpController: GIMP Widgets Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Widgets Library Reference Manual"> +<link rel="up" href="libgimpwidgets-controller.html" title="Part V. GIMP Controllers"> +<link rel="prev" href="libgimpwidgets-controller.html" title="Part V. GIMP Controllers"> +<link rel="next" href="libgimpwidgets-utils.html" title="Part VI. GIMP Widgets Utilities"> +<meta name="generator" content="GTK-Doc V1.32 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</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="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#GimpController.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#GimpController.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> + <a href="#GimpController.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#GimpController.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#GimpController.signals" class="shortcut">Signals</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimpwidgets-controller.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimpwidgets-controller.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimpwidgets-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="GimpController"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="GimpController.top_of_page"></a>GimpController</span></h2> +<p>GimpController — Pluggable GIMP input controller modules.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="GimpController.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<a class="link" href="GimpController.html" title="GimpController"><span class="returnvalue">GimpController</span></a> * +</td> +<td class="function_name"> +<a class="link" href="GimpController.html#gimp-controller-new" title="gimp_controller_new ()">gimp_controller_new</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="GimpController.html#gimp-controller-get-n-events" title="gimp_controller_get_n_events ()">gimp_controller_get_n_events</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpController.html#gimp-controller-get-event-name" title="gimp_controller_get_event_name ()">gimp_controller_get_event_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type">const <span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="GimpController.html#gimp-controller-get-event-blurb" title="gimp_controller_get_event_blurb ()">gimp_controller_get_event_blurb</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="GimpController.html#gimp-controller-event" title="gimp_controller_event ()">gimp_controller_event</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpController.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="GimpController.html#GimpController--name" title="The “name” property">name</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="GimpController.html#GimpController--state" title="The “state” property">state</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpController.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> +</colgroup> +<tbody><tr> +<td class="signal_type"><span class="returnvalue">gboolean</span></td> +<td class="signal_name"><a class="link" href="GimpController.html#GimpController-event" title="The “event” signal">event</a></td> +<td class="signal_flags">Run Last</td> +</tr></tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpController.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="other_proto_type"> +<col class="other_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType">GimpControllerEventType</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="GimpController.html#GimpControllerEventAny" title="struct GimpControllerEventAny">GimpControllerEventAny</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="GimpController.html#GimpControllerEventTrigger" title="struct GimpControllerEventTrigger">GimpControllerEventTrigger</a></td> +</tr> +<tr> +<td class="datatype_keyword">struct</td> +<td class="function_name"><a class="link" href="GimpController.html#GimpControllerEventValue" title="struct GimpControllerEventValue">GimpControllerEventValue</a></td> +</tr> +<tr> +<td class="datatype_keyword">union</td> +<td class="function_name"><a class="link" href="GimpController.html#GimpControllerEvent" title="union GimpControllerEvent">GimpControllerEvent</a></td> +</tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="GimpController.html#GimpController-struct" title="GimpController">GimpController</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="GimpController.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> GObject + <span class="lineart">╰──</span> GimpController +</pre> +</div> +<div class="refsect1"> +<a name="GimpController.implemented-interfaces"></a><h2>Implemented Interfaces</h2> +<p> +GimpController implements + <a href="../html/libgimpconfig-GimpConfig.html#GimpConfigInterface-struct">GimpConfigInterface</a>.</p> +</div> +<div class="refsect1"> +<a name="GimpController.description"></a><h2>Description</h2> +<p>An abstract interface for implementing arbitrary input controllers.</p> +</div> +<div class="refsect1"> +<a name="GimpController.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-controller-new"></a><h3>gimp_controller_new ()</h3> +<pre class="programlisting"><a class="link" href="GimpController.html" title="GimpController"><span class="returnvalue">GimpController</span></a> * +gimp_controller_new (<em class="parameter"><code><span class="type">GType</span> controller_type</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-controller-get-n-events"></a><h3>gimp_controller_get_n_events ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_controller_get_n_events (<em class="parameter"><code><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *controller</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-controller-get-event-name"></a><h3>gimp_controller_get_event_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * +gimp_controller_get_event_name (<em class="parameter"><code><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *controller</code></em>, + <em class="parameter"><code><span class="type">gint</span> event_id</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-controller-get-event-blurb"></a><h3>gimp_controller_get_event_blurb ()</h3> +<pre class="programlisting">const <span class="returnvalue">gchar</span> * +gimp_controller_get_event_blurb (<em class="parameter"><code><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *controller</code></em>, + <em class="parameter"><code><span class="type">gint</span> event_id</code></em>);</pre> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-controller-event"></a><h3>gimp_controller_event ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_controller_event (<em class="parameter"><code><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *controller</code></em>, + <em class="parameter"><code>const <a class="link" href="GimpController.html#GimpControllerEvent" title="union GimpControllerEvent"><span class="type">GimpControllerEvent</span></a> *event</code></em>);</pre> +</div> +</div> +<div class="refsect1"> +<a name="GimpController.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="GimpControllerEventType"></a><h3>enum GimpControllerEventType</h3> +<p>Event types for <a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a>.</p> +<div class="refsect3"> +<a name="GimpControllerEventType.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONTROLLER-EVENT-TRIGGER:CAPS"></a>GIMP_CONTROLLER_EVENT_TRIGGER</p></td> +<td class="enum_member_description"> +<p>the event is a simple trigger</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="GIMP-CONTROLLER-EVENT-VALUE:CAPS"></a>GIMP_CONTROLLER_EVENT_VALUE</p></td> +<td class="enum_member_description"> +<p>the event carries a double value</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpControllerEventAny"></a><h3>struct GimpControllerEventAny</h3> +<pre class="programlisting">struct GimpControllerEventAny { + GimpControllerEventType type; + GimpController *source; + gint event_id; +}; +</pre> +<p>Generic controller event. Every event has these three members at the +beginning of its struct</p> +<div class="refsect3"> +<a name="GimpControllerEventAny.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a> <em class="structfield"><code><a name="GimpControllerEventAny.type"></a>type</code></em>;</p></td> +<td class="struct_member_description"><p>The event's <a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *<em class="structfield"><code><a name="GimpControllerEventAny.source"></a>source</code></em>;</p></td> +<td class="struct_member_description"><p>The event's source <a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpControllerEventAny.event-id"></a>event_id</code></em>;</p></td> +<td class="struct_member_description"><p>The event's ID</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpControllerEventTrigger"></a><h3>struct GimpControllerEventTrigger</h3> +<pre class="programlisting">struct GimpControllerEventTrigger { + GimpControllerEventType type; + GimpController *source; + gint event_id; +}; +</pre> +<p>Trigger controller event.</p> +<div class="refsect3"> +<a name="GimpControllerEventTrigger.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a> <em class="structfield"><code><a name="GimpControllerEventTrigger.type"></a>type</code></em>;</p></td> +<td class="struct_member_description"><p>The event's <a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *<em class="structfield"><code><a name="GimpControllerEventTrigger.source"></a>source</code></em>;</p></td> +<td class="struct_member_description"><p>The event's source <a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpControllerEventTrigger.event-id"></a>event_id</code></em>;</p></td> +<td class="struct_member_description"><p>The event's ID</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpControllerEventValue"></a><h3>struct GimpControllerEventValue</h3> +<pre class="programlisting">struct GimpControllerEventValue { + GimpControllerEventType type; + GimpController *source; + gint event_id; + GValue value; +}; +</pre> +<p>Value controller event.</p> +<div class="refsect3"> +<a name="GimpControllerEventValue.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="struct_members_name"> +<col class="struct_members_description"> +<col width="200px" class="struct_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a> <em class="structfield"><code><a name="GimpControllerEventValue.type"></a>type</code></em>;</p></td> +<td class="struct_member_description"><p>The event's <a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *<em class="structfield"><code><a name="GimpControllerEventValue.source"></a>source</code></em>;</p></td> +<td class="struct_member_description"><p>The event's source <a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a></p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="GimpControllerEventValue.event-id"></a>event_id</code></em>;</p></td> +<td class="struct_member_description"><p>The event's ID</p></td> +<td class="struct_member_annotations"> </td> +</tr> +<tr> +<td class="struct_member_name"><p><span class="type">GValue</span> <em class="structfield"><code><a name="GimpControllerEventValue.value"></a>value</code></em>;</p></td> +<td class="struct_member_description"><p>The event's value</p></td> +<td class="struct_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpControllerEvent"></a><h3>union GimpControllerEvent</h3> +<p>A union to hjold all event event types</p> +<div class="refsect3"> +<a name="GimpControllerEvent.members"></a><h4>Members</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="300px" class="union_members_name"> +<col class="union_members_description"> +<col width="200px" class="union_members_annotations"> +</colgroup> +<tbody> +<tr> +<td class="union_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventType" title="enum GimpControllerEventType"><span class="type">GimpControllerEventType</span></a> <em class="structfield"><code><a name="GimpControllerEvent.type"></a>type</code></em>;</p></td> +<td class="union_member_description"><p>The event type</p></td> +<td class="union_member_annotations"> </td> +</tr> +<tr> +<td class="union_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventAny" title="struct GimpControllerEventAny"><span class="type">GimpControllerEventAny</span></a> <em class="structfield"><code><a name="GimpControllerEvent.any"></a>any</code></em>;</p></td> +<td class="union_member_description"><p>GimpControllerEventAny</p></td> +<td class="union_member_annotations"> </td> +</tr> +<tr> +<td class="union_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventTrigger" title="struct GimpControllerEventTrigger"><span class="type">GimpControllerEventTrigger</span></a> <em class="structfield"><code><a name="GimpControllerEvent.trigger"></a>trigger</code></em>;</p></td> +<td class="union_member_description"><p>GimpControllerEventTrigger</p></td> +<td class="union_member_annotations"> </td> +</tr> +<tr> +<td class="union_member_name"><p><a class="link" href="GimpController.html#GimpControllerEventValue" title="struct GimpControllerEventValue"><span class="type">GimpControllerEventValue</span></a> <em class="structfield"><code><a name="GimpControllerEvent.value"></a>value</code></em>;</p></td> +<td class="union_member_description"><p>GimpControllerEventValue</p></td> +<td class="union_member_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="GimpController-struct"></a><h3>GimpController</h3> +<pre class="programlisting">typedef struct _GimpController GimpController;</pre> +</div> +</div> +<div class="refsect1"> +<a name="GimpController.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="GimpController--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> +<p>The controller's name.</p> +<p>Owner: GimpController</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: "Unnamed Controller"</p> +</div> +<hr> +<div class="refsect2"> +<a name="GimpController--state"></a><h3>The <code class="literal">“state”</code> property</h3> +<pre class="programlisting"> “state” <span class="type">gchar</span> *</pre> +<p>The controller's state, as human-readable string.</p> +<p>Owner: GimpController</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: "Unknown"</p> +</div> +</div> +<div class="refsect1"> +<a name="GimpController.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="GimpController-event"></a><h3>The <code class="literal">“event”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +user_function (<a class="link" href="GimpController.html" title="GimpController"><span class="type">GimpController</span></a> *gimpcontroller, + <span class="type">gpointer</span> arg1, + <span class="type">gpointer</span> user_data)</pre> +<p>Flags: Run Last</p> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.32</div> +</body> +</html>
\ No newline at end of file |