272 lines
11 KiB
XML
272 lines
11 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="GimpController">
|
|
<refmeta>
|
|
<refentrytitle>GimpController</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpController</refname><refpurpose>Pluggable GIMP input controller modules.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
enum <link linkend="GimpControllerEventType">GimpControllerEventType</link>;
|
|
<link linkend="GimpControllerEventAny">GimpControllerEventAny</link>;
|
|
<link linkend="GimpControllerEventTrigger">GimpControllerEventTrigger</link>;
|
|
<link linkend="GimpControllerEventValue">GimpControllerEventValue</link>;
|
|
union <link linkend="GimpControllerEvent">GimpControllerEvent</link>;
|
|
<link linkend="GimpController-struct">GimpController</link>;
|
|
<link linkend="GimpController">GimpController</link>* <link linkend="gimp-controller-new">gimp_controller_new</link> (<link linkend="GType">GType</link> controller_type);
|
|
<link linkend="gint">gint</link> <link linkend="gimp-controller-get-n-events">gimp_controller_get_n_events</link> (<link linkend="GimpController">GimpController</link> *controller);
|
|
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-name">gimp_controller_get_event_name</link> (<link linkend="GimpController">GimpController</link> *controller,
|
|
<link linkend="gint">gint</link> event_id);
|
|
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</link>
|
|
(<link linkend="GimpController">GimpController</link> *controller,
|
|
<link linkend="gint">gint</link> event_id);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-controller-event">gimp_controller_event</link> (<link linkend="GimpController">GimpController</link> *controller,
|
|
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----GimpController
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpController--name">name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
|
|
"<link linkend="GimpController--state">state</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Signal Prototypes</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpController-event">event</link>" <link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
|
|
<link linkend="gpointer">gpointer</link> arg1,
|
|
<link linkend="gpointer">gpointer</link> user_data);
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
An abstract interface for implementing arbitrary input controllers.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpControllerEventType"/>enum GimpControllerEventType</title>
|
|
<indexterm><primary>GimpControllerEventType</primary></indexterm><programlisting>typedef enum
|
|
{
|
|
GIMP_CONTROLLER_EVENT_TRIGGER,
|
|
GIMP_CONTROLLER_EVENT_VALUE
|
|
} GimpControllerEventType;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpControllerEventAny"/>GimpControllerEventAny</title>
|
|
<indexterm><primary>GimpControllerEventAny</primary></indexterm><programlisting>typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
} GimpControllerEventAny;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpControllerEventTrigger"/>GimpControllerEventTrigger</title>
|
|
<indexterm><primary>GimpControllerEventTrigger</primary></indexterm><programlisting>typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
} GimpControllerEventTrigger;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpControllerEventValue"/>GimpControllerEventValue</title>
|
|
<indexterm><primary>GimpControllerEventValue</primary></indexterm><programlisting>typedef struct {
|
|
GimpControllerEventType type;
|
|
GimpController *source;
|
|
gint event_id;
|
|
GValue value;
|
|
} GimpControllerEventValue;
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpControllerEvent"/>union GimpControllerEvent</title>
|
|
<indexterm><primary>GimpControllerEvent</primary></indexterm><programlisting>union GimpControllerEvent
|
|
{
|
|
GimpControllerEventType type;
|
|
GimpControllerEventAny any;
|
|
GimpControllerEventTrigger trigger;
|
|
GimpControllerEventValue value;
|
|
};
|
|
</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpController-struct"/>GimpController</title>
|
|
<indexterm><primary>GimpController</primary></indexterm><programlisting>typedef struct _GimpController GimpController;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-controller-new"/>gimp_controller_new ()</title>
|
|
<indexterm><primary>gimp_controller_new</primary></indexterm><programlisting><link linkend="GimpController">GimpController</link>* gimp_controller_new (<link linkend="GType">GType</link> controller_type);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>controller_type</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-controller-get-n-events"/>gimp_controller_get_n_events ()</title>
|
|
<indexterm><primary>gimp_controller_get_n_events</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_controller_get_n_events (<link linkend="GimpController">GimpController</link> *controller);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>controller</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-controller-get-event-name"/>gimp_controller_get_event_name ()</title>
|
|
<indexterm><primary>gimp_controller_get_event_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_name (<link linkend="GimpController">GimpController</link> *controller,
|
|
<link linkend="gint">gint</link> event_id);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>controller</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>event_id</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-controller-get-event-blurb"/>gimp_controller_get_event_blurb ()</title>
|
|
<indexterm><primary>gimp_controller_get_event_blurb</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_blurb
|
|
(<link linkend="GimpController">GimpController</link> *controller,
|
|
<link linkend="gint">gint</link> event_id);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>controller</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>event_id</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-controller-event"/>gimp_controller_event ()</title>
|
|
<indexterm><primary>gimp_controller_event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_controller_event (<link linkend="GimpController">GimpController</link> *controller,
|
|
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>controller</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>event</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>Properties</title>
|
|
<refsect2><title><anchor id="GimpController--name"/>The "<literal>name</literal>" property</title>
|
|
<programlisting> "name" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
|
|
<para></para><para>Default value: "Unnamed Controller"</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GimpController--state"/>The "<literal>state</literal>" property</title>
|
|
<programlisting> "state" <link linkend="gchararray">gchararray</link> : Read / Write / Construct</programlisting>
|
|
<para></para><para>Default value: "Unknown"</para>
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Signals</title>
|
|
<refsect2><title><anchor id="GimpController-event"/>The "event" signal</title>
|
|
<programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
|
|
<link linkend="gpointer">gpointer</link> arg1,
|
|
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>gimpcontroller</parameter> :</term>
|
|
<listitem><simpara>the object which received the signal.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>arg1</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|