<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkInputDialog">
<refmeta>
<refentrytitle role="top_of_page" id="GtkInputDialog.top_of_page">GtkInputDialog</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkInputDialog</refname>
<refpurpose>Configure devices for the XInput extension</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkInputDialog.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkInputDialog-struct">GtkInputDialog</link>;
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-input-dialog-new">gtk_input_dialog_new</link>                (void);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkInputDialog.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkWindow">GtkWindow</link>
                                       +----<link linkend="GtkDialog">GtkDialog</link>
                                             +----GtkInputDialog
</synopsis>
</refsect1>



<refsect1 id="GtkInputDialog.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkInputDialog implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>



<refsect1 id="GtkInputDialog.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GtkInputDialog-disable-device">disable-device</link>&quot;                                 : Run Last
  &quot;<link linkend="GtkInputDialog-enable-device">enable-device</link>&quot;                                  : Run Last
</synopsis>
</refsect1>


<refsect1 id="GtkInputDialog.description" role="desc">
<title role="desc.title">Description</title>
<para>
 NOTE this widget is considered too specialized/little-used for
 GTK+, and will in the future be moved to some other package.  If
 your application needs this widget, feel free to use it, as the
 widget does work and is useful in some applications; it's just not
 of general interest. However, we are not accepting new features for
 the widget, and it will eventually move out of the GTK+
 distribution.
</para>
<para>
<link linkend="GtkInputDialog"><type>GtkInputDialog</type></link> displays a dialog which allows the user
to configure XInput extension devices. For each
device, they can control the mode of the device
(disabled, screen-relative, or window-relative),
the mapping of axes to coordinates, and the
mapping of the devices macro keys to key press
events.
</para>
<para>
<link linkend="GtkInputDialog"><type>GtkInputDialog</type></link> contains two buttons to which
the application can connect; one for closing
the dialog, and one for saving the changes.
No actions are bound to these by default.
The changes that the user makes take effect
immediately.
</para>
</refsect1>

<refsect1 id="GtkInputDialog.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkInputDialog-struct" role="struct">
<title>GtkInputDialog</title>
<indexterm zone="GtkInputDialog-struct"><primary sortas="InputDialog">GtkInputDialog</primary></indexterm><programlisting>typedef struct _GtkInputDialog GtkInputDialog;</programlisting>
<para>
</para></refsect2>
<refsect2 id="gtk-input-dialog-new" role="function">
<title>gtk_input_dialog_new ()</title>
<indexterm zone="gtk-input-dialog-new"><primary sortas="input_dialog_new">gtk_input_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_input_dialog_new                (void);</programlisting>
<para>
Creates a new <link linkend="GtkInputDialog"><type>GtkInputDialog</type></link>.
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the new <link linkend="GtkInputDialog"><type>GtkInputDialog</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>

<refsect1 id="GtkInputDialog.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkInputDialog-disable-device" role="signal"><title>The <literal>&quot;disable-device&quot;</literal> signal</title>
<indexterm zone="GtkInputDialog-disable-device"><primary sortas="InputDialog::disable-device">GtkInputDialog::disable-device</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkInputDialog">GtkInputDialog</link> *inputdialog,
                                                        <link linkend="GdkDevice">GdkDevice</link>      *deviceid,
                                                        <link linkend="gpointer">gpointer</link>        user_data)        : Run Last</programlisting>
<para>
This signal is emitted when the user changes the
mode of a device from a <link linkend="GDK-MODE-SCREEN--CAPS"><type>GDK_MODE_SCREEN</type></link> or <link linkend="GDK-MODE-WINDOW--CAPS"><type>GDK_MODE_WINDOW</type></link>
to <link linkend="GDK-MODE-ENABLED--CAPS"><type>GDK_MODE_ENABLED</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>inputdialog</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>deviceid</parameter>&#160;:</term>
<listitem><simpara>The ID of the newly disabled device.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkInputDialog-enable-device" role="signal"><title>The <literal>&quot;enable-device&quot;</literal> signal</title>
<indexterm zone="GtkInputDialog-enable-device"><primary sortas="InputDialog::enable-device">GtkInputDialog::enable-device</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkInputDialog">GtkInputDialog</link> *inputdialog,
                                                        <link linkend="GdkDevice">GdkDevice</link>      *deviceid,
                                                        <link linkend="gpointer">gpointer</link>        user_data)        : Run Last</programlisting>
<para>
This signal is emitted when the user changes the
mode of a device from <link linkend="GDK-MODE-DISABLED--CAPS"><type>GDK_MODE_DISABLED</type></link> to a
<link linkend="GDK-MODE-SCREEN--CAPS"><type>GDK_MODE_SCREEN</type></link> or <link linkend="GDK-MODE-WINDOW--CAPS"><type>GDK_MODE_WINDOW</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>inputdialog</parameter>&#160;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>deviceid</parameter>&#160;:</term>
<listitem><simpara>The ID of the newly enabled device.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>
