<?xml version="1.0" standalone="no"?>
<!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="class-gtkinputdialog">
  <refnamediv>
    <refname>gtk.InputDialog</refname>
    <refpurpose>a dialog for configuring devices for the XInput
extension.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.InputDialog</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkinputdialog">gtk.InputDialog</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkwindow">gtk.Window</link>
            +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
              +-- <link linkend="class-gtkinputdialog">gtk.InputDialog</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkinputdialog">
    <title>gtk.InputDialog Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
    <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkinputdialog">
    <title>gtk.InputDialog Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkinputdialog">
    <title>gtk.InputDialog Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>

    <variablelist>
      <varlistentry>
        <term>"<link
linkend="signal-gtkinputdialog--disable-device">disable-device</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>inputdialog</parameter>
            </methodparam>
            <methodparam><parameter>deviceid</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link
linkend="signal-gtkinputdialog--enable-device">enable-device</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>inputdialog</parameter>
            </methodparam>
            <methodparam><parameter>deviceid</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This widget is considered too specialized or little-used for
PyGTK, 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, it will eventually move out of the PyGTK distribution.</para>
    </note>

    <para><link
linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></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. <link
linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></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="constructor-gtkinputdialog">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.InputDialog</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>
widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkinputdialog"><classname>gtk.InputDialog</classname></link>.</para>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkinputdialog--disable-device">
      <title>The "disable-device" gtk.InputDialog Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>inputdialog</parameter></methodparam>
	  <methodparam><parameter>deviceid</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>inputdialog</parameter>&nbsp;:</term>
	  <listitem><simpara>the inputdialog that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>deviceid</parameter>&nbsp;:</term>
	  <listitem><simpara>the ID of the newly disabled
device.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "disable-device" signal is emitted when the user changes the
mode of a device from a <literal>gtk.gdk.MODE_SCREEN</literal> or
<literal>gtk.gdk.MODE_WINDOW</literal> to
<literal>gtk.gdk.MODE_ENABLED</literal>.</para>

    </refsect2>

    <refsect2 id="signal-gtkinputdialog--enable-device">
      <title>The "enable-device" gtk.InputDialog Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>inputdialog</parameter></methodparam>
	  <methodparam><parameter>deviceid</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>inputdialog</parameter>&nbsp;:</term>
	  <listitem><simpara>the inputdialog that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>deviceid</parameter>&nbsp;:</term>
	  <listitem><simpara>the ID of the newly disabled
device.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "enable-device" signal is emitted when the user changes the
mode of a device from <literal>gtk.gdk.MODE_DISABLED</literal> to a
<literal>gtk.gdk.MODE_SCREEN</literal> or
<literal>gtk.gdk.MODE_WINDOW</literal>. </para>

    </refsect2>

  </refsect1>

</refentry>
