1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
<?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> :</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> :</term>
<listitem><simpara>the inputdialog that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>deviceid</parameter> :</term>
<listitem><simpara>the ID of the newly disabled
device.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</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> :</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> :</term>
<listitem><simpara>the inputdialog that received the
signal</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>deviceid</parameter> :</term>
<listitem><simpara>the ID of the newly disabled
device.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>user_param1</parameter> :</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> :</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>
|