GtkSharp/doc/en/Gtk/InputDialog.xml
John Luke cc1f6e10f2 run the updater, add docs for Art, Gda, and GnomeDb
(includes Gnome.Print)

svn path=/trunk/gtk-sharp/; revision=18154
2003-09-17 21:56:59 +00:00

143 lines
6.3 KiB
XML

<Type Name="InputDialog" FullName="Gtk.InputDialog">
<TypeSignature Language="C#" Value="public class InputDialog : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Configure devices for the XInput extension.</summary>
<remarks>
<para>
NOTE: this <see cref="T:Gtk.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 <see cref="T:Gtk.Widget" />, feel free to use it, as the <see cref="T:Gtk.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 <see cref="T:Gtk.Widget" />, and it will eventually move out of the Gtk# distribution.
</para>
<para>
<see cref="T:Gtk.InputDialog" /> displays a <see cref="T:Gtk.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>
<see cref="T:Gtk.InputDialog" /> contains two <see cref="T:Gtk.Button" />s to which the application can connect; one for closing the <see cref="T:Gtk.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>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InputDialog (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of InputDialog, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public InputDialog ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates an instance of <see cref="T:Gtk.InputDialog" /></summary>
<returns>an object of type <see cref="T:Gtk.InputDialog" /></returns>
<remarks>Creates an instance of <see cref="T:Gtk.InputDialog" /></remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gtk.InputDialog" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gtk.InputDialog" /> class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="DisableDevice">
<MemberSignature Language="C#" Value="public event GtkSharp.DisableDeviceHandler DisableDevice;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.DisableDeviceHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED.</summary>
<remarks>
This signal is emitted when the user changes the mode of a device from a GDK_MODE_SCREEN or GDK_MODE_WINDOW to GDK_MODE_ENABLED.
</remarks>
</Docs>
</Member>
<Member MemberName="EnableDevice">
<MemberSignature Language="C#" Value="public event GtkSharp.EnableDeviceHandler EnableDevice;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>GtkSharp.EnableDeviceHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW.</summary>
<remarks>
This signal is emitted when the user changes the mode of a device from GDK_MODE_DISABLED to a GDK_MODE_SCREEN or GDK_MODE_WINDOW.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected InputDialog (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of InputDialog, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.InputDialog" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>