GtkSharp/doc/en/Gtk/InputDialog.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>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <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 override 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="DisableDevice">
      <MemberSignature Language="C#" Value="public event Gtk.DisableDeviceHandler DisableDevice;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.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 Gtk.EnableDeviceHandler EnableDevice;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.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="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.InputDialog" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnEnableDevice">
      <MemberSignature Language="C#" Value="protected virtual void OnEnableDevice (Gdk.Device device);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="device" Type="Gdk.Device" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.InputDialog.EnableDevice" /> event.</summary>
        <param name="device">a <see cref="T:Gdk.Device" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.InputDialog.EnableDevice" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnDisableDevice">
      <MemberSignature Language="C#" Value="protected virtual void OnDisableDevice (Gdk.Device device);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="device" Type="Gdk.Device" />
      </Parameters>
      <Docs>
        <summary>Default handler for the <see cref="M:Gtk.InputDialog.DisableDevice" /> event.</summary>
        <param name="device">a <see cref="T:Gdk.Device" /></param>
        <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.InputDialog.DisableDevice" /> event.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected InputDialog (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Protected Constructor.</summary>
        <param name="gtype">a <see cref="T:GLib.GType" /></param>
        <returns>a <see cref="T:Gtk.InputDialog" /></returns>
        <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SaveButton">
      <MemberSignature Language="C#" Value="public Gtk.Button SaveButton { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Button</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The save button in this dialog.</summary>
        <returns>a <see cref="T:Gtk.Button" /></returns>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="CloseButton">
      <MemberSignature Language="C#" Value="public Gtk.Button CloseButton { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Button</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The "close window" button in this dialog.</summary>
        <returns>a <see cref="T:Gtk.Button" /></returns>
        <remarks/>
      </Docs>
    </Member>
  </Members>
</Type>