GtkSharp/doc/en/Gdk/Device.xml

254 lines
9.8 KiB
XML
Raw Normal View History

<Type Name="Device" FullName="Gdk.Device">
<TypeSignature Language="C#" Value="public class Device : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="FreeHistory">
<MemberSignature Language="C#" Value="public static void FreeHistory (Gdk.TimeCoord events, int n_events);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="events" Type="Gdk.TimeCoord" />
<Parameter Name="n_events" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="events">To be added: an object of type 'Gdk.TimeCoord'</param>
<param name="n_events">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetHistory">
<MemberSignature Language="C#" Value="public bool GetHistory (Gdk.Window window, uint start, uint stop, Gdk.TimeCoord events, int n_events);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="start" Type="System.UInt32" />
<Parameter Name="stop" Type="System.UInt32" />
<Parameter Name="events" Type="Gdk.TimeCoord" />
<Parameter Name="n_events" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="start">To be added: an object of type 'uint'</param>
<param name="stop">To be added: an object of type 'uint'</param>
<param name="events">To be added: an object of type 'Gdk.TimeCoord'</param>
<param name="n_events">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetMode">
<MemberSignature Language="C#" Value="public bool SetMode (Gdk.InputMode mode);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="mode" Type="Gdk.InputMode" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="mode">To be added: an object of type 'Gdk.InputMode'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetAxis">
<MemberSignature Language="C#" Value="public bool GetAxis (double axes, Gdk.AxisUse use, double value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="axes" Type="System.Double" />
<Parameter Name="use" Type="Gdk.AxisUse" />
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="axes">To be added: an object of type 'double'</param>
<param name="use">To be added: an object of type 'Gdk.AxisUse'</param>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetState">
<MemberSignature Language="C#" Value="public void GetState (Gdk.Window window, double axes, Gdk.ModifierType mask);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="axes" Type="System.Double" />
<Parameter Name="mask" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="axes">To be added: an object of type 'double'</param>
<param name="mask">To be added: an object of type 'Gdk.ModifierType'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<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 Device (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 Device, 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="protected Device ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Device'</returns>
<remarks>To be added</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 GLib Type for Gdk.Device</summary>
<returns>The GLib Type for the Gdk.Device class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="CorePointer">
<MemberSignature Language="C#" Value="public static Gdk.Device CorePointer { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Device</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Device'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public Gdk.InputSource Source { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.InputSource</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.InputSource'</param>
<returns>To be added: an object of type 'Gdk.InputSource'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Device (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 Device, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gdk.Device" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetKey">
<MemberSignature Language="C#" Value="public void SetKey (uint index_, uint keyval, Gdk.ModifierType modifiers);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.UInt32" />
<Parameter Name="keyval" Type="System.UInt32" />
<Parameter Name="modifiers" Type="Gdk.ModifierType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.UInt32" /></param>
<param name="keyval">a <see cref="T:System.UInt32" /></param>
<param name="modifiers">a <see cref="T:Gdk.ModifierType" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetAxisUse">
<MemberSignature Language="C#" Value="public void SetAxisUse (uint index_, Gdk.AxisUse use);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index_" Type="System.UInt32" />
<Parameter Name="use" Type="Gdk.AxisUse" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="index_">a <see cref="T:System.UInt32" /></param>
<param name="use">a <see cref="T:Gdk.AxisUse" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>