Ryujinx-GtkSharp/doc/en/Gdk/Device.xml
Miguel de Icaza e9ef63ae4c From Todd Berman
svn path=/trunk/gtk-sharp/; revision=30500
2004-06-29 04:45:04 +00:00

255 lines
10 KiB
XML

<Type Name="Device" FullName="Gdk.Device">
<TypeSignature Language="C#" Value="public class Device : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-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>This class contains a detailed description of an extended input device.</summary>
<remarks>None.</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>Frees an array of <see cref="T:Gdk.TimeCoord" /> that was returned by <see cref="M:Gdk.Device.GetHistory" />.</summary>
<param name="events">An array of <see cref="T:Gdk.TimeCoord" /></param>
<param name="n_events">Length of the array.</param>
<remarks>None.</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="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 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="CorePointer">
<MemberSignature Language="C#" Value="public static Gdk.Device CorePointer { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Device</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the core pointer device for the default display.</summary>
<returns>the core pointer device.</returns>
<remarks>None.</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>Sets the source type for an input device.</summary>
<param name="value">Sets the source type for an input device.</param>
<returns>None.</returns>
<remarks>None.</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>
<Member MemberName="GetState">
<MemberSignature Language="C#" Value="public void GetState (Gdk.Window window, out double axes, out 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&amp;" RefType="out" />
<Parameter Name="mask" Type="Gdk.ModifierType&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="axes">a <see cref="T:System.Double&amp;" /></param>
<param name="mask">a <see cref="T:Gdk.ModifierType&amp;" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetAxis">
<MemberSignature Language="C#" Value="public bool GetAxis (out double axes, Gdk.AxisUse use, out double value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="axes" Type="System.Double&amp;" RefType="out" />
<Parameter Name="use" Type="Gdk.AxisUse" />
<Parameter Name="value" Type="System.Double&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>Interprets an array of double as axis values for a given device, and locates the value in the array for a given axis use.</summary>
<param name="axes">An array of axes.</param>
<param name="use">The <see cref="T:Gdk.AxisUse" /> to look for.</param>
<param name="value">Found value.</param>
<returns>True if the given axis use was found, otherwise false.</returns>
<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, out 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&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="start">a <see cref="T:System.UInt32" /></param>
<param name="stop">a <see cref="T:System.UInt32" /></param>
<param name="events">a <see cref="T:Gdk.TimeCoord" /></param>
<param name="n_events">a <see cref="T:System.Int32&amp;" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</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:Gdk.Device" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Device (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gdk.Device" /></returns>
<remarks>This is a constructor used by derivative types of <see cref="T:Gdk.Device" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Device ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor.</summary>
<returns>A new <see cref="T:Gdk.Device" /></returns>
<remarks>None.</remarks>
</Docs>
</Member>
</Members>
</Type>