GtkSharp/doc/en/Gdk/Device.xml

311 lines
12 KiB
XML
Raw Normal View History

<Type Name="Device" FullName="Gdk.Device">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Device : GLib.Object" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</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>
</Interfaces>
<Members>
<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=".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>
<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>
<value>the core pointer device.</value>
<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="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>
<value>a <see cref="T:GLib.GType" /></value>
<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>
<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>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Device ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor.</summary>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Source">
<MemberSignature Language="C#" Value="public Gdk.InputSource Source { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.InputSource</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Gdk.InputSource" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Mode">
<MemberSignature Language="C#" Value="public Gdk.InputMode Mode { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.InputMode</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Gdk.InputMode" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="HasCursor">
<MemberSignature Language="C#" Value="public bool HasCursor { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NumAxes">
<MemberSignature Language="C#" Value="public int NumAxes { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NumKeys">
<MemberSignature Language="C#" Value="public int NumKeys { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetAxis">
<MemberSignature Language="C#" Value="public bool GetAxis (double[] axes, Gdk.AxisUse use, out 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&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="axes">a <see cref="T:System.Double" /></param>
<param name="use">a <see cref="T:System.Int32" /></param>
<param name="value">a <see cref="T:System.Double" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<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[]" /></param>
<param name="mask">a <see cref="T:Gdk.ModifierType" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetDeviceAxis">
<MemberSignature Language="C#" Value="public Gdk.DeviceAxis GetDeviceAxis (uint axis);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.DeviceAxis</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="axis" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="axis">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gdk.DeviceAxis" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetDeviceKey">
<MemberSignature Language="C#" Value="public Gdk.DeviceKey GetDeviceKey (uint axis);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.DeviceKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="axis" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="axis">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gdk.DeviceKey" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetHistory">
<MemberSignature Language="C#" Value="public Gdk.TimeCoord[] GetHistory (Gdk.Window window, uint start, uint stop);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.TimeCoord[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="start" Type="System.UInt32" />
<Parameter Name="stop" Type="System.UInt32" />
</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>
<returns>a <see cref="T:Gdk.TimeCoord[]" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>