GtkSharp/doc/en/Gdk/Pointer.xml

108 lines
4.5 KiB
XML
Raw Normal View History

<Type Name="Pointer" FullName="Gdk.Pointer">
<TypeSignature Language="C#" Value="public class Pointer" 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>Class containing static methods for grabbing and ungrabbing the pointer as well as checking IsGrabbed status.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Ungrab">
<MemberSignature Language="C#" Value="public static void Ungrab (uint time_);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Ungrab the pointer.</summary>
<param name="time_">a <see cref="T:System.UInt32" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName="Grab">
<MemberSignature Language="C#" Value="public static Gdk.GrabStatus Grab (Gdk.Window window, bool owner_events, Gdk.EventMask event_mask, Gdk.Window confine_to, Gdk.Cursor cursor, uint time_);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.GrabStatus</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="owner_events" Type="System.Boolean" />
<Parameter Name="event_mask" Type="Gdk.EventMask" />
<Parameter Name="confine_to" Type="Gdk.Window" />
<Parameter Name="cursor" Type="Gdk.Cursor" />
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Try to grab pointer. Returns <see cref="T:Gdk.GrabStatus" /> enumeratioion value.</summary>
<param name="window">a <see cref="T:Gdk.Window" /></param>
<param name="owner_events">a <see cref="T:System.Boolean" /></param>
<param name="event_mask">a <see cref="T:Gdk.EventMask" /></param>
<param name="confine_to">a <see cref="T:Gdk.Window" /></param>
<param name="cursor">a <see cref="T:Gdk.Cursor" /></param>
<param name="time_">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gdk.GrabStatus" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pointer ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor.</summary>
<returns>a <see cref="T:Gdk.Pointer" /></returns>
<remarks>Class contains only static methods.</remarks>
</Docs>
</Member>
<Member MemberName="IsGrabbed">
<MemberSignature Language="C#" Value="public static bool IsGrabbed { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Readonly property indicating if pointer is grabbed.</summary>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GrabInfoLibgtkOnly">
<MemberSignature Language="C#" Value="public static bool GrabInfoLibgtkOnly (Gdk.Display display, Gdk.Window grab_window, out bool owner_events);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="grab_window" Type="Gdk.Window" />
<Parameter Name="owner_events" Type="System.Boolean&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="grab_window">a <see cref="T:Gdk.Window" /></param>
<param name="owner_events">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>