GtkSharp/doc/en/Gtk/Grab.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

76 lines
3.4 KiB
XML

<Type Name="Grab" FullName="Gtk.Grab">
<TypeSignature Language="C#" Value="public class Grab" Maintainer="auto" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Grab extends System.Object" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Grab methods allow you to limit the keyboard and mouse interaction to a particular widget or window.</summary>
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Grab ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Don't use.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public static void Add (Gtk.Widget widget);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Add(class Gtk.Widget widget) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
</Parameters>
<Docs>
<param name="widget">The <see cref="T:Gtk.Widget" /> that grabs keyboard and pointer events.</param>
<summary>Makes the specified widget the currently grabbed widget. This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events are delivered to this widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Current">
<MemberSignature Language="C#" Value="public static Gtk.Widget Current { get; }" />
<MemberSignature Language="ILAsm" Value=".property class Gtk.Widget Current" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>Queries the current grab of the default window group.</summary>
<value>A <see cref="T:Gtk.Widget" /> which currently has the grab or <see langword="null" /> if no grab is active.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public static void Remove (Gtk.Widget widget);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Remove(class Gtk.Widget widget) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
</Parameters>
<Docs>
<param name="widget">The <see cref="T:Gtk.Widget" /> which gives up the grab.</param>
<summary>Removes the grab from the given widget. You have to pair calls to <see cref="T:Gtk.Grab.Add" /> and <see cref="T:Gtk.Grab.Remove" />.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>