GtkSharp/doc/en/Gdk/Keyboard.xml
Mike Kestner 04ec18f4f4 updates to latest monodocer -pretty
svn path=/trunk/gtk-sharp/; revision=71141
2007-01-16 15:28:18 +00:00

86 lines
4.2 KiB
XML

<Type Name="Keyboard" FullName="Gdk.Keyboard">
<TypeSignature Language="C#" Value="public class Keyboard" Maintainer="auto" />
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<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>Ungrabs the keyboard, if it is grabbed by this application.</summary>
<param name="time_">a timestamp from a <see cref="T:Gdk.Event" />, or <see cref="M:Gdk.EventDND.Time" /> if no timestamp is available.</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Grab">
<MemberSignature Language="C#" Value="public static Gdk.GrabStatus Grab (Gdk.Window window, bool owner_events, 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="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with <see cref="M:Gdk.Keyboard.Grab" />. This overrides any previous keyboard grab by this client.</summary>
<param name="window">the <see cref="T:Gdk.Window" /> which will own the grab (the grab window).</param>
<param name="owner_events">if false then all keyboard events are reported with respect to window. If true then keyboard events for this application are reported as normal, but keyboard events outside this application are reported with respect to window. Both key press and key release events are always reported, independant of the event mask set by the application.</param>
<param name="time_">a timestamp from a <see cref="T:Gdk.Event" /> or <see cref="M:Gdk.EventDND.Time" /> if no timestamp is available.</param>
<returns>a <see cref="M:Gdk.GrabStatus.Success" /> if the grab was successful.</returns>
<remarks>Documentation for this section has not yet been entered.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Keyboard ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</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>
<since version="Gtk# 2.6" />
</Docs>
</Member>
</Members>
</Type>