GtkSharp/doc/en/Gdk/EventKey.xml

115 lines
4.1 KiB
XML
Raw Normal View History

<Type Name="EventKey" FullName="Gdk.EventKey">
<TypeSignature Language="C#" Value="public sealed struct EventKey;" 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>Describes a key press or key release event.</summary>
<remarks>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gdk.Event</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public Gdk.Key Key { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Key</ReturnType>
</ReturnValue>
<Docs>
<summary>The key that was pressed or released.</summary>
<returns>The key that was pressed or released.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Time">
<MemberSignature Language="C#" Value="public uint Time { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The time of the event in milliseconds.</summary>
<returns>The time of the event in milliseconds.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C#" Value="public Gdk.ModifierType State { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.ModifierType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A enum representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons.</summary>
<returns>A enum representing the state of the modifier keys (e.g. Control, Shift and Alt) and the pointer buttons.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="KeyValue">
<MemberSignature Language="C#" Value="public uint KeyValue { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The key that was pressed or released.</summary>
<returns>The key that was pressed or released.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="HardwareKeycode">
<MemberSignature Language="C#" Value="public ushort HardwareKeycode { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The raw code of the key that was pressed or released.</summary>
<returns>The raw code of the key that was pressed or released.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Group">
<MemberSignature Language="C#" Value="public byte Group { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The keyboard group.</summary>
<returns>The keyboard group.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventKey (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor.</summary>
<param name="raw">raw unmanaged pointer.</param>
<returns>A new <see cref="T:Gdk.EventKey" /></returns>
<remarks>None.</remarks>
</Docs>
</Member>
</Members>
</Type>