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

167 lines
7.2 KiB
XML

<Type Name="AccelKey" FullName="Gtk.AccelKey">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct AccelKey : IEquatable&lt;Gtk.AccelKey&gt;" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit AccelKey extends System.ValueType implements class System.IEquatable`1&lt;valuetype Gtk.AccelKey&gt;" />
<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.ValueType</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable&lt;Gtk.AccelKey&gt;</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>A class for holding information about a key that gets used as an accelerator.</summary>
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AccelKey (Gdk.Key key, Gdk.ModifierType mods, Gtk.AccelFlags flags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Gdk.Key key, valuetype Gdk.ModifierType mods, valuetype Gtk.AccelFlags flags) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="key" Type="Gdk.Key" />
<Parameter Name="mods" Type="Gdk.ModifierType" />
<Parameter Name="flags" Type="Gtk.AccelFlags" />
</Parameters>
<Docs>
<param name="key">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.Key" /></param>
<param name="mods">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.ModifierType" />, the modifiers (shift, ctrl, etc) that apply for this AccelKey</param>
<param name="flags">a <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.AccelFlags" /> for whether this AccelKey should be displayed in the menu</param>
<summary>Public constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AccelFlags">
<MemberSignature Language="C#" Value="public Gtk.AccelFlags AccelFlags { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.AccelFlags AccelFlags" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelFlags</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The flags for this AccelKey that determine whether <see cref="T:Gtk.AccelLabel" /> will display it.</summary>
<value>a <see cref="T:Gtk.AccelFlags" /></value>
<remarks />
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="AccelMods">
<MemberSignature Language="C#" Value="public Gdk.ModifierType AccelMods;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype Gdk.ModifierType AccelMods" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.ModifierType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A mask of the modifier keys that are relevant for this AccelKey.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Gtk.AccelKey other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(valuetype Gtk.AccelKey other) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Gtk.AccelKey" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object other) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="System.Object" />
</Parameters>
<Docs>
<param name="other">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public Gdk.Key Key;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype Gdk.Key Key" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gdk.Key</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The main keyboard key to use for this AccelKey.</summary>
<remarks>Useful values are <see cref="T:System.Int32" /> enumerated in <see cref="T:Gdk.Key" />.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.AccelKey New (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Gtk.AccelKey New(native int raw) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">an <see cref="T:IntPtr" /></param>
<summary>Make a new AccelKey object with the object key specified by <paramref name="raw" />.</summary>
<returns>An object of type <see cref="T:Gtk.AccelKey" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static Gtk.AccelKey Zero;" />
<MemberSignature Language="ILAsm" Value=".field public static valuetype Gtk.AccelKey Zero" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelKey</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Make a new AccelKey object that has no global object key.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>