GtkSharp/doc/en/Gtk/AccelKey.xml

105 lines
4.1 KiB
XML
Raw Normal View History

<Type Name="AccelKey" FullName="Gtk.AccelKey">
<TypeSignature Language="C#" Maintainer="auto" Value="public struct AccelKey" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.0.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>A class for holding information about a key that gets used as an accelerator.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Zero">
<MemberSignature Language="C#" Value="public static 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>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gtk.AccelKey New (IntPtr raw);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Make a new AccelKey object with the object key specified by <paramref name="raw" />.</summary>
<param name="raw">an <see cref="T:IntPtr" /></param>
<returns>An object of type <see cref="T:Gtk.AccelKey" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="AccelMods">
<MemberSignature Language="C#" Value="public 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="AccelFlags">
* generator/StructBase.cs: update field-generation logic a bit * generator/CodeGenerator.cs: add a --glue-includes flag * generator/GenerationInfo.cs: Accept glue_includes value from Main and output it to the glue_filename. * generator/FieldBase.cs (Ignored): handle more ignorable cases. (CheckGlue): New method to figure out what kind of glue we'll need for a field. (GenerateImports): generate appropriate imports per CheckGlue. (GenerateGlue): Generate C glue for accessing a struct field; either a fully-C-based accessor, or a method to just return the field's offset in the struct. (Generate): Use the generated glue to read the field. * generator/PropertyBase.cs (CType): if the field is a single bit, set its type to gboolean. * generator/ObjectGen.cs (Generate): * generator/OpaqueGen.cs (Generate): Call GenFields. * generator/StructField.cs: Use FieldBase's glue-generation code to handle bitfields. [#54489] * generator/ObjectField.cs: Generates accessors for public fields of objects and opaque structs. [#69514] * generator/ClassBase.cs (ClassBase): Parse <fields> nodes and create ObjectField objects. (GenFields): Output field properties (IgnoreMethod): Ignore Get/Set methods that duplicate fields * generator/Makefile.am (sources): update * {gdk,gnome,gtk,pango}/*.metadata: Mark some additional fields as public. Rename/retype some fields for consistency with earlier hand-coded bindings. * {gdk,gnome,gtk,pango}/*.custom: Remove custom methods that can now be autogenerated. * {gdk,gnome,gtk,pango}/glue/*.c: Remove glue methods that can now be autogenerated * {gdk,glade,gnome,gtk,pango,vte}/Makefile.am * {gdk,glade,gnome,gtk,pango,vte}/glue/Makefile.am * {gdk,gnome,gtk,pango}/glue/makefile.win32: Update svn path=/trunk/gtk-sharp/; revision=44563
2005-05-16 14:28:55 +00:00
<MemberSignature Language="C#" Value="public Gtk.AccelFlags AccelFlags { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AccelFlags</ReturnType>
</ReturnValue>
* generator/StructBase.cs: update field-generation logic a bit * generator/CodeGenerator.cs: add a --glue-includes flag * generator/GenerationInfo.cs: Accept glue_includes value from Main and output it to the glue_filename. * generator/FieldBase.cs (Ignored): handle more ignorable cases. (CheckGlue): New method to figure out what kind of glue we'll need for a field. (GenerateImports): generate appropriate imports per CheckGlue. (GenerateGlue): Generate C glue for accessing a struct field; either a fully-C-based accessor, or a method to just return the field's offset in the struct. (Generate): Use the generated glue to read the field. * generator/PropertyBase.cs (CType): if the field is a single bit, set its type to gboolean. * generator/ObjectGen.cs (Generate): * generator/OpaqueGen.cs (Generate): Call GenFields. * generator/StructField.cs: Use FieldBase's glue-generation code to handle bitfields. [#54489] * generator/ObjectField.cs: Generates accessors for public fields of objects and opaque structs. [#69514] * generator/ClassBase.cs (ClassBase): Parse <fields> nodes and create ObjectField objects. (GenFields): Output field properties (IgnoreMethod): Ignore Get/Set methods that duplicate fields * generator/Makefile.am (sources): update * {gdk,gnome,gtk,pango}/*.metadata: Mark some additional fields as public. Rename/retype some fields for consistency with earlier hand-coded bindings. * {gdk,gnome,gtk,pango}/*.custom: Remove custom methods that can now be autogenerated. * {gdk,gnome,gtk,pango}/glue/*.c: Remove glue methods that can now be autogenerated * {gdk,glade,gnome,gtk,pango,vte}/Makefile.am * {gdk,glade,gnome,gtk,pango,vte}/glue/Makefile.am * {gdk,gnome,gtk,pango}/glue/makefile.win32: Update svn path=/trunk/gtk-sharp/; revision=44563
2005-05-16 14:28:55 +00:00
<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 />
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public 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=".ctor">
<MemberSignature Language="C#" Value="public AccelKey (Gdk.Key key, Gdk.ModifierType mods, Gtk.AccelFlags flags);" />
<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>
<summary>Public constructor.</summary>
<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>
<remarks />
</Docs>
</Member>
</Members>
</Type>