GtkSharp/doc/en/Gtk/ActionEntry.xml
Shane Landrum 382369538c 2004-12-31 Shane Landrum <epicene@pobox.com>
* en/Gtk/FileSystem.xml: Wording tweak.
	* en/Gtk/ActionGroup.xml
	* en/Gtk/Action.xml
	* en/Gtk/ActionEntry.xml
	* en/Gtk/AccelGroup.xml
	* en/Gtk/AccelMap.xml: Added docs.

svn path=/trunk/gtk-sharp/; revision=38218
2004-12-31 19:36:13 +00:00

162 lines
7.2 KiB
XML

<Type Name="ActionEntry" FullName="Gtk.ActionEntry">
<TypeSignature Language="C#" Value="public sealed struct ActionEntry" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>2.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>A struct containing all the info necessary for creating an <see cref="T:Gtk.Action" /></summary>
<remarks>
<para>The ActionEntry struct is C# "syntactic sugar", designed to make it easier for developers to add <see cref="T:Gtk.Action" />s to their code.</para>
<para>Instead of creating a new <see cref="T:Gtk.Action" /> object for each action, a developer can create an array of ActionEntry's and add them to an <see cref="T:Gtk.ActionGroup" /> all at once using the <see cref="M:Gtk.ActionGroup.Add" /> method.</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName="name">
<MemberSignature Language="C#" Value="public string name;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A unique name for the action.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="stock_id">
<MemberSignature Language="C#" Value="public string stock_id;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The stock icon displayed in widgets representing this action.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="label">
<MemberSignature Language="C#" Value="public string label;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The label used for menu items and buttons that activate this action.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="tooltip">
<MemberSignature Language="C#" Value="public string tooltip;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A tooltip for this action.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="accelerator">
<MemberSignature Language="C#" Value="public string accelerator;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The accelerator for the action, in the format understood by <see cref="M:Gtk.Accelerator.Parse()" />, or "" for no accelerator, or <see langword="null" /> to use the stock accelerator.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="activated">
<MemberSignature Language="C#" Value="public EventHandler activated;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>EventHandler to be called when the action is triggered.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActionEntry (string name, string stock_id);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="stock_id" Type="System.String" />
</Parameters>
<Docs>
<summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActionEntry (string name, string stock_id, EventHandler activated);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="activated" Type="System.EventHandler" />
</Parameters>
<Docs>
<summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<param name="activated">a <see cref="T:System.EventHandler" />, a handler to run when the action is activated</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActionEntry (string name, string stock_id, string label, string accelerator, string tooltip, EventHandler activated);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="label" Type="System.String" />
<Parameter Name="accelerator" Type="System.String" />
<Parameter Name="tooltip" Type="System.String" />
<Parameter Name="activated" Type="System.EventHandler" />
</Parameters>
<Docs>
<summary>Public constructor.</summary>
<param name="name">a <see cref="T:System.String" />, a unique name</param>
<param name="stock_id">a <see cref="T:System.String" />, a stock icon</param>
<param name="label">a <see cref="T:System.String" />, label text</param>
<param name="accelerator">a <see cref="T:System.String" />, an accelerator sequence</param>
<param name="tooltip">a <see cref="T:System.String" />, tooltip text</param>
<param name="activated">a <see cref="T:System.EventHandler" />, a handler to run when the action is activated</param>
<returns>a <see cref="T:Gtk.ActionEntry" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>