GtkSharp/doc/en/Gtk/ActionGroup.xml

<Type Name="ActionGroup" FullName="Gtk.ActionGroup">
  <TypeSignature Language="C#" Value="public class ActionGroup : GLib.Object, IWrapper, IDisposable" 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 group of actions</summary>
    <remarks>
      <para>
        <para>
Actions are organised into groups. An action group is essentially a map from names to <see cref="T:Gtk.Action" /> objects.
</para>
        <para>
All actions that would make sense to use in a particular context should be in a single group. Multiple action groups may be used for a particular user interface. In fact, it is expected that most nontrivial applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each window's menus would be constructed from a combination of two action groups.
</para>
        <para>
Accelerators are handled by the Gtk accelerator map. All actions are assigned an accelerator path (which normally has the form &lt;Actions&gt;/group-name/action-name) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The Gtk accelerator map code makes sure that the correct shortcut is displayed next to the menu item. 
</para>
      </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="Finalize">
      <MemberSignature Language="C#" Value="protected override void Finalize ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Disposes the resources associated with this <see cref="T:Gtk.ActionGroup" /> object.</summary>
        <remarks>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SetTranslateFunc">
      <MemberSignature Language="C#" Value="public void SetTranslateFunc (Gtk.TranslateFunc func, IntPtr data, Gtk.DestroyNotify notify);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="func" Type="Gtk.TranslateFunc" />
        <Parameter Name="data" Type="System.IntPtr" />
        <Parameter Name="notify" Type="Gtk.DestroyNotify" />
      </Parameters>
      <Docs>
        <summary>Sets a function to be used for translating the label and tooltip of GtkActionGroupEntrys added by <see cref="M:Gtk.ActionGroup.AddActions()" />.</summary>
        <param name="func">a <see cref="T:Gtk.TranslateFunc" /></param>
        <param name="data">a <see cref="T:System.IntPtr" /></param>
        <param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
        <remarks>If you are using gettext(), it is enough to set the translation domain with <see cref="P:Gtk.ActionGroup.TranslationDomain" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Remove">
      <MemberSignature Language="C#" Value="public void Remove (Gtk.Action action);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="action" Type="Gtk.Action" />
      </Parameters>
      <Docs>
        <summary>Removes an action object from the action group.</summary>
        <param name="action">a <see cref="T:Gtk.Action" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (Gtk.Action action, string accelerator);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="action" Type="Gtk.Action" />
        <Parameter Name="accelerator" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Adds an action object to the action group and sets up the accelerator.</summary>
        <param name="action">a <see cref="T:Gtk.Action" /></param>
        <param name="accelerator">a <see cref="T:System.String" />.  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</param>
        <remarks>
          <para>
            <para>
If accelerator is <see langword="null" />, attempts to use the accelerator associated with the stock_id of the action.
</para>
            <para>
Accel paths are set to &lt;Actions&gt;/group-name/action-name.
</para>
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="GetAction">
      <MemberSignature Language="C#" Value="public Gtk.Action GetAction (string action_name);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Action</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="action_name" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Looks up an action in the action group by name.</summary>
        <param name="action_name">a <see cref="T:System.String" />,  the name of the action</param>
        <returns>a <see cref="T:Gtk.Action" />,  or <see langword="null" /> if no action by that name exists</returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (Gtk.Action action);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="action" Type="Gtk.Action" />
      </Parameters>
      <Docs>
        <summary>Adds an action object to the action group.</summary>
        <param name="action">a <see cref="T:Gtk.Action" /></param>
        <remarks>Note that this function does not set up the accel path of the action, which can lead to problems if a user tries to modify the accelerator of a menuitem associated with the action.
Therefore you must either set the accel path yourself with <see cref="P:Gtk.Action.AccelPath" />, or use <see cref="M:Gtk.ActionGroup.Add(Gtk.Action,System.String)" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected ActionGroup (GLib.GType gtype);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="gtype" Type="GLib.GType" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="gtype">a <see cref="T:GLib.GType" /></param>
        <returns>a <see cref="T:Gtk.ActionGroup" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ActionGroup (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="raw">a <see cref="T:System.IntPtr" /></param>
        <returns>a <see cref="T:Gtk.ActionGroup" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ActionGroup (string name);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="name" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Creates a new <see cref="T:Gtk.ActionGroup" /> object.</summary>
        <param name="name">a <see cref="T:System.String" />,  the name of the action group.</param>
        <returns>a <see cref="T:Gtk.ActionGroup" /></returns>
        <remarks>The name of the action group is used when associating keybindings with the actions.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.ActionGroup" />.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Visible">
      <MemberSignature Language="C#" Value="public bool Visible { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The visibility of the ActionGroup</summary>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>The constituent actions can only be logically visible (see <see cref="P:Gtk.Action.IsVisible" />) if they are visible (see <see cref="P:Gtk.Action.Visible" />) and their group is visible.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Sensitive">
      <MemberSignature Language="C#" Value="public bool Sensitive { set; get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The sensitivity of the ActionGroup</summary>
        <returns>a <see cref="T:System.Boolean" /></returns>
        <remarks>The constituent actions can only be logically sensitive (see <see cref="P:Gtk.Action.IsSensitive" />) if they are sensitive (see <see cref="P:Gtk.Action.Sensitive" />) and their group is sensitive.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the name of the action group.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="TranslationDomain">
      <MemberSignature Language="C#" Value="public string TranslationDomain { set; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Sets the translation domain and uses dgettext() for translating the label and tooltip of <see cref="T:Gtk.ActionEntry" />s added by <see cref="M:Gtk.ActionGroup.AddActions()" />.</summary>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (Gtk.ActionEntry[] entries);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="entries" Type="Gtk.ActionEntry[]" />
      </Parameters>
      <Docs>
        <summary>Ease of use function for adding multiple <see cref="T:Gtk.Action" />s in a single call using the <see cref="T:Gtk.ActionEntry" /> struct.</summary>
        <param name="entries">a <see cref="T:Gtk.ActionEntry" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (Gtk.ToggleActionEntry[] entries);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="entries" Type="Gtk.ToggleActionEntry[]" />
      </Parameters>
      <Docs>
        <summary>Ease of use function for adding multiple <see cref="T:Gtk.ToggleAction" />s in a single call using the <see cref="T:Gtk.ToggleActionEntry" /> struct.</summary>
        <param name="entries">a <see cref="T:Gtk.ToggleActionEntry" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public void Add (Gtk.RadioActionEntry[] entries, int value, Gtk.ChangedHandler changed);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="entries" Type="Gtk.RadioActionEntry[]" />
        <Parameter Name="value" Type="System.Int32" />
        <Parameter Name="changed" Type="Gtk.ChangedHandler" />
      </Parameters>
      <Docs>
        <summary>Ease of use function for adding multiple <see cref="T:Gtk.RadioAction" />s in a single call using the <see cref="T:Gtk.RadioActionEntry" /> struct.</summary>
        <param name="entries">a <see cref="T:Gtk.RadioActionEntry" /></param>
        <param name="value">a <see cref="T:System.Int32" /></param>
        <param name="changed">a <see cref="T:Gtk.ChangedHandler" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="ListActions">
      <MemberSignature Language="C#" Value="public Gtk.Action[] ListActions ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gtk.Action[]</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets a list of the <see cref="T:Gtk.Action" />s in the <see cref="T:Gtk.ActionGroup" />.</summary>
        <returns>a <see cref="T:Gtk.Action[]" /></returns>
        <remarks>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>