## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Action_Group

- Goto spec source

# Description

    package Gtk.Action_Group is

Actions are organised into groups. An action group is essentially a map from names to Gtk_Action objects.

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.

Accelerators are handled by the GTK+ accelerator map. All actions are assigned an accelerator path (which normally has the form "<Actions>/group-name/action-name") and a shortcut is associated with this accelerator path. All menu items and tool items take on this accelerator path. The GTK+ accelerator map code makes sure that the correct shortcut is displayed next to the menu item.

Binding from C File version 2.8.17

# Classes

### Gtk_Action_Group_Record

- Goto declaration in source

    type Gtk_Action_Group_Record is new Glib.Object.GObject_Record with
         null record;

#### Ancestors:

Glib.Object.GObject_Record

#### Primitive operations:

Add_Action

- To API doc
- To spec

Add_Action_With_Accel

- To API doc
- To spec

Add_Actions

- To API doc
- To spec

Add_Radio_Actions

- To API doc
- To spec

Add_Toggle_Actions

- To API doc
- To spec

Get_Action

- To API doc
- To spec

Get_Name

- To API doc
- To spec

Get_Sensitive

- To API doc
- To spec

Get_Visible

- To API doc
- To spec

Glib.Object.Deallocate

- To API doc
- To spec

(Inherited)
Glib.Object.Get_Type

- To API doc
- To spec

(Inherited)
Glib.Object.Notify

- To API doc
- To spec

(Inherited)
Glib.Object.Ref

- To API doc
- To spec

(Inherited)
Glib.Object.Ref_Sink

- To API doc
- To spec

(Inherited)
Glib.Object.Unref

- To API doc
- To spec

(Inherited)
List_Actions

- To API doc
- To spec

Remove_Action

- To API doc
- To spec

Set_Sensitive

- To API doc
- To spec

Set_Translation_Domain

- To API doc
- To spec

Set_Visible

- To API doc
- To spec

# Types

### Gtk_Action_Group

- Goto declaration in source

    type Gtk_Action_Group is access all Gtk_Action_Group_Record'Class;

### Action_Entry

- Goto declaration in source
- Goto full declaration in source

    type Action_Entry        is private;

### Radio_Action_Entry

- Goto declaration in source
- Goto full declaration in source

    type Radio_Action_Entry  is private;

### Toggle_Action_Entry

- Goto declaration in source
- Goto full declaration in source

    type Toggle_Action_Entry is private;

An opaque structure describing an action entry

### Action_Entry_Array

- Goto declaration in source

    type Action_Entry_Array is array (Natural range <>) of Action_Entry;

### Radio_Action_Entry_Array

- Goto declaration in source

    type Radio_Action_Entry_Array
         is array (Natural range <>) of Radio_Action_Entry;

### Toggle_Action_Entry_Array

- Goto declaration in source

    type Toggle_Action_Entry_Array
         is array (Natural range <>) of Toggle_Action_Entry;

### Action_Callback

- Goto declaration in source

    type Action_Callback is access procedure
         (Action : System.Address; User_Data : System.Address);

### Radio_Action_Callback

- Goto declaration in source

    type Radio_Action_Callback is access procedure
         (Group     : access Gtk.Action.Gtk_Action_Record'Class;
          Current   : access Gtk.Action.Gtk_Action_Record'Class;
          User_Data : System.Address);

Called when an element of the Gtk_Radio_Action group is selected

# Constants & Global variables

### Name_Property

- Goto declaration in source

(Glib.Properties.Property_String)

    Name_Property      : constant Glib.Properties.Property_String;

### Sensitive_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Sensitive_Property : constant Glib.Properties.Property_Boolean;

### Visible_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Visible_Property   : constant Glib.Properties.Property_Boolean;

### Signal_Connect_Proxy

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Connect_Proxy    : constant Glib.Signal_Name := "connect_proxy";

### Signal_Disconnect_Proxy

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Disconnect_Proxy : constant Glib.Signal_Name := "disconnect_proxy";

### Signal_Post_Activate

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Post_Activate    : constant Glib.Signal_Name := "post_activate";

### Signal_Pre_Activate

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Pre_Activate     : constant Glib.Signal_Name := "pre_activate";

# Subprograms & Entries

### Gtk_New

- Goto spec in source

    procedure Gtk_New (Group: out Gtk_Action_Group;Name: String);

### Initialize

- Goto spec in source

    procedure Initialize (Group: access Gtk_Action_Group_Record'Class;Name: String);

Creates a new Gtk_Action_Group object. The name of the action group is used when associating keybindings with the actions.

### Get_Type

- Goto spec in source
- Goto body in source

    function Get_Type return GType;

Return the internal value associated with a Gtk_Action_Group.

### Get_Action

- Goto spec in source

    function Get_Action (Action_Group: access Gtk_Action_Group_Record;Action_Name: String) return Gtk.Action.Gtk_Action;

Looks up an action in the action group by name, or null if no such action exists.

### Get_Name

- Goto spec in source

    function Get_Name (Action_Group: access Gtk_Action_Group_Record) return String;

Gets the name of the action group.

### Set_Sensitive

- Goto spec in source

    procedure Set_Sensitive (Action_Group: access Gtk_Action_Group_Record;Sensitive: Boolean);

### Get_Sensitive

- Goto spec in source

    function Get_Sensitive (Action_Group: access Gtk_Action_Group_Record) return Boolean;

Returns True if the group is sensitive. The constituent actions can only be logically sensitive (see Gtk.Action.Is_Sensitive) if they are sensitive (see Gtk.Action.Get_Sensitive) and their group is sensitive.

### Set_Visible

- Goto spec in source

    procedure Set_Visible (Action_Group: access Gtk_Action_Group_Record;Visible: Boolean);

### Get_Visible

- Goto spec in source

    function Get_Visible (Action_Group: access Gtk_Action_Group_Record) return Boolean;

Returns True if the group is visible. The constituent actions can only be logically visible (see Gtk.Action.Is_Visible) if they are visible (see Gtk.Action.Get_Visible) and their group is visible.

### List_Actions

- Goto spec in source

    function List_Actions (Action_Group: access Gtk_Action_Group_Record) return Glib.Object.Object_Simple_List.Glist;

Lists the actions in the action group. The returned list must be freed by the user.

### Set_Translation_Domain

- Goto spec in source

    procedure Set_Translation_Domain (Action_Group: access Gtk_Action_Group_Record;Domain: String);

Sets the translation domain and uses dgettext() for translating the Label and Tooltip of Gtk_Action_Entry's added by Add_Actions.

### Create

- Goto spec in source

    function Create (Name: String;Label: String := "";Stock_Id: String := "";Accelerator: String := "";Tooltip: String := "";Callback: Action_Callback := null) return Action_Entry;

Create a new Action_Entry. The returned value must be freed by the caller.

### Create

- Goto spec in source

    function Create (Name: String;Label: String := "";Stock_Id: String := "";Accelerator: String := "";Tooltip: String := "";Callback: Action_Callback := null;Is_Active: Boolean := True) return Toggle_Action_Entry;

Create a new Action_Entry. The returned value must be freed by the caller. Is_Active is the initial state of the button.

### Create

- Goto spec in source

    function Create (Name: String;Label: String;Stock_Id: String := "";Accelerator: String := "";Tooltip: String := "";Value: Glib.Gint) return Radio_Action_Entry;

Create a new Radio_Action_Entry. Value is the value set on the radio action (see Gtk.Radio_Action.Get_Current_Value)

### Free

- Goto spec in source

    procedure Free (Action: in out Action_Entry);

### Free

- Goto spec in source

    procedure Free (Actions: in out Action_Entry_Array);

### Free

- Goto spec in source

    procedure Free (Action: in out Radio_Action_Entry);

### Free

- Goto spec in source

    procedure Free (Actions: in out Radio_Action_Entry_Array);

### Free

- Goto spec in source

    procedure Free (Action: in out Toggle_Action_Entry);

### Free

- Goto spec in source

    procedure Free (Actions: in out Toggle_Action_Entry_Array);

Free Action and Actions

### Add_Action

- Goto spec in source

    procedure Add_Action (Action_Group: access Gtk_Action_Group_Record;Action: access Gtk.Action.Gtk_Action_Record'Class);

Adds an action object to the action group. 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 Gtk.Action.Set_Accel_Path, or use Add_Action_With_Accel.

### Remove_Action

- Goto spec in source

    procedure Remove_Action (Action_Group: access Gtk_Action_Group_Record;Action: access Gtk.Action.Gtk_Action_Record'Class);

Removes an action object from the action group.

### Add_Action_With_Accel

- Goto spec in source

    procedure Add_Action_With_Accel (Action_Group: access Gtk_Action_Group_Record;Action: access Gtk.Action.Gtk_Action_Record'Class;Accelerator: String := "");

Adds an action object to the action group and sets up the accelerator. If Accelerator is unspecified, attempts to use the accelerator associated with the stock_id of the action. Accel paths are set to <Actions>/group-name/action-name.

### Add_Actions

- Goto spec in source

    procedure Add_Actions (Action_Group: access Gtk_Action_Group_Record;Entries: Action_Entry_Array;User_Data: System.Address := System.Null_Address;Destroy: Glib.G_Destroy_Notify_Address := null);

This is a convenience function to create a number of actions and add them to the action group. Destroy is called when User_Data is no longer needed. The "activate" signals of the actions are connected to the callbacks in Entries, and their accel paths are set to <Actions>/group-name/action-name.

### Add_Radio_Actions

- Goto spec in source

    procedure Add_Radio_Actions (Action_Group: access Gtk_Action_Group_Record;Entries: Radio_Action_Entry_Array;Value: Glib.Gint;On_Change: Radio_Action_Callback;User_Data: System.Address := System.Null_Address;Destroy: Glib.G_Destroy_Notify_Address := null);

This is a convenience routine to create a group of radio actions and add them to the action group. The "changed" signal of the first radio action is connected to the On_Change callback and the accel paths of the actions are set to <Actions>/group-name/action-name Value is the value of the action to activate initially, or -1 if no action should be activated. Destroy is called when User_Data is no longer necessary.

### Add_Toggle_Actions

- Goto spec in source

    procedure Add_Toggle_Actions (Action_Group: access Gtk_Action_Group_Record;Entries: Toggle_Action_Entry_Array;User_Data: System.Address := System.Null_Address;Destroy: Glib.G_Destroy_Notify_Address := null);

This is a convenience function to create a number of toggle actions and add them to the action group. The "activate" signals of the actions are connected to the callbacks and their accel paths are set to <Actions>/group-name/action-name. Destroy is called when User_Data is no longer necessary.