Action

Object Hierarchy:

Description:

public class Action : Object, Buildable

Actions represent operations that the user can be perform, along with some information how it should be presented in the interface. Each action provides methods to create icons, menu items and toolbar items representing itself.

As well as the callback that is called when the action gets activated, the following also gets associated with the action:

a name (not translated, for path lookup)
a label (translated, for display)
an accelerator
whether label indicates a stock id
a tooltip (optional, translated)
a toolbar label (optional, shorter than label)

The action will also have some state information:

visible (shown/hidden)
sensitive (enabled/disabled)

Apart from regular actions, there are toggle
actions, which can be toggled between two states and radio actions, of which only one in a group can be in the "active" state. Other actions can be implemented as Action subclasses.

Each action can have one or more proxy menu item, toolbar button or other proxy widgets. Proxies mirror the state of the action (text label, tooltip, icon, visible, sensitive, etc), and should change when the action's state changes. When the proxy is activated, it should activate its action.

All known sub-classes:

RadioAction

RecentAction

ToggleAction

Namespace: Gtk

Package: gtk+-2.0

Content:

Properties:

public ActionGroup action_group { set; owned get; }
public bool always_show_image { construct set; get; }
If true, the action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available.
public Icon gicon { set; get; }
The Icon displayed in the Action.
public bool hide_if_empty { set; get; }
public string icon_name { set; get; }
The name of the icon from the icon theme.
public bool is_important { set; get; }
public string label { set; get; }
The label used for menu items and buttons that activate this action. If the label is null , GTK+ uses the stock label specified via the stock-id property.
public string name { construct set; get; }
public bool sensitive { set; get; }
public string short_label { set; get; }
A shorter label that may be used on toolbar buttons.
public string stock_id { set; get; }
The stock icon displayed in widgets representing this action.
public string tooltip { set; get; }
public bool visible { set; get; }
public bool visible_horizontal { set; get; }
public bool visible_overflown { set; get; }
When true, toolitem proxies for this action are represented in the toolbar overflow menu.
public bool visible_vertical { set; get; }

Creation methods:

public Action (string name, string? label, string? tooltip, string? stock_id)
Creates a new Action object. To add the action to a ActionGroup and set the accelerator for the action, call add_action_with_accel. See XML-UI for information on allowed action names.

Methods:

public void block_activate ()
Disable activation signals from the action
public void connect_accelerator ()
Installs the accelerator for action if action has an accel path and group. See set_accel_path and set_accel_group
public virtual void connect_proxy (Widget proxy)
Connects a widget to an action object as a proxy. Synchronises various properties of the action with the widget (such as label text, icon, tooltip, etc), and attaches a callback so that the action gets activated when the proxy widget does.
public weak Widget create_icon (IconSize icon_size)
This function is intended for use by action implementations to create icons displayed in the proxy widgets.
public virtual weak Widget create_menu ()
If action provides a Menu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu.
public virtual weak Widget create_menu_item ()
Creates a menu item widget that proxies for the given action.
public virtual weak Widget create_tool_item ()
Creates a toolbar item widget that proxies for the given action.
public void disconnect_accelerator ()
Undoes the effect of one call to connect_accelerator.
public virtual void disconnect_proxy (Widget proxy)
Disconnects a proxy widget from an action. Does not destroy the widget, however.
public weak Closure get_accel_closure ()
Returns the accel closure for this action.
public unowned string get_accel_path ()
Returns the accel path for this action.
public bool get_always_show_image ()
Returns whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available.
public weak Icon get_gicon ()
Gets the gicon of action.
public unowned string get_icon_name ()
Gets the icon name of action.
public bool get_is_important ()
Checks whether action is important or not
public unowned string get_label ()
Gets the label text of action.
public unowned SList<Widget> get_proxies ()
Returns the proxy widgets for an action. See also gtk_widget_get_action.
public bool get_sensitive ()
Returns whether the action itself is sensitive. Note that this doesn't necessarily mean effective sensitivity. See is_sensitive for that.
public unowned string get_short_label ()
Gets the short label text of action.
public unowned string get_stock_id ()
Gets the stock id of action.
public unowned string get_tooltip ()
Gets the tooltip text of action.
public bool get_visible ()
Returns whether the action itself is visible. Note that this doesn't necessarily mean effective visibility. See is_sensitive for that.
public bool get_visible_horizontal ()
Checks whether action is visible when horizontal
public bool get_visible_vertical ()
Checks whether action is visible when horizontal
public bool is_sensitive ()
Returns whether the action is effectively sensitive.
public bool is_visible ()
Returns whether the action is effectively visible.
public void set_accel_group (AccelGroup accel_group)
Sets the AccelGroup in which the accelerator for this action will be installed.
public void set_accel_path (string accel_path)
Sets the accel path for this action. All proxy widgets associated with the action will have this accel path, so that their accelerators are consistent.
public void set_always_show_image (bool always_show)
Sets whether action's menu item proxies will ignore the GtkSettings:gtk-menu-images setting and always show their image, if available.
public void set_gicon (Icon icon)
Sets the icon of action.
public void set_icon_name (string icon_name)
Sets the icon name on action
public void set_is_important (bool is_important)
Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not.
public void set_label (string label)
Sets the label of action.
public void set_sensitive (bool sensitive)
Sets the ::sensitive property of the action to sensitive. Note that this doesn't necessarily mean effective sensitivity. See is_sensitive for that.
public void set_short_label (string short_label)
Sets a shorter label text on action.
public void set_stock_id (string stock_id)
Sets the stock id on action
public void set_tooltip (string tooltip)
Sets the tooltip text on action
public void set_visible (bool visible)
Sets the ::visible property of the action to visible. Note that this doesn't necessarily mean effective visibility. See is_visible for that.
public void set_visible_horizontal (bool visible_horizontal)
Sets whether action is visible when horizontal
public void set_visible_vertical (bool visible_vertical)
Sets whether action is visible when vertical
public void unblock_activate ()
Reenable activation signals from the action

Signals:

public virtual void activate ()
The "activate" signal is emitted when the action is activated.