Gtk::Action Class Reference

An action which can be triggered by a menu or toolbar item. More...

Inherited by Gtk::RecentAction, and Gtk::ToggleAction.

Collaboration diagram for Gtk::Action:

Public Types
typedef sigc::slot< void >	SlotActivate
	For instance, void on_activate();.
Public Member Functions
virtual	~Action ()
GtkAction*	gobj ()
	Provides access to the underlying C GObject.
const GtkAction*	gobj () const
	Provides access to the underlying C GObject.
GtkAction*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring	get_name () const
	Returns the name of the action.
bool	is_sensitive () const
	Returns whether the action is effectively sensitive.
bool	get_sensitive () const
	Returns whether the action itself is sensitive.
void	set_sensitive (bool sensitive=true)
	Sets the sensitive property of the action to sensitive.
bool	is_visible () const
	Returns whether the action is effectively visible.
bool	get_visible () const
	Returns whether the action itself is visible.
void	set_visible (bool visible=true)
	Sets the visible property of the action to visible.
void	activate ()
	Emits the "activate" signal on the specified action, if it isn't insensitive.
Image*	create_icon (IconSize icon_size)
	This function is intended for use by action implementations to create icons displayed in the proxy widgets.
MenuItem*	create_menu_item ()
	Creates a menu item widget that proxies for the given action.
ToolItem*	create_tool_item ()
	Creates a toolbar item widget that proxies for the given action.
Menu*	create_menu ()
	If action provides a Gtk::Menu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu.
void	connect_proxy (Widget& proxy)
	Connects a widget to an action object as a proxy.
void	disconnect_proxy (Widget& proxy)
	Disconnects a proxy widget from an action.
Glib::SListHandle< Widget* >	get_proxies ()
	Returns the proxy widgets for an action.
Glib::SListHandle< const Widget* >	get_proxies () const
	Returns the proxy widgets for an action.
void	connect_accelerator ()
	Installs the accelerator for action if action has an accel path and group.
void	disconnect_accelerator ()
	Undoes the effect of one call to connect_accelerator().
Glib::ustring	get_accel_path () const
	Returns the accel path for this action.
Glib::SignalProxy0< void >	signal_activate ()
	The "activate" signal is emitted when the action is activated.
void	set_accel_path (const Glib::ustring& accel_path)
	Sets the accel path for this action.
void	set_accel_group (const Glib::RefPtr< AccelGroup >& accel_group)
	Sets the Gtk::AccelGroup in which the accelerator for this action will be installed.
void	set_label (const Glib::ustring& label)
	Sets the label of action.
Glib::ustring	get_label () const
	Gets the label text of action.
void	set_short_label (const Glib::ustring& short_label)
	Sets a shorter label text on action.
Glib::ustring	get_short_label () const
	Gets the short label text of action.
void	set_tooltip (const Glib::ustring& tooltip)
	Sets the tooltip text on action.
Glib::ustring	get_tooltip () const
	Gets the tooltip text of action.
void	set_stock_id (const StockID& stock_id)
	Sets the stock id on action.
StockID	get_stock_id () const
	Gets the stock id of action.
void	set_gicon (const Glib::RefPtr< Gio::Icon >& icon)
	Sets the icon of action.
Glib::RefPtr< Gio::Icon >	get_gicon ()
	Gets the gicon of action.
Glib::RefPtr< const Gio::Icon >	get_gicon () const
	Gets the gicon of action.
void	set_icon_name (const Glib::ustring& icon_name)
	Sets the icon name on action.
Glib::ustring	get_icon_name () const
	Gets the icon name of action.
void	set_visible_horizontal (bool visible_horizontal=true)
	Sets whether action is visible when horizontal.
bool	get_visible_horizontal () const
	Checks whether action is visible when horizontal.
void	set_visible_vertical (bool visible_vertical=true)
	Sets whether action is visible when vertical.
bool	get_visible_vertical () const
	Checks whether action is visible when horizontal.
void	set_is_important (bool is_important=true)
	Sets whether the action is important, this attribute is used primarily by toolbar items to decide whether to show a label or not.
bool	get_is_important () const
	Checks whether action is important or not.
void	set_always_show_image (bool always_show=true)
	Sets whether action's menu item proxies will ignore the Gtk::Settings:gtk-menu-images setting and always show their image, if available.
bool	get_always_show_image () const
	Returns whether action's menu item proxies will ignore the Gtk::Settings:gtk-menu-images setting and always show their image, if available.
void	block_activate ()
	Disable activation signals from the action.
void	unblock_activate ()
	Reenable activation signals from the action.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_name () const
	A unique name for the action.
Glib::PropertyProxy < Glib::ustring >	property_label ()
	The label used for menu items and buttons that activate this action.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_label () const
	The label used for menu items and buttons that activate this action.
Glib::PropertyProxy < Glib::ustring >	property_short_label ()
	A shorter label that may be used on toolbar buttons.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_short_label () const
	A shorter label that may be used on toolbar buttons.
Glib::PropertyProxy < Glib::ustring >	property_tooltip ()
	A tooltip for this action.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_tooltip () const
	A tooltip for this action.
Glib::PropertyProxy< StockID >	property_stock_id ()
	The stock icon displayed in widgets representing this action.
Glib::PropertyProxy_ReadOnly < StockID >	property_stock_id () const
	The stock icon displayed in widgets representing this action.
Glib::PropertyProxy < Glib::RefPtr< Gio::Icon > >	property_gicon ()
	The GIcon being displayed.
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Gio::Icon > >	property_gicon () const
	The GIcon being displayed.
Glib::PropertyProxy < Glib::ustring >	property_icon_name ()
	The name of the icon from the icon theme.
Glib::PropertyProxy_ReadOnly < Glib::ustring >	property_icon_name () const
	The name of the icon from the icon theme.
Glib::PropertyProxy< bool >	property_visible_horizontal ()
	Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
Glib::PropertyProxy_ReadOnly < bool >	property_visible_horizontal () const
	Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
Glib::PropertyProxy< bool >	property_visible_vertical ()
	Whether the toolbar item is visible when the toolbar is in a vertical orientation.
Glib::PropertyProxy_ReadOnly < bool >	property_visible_vertical () const
	Whether the toolbar item is visible when the toolbar is in a vertical orientation.
Glib::PropertyProxy< bool >	property_visible_overflown ()
	When TRUE.
Glib::PropertyProxy_ReadOnly < bool >	property_visible_overflown () const
	When TRUE.
Glib::PropertyProxy< bool >	property_is_important ()
	Whether the action is considered important.
Glib::PropertyProxy_ReadOnly < bool >	property_is_important () const
	Whether the action is considered important.
Glib::PropertyProxy< bool >	property_hide_if_empty ()
	When TRUE.
Glib::PropertyProxy_ReadOnly < bool >	property_hide_if_empty () const
	When TRUE.
Glib::PropertyProxy< bool >	property_sensitive ()
	Whether the action is enabled.
Glib::PropertyProxy_ReadOnly < bool >	property_sensitive () const
	Whether the action is enabled.
Glib::PropertyProxy< bool >	property_visible ()
	Whether the action is visible.
Glib::PropertyProxy_ReadOnly < bool >	property_visible () const
	Whether the action is visible.
Glib::PropertyProxy < Glib::RefPtr< ActionGroup > >	property_action_group ()
	The GtkActionGroup this GtkAction is associated with.
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< ActionGroup > >	property_action_group () const
	The GtkActionGroup this GtkAction is associated with.
Glib::PropertyProxy< bool >	property_always_show_image ()
	Whether the image will always be shown.
Glib::PropertyProxy_ReadOnly < bool >	property_always_show_image () const
	Whether the image will always be shown.
Static Public Member Functions
static Glib::RefPtr< Action >	create ()
static Glib::RefPtr< Action >	create (const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
	Creates an action.
static Glib::RefPtr< Action >	create (const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
	Creates an action with a stock ID.
static Glib::RefPtr< Action >	create_with_icon_name (const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label, const Glib::ustring& tooltip)
	Create an action with an icon name.
Protected Member Functions
	Action ()
	Creates an empty action.
	Action (const Glib::ustring& name, const StockID& stock_id=StockID(), const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
	Creates an action with a stock ID.
	Action (const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
	Creates an action with an icon name.
void	block_activate_from (Widget& proxy)
	Disables calls to the activate() function by signals on the given proxy widget.
void	unblock_activate_from (Widget& proxy)
	Re-enables calls to the activate() function by signals on the given proxy widget.
virtual Widget*	create_menu_item_vfunc ()
virtual Widget*	create_tool_item_vfunc ()
virtual void	connect_proxy_vfunc (Widget* proxy)
virtual void	disconnect_proxy_vfunc (Widget* proxy)
virtual void	on_activate ()
Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::Action >	wrap (GtkAction* object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

An action which can be triggered by a menu or toolbar item.

Actions represent operations that the user can perform, along with some information about how it should be presented in the user 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 is activated, the following is also associated with the action:

a name (not translated, for path lookup)
a label (translated, for display)
an accelerator
whether the 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 Gtk::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.

Member Typedef Documentation

typedef sigc::slot<void> Gtk::Action::SlotActivate

For instance, void on_activate();.

Constructor & Destructor Documentation

virtual Gtk::Action::~Action ( ) [virtual]

Gtk::Action::Action ( ) [protected]

Creates an empty action.

Gtk::Action::Action	(	const Glib::ustring &	name,
		const StockID&	stock_id = `StockID()`,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)			`[explicit, protected]`

Creates an action with a stock ID.

The stock ID is used to set a default icon, text and accelerator for the action.

Parameters:

	name	A unique name for the action.
	stock_id	The stock icon to display in widgets representing the action.
	label	The label displayed in menu items and on buttons.
	tooltip	A tooltip for the action.

Gtk::Action::Action	(	const Glib::ustring &	name,
		const Glib::ustring &	icon_name,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)			`[explicit, protected]`

Creates an action with an icon name.

The action's icon will reflect the specified icon name in the user's icon theme.

Parameters:

	name	A unique name for the action.
	icon_name	An IconTheme icon name used for widgets representing the action.
	label	The label displayed in menu items and on buttons.
	tooltip	A tooltip for the action.

Member Function Documentation

void Gtk::Action::activate ( )

Emits the "activate" signal on the specified action, if it isn't insensitive.

This gets called by the proxy widgets when they get activated.

It can also be used to manually activate an action.

Since gtkmm 2.4:

void Gtk::Action::block_activate ( )

Disable activation signals from the action.

This is needed when updating the state of your proxy Gtk::Activatable widget could result in calling activate(), this is a convenience function to avoid recursing in those cases (updating toggle state for instance).

Since gtkmm 2.16:

void Gtk::Action::block_activate_from ( Widget& proxy ) [protected]

Disables calls to the activate() function by signals on the given proxy widget.

This is used to break notification loops for things like check or radio actions.

This function is intended for use by action implementations.

Since gtkmm 2.4:

Deprecated: 2.16: activatables are now responsible for activating the action directly so this doesnt apply anymore.

Parameters:

proxy

A proxy widget.

void Gtk::Action::connect_accelerator ( )

Installs the accelerator for action if action has an accel path and group.

See set_accel_path() and set_accel_group()

Since multiple proxies may independently trigger the installation of the accelerator, the action counts the number of times this function has been called and doesn't remove the accelerator until disconnect_accelerator() has been called as many times.

Since gtkmm 2.4:

void Gtk::Action::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.

If the widget is already connected to an action, it is disconnected first.

Since gtkmm 2.4:

Deprecated: 2.16: Use Gtk::Activatable::set_related_action() instead.

Parameters:

proxy

The proxy widget.

virtual void Gtk::Action::connect_proxy_vfunc ( Widget* proxy ) [protected, virtual]

static Glib::RefPtr<Action> Gtk::Action::create	(	const Glib::ustring &	name,
		const Gtk::StockID&	stock_id,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)			`[static]`

Creates an action with a stock ID.

The stock ID is used to set a default icon, text and accelerator for the action.

Parameters:

	name	A unique name for the action.
	stock_id	The stock icon to display in widgets representing the action.
	label	The label displayed in menu items and on buttons.
	tooltip	A tooltip for the action.

Returns:: A new Action.

Reimplemented in Gtk::RecentAction.

static Glib::RefPtr<Action> Gtk::Action::create	(	const Glib::ustring &	name,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)			`[static]`

Creates an action.

Parameters:

	name	A unique name for the action.
	label	The label displayed in menu items and on buttons.
	tooltip	A tooltip for the action.

Returns:: A new Action.

Reimplemented in Gtk::RecentAction.

static Glib::RefPtr<Action> Gtk::Action::create ( ) [static]

Reimplemented in Gtk::RadioAction, Gtk::RecentAction, and Gtk::ToggleAction.

Image* Gtk::Action::create_icon ( IconSize icon_size )

This function is intended for use by action implementations to create icons displayed in the proxy widgets.

Since gtkmm 2.4:

Parameters:

icon_size

The size of the icon that should be created.

Returns:: A widget that displays the icon for this action.

Menu* Gtk::Action::create_menu ( )

If action provides a Gtk::Menu widget as a submenu for the menu item or the toolbar item it creates, this function returns an instance of that menu.

Since gtkmm 2.12:

Returns:: The menu item provided by the action, or 0.

MenuItem* Gtk::Action::create_menu_item ( )

Creates a menu item widget that proxies for the given action.

Since gtkmm 2.4:

Returns:: A menu item connected to the action.

virtual Widget* Gtk::Action::create_menu_item_vfunc ( ) [protected, virtual]

ToolItem* Gtk::Action::create_tool_item ( )

Creates a toolbar item widget that proxies for the given action.

Since gtkmm 2.4:

Returns:: A toolbar item connected to the action.

virtual Widget* Gtk::Action::create_tool_item_vfunc ( ) [protected, virtual]

static Glib::RefPtr<Action> Gtk::Action::create_with_icon_name	(	const Glib::ustring &	name,
		const Glib::ustring &	icon_name,
		const Glib::ustring &	label,
		const Glib::ustring &	tooltip
	)			`[static]`

Create an action with an icon name.

The action's icon will reflect the specified icon name in the user's icon theme.

Parameters:

	name	A unique name for the action.
	icon_name	An IconTheme icon name used for widgets representing the action.
	label	The label displayed in menu items and on buttons.
	tooltip	A tooltip for the action.