logo top
Main Page   Widgets   Namespaces   Book  

Gtk::Action Class Reference

Inheritance diagram for Gtk::Action:

List of all members.


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:

The action will also have some state information:

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.

Public Types

typedef sigc::slot<void> SlotActivate
 For instance, void on_activate();.

Public Member Functions

void activate ()
 Emits the "activate" signal on the specified action, if it isn't insensitive.
void block_activate ()
 Disable activation signals from the action.
void connect_accelerator ()
 Installs the accelerator for action if action has an accel path and group.
void connect_proxy (Widget& proxy)
 Connects a widget to an action object as a proxy.
Imagecreate_icon (IconSize icon_size)
 This function is intended for use by action implementations to create icons displayed in the proxy widgets.
Menucreate_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.
MenuItemcreate_menu_item ()
 Creates a menu item widget that proxies for the given action.
ToolItemcreate_tool_item ()
 Creates a toolbar item widget that proxies for the given action.
void disconnect_accelerator ()
 Undoes the effect of one call to connect_accelerator().
void disconnect_proxy (Widget& proxy)
 Disconnects a proxy widget from an action.
Glib::ustring get_accel_path () const
 Returns: the accel path for this action, or 0.
Glib::RefPtr<const Gio::Iconget_gicon () const
 Gets the gicon of action.
Glib::RefPtr<Gio::Iconget_gicon ()
 Gets the gicon of action.
Glib::ustring get_icon_name () const
 Gets the icon name of action.
bool get_is_important () const
 Checks whether action is important or not.
Glib::ustring get_label () const
 Gets the label text of action.
Glib::ustring get_name () const
 Return value: the name of the action.
Glib::SListHandle<const Widget*> get_proxies () const
 Return value: a SList of proxy widgets.
Glib::SListHandle<Widget*> get_proxies ()
 Return value: a SList of proxy widgets.
bool get_sensitive () const
 Return value: true if the action itself is sensitive.
Glib::ustring get_short_label () const
 Gets the short label text of action.
StockID get_stock_id () const
 Gets the stock id of action.
Glib::ustring get_tooltip () const
 Gets the tooltip text of action.
bool get_visible () const
 Return value: true if the action itself is visible.
bool get_visible_horizontal () const
 Checks whether action is visible when horizontal.
bool get_visible_vertical () const
 Checks whether action is visible when horizontal.
const GtkAction* gobj () const
 Provides access to the underlying C GObject.
GtkAction* gobj ()
 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.
bool is_sensitive () const
 Return value: true if the action and its associated action group.
bool is_visible () const
 Return value: true if the action and its associated action group.
Glib::PropertyProxy_ReadOnly
<Glib::RefPtr<ActionGroup>> 
property_action_group () const
 The GtkActionGroup this GtkAction is associated with.
Glib::PropertyProxy
<Glib::RefPtr<ActionGroup>> 
property_action_group ()
 The GtkActionGroup this GtkAction is associated with.
Glib::PropertyProxy_ReadOnly
<Glib::RefPtr<Gio::Icon>> 
property_gicon () const
 The GIcon being displayed.
Glib::PropertyProxy
<Glib::RefPtr<Gio::Icon>> 
property_gicon ()
 The GIcon being displayed.
Glib::PropertyProxy_ReadOnly
<bool> 
property_hide_if_empty () const
 When TRUE.
Glib::PropertyProxy<bool> property_hide_if_empty ()
 When TRUE.
Glib::PropertyProxy_ReadOnly
<Glib::ustring
property_icon_name () const
 The name of the icon from the icon theme.
Glib::PropertyProxy
<Glib::ustring
property_icon_name ()
 The name of the icon from the icon theme.
Glib::PropertyProxy_ReadOnly
<bool> 
property_is_important () const
 Whether the action is considered important.
Glib::PropertyProxy<bool> property_is_important ()
 Whether the action is considered important.
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_label ()
 The label used for menu items and buttons that activate this action.
Glib::PropertyProxy_ReadOnly
<Glib::ustring
property_name () const
 A unique name for the action.
Glib::PropertyProxy_ReadOnly
<bool> 
property_sensitive () const
 Whether the action is enabled.
Glib::PropertyProxy<bool> property_sensitive ()
 Whether the action is enabled.
Glib::PropertyProxy_ReadOnly
<Glib::ustring
property_short_label () const
 A shorter label that may be used on toolbar buttons.
Glib::PropertyProxy
<Glib::ustring
property_short_label ()
 A shorter label that may be used on toolbar buttons.
Glib::PropertyProxy_ReadOnly
<StockID
property_stock_id () const
 The stock icon displayed in widgets representing this action.
Glib::PropertyProxy<StockIDproperty_stock_id ()
 The stock icon displayed in widgets representing this action.
Glib::PropertyProxy_ReadOnly
<Glib::ustring
property_tooltip () const
 A tooltip for this action.
Glib::PropertyProxy
<Glib::ustring
property_tooltip ()
 A tooltip for this action.
Glib::PropertyProxy_ReadOnly
<bool> 
property_visible () const
 Whether the action is visible.
Glib::PropertyProxy<bool> property_visible ()
 Whether the action is visible.
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_horizontal ()
 Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
Glib::PropertyProxy_ReadOnly
<bool> 
property_visible_overflown () const
 When TRUE.
Glib::PropertyProxy<bool> property_visible_overflown ()
 When TRUE.
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_vertical ()
 Whether the toolbar item is visible when the toolbar is in a vertical orientation.
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_accel_path (const Glib::ustring& accel_path)
 Sets the accel path for this action.
void set_gicon (const Glib::RefPtr<Gio::Icon>& icon)
 Sets the icon of action.
void set_icon_name (const Glib::ustring& icon_name)
 Sets the icon name on action.
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.
void set_label (const Glib::ustring& label)
 Sets the label of action.
void set_sensitive (bool sensitive=true)
 Sets the sensitive property of the action to sensitive.
void set_short_label (const Glib::ustring& short_label)
 Sets a shorter label text on action.
void set_stock_id (const StockID& stock_id)
 Sets the stock id on action.
void set_tooltip (const Glib::ustring& tooltip)
 Sets the tooltip text on action.
void set_visible (bool visible=true)
 Sets the visible property of the action to visible.
void set_visible_horizontal (bool visible_horizontal=true)
 Sets whether action is visible when horizontal.
void set_visible_vertical (bool visible_vertical=true)
 Sets whether action is visible when vertical.
Glib::SignalProxy0<void> signal_activate ()
 The "activate" signal is emitted when the action is activated.
void unblock_activate ()
 Reenable activation signals from the action.
virtual ~Action ()

Static Public Member Functions

static Glib::RefPtr<Actioncreate (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<Actioncreate (const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 Creates an action.
static Glib::RefPtr<Actioncreate ()
static Glib::RefPtr<Actioncreate_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 (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.
 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 ()
 Creates an empty action.
void block_activate_from (Widget& proxy)
 Disables calls to the activate() function by signals on the given proxy widget.
virtual void connect_proxy_vfunc (Widget* proxy)
virtual Widgetcreate_menu_item_vfunc ()
virtual Widgetcreate_tool_item_vfunc ()
virtual void disconnect_proxy_vfunc (Widget* proxy)
virtual void on_activate ()
void unblock_activate_from (Widget& proxy)
 Re-enables calls to the activate() function by signals on the given proxy widget.

Related Functions

(Note that these are not member functions.)

Glib::RefPtr<Gtk::Actionwrap (GtkAction* object, bool take_copy=false)
 A Glib::wrap() method for this object.


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.
Deprecated:
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]

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.

Parameters:
icon_size The size of the icon that should be created.
Returns:
A widget that displays the icon for this action.
Since gtkmm 2.4:

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.

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

MenuItem* Gtk::Action::create_menu_item (  ) 

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

Returns:
A menu item connected to the action.
Since gtkmm 2.4:

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.

Returns:
A toolbar item connected to the action.
Since gtkmm 2.4:

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.
Returns:
A new Action.

void Gtk::Action::disconnect_accelerator (  ) 

Undoes the effect of one call to connect_accelerator().

Since gtkmm 2.4:

void Gtk::Action::disconnect_proxy ( Widget proxy  ) 

Disconnects a proxy widget from an action.

Does <emphasis>not</emphasis> destroy the widget, however.

Since gtkmm 2.4:
Deprecated 2.16: Use Gtk::Activatable::set_related_action() instead.
Parameters:
proxy The proxy widget.

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

Glib::ustring Gtk::Action::get_accel_path (  )  const

Returns: the accel path for this action, or 0.

Returns:
The accel path for this action, or 0 if none is set. The returned string is owned by GTK+ and must not be freed or modified.

Glib::RefPtr<const Gio::Icon> Gtk::Action::get_gicon (  )  const

Gets the gicon of action.

Returns:
The action's Icon if one is set.
Since gtkmm 2.16:

Glib::RefPtr<Gio::Icon> Gtk::Action::get_gicon (  ) 

Gets the gicon of action.

Returns:
The action's Icon if one is set.
Since gtkmm 2.16:

Glib::ustring Gtk::Action::get_icon_name (  )  const

Gets the icon name of action.

Returns:
The icon name
Since gtkmm 2.16:

bool Gtk::Action::get_is_important (  )  const

Checks whether action is important or not.

Returns:
Whether action is important
Since gtkmm 2.16:

Glib::ustring Gtk::Action::get_label (  )  const

Gets the label text of action.

Returns:
The label text
Since gtkmm 2.16:

Glib::ustring Gtk::Action::get_name (  )  const

Return value: the name of the action.

The string belongs to GTK+ and should not

Returns:
The name of the action. The string belongs to GTK+ and should not be freed.
Since gtkmm 2.4:

Glib::SListHandle<const Widget*> Gtk::Action::get_proxies (  )  const

Return value: a SList of proxy widgets.

The list is owned by GTK+

Returns:
A SList of proxy widgets. The list is owned by GTK+ and must not be modified.
Since gtkmm 2.4:

Glib::SListHandle<Widget*> Gtk::Action::get_proxies (  ) 

Return value: a SList of proxy widgets.

The list is owned by GTK+

Returns:
A SList of proxy widgets. The list is owned by GTK+ and must not be modified.
Since gtkmm 2.4:

bool Gtk::Action::get_sensitive (  )  const

Return value: true if the action itself is sensitive.

Returns:
true if the action itself is sensitive.
Since gtkmm 2.4:

Glib::ustring Gtk::Action::get_short_label (  )  const

Gets the short label text of action.

Parameters:
label The label text to set.
Returns:
The short label text.
Since gtkmm 2.16:

StockID Gtk::Action::get_stock_id (  )  const

Gets the stock id of action.

Returns:
The stock id
Since gtkmm 2.16:

Glib::ustring Gtk::Action::get_tooltip (  )  const

Gets the tooltip text of action.

Returns:
The tooltip text
Since gtkmm 2.16:

bool Gtk::Action::get_visible (  )  const

Return value: true if the action itself is visible.

Returns:
true if the action itself is visible.
Since gtkmm 2.4:

bool Gtk::Action::get_visible_horizontal (  )  const

Checks whether action is visible when horizontal.

Returns:
Whether action is visible when horizontal
Since gtkmm 2.16:

bool Gtk::Action::get_visible_vertical (  )  const

Checks whether action is visible when horizontal.

Returns:
Whether action is visible when horizontal
Since gtkmm 2.16:

const GtkAction* Gtk::Action::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

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

GtkAction* Gtk::Action::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

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

GtkAction* Gtk::Action::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

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

bool Gtk::Action::is_sensitive (  )  const

Return value: true if the action and its associated action group.

Returns:
true if the action and its associated action group are both sensitive.
Since gtkmm 2.4:

bool Gtk::Action::is_visible (  )  const

Return value: true if the action and its associated action group.

Returns:
true if the action and its associated action group are both visible.
Since gtkmm 2.4:

virtual void Gtk::Action::on_activate (  )  [protected, virtual]

Glib::PropertyProxy_ReadOnly<Glib::RefPtr<ActionGroup>> Gtk::Action::property_action_group (  )  const

The GtkActionGroup this GtkAction is associated with.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::RefPtr<ActionGroup>> Gtk::Action::property_action_group (  ) 

The GtkActionGroup this GtkAction is associated with.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Gio::Icon> > Gtk::Action::property_gicon (  )  const

The GIcon being displayed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy< Glib::RefPtr<Gio::Icon> > Gtk::Action::property_gicon (  ) 

The GIcon being displayed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_hide_if_empty (  )  const

When TRUE.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_hide_if_empty (  ) 

When TRUE.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::Action::property_icon_name (  )  const

The name of the icon from the icon theme.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gtk::Action::property_icon_name (  ) 

The name of the icon from the icon theme.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_is_important (  )  const

Whether the action is considered important.

When TRUE

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_is_important (  ) 

Whether the action is considered important.

When TRUE

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::Action::property_label (  )  const

The label used for menu items and buttons that activate this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gtk::Action::property_label (  ) 

The label used for menu items and buttons that activate this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::Action::property_name (  )  const

A unique name for the action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_sensitive (  )  const

Whether the action is enabled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_sensitive (  ) 

Whether the action is enabled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::Action::property_short_label (  )  const

A shorter label that may be used on toolbar buttons.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gtk::Action::property_short_label (  ) 

A shorter label that may be used on toolbar buttons.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<StockID> Gtk::Action::property_stock_id (  )  const

The stock icon displayed in widgets representing this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<StockID> Gtk::Action::property_stock_id (  ) 

The stock icon displayed in widgets representing this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<Glib::ustring> Gtk::Action::property_tooltip (  )  const

A tooltip for this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<Glib::ustring> Gtk::Action::property_tooltip (  ) 

A tooltip for this action.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_visible (  )  const

Whether the action is visible.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_visible (  ) 

Whether the action is visible.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_visible_horizontal (  )  const

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_visible_horizontal (  ) 

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_visible_overflown (  )  const

When TRUE.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_visible_overflown (  ) 

When TRUE.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Gtk::Action::property_visible_vertical (  )  const

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Gtk::Action::property_visible_vertical (  ) 

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

void Gtk::Action::set_accel_group ( const Glib::RefPtr<AccelGroup>&  accel_group  ) 

Sets the Gtk::AccelGroup in which the accelerator for this action will be installed.

Since gtkmm 2.4:
Parameters:
accel_group A Gtk::AccelGroup or 0.

void Gtk::Action::set_accel_path ( const Glib::ustring 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.

Note that accel_path string will be stored in a Quark. Therefore, if you pass a static string, you can save some memory by interning it first with Glib::intern_static_string().

Since gtkmm 2.4:
Parameters:
accel_path The accelerator path.

void Gtk::Action::set_gicon ( const Glib::RefPtr< Gio::Icon > &  icon  ) 

Sets the icon of action.

Since gtkmm 2.16:
Parameters:
icon The Icon to set.

void Gtk::Action::set_icon_name ( const Glib::ustring icon_name  ) 

Sets the icon name on action.

Since gtkmm 2.16:
Parameters:
icon_name The icon name to set.

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

Since gtkmm 2.16:
Parameters:
is_important true to make the action important.

void Gtk::Action::set_label ( const Glib::ustring label  ) 

Sets the label of action.

Since gtkmm 2.16:
Parameters:
label The label text to set.

void Gtk::Action::set_sensitive ( bool  sensitive = true  ) 

Sets the sensitive property of the action to sensitive.

Note that this doesn't necessarily mean effective sensitivity. See is_sensitive() for that.

Since gtkmm 2.6:
Parameters:
sensitive true to make the action sensitive.

void Gtk::Action::set_short_label ( const Glib::ustring short_label  ) 

Sets a shorter label text on action.

Since gtkmm 2.16:
Parameters:
short_label The label text to set.

void Gtk::Action::set_stock_id ( const StockID stock_id  ) 

Sets the stock id on action.

Since gtkmm 2.16:
Parameters:
stock_id The stock id.

void Gtk::Action::set_tooltip ( const Glib::ustring tooltip  ) 

Sets the tooltip text on action.

Since gtkmm 2.16:
Parameters:
tooltip The tooltip text.

void Gtk::Action::set_visible ( bool  visible = true  ) 

Sets the visible property of the action to visible.

Note that this doesn't necessarily mean effective visibility. See is_visible() for that.

Since gtkmm 2.6:
Parameters:
visible true to make the action visible.

void Gtk::Action::set_visible_horizontal ( bool  visible_horizontal = true  ) 

Sets whether action is visible when horizontal.

Since gtkmm 2.16:
Parameters:
visible_horizontal Whether the action is visible horizontally.

void Gtk::Action::set_visible_vertical ( bool  visible_vertical = true  ) 

Sets whether action is visible when vertical.

Since gtkmm 2.16:
Parameters:
visible_vertical Whether the action is visible vertically.

Glib::SignalProxy0< void > Gtk::Action::signal_activate (  ) 

The "activate" signal is emitted when the action is activated.

Prototype:
void on_my_activate()

void Gtk::Action::unblock_activate (  ) 

Reenable activation signals from the action.

Since gtkmm 2.16:

void Gtk::Action::unblock_activate_from ( Widget proxy  )  [protected]

Re-enables calls to the activate() function by signals on the given proxy widget.

This undoes the blocking done by block_activate_from().

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.
Deprecated:
Activatables are now responsible for activating the action directly so this doesnt apply anymore
Parameters:
proxy A proxy widget.


Friends And Related Function Documentation

Glib::RefPtr<Gtk::Action> wrap ( GtkAction *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated for gtkmm 2.4 by Doxygen 1.5.6 © 1997-2001