gtkmm  3.5.13
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gtk::ToggleAction Class Reference

An action which can be toggled between two states. More...

Inheritance diagram for Gtk::ToggleAction:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~ToggleAction ()
GtkToggleAction* gobj ()
 Provides access to the underlying C GObject.
const GtkToggleAction* gobj () const
 Provides access to the underlying C GObject.
GtkToggleAction* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void toggled ()
 Emits the "toggled" signal on the toggle action.
void set_active (bool is_active=true)
 Sets the checked state on the toggle action.
bool get_active () const
 Returns the checked state of the toggle action.
void set_draw_as_radio (bool draw_as_radio=true)
 Sets whether the action should have proxies like a radio action.
bool get_draw_as_radio () const
 Returns whether the action should have proxies like a radio action.
Glib::SignalProxy0< void > signal_toggled ()
Glib::PropertyProxy< bool > property_draw_as_radio ()
 Whether the proxies for this action look like radio action proxies.
Glib::PropertyProxy_ReadOnly
< bool > 
property_draw_as_radio () const
 Whether the proxies for this action look like radio action proxies.
Glib::PropertyProxy< bool > property_active ()
 Whether the toggle action should be active.
Glib::PropertyProxy_ReadOnly
< bool > 
property_active () const
 Whether the toggle action should be active.
- Public Member Functions inherited from Gtk::Action
virtual ~Action ()
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 property_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 property_visible() property of the action to visible.
void activate ()
 Emits the "activate" signal on the specified action, if it isn't insensitive.
Imagecreate_icon (IconSize icon_size)
 This function is intended for use by action implementations to create icons displayed in the proxy widgets.
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.
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.
std::vector< Widget* > get_proxies ()
 Returns the proxy widgets for an action.
std::vector< 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 ()
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::Iconget_gicon ()
 Gets the gicon of action.
Glib::RefPtr< const Gio::Iconget_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::property_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::property_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< StockIDproperty_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, toolitem proxies for this action are represented in the toolbar overflow menu.
Glib::PropertyProxy_ReadOnly
< bool > 
property_visible_overflown () const
 When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.
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, empty menu proxies for this action are hidden.
Glib::PropertyProxy_ReadOnly
< bool > 
property_hide_if_empty () const
 When TRUE, empty menu proxies for this action are hidden.
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, or NULL (for internal use).
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< ActionGroup > > 
property_action_group () const
 The GtkActionGroup this GtkAction is associated with, or NULL (for internal use).
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.
- Public Member Functions inherited from Glib::Object
void * get_data (const QueryQuark &key)
void set_data (const Quark &key, void *data)
void set_data (const Quark &key, void *data, DestroyNotify notify)
void remove_data (const QueryQuark &quark)
void * steal_data (const QueryQuark &quark)
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void set_property (const Glib::ustring &property_name, const PropertyType &value)
void get_property (const Glib::ustring &property_name, PropertyType &value) const
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
- Public Member Functions inherited from Gtk::Buildable
virtual ~Buildable ()
void set_name (const Glib::ustring& name)
 Sets the name of the buildable object.
- Public Member Functions inherited from Glib::Interface
 Interface (const Glib::Interface_Class &interface_class)
 Interface (GObject *castitem)
virtual ~Interface ()
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
void set_property (const Glib::ustring &property_name, const PropertyType &value)
void get_property (const Glib::ustring &property_name, PropertyType &value) const
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
void freeze_notify ()
void thaw_notify ()
virtual void reference () const
virtual void unreference () const
GObject * gobj_copy () const

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
static Glib::RefPtr< ToggleActioncreate ()
static Glib::RefPtr< ToggleActioncreate (const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring(), bool is_active=false)
 Creates a toggle action.
static Glib::RefPtr< ToggleActioncreate (const Glib::ustring& name, const Gtk::StockID& stock_id, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring(), bool is_active=false)
 Creates a toggle action with a stock ID.
static Glib::RefPtr< ToggleActioncreate_with_icon_name (const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label, const Glib::ustring& tooltip, bool is_active=false)
 Creates a toggle action with an icon name.
- Static Public Member Functions inherited from Gtk::Action
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 (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_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.
- Static Public Member Functions inherited from Gtk::Buildable
static void add_interface (GType gtype_implementer)

Protected Member Functions

 ToggleAction ()
 Creates an empty toggle action.
 ToggleAction (const Glib::ustring& name, const StockID& stock_id=StockID(), const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring(), bool is_active=false)
 Creates a toggle action.
 ToggleAction (const Glib::ustring& name, const Glib::ustring& icon_name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring(), bool is_active=false)
 Creates a toggle action with an icon name.
virtual void on_toggled ()
 This is a default handler for the signal signal_toggled().
- Protected Member Functions inherited from Gtk::Action
 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.
virtual Widgetcreate_menu_item_vfunc ()
virtual Widgetcreate_tool_item_vfunc ()
virtual void connect_proxy_vfunc (Widget* proxy)
virtual void disconnect_proxy_vfunc (Widget* proxy)
virtual void on_activate ()
 This is a default handler for the signal signal_activate().
- Protected Member Functions inherited from Glib::Object
 Object ()
 Object (const Glib::ConstructParams &construct_params)
 Object (GObject *castitem)
virtual ~Object ()
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)
- Protected Member Functions inherited from Gtk::Buildable
 Buildable ()
 You should derive from this class to use it.
- Protected Member Functions inherited from Glib::Interface
 ObjectBase ()
 ObjectBase (const char *custom_type_name)
 ObjectBase (const std::type_info &custom_type_info)
virtual ~ObjectBase ()=0
void initialize (GObject *castitem)

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Gtk::Action
typedef sigc::slot< void > SlotActivate
 For instance, void on_activate();.
- Public Types inherited from Glib::Object
typedef void(* DestroyNotify )(gpointer data)

Detailed Description

An action which can be toggled between two states.

A Gtk::ToggleAction corresponds roughly to a Gtk::CheckMenuItem. It has an "active" state specifying whether the action has been checked or not.


Constructor & Destructor Documentation

virtual Gtk::ToggleAction::~ToggleAction ( )
virtual
Gtk::ToggleAction::ToggleAction ( )
protected

Creates an empty toggle action.

Gtk::ToggleAction::ToggleAction ( const Glib::ustring name,
const StockID stock_id = StockID(),
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring(),
bool  is_active = false 
)
explicitprotected

Creates a toggle action.

Parameters:
nameA unique name for the action.
stock_idThe stock icon to display in widgets representing the action.
labelThe label displayed in menu items and on buttons.
tooltipA tooltip for the action.
is_activeThe default checked state of the action.
Gtk::ToggleAction::ToggleAction ( const Glib::ustring name,
const Glib::ustring icon_name,
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring(),
bool  is_active = false 
)
explicitprotected

Creates a toggle action with an icon name.

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

Parameters:
nameA unique name for the action.
icon_nameAn IconTheme icon name used for widgets representing the action.
labelThe label displayed in menu items and on buttons.
tooltipA tooltip for the action.
is_activeThe default checked state of the action.

Member Function Documentation

static Glib::RefPtr<ToggleAction> Gtk::ToggleAction::create ( )
static

Reimplemented from Gtk::Action.

Reimplemented in Gtk::RadioAction.

static Glib::RefPtr<ToggleAction> Gtk::ToggleAction::create ( const Glib::ustring name,
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring(),
bool  is_active = false 
)
static

Creates a toggle action.

Parameters:
nameA unique name for the action.
labelThe label displayed in menu items and on buttons.
tooltipA tooltip for the action.
is_activeThe default checked state of the action.
Returns:
A new ToggleAction.
static Glib::RefPtr<ToggleAction> Gtk::ToggleAction::create ( const Glib::ustring name,
const Gtk::StockID stock_id,
const Glib::ustring label = Glib::ustring(),
const Glib::ustring tooltip = Glib::ustring(),
bool  is_active = false 
)
static

Creates a toggle action with a stock ID.

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

Parameters:
nameA unique name for the action.
stock_idThe stock icon to display in widgets representing the action.
labelThe label displayed in menu items and on buttons.
tooltipA tooltip for the action.
is_activeThe default checked state of the action.
Returns:
A new ToggleAction.
static Glib::RefPtr<ToggleAction> Gtk::ToggleAction::create_with_icon_name ( const Glib::ustring name,
const Glib::ustring icon_name,
const Glib::ustring label,
const Glib::ustring tooltip,
bool  is_active = false 
)
static

Creates a toggle action with an icon name.

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

Parameters:
nameA unique name for the action.
icon_nameAn IconTheme icon name used for widgets representing the action.
labelThe label displayed in menu items and on buttons.
tooltipA tooltip for the action.
is_activeThe default checked state of the action.
Returns:
A new ToggleAction.
bool Gtk::ToggleAction::get_active ( ) const

Returns the checked state of the toggle action.

Since gtkmm 2.4:
Returns:
The checked state of the toggle action.
bool Gtk::ToggleAction::get_draw_as_radio ( ) const

Returns whether the action should have proxies like a radio action.

Since gtkmm 2.4:
Returns:
Whether the action should have proxies like a radio action.
static GType Gtk::ToggleAction::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

Reimplemented from Gtk::Action.

Reimplemented in Gtk::RadioAction.

GtkToggleAction* Gtk::ToggleAction::gobj ( )
inline

Provides access to the underlying C GObject.

Reimplemented from Gtk::Action.

Reimplemented in Gtk::RadioAction.

const GtkToggleAction* Gtk::ToggleAction::gobj ( ) const
inline

Provides access to the underlying C GObject.

Reimplemented from Gtk::Action.

Reimplemented in Gtk::RadioAction.

GtkToggleAction* Gtk::ToggleAction::gobj_copy ( )

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

Reimplemented from Gtk::Action.

Reimplemented in Gtk::RadioAction.

virtual void Gtk::ToggleAction::on_toggled ( )
protectedvirtual

This is a default handler for the signal signal_toggled().

Glib::PropertyProxy< bool > Gtk::ToggleAction::property_active ( )

Whether the toggle action should be active.

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::ToggleAction::property_active ( ) const

Whether the toggle action should be active.

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::ToggleAction::property_draw_as_radio ( )

Whether the proxies for this action look like radio action proxies.

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::ToggleAction::property_draw_as_radio ( ) const

Whether the proxies for this action look like radio action proxies.

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::ToggleAction::set_active ( bool  is_active = true)

Sets the checked state on the toggle action.

Since gtkmm 2.4:
Parameters:
is_activeWhether the action should be checked or not.
void Gtk::ToggleAction::set_draw_as_radio ( bool  draw_as_radio = true)

Sets whether the action should have proxies like a radio action.

Since gtkmm 2.4:
Parameters:
draw_as_radioWhether the action should have proxies like a radio action.
Glib::SignalProxy0< void > Gtk::ToggleAction::signal_toggled ( )
Slot Prototype:
void on_my_toggled()

Should be connected if you wish to perform an action whenever the Gtk::ToggleAction state is changed.

void Gtk::ToggleAction::toggled ( )

Emits the "toggled" signal on the toggle action.

Since gtkmm 2.4:

Friends And Related Function Documentation

Glib::RefPtr< Gtk::ToggleAction > wrap ( GtkToggleAction *  object,
bool  take_copy = false 
)
related

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

Parameters:
objectThe C instance.
take_copyFalse 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: