gtkmm  2.24.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::ToggleAction Class Reference

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

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

Public Member Functions

 ToggleAction (ToggleAction&& src) noexcept
 
ToggleActionoperator= (ToggleAction&& src) noexcept
 
 ~ToggleAction () noexceptoverride
 
GtkToggleAction* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkToggleAction* gobj () const
 Provides access to the underlying C GObject. More...
 
GtkToggleAction* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
void toggled ()
 Emits the "toggled" signal on the toggle action. More...
 
void set_active (bool is_active=true)
 Sets the checked state on the toggle action. More...
 
bool get_active () const
 Returns the checked state of the toggle action. More...
 
void set_draw_as_radio (bool draw_as_radio=true)
 Sets whether the action should have proxies like a radio action. More...
 
bool get_draw_as_radio () const
 Returns whether the action should have proxies like a radio action. More...
 
Glib::SignalProxy< void > signal_toggled ()
 
Glib::PropertyProxy< bool > property_draw_as_radio ()
 Whether the proxies for this action look like radio action proxies. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_draw_as_radio () const
 Whether the proxies for this action look like radio action proxies. More...
 
Glib::PropertyProxy< bool > property_active ()
 If the toggle action should be active in or not. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_active () const
 If the toggle action should be active in or not. More...
 
- Public Member Functions inherited from Gtk::Action
 Action (Action&& src) noexcept
 
Actionoperator= (Action&& src) noexcept
 
 ~Action () noexceptoverride
 
GtkAction* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkAction* gobj () const
 Provides access to the underlying C GObject. More...
 
GtkAction* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Returns the name of the action. More...
 
bool is_sensitive () const
 Returns whether the action is effectively sensitive. More...
 
bool get_sensitive () const
 Returns whether the action itself is sensitive. More...
 
void set_sensitive (bool sensitive=true)
 Sets the property_sensitive() property of the action to sensitive. More...
 
bool is_visible () const
 Returns whether the action is effectively visible. More...
 
bool get_visible () const
 Returns whether the action itself is visible. More...
 
void set_visible (bool visible=true)
 Sets the property_visible() property of the action to visible. More...
 
void activate ()
 Emits the "activate" signal on the specified action, if it isn't insensitive. More...
 
Imagecreate_icon (IconSize icon_size)
 This function is intended for use by action implementations to create icons displayed in the proxy widgets. More...
 
MenuItemcreate_menu_item ()
 Creates a menu item widget that proxies for the given action. More...
 
ToolItemcreate_tool_item ()
 Creates a toolbar item widget that proxies for the given action. More...
 
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. More...
 
void connect_proxy (Widget& proxy)
 Connects a widget to an action object as a proxy. More...
 
void disconnect_proxy (Widget& proxy)
 Disconnects a proxy widget from an action. More...
 
Glib::SListHandle< Widget* > get_proxies ()
 Returns the proxy widgets for an action. More...
 
Glib::SListHandle< const Widget* > get_proxies () const
 Returns the proxy widgets for an action. More...
 
void connect_accelerator ()
 Installs the accelerator for action if action has an accel path and group. More...
 
void disconnect_accelerator ()
 Undoes the effect of one call to connect_accelerator(). More...
 
Glib::ustring get_accel_path () const
 Returns the accel path for this action. More...
 
Glib::SignalProxy< void > signal_activate ()
 The "activate" signal is emitted when the action is activated. More...
 
void set_accel_path (const Glib::ustring& accel_path)
 Sets the accel path for this action. More...
 
void set_accel_group (const Glib::RefPtr< AccelGroup >& accel_group)
 Sets the Gtk::AccelGroup in which the accelerator for this action will be installed. More...
 
void set_label (const Glib::ustring& label)
 Sets the label of action. More...
 
Glib::ustring get_label () const
 Gets the label text of action. More...
 
void set_short_label (const Glib::ustring& short_label)
 Sets a shorter label text on action. More...
 
Glib::ustring get_short_label () const
 Gets the short label text of action. More...
 
void set_tooltip (const Glib::ustring& tooltip)
 Sets the tooltip text on action. More...
 
Glib::ustring get_tooltip () const
 Gets the tooltip text of action. More...
 
void set_stock_id (const StockID& stock_id)
 Sets the stock id on action. More...
 
StockID get_stock_id () const
 Gets the stock id of action. More...
 
void set_gicon (const Glib::RefPtr< Gio::Icon >& icon)
 Sets the icon of action. More...
 
Glib::RefPtr< Gio::Iconget_gicon ()
 Gets the gicon of action. More...
 
Glib::RefPtr< const Gio::Iconget_gicon () const
 Gets the gicon of action. More...
 
void set_icon_name (const Glib::ustring& icon_name)
 Sets the icon name on action. More...
 
Glib::ustring get_icon_name () const
 Gets the icon name of action. More...
 
void set_visible_horizontal (bool visible_horizontal=true)
 Sets whether action is visible when horizontal. More...
 
bool get_visible_horizontal () const
 Checks whether action is visible when horizontal. More...
 
void set_visible_vertical (bool visible_vertical=true)
 Sets whether action is visible when vertical. More...
 
bool get_visible_vertical () const
 Checks whether action is visible when horizontal. More...
 
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. More...
 
bool get_is_important () const
 Checks whether action is important or not. More...
 
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. More...
 
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. More...
 
void block_activate ()
 Disable activation signals from the action. More...
 
void unblock_activate ()
 Reenable activation signals from the action. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 A unique name for the action. More...
 
Glib::PropertyProxy< Glib::ustringproperty_label ()
 The label used for menu items and buttons that activate this action. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_label () const
 The label used for menu items and buttons that activate this action. More...
 
Glib::PropertyProxy< Glib::ustringproperty_short_label ()
 A shorter label that may be used on toolbar buttons. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_short_label () const
 A shorter label that may be used on toolbar buttons. More...
 
Glib::PropertyProxy< Glib::ustringproperty_tooltip ()
 A tooltip for this action. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_tooltip () const
 A tooltip for this action. More...
 
Glib::PropertyProxy< StockIDproperty_stock_id ()
 The stock icon displayed in widgets representing this action. More...
 
Glib::PropertyProxy_ReadOnly< StockIDproperty_stock_id () const
 The stock icon displayed in widgets representing this action. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > property_gicon ()
 The GIcon being displayed. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > property_gicon () const
 The GIcon being displayed. More...
 
Glib::PropertyProxy< Glib::ustringproperty_icon_name ()
 The name of the icon from the icon theme. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_icon_name () const
 The name of the icon from the icon theme. More...
 
Glib::PropertyProxy< bool > property_visible_horizontal ()
 Whether the toolbar item is visible when the toolbar is in a horizontal orientation. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible_horizontal () const
 Whether the toolbar item is visible when the toolbar is in a horizontal orientation. More...
 
Glib::PropertyProxy< bool > property_visible_vertical ()
 Whether the toolbar item is visible when the toolbar is in a vertical orientation. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible_vertical () const
 Whether the toolbar item is visible when the toolbar is in a vertical orientation. More...
 
Glib::PropertyProxy< bool > property_visible_overflown ()
 When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible_overflown () const
 When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu. More...
 
Glib::PropertyProxy< bool > property_is_important ()
 Whether the action is considered important. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_important () const
 Whether the action is considered important. More...
 
Glib::PropertyProxy< bool > property_hide_if_empty ()
 When TRUE, empty menu proxies for this action are hidden. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_hide_if_empty () const
 When TRUE, empty menu proxies for this action are hidden. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the action is enabled. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the action is enabled. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Whether the action is visible. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the action is visible. More...
 
Glib::PropertyProxy< Glib::RefPtr< ActionGroup > > property_action_group ()
 The GtkActionGroup this GtkAction is associated with, or NULL (for internal use). More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ActionGroup > > property_action_group () const
 The GtkActionGroup this GtkAction is associated with, or NULL (for internal use). More...
 
Glib::PropertyProxy< bool > property_always_show_image ()
 Whether the image will always be shown. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_always_show_image () const
 Whether the image will always be shown. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
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)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
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)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
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. More...
 
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. More...
 
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. More...
 
- Static Public Member Functions inherited from Gtk::Action
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 
static Glib::RefPtr< Actioncreate ()
 
static Glib::RefPtr< Actioncreate (const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 Creates an action. More...
 
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. More...
 
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. More...
 

Protected Member Functions

 ToggleAction ()
 Creates an empty toggle action. More...
 
 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. More...
 
 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. More...
 
virtual void on_toggled ()
 This is a default handler for the signal signal_toggled(). More...
 
- Protected Member Functions inherited from Gtk::Action
 Action ()
 Creates an empty action. More...
 
 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. More...
 
 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. More...
 
void block_activate_from (Widget& proxy)
 Disables calls to the activate() function by signals on the given proxy widget. More...
 
void unblock_activate_from (Widget& proxy)
 Re-enables calls to the activate() function by signals on the given proxy widget. More...
 
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(). More...
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexceptoverride
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

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. More...
 

Additional Inherited Members

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

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

Gtk::ToggleAction::ToggleAction ( ToggleAction&&  src)
noexcept
Gtk::ToggleAction::~ToggleAction ( )
overridenoexcept
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
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.

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

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.

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

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

ToggleAction& Gtk::ToggleAction::operator= ( ToggleAction&&  src)
noexcept
Glib::PropertyProxy< bool > Gtk::ToggleAction::property_active ( )

If the toggle action should be active in or not.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ToggleAction::property_active ( ) const

If the toggle action should be active in or not.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, 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.

Returns
A PropertyProxy that allows you to get or set the value of the property, 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.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, 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::SignalProxy< void > Gtk::ToggleAction::signal_toggled ( )
Slot Prototype:
void on_my_toggled()
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: