A deprecated action of which only one in a group can be active. More...

#include <gtkmm/radioaction.h>

Inheritance diagram for Gtk::RadioAction:

[legend]

Public Types
typedef RadioButtonGroup	Group

Public Types inherited from Gtk::Action
typedef sigc::slot< void >	SlotActivate
	For instance, void on_activate();. More...

Public Member Functions
	RadioAction (RadioAction && src) noexcept

RadioAction &	operator= (RadioAction && src) noexcept

	~RadioAction () noexcept override

GtkRadioAction *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkRadioAction *	gobj () const
	Provides access to the underlying C GObject. More...

GtkRadioAction *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Group	get_group ()
	Returns the list representing the radio group for this object. More...

void	set_group (Group & group)

void	join_group (const Glib::RefPtr< RadioAction > & group_source)
	Joins a radio action object to the group of another radio action object. More...

int	get_current_value () const
	Obtains the value property of the currently active member of the group to which action belongs. More...

void	set_current_value (int current_value)
	Sets the currently active group member to the member with value property current_value. More...

Glib::SignalProxy< void, const Glib::RefPtr< RadioAction > & >	signal_changed ()

Glib::PropertyProxy< int >	property_value ()
	The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an signal_activate() or signal_changed() signal handler. More...

Glib::PropertyProxy_ReadOnly< int >	property_value () const
	The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an signal_activate() or signal_changed() signal handler. More...

Glib::PropertyProxy< int >	property_current_value ()
	The value property of the currently active member of the group to which this action belongs. More...

Glib::PropertyProxy_ReadOnly< int >	property_current_value () const
	The value property of the currently active member of the group to which this action belongs. More...

Public Member Functions inherited from Gtk::ToggleAction
	ToggleAction (ToggleAction && src) noexcept

ToggleAction &	operator= (ToggleAction && src) noexcept

	~ToggleAction () noexcept override

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 ()
	Whether the toggle action should be active. More...

Glib::PropertyProxy_ReadOnly< bool >	property_active () const
	Whether the toggle action should be active. More...

Public Member Functions inherited from Gtk::Action
	Action (Action && src) noexcept

Action &	operator= (Action && src) noexcept

	~Action () noexcept override

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 :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 :visible property of the action to visible. More...

void	activate ()
	Emits the “activate” signal on the specified action, if it isn't insensitive. More...

Image *	create_icon (IconSize icon_size)
	This function is intended for use by action implementations to create icons displayed in the proxy widgets. More...

MenuItem *	create_menu_item ()
	Creates a menu item widget that proxies for the given action. More...

ToolItem *	create_tool_item ()
	Creates a toolbar item widget that proxies for the given action. More...

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

std::vector< Widget * >	get_proxies ()
	Returns the proxy widgets for an action. More...

std::vector< 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 ()

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::Icon >	get_gicon ()
	Gets the gicon of action. More...

Glib::RefPtr< const Gio::Icon >	get_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 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::ustring >	property_name () const
	A unique name for the action. More...

Glib::PropertyProxy< Glib::ustring >	property_label ()
	The label used for menu items and buttons that activate this action. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_label () const
	The label used for menu items and buttons that activate this action. More...

Glib::PropertyProxy< Glib::ustring >	property_short_label ()
	A shorter label that may be used on toolbar buttons. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_short_label () const
	A shorter label that may be used on toolbar buttons. More...

Glib::PropertyProxy< Glib::ustring >	property_tooltip ()
	A tooltip for this action. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_tooltip () const
	A tooltip for this action. More...

Glib::PropertyProxy< StockID >	property_stock_id ()
	The stock icon displayed in widgets representing this action. More...

Glib::PropertyProxy_ReadOnly< StockID >	property_stock_id () const
	The stock icon displayed in widgets representing this action. More...

Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > >	property_gicon ()
	The Gio::Icon displayed in the Gtk::Action. More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > >	property_gicon () const
	The Gio::Icon displayed in the Gtk::Action. More...

Glib::PropertyProxy< Glib::ustring >	property_icon_name ()
	The name of the icon from the icon theme. More...

Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_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 `nullptr` (for internal use). More...

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< ActionGroup > >	property_action_group () const
	The GtkActionGroup this GtkAction is associated with, or `nullptr` (for internal use). More...

Glib::PropertyProxy< bool >	property_always_show_image ()
	If `true`, the action's menu item proxies will ignore the Gtk::Settings::property_gtk_menu_images() setting and always show their image, if available. More...

Glib::PropertyProxy_ReadOnly< bool >	property_always_show_image () const
	If `true`, the action's menu item proxies will ignore the Gtk::Settings::property_gtk_menu_images() setting and always show their image, if available. More...

Public Member Functions inherited from Gtk::Buildable
	Buildable (Buildable && src) noexcept

Buildable &	operator= (Buildable && src) noexcept

	~Buildable () noexcept override

GtkBuildable *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkBuildable *	gobj () const
	Provides access to the underlying C GObject. More...

void	set_name (const Glib::ustring & name)
	Sets the name of the buildable object. More...

Glib::ustring	get_name () const
	Gets the name of the buildable object. More...

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< RadioAction >	create ()

static Glib::RefPtr< RadioAction >	create (Group & group, const Glib::ustring & name, const Glib::ustring & label=Glib::ustring(), const Glib::ustring & tooltip=Glib::ustring())
	Creates a radio action. More...

static Glib::RefPtr< RadioAction >	create (Group & group, const Glib::ustring & name, const Gtk::StockID & stock_id, const Glib::ustring & label=Glib::ustring(), const Glib::ustring & tooltip=Glib::ustring())
	Creates a radio action with a stock ID. More...

static Glib::RefPtr< RadioAction >	create_with_icon_name (Group & group, const Glib::ustring & name, const Glib::ustring & icon_name, const Glib::ustring & label, const Glib::ustring & tooltip)
	Creates a radio action with an icon name. More...

Static Public Member Functions inherited from Gtk::ToggleAction
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< ToggleAction >	create ()

static Glib::RefPtr< ToggleAction >	create (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< 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)
	Creates a toggle action with a stock ID. More...

static Glib::RefPtr< 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)
	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< 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. More...

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

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

Static Public Member Functions inherited from Gtk::Buildable
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	RadioAction ()

	RadioAction (Group & group, const Glib::ustring & name, const StockID & stock_id=StockID(), const Glib::ustring & label=Glib::ustring(), const Glib::ustring & tooltip=Glib::ustring())
	Creates a radio action. More...

	RadioAction (Group & group, const Glib::ustring & name, const Glib::ustring & icon_name, const Glib::ustring & label=Glib::ustring(), const Glib::ustring & tooltip=Glib::ustring())
	Creates a radio action with an icon name. More...

virtual void	on_changed (const Glib::RefPtr< RadioAction > & current)
	This is a default handler for the signal signal_changed(). More...

Protected Member Functions inherited from Gtk::ToggleAction
	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...

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 ()
	This is a default handler for the signal signal_activate(). More...

Protected Member Functions inherited from Gtk::Buildable
	Buildable ()
	You should derive from this class to use it. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::RadioAction >	wrap (GtkRadioAction * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::ToggleAction
Glib::RefPtr< Gtk::ToggleAction >	wrap (GtkToggleAction * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::Action
Glib::RefPtr< Gtk::Action >	wrap (GtkAction * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::Buildable
Glib::RefPtr< Gtk::Buildable >	wrap (GtkBuildable * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

A deprecated action of which only one in a group can be active.

A Gtk::RadioAction is similar to Gtk::RadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time.

Deprecated:: Use Gio::Action and Gio::SimpleAction instead, and associate actions with Gtk::Actionable widgets. Use Gio::MenuModel for creating menus with Gtk::Menu(const Glib::RefPtr<Gio::MenuModel>& model). See the Gtk::Action base class for more information about the deprecation.

Member Typedef Documentation

◆ Group

typedef RadioButtonGroup Gtk::RadioAction::Group

Constructor & Destructor Documentation

◆ RadioAction() [1/4]

Gtk::RadioAction::RadioAction ( RadioAction && src )

noexcept

◆ ~RadioAction()

Gtk::RadioAction::~RadioAction ( )

overridenoexcept

◆ RadioAction() [2/4]

Gtk::RadioAction::RadioAction ( )

protected

◆ RadioAction() [3/4]

Gtk::RadioAction::RadioAction	(	Group &	group,
		const Glib::ustring &	name,
		const StockID &	stock_id = `StockID()`,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)

explicitprotected

Creates a radio action.

Parameters

group	The radio group this action belongs to.
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.

Deprecated:: There is no corresponding replacement when using Gio::Action.

◆ RadioAction() [4/4]

Gtk::RadioAction::RadioAction	(	Group &	group,
		const Glib::ustring &	name,
		const Glib::ustring &	icon_name,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)

explicitprotected

Creates a radio action with an icon name.

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

Parameters

group	The radio group this action belongs to.
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.

Deprecated:: Use Gio::Action, which can be created by Gio::ActionMap::add_action_radio_string() or Gio::ActionMap::add_action_radio_integer().
Use Gio::MenuItem::set_icon() to set an icon on a Gio::MenuItem associated with a Gio::Action, or Gtk::Container::add() to add a Gtk::Image to a Gtk::RadioButton.
Set a label on a menu item with Gio::MenuItem::set_label(). For Gtk::Actionable widgets, use the widget-specific API to set a label.
Set tooltips on associated Gtk::Actionable widgets with Gtk::Widget::set_tooltip_text().

Member Function Documentation

◆ create() [1/3]

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

static

◆ create() [2/3]

static Glib::RefPtr< RadioAction > Gtk::RadioAction::create	(	Group &	group,
		const Glib::ustring &	name,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)

static

Creates a radio action.

Parameters

group	The radio group this action belongs to.
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 RadioAction.

Deprecated:: Use Gio::Action, which can be created by Gio::ActionMap::add_action_radio_string() or Gio::ActionMap::add_action_radio_integer().
Set a label on a menu item with Gio::MenuItem::set_label(). For Gtk::Actionable widgets, use the widget-specific API to set a label.
Set tooltips on associated Gtk::Actionable widgets with Gtk::Widget::set_tooltip_text().

◆ create() [3/3]

static Glib::RefPtr< RadioAction > Gtk::RadioAction::create	(	Group &	group,
		const Glib::ustring &	name,
		const Gtk::StockID &	stock_id,
		const Glib::ustring &	label = `Glib::ustring()`,
		const Glib::ustring &	tooltip = `Glib::ustring()`
	)

static

Creates a radio action with a stock ID.

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

Parameters

group	The radio group this action belongs to.
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 RadioAction.

Deprecated:: There is no corresponding replacement when using Gio::Action.

◆ create_with_icon_name()

static Glib::RefPtr< RadioAction > Gtk::RadioAction::create_with_icon_name	(	Group &	group,
		const Glib::ustring &	name,
		const Glib::ustring &	icon_name,
		const Glib::ustring &	label,
		const Glib::ustring &	tooltip
	)

static

Creates a radio action with an icon name.

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

Parameters

group	The radio group this action belongs to.
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 RadioAction.

Deprecated:: Use Gio::Action, which can be created by Gio::ActionMap::add_action_radio_string() or Gio::ActionMap::add_action_radio_integer().
Use Gio::MenuItem::set_icon() to set an icon on a Gio::MenuItem associated with a Gio::Action, or Gtk::Container::add() to add a Gtk::Image to a Gtk::RadioButton.
Set a label on a menu item with Gio::MenuItem::set_label(). For Gtk::Actionable widgets, use the widget-specific API to set a label.
Set tooltips on associated Gtk::Actionable widgets with Gtk::Widget::set_tooltip_text().

◆ get_current_value()

int Gtk::RadioAction::get_current_value ( ) const

Obtains the value property of the currently active member of the group to which action belongs.

Since gtkmm 2.4:

Deprecated: 3.10

Deprecated:: Use Gio::Action::get_state() on a Gio::Action instead.

Returns: The value of the currently active group member.

◆ get_group()

Group Gtk::RadioAction::get_group ( )

Returns the list representing the radio group for this object.

Note that the returned list is only valid until the next change to the group.

A common way to set up a group of radio group is the following:

[C example ellipted]

Since gtkmm 2.4:

Deprecated: 3.10

Deprecated:: There is no corresponding replacement when using Gio::Action.

Returns: The list representing the radio group for this object.

◆ get_type()

static GType Gtk::RadioAction::get_type ( )

static

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

◆ gobj() [1/2]

GtkRadioAction * Gtk::RadioAction::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkRadioAction * Gtk::RadioAction::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkRadioAction * Gtk::RadioAction::gobj_copy ( )

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

◆ join_group()

void Gtk::RadioAction::join_group ( const Glib::RefPtr< RadioAction > & group_source )

Joins a radio action object to the group of another radio action object.

Use this in language bindings instead of the get_group() and set_group() methods

A common way to set up a group of radio actions is the following:

[C example ellipted]

Since gtkmm 3.0:

Deprecated: 3.10

Deprecated:: There is no corresponding replacement when using Gio::Action.

Parameters

group_source A radio action object whos group we are joining, or nullptr to remove the radio action from its group.

◆ on_changed()

virtual void Gtk::RadioAction::on_changed ( const Glib::RefPtr< RadioAction > & current )

protectedvirtual

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

◆ operator=()

RadioAction & Gtk::RadioAction::operator= ( RadioAction && src )

noexcept

◆ property_current_value() [1/2]

Glib::PropertyProxy< int > Gtk::RadioAction::property_current_value ( )

The value property of the currently active member of the group to which this action belongs.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:: Use Gio::Action::property_state() and Gio::SimpleAction::property_state() instead.

Default value: 0

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.

◆ property_current_value() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::RadioAction::property_current_value ( ) const

The value property of the currently active member of the group to which this action belongs.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:: Use Gio::Action::property_state() and Gio::SimpleAction::property_state() instead.

Default value: 0

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

◆ property_value() [1/2]

Glib::PropertyProxy< int > Gtk::RadioAction::property_value ( )

The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an signal_activate() or signal_changed() signal handler.

See Gtk::RadioAction::get_current_value() and Gtk::RadioActionEntry for convenient ways to get and set this property.

Since gtkmm 2.4:

Deprecated: 3.10

Deprecated:: Use Gio::Action instead, and Gtk::Actionable::property_action_target() on one of the associated actionable widgets.

Default value: 0

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.

◆ property_value() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::RadioAction::property_value ( ) const

The value is an arbitrary integer which can be used as a convenient way to determine which action in the group is currently active in an signal_activate() or signal_changed() signal handler.

See Gtk::RadioAction::get_current_value() and Gtk::RadioActionEntry for convenient ways to get and set this property.

Since gtkmm 2.4:

Deprecated: 3.10

Deprecated:: Use Gio::Action instead, and Gtk::Actionable::property_action_target() on one of the associated actionable widgets.

Default value: 0

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

◆ set_current_value()

void Gtk::RadioAction::set_current_value ( int current_value )

Sets the currently active group member to the member with value property current_value.

Since gtkmm 2.10:

Deprecated: 3.10

Deprecated:: Use Gio::Action::change_state() on a Gio::Action instead.

Parameters

current_value The new value.

◆ set_group()

void Gtk::RadioAction::set_group ( Group & group )

Deprecated:: There is no corresponding replacement when using Gio::Action.

◆ signal_changed()

Glib::SignalProxy< void, const Glib::RefPtr< RadioAction > & > Gtk::RadioAction::signal_changed ( )

Slot Prototype:: void on_my_changed(const Glib::RefPtr<RadioAction>& current)

Flags: Run First, No Recurse

The signal_changed() signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the signal_activate() signals for the previous and current active members.

Since gtkmm 2.4:

Deprecated: 3.10

Deprecated:: Use Gio::SimpleAction::signal_activate() or Gio::SimpleAction::signal_change_state() instead.

Parameters

current The member of action's group which has just been activated.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::RadioAction > wrap	(	GtkRadioAction *	object,
		bool	take_copy = `false`
	)

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.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Member Typedef Documentation

◆ Group

Constructor & Destructor Documentation

◆ RadioAction() [1/4]

◆ ~RadioAction()

◆ RadioAction() [2/4]

◆ RadioAction() [3/4]

◆ RadioAction() [4/4]

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ create_with_icon_name()

◆ get_current_value()

◆ get_group()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ join_group()

◆ on_changed()

◆ operator=()

◆ property_current_value() [1/2]

◆ property_current_value() [2/2]

◆ property_value() [1/2]

◆ property_value() [2/2]

◆ set_current_value()

◆ set_group()

◆ signal_changed()

Friends And Related Function Documentation

◆ wrap()