logo top
Main Page   Widgets   Namespaces   Book  

Gtk::RadioAction Class Reference

Inheritance diagram for Gtk::RadioAction:

List of all members.


Detailed Description

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

Public Types

typedef RadioButtonGroup Group

Public Member Functions

int get_current_value () const
 Obtains the value property of the currently active member of the group to which action belongs.
Group get_group ()
 Returns: the list representing the radio group for this object.
const GtkRadioAction* gobj () const
 Provides access to the underlying C GObject.
GtkRadioAction* gobj ()
 Provides access to the underlying C GObject.
GtkRadioAction* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy_ReadOnly<int> property_current_value () const
 The value property of the currently active member of the group to which this action belongs.
Glib::PropertyProxy<int> property_current_value ()
 The value property of the currently active member of the group to which this action belongs.
Glib::PropertyProxy_ReadOnly<int> property_value () const
 The value returned by gtk_radio_action_get_current_value() when this action is the current action of its group.
Glib::PropertyProxy<int> property_value ()
 The value returned by gtk_radio_action_get_current_value() when this action is the current action of its group.
void set_current_value (int current_value)
 Sets the currently active group member to the member with value property current_value.
void set_group (Group& group)
Glib::SignalProxy1< void,
const Glib::RefPtr
<RadioAction >&> 
signal_changed ()
 The changed signal is emitted on every member of a radio group when the active member is changed.
virtual ~RadioAction ()

Static Public Member Functions

static Glib::RefPtr<RadioActioncreate (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.
static Glib::RefPtr<RadioActioncreate (Group& group, const Glib::ustring& name, const Glib::ustring& label=Glib::ustring(), const Glib::ustring& tooltip=Glib::ustring())
 Creates a radio action.
static Glib::RefPtr<RadioActioncreate ()
static Glib::RefPtr<RadioActioncreate_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.

Protected Member Functions

virtual void on_changed (const Glib::RefPtr<RadioAction>& current)
 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.
 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.
 RadioAction ()

Related Functions

(Note that these are not member functions.)

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


Member Typedef Documentation


Constructor & Destructor Documentation

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

Gtk::RadioAction::RadioAction (  )  [protected]

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() 
) [explicit, protected]

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.

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() 
) [explicit, protected]

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.


Member Function Documentation

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.

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.

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

Reimplemented from Gtk::ToggleAction.

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.

int Gtk::RadioAction::get_current_value (  )  const

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

Returns:
The value of the currently active group member
Since gtkmm 2.4:

Group Gtk::RadioAction::get_group (  ) 

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

Returns:
The list representing the radio group for this object
Since gtkmm 2.4:

const GtkRadioAction* Gtk::RadioAction::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::ToggleAction.

GtkRadioAction* Gtk::RadioAction::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::ToggleAction.

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.

Reimplemented from Gtk::ToggleAction.

virtual void Gtk::RadioAction::on_changed ( const Glib::RefPtr<RadioAction>&  current  )  [protected, virtual]

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.

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<int> Gtk::RadioAction::property_current_value (  ) 

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

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<int> Gtk::RadioAction::property_value (  )  const

The value returned by gtk_radio_action_get_current_value() when this action is the current action of its group.

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<int> Gtk::RadioAction::property_value (  ) 

The value returned by gtk_radio_action_get_current_value() when this action is the current action of its group.

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::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:
Parameters:
current_value The new value.

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

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

The changed signal is emitted on every member of a radio group when the active member is changed.

The signal is emitted after the activate signals for the previous and current active members.

Parameters:
current the member of this action's group which has just been activated.
Prototype:
void on_my_changed(const Glib::RefPtr<RadioAction>& current)


Friends And Related Function Documentation

Glib::RefPtr<Gtk::RadioAction> wrap ( GtkRadioAction *  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