logo top
Main Page   Widgets   Namespaces   Book  

Gtk::ToggleButton Class Reference
[Widgets]

Inheritance diagram for Gtk::ToggleButton:

Inheritance graph
[legend]
List of all members.

Detailed Description

A Gtk::ToggleButton will remain 'pressed-in' when clicked.

Clicking again will cause the toggle button to return to it's normal state. The state of a Gtk::ToggleButton can be set specifically using set_active(), and retrieved using get_active(). To simply switch the state of a toggle button, use toggled().


Public Member Functions

bool get_active () const
bool get_inconsistent () const
 Gets the value set by set_inconsistent().
bool get_mode () const
 Retrieves whether the button is displayed as a separate indicator and label.
const GtkToggleButton* gobj () const
 Provides access to the underlying C GtkObject.
GtkToggleButton* gobj ()
 Provides access to the underlying C GtkObject.
void set_active (bool is_active=true)
void set_inconsistent (bool setting=true)
 If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state.
void set_mode (bool draw_indicator=true)
 Sets whether the button is displayed as a separate indicator and label.
Glib::SignalProxy0<void> signal_toggled ()
 Emitted whenever the toggle tool button changes state.
 ToggleButton (const Glib::ustring& label, bool mnemonic=false)
 Create a toggle button with a label.
 ToggleButton ()
 Create an empty toggle button.
void toggled ()
virtual ~ToggleButton ()

Related Functions

(Note that these are not member functions.)

Gtk::ToggleButtonwrap (GtkToggleButton* object, bool take_copy=false)
 
Parameters:
object The C instance


Constructor & Destructor Documentation

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

Gtk::ToggleButton::ToggleButton (  ) 

Create an empty toggle button.

With an empty button, you can Gtk::Button::add() a widget such as a Gtk::Pixmap or Gtk::Box.

If you just wish to add a Gtk::Label, you may want to use the Gtk::ToggleButton(const Glib::ustring& label) constructor directly instead.

Gtk::ToggleButton::ToggleButton ( const Glib::ustring &  label,
bool  mnemonic = false 
) [explicit]

Create a toggle button with a label.

You won't be able to add a widget to this button since it already contains a Gtk::Label


Member Function Documentation

bool Gtk::ToggleButton::get_active (  )  const

bool Gtk::ToggleButton::get_inconsistent (  )  const

Gets the value set by set_inconsistent().

Returns:
true if the button is displayed as inconsistent, false otherwise.

bool Gtk::ToggleButton::get_mode (  )  const

Retrieves whether the button is displayed as a separate indicator and label.

See set_mode().

Returns:
true if the togglebutton is drawn as a separate indicator and label.

const GtkToggleButton* Gtk::ToggleButton::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

Reimplemented in Gtk::CheckButton, and Gtk::RadioButton.

GtkToggleButton* Gtk::ToggleButton::gobj (  )  [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

Reimplemented in Gtk::CheckButton, and Gtk::RadioButton.

void Gtk::ToggleButton::set_active ( bool  is_active = true  ) 

void Gtk::ToggleButton::set_inconsistent ( bool  setting = true  ) 

If the user has selected a range of elements (such as some text or spreadsheet cells) that are affected by a toggle button, and the current values in that range are inconsistent, you may want to display the toggle in an "in between" state.

This function turns on "in between" display. Normally you would turn off the inconsistent state again if the user toggles the toggle button. This has to be done manually, set_inconsistent() only affects visual appearance, it doesn't affect the semantics of the button.

Parameters:
setting true if state is inconsistent.

void Gtk::ToggleButton::set_mode ( bool  draw_indicator = true  ) 

Sets whether the button is displayed as a separate indicator and label.

You can call this function on a checkbutton or a radiobutton with draw_indicator = false to make the button look like a normal button

This function only effects instances of classes like Gtk::CheckButton and Gtk::RadioButton that derive from Gtk::ToggleButton, not instances of Gtk::ToggleButton itself.

Parameters:
draw_indicator If true, draw the button as a separate indicator and label; if false, draw the button like a normal button.

Glib::SignalProxy0< void > Gtk::ToggleButton::signal_toggled (  ) 

Emitted whenever the toggle tool button changes state.

Prototype:
void toggled()

void Gtk::ToggleButton::toggled (  ) 


Friends And Related Function Documentation

Gtk::ToggleButton* wrap ( GtkToggleButton *  object,
bool  take_copy = false 
) [related]

Parameters:
object The C instance

Parameters:
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.1 © 1997-2001