Gtk-- Reference: Gtk::ToggleButton

Class Index | Cross Index | Namespace Index

# Class Gtk::ToggleButton

Button with two states
Contained in: Gtk
Derived from: Gtk::Button
Derived by: Gtk::CheckButton

#include <gtk--/togglebutton.h>

### public function member index:
`` | `ToggleButton` | `()`;
``explicit`` | `ToggleButton` | `(`const` `string`& `label`, `gfloat` `x`=0.5, `gfloat` `y`=0.5)`;
``bool`` | `get_active` | `() `const``;
``bool`` | `get_mode` | `() `const``;
``GtkToggleButton`*` | `gtkobj` | `()`;
``const` `GtkToggleButton`*` | `gtkobj` | `() `const``;
``static` `bool`` | `isA` | `(`Object`* `object`)`;
``void`` | `set_active` | `(`bool` `is_active`)`;
``void`` | `set_mode` | `(`bool` `draw_indicator`)`;
``emitable` `signal` `void`` | `toggled` | `()`;
``virtual`` | `~ToggleButton` | `()`;
### protected function member index:
``virtual` `void`` | `toggled_impl` | `()`;

## Description:

The togglebutton has the look of a regular button, but the action of a checkbutton. It can be switched between two states by clicking on it. Like the button, it can hold another widget inside it.

## Function Member Descriptions:

Gtk::ToggleButton::ToggleButton - Create an empty toggle button.

`` `ToggleButton``()`;

> 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 {ToggleButton(const string &label)} ctor directly instead.

Gtk::ToggleButton::ToggleButton - Create a check button with a label.

``explicit`` `ToggleButton``(`const` `string`& `label`, `gfloat` `x`=0.5, `gfloat` `y`=0.5)`;

> You won't be able to add a widget in this button since it already has a `Gtk_Label` in it.

Gtk::ToggleButton::get_active - Return the state of the indicator.

``bool`` `get_active``() `const``;

> See ``active``.

Gtk::ToggleButton::get_mode - Returns whether the indicator will be drawn.

``bool`` `get_mode``() `const``;

> See ``draw_indicator``.

Gtk::ToggleButton::gtkobj - Returns the underlaying gtk+ object.

``GtkToggleButton`*` `gtkobj``()`;
Gtk::ToggleButton::isA - Returns true if object is this type.

``static` `bool`` `isA``(`Object`* `object`)`;
Gtk::ToggleButton::set_active - Set the state of the indicator.

``void`` `set_active``(`bool` `is_active`)`;
Gtk::ToggleButton::set_mode - Set whether the indicator will be drawn.

``void`` `set_mode``(`bool` `draw_indicator`)`;

> See ``draw_indicator``.

Gtk::ToggleButton::toggled - Emitted on a change of button state.

``emitable` `signal` `void`` `toggled``()`;
``virtual` `void`` `toggled_impl``()`;

> Triggered when the button changes state (Note : changing the button's state with `set_active` will also trigger this signal).