Hildon::CheckButton Class Reference
[Widgets, Buttons]

Button with a check box inside. More...

Inheritance diagram for Hildon::CheckButton:

[legend]

List of all members.

Public Member Functions
virtual	~CheckButton ()
HildonCheckButton*	gobj ()
	Provides access to the underlying C GtkObject.
const HildonCheckButton*	gobj () const
	Provides access to the underlying C GtkObject.
	CheckButton ()
	CheckButton (Gtk::Hildon::SizeType size)
void	set_active (bool is_active=true)
	Sets the status of a Hildon::CheckButton.
bool	get_active () const
	Gets the current state of button.
void	toggled ()
	Emits the Hildon::CheckButton::toggled signal on the Hildon::CheckButton.
Glib::SignalProxy0<void>	signal_toggled ()
Related Functions
(Note that these are not member functions.)
Hildon::CheckButton*	wrap (HildonCheckButton* object, bool take_copy=false)
	A Glib::wrap() method for this object.

---

Detailed Description

Button with a check box inside.

Hildon::CheckButton is a button containing a label and a check box which will remain "pressed-in" when clicked. Clicking again will make the check box toggle its state.

The state of a Hildon::CheckButton can be set using Hildon::CheckButton::set_active(), and retrieved using Hildon::CheckButton::get_active(). The label can be set using Gtk::Button::set_label() and retrieved using Gtk::Button::get_label().

Note:

Hildon::CheckButton does not support an image, so don't use Gtk::Button::set_image().

---

Constructor & Destructor Documentation

virtual Hildon::CheckButton::~CheckButton

(

)

[virtual]

Hildon::CheckButton::CheckButton

(

)

Hildon::CheckButton::CheckButton

(

Gtk::Hildon::SizeType

size

)

[explicit]

---

Member Function Documentation

HildonCheckButton* Hildon::CheckButton::gobj

(

)

[inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

const HildonCheckButton* Hildon::CheckButton::gobj

(

)

const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::Button.

void Hildon::CheckButton::set_active

(

bool

is_active = true

)

Sets the status of a Hildon::CheckButton.

Set to true if you want button to be 'pressed-in', and false to raise it. This action causes the Hildon::CheckButton::toggled signal to be emitted.

Parameters:

is_active

New state for the button.

bool Hildon::CheckButton::get_active

(

)

const

Gets the current state of button.

Returns:

true if button is active, false otherwise.

.

void Hildon::CheckButton::toggled

(

)

Emits the Hildon::CheckButton::toggled signal on the Hildon::CheckButton.

There is no good reason for an application ever to call this function.

Glib::SignalProxy0< void > Hildon::CheckButton::signal_toggled

(

)

Prototype:

void on_my_toggled()

---

Friends And Related Function Documentation

Hildon::CheckButton* wrap	(	HildonCheckButton *	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:

• check-button.h