Class implementing a checkbox. More...

Inheritance diagram for t3_widget::checkbox_t:

Public Member Functions
	checkbox_t (bool _state=false)
	Create a new checkbox_t. More...

bool	get_state (void)
	Retrieve the current state of the checkbox_t. More...

virtual bool	is_hotkey (key_t key)
	Query whether key is a hotkey for this widget. More...

virtual bool	process_key (key_t key)
	Handle a key press by the user. More...

virtual bool	process_mouse_event (mouse_event_t event)
	Process a mouse event. More...

virtual void	set_enabled (bool enable)
	Set the enabled status of this widget. More...

virtual void	set_focus (focus_t focus)
	Set whether this window_component_t has the input focus. More...

void	set_label (smart_label_t *_label)
	Associate this checkbox_t with a smart_label_t. More...

virtual bool	set_size (optint height, optint width)
	Set the size of this checkbox_t (ignored). More...

void	set_state (bool _state)
	Set the current state of the checkbox_t. More...

	T3_WIDGET_SIGNAL (activate, void)
	Signal emitted when the button is pressed. More...

	T3_WIDGET_SIGNAL (toggled, void)
	Signal emitted when the state of the checkbox_t is toggled. More...

virtual void	update_contents (void)
	Update the contents of the window. More...

Public Member Functions inherited from t3_widget::widget_t
virtual bool	accepts_focus (void)
	Query whether this widget accepts focus. More...

virtual void	force_redraw (void)
	Request that this window_component_t be completely redrawn. More...

virtual void	hide (void)
	Hide the window_component_t. More...

virtual bool	is_enabled (void)
	Query the enabled status of this widget. More...

virtual bool	is_shown (void)
	Query the visibility status of this widget. More...

virtual void	set_anchor (window_component_t *anchor, int relation)
	Set this widget's anchor. More...

virtual void	set_position (optint top, optint left)
	Move the window_component_t to a specified position. More...

virtual void	show (void)
	Display the window_component_t. More...

Public Member Functions inherited from t3_widget::window_component_t
virtual t3_window_t *	get_base_window (void)
	Retrieve the t3_window_t for this window_component_t. More...

	window_component_t (void)
	Base constructor. More...

virtual	~window_component_t (void)
	Base destructor. More...

Public Member Functions inherited from t3_widget::mouse_target_t
void	grab_mouse (void)
	Grab all future mouse events. More...

void	register_mouse_target (t3_window_t *target)
	Register a window to receive mouse events. More...

void	release_mouse_grab (void)
	Release a previous mouse grab. More...

void	unregister_mouse_target (t3_window_t *target)
	Unregister a window to receive mouse events. More...

Additional Inherited Members
Public Types inherited from t3_widget::window_component_t
enum	focus_t { FOCUS_OUT, FOCUS_SET, FOCUS_IN_FWD, FOCUS_IN_BCK, FOCUS_REVERT }

Static Public Member Functions inherited from t3_widget::mouse_target_t
static bool	handle_mouse_event (mouse_event_t event)

Protected Member Functions inherited from t3_widget::widget_t
void	init_unbacked_window (int height, int width, bool register_as_mouse_target=false)
	Initialize the window with an unbacked `t3_window_t` with `height` and `width`. More...

void	init_window (int height, int width, bool register_as_mouse_target=true)
	Initialize the window with a `t3_window_t` with `height` and `width`. More...

	widget_t (int height, int width, bool register_as_mouse_target=true)
	Constructor which creates a default `t3_window_t` with `height` and `width`. More...

	widget_t (void)
	Constructor which does not create a default t3_window_t. More...

Protected Member Functions inherited from t3_widget::mouse_target_t
	mouse_target_t (bool use_window=true)

Protected Attributes inherited from t3_widget::widget_t
bool	enabled
	Widget is enabled. More...

bool	redraw
	Widget requires redrawing on next update_contents call. More...

bool	shown
	Widget is shown. More...

Protected Attributes inherited from t3_widget::window_component_t
cleanup_t3_window_ptr	window
	The t3_window_t used for presenting this item on screen (see libt3window). More...

Detailed Description

Class implementing a checkbox.

Constructor & Destructor Documentation

t3_widget::checkbox_t::checkbox_t ( bool _state = false )

Create a new checkbox_t.

Parameters

_state The initial state of the checkbox_t.

Member Function Documentation

bool t3_widget::checkbox_t::get_state ( void )

Retrieve the current state of the checkbox_t.

bool t3_widget::checkbox_t::is_hotkey ( key_t key )

virtual

Query whether key is a hotkey for this widget.

Reimplemented from t3_widget::widget_t.

bool t3_widget::checkbox_t::process_key ( key_t key )

virtual

Handle a key press by the user.

Returns: A boolean indicating whether this window_component_t handled the key press.

Implements t3_widget::window_component_t.

bool t3_widget::checkbox_t::process_mouse_event ( mouse_event_t event )

virtual

Process a mouse event.

Returns: A boolean indicating whether this mouse_target_t handled the mouse event.

Reimplemented from t3_widget::widget_t.

void t3_widget::checkbox_t::set_enabled ( bool enable )

virtual

Set the enabled status of this widget.

When the checkbox_t is not enabled, it does not accept focus and the contents will be shown as a dash (-).

Reimplemented from t3_widget::widget_t.

void t3_widget::checkbox_t::set_focus ( focus_t focus )

virtual

Set whether this window_component_t has the input focus.

Note that this merely notifies the window_component_t that it should change it's appearance to indicate the user that this window_component_t has the input focus. Which window_component_t actually receives the input events is handled outside of the window_component_t.

Reimplemented from t3_widget::widget_t.

void t3_widget::checkbox_t::set_label ( smart_label_t * _label )

Associate this checkbox_t with a smart_label_t.

bool t3_widget::checkbox_t::set_size	(	optint	height,
		optint	width
	)

virtual

Set the size of this checkbox_t (ignored).

A checkbox_t has a fixed size, so both height and width are ignored.

Implements t3_widget::window_component_t.

void t3_widget::checkbox_t::set_state ( bool _state )

Set the current state of the checkbox_t.

t3_widget::checkbox_t::T3_WIDGET_SIGNAL	(	activate	,
		void
	)

Signal emitted when the button is pressed.

t3_widget::checkbox_t::T3_WIDGET_SIGNAL	(	toggled	,
		void
	)

Signal emitted when the state of the checkbox_t is toggled.

void t3_widget::checkbox_t::update_contents ( void )

virtual

Update the contents of the window.

Implements t3_widget::window_component_t.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation