checkbox_t Struct Reference
[Concrete Widget Library (Carbon)]

Checkbox widget. More...

#include <platform_checkbox.hpp>


Public Types
typedef any_regular_t	model_type
typedef any_regular_t	model_type
typedef boost::function< void(const model_type &)>	setter_type
typedef boost::function< void(const model_type &)>	setter_type
Public Member Functions
	checkbox_t (const std::string &name, const any_regular_t &true_value, const any_regular_t &false_value, theme_t theme, const std::string &alt_text)
	checkbox_t (const std::string &name, const any_regular_t &true_value, const any_regular_t &false_value, theme_t theme, const std::string &alt_text)
void	display (const any_regular_t &value)
void	enable (bool make_enabled)
void	measure (extents_t &result)
void	monitor (const setter_type &proc)
void	place (const place_data_t &place_data)
View Concept Operations
See the View concept and view::hpp for more information.
void	display (const any_regular_t &value)
Controller Concept Operations
See the Controller concept and controller::hpp for more information.
void	enable (bool make_enabled)
void	monitor (setter_type proc)
Placeable Concept Operations
See the Placeable concept and placeable::hpp for more information.
void	measure (extents_t &result)
void	place (const place_data_t &place_data)
Public Attributes
std::string	alt_text_m
HWND	control_m
any_regular_t	current_value_m
any_regular_t	false_value_m
setter_type	hit_proc_m
std::string	name_m
theme_t	theme_m
any_regular_t	true_value_m
Friends
bool	operator== (const checkbox_t &x, const checkbox_t &y)

Detailed Description

Model Of:

The semantics of a checkbox are that of a flag. One would use a checkbox when you want to have a selectable option turned on or off. There is a third state the checkbox can be in, the undetermined state, which is neither true or false. This is often represented with a dash or a filled checkbox.

Definition at line 75 of file macintosh/adobe/future/widgets/headers/platform_checkbox.hpp.

Member Typedef Documentation

typedef any_regular_t model_type

Definition at line 46 of file windows/adobe/future/widgets/headers/platform_checkbox.hpp.

typedef any_regular_t model_type

The model type for this widget

Definition at line 78 of file macintosh/adobe/future/widgets/headers/platform_checkbox.hpp.

typedef boost::function<void (const model_type&)> setter_type

Definition at line 47 of file windows/adobe/future/widgets/headers/platform_checkbox.hpp.

typedef boost::function<void (const model_type&)> setter_type

The controller callback proc type for this widget

Definition at line 81 of file macintosh/adobe/future/widgets/headers/platform_checkbox.hpp.

Constructor & Destructor Documentation

checkbox_t	(	const std::string &	name,
		const any_regular_t &	true_value,
		const any_regular_t &	false_value,
		theme_t	theme,
		const std::string &	alt_text
	)

Parameters:

	name	is the name of the widget
	true_value	is the value to which the checkbox is set when it is checked
	false_value	is the value to which the checkbox is set when it is unchecked
	theme	details additional visual attributes for the widget
	alt_text	provides additional help text for the widget when the user pauses over it

Note:: If the checkbox is set to a value other than true_value or false_value, the checkbox gets a 'dash' (undefined) state.

checkbox_t	(	const std::string &	name,
		const any_regular_t &	true_value,
		const any_regular_t &	false_value,
		theme_t	theme,
		const std::string &	alt_text
	)

Member Function Documentation

void display ( const any_regular_t & value )

Note:: When the new value is set for the checkbox_t it will be compared to the true- and false-values specified when the widget was created. If the new value matches the true-value, the checkbox will be checked. If the new value matches the false-value, the checkbox will not be checked. Otherwise, the checkbox will be set to an undetermined state.

void enable ( bool make_enabled )