Reveal widget. More...

#include <platform_reveal.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
void	display (const any_regular_t &value)
void	initialize (HWND parent)
void	measure (extents_t &result)
void	monitor (const setter_type &proc)
void	place (const place_data_t &place_data)
	reveal_t (const std::string &name, const any_regular_t &show_value, theme_t theme, const std::string &alt_text)
	reveal_t (const std::string &name, const any_regular_t &show_value, theme_t theme, const std::string &alt_text)
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)
View Concept Operations
See the View concept and view::hpp for more information.
void	display (const any_regular_t &to_value)
void	display (const bool &to_value)
Controller Concept Operations
See the Controller concept and controller::hpp for more information.
void	monitor (setter_type proc)
void	enable (bool make_enabled)
Public Attributes
std::string	alt_text_m
HWND	control_m
any_regular_t	current_value_m
setter_type	hit_proc_m
label_t	name_m
any_regular_t	show_value_m
theme_t	theme_m
bool	using_label_m

Detailed Description

The semantics of a reveal are that of a ui element that controls the state of a visibility flag. One would use a reveal widget when there is a portion of a view that you want optionally viewable by the user, at the user's discretion (e.g., an "advanced" subsection of the dialog.)

Definition at line 76 of file macintosh/adobe/future/widgets/headers/platform_reveal.hpp.

Member Typedef Documentation

typedef any_regular_t model_type

model type for this widget

Definition at line 79 of file macintosh/adobe/future/widgets/headers/platform_reveal.hpp.

typedef any_regular_t model_type

Definition at line 33 of file windows/adobe/future/widgets/headers/platform_reveal.hpp.

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

Definition at line 35 of file windows/adobe/future/widgets/headers/platform_reveal.hpp.

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

controller callback proc type for this widget

Definition at line 82 of file macintosh/adobe/future/widgets/headers/platform_reveal.hpp.

Constructor & Destructor Documentation

reveal_t	(	const std::string &	name,
		const any_regular_t &	show_value,
		theme_t	theme,
		const std::string &	alt_text
	)

Parameters:

name	Label for the widget
show_value	Value to which the reveal is set when in its show state
theme	Theme for the widget
alt_text	optional text for tooltip display

Note:: If the reveal is set to a value other than show_value, the reveal is considered in its 'hide' state.

reveal_t	(	const std::string &	name,
		const any_regular_t &	show_value,
		theme_t	theme,
		const std::string &	alt_text
	)

Member Function Documentation

void display ( const any_regular_t & to_value )

Note:: When the new value is set for the reveal_t it will be compared to the show-value specified when the widget was created. If the new value matches the show-value, the reveal will be rendered in its 'show' state. Otherwise, the reveal will be rendered in its 'hide' state.

void display ( const bool & to_value )

Note:: This API is the similar to the set operation that takes an any_regular_t, and is intended as an easier way of manipulating a reveal that has default show-value.

Definition at line 136 of file macintosh/adobe/future/widgets/headers/platform_reveal.hpp.

void display ( const any_regular_t & value )