radio_button_t Struct Reference |
Public Types | |
typedef any_regular_t | model_type |
typedef any_regular_t | model_type |
typedef boost::function< void(const model_type &)> | setter_type |
Public Member Functions | |
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) |
radio_button_t (const std::string &name, const std::string &alt_text, const any_regular_t &value, theme_t theme) | |
radio_button_t (const std::string &name, const std::string &alt_text, const any_regular_t &set_value, theme_t theme) | |
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 model_type &value) |
Controller Concept Operations | |
See the Controller concept and controller::hpp for more information. | |
void | monitor (const radio_button_monitor_proc_t &proc) |
void | enable (bool make_enabled) |
Public Attributes | |
std::string | alt_text_m |
HWND | control_m |
setter_type | hit_proc_m |
any_regular_t | last_m |
std::string | name_m |
any_regular_t | set_value_m |
theme_t | theme_m |
Detailed Description
The semantics of a radio button are that of a set of mutually exclusive options from which the user must pick. One radio button is presented for every option available.
Definition at line 65 of file macintosh/adobe/future/widgets/headers/platform_radio_button.hpp.
Member Typedef Documentation
typedef any_regular_t model_type |
model type for this widget
Definition at line 68 of file macintosh/adobe/future/widgets/headers/platform_radio_button.hpp.
typedef any_regular_t model_type |
Definition at line 36 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
typedef boost::function<void (const model_type&)> setter_type |
Definition at line 37 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
Constructor & Destructor Documentation
radio_button_t | ( | const std::string & | name, |
const std::string & | alt_text, | ||
const any_regular_t & | value, | ||
theme_t | theme | ||
) |
- Parameters:
-
name Name of the widget alt_text Alt text for the widget (supplemental information for the user) value Value to which the radio button is set when it is selected theme Theme for the widget
radio_button_t | ( | const std::string & | name, |
const std::string & | alt_text, | ||
const any_regular_t & | set_value, | ||
theme_t | theme | ||
) |
Member Function Documentation
void display | ( | const model_type & | value ) |
- Note:
- When the new value is set for the radio button it will be compared to the value specified when the widget was created. If the new value matches that value the radio button will be selected. Otherwise, the radio button will not be selected.
void display | ( | const any_regular_t & | value ) |
void enable | ( | bool | make_enabled ) |
- Parameters:
-
make_enabled Specifies whether or not to show this widget enabled
void enable | ( | bool | make_enabled ) |
void measure | ( | extents_t & | result ) |
void measure | ( | extents_t & | result ) |
void monitor | ( | const radio_button_monitor_proc_t & | proc ) |
- Note:
- The following table outlines the state changes for a radio button when it is clicked on:
Previous state New state not selected
selected
selected
selected
void monitor | ( | const setter_type & | proc ) |
void place | ( | const place_data_t & | place_data ) |
void place | ( | const place_data_t & | place_data ) |
Member Data Documentation
std::string alt_text_m |
Definition at line 56 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
HWND control_m |
Definition at line 54 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
Definition at line 59 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
Definition at line 60 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
std::string name_m |
Definition at line 55 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
Definition at line 57 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.
Definition at line 58 of file windows/adobe/future/widgets/headers/platform_radio_button.hpp.