presets_t Struct Reference |
Public Types | |
typedef dictionary_t | model_type |
typedef dictionary_t | model_type |
typedef popup_t::setter_type | setter_type |
typedef preset_setter_type | setter_type |
Public Member Functions | |
void | display (const model_type &value) |
void | display_additional_preset_set (const array_t &value) |
void | display_additional_preset_set (const array_t &value) |
void | do_imbue (const popup_t::model_type &value) |
void | measure (extents_t &result) |
void | monitor (const setter_type &proc) |
void | place (const place_data_t &place_data) |
presets_t (const std::string &name, const std::string &domain, const std::string &alt_text, const array_t &bind_set, const dictionary_t &localization_set, theme_t theme) | |
presets_t (const std::string &name, const std::string &domain, const std::string &alt_text, const array_t &bind_set, const dictionary_t &localization_set, theme_t theme) | |
void | snapshot_callback (const model_snapshot_proc_t &proc) |
void | snapshot_callback (const model_snapshot_proc_t &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) |
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 setter_type &proc) |
Public Attributes | |
std::string | alt_text_m |
array_t | bind_set_m |
popup_t | category_popup_m |
array_t | composite_m |
HWND | control_m |
bool | custom_m |
array_t | default_preset_set_m |
std::string | domain_m |
array_t | dynamic_preset_set_m |
dictionary_t | last_m |
dictionary_t | localization_set_m |
std::string | name_m |
long | popup_height_m |
popup_t | popup_m |
setter_type | proc_m |
bool | selected_m |
model_snapshot_proc_t | snapshot_proc_m |
theme_t | theme_m |
bool | type_2_debounce_m |
array_t | user_preset_set_m |
Detailed Description
UI core presets widget.
- Model Of:
The semantics of a preset widget is a widget that can save and restore "snapshots" of the state of the current model. These snapshots are given a name and can be recalled and imposed upon a model at any time, allowing for the user of the model to preserve, well, presets.
The semantics of a preset widget is a widget that can save and restore "snapshots" of the state of the current model. These snapshots are given a name and can be recalled and imposed upon a model at any time, allowing for the user of the model to preserve, well, presets.
Definition at line 80 of file macintosh/adobe/future/widgets/headers/platform_presets.hpp.
Member Typedef Documentation
typedef dictionary_t model_type |
model type for this widget
Definition at line 83 of file macintosh/adobe/future/widgets/headers/platform_presets.hpp.
typedef dictionary_t model_type |
Definition at line 49 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
typedef popup_t::setter_type setter_type |
Definition at line 50 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
typedef preset_setter_type setter_type |
controller callback proc type for this widget
Definition at line 86 of file macintosh/adobe/future/widgets/headers/platform_presets.hpp.
Constructor & Destructor Documentation
presets_t | ( | const std::string & | name, |
const std::string & | domain, | ||
const std::string & | alt_text, | ||
const array_t & | bind_set, | ||
const dictionary_t & | localization_set, | ||
theme_t | theme | ||
) |
- Parameters:
-
name Preset file name (xyz becomes xyz.preset) domain Domain of the widget (usually the name of the application) alt_text Additional help text for the widget when the user pauses over it bind_set Array of name/string pairs that area values which will be saved/restored by presets localization_set Set of named arguments that contain the basic string keys for localization of widget-private resources (e.g., the keys used in the add/delete subdialogs to the preset widget). theme Theme for the widget
- Note:
- If the presets is set to a value other than
true_value
orfalse_value
, the presets gets a 'dash' (undefined) state.
presets_t | ( | const std::string & | name, |
const std::string & | domain, | ||
const std::string & | alt_text, | ||
const array_t & | bind_set, | ||
const dictionary_t & | localization_set, | ||
theme_t | theme | ||
) |
- Parameters:
-
name Preset file name (xyz becomes xyz.preset) domain Domain of the widget (usually the name of the application) alt_text Additional help text for the widget when the user pauses over it bind_set Array of name/string pairs that area values which will be saved/restored by presets localization_set Set of named arguments that contain the basic string keys for localization of widget-private resources (e.g., the keys used in the add/delete subdialogs to the preset widget). theme Theme for the widget
- Note:
- If the presets is set to a value other than
true_value
orfalse_value
, the presets gets a 'dash' (undefined) state.
Member Function Documentation
void display | ( | const model_type & | value ) |
void display | ( | const model_type & | value ) |
- Parameters:
-
value Preset settings to which we need to be set
void display_additional_preset_set | ( | const array_t & | value ) |
- Note:
- This function is to allow for the preset widget to obtain runtime-generated presets from the application (or property model) as is required by the app.
- Parameters:
-
value Set of additional preset data to be added to the preset listings
void display_additional_preset_set | ( | const array_t & | value ) |
- Parameters:
-
value Set of additional preset data to be added to the preset listings
void do_imbue | ( | const popup_t::model_type & | value ) |
void measure | ( | extents_t & | result ) |
void measure | ( | extents_t & | result ) |
- Parameters:
-
result The ideal extent values for this widget given its current attributes
void monitor | ( | const setter_type & | proc ) |
- Parameters:
-
proc Procedure called to imbue the model with preset data
Definition at line 97 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
void monitor | ( | const setter_type & | proc ) |
Definition at line 150 of file macintosh/adobe/future/widgets/headers/platform_presets.hpp.
void place | ( | const place_data_t & | place_data ) |
- Parameters:
-
place_data Position information to apply to the widget
void place | ( | const place_data_t & | place_data ) |
void snapshot_callback | ( | const model_snapshot_proc_t & | proc ) |
- Parameters:
-
proc Procedure called when a model snapshot is needed
Definition at line 103 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
void snapshot_callback | ( | const model_snapshot_proc_t & | proc ) |
- Parameters:
-
proc Procedure called when a model snapshot is needed
Definition at line 157 of file macintosh/adobe/future/widgets/headers/platform_presets.hpp.
Member Data Documentation
std::string alt_text_m |
Definition at line 114 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 111 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 108 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 127 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
HWND control_m |
Definition at line 106 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
bool custom_m |
Definition at line 121 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 125 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
std::string domain_m |
Definition at line 113 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 124 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 118 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 107 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
std::string name_m |
Definition at line 112 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
long popup_height_m |
Definition at line 116 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 109 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 120 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
bool selected_m |
Definition at line 115 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 117 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 110 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
bool type_2_debounce_m |
Definition at line 119 of file windows/adobe/future/widgets/headers/platform_presets.hpp.
Definition at line 126 of file windows/adobe/future/widgets/headers/platform_presets.hpp.