ui_element_instance_callback Class Reference

#include <ui_element.h>

Inheritance diagram for ui_element_instance_callback:
service_base ui_element_instance_callback_v2 ui_element_instance_callback_v3 ui_element_instance_callback_impl< t_receiver >

List of all members.

Public Member Functions

virtual void on_min_max_info_change ()=0
virtual void on_alt_pressed (bool p_state)=0
 Deprecated, does nothing.
virtual bool query_color (const GUID &p_what, t_ui_color &p_out)=0
 Returns true on success, false when the color is undefined and defaults such as global windows settings should be used.
virtual bool request_activation (service_ptr_t< class ui_element_instance > p_item)=0
virtual bool is_edit_mode_enabled ()=0
 Queries whether "edit mode" is enabled. Most of UI element editing functionality should be locked when it's not.
virtual void request_replace (service_ptr_t< class ui_element_instance > p_item)=0
t_ui_font query_font ()
 Deprecated - use query_font_ex. Equivalent to query_font_ex(ui_font_default).
virtual t_ui_font query_font_ex (const GUID &p_what)=0
 Retrieves an user-configurable font to use for specified kind of display. See ui_font_* constant for possible parameters.
t_ui_color query_std_color (const GUID &p_what)
 Helper - a wrapper around query_color(), if the color is not user-overridden, returns relevant system color.
bool is_elem_visible_ (service_ptr_t< class ui_element_instance > elem)
t_size notify_ (ui_element_instance *source, const GUID &what, t_size param1, const void *param2, t_size param2size)
bool set_elem_label (ui_element_instance *source, const char *label)
t_uint32 get_dialog_texture (ui_element_instance *source)
bool is_border_needed (ui_element_instance *source)

Detailed Description

Callback class passed by a UI element host to a UI element instance, allowing each UI element instance to communicate with its host.
Each ui_element_instance_callback implementation must also implement ui_element_instance_callback_v2.


Member Function Documentation

t_uint32 ui_element_instance_callback::get_dialog_texture ( ui_element_instance source  ) 
bool ui_element_instance_callback::is_border_needed ( ui_element_instance source  ) 
virtual bool ui_element_instance_callback::is_edit_mode_enabled (  )  [pure virtual]

Queries whether "edit mode" is enabled. Most of UI element editing functionality should be locked when it's not.

Implemented in ui_element_instance_callback_impl< t_receiver >.

bool ui_element_instance_callback::is_elem_visible_ ( service_ptr_t< class ui_element_instance elem  ) 
t_size ui_element_instance_callback::notify_ ( ui_element_instance source,
const GUID &  what,
t_size  param1,
const void *  param2,
t_size  param2size 
)
virtual void ui_element_instance_callback::on_alt_pressed ( bool  p_state  )  [pure virtual]

Deprecated, does nothing.

Implemented in ui_element_instance_callback_impl< t_receiver >.

virtual void ui_element_instance_callback::on_min_max_info_change (  )  [pure virtual]
virtual bool ui_element_instance_callback::query_color ( const GUID &  p_what,
t_ui_color p_out 
) [pure virtual]

Returns true on success, false when the color is undefined and defaults such as global windows settings should be used.

Implemented in ui_element_instance_callback_impl< t_receiver >.

t_ui_font ui_element_instance_callback::query_font (  )  [inline]

Deprecated - use query_font_ex. Equivalent to query_font_ex(ui_font_default).

virtual t_ui_font ui_element_instance_callback::query_font_ex ( const GUID &  p_what  )  [pure virtual]

Retrieves an user-configurable font to use for specified kind of display. See ui_font_* constant for possible parameters.

Implemented in ui_element_instance_callback_impl< t_receiver >.

t_ui_color ui_element_instance_callback::query_std_color ( const GUID &  p_what  ) 

Helper - a wrapper around query_color(), if the color is not user-overridden, returns relevant system color.

virtual bool ui_element_instance_callback::request_activation ( service_ptr_t< class ui_element_instance p_item  )  [pure virtual]

Tells the host that specified element wants to activate itself as a result of some kind of external user command (eg. menu command). Host should ensure that requesting child element's window is visible.

Returns:
True when relevant child element window has been properly made visible and requesting code should proceed to SetFocus their window etc, false when denied.

Implemented in ui_element_instance_callback_impl< t_receiver >.

virtual void ui_element_instance_callback::request_replace ( service_ptr_t< class ui_element_instance p_item  )  [pure virtual]

Tells the host that the user has requested the element to be replaced with another one. Note: this is generally used only when "edit mode" is enabled, but legal to call when it's not (eg. dummy element calls it regardless of settings when clicked).

Implemented in ui_element_instance_callback_impl< t_receiver >.

bool ui_element_instance_callback::set_elem_label ( ui_element_instance source,
const char *  label 
)

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated by  doxygen 1.6.2