ui_control Class Reference
#include <ui.h>
Inheritance diagram for ui_control:
Public Types | |
| typedef ui_control | t_interface_entrypoint |
| typedef ui_control | t_interface |
| typedef service_base | t_interface_parent |
Public Member Functions | |
| virtual bool | is_visible ()=0 |
| Returns whether primary UI is visible/unminimized. | |
| virtual void | activate ()=0 |
| Activates/unminimizes main UI. | |
| virtual void | hide ()=0 |
| Hides/minimizese main UI. | |
| virtual HICON | get_main_icon ()=0 |
| Retrieves main GUI icon, to use as window icon etc. Returned handle does not need to be freed. | |
| virtual HICON | load_main_icon (unsigned width, unsigned height)=0 |
| Loads main GUI icon, version with specified width/height. Returned handle needs to be freed with DestroyIcon when you are done using it. | |
| virtual void | show_preferences (const GUID &p_page)=0 |
| Activates preferences dialog and navigates to specified page. See also: preference_page API. | |
| virtual bool | override_status_text_create (service_ptr_t< ui_status_text_override > &p_out)=0 |
Static Public Attributes | |
| static const GUID | class_guid |
Detailed Description
Serivce providing various UI-related commands. Implemented by core; do not reimplement. Instantiation: use static_api_ptr_t<ui_control>.Member Typedef Documentation
| typedef ui_control ui_control::t_interface |
Reimplemented from service_base.
Member Function Documentation
| virtual bool ui_control::is_visible | ( | ) | [pure virtual] |
Returns whether primary UI is visible/unminimized.
| virtual void ui_control::activate | ( | ) | [pure virtual] |
Activates/unminimizes main UI.
| virtual void ui_control::hide | ( | ) | [pure virtual] |
Hides/minimizese main UI.
| virtual HICON ui_control::get_main_icon | ( | ) | [pure virtual] |
Retrieves main GUI icon, to use as window icon etc. Returned handle does not need to be freed.
| virtual HICON ui_control::load_main_icon | ( | unsigned | width, | |
| unsigned | height | |||
| ) | [pure virtual] |
Loads main GUI icon, version with specified width/height. Returned handle needs to be freed with DestroyIcon when you are done using it.
| virtual void ui_control::show_preferences | ( | const GUID & | p_page | ) | [pure virtual] |
Activates preferences dialog and navigates to specified page. See also: preference_page API.
| virtual bool ui_control::override_status_text_create | ( | service_ptr_t< ui_status_text_override > & | p_out | ) | [pure virtual] |
Instantiates ui_status_text_override service, that can be used to display status messages.
- Parameters:
-
p_out receives new ui_status_text_override instance.
- Returns:
- true on success, false on failure (out of memory / no GUI loaded / etc)
Member Data Documentation
const GUID ui_control::class_guid [static] |
Initial value:
{ 0x2dc57ff7, 0x476d, 0x42f5, { 0xa0, 0x5a, 0x60, 0x49, 0x98, 0x96, 0x13, 0x4a } }
The documentation for this class was generated from the following files:
