#include <ui.h>

Inheritance diagram for ui_control:

Public Member Functions
virtual void	activate ()=0

	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (ui_control)

virtual HICON	get_main_icon ()=0

virtual void	hide ()=0

virtual bool	is_visible ()=0

virtual HICON	load_main_icon (unsigned width, unsigned height)=0

virtual bool	override_status_text_create (service_ptr_t< ui_status_text_override > &p_out)=0

virtual void	show_preferences (const GUID &p_page)=0

Public Member Functions inherited from service_base
template<typename outPtr_t >
bool	cast (outPtr_t &outPtr)

virtual int	service_add_ref ()=0 throw ()

virtual bool	service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)

template<class T >
bool	service_query_t (service_ptr_t< T > &p_out)

virtual int	service_release ()=0 throw ()

Additional Inherited Members
Public Types inherited from service_base
typedef service_base	t_interface

Protected Member Functions inherited from service_base
	service_base ()

	~service_base ()

Detailed Description

Serivce providing various UI-related commands. Implemented by core; do not reimplement. Instantiation: use static_api_ptr_t<ui_control>.

Definition at line 60 of file ui.h.

Member Function Documentation

virtual void ui_control::activate ( )

pure virtual

Activates/unminimizes main UI.

ui_control::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT ( ui_control )

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 void ui_control::hide ( )

pure virtual

Hides/minimizese main UI.

virtual bool ui_control::is_visible ( )

pure virtual

Returns whether primary UI is visible/unminimized.

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 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)

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.

The documentation for this class was generated from the following file: