Columns UI SDK  6.5
Public Member Functions | List of all members
ui_extension::window_host_with_control Class Referenceabstract

Sub-class of window_host, providing methods for external control. More...

#include <window_host.h>

Inheritance diagram for ui_extension::window_host_with_control:
ui_extension::window_host

Public Member Functions

virtual unsigned get_supported_types () const =0
 Get supported UI extension types. More...
 
virtual void insert_extension (const GUID &guid, unsigned height, unsigned width)=0
 Insert new instance of a UI extension. More...
 
virtual void insert_extension (window_ptr &p_ext, unsigned height, unsigned width)=0
 Insert existing instance of a UI extension. More...
 
virtual void get_name (pfc::string_base &out) const =0
 Get the name of the host. More...
 
virtual bool is_available () const =0
 Get availability of the host. More...
 
 FB2K_MAKE_SERVICE_INTERFACE (window_host_with_control, window_host)
 
- Public Member Functions inherited from ui_extension::window_host
virtual const GUID & get_host_guid () const =0
 Get the unique ID of the host. More...
 
virtual void on_size_limit_change (HWND wnd, unsigned flags)=0
 Notify host about changed size limits of a hosted extension. More...
 
virtual unsigned is_resize_supported (HWND wnd) const =0
 Called by panels hosted by this host to find out whether the host supports resizing. More...
 
virtual bool request_resize (HWND wnd, unsigned flags, unsigned width, unsigned height)=0
 Called by ui extension hosted by this host to resize your window. More...
 
virtual bool override_status_text_create (service_ptr_t< ui_status_text_override > &p_out)=0
 Instantiates ui_status_text_override service, that can be used to display status messages. More...
 
virtual bool get_keyboard_shortcuts_enabled () const
 Query if keyboard shortcuts should be processed. More...
 
virtual bool is_visible (HWND wnd) const =0
 Query if extension window is visible. More...
 
virtual bool is_visibility_modifiable (HWND wnd, bool desired_visibility) const =0
 Query if extension window can be hidden or shown. More...
 
virtual bool set_window_visibility (HWND wnd, bool visibility)=0
 Hides or shows extension window. More...
 
virtual void relinquish_ownership (HWND wnd)=0
 Relinquish ownership of a UI extension instance. More...
 
 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (window_host)
 

Detailed Description

Sub-class of window_host, providing methods for external control.

In addition to the methods exposed through the window_host interface, this interface provides information about the host and its state as well as methods to manage hosted extensions.

Member Function Documentation

ui_extension::window_host_with_control::FB2K_MAKE_SERVICE_INTERFACE ( window_host_with_control  ,
window_host   
)
virtual void ui_extension::window_host_with_control::get_name ( pfc::string_base &  out) const
pure virtual

Get the name of the host.

Get a user-readable name of the host.

Warning
Do not use the name to identify hosts; use host GUIDs instead.
Parameters
[out]outreceives the name of the host, e.g. "My UI/Sidebar"
See also
get_host_guid
virtual unsigned ui_extension::window_host_with_control::get_supported_types ( ) const
pure virtual

Get supported UI extension types.

Returns
a combination of window_flag::TYPE_* flags to indicate recommended types for the host
See also
window_flag::window_type
virtual void ui_extension::window_host_with_control::insert_extension ( const GUID &  guid,
unsigned  height,
unsigned  width 
)
pure virtual

Insert new instance of a UI extension.

Creates an instance of the specified extension and inserts it into the host's client area. Single-instance extensions should removed themselves from the old host, if any.

Precondition
May only be called, if is_available() returned true.
Parameters
[in]guidunique ID of the UI extension to be inserted
[in]heightdesired height of the new panel
[in]widthdesired width of the new panel
See also
is_available, window::init_or_take_ownership
virtual void ui_extension::window_host_with_control::insert_extension ( window_ptr p_ext,
unsigned  height,
unsigned  width 
)
pure virtual

Insert existing instance of a UI extension.

Inserts the given UI extension instance into the host's client area.

Precondition
May only be called, if is_available() returned true.
Parameters
[in]p_extpointer to the UI extension instance to be inserted
[in]heightdesired height of the new panel
[in]widthdesired width of the new panel
See also
is_available, window::init_or_take_ownership
virtual bool ui_extension::window_host_with_control::is_available ( ) const
pure virtual

Get availability of the host.

Returns
true if it is possible to insert a UI extension into the host.
See also
insert_extension(const GUID &, unsigned, unsigned), insert_extension(window *, unsigned, unsigned)

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