ui_extension::window_host_with_control Class Reference

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

#include <window_host.h>

Inheritance diagram for ui_extension::window_host_with_control:

List of all members.

Public Member Functions
virtual void	get_name (pfc::string_base &out) const =0
	Get the name of the host.
virtual unsigned	get_supported_types () const =0
	Get supported UI extension types.
virtual void	insert_extension (window_ptr &p_ext, unsigned height, unsigned width)=0
	Insert existing instance of a UI extension.
virtual void	insert_extension (const GUID &guid, unsigned height, unsigned width)=0
	Insert new instance of a UI extension.
virtual bool	is_available () const =0
	Get availability of the host.
Public Attributes
	window_host
	window_host_with_control

---

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

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]  out  receives 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 (  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_ext  pointer to the UI extension instance to be inserted [in]  height  desired height of the new panel [in]  width  desired width of the new panel See also: is_available, window::init_or_take_ownership

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]  guid  unique ID of the UI extension to be inserted [in]  height  desired height of the new panel [in]  width  desired 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:

• foobar2000/columns_ui-sdk/window_host.h

---