ui_extension Namespace Reference

Namespace for UI Extension services. More...

Classes
class	button
	Service that provides buttons for a toolbar. More...
class	button_callback
	Class implemented by button hosts to recieve notification of button events. More...
class	button_factory
	Service factory for buttons. More...
class	container_ui_extension_t
	Wraps ui_helpers::container_window into a panel. More...
class	custom_button
	Sub-class of ui_extension::button, for buttons that implement their own command. More...
class	extension_base
	Base class for ui_extension::window and ui_extension::visualisation classes. More...
class	menu_button
	Sub-class of ui_extension::button, for buttons based upon a context menu item. More...
class	menu_node_configure
	Standard implementation of ui_extension::menu_node_command_t, for a "Configure..." menu item. More...
class	menu_window
	Subclass of ui_extension::window, specifically for menubars. More...
class	playlist_window
	Subclass of ui_extension::window for playlist views. More...
struct	size_limit_t
	Class describing the size limits of a window. More...
class	splitter_item_full_impl_t
class	splitter_item_full_t
	Implements splitter_item_t with a full set of data stored. More...
class	splitter_item_simple
	Implements splitter_item_t with the standard set of data stored. More...
class	splitter_item_t
	Holds data about a splitter item. More...
class	splitter_window
	Subclass of ui_extension::window, specifically for splitters. More...
class	stream_writer_fixedbuffer
class	visualisation
	Interface for vis_extension service. This service allows you to embed the default Columns UI visualisation, and any other visualisations that implement it, into your own window. More...
class	visualisation_factory
	Service factory for vis extensions. More...
class	visualisation_host
	Interface for visualisation extension hosts. More...
class	visualisation_host_factory
	Service factory for vis extension hosts. More...
class	visualization_host_factory
class	window
	Interface for window service. More...
class	window_base_t
class	window_factory
	Service factory for multiple instance windows. More...
class	window_factory_single
	Service factory for single instance windows. More...
class	window_factory_transparent_single
	Service factory for single instance windows. More...
class	window_host
	Interface for window_host service. More...
class	window_host_factory
	Service factory for window hosts. More...
class	window_host_factory_single
	Service factory for window hosts. More...
class	window_host_factory_transparent_single
	Service factory for window hosts. More...
class	window_host_with_control
	Sub-class of window_host, providing methods for external control. More...
class	window_info_list_simple
	Helper class to hold information about many ui_extension services. More...
class	window_info_simple
	Helper class to hold information about ui_extension services. More...
Typedefs
typedef container_ui_extension_t< ui_helpers::container_window, ui_extension::menu_window >	container_menu_ui_extension
typedef container_ui_extension_t< ui_helpers::container_window, ui_extension::window >	container_ui_extension
typedef pfc::refcounted_object_ptr_t< class menu_node_t >	menu_node_ptr
typedef service_ptr_t< class menu_window >	menu_window_ptr
typedef service_ptr_t< class playlist_window >	playlist_window_ptr
typedef pfc::ptrholder_t< splitter_item_t >	splitter_item_ptr
typedef splitter_item_simple< splitter_item_t >	splitter_item_simple_t
typedef service_ptr_t< class splitter_window >	splitter_window_ptr
typedef service_ptr_t< class visualisation_host >	visualisation_host_ptr
typedef service_ptr_t< class visualisation >	visualisation_ptr
typedef visualisation	visualization
typedef visualisation_host_ptr	visualization_host_ptr
typedef visualisation_ptr	visualization_ptr
typedef service_ptr_t< class window_host >	window_host_ptr
typedef service_ptr_t< class window >	window_ptr
Enumerations
enum	resize_flag_t { size_width = (1 << 0), size_height = (1 << 1) }
	Flags indicating whether the size and height parameters are valid. More...
enum	size_limit_flag_t {   size_limit_minimum_width = (1 << 0), size_limit_maximum_width = (1 << 1), size_limit_minimum_height = (1 << 2), size_limit_maximum_height = (1 << 3),   size_limit_all = size_limit_minimum_width|size_limit_maximum_width|size_limit_minimum_height|size_limit_maximum_height }
	Flags indicating a change of a size limit. More...
enum	t_button_guid { BUTTON_GUID_BUTTON, BUTTON_GUID_MENU_ITEM_CONTEXT, BUTTON_GUID_MENU_ITEM_MAIN }
	Identifies the type of GUID. More...
enum	t_button_state { BUTTON_STATE_ENABLED = (1 << 0), BUTTON_STATE_PRESSED = (1 << 1), BUTTON_STATE_SHOW_TOOLTIP = (1 << 2), BUTTON_STATE_DEFAULT = BUTTON_STATE_ENABLED|BUTTON_STATE_SHOW_TOOLTIP }
	Identifies the state of a button. More...
enum	t_button_type { BUTTON_TYPE_NORMAL, BUTTON_TYPE_DROPDOWN, BUTTON_TYPE_DROPDOWN_ARROW }
	Identifies the type of button. More...
enum	t_mask { MASK_NONE, MASK_BITMAP, MASK_COLOUR }
enum	window_type_t {   type_panel = (1 << 0), type_toolbar = (1 << 1), type_playlist = (1 << 2), type_layout = (1 << 3),   type_splitter = (1 << 4) }
	Flags indicating the type of the UI extension. More...

---

Detailed Description

Namespace for UI Extension services.

---

Enumeration Type Documentation

enum ui_extension::resize_flag_t

Flags indicating whether the size and height parameters are valid. Combine multiple flags using bitwise or. See also: ui_extension::window_host::on_size_limit_change Enumerator: size_width  The width parameter is valid. size_height  The height parameter is valid.

enum ui_extension::size_limit_flag_t

Flags indicating a change of a size limit. Combine multiple flags using bitwise or, if more than one size limit changed. See also: window_host::on_size_limit_change Enumerator: size_limit_minimum_width  The minimum width changed. size_limit_maximum_width  The maximum width changed. size_limit_minimum_height  The minimum height changed. size_limit_maximum_height  The maximum height changed. size_limit_all  All size limits changed.

enum ui_extension::t_button_guid

Identifies the type of GUID. Enumerator: BUTTON_GUID_BUTTON  GUID identifies a button command BUTTON_GUID_MENU_ITEM_CONTEXT  GUID identifies a context menu command BUTTON_GUID_MENU_ITEM_MAIN  GUID identifies a main menu command

enum ui_extension::t_button_state

Identifies the state of a button. Combine multiple flags using bitwise or. See also: button::get_button_state Enumerator: BUTTON_STATE_ENABLED  The button is enabled BUTTON_STATE_PRESSED  The button is in an active state BUTTON_STATE_SHOW_TOOLTIP  The button displays a ToolTip BUTTON_STATE_DEFAULT  The default button state

enum ui_extension::t_button_type

Identifies the type of button. Enumerator: BUTTON_TYPE_NORMAL  The button acts as a standard click button BUTTON_TYPE_DROPDOWN  The button displays a drop-down menu when pressed BUTTON_TYPE_DROPDOWN_ARROW  The button displays an arrow which displays a drop-down menu

enum ui_extension::t_mask

Enumerator: MASK_NONE  No transparency mask is used. MASK_BITMAP  1bpp bitmap transparency mask is used MASK_COLOUR  Pixels with specified colour are transparent.

enum ui_extension::window_type_t

Flags indicating the type of the UI extension. Remarks: Combine multiple flags using bitwise or, if an extension supports more than one type. See also: window::get_type, window_host_with_control::get_supported_types Enumerator: type_panel  The extension is a sidebar panel. type_toolbar  The extension is a toolbar panel. type_playlist  The extension is a playlist panel. type_layout  The extension is a layout panel. type_splitter  The extension is a splitter panel.

---