Columns UI SDK  6.5
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
ui_extension::splitter_window Class Referenceabstract

Subclass of ui_extension::window, specifically for splitters. More...

#include <splitter.h>

Inheritance diagram for ui_extension::splitter_window:
ui_extension::window ui_extension::extension_base ui_extension::splitter_window_v2

Public Member Functions

virtual bool get_config_item_supported (t_size p_index, const GUID &p_type) const
 Get config item supported. More...
 
virtual bool get_config_item (t_size index, const GUID &p_type, stream_writer *p_out, abort_callback &p_abort) const
 Creates non-modal child configuration dialog. Since its non-modal, remember to keep a refcounted reference to yourself. Use WS_EX_CONTROLPARENT. More...
 
bool get_config_item (t_size index, const GUID &p_type, stream_writer *p_out) const
 
virtual bool set_config_item (t_size index, const GUID &p_type, stream_reader *p_source, abort_callback &p_abort)
 
template<typename class_t >
bool set_config_item_t (t_size index, const GUID &p_type, const class_t &p_val, abort_callback &p_abort)
 
template<class T >
bool get_config_item (t_size p_index, const GUID &p_type, T &p_out, abort_callback &p_abort) const
 
template<class T >
bool get_config_item (t_size p_index, const GUID &p_type, T &p_out) const
 
virtual void insert_panel (t_size index, const splitter_item_t *p_item)=0
 
virtual void remove_panel (t_size index)=0
 
virtual void replace_panel (t_size index, const splitter_item_t *p_item)=0
 
virtual t_size get_panel_count () const =0
 
virtual t_size get_maximum_panel_count () const
 
virtual void register_callback (splitter_callback *p_callback)
 
virtual void deregister_callback (splitter_callback *p_callback)
 
void get_panel (t_size index, pfc::ptrholder_t< splitter_item_t > &p_out) const
 
t_size add_panel (const splitter_item_t *p_item)
 
void swap_items (t_size p_item1, t_size p_item2)
 
bool move_up (t_size p_index)
 
bool move_down (t_size p_index)
 
bool find_by_ptr (const uie::window::ptr &window, t_size &p_index)
 
void remove_panel (const uie::window::ptr &window)
 
 FB2K_MAKE_SERVICE_INTERFACE (splitter_window, window)
 
- Public Member Functions inherited from ui_extension::window
virtual const bool get_is_single_instance () const =0
 Gets whether the panel is single instance or not. More...
 
virtual void get_category (pfc::string_base &out) const =0
 Gets the category of the extension. More...
 
virtual bool get_short_name (pfc::string_base &out) const
 Gets the short, presumably more user-friendly than the name returned by get_name, name of the panel. More...
 
virtual bool get_description (pfc::string_base &out) const
 Gets the description of the extension. More...
 
virtual unsigned get_type () const =0
 Gets the type of the extension. More...
 
virtual bool get_prefer_multiple_instances () const
 Gets whther the panel prefers to be created in multiple instances. More...
 
virtual bool is_available (const window_host_ptr &p_host) const =0
 Get availability of the extension. More...
 
virtual HWND create_or_transfer_window (HWND wnd_parent, const window_host_ptr &p_host, const ui_helpers::window_position_t &p_position=ui_helpers::window_position_null)=0
 Create or transfer extension window. More...
 
virtual void destroy_window ()=0
 Destroys the extension window. More...
 
virtual HWND get_wnd () const =0
 Gets extension window handle. More...
 
virtual void get_size_limits (size_limit_t &p_out) const
 Gets size limits of the window. More...
 
 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (window)
 
- Public Member Functions inherited from ui_extension::extension_base
virtual const GUID & get_extension_guid () const =0
 Get unique ID of extension. More...
 
virtual void get_name (pfc::string_base &out) const =0
 Get a user-readable name of the extension. More...
 
virtual void set_config (stream_reader *p_reader, t_size p_size, abort_callback &p_abort)
 Set instance configuration data. More...
 
virtual void get_config (stream_writer *p_writer, abort_callback &p_abort) const
 Get instance configuration data. More...
 
virtual void import_config (stream_reader *p_reader, t_size p_size, abort_callback &p_abort)
 Set instance configuration data. This differs from set_config in that the data will be of that returned by export_config. More...
 
virtual void export_config (stream_writer *p_writer, abort_callback &p_abort) const
 Get instance configuration data. This differs from get_config, in that what is written is intended to be transferable between different foobar2000 installations on different computers (i.e. self-contained). More...
 
virtual bool have_config_popup () const
 Gets whether the extension has a modal configuration window. More...
 
virtual bool show_config_popup (HWND wnd_parent)
 Displays a modal configuartion dialog. More...
 
virtual void get_menu_items (menu_hook_t &p_hook)
 Retrieve menu items to be displayed in the host menu. More...
 

Static Public Attributes

static const GUID bool_show_caption
 
static const GUID bool_hidden
 
static const GUID bool_autohide
 
static const GUID bool_locked
 
static const GUID uint32_orientation
 
static const GUID bool_show_toggle_area
 
static const GUID uint32_size
 
static const GUID bool_use_custom_title
 
static const GUID string_custom_title
 

Protected Member Functions

virtual splitter_item_tget_panel (t_size index) const =0
 

Additional Inherited Members

- Static Public Member Functions inherited from ui_extension::window
static bool create_by_guid (const GUID &guid, window_ptr &p_out)
 Creates extension by GUID. More...
 
static HWND g_on_tab (HWND wnd_focus)
 Helper function. Activates next or previous window. More...
 
static bool g_process_keydown_keyboard_shortcuts (WPARAM wp)
 Helper function. Processes keyboard shortcuts using keyboard_shortcut_manager_v2::process_keydown_simple(). Requires foobar2000 >= 0.9.5. More...
 

Detailed Description

Subclass of ui_extension::window, specifically for splitters.

Splitter classes must support multiple instances

Member Function Documentation

t_size ui_extension::splitter_window::add_panel ( const splitter_item_t p_item)
inline
virtual void ui_extension::splitter_window::deregister_callback ( splitter_callback *  p_callback)
inlinevirtual

Reserved for future use

ui_extension::splitter_window::FB2K_MAKE_SERVICE_INTERFACE ( splitter_window  ,
window   
)
bool ui_extension::splitter_window::find_by_ptr ( const uie::window::ptr &  window,
t_size &  p_index 
)
inline
virtual bool ui_extension::splitter_window::get_config_item ( t_size  index,
const GUID &  p_type,
stream_writer *  p_out,
abort_callback &  p_abort 
) const
inlinevirtual

Creates non-modal child configuration dialog. Since its non-modal, remember to keep a refcounted reference to yourself. Use WS_EX_CONTROLPARENT.

bool ui_extension::splitter_window::get_config_item ( t_size  index,
const GUID &  p_type,
stream_writer *  p_out 
) const
inline
template<class T >
bool ui_extension::splitter_window::get_config_item ( t_size  p_index,
const GUID &  p_type,
T &  p_out,
abort_callback &  p_abort 
) const
inline
template<class T >
bool ui_extension::splitter_window::get_config_item ( t_size  p_index,
const GUID &  p_type,
T &  p_out 
) const
inline
virtual bool ui_extension::splitter_window::get_config_item_supported ( t_size  p_index,
const GUID &  p_type 
) const
inlinevirtual

Get config item supported.

Returns
count
virtual t_size ui_extension::splitter_window::get_maximum_panel_count ( ) const
inlinevirtual
virtual splitter_item_t* ui_extension::splitter_window::get_panel ( t_size  index) const
protectedpure virtual

Return value needs deleting!! Use pfc::ptrholder_t This method may be called on both active and inactive (i.e. no window) instances

void ui_extension::splitter_window::get_panel ( t_size  index,
pfc::ptrholder_t< splitter_item_t > &  p_out 
) const
inline
virtual t_size ui_extension::splitter_window::get_panel_count ( ) const
pure virtual
virtual void ui_extension::splitter_window::insert_panel ( t_size  index,
const splitter_item_t p_item 
)
pure virtual

This method may be called on both active and inactive (i.e. no window) instances

bool ui_extension::splitter_window::move_down ( t_size  p_index)
inline
bool ui_extension::splitter_window::move_up ( t_size  p_index)
inline
virtual void ui_extension::splitter_window::register_callback ( splitter_callback *  p_callback)
inlinevirtual

Reserved for future use

virtual void ui_extension::splitter_window::remove_panel ( t_size  index)
pure virtual

This method may be called on both active and inactive (i.e. no window) instances

void ui_extension::splitter_window::remove_panel ( const uie::window::ptr &  window)
inline
virtual void ui_extension::splitter_window::replace_panel ( t_size  index,
const splitter_item_t p_item 
)
pure virtual

This method may be called on both active and inactive (i.e. no window) instances

virtual bool ui_extension::splitter_window::set_config_item ( t_size  index,
const GUID &  p_type,
stream_reader *  p_source,
abort_callback &  p_abort 
)
inlinevirtual
template<typename class_t >
bool ui_extension::splitter_window::set_config_item_t ( t_size  index,
const GUID &  p_type,
const class_t &  p_val,
abort_callback &  p_abort 
)
inline
void ui_extension::splitter_window::swap_items ( t_size  p_item1,
t_size  p_item2 
)
inline

Member Data Documentation

const GUID ui_extension::splitter_window::bool_autohide
static
Initial value:
=
{ 0x40c95dfe, 0xe5e9, 0x4f11, { 0x90, 0xec, 0xe7, 0x41, 0xbe, 0x88, 0x7d, 0xdd } }
const GUID ui_extension::splitter_window::bool_hidden
static
Initial value:
=
{ 0x35fa3514, 0x8120, 0x49e3, { 0xa5, 0x6c, 0x3e, 0xa1, 0xc8, 0x17, 0xa, 0x2e } }
const GUID ui_extension::splitter_window::bool_locked
static
Initial value:
=
{ 0x3661a5e9, 0xfb4, 0x4d2a, { 0xac, 0x5, 0xef, 0x2f, 0x47, 0xd1, 0x8a, 0xd9 } }
const GUID ui_extension::splitter_window::bool_show_caption
static
Initial value:
=
{ 0x4673437d, 0x1685, 0x433f, { 0xa2, 0xcc, 0x38, 0x64, 0xd6, 0x9, 0xf4, 0xe2 } }
const GUID ui_extension::splitter_window::bool_show_toggle_area
static
Initial value:
=
{ 0x5ce8945e, 0xbbb4, 0x4308, { 0x99, 0xc1, 0xdf, 0xa6, 0xd1, 0xf, 0x90, 0x4 } }
const GUID ui_extension::splitter_window::bool_use_custom_title
static
Initial value:
=
{ 0x71bc1fbc, 0xedd1, 0x429c, { 0xb2, 0x62, 0x74, 0xc2, 0xf0, 0xa, 0xb3, 0xd3 } }
const GUID ui_extension::splitter_window::string_custom_title
static
Initial value:
=
{ 0x3b4deda5, 0x493d, 0x4c5c, { 0xb5, 0x2c, 0x3, 0x6d, 0xe4, 0xcf, 0x43, 0xd9 } }
const GUID ui_extension::splitter_window::uint32_orientation
static
Initial value:
=
{ 0x709465de, 0x42cd, 0x484d, { 0xbe, 0x8f, 0xe7, 0x37, 0xf0, 0x1a, 0x64, 0x58 } }
const GUID ui_extension::splitter_window::uint32_size
static
Initial value:
=
{ 0x5cb327ab, 0x34eb, 0x409c, { 0x9b, 0x4e, 0x10, 0xd0, 0xa3, 0xb0, 0x4e, 0x8d } }

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