ui_extension::custom_button Class Reference

Sub-class of ui_extension::button, for buttons that implement their own command. More...

#include <buttons.h>

Inheritance diagram for ui_extension::custom_button:

List of all members.

Public Member Functions
virtual void	execute (const pfc::list_base_const_t< metadb_handle_ptr > &p_items)=0
	Executes the custom button's command.
virtual bool	get_description (pfc::string_base &p_out) const
	Gets the description of the custom button.
virtual t_button_guid	get_guid_type () const
	Get whether get_item_guid() specifies a main menu item, a context menu, or a custom button command.
virtual void	get_name (pfc::string_base &p_out) const =0
	Gets the name of the custom button.
Static Public Member Functions
static bool	g_button_get_name (const GUID &p_guid, pfc::string_base &p_out)
Public Attributes
	button
	custom_button

---

Detailed Description

Sub-class of ui_extension::button, for buttons that implement their own command.

---

Member Function Documentation

virtual void ui_extension::custom_button::execute (  const pfc::list_base_const_t< metadb_handle_ptr > &  p_items  )  [pure virtual]

Executes the custom button's command. Parameters: [in]  p_items  Items to perform the command on

virtual bool ui_extension::custom_button::get_description (  pfc::string_base &  p_out  )  const [inline, virtual]

Gets the description of the custom button. Parameters: [out]  p_out  Recieves the description of the button, UTF-8 encoded Returns: true iff the button has a description

virtual t_button_guid ui_extension::custom_button::get_guid_type (   )  const [inline, virtual]

Get whether get_item_guid() specifies a main menu item, a context menu, or a custom button command. Note: Only recommended use of button-only buttons are dropdown-only buttons Returns: type of command represnted by this class See also: t_button_guid Reimplemented from ui_extension::button.

virtual void ui_extension::custom_button::get_name (  pfc::string_base &  p_out  )  const [pure virtual]

Gets the name of the custom button. Parameters: [out]  p_out  Recieves the name of the button, UTF-8 encoded

---

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

• foobar2000/columns_ui-sdk/buttons.h

---