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

Sub-class of ui_extension::button, for buttons based upon a context menu item. More...

#include <buttons.h>

Inheritance diagram for ui_extension::menu_button:
ui_extension::button

Public Member Functions

virtual void select_subcommand (const GUID &p_subcommand)=0
 Sets subcommand that subsequent function calls will refer to. More...
 
 FB2K_MAKE_SERVICE_INTERFACE (menu_button, button)
 
- Public Member Functions inherited from ui_extension::button
virtual const GUID & get_item_guid () const =0
 Get the identifier of the button. More...
 
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. More...
 
virtual HBITMAP get_item_bitmap (unsigned command_state_index, COLORREF cr_btntext, t_mask &p_mask_type, COLORREF &cr_mask, HBITMAP &bm_mask) const =0
 Get a handle to a bitmap and its transparency mask of the menu item. More...
 
virtual t_button_type get_button_type () const
 Get type of button. More...
 
virtual void get_menu_items (menu_hook_t &p_out)
 Gets menu items for drop-down buttons. More...
 
virtual unsigned get_button_state () const
 Gets buttons state. More...
 
virtual unsigned get_command_state_index () const
 Gets current state of the command. For example, in a "Play or pause" command this would indicate the play or pause state. More...
 
virtual unsigned get_command_state_count () const
 Gets total count of possible command states. More...
 
virtual void get_command_state_name (unsigned index, pfc::string_base &p_out) const
 Gets name of specified command state. More...
 
virtual void register_callback (button_callback &p_callback)
 Registers a button_callback class to receive callbacks. More...
 
virtual void deregister_callback (button_callback &p_callback)
 Deregisters a button_callback class to stop receiving callbacks. More...
 
 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (button)
 

Detailed Description

Sub-class of ui_extension::button, for buttons based upon a context menu item.

Member Function Documentation

ui_extension::menu_button::FB2K_MAKE_SERVICE_INTERFACE ( menu_button  ,
button   
)
virtual void ui_extension::menu_button::select_subcommand ( const GUID &  p_subcommand)
pure virtual

Sets subcommand that subsequent function calls will refer to.

Called after instantiation, but before other command-related methods.

Parameters
[in]p_subcommandSpecifies the subcommand that this object wll represent

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