v2.23
IDropDownButton Interface Reference

Represents a button capable of displaying a drop-down list of mutually exclusive actions. More...

Inheritance diagram for IDropDownButton:

Public Member Functions

HRESULT AddAction ([in] IAction *pAction)
 Creates and adds a drop-down button action. More...
 
HRESULT AddSeparator ()
 Adds a separaror to the drop-down button.
 

Properties

IImage Icon [set]
 The drop-down button icon.
 
BSTR ToolTip [get, set]
 The localized string which will be displayed for this drop-down button.
 

Detailed Description

Represents a button capable of displaying a drop-down list of mutually exclusive actions.

A drop-down button is a button which displays a drop-down list of mutually exclusive actions when clicked. It always occupies its own line in a tool panel, with both the icon and text shown on it.

The icon size is 24x24 pixels. If the provided image is bigger, it gets downscaled to fit. If no icon is provided, the space for it is still reserved.

A drop-down button object exists in Renga until the application is closed. It is possible to add the same drop-down button to multiple UI panel extensions.

See also
CreateDropDownButton(), IUIPanelExtension, ISplitButton, IAction

Member Function Documentation

◆ AddAction()

HRESULT IDropDownButton::AddAction ( [in] IAction pAction)

Creates and adds a drop-down button action.

Parameters
[in]pActionThe action to add to the drop-down button action.