v2.23
IUIPanelExtension Interface Reference

IUIPanelExtension represents a collection of UI elements which are placed in a separate layout group of a UI panel. More...

Inheritance diagram for IUIPanelExtension:

Public Member Functions

HRESULT AddToolButton ([in] IAction *pAction)
 Adds a tool button to the panel extension. More...
 
HRESULT AddSplitButton ([in] ISplitButton *pSplitButton)
 Adds a split button to the panel extension. More...
 
HRESULT AddDropDownButton ([in] IDropDownButton *pDropDownButton)
 Adds a drop-down button to the panel extension. More...
 

Detailed Description

IUIPanelExtension represents a collection of UI elements which are placed in a separate layout group of a UI panel.

Actions can be grouped in three ways:

  • as tool buttons contained directly in panel extensions,
  • contained within split buttons,
  • contained within drop-down buttons.

To display its contents, the extension has to be added to a UI panel. Controls in the extension are displayed in the order they were added to it. The same extension can be added to different panels.

An extension exists in Renga until the application is closed.

See also
IUI::CreateUIPanelExtension(), IUI::AddExtensionToPrimaryPanel(), IUI::AddExtensionToActionsPanel()

Member Function Documentation

◆ AddDropDownButton()

HRESULT IUIPanelExtension::AddDropDownButton ( [in] IDropDownButton pDropDownButton)

Adds a drop-down button to the panel extension.

Parameters
[in]pDropDownButtonThe drop-down button to add.
See also
IUI::CreateDropDownButton()

◆ AddSplitButton()

HRESULT IUIPanelExtension::AddSplitButton ( [in] ISplitButton pSplitButton)

Adds a split button to the panel extension.

Parameters
[in]pSplitButtonThe split button to add.
See also
IUI::CreateSplitButton()

◆ AddToolButton()

HRESULT IUIPanelExtension::AddToolButton ( [in] IAction pAction)

Adds a tool button to the panel extension.

Parameters
[in]pActionThe action for the button to add
See also
IUI::CreateAction()