#include <IRhRdkHeaderButtonHandler.h>
This interface represents a handler for putting custom buttons on the header of IRhinoUiSection.
- See also
- IRhinoUiSection::HeaderButtonHandler().
◆ ~IRhRdkHeaderButtonHandler()
| virtual IRhRdkHeaderButtonHandler::~IRhRdkHeaderButtonHandler |
( |
| ) |
|
|
inlinevirtual |
◆ ButtonDetails()
| virtual bool IRhRdkHeaderButtonHandler::ButtonDetails |
( |
int |
index, |
|
|
CRhinoDib & |
iconOut, |
|
|
ON_wString & |
sToolTipOut |
|
) |
| const |
|
pure virtual |
Implement this method to describe custom buttons on the section header. RDK calls this method continually increasing iIndex until it returns false.
- Parameters
-
| index | is the button index starting at zero and increasing with each call. |
| iconOut | accepts the button's imagery, or 'icon'. If an icon is not required, do not set this parameter. |
| sToolTipOut | accepts the button's tool-tip. If a tool-tip is not required, do not set this parameter. |
- Returns
- true if button is required, false to stop.
◆ ButtonRect()
| virtual ON_4iRect IRhRdkHeaderButtonHandler::ButtonRect |
( |
int |
index, |
|
|
const ON_4iRect & |
rectHeader |
|
) |
| const |
|
pure virtual |
Implement this method to get the rectangle of a button on the header window.
- Parameters
-
| index | is the index of the button. |
| rectHeader | is the usable area of the header where the buttons can be placed. |
- Returns
- The rectangle of the button.
◆ DeleteThis()
| virtual void IRhRdkHeaderButtonHandler::DeleteThis |
( |
void |
| ) |
|
|
pure virtual |
You must implement this method as
◆ EVF()
| virtual void* IRhRdkHeaderButtonHandler::EVF |
( |
const wchar_t * |
, |
|
|
void * |
|
|
) |
| |
|
pure virtual |
Emergency virtual function for future expansion.
◆ OnButtonClicked()
| virtual bool IRhRdkHeaderButtonHandler::OnButtonClicked |
( |
int |
index | ) |
|
|
pure virtual |
Implement this method to handle a button click.
- Parameters
-
| index | is the index of the button that was clicked. |
- Returns
- true if handled successfully, else false.
