C++ Syntax

class MKI_BUTTON_DATA

{

public:

__int32 m_nType,

m_nButtonState;

LPWSTR m_pszButtonText,

m_pszOptionText;

MKI_ICON_DATA m_cIconData;

};

This structure contains a button's complete description, i.e. its title and its icon.

Element Description

Type

[__int32] When identifying a plug-in's button, this value contains command type flags of the plug-in's button. A bit-wise OR combination of the following flags:

MKI_MENUMODE_ENTRY

If this flag is set, the corresponding button is a standard button and will be displayed. Otherwise, the button is not visible. This can be used to dynamically show and hide buttons without having to reorder the complete list.

MKI_MENUMODE_SEPARATOR

If this flag is set, a separating space will be inserted after the corresponding button (if the button itself is visible).

MKI_MENUMODE_END

This flag is used to terminate the command list. The entry in which MKI_MENUMODE_END is set is the final entry to be used.

ButtonState

[__int32] Current display state of the button (see MKI_BUTTONSTATE_*)

ButtonText Changed in Version 2019.1

[LPWSTR] Address of a null-terminated string that contains the button's description that will be displayed if the mouse pointer is above that button.

OptionText New in Version 2023.0

[LPWSTR] Address of a null-terminated string that contains the button's option text that will be displayed in the context display if the user right-clicks this button. Set to nullptr to indicate that there are no options for this button. Will be ignored if ButtonState contains MKI_BUTTONSTATE_NO_RBUTTON.

IconData

[MKI_ICON_DATA] Icon for the button. The IconMode element must be 0!