Button

class Button
property id

The id of the button.

Type

str, read-only

property visible

The visible state of the button.

Type

bool

property name

The name of the button.

Type

str, read-only

property shortcut

The shortcut assigned to the button.

Type

str

CustomButton

class CustomButton

Base class: Button

property id

The id of the button.

Type

str, read-only

property visible

The visible state of the button.

Type

bool

property name

The name of the button.

Type

str, read-only

property shortcut

The shortcut assigned to the button.

Type

str

property script

The script path of the button.

Type

str

property icon

The icon file path of the button.

Type

str

property label

The label of the button.

Type

str

property description

The description of the button.

Type

str

CycleButton

class CycleButton

Base class: Button

property id

The id of the button.

Type

str, read-only

property visible

The visible state of the button.

Type

bool

property name

The name of the button.

Type

str, read-only

property shortcut

The shortcut assigned to the button.

Type

str

insert_action(name)

Insert action from name in the cycle button.

Parameters

name (str) -- The name of the action inserted.

create_custom_action(name)

Create custom action from name in the popup

Note

The action's name must be unique in the whole application.

Parameters

name (str) -- The name of the the new custom action created.

Returns

The new custom action created.

Return type

CustomAction

PopupButton

class PopupButton

Base class: Button

property id

The id of the button.

Type

str, read-only

property visible

The visible state of the button.

Type

bool

property name

The name of the button.

Type

str, read-only

property shortcut

The shortcut assigned to the button.

Type

str

insert_action(name)

Insert action from name in the popup.

Parameters

name (str) -- The name of the action inserted.

create_custom_action(name)

Create custom action from name in the popup

Note

The action's name must be unique in the whole application.

Parameters

name (str) -- The name of the the new custom action created.

Returns

The new custom action created.

Return type

CustomAction

TinyPopupButton

class TinyPopupButton

Base class: Button

property id

The id of the button.

Type

str, read-only

property visible

The visible state of the button.

Type

bool

property name

The name of the button.

Type

str, read-only

property shortcut

The shortcut assigned to the button.

Type

str

property icon

The icon file path of the button.

Type

str

property label

The label of the button.

Type

str

property description

The description of the button.

Type

str

insert_action(name)

Insert action from name in the popup.

Parameters

name (str) -- The name of the action inserted.

create_custom_action(name)

Create custom action from name in the popup

Note

The action's name must be unique in the whole application.

Parameters

name (str) -- The name of the new custom action created.

Returns

The new custom action created.

Return type

CustomAction