BaseButton¶
继承¶
Control
简要描述¶
不同种类的按钮的基类。
描述¶
BaseButton是按钮的抽象基类，因此不应直接使用它（不显示任何内容）。
成员¶
| 类型 | 属性名 | 默认值 |
|---|---|---|
| int | action_mode | 1 |
| int | button_mask | 1 |
| bool | disabled | false |
| int | focus_mode | 2 |
| ButtonGroup | group | |
| bool | keep_pressed_outside | false |
| bool | pressed | false |
| ShortCut | shortcut | |
| bool | shortcut_in_tooltip | true |
| bool | toggle_mode | false |
方法¶
| 返回值类型 | 方法名称 |
|---|---|
| void | _pressed() virtual |
| void | _toggled(button_pressed: bool) virtual |
| int | get_draw_mode() const |
| bool | is_hovered() const |
信号¶
当按钮开始按住时发出。
当按钮停止按下时发出。
- pressed
切换或按下按钮时发出。
- toggled
在仅在按下状态和正常状态之间切换按钮时发出（仅当toggle_mode处于活动状态时）。
枚举¶
enum DrawMode: - DRAW_NORMAL = 0
按钮的正常状态（即未按下，未悬停，未切换和启用）。
- DRAW_PRESSED = 1
按下按钮的状态。
- DRAW_HOVER = 2
按钮的状态已悬停。
- DRAW_DISABLED = 3
按钮的状态被禁用。
- DRAW_HOVER_PRESSED = 4
按钮的状态既被悬停又被按下。
enum ActionMode: - ACTION_MODE_BUTTON_PRESS = 0
仅需按一下即可认为是单击了按钮。
- ACTION_MODE_BUTTON_RELEASE = 1
需要按一下，然后再释放才能认为是单击了该按钮。
常量¶
成员说明¶
- int action_mode
| Default | 1 |
|---|---|
| setter | set_action_mode(value) |
| getter | get_action_mode |
- int
| Default | 1 |
|---|---|
| setter | set_button_mask(value) |
| getter | get_button_mask |
- bool disabled
| Default | false |
|---|---|
| setter | set_disabled(value) |
| getter | is_disabled |
- int focus_mode
| Default | 2 |
|---|---|
| setter | set_focus_mode(value) |
| getter | get_focus_mode |
- ButtonGroup group
| setter | set_button_group(value) |
|---|---|
| getter | get_button_group |
- bool keep_pressed_outside
| Default | false |
|---|---|
| setter | set_keep_pressed_outside(value) |
| getter | is_keep_pressed_outside |
- bool pressed
| Default | false |
|---|---|
| setter | set_pressed(value) |
| getter | is_pressed |
- ShortCut shortcut
| setter | set_shortcut(value) |
|---|---|
| getter | get_shortcut |
- bool shortcut_in_tooltip
| Default | true |
|---|---|
| setter | set_shortcut_in_tooltip(value) |
| getter | is_shortcut_in_tooltip_enabled |
- bool toggle_mode
| Default | false |
|---|---|
| setter | set_toggle_mode(value) |
| getter | is_toggle_mode |
方法说明¶
- _pressed _pressed() virtual
按下按钮时调用。
- _toggled _toggled(button_pressed: bool) virtual
切换按钮时调用（仅当toggle_mode处于活动状态时）。
- get_draw_mode get_draw_mode() const
返回用于绘制按钮的视觉状态。
- is_hovered is_hovered() const
如果鼠标已进入按钮但尚未离开按钮，则返回true。