BaseButton

Inherits: Control < CanvasItem < Node < Object

继承人: ButtonLinkButtonTextureButton

类别: 核心

简要说明

用于不同类型按钮的基类。

方法

无效

_pressed ( ) virtual

无效

_toggled ( bool button_pressed ) virtual

DrawMode

get_draw_mode ( ) const

bool

is_hovered ( ) const

信号

  • button_down ( )

当按钮开始被按下时发出。

  • button_up ( )

当按钮停止按下时发出。

  • pressed ( )

在切换或按下按钮时发出。这个开着 button_down 如果 action_modeACTION_MODE_BUTTON_PRESS 以及在 button_up 否则。

  • toggled ( bool button_pressed )

按钮刚在按下状态和正常状态之间切换时发出(仅当 toggle_mode 激活)。新状态包含在 button_pressed 争论。

枚举

枚举 DrawMode

  • DRAW_NORMAL = 0 ---按钮的正常状态(即未按下、未悬停、未切换和启用)。

  • DRAW_PRESSED = 1 ---按钮状态被按下。

  • DRAW_HOVER = 2 ---按钮状态悬停。

  • DRAW_DISABLED = 3 ---按钮状态被禁用。

  • DRAW_HOVER_PRESSED = 4

枚举 ActionMode

  • ACTION_MODE_BUTTON_PRESS = 0 ---只需按一下就可以考虑单击的按钮。

  • ACTION_MODE_BUTTON_RELEASE = 1 ---在考虑单击按钮之前,需要按下并随后释放。

描述

baseButton是按钮的抽象基类,因此不应直接使用它(它不显示任何内容)。其他类型的按钮继承自它。

属性描述

违约

1

设定器

设置动作模式(值)

吸气剂

获取动作模式()。

确定按钮被视为单击的时间,其中一个 ACTION_MODE_* 常量。

  • int button_mask

违约

1

设定器

设置按钮掩码(值)

吸气剂

获取按钮掩码()。

选择此按钮将响应的鼠标按钮的二进制掩码。

要允许左键单击和右键单击,请使用 BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT .

违约

设定器

设置禁用(值)

吸气剂

已禁用(

如果 true ,按钮处于禁用状态,无法单击或切换。

违约

2

设定器

设置“启用焦点”模式(值)

吸气剂

启用焦点模式()。

在启用/禁用之间切换时使用的焦点访问模式(请参见 Control.focus_modedisabled

设定器

设置按钮组(值)

吸气剂

获取按钮组()

ButtonGroup 与按钮关联。

  • bool keep_pressed_outside

违约

设定器

设置“保持按下”在外部(值)

吸气剂

保持在外边

如果 true ,当光标在按钮外移动时,按钮保持按下状态。

违约

设定器

设置按下(值)

吸气剂

按下()键

如果 true ,按钮的状态被按下。表示按下或切换按钮(如果切换模式激活)。

设定器

设置快捷方式(值)

吸气剂

获取快捷方式()

ShortCut 与按钮关联。

  • bool shortcut_in_tooltip

违约

设定器

在工具提示(值)中设置快捷方式

吸气剂

在工具提示中是否启用了快捷方式?

如果 true ,按钮将在工具提示中添加有关其快捷方式的信息。

违约

设定器

设置切换模式(值)

吸气剂

是“切换模式”()

如果 true ,按钮处于切换模式。使按钮在每次单击其区域时处于按下和未按下之间的翻转状态。

方法说明

  • void _pressed ( ) virtual

当按下按钮时调用。

  • void _toggled ( bool button_pressed ) virtual

当按钮被切换时调用(仅当切换模式处于活动状态时)。

返回用于绘制按钮的视觉状态。这主要在通过重写_draw()或连接到“draw”信号来实现自己的draw代码时有用。按钮的视觉状态由 DRAW_* 枚举。

  • bool is_hovered ( ) const

返回 true 如果鼠标已输入按钮,但尚未离开。