mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
136 lines
6.7 KiB
ReStructuredText
136 lines
6.7 KiB
ReStructuredText
.. _class_BaseButton:
|
|
|
|
BaseButton
|
|
==========
|
|
|
|
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Inherited By:** :ref:`TextureButton<class_texturebutton>`, :ref:`Button<class_button>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Provides a base class for different kinds of buttons.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`get_click_on_press<class_BaseButton_get_click_on_press>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
|
|
+--------------------------+-------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
- **released** **(** **)**
|
|
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
|
|
- **pressed** **(** **)**
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **DRAW_NORMAL** = **0**
|
|
- **DRAW_PRESSED** = **1**
|
|
- **DRAW_HOVER** = **2**
|
|
- **DRAW_DISABLED** = **3**
|
|
|
|
Description
|
|
-----------
|
|
|
|
BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_BaseButton__pressed:
|
|
|
|
- void **_pressed** **(** **)** virtual
|
|
|
|
.. _class_BaseButton__toggled:
|
|
|
|
- void **_toggled** **(** :ref:`bool<class_bool>` pressed **)** virtual
|
|
|
|
.. _class_BaseButton_set_pressed:
|
|
|
|
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
|
|
|
|
Set the button to pressed state (only if toggle_mode is active).
|
|
|
|
.. _class_BaseButton_is_pressed:
|
|
|
|
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
|
|
|
|
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
|
|
|
|
.. _class_BaseButton_is_hovered:
|
|
|
|
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
|
|
|
|
.. _class_BaseButton_set_toggle_mode:
|
|
|
|
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
|
|
|
|
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
|
|
|
|
.. _class_BaseButton_is_toggle_mode:
|
|
|
|
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
|
|
|
|
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
|
|
|
|
.. _class_BaseButton_set_disabled:
|
|
|
|
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
|
|
|
|
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
|
|
|
|
.. _class_BaseButton_is_disabled:
|
|
|
|
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
|
|
|
|
Return whether the button is in disabled state (see :ref:`set_disabled<class_BaseButton_set_disabled>`).
|
|
|
|
.. _class_BaseButton_set_click_on_press:
|
|
|
|
- void **set_click_on_press** **(** :ref:`bool<class_bool>` enable **)**
|
|
|
|
Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
|
|
|
|
.. _class_BaseButton_get_click_on_press:
|
|
|
|
- :ref:`bool<class_bool>` **get_click_on_press** **(** **)** const
|
|
|
|
Return the state of the click_on_press property (see :ref:`set_click_on_press<class_BaseButton_set_click_on_press>`).
|
|
|
|
.. _class_BaseButton_get_draw_mode:
|
|
|
|
- :ref:`int<class_int>` **get_draw_mode** **(** **)** const
|
|
|
|
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
|
|
|
|
|