godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with 2.1 source, goodbye 2.0!

Browse Source
This commit is contained in:
Rémi Verschelde
2016-08-10 21:33:38 +02:00
parent 6f795d4295
commit f629e839e5
125 changed files with 5464 additions and 2321 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
classes/class_basebutton.rst
View File

@@ -8,7 +8,7 @@ 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>`
**Inherited By:** :ref:`LinkButton<class_linkbutton>`, :ref:`TextureButton<class_texturebutton>`, :ref:`Button<class_button>`
**Category:** Core
@@ -20,31 +20,39 @@ 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 |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :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 |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`_pressed<class_BaseButton__pressed>` **(** **)** virtual |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :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 |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_enabled_focus_mode<class_BaseButton_get_enabled_focus_mode>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_shortcut<class_BaseButton_get_shortcut>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enabled_focus_mode<class_BaseButton_set_enabled_focus_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shortcut<class_BaseButton_set_shortcut>` **(** :ref:`Object<class_object>` shortcut **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+------------------------------+-----------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -93,6 +101,16 @@ Return the state of the click_on_press property (see :ref:`set_click_on_press<cl
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.
.. _class_BaseButton_get_enabled_focus_mode:
- :ref:`int<class_int>` **get_enabled_focus_mode** **(** **)** const
Returns focus access mode used when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_set_focus_mode>` and :ref:`set_disabled<class_BaseButton_set_disabled>`).
.. _class_BaseButton_get_shortcut:
- :ref:`Object<class_object>` **get_shortcut** **(** **)** const
.. _class_BaseButton_is_disabled:
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
@@ -129,12 +147,22 @@ Set the button click_on_press mode. This mode generates click events when a mous
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
.. _class_BaseButton_set_enabled_focus_mode:
- void **set_enabled_focus_mode** **(** :ref:`int<class_int>` mode **)**
Sets the focus access mode to use when switching between enabled/disabled (see :ref:`Control.set_focus_mode<class_Control_set_focus_mode>` and :ref:`set_disabled<class_BaseButton_set_disabled>`).
.. _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_set_shortcut:
- void **set_shortcut** **(** :ref:`Object<class_object>` shortcut **)**
.. _class_BaseButton_set_toggle_mode:
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**