.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/BaseButton.xml. .. _class_BaseButton: BaseButton ========== **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`Button`, :ref:`LinkButton`, :ref:`TextureButton` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`ActionMode` | :ref:`action_mode` | ``1`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`ButtonGroup` | :ref:`button_group` | | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | |bitfield|\<:ref:`MouseButtonMask`\> | :ref:`button_mask` | ``1`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`button_pressed` | ``false`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`disabled` | ``false`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`keep_pressed_outside` | ``false`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`Shortcut` | :ref:`shortcut` | | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_feedback` | ``true`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`shortcut_in_tooltip` | ``true`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ | :ref:`bool` | :ref:`toggle_mode` | ``false`` | +-------------------------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_pressed` **(** **)** |virtual| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_toggled` **(** :ref:`bool` toggled_on **)** |virtual| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`DrawMode` | :ref:`get_draw_mode` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_hovered` **(** **)** |const| | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pressed_no_signal` **(** :ref:`bool` pressed **)** | +-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_BaseButton_signal_button_down: .. rst-class:: classref-signal **button_down** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_signal_button_up: .. rst-class:: classref-signal **button_up** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_signal_pressed: .. rst-class:: classref-signal **pressed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_signal_toggled: .. rst-class:: classref-signal **toggled** **(** :ref:`bool` toggled_on **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_BaseButton_DrawMode: .. rst-class:: classref-enumeration enum **DrawMode**: .. _class_BaseButton_constant_DRAW_NORMAL: .. rst-class:: classref-enumeration-constant :ref:`DrawMode` **DRAW_NORMAL** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_BaseButton_constant_DRAW_PRESSED: .. rst-class:: classref-enumeration-constant :ref:`DrawMode` **DRAW_PRESSED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_BaseButton_constant_DRAW_HOVER: .. rst-class:: classref-enumeration-constant :ref:`DrawMode` **DRAW_HOVER** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_BaseButton_constant_DRAW_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`DrawMode` **DRAW_DISABLED** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_BaseButton_constant_DRAW_HOVER_PRESSED: .. rst-class:: classref-enumeration-constant :ref:`DrawMode` **DRAW_HOVER_PRESSED** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_BaseButton_ActionMode: .. rst-class:: classref-enumeration enum **ActionMode**: .. _class_BaseButton_constant_ACTION_MODE_BUTTON_PRESS: .. rst-class:: classref-enumeration-constant :ref:`ActionMode` **ACTION_MODE_BUTTON_PRESS** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_BaseButton_constant_ACTION_MODE_BUTTON_RELEASE: .. rst-class:: classref-enumeration-constant :ref:`ActionMode` **ACTION_MODE_BUTTON_RELEASE** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_BaseButton_property_action_mode: .. rst-class:: classref-property :ref:`ActionMode` **action_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_action_mode** **(** :ref:`ActionMode` value **)** - :ref:`ActionMode` **get_action_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_button_group: .. rst-class:: classref-property :ref:`ButtonGroup` **button_group** .. rst-class:: classref-property-setget - void **set_button_group** **(** :ref:`ButtonGroup` value **)** - :ref:`ButtonGroup` **get_button_group** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_button_mask: .. rst-class:: classref-property |bitfield|\<:ref:`MouseButtonMask`\> **button_mask** = ``1`` .. rst-class:: classref-property-setget - void **set_button_mask** **(** |bitfield|\<:ref:`MouseButtonMask`\> value **)** - |bitfield|\<:ref:`MouseButtonMask`\> **get_button_mask** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_button_pressed: .. rst-class:: classref-property :ref:`bool` **button_pressed** = ``false`` .. rst-class:: classref-property-setget - void **set_pressed** **(** :ref:`bool` value **)** - :ref:`bool` **is_pressed** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_disabled: .. rst-class:: classref-property :ref:`bool` **disabled** = ``false`` .. rst-class:: classref-property-setget - void **set_disabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_disabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_keep_pressed_outside: .. rst-class:: classref-property :ref:`bool` **keep_pressed_outside** = ``false`` .. rst-class:: classref-property-setget - void **set_keep_pressed_outside** **(** :ref:`bool` value **)** - :ref:`bool` **is_keep_pressed_outside** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_shortcut: .. rst-class:: classref-property :ref:`Shortcut` **shortcut** .. rst-class:: classref-property-setget - void **set_shortcut** **(** :ref:`Shortcut` value **)** - :ref:`Shortcut` **get_shortcut** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_shortcut_feedback: .. rst-class:: classref-property :ref:`bool` **shortcut_feedback** = ``true`` .. rst-class:: classref-property-setget - void **set_shortcut_feedback** **(** :ref:`bool` value **)** - :ref:`bool` **is_shortcut_feedback** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_shortcut_in_tooltip: .. rst-class:: classref-property :ref:`bool` **shortcut_in_tooltip** = ``true`` .. rst-class:: classref-property-setget - void **set_shortcut_in_tooltip** **(** :ref:`bool` value **)** - :ref:`bool` **is_shortcut_in_tooltip_enabled** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_property_toggle_mode: .. rst-class:: classref-property :ref:`bool` **toggle_mode** = ``false`` .. rst-class:: classref-property-setget - void **set_toggle_mode** **(** :ref:`bool` value **)** - :ref:`bool` **is_toggle_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_BaseButton_private_method__pressed: .. rst-class:: classref-method void **_pressed** **(** **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_private_method__toggled: .. rst-class:: classref-method void **_toggled** **(** :ref:`bool` toggled_on **)** |virtual| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_method_get_draw_mode: .. rst-class:: classref-method :ref:`DrawMode` **get_draw_mode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_method_is_hovered: .. rst-class:: classref-method :ref:`bool` **is_hovered** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_BaseButton_method_set_pressed_no_signal: .. rst-class:: classref-method void **set_pressed_no_signal** **(** :ref:`bool` pressed **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`