mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
71 lines
3.1 KiB
ReStructuredText
71 lines
3.1 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_LinkButton:
|
|
|
|
LinkButton
|
|
==========
|
|
|
|
**Inherits:** :ref:`BaseButton<class_basebutton>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Simple button used to represent a link to some resource
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_string>` | :ref:`get_text<class_LinkButton_get_text>` **(** **)** const |
|
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_underline_mode<class_LinkButton_get_underline_mode>` **(** **)** const |
|
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_text<class_LinkButton_set_text>` **(** :ref:`String<class_string>` text **)** |
|
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_underline_mode<class_LinkButton_set_underline_mode>` **(** :ref:`int<class_int>` underline_mode **)** |
|
|
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Numeric Constants
|
|
-----------------
|
|
|
|
- **UNDERLINE_MODE_ALWAYS** = **0** --- The LinkButton will always show an underline at the bottom of its text
|
|
- **UNDERLINE_MODE_ON_HOVER** = **1** --- The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
|
|
- **UNDERLINE_MODE_NEVER** = **2** --- The LinkButton will never show an underline at the bottom of its text.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_LinkButton_get_text:
|
|
|
|
- :ref:`String<class_string>` **get_text** **(** **)** const
|
|
|
|
Returns the text of the button.
|
|
|
|
.. _class_LinkButton_get_underline_mode:
|
|
|
|
- :ref:`int<class_int>` **get_underline_mode** **(** **)** const
|
|
|
|
Returns the underline mode for this button.
|
|
|
|
.. _class_LinkButton_set_text:
|
|
|
|
- void **set_text** **(** :ref:`String<class_string>` text **)**
|
|
|
|
Sets the text of the button.
|
|
|
|
.. _class_LinkButton_set_underline_mode:
|
|
|
|
- void **set_underline_mode** **(** :ref:`int<class_int>` underline_mode **)**
|
|
|
|
Sets the underline mode for this button, the argument must be one of the :ref:`LinkButton<class_linkbutton>` constants (see constants section).
|
|
|
|
|