mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
108 lines
5.1 KiB
ReStructuredText
108 lines
5.1 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the LinkButton.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_LinkButton:
|
|
|
|
LinkButton
|
|
==========
|
|
|
|
**Inherits:** :ref:`BaseButton<class_BaseButton>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Simple button used to represent a link to some resource.
|
|
|
|
Description
|
|
-----------
|
|
|
|
This kind of button is primarily used when the interaction with the button causes a context change (like linking to a web page).
|
|
|
|
See also :ref:`BaseButton<class_BaseButton>` which contains common properties and methods associated with this node.
|
|
|
|
Properties
|
|
----------
|
|
|
|
+-----------------------------------------------------+-------------------------------------------------------+---------------------------+
|
|
| :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``0`` *(parent override)* |
|
|
+-----------------------------------------------------+-------------------------------------------------------+---------------------------+
|
|
| :ref:`CursorShape<enum_Control_CursorShape>` | mouse_default_cursor_shape | ``2`` *(parent override)* |
|
|
+-----------------------------------------------------+-------------------------------------------------------+---------------------------+
|
|
| :ref:`String<class_String>` | :ref:`text<class_LinkButton_property_text>` | ``""`` |
|
|
+-----------------------------------------------------+-------------------------------------------------------+---------------------------+
|
|
| :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` | :ref:`underline<class_LinkButton_property_underline>` | ``0`` |
|
|
+-----------------------------------------------------+-------------------------------------------------------+---------------------------+
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | focus | |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`Font<class_Font>` | font | |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`Color<class_Color>` | font_color_hover | Color( 0.94, 0.94, 0.94, 1 ) |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`Color<class_Color>` | font_color_pressed | Color( 1, 1, 1, 1 ) |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
| :ref:`int<class_int>` | underline_spacing | 2 |
|
|
+---------------------------------+--------------------+------------------------------+
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_LinkButton_UnderlineMode:
|
|
|
|
.. _class_LinkButton_constant_UNDERLINE_MODE_ALWAYS:
|
|
|
|
.. _class_LinkButton_constant_UNDERLINE_MODE_ON_HOVER:
|
|
|
|
.. _class_LinkButton_constant_UNDERLINE_MODE_NEVER:
|
|
|
|
enum **UnderlineMode**:
|
|
|
|
- **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.
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_LinkButton_property_text:
|
|
|
|
- :ref:`String<class_String>` **text**
|
|
|
|
+-----------+-----------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+-----------------+
|
|
| *Setter* | set_text(value) |
|
|
+-----------+-----------------+
|
|
| *Getter* | get_text() |
|
|
+-----------+-----------------+
|
|
|
|
The button's text that will be displayed inside the button's area.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_property_underline:
|
|
|
|
- :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` **underline**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_underline_mode(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_underline_mode() |
|
|
+-----------+---------------------------+
|
|
|
|
Determines when to show the underline. See :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` for options.
|
|
|
|
.. |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.)`
|