mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
296 lines
14 KiB
ReStructuredText
296 lines
14 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.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:`String<class_String>` | :ref:`language<class_LinkButton_property_language>` | ``""`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` | :ref:`structured_text_bidi_override<class_LinkButton_property_structured_text_bidi_override>` | ``0`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`Array<class_Array>` | :ref:`structured_text_bidi_override_options<class_LinkButton_property_structured_text_bidi_override_options>` | ``[]`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`String<class_String>` | :ref:`text<class_LinkButton_property_text>` | ``""`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`text_direction<class_LinkButton_property_text_direction>` | ``0`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
| :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` | :ref:`underline<class_LinkButton_property_underline>` | ``0`` |
|
|
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+
|
|
|
|
Theme Properties
|
|
----------------
|
|
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_color<class_LinkButton_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_focus_color<class_LinkButton_theme_color_font_focus_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_hover_color<class_LinkButton_theme_color_font_hover_color>` | ``Color(0.95, 0.95, 0.95, 1)`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_LinkButton_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Color<class_Color>` | :ref:`font_pressed_color<class_LinkButton_theme_color_font_pressed_color>` | ``Color(1, 1, 1, 1)`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`outline_size<class_LinkButton_theme_constant_outline_size>` | ``0`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`underline_spacing<class_LinkButton_theme_constant_underline_spacing>` | ``2`` |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`Font<class_Font>` | :ref:`font<class_LinkButton_theme_font_font>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`font_size<class_LinkButton_theme_font_size_font_size>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_LinkButton_theme_style_focus>` | |
|
|
+---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+
|
|
|
|
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_language:
|
|
|
|
- :ref:`String<class_String>` **language**
|
|
|
|
+-----------+---------------------+
|
|
| *Default* | ``""`` |
|
|
+-----------+---------------------+
|
|
| *Setter* | set_language(value) |
|
|
+-----------+---------------------+
|
|
| *Getter* | get_language() |
|
|
+-----------+---------------------+
|
|
|
|
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_property_structured_text_bidi_override:
|
|
|
|
- :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **structured_text_bidi_override**
|
|
|
|
+-----------+------------------------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+------------------------------------------+
|
|
| *Setter* | set_structured_text_bidi_override(value) |
|
|
+-----------+------------------------------------------+
|
|
| *Getter* | get_structured_text_bidi_override() |
|
|
+-----------+------------------------------------------+
|
|
|
|
Set BiDi algorithm override for the structured text.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_property_structured_text_bidi_override_options:
|
|
|
|
- :ref:`Array<class_Array>` **structured_text_bidi_override_options**
|
|
|
|
+-----------+--------------------------------------------------+
|
|
| *Default* | ``[]`` |
|
|
+-----------+--------------------------------------------------+
|
|
| *Setter* | set_structured_text_bidi_override_options(value) |
|
|
+-----------+--------------------------------------------------+
|
|
| *Getter* | get_structured_text_bidi_override_options() |
|
|
+-----------+--------------------------------------------------+
|
|
|
|
Set additional options for BiDi override.
|
|
|
|
----
|
|
|
|
.. _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_text_direction:
|
|
|
|
- :ref:`TextDirection<enum_Control_TextDirection>` **text_direction**
|
|
|
|
+-----------+---------------------------+
|
|
| *Default* | ``0`` |
|
|
+-----------+---------------------------+
|
|
| *Setter* | set_text_direction(value) |
|
|
+-----------+---------------------------+
|
|
| *Getter* | get_text_direction() |
|
|
+-----------+---------------------------+
|
|
|
|
Base text writing direction.
|
|
|
|
----
|
|
|
|
.. _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.
|
|
|
|
Theme Property Descriptions
|
|
---------------------------
|
|
|
|
.. _class_LinkButton_theme_color_font_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_color**
|
|
|
|
+-----------+-----------------------------------+
|
|
| *Default* | ``Color(0.875, 0.875, 0.875, 1)`` |
|
|
+-----------+-----------------------------------+
|
|
|
|
Default text :ref:`Color<class_Color>` of the ``LinkButton``.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_color_font_focus_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_focus_color**
|
|
|
|
+-----------+--------------------------------+
|
|
| *Default* | ``Color(0.95, 0.95, 0.95, 1)`` |
|
|
+-----------+--------------------------------+
|
|
|
|
Text :ref:`Color<class_Color>` used when the ``LinkButton`` is focused. Only replaces the normal text color of the button. Disabled, hovered, and pressed states take precedence over this color.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_color_font_hover_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_hover_color**
|
|
|
|
+-----------+--------------------------------+
|
|
| *Default* | ``Color(0.95, 0.95, 0.95, 1)`` |
|
|
+-----------+--------------------------------+
|
|
|
|
Text :ref:`Color<class_Color>` used when the ``LinkButton`` is being hovered.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_color_font_outline_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_outline_color**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``Color(1, 1, 1, 1)`` |
|
|
+-----------+-----------------------+
|
|
|
|
The tint of text outline of the ``LinkButton``.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_color_font_pressed_color:
|
|
|
|
- :ref:`Color<class_Color>` **font_pressed_color**
|
|
|
|
+-----------+-----------------------+
|
|
| *Default* | ``Color(1, 1, 1, 1)`` |
|
|
+-----------+-----------------------+
|
|
|
|
Text :ref:`Color<class_Color>` used when the ``LinkButton`` is being pressed.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_constant_outline_size:
|
|
|
|
- :ref:`int<class_int>` **outline_size**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``0`` |
|
|
+-----------+-------+
|
|
|
|
The size of the text outline.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_constant_underline_spacing:
|
|
|
|
- :ref:`int<class_int>` **underline_spacing**
|
|
|
|
+-----------+-------+
|
|
| *Default* | ``2`` |
|
|
+-----------+-------+
|
|
|
|
The vertical space between the baseline of text and the underline.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_font_font:
|
|
|
|
- :ref:`Font<class_Font>` **font**
|
|
|
|
:ref:`Font<class_Font>` of the ``LinkButton``'s text.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_font_size_font_size:
|
|
|
|
- :ref:`int<class_int>` **font_size**
|
|
|
|
Font size of the ``LinkButton``'s text.
|
|
|
|
----
|
|
|
|
.. _class_LinkButton_theme_style_focus:
|
|
|
|
- :ref:`StyleBox<class_StyleBox>` **focus**
|
|
|
|
:ref:`StyleBox<class_StyleBox>` used when the ``LinkButton`` is focused. The ``focus`` :ref:`StyleBox<class_StyleBox>` is displayed *over* the base :ref:`StyleBox<class_StyleBox>`, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the base :ref:`StyleBox<class_StyleBox>` remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
|
|
|
|
.. |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.)`
|