:github_url: hide .. 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/doc/classes/LinkButton.xml. .. _class_LinkButton: LinkButton ========== **Inherits:** :ref:`BaseButton` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`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` which contains common properties and methods associated with this node. Properties ---------- +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`language` | ``""`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`StructuredTextParser` | :ref:`structured_text_bidi_override` | ``0`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`Array` | :ref:`structured_text_bidi_override_options` | ``[]`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`text` | ``""`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`TextDirection` | :ref:`text_direction` | ``0`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ | :ref:`UnderlineMode` | :ref:`underline` | ``0`` | +-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------+ Theme Properties ---------------- +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`outline_size` | ``0`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`underline_spacing` | ``2`` | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+-----------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`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` **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` **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` **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` **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` **text_direction** +-----------+---------------------------+ | *Default* | ``0`` | +-----------+---------------------------+ | *Setter* | set_text_direction(value) | +-----------+---------------------------+ | *Getter* | get_text_direction() | +-----------+---------------------------+ Base text writing direction. ---- .. _class_LinkButton_property_underline: - :ref:`UnderlineMode` **underline** +-----------+---------------------------+ | *Default* | ``0`` | +-----------+---------------------------+ | *Setter* | set_underline_mode(value) | +-----------+---------------------------+ | *Getter* | get_underline_mode() | +-----------+---------------------------+ Determines when to show the underline. See :ref:`UnderlineMode` for options. Theme Property Descriptions --------------------------- .. _class_LinkButton_theme_color_font_color: - :ref:`Color` **font_color** +-----------+-----------------------------------+ | *Default* | ``Color(0.875, 0.875, 0.875, 1)`` | +-----------+-----------------------------------+ Default text :ref:`Color` of the ``LinkButton``. ---- .. _class_LinkButton_theme_color_font_focus_color: - :ref:`Color` **font_focus_color** +-----------+--------------------------------+ | *Default* | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------+--------------------------------+ Text :ref:`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` **font_hover_color** +-----------+--------------------------------+ | *Default* | ``Color(0.95, 0.95, 0.95, 1)`` | +-----------+--------------------------------+ Text :ref:`Color` used when the ``LinkButton`` is being hovered. ---- .. _class_LinkButton_theme_color_font_outline_color: - :ref:`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` **font_pressed_color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ Text :ref:`Color` used when the ``LinkButton`` is being pressed. ---- .. _class_LinkButton_theme_constant_outline_size: - :ref:`int` **outline_size** +-----------+-------+ | *Default* | ``0`` | +-----------+-------+ The size of the text outline. ---- .. _class_LinkButton_theme_constant_underline_spacing: - :ref:`int` **underline_spacing** +-----------+-------+ | *Default* | ``2`` | +-----------+-------+ The vertical space between the baseline of text and the underline. ---- .. _class_LinkButton_theme_font_font: - :ref:`Font` **font** :ref:`Font` of the ``LinkButton``'s text. ---- .. _class_LinkButton_theme_font_size_font_size: - :ref:`int` **font_size** Font size of the ``LinkButton``'s text. ---- .. _class_LinkButton_theme_style_focus: - :ref:`StyleBox` **focus** :ref:`StyleBox` used when the ``LinkButton`` is focused. The ``focus`` :ref:`StyleBox` is displayed *over* the base :ref:`StyleBox`, so a partially transparent :ref:`StyleBox` should be used to ensure the base :ref:`StyleBox` remains visible. A :ref:`StyleBox` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`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.)`