:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/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. .. rst-class:: classref-introduction-group 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. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``0`` (overrides :ref:`Control`) | +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`CursorShape` | mouse_default_cursor_shape | ``2`` (overrides :ref:`Control`) | +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`text` | ``""`` | +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`UnderlineMode` | :ref:`underline` | ``0`` | +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`uri` | ``""`` | +-----------------------------------------------------+-------------------------------------------------------+-------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Theme Properties ---------------- .. table:: :widths: auto +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color` | ``Color( 0.88, 0.88, 0.88, 1 )`` | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_focus` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_hover` | ``Color( 0.94, 0.94, 0.94, 1 )`` | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`font_color_pressed` | ``Color( 1, 1, 1, 1 )`` | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`int` | :ref:`underline_spacing` | ``2`` | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`Font` | :ref:`font` | | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ | :ref:`StyleBox` | :ref:`focus` | | +---------------------------------+-----------------------------------------------------------------------------+----------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_LinkButton_UnderlineMode: .. rst-class:: classref-enumeration enum **UnderlineMode**: .. _class_LinkButton_constant_UNDERLINE_MODE_ALWAYS: .. rst-class:: classref-enumeration-constant :ref:`UnderlineMode` **UNDERLINE_MODE_ALWAYS** = ``0`` The LinkButton will always show an underline at the bottom of its text. .. _class_LinkButton_constant_UNDERLINE_MODE_ON_HOVER: .. rst-class:: classref-enumeration-constant :ref:`UnderlineMode` **UNDERLINE_MODE_ON_HOVER** = ``1`` The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. .. _class_LinkButton_constant_UNDERLINE_MODE_NEVER: .. rst-class:: classref-enumeration-constant :ref:`UnderlineMode` **UNDERLINE_MODE_NEVER** = ``2`` The LinkButton will never show an underline at the bottom of its text. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_LinkButton_property_text: .. rst-class:: classref-property :ref:`String` **text** = ``""`` .. rst-class:: classref-property-setget - void **set_text** **(** :ref:`String` value **)** - :ref:`String` **get_text** **(** **)** The button's text that will be displayed inside the button's area. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_property_underline: .. rst-class:: classref-property :ref:`UnderlineMode` **underline** = ``0`` .. rst-class:: classref-property-setget - void **set_underline_mode** **(** :ref:`UnderlineMode` value **)** - :ref:`UnderlineMode` **get_underline_mode** **(** **)** The underline mode to use for the text. See :ref:`UnderlineMode` for the available modes. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_property_uri: .. rst-class:: classref-property :ref:`String` **uri** = ``""`` .. rst-class:: classref-property-setget - void **set_uri** **(** :ref:`String` value **)** - :ref:`String` **get_uri** **(** **)** The `URI `__ for this **LinkButton**. If set to a valid URI, pressing the button opens the URI using the operating system's default program for the protocol (via :ref:`OS.shell_open`). HTTP and HTTPS URLs open the default web browser. \ **Examples:**\ :: uri = "https://godotengine.org" # Opens the URL in the default web browser. uri = "C:\SomeFolder" # Opens the file explorer at the given path. uri = "C:\SomeImage.png" # Opens the given image in the default viewing app. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Theme Property Descriptions --------------------------- .. _class_LinkButton_theme_color_font_color: .. rst-class:: classref-themeproperty :ref:`Color` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )`` Default text :ref:`Color` of the **LinkButton**. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_color_font_color_focus: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_focus** = ``Color( 0.94, 0.94, 0.94, 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. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_color_font_color_hover: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_hover** = ``Color( 0.94, 0.94, 0.94, 1 )`` Text :ref:`Color` used when the **LinkButton** is being hovered. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_color_font_color_pressed: .. rst-class:: classref-themeproperty :ref:`Color` **font_color_pressed** = ``Color( 1, 1, 1, 1 )`` Text :ref:`Color` used when the **LinkButton** is being pressed. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_constant_underline_spacing: .. rst-class:: classref-themeproperty :ref:`int` **underline_spacing** = ``2`` The vertical space between the baseline of text and the underline. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_font_font: .. rst-class:: classref-themeproperty :ref:`Font` **font** :ref:`Font` of the **LinkButton**'s text. .. rst-class:: classref-item-separator ---- .. _class_LinkButton_theme_style_focus: .. rst-class:: classref-themeproperty :ref:`StyleBox` **focus** :ref:`StyleBox` used when the **LinkButton** is focused. It is displayed over the current :ref:`StyleBox`, so using :ref:`StyleBoxEmpty` will just disable the focus visual effect. .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`