| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495 |
- :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>`
- **Category:** Core
- Brief Description
- -----------------
- Simple button used to represent a link to some resource.
- Properties
- ----------
- +-----------------------------------------------------+-------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`text<class_LinkButton_property_text>` |
- +-----------------------------------------------------+-------------------------------------------------------+
- | :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` | :ref:`underline<class_LinkButton_property_underline>` |
- +-----------------------------------------------------+-------------------------------------------------------+
- Theme Properties
- ----------------
- +---------------------------------+--------------------+
- | :ref:`StyleBox<class_StyleBox>` | focus |
- +---------------------------------+--------------------+
- | :ref:`Font<class_Font>` | font |
- +---------------------------------+--------------------+
- | :ref:`Color<class_Color>` | font_color |
- +---------------------------------+--------------------+
- | :ref:`Color<class_Color>` | font_color_hover |
- +---------------------------------+--------------------+
- | :ref:`Color<class_Color>` | font_color_pressed |
- +---------------------------------+--------------------+
- | :ref:`int<class_int>` | underline_spacing |
- +---------------------------------+--------------------+
- 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.
- Description
- -----------
- This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).
- Property Descriptions
- ---------------------
- .. _class_LinkButton_property_text:
- - :ref:`String<class_String>` **text**
- +----------+-----------------+
- | *Setter* | set_text(value) |
- +----------+-----------------+
- | *Getter* | get_text() |
- +----------+-----------------+
- ----
- .. _class_LinkButton_property_underline:
- - :ref:`UnderlineMode<enum_LinkButton_UnderlineMode>` **underline**
- +----------+---------------------------+
- | *Setter* | set_underline_mode(value) |
- +----------+---------------------------+
- | *Getter* | get_underline_mode() |
- +----------+---------------------------+
|
