LinkButton

Inherits: BaseButton < Control < CanvasItem < Node < Object

A button that represents a link.

Description

A button that represents a link. This type of button is primarily used for interactions that cause a context change (like linking to a web page).

See also BaseButton which contains common properties and methods associated with this node.

Properties

FocusMode	focus_mode	0 (overrides Control)
String	language	""
CursorShape	mouse_default_cursor_shape	2 (overrides Control)
StructuredTextParser	structured_text_bidi_override	0
Array	structured_text_bidi_override_options	[]
String	text	""
TextDirection	text_direction	0
UnderlineMode	underline	0
String	uri	""

Theme Properties

Color	font_color	Color(0.875, 0.875, 0.875, 1)
Color	font_focus_color	Color(0.95, 0.95, 0.95, 1)
Color	font_hover_color	Color(0.95, 0.95, 0.95, 1)
Color	font_outline_color	Color(1, 1, 1, 1)
Color	font_pressed_color	Color(1, 1, 1, 1)
int	outline_size	0
int	underline_spacing	2
Font	font
int	font_size
StyleBox	focus

---

Enumerations

enum UnderlineMode:

UnderlineMode UNDERLINE_MODE_ALWAYS = 0

The LinkButton will always show an underline at the bottom of its text.

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.

UnderlineMode UNDERLINE_MODE_NEVER = 2

The LinkButton will never show an underline at the bottom of its text.

---

Property Descriptions

String language = ""

• void set_language ( String value )

• String get_language ( )

Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

---

StructuredTextParser structured_text_bidi_override = 0

• void set_structured_text_bidi_override ( StructuredTextParser value )

• StructuredTextParser get_structured_text_bidi_override ( )

Set BiDi algorithm override for the structured text.

---

Array structured_text_bidi_override_options = []

• void set_structured_text_bidi_override_options ( Array value )

• Array get_structured_text_bidi_override_options ( )

Set additional options for BiDi override.

---

String text = ""

• void set_text ( String value )

• String get_text ( )

The button's text that will be displayed inside the button's area.

---

TextDirection text_direction = 0

• void set_text_direction ( TextDirection value )

• TextDirection get_text_direction ( )

Base text writing direction.

---

UnderlineMode underline = 0

• void set_underline_mo