LinkButton¶

Inherits: BaseButton < Control < CanvasItem < Node < 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 BaseButton which contains common properties and methods associated with this node.

Properties¶

String	language	`""`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
String	text	`""`
TextDirection	text_direction	`0`
UnderlineMode	underline	`0`

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:

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¶

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.

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.

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.

String text

Default	`""`
Setter	set_text(value)
Getter	get_text()

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

TextDirection text_direction

Default	`0`
Setter	set_text_direction(value)
Getter	get_text_direction()

Base text writing direction.

UnderlineMode underline

Default	`0`
Setter	set_underline_mode(value)
Getter	get_underline_mode()

Determines when to show the underline. See UnderlineMode for options.

Theme Property Descriptions¶

Color font_color

Default

Color(0.875, 0.875, 0.875, 1)

Default text Color of the LinkButton.

Color font_focus_color

Default

Color(0.95, 0.95, 0.95, 1)

Text 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.

Color font_hover_color

Default

Color(0.95, 0.95, 0.95, 1)

Text Color used when the LinkButton is being hovered.

Color font_outline_color

Default

Color(1, 1, 1, 1)

The tint of text outline of the LinkButton.

Color font_pressed_color

Default

Color(1, 1, 1, 1)

Text Color used when the LinkButton is being pressed.

int outline_size

Default

0

The size of the text outline.

int underline_spacing

Default

2

The vertical space between the baseline of text and the underline.

Font font

Font of the LinkButton's text.

int font_size

Font size of the LinkButton's text.

StyleBox focus

StyleBox used when the LinkButton is focused. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.