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.

Methods

void

clear_opentype_features ( )

int

get_opentype_feature ( String tag ) const

void

set_opentype_feature ( String tag, int value )

Theme Properties

StyleBox

focus

Font

font

Color

font_color

Color(0.88, 0.88, 0.88, 1)

Color

font_hover_color

Color(0.94, 0.94, 0.94, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_pressed_color

Color(1, 1, 1, 1)

int

font_size

int

outline_size

0

int

underline_spacing

2

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

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.


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.


Default

""

Setter

set_text(value)

Getter

get_text()

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


Default

0

Setter

set_text_direction(value)

Getter

get_text_direction()

Base text writing direction.


Default

0

Setter

set_underline_mode(value)

Getter

get_underline_mode()

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

Method Descriptions

  • void clear_opentype_features ( )

Removes all OpenType features.


  • int get_opentype_feature ( String tag ) const

Returns OpenType feature tag.


  • void set_opentype_feature ( String tag, int value )

Returns OpenType feature tag. More info: OpenType feature tags.

Theme Property Descriptions

StyleBox used when the LinkButton is focused. It is displayed over the current StyleBox, so using StyleBoxEmpty will just disable the focus visual effect.


Font of the LinkButton's text.


Default

Color(0.88, 0.88, 0.88, 1)

Default text Color of the LinkButton.


Default

Color(0.94, 0.94, 0.94, 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 font_size

Font size of the LinkButton's text.


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