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

Properties

FocusMode

enabled_focus_mode

O: 0

FocusMode

focus_mode

O: 0

CursorShape

mouse_default_cursor_shape

O: 2

String

text

""

UnderlineMode

underline

0

Theme Properties

StyleBox

focus

Font

font

Color

font_color

Color( 0.88, 0.88, 0.88, 1 )

Color

font_color_hover

Color( 0.94, 0.94, 0.94, 1 )

Color

font_color_pressed

Color( 1, 1, 1, 1 )

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_text(value)

Getter

get_text()

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


Default

0

Setter

set_underline_mode(value)

Getter

get_underline_mode()

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