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¶
focus_mode |
|
|
mouse_default_cursor_shape |
|
|
|
||
|
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
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 text
Default |
|
Setter |
set_text(value) |
Getter |
get_text() |
The button's text that will be displayed inside the button's area.
UnderlineMode underline
Default |
|
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 |
|
Default text Color of the LinkButton
.
Color font_color_focus
Default |
|
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_color_hover
Default |
|
Text Color used when the LinkButton
is being hovered.
Color font_color_pressed
Default |
|
Text Color used when the LinkButton
is being pressed.
int underline_spacing
Default |
|
The vertical space between the baseline of text and the underline.
Font font
Font of the LinkButton
's text.
StyleBox focus
StyleBox used when the LinkButton
is focused. It is displayed over the current StyleBox, so using StyleBoxEmpty will just disable the focus visual effect.