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 |
|
|
|
||
|
||
|
||
|
||
|
Methods¶
void |
|
get_opentype_feature ( String tag ) const |
|
void |
set_opentype_feature ( String tag, int value ) |
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 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 |
|
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 |
|
Setter |
set_text_direction(value) |
Getter |
get_text_direction() |
Base text writing direction.
UnderlineMode underline
Default |
|
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.
Returns OpenType feature tag
.
Returns OpenType feature tag
. More info: OpenType feature tags.
Theme Property Descriptions¶
Color font_color
Default |
|
Default text Color of the LinkButton
.
Color font_focus_color
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_hover_color
Default |
|
Text Color used when the LinkButton
is being hovered.
Color font_outline_color
Default |
|
The tint of text outline of the LinkButton
.
Color font_pressed_color
Default |
|
Text Color used when the LinkButton
is being pressed.
int outline_size
Default |
|
The size of the text outline.
int underline_spacing
Default |
|
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.