LinkButton

Inherits: BaseButton < Control < CanvasItem < Node < Object

Category: Core

Brief Description

Simple button used to represent a link to some resource

Member Functions

String	get_text ( ) const
int	get_underline_mode ( ) const
void	set_text ( String text )
void	set_underline_mode ( int underline_mode )

Numeric Constants

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

Description

This kind of buttons are primarily used when the interaction with the button causes a context change (like linking to a web page).

Member Function Description

String get_text ( ) const

Returns the text of the button.

int get_underline_mode ( ) const

Returns the underline mode for this button.

void set_text ( String text )

Sets the text of the button.

void set_underline_mode ( int underline_mode )

Sets the underline mode for this button, the argument must be one of the LinkButton constants (see constants section).