81064cc239
We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
95 lines
6.2 KiB
XML
95 lines
6.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="LinkButton" inherits="BaseButton" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
A button that represents a link.
|
|
</brief_description>
|
|
<description>
|
|
A button that represents a link. This type of button is primarily used for interactions that cause a context change (like linking to a web page).
|
|
See also [BaseButton] which contains common properties and methods associated with this node.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<members>
|
|
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="0" />
|
|
<member name="language" type="String" setter="set_language" getter="get_language" default="""">
|
|
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
|
|
</member>
|
|
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" overrides="Control" enum="Control.CursorShape" default="2" />
|
|
<member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0">
|
|
Set BiDi algorithm override for the structured text.
|
|
</member>
|
|
<member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]">
|
|
Set additional options for BiDi override.
|
|
</member>
|
|
<member name="text" type="String" setter="set_text" getter="get_text" default="""">
|
|
The button's text that will be displayed inside the button's area.
|
|
</member>
|
|
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0">
|
|
Base text writing direction.
|
|
</member>
|
|
<member name="underline" type="int" setter="set_underline_mode" getter="get_underline_mode" enum="LinkButton.UnderlineMode" default="0">
|
|
The underline mode to use for the text. See [enum LinkButton.UnderlineMode] for the available modes.
|
|
</member>
|
|
<member name="uri" type="String" setter="set_uri" getter="get_uri" default="""">
|
|
The [url=https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]URI[/url] for this [LinkButton]. If set to a valid URI, pressing the button opens the URI using the operating system's default program for the protocol (via [method OS.shell_open]). HTTP and HTTPS URLs open the default web browser.
|
|
[b]Examples:[/b]
|
|
[codeblocks]
|
|
[gdscript]
|
|
uri = "https://godotengine.org" # Opens the URL in the default web browser.
|
|
uri = "C:\SomeFolder" # Opens the file explorer at the given path.
|
|
uri = "C:\SomeImage.png" # Opens the given image in the default viewing app.
|
|
[/gdscript]
|
|
[csharp]
|
|
Uri = "https://godotengine.org"; // Opens the URL in the default web browser.
|
|
Uri = "C:\SomeFolder"; // Opens the file explorer at the given path.
|
|
Uri = "C:\SomeImage.png"; // Opens the given image in the default viewing app.
|
|
[/csharp]
|
|
[/codeblocks]
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
<constant name="UNDERLINE_MODE_ALWAYS" value="0" enum="UnderlineMode">
|
|
The LinkButton will always show an underline at the bottom of its text.
|
|
</constant>
|
|
<constant name="UNDERLINE_MODE_ON_HOVER" value="1" enum="UnderlineMode">
|
|
The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it.
|
|
</constant>
|
|
<constant name="UNDERLINE_MODE_NEVER" value="2" enum="UnderlineMode">
|
|
The LinkButton will never show an underline at the bottom of its text.
|
|
</constant>
|
|
</constants>
|
|
<theme_items>
|
|
<theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)">
|
|
Default text [Color] of the [LinkButton].
|
|
</theme_item>
|
|
<theme_item name="font_focus_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
|
|
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.
|
|
</theme_item>
|
|
<theme_item name="font_hover_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
|
|
Text [Color] used when the [LinkButton] is being hovered.
|
|
</theme_item>
|
|
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
The tint of text outline of the [LinkButton].
|
|
</theme_item>
|
|
<theme_item name="font_pressed_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
|
|
Text [Color] used when the [LinkButton] is being pressed.
|
|
</theme_item>
|
|
<theme_item name="outline_size" data_type="constant" type="int" default="0">
|
|
The size of the text outline.
|
|
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
|
|
</theme_item>
|
|
<theme_item name="underline_spacing" data_type="constant" type="int" default="2">
|
|
The vertical space between the baseline of text and the underline.
|
|
</theme_item>
|
|
<theme_item name="font" data_type="font" type="Font">
|
|
[Font] of the [LinkButton]'s text.
|
|
</theme_item>
|
|
<theme_item name="font_size" data_type="font_size" type="int">
|
|
Font size of the [LinkButton]'s text.
|
|
</theme_item>
|
|
<theme_item name="focus" data_type="style" type="StyleBox">
|
|
[StyleBox] used when the [LinkButton] is focused. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] 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.
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|