You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-11-17 14:11:06 +00:00
32ddd4f4e0
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).
(cherry picked from commit 81064cc239)
68 lines
3.9 KiB
XML
68 lines
3.9 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>
|
|
Simple button used to represent a link to some resource.
|
|
</brief_description>
|
|
<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.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
</methods>
|
|
<members>
|
|
<member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="0" />
|
|
<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="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="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]
|
|
[codeblock]
|
|
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.
|
|
[/codeblock]
|
|
</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.88, 0.88, 0.88, 1 )">
|
|
Default text [Color] of the [LinkButton].
|
|
</theme_item>
|
|
<theme_item name="font_color_focus" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 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_color_hover" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
|
|
Text [Color] used when the [LinkButton] is being hovered.
|
|
</theme_item>
|
|
<theme_item name="font_color_pressed" 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="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="focus" data_type="style" type="StyleBox">
|
|
[StyleBox] used when the [LinkButton] is focused. It is displayed over the current [StyleBox], so using [StyleBoxEmpty] will just disable the focus visual effect.
|
|
</theme_item>
|
|
</theme_items>
|
|
</class>
|