Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

LinkButton

继承: BaseButton < Control < CanvasItem < Node < Object

代表链接的按钮。

描述

代表链接的按钮。这种按钮主要用于与按钮的交互引起上下文变化时(如链接到网页)。

另见 BaseButton,它包含了该节点相关的常用属性和方法。

属性

FocusMode

focus_mode

0 (overrides Control)

String

language

""

CursorShape

mouse_default_cursor_shape

2 (overrides Control)

StructuredTextParser

structured_text_bidi_override

0

Array

structured_text_bidi_override_options

[]

String

text

""

TextDirection

text_direction

0

UnderlineMode

underline

0

String

uri

""

主题属性

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_disabled_color

Color(0, 0, 0, 1)

Color

font_focus_color

Color(0.95, 0.95, 0.95, 1)

Color

font_hover_color

Color(0.95, 0.95, 0.95, 1)

Color

font_hover_pressed_color

Color(0, 0, 0, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_pressed_color

Color(1, 1, 1, 1)

int

outline_size

0

int

underline_spacing

2

Font

font

int

font_size

StyleBox

focus


枚举

enum UnderlineMode:

UnderlineMode UNDERLINE_MODE_ALWAYS = 0

LinkButton 将始终在其文本底部显示下划线。

UnderlineMode UNDERLINE_MODE_ON_HOVER = 1

LinkButton 将在鼠标光标悬停时,在文本底部显示下划线。

UnderlineMode UNDERLINE_MODE_NEVER = 2

LinkButton 永远不会在其文本底部显示下划线。


属性说明

String language = ""

  • void set_language ( String value )

  • String get_language ( )

语言代码,用于断行和文本塑形算法,如果留空则使用当前区域设置。


StructuredTextParser structured_text_bidi_override = 0

为结构化文本设置 BiDi 算法覆盖。


Array structured_text_bidi_override_options = []

  • void set_structured_text_bidi_override_options ( Array value )

  • Array get_structured_text_bidi_override_options ( )

设置 BiDi 覆盖的附加选项。


String text = ""

该按钮的文本,将显示在按钮的区域内。


TextDirection text_direction = 0

基础文本书写方向。


UnderlineMode underline = 0

文本的下划线模式。可用模式见 UnderlineMode


String uri = ""

这个 LinkButtonURI。如果设置为有效的 URI,按下按钮就会使用操作系统中与该协议对应的默认程序打开该 URI(使用 OS.shell_open)。HTTP 和 HTTPS 的 URL 会打开默认的浏览器。

示例:

uri = "https://godotengine.org"  # 在默认浏览器中打开 URL。
uri = "C:\SomeFolder"  # 将文件浏览器打开到给定的路径。
uri = "C:\SomeImage.png"  # 在默认查看应用中打开给定的图像。

主题属性说明

Color font_color = Color(0.875, 0.875, 0.875, 1)

LinkButton 默认的字体颜色 Color


Color font_disabled_color = Color(0, 0, 0, 1)

LinkButton 处于禁用状态时,使用的文本 Color


Color font_focus_color = Color(0.95, 0.95, 0.95, 1)

LinkButton 获得焦点时使用的文本 Color。只替换按钮的正常文本颜色。禁用、悬停和按下状态优先于这个颜色。


Color font_hover_color = Color(0.95, 0.95, 0.95, 1)

LinkButton 被悬停时使用的文本颜色 Color


Color font_hover_pressed_color = Color(0, 0, 0, 1)

LinkButton 处于悬停并按下状态时,使用的文本 Color


Color font_outline_color = Color(1, 1, 1, 1)

LinkButton 的文本轮廓的色调。


Color font_pressed_color = Color(1, 1, 1, 1)

LinkButton 被按下时使用的文本颜色 Color


int outline_size = 0

文字轮廓的大小。

注意:如果使用启用了 FontFile.multichannel_signed_distance_field 的字体,其 FontFile.msdf_pixel_range 必须至少设置为 outline_size两倍,轮廓渲染才能看起来正确。否则,轮廓可能会比预期的更早被切断。


int underline_spacing = 2

文本基线和下划线之间的垂直空间。


Font font

LinkButton 文本的字体 Font


int font_size

LinkButton 文本的字体大小。


StyleBox focus

LinkButton 处于聚焦状态时使用的 StyleBoxfocus StyleBox 显示在基础 StyleBox 之上,所以应该使用部分透明的 StyleBox,确保基础 StyleBox 仍然可见。代表轮廓或下划线的 StyleBox 可以很好地实现这个目的。要禁用聚焦的视觉效果,请指定 StyleBoxEmpty 资源。请注意,禁用聚焦的视觉效果会影响使用键盘/手柄进行导航的可用性,所以出于可访问性的原因,不建议这样做。