diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2022-12-17 20:58:15 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-12-17 20:58:15 +0100 |
| commit | 10bc1d8710e8d6a3f58f2c4f5cc09604ef3ec51f (patch) | |
| tree | 1317dd02802e5b2227848ae6bd292f47f5af5313 /doc | |
| parent | 92018c9508ce0a080bd48d119a6310676ab56810 (diff) | |
| parent | d73a9b56b08864b5e5ccf0df910190b064ff7463 (diff) | |
Merge pull request #30675 from zaksnet/link-button-link-prop
Add a `uri` property to `LinkButton`
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/LinkButton.xml | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/doc/classes/LinkButton.xml b/doc/classes/LinkButton.xml index d7701ea184..184ba1ba7a 100644 --- a/doc/classes/LinkButton.xml +++ b/doc/classes/LinkButton.xml @@ -28,7 +28,23 @@ Base text writing direction. </member> <member name="underline" type="int" setter="set_underline_mode" getter="get_underline_mode" enum="LinkButton.UnderlineMode" default="0"> - Determines when to show the underline. See [enum UnderlineMode] for options. + 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> |