mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-09 10:09:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
d34594179a
godot/doc/classes/RichTextLabel.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

719 lines
35 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 21:18:53 +08:00
<class name="RichTextLabel" inherits="Control" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<brief_description>
Label that displays rich text.
</brief_description>
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Rich text can contain custom text, fonts, images and some basic formatting. The label manages these as an internal tag stack. It also adapts itself to given width/heights.
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
[b]Note:[/b] Assignments to [member text] clear the tag stack and reconstruct it from the property's contents. Any edits made to [member text] will erase previous edits made from other manual sources such as [method append_text] and the [code]push_*[/code] / [method pop] methods.
Document RichTextLabel not supporting entangled BBCode tags See #44634.
2020-12-27 06:36:08 +08:00
[b]Note:[/b] RichTextLabel doesn't support entangled BBCode tags. For example, instead of using [code][b]bold[i]bold italic[/b]italic[/i][/code], use [code][b]bold[i]bold italic[/i][/b][i]italic[/i][/code].
Add note to `RichTextLabel`
2021-07-06 16:55:39 +08:00
[b]Note:[/b] [code]push_*/pop[/code] functions won't affect BBCode.
Document limitations related to centering text with RichTextLabel This is a relatively common question on various community channels.
2020-08-19 16:32:55 +08:00
[b]Note:[/b] Unlike [Label], RichTextLabel doesn't have a [i]property[/i] to horizontally align text to the center. Instead, enable [member bbcode_enabled] and surround the text in a [code][center][/code] tag as follows: [code][center]Example[/center][/code]. There is currently no built-in way to vertically align text either, but this can be emulated by relying on anchors/containers and the [member fit_content_height] property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:43:07 +08:00
<link title="BBCode in RichTextLabel">$DOCS_URL/tutorials/ui/bbcode_in_richtextlabel.html</link>
Link to demos from within the class reference
2020-10-01 16:34:47 +08:00
<link title="GUI Rich Text/BBcode Demo">https://godotengine.org/asset-library/asset/132</link>
<link title="OS Test Demo">https://godotengine.org/asset-library/asset/677</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</tutorials>
<methods>
<method name="add_image">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="image" type="Texture2D" />
<param index="1" name="width" type="int" default="0" />
<param index="2" name="height" type="int" default="0" />
<param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" />
<param index="4" name="inline_align" type="int" enum="InlineAlignment" default="5" />
Add Spritesheet support to RichTextLabel BBCode BBCode: [img region=0,0,16,16]res://icon.svg[/img]
2022-10-10 22:55:28 +08:00
<param index="5" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Add Spritesheet support to RichTextLabel BBCode BBCode: [img region=0,0,16,16]res://icon.svg[/img]
2022-10-10 22:55:28 +08:00
Adds an image's opening and closing tags to the tag stack, optionally providing a [param width] and [param height] to resize the image, a [param color] to tint the image and a [param region] to only use parts of the image.
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
If [param width] or [param height] is set to 0, the image size will be adjusted in order to keep the original aspect ratio.
Add Spritesheet support to RichTextLabel BBCode BBCode: [img region=0,0,16,16]res://icon.svg[/img]
2022-10-10 22:55:28 +08:00
If [param width] and [param height] are not set, but [param region] is, the region's rect will be used.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="add_text">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="text" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Adds raw non-BBCode-parsed text to the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
<method name="append_text">
Make RichTextLabel's parse_bbcode and append_text return void
2021-10-23 14:25:39 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="bbcode" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Parses [param bbcode] and adds tags to the tag stack as needed.
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
[b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_text] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member text] instead of using [method append_text].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
Clears the tag stack and sets [member text] to an empty string.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Add deselect() to RichTextLabel
2022-04-04 22:06:57 +08:00
<method name="deselect">
<return type="void" />
<description>
Clears the current selection.
</description>
</method>
Add get_character_line method for RichTextLabel Adds the ability to get the line number of provided character position Fix arg name Add get_character_paragraph Replaced glyph logic with code suggestions, added get_character_paragraph method Run doctool Use built-in method Replace TS access with built in method
2022-02-12 05:02:59 +08:00
<method name="get_character_line">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="character" type="int" />
Add get_character_line method for RichTextLabel Adds the ability to get the line number of provided character position Fix arg name Add get_character_paragraph Replaced glyph logic with code suggestions, added get_character_paragraph method Run doctool Use built-in method Replace TS access with built in method
2022-02-12 05:02:59 +08:00
<description>
Returns the line number of the character position provided.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Add get_character_line method for RichTextLabel Adds the ability to get the line number of provided character position Fix arg name Add get_character_paragraph Replaced glyph logic with code suggestions, added get_character_paragraph method Run doctool Use built-in method Replace TS access with built in method
2022-02-12 05:02:59 +08:00
</description>
</method>
<method name="get_character_paragraph">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="character" type="int" />
Add get_character_line method for RichTextLabel Adds the ability to get the line number of provided character position Fix arg name Add get_character_paragraph Replaced glyph logic with code suggestions, added get_character_paragraph method Run doctool Use built-in method Replace TS access with built in method
2022-02-12 05:02:59 +08:00
<description>
Returns the paragraph number of the character position provided.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Add get_character_line method for RichTextLabel Adds the ability to get the line number of provided character position Fix arg name Add get_character_paragraph Replaced glyph logic with code suggestions, added get_character_paragraph method Run doctool Use built-in method Replace TS access with built in method
2022-02-12 05:02:59 +08:00
</description>
</method>
doc: Sync classref with current source
2020-06-25 16:51:46 +08:00
<method name="get_content_height" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Sync classref with current source
2018-05-12 15:38:00 +08:00
<description>
Returns the height of the content.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</description>
</method>
Add get_content_width method Adds a get_content_width method to RichTextLabel
2022-02-10 04:02:46 +08:00
<method name="get_content_width" qualifiers="const">
<return type="int" />
<description>
Returns the width of the content.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Add get_content_width method Adds a get_content_width method to RichTextLabel
2022-02-10 04:02:46 +08:00
</description>
</method>
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
<method name="get_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
<description>
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
Returns the total number of lines in the text. Wrapped text is counted as multiple lines.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
</description>
</method>
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
<method name="get_line_offset">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="line" type="int" />
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
<description>
Returns the vertical offset of the line found at the provided index.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
</description>
</method>
Add context menu to RichTextLabel
2022-04-12 14:58:04 +08:00
<method name="get_menu" qualifiers="const">
<return type="PopupMenu" />
<description>
Returns the [PopupMenu] of this [RichTextLabel]. By default, this menu is displayed when right-clicking on the [RichTextLabel].
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
</description>
</method>
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<method name="get_paragraph_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<description>
Returns the total number of paragraphs (newlines or [code]p[/code] tags in the tag stack's text tags). Considers wrapped text as one paragraph.
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
</description>
</method>
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
<method name="get_paragraph_offset">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="paragraph" type="int" />
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
<description>
Returns the vertical offset of the paragraph found at the provided index.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
Add offset methods for lines and paragraphs in RichTextLabel Adds `get_line_offset` and `get_paragraph_offset` methods to `RichTextLabel` Fix arg mismatch
2022-02-14 01:33:37 +08:00
</description>
</method>
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
<method name="get_parsed_text" qualifiers="const">
<return type="String" />
<description>
Returns the text without BBCode mark-up.
</description>
</method>
Expose RichTextLabel selection to script Expose existing get_selection_text and add methods to get the current selection index from and index to.
2021-02-12 00:33:45 +08:00
<method name="get_selected_text" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="String" />
Expose RichTextLabel selection to script Expose existing get_selection_text and add methods to get the current selection index from and index to.
2021-02-12 00:33:45 +08:00
<description>
Returns the current selection text. Does not include BBCodes.
</description>
</method>
<method name="get_selection_from" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Expose RichTextLabel selection to script Expose existing get_selection_text and add methods to get the current selection index from and index to.
2021-02-12 00:33:45 +08:00
<description>
Returns the current selection first character index if a selection is active, [code]-1[/code] otherwise. Does not include BBCodes.
</description>
</method>
<method name="get_selection_to" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Expose RichTextLabel selection to script Expose existing get_selection_text and add methods to get the current selection index from and index to.
2021-02-12 00:33:45 +08:00
<description>
Returns the current selection last character index if a selection is active, [code]-1[/code] otherwise. Does not include BBCodes.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="get_total_character_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Returns the total number of characters from text tags. Does not include BBCodes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rename all methods that return `ScrollBar` nodes to `get_*_scroll_bar()`
2021-12-01 00:46:36 +08:00
<method name="get_v_scroll_bar">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="VScrollBar" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Returns the vertical scrollbar.
Add warnings to methods that give access to internal nodes
2021-10-11 03:28:56 +08:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
<method name="get_visible_line_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
<description>
Added descriptions to RichTextLabel
2017-10-26 02:15:39 +08:00
Returns the number of visible lines.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
doc: Sync classref with current source [ci skip]
2017-09-23 16:59:35 +08:00
</description>
</method>
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<method name="get_visible_paragraph_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<description>
Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
[b]Note:[/b] If [member threaded] is enabled, this method returns a value for the loaded part of the document. Use [method is_ready] or [signal finished] to determine whether document is fully loaded.
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
</description>
</method>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<method name="install_effect">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="effect" type="Variant" />
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Installs a custom effect. [param effect] should be a valid [RichTextEffect].
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</description>
</method>
Add context menu to RichTextLabel
2022-04-12 14:58:04 +08:00
<method name="is_menu_visible" qualifiers="const">
<return type="bool" />
<description>
Returns whether the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided).
</description>
</method>
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
<method name="is_ready" qualifiers="const">
<return type="bool" />
<description>
If [member threaded] is enabled, returns [code]true[/code] if the background thread has finished text processing, otherwise always return [code]true[/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="newline">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Adds a newline tag to the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="parse_bbcode">
Make RichTextLabel's parse_bbcode and append_text return void
2021-10-23 14:25:39 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="bbcode" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Make RichTextLabel's parse_bbcode and append_text return void
2021-10-23 14:25:39 +08:00
The assignment version of [method append_text]. Clears the tag stack and inserts the new content.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<method name="parse_expressions_for_values">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Dictionary" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="expressions" type="PackedStringArray" />
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Parses BBCode parameter [param expressions] into a dictionary.
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="pop">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Terminates the current tag. Use after [code]push_*[/code] methods to close BBCodes manually. Does not need to follow [code]add_*[/code] methods.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
Rich Text Label now allows for foreground colors and background colors
2020-01-27 06:11:09 +08:00
<method name="push_bgcolor">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="bgcolor" type="Color" />
Rich Text Label now allows for foreground colors and background colors
2020-01-27 06:11:09 +08:00
<description>
Adds a [code][bgcolor][/code] tag to the tag stack.
</description>
</method>
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<method name="push_bold">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Adds a [code][font][/code] tag with a bold font to the tag stack. This is the same as adding a [code][b][/code] tag if not currently in a [code][i][/code] tag.
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
</description>
</method>
<method name="push_bold_italics">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Adds a [code][font][/code] tag with a bold italics font to the tag stack.
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="push_cell">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
doc: Fix wrong references found by new makerst.py Thanks @PJB3005
2019-01-07 17:02:04 +08:00
Adds a [code][cell][/code] tag to the tag stack. Must be inside a [code][table][/code] tag. See [method push_table] for details.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="push_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="color" type="Color" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Adds a [code][color][/code] tag to the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
[Complex Text Layouts] Add drop-caps support to TextParagraph and RTL.
2020-11-19 22:45:23 +08:00
<method name="push_dropcap">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="string" type="String" />
<param index="1" name="font" type="Font" />
<param index="2" name="size" type="int" />
<param index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" />
<param index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" />
<param index="5" name="outline_size" type="int" default="0" />
<param index="6" name="outline_color" type="Color" default="Color(0, 0, 0, 0)" />
[Complex Text Layouts] Add drop-caps support to TextParagraph and RTL.
2020-11-19 22:45:23 +08:00
<description>
Adds a [code][dropcap][/code] tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.
</description>
</method>
Rich Text Label now allows for foreground colors and background colors
2020-01-27 06:11:09 +08:00
<method name="push_fgcolor">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="fgcolor" type="Color" />
Rich Text Label now allows for foreground colors and background colors
2020-01-27 06:11:09 +08:00
<description>
Adds a [code][fgcolor][/code] tag to the tag stack.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="push_font">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="font" type="Font" />
<param index="1" name="font_size" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Adds a [code][font][/code] tag to the tag stack. Overrides default fonts for its duration.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<method name="push_font_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="font_size" type="int" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
</description>
</method>
Add RichTextLabel "hint" tag.
2022-02-22 01:34:16 +08:00
<method name="push_hint">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="description" type="String" />
Add RichTextLabel "hint" tag.
2022-02-22 01:34:16 +08:00
<description>
Adds a [code][hint][/code] tag to the tag stack. Same as BBCode [code][hint=something]{text}[/hint][/code].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="push_indent">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="level" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Adds an [code][indent][/code] tag to the tag stack. Multiplies [param level] by current [member tab_size] to determine new margin length.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<method name="push_italics">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Adds a [code][font][/code] tag with a italics font to the tag stack. This is the same as adding a [code][i][/code] tag if not currently in a [code][b][/code] tag.
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="push_list">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="level" type="int" />
<param index="1" name="type" type="int" enum="RichTextLabel.ListType" />
<param index="2" name="capitalize" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Adds [code][ol][/code] or [code][ul][/code] tag to the tag stack. Multiplies [param level] by current [member tab_size] to determine new margin length.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="push_meta">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="data" type="Variant" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Adds a [code][meta][/code] tag to the tag stack. Similar to the BBCode [code][url=something]{text}[/url][/code], but supports non-[String] metadata types.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<method name="push_mono">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Adds a [code][font][/code] tag with a monospace font to the tag stack.
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
</description>
</method>
<method name="push_normal">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Adds a [code][font][/code] tag with a normal font to the tag stack.
doc: Sync classref with current source
2019-10-26 22:40:31 +08:00
</description>
</method>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<method name="push_outline_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="color" type="Color" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Adds a [code][outline_color][/code] tag to the tag stack. Adds text outline for its duration.
</description>
</method>
<method name="push_outline_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="outline_size" type="int" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Adds a [code][outline_size][/code] tag to the tag stack. Overrides default text outline size for its duration.
</description>
</method>
<method name="push_paragraph">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="alignment" type="int" enum="HorizontalAlignment" />
<param index="1" name="base_direction" type="int" enum="Control.TextDirection" default="0" />
<param index="2" name="language" type="String" default="&quot;&quot;" />
<param index="3" name="st_parser" type="int" enum="TextServer.StructuredTextParser" default="0" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Adds a [code][p][/code] tag to the tag stack.
</description>
</method>
Update class documentation xml
2018-10-07 21:52:07 +08:00
<method name="push_strikethrough">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Update class documentation xml
2018-10-07 21:52:07 +08:00
<description>
Doc RichTextLabel push strikethrough and align
2018-10-12 22:43:03 +08:00
Adds a [code][s][/code] tag to the tag stack.
Update class documentation xml
2018-10-07 21:52:07 +08:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="push_table">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="columns" type="int" />
<param index="1" name="inline_align" type="int" enum="InlineAlignment" default="0" />
[RTL/TextServer] Add baseline inline alignment mode for objects and RTL tables.
2022-12-09 04:01:07 +08:00
<param index="2" name="align_to_row" type="int" default="-1" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
Adds a [code][table=columns,inline_align][/code] tag to the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="push_underline">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
Adds a [code][u][/code] tag to the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="remove_line">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="line" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Rewording RichTextLabel::remove_line documentation
2020-01-07 08:29:10 +08:00
Removes a line of content from the label. Returns [code]true[/code] if the line exists.
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
The [param line] argument is the index of the line to remove, it can take values in the interval [code][0, get_line_count() - 1][/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="scroll_to_line">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="line" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Scrolls the window's top line to match [param line].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<method name="scroll_to_paragraph">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="paragraph" type="int" />
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Scrolls the window's top line to match first line of the [param paragraph].
RichTextLabel: adds separate `get_total_x_count`, `get_visible_x_count` and `scroll_to_x` functions for wrapped lines and paragraphs (newlines).
2021-01-12 20:03:10 +08:00
</description>
</method>
[RTL] Fix search method not taking nested frame and line wraps into account.
2022-12-05 04:11:21 +08:00
<method name="scroll_to_selection">
<return type="void" />
<description>
Scrolls to the beginning of the current selection.
</description>
</method>
Add select_all() to RichTextLabel
2022-04-11 00:03:10 +08:00
<method name="select_all">
<return type="void" />
<description>
Select all the text.
If [member selection_enabled] is [code]false[/code], no selection will occur.
</description>
</method>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<method name="set_cell_border_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="color" type="Color" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Sets color of a table cell border.
</description>
</method>
<method name="set_cell_padding">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="padding" type="Rect2" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Sets inner padding of a table cell.
</description>
</method>
<method name="set_cell_row_background_color">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="odd_row_bg" type="Color" />
<param index="1" name="even_row_bg" type="Color" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Sets color of a table cell. Separate colors for alternating rows can be specified.
</description>
</method>
<method name="set_cell_size_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="min_size" type="Vector2" />
<param index="1" name="max_size" type="Vector2" />
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<description>
Sets minimum and maximum size overrides for a table cell.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<method name="set_table_column_expand">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="column" type="int" />
<param index="1" name="expand" type="bool" />
<param index="2" name="ratio" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
Edits the selected column's expansion options. If [param expand] is [code]true[/code], the column expands in proportion to its expansion ratio versus the other columns' ratios.
Adding internal tag stack information.
2017-11-13 11:05:28 +08:00
For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively.
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-10 10:00:19 +08:00
If [param expand] is [code]false[/code], the column will not contribute to the total ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 16:01:45 +08:00
<member name="autowrap_mode" type="int" setter="set_autowrap_mode" getter="get_autowrap_mode" enum="TextServer.AutowrapMode" default="3">
If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. To see how each mode behaves, see [enum TextServer.AutowrapMode].
Add auto-wrap mode property to the RichTextLabel, set default auto-wrap mode to AUTOWRAP_WORD_SMART to match 3.x behavior.
2022-02-03 21:56:44 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="bbcode_enabled" type="bool" setter="set_use_bbcode" getter="is_using_bbcode" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], the label uses BBCode formatting.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Rename Control's Rect properties to exclude rect_ part
2022-01-24 01:14:31 +08:00
<member name="clip_contents" type="bool" setter="set_clip_contents" getter="is_clipping_contents" overrides="Control" default="true" />
Add context menu to RichTextLabel
2022-04-12 14:58:04 +08:00
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="false">
If [code]true[/code], a right-click displays the context menu.
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="custom_effects" type="Array" setter="set_effects" getter="get_effects" default="[]">
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
The currently installed custom effects. This is an array of [RichTextEffect]s.
To add a custom effect, it's more convenient to use [method install_effect].
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</member>
Add option to make selection unique
2021-10-22 05:02:46 +08:00
<member name="deselect_on_focus_loss_enabled" type="bool" setter="set_deselect_on_focus_loss_enabled" getter="is_deselect_on_focus_loss_enabled" default="true">
If [code]true[/code], the selected text will be deselected when focus is lost.
</member>
Option in RichTextLabel for height to fit content
2019-11-01 22:17:40 +08:00
<member name="fit_content_height" type="bool" setter="set_fit_content_height" getter="is_fit_content_height_enabled" default="false">
If [code]true[/code], the label's height will be automatically updated to fit its content.
[b]Note:[/b] This property is used as a workaround to fix issues with [RichTextLabel] in [Container]s, but it's unreliable in some cases and will be removed in future versions.
</member>
Add RichTextLabel "hint" tag.
2022-02-22 01:34:16 +08:00
<member name="hint_underlined" type="bool" setter="set_hint_underline" getter="is_hint_underlined" default="true">
If [code]true[/code], the label underlines hint tags such as [code][hint=description]{text}[/hint][/code].
</member>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<member name="language" type="String" setter="set_language" getter="get_language" default="&quot;&quot;">
Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="meta_underlined" type="bool" setter="set_meta_underline" getter="is_meta_underlined" default="true">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code].
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
</member>
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
<member name="progress_bar_delay" type="int" setter="set_progress_bar_delay" getter="get_progress_bar_delay" default="1000">
The delay after which the loading progress bar is displayed, in milliseconds. Set to [code]-1[/code] to disable progress bar entirely.
Fix typos with codespell Using codespell 2.2-dev from current git.
2022-05-24 03:32:19 +08:00
[b]Note:[/b] Progress bar is displayed only if [member threaded] is enabled.
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="scroll_active" type="bool" setter="set_scroll_active" getter="is_scroll_active" default="true">
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
If [code]true[/code], the scrollbar is visible. Setting this to [code]false[/code] does not block scrolling completely. See [method scroll_to_line].
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="scroll_following" type="bool" setter="set_scroll_follow" getter="is_scroll_following" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], the window scrolls down to display new content automatically.
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="selection_enabled" type="bool" setter="set_selection_enabled" getter="is_selection_enabled" default="false">
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
If [code]true[/code], the label allows text selection.
</member>
Add context menu to RichTextLabel
2022-04-12 14:58:04 +08:00
<member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true">
If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled.
</member>
Implement Label3D node. Add "generate_mipmap" font import option. Add some missing features to the Sprite3D. Move BiDi override code from Control to TextServer. Add functions to access TextServer font cache textures. Add MSDF related flags and shader to the standard material. Change standard material cache to use HashMap instead of Vector.
2022-04-19 18:27:18 +08:00
<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">
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
Set BiDi algorithm override for the structured text.
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]">
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
Set additional options for BiDi override.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="tab_size" type="int" setter="set_tab_size" getter="get_tab_size" default="4">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
The number of spaces associated with a single tab length. Does not affect [code]\t[/code] in text tags, only indent tags.
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
Remove bbcode_text from RichTextLabel Also renames: - append_bbcode -> append_text - get_bbcode -> get_text - set_bbcode -> set_text - get_text -> get_parsed_text Property text is: set_text get_text
2020-05-29 22:25:12 +08:00
The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.
Mention that modifying text erases BBCode stacks
2022-01-15 09:13:58 +08:00
[b]Note:[/b] If [member bbcode_enabled] is [code]true[/code], it is unadvised to use the [code]+=[/code] operator with [code]text[/code] (e.g. [code]text += "some string"[/code]) as it replaces the whole text and can cause slowdowns. It will also erase all BBCode that was added to stack using [code]push_*[/code] methods. Use [method append_text] for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.
Update docs [ci skip]
2018-01-12 06:38:35 +08:00
</member>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0">
Base text writing direction.
</member>
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
<member name="threaded" type="bool" setter="set_threaded" getter="is_threaded" default="false">
If [code]true[/code], text processing is done in a background thread.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="visible_characters" type="int" setter="set_visible_characters" getter="get_visible_characters" default="-1">
Improve `percent_visible` and `visible_characters` description Applies for Label and RichTextLabel.
2022-08-22 21:13:19 +08:00
The number of characters to display. If set to [code]-1[/code], all characters are displayed. This can be useful when animating the text appearing in a dialog box.
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-21 02:06:13 +08:00
[b]Note:[/b] Setting this property updates [member visible_ratio] accordingly.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
Move duplicate AutoWrap, Overrun and VisibleChar behavior enums to the TextServer.
2022-06-15 16:01:45 +08:00
<member name="visible_characters_behavior" type="int" setter="set_visible_characters_behavior" getter="get_visible_characters_behavior" enum="TextServer.VisibleCharactersBehavior" default="0">
Rename Label & RichTextLabel.`percent_visible` to `visible_ratio` Also updates the documentation of both `visible_characters` and `visible_ratio` to, better describe what they do and improve consistency between the two Classes.
2022-08-21 02:06:13 +08:00
Sets the clipping behavior when [member visible_characters] or [member visible_ratio] is set. See [enum TextServer.VisibleCharactersBehavior] for more info.
</member>
<member name="visible_ratio" type="float" setter="set_visible_ratio" getter="get_visible_ratio" default="1.0">
The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to [code]1.0[/code], all characters are displayed. If set to [code]0.5[/code], only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.
[b]Note:[/b] Setting this property updates [member visible_characters] accordingly.
Add different "visible characters" behavior modes.
2021-12-05 20:28:32 +08:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</members>
<signals>
[RTL] Add support for shaping in background thread.
2022-05-18 15:17:55 +08:00
<signal name="finished">
<description>
Triggered when the document is fully loaded.
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<signal name="meta_clicked">
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="meta" type="Variant" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<description>
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Triggered when the user clicks on content between meta tags. If the meta is defined in text, e.g. [code][url={"data"="hi"}]hi[/url][/code], then the parameter for this signal will be a [String] type. If a particular type or an object is desired, the [method push_meta] method must be used to manually insert the data into the tag stack.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</signal>
doc: Sync classref with current source
2017-11-24 16:16:27 +08:00
<signal name="meta_hover_ended">
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="meta" type="Variant" />
Adding ability for single meta hovering
2017-11-17 13:49:39 +08:00
<description>
doc: Sync classref with current source
2017-11-24 16:16:27 +08:00
Triggers when the mouse exits a meta tag.
Adding ability for single meta hovering
2017-11-17 13:49:39 +08:00
</description>
</signal>
doc: Sync classref with current source
2017-11-24 16:16:27 +08:00
<signal name="meta_hover_started">
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="meta" type="Variant" />
Adding ability for single meta hovering
2017-11-17 13:49:39 +08:00
<description>
doc: Sync classref with current source
2017-11-24 16:16:27 +08:00
Triggers when the mouse enters a meta tag.
Adding ability for single meta hovering
2017-11-17 13:49:39 +08:00
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="LIST_NUMBERS" value="0" enum="ListType">
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Each list item has a number marker.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="LIST_LETTERS" value="1" enum="ListType">
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Each list item has a letter marker.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="LIST_ROMAN" value="2" enum="ListType">
Each list item has a roman number marker.
</constant>
<constant name="LIST_DOTS" value="3" enum="ListType">
Completes the RichTextLabel documentation
2020-01-06 13:33:53 +08:00
Each list item has a filled circle marker.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ITEM_FRAME" value="0" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ITEM_TEXT" value="1" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ITEM_IMAGE" value="2" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ITEM_NEWLINE" value="3" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-25 06:16:30 +08:00
<constant name="ITEM_FONT" value="4" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_FONT_SIZE" value="5" enum="ItemType">
</constant>
<constant name="ITEM_FONT_FEATURES" value="6" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_COLOR" value="7" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_OUTLINE_SIZE" value="8" enum="ItemType">
Update class documentation xml
2018-10-07 21:52:07 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_OUTLINE_COLOR" value="9" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_UNDERLINE" value="10" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_STRIKETHROUGH" value="11" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_PARAGRAPH" value="12" enum="ItemType">
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 18:56:11 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_INDENT" value="13" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_LIST" value="14" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_TABLE" value="15" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_FADE" value="16" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_SHAKE" value="17" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_WAVE" value="18" enum="ItemType">
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 17:44:48 +08:00
</constant>
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
<constant name="ITEM_TORNADO" value="19" enum="ItemType">
</constant>
<constant name="ITEM_RAINBOW" value="20" enum="ItemType">
</constant>
Rich Text Label now allows for foreground colors and background colors
2020-01-27 06:11:09 +08:00
<constant name="ITEM_BGCOLOR" value="21" enum="ItemType">
</constant>
<constant name="ITEM_FGCOLOR" value="22" enum="ItemType">
</constant>
<constant name="ITEM_META" value="23" enum="ItemType">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constant>
Add RichTextLabel "hint" tag.
2022-02-22 01:34:16 +08:00
<constant name="ITEM_HINT" value="24" enum="ItemType">
</constant>
<constant name="ITEM_DROPCAP" value="25" enum="ItemType">
[Complex Text Layouts] Add drop-caps support to TextParagraph and RTL.
2020-11-19 22:45:23 +08:00
</constant>
Add RichTextLabel "hint" tag.
2022-02-22 01:34:16 +08:00
<constant name="ITEM_CUSTOMFX" value="26" enum="ItemType">
[Complex Text Layouts] Add drop-caps support to TextParagraph and RTL.
2020-11-19 22:45:23 +08:00
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="default_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The default text color.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
The default tint of text outline.
</theme_item>
Remove override_selected_font_color property
2022-10-26 06:46:06 +08:00
<theme_item name="font_selected_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
The color of selected text, used when [member selection_enabled] is [code]true[/code]. If equal to [code]Color(0, 0, 0, 0)[/code], it will be ignored.
doc: Sync classref with current source
2021-01-28 18:26:37 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="font_shadow_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The color of the font's shadow.
Implement font shadows for RichTextLabel
2018-04-11 21:08:56 +08:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="selection_color" data_type="color" type="Color" default="Color(0.1, 0.1, 1, 0.8)">
The color of the selection box.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="table_border" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
The default cell border color.
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="table_even_row_bg" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
The default background color for even rows.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="table_odd_row_bg" data_type="color" type="Color" default="Color(0, 0, 0, 0)">
The default background color for odd rows.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="line_separation" data_type="constant" type="int" default="0">
The vertical space between lines.
[Complex Text Layouts] Refactor RichTextLabel.
2020-10-02 20:02:02 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-26 05:45:28 +08:00
The size of the text outline.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="shadow_offset_x" data_type="constant" type="int" default="1">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The horizontal offset of the font's shadow.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-05 00:54:41 +08:00
<theme_item name="shadow_offset_y" data_type="constant" type="int" default="1">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The vertical offset of the font's shadow.
Sync classref with current source
2018-05-12 15:38:00 +08:00
</theme_item>
Fix Label and RichTextLabale text shadows and shadow outlines.
2021-11-06 06:28:48 +08:00
<theme_item name="shadow_outline_size" data_type="constant" type="int" default="1">
The size of the shadow outline.
</theme_item>
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-15 05:20:28 +08:00
<theme_item name="table_h_separation" data_type="constant" type="int" default="3">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The horizontal separation of elements in a table.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Rename theme properties to include underscores - check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-04-15 05:20:28 +08:00
<theme_item name="table_v_separation" data_type="constant" type="int" default="3">
Add LOTS of missing docs
2020-03-04 02:21:21 +08:00
The vertical separation of elements in a table.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_item>
Add padding options in theme for fg/bgcolor tags
2022-07-29 02:49:10 +08:00
<theme_item name="text_highlight_h_padding" data_type="constant" type="int" default="3">
The horizontal padding around a highlighting and background color box.
</theme_item>
<theme_item name="text_highlight_v_padding" data_type="constant" type="int" default="3">
The vertical padding around a highlighting and background color box.
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
<theme_item name="bold_font" data_type="font" type="Font">
The font used for bold text.
</theme_item>
<theme_item name="bold_italics_font" data_type="font" type="Font">
The font used for bold italics text.
</theme_item>
<theme_item name="italics_font" data_type="font" type="Font">
The font used for italics text.
</theme_item>
<theme_item name="mono_font" data_type="font" type="Font">
The font used for monospace text.
</theme_item>
<theme_item name="normal_font" data_type="font" type="Font">
The default text font.
</theme_item>
<theme_item name="bold_font_size" data_type="font_size" type="int">
The font size used for bold text.
</theme_item>
<theme_item name="bold_italics_font_size" data_type="font_size" type="int">
The font size used for bold italics text.
</theme_item>
<theme_item name="italics_font_size" data_type="font_size" type="int">
The font size used for italics text.
</theme_item>
<theme_item name="mono_font_size" data_type="font_size" type="int">
The font size used for monospace text.
</theme_item>
<theme_item name="normal_font_size" data_type="font_size" type="int">
The default text font size.
</theme_item>
<theme_item name="focus" data_type="style" type="StyleBox">
Document that transparent StyleBoxes/textures should be used for UI focus
2021-11-21 00:43:34 +08:00
The background used when the [RichTextLabel] 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.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-02 02:02:20 +08:00
</theme_item>
<theme_item name="normal" data_type="style" type="StyleBox">
The normal background for the [RichTextLabel].
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</theme_items>
</class>
Reference in New Issue Copy Permalink