asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Make RichTextLabel's parse_bbcode and append_text return void

Browse source
This commit is contained in:
Haoyu Qiu 2021-10-23 14:25:39 +08:00
parent f1f51f5d4b
commit 4f8dfa1667
3 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/RichTextLabel.xml
View file

@ -36,10 +36,10 @@
</description> </description>
</method> </method>
<method name="append_text"> <method name="append_text">
<return type="int" enum="Error" /> <return type="void" />
<argument index="0" name="bbcode" type="String" /> <argument index="0" name="bbcode" type="String" />
<description> <description>
Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful. Parses [code]bbcode[/code] and adds tags to the tag stack as needed.
[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]. [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].
</description> </description>
</method> </method>
@ -130,10 +130,10 @@
</description> </description>
</method> </method>
<method name="parse_bbcode"> <method name="parse_bbcode">
<return type="int" enum="Error" /> <return type="void" />
<argument index="0" name="bbcode" type="String" /> <argument index="0" name="bbcode" type="String" />
<description> <description>
The assignment version of [method append_text]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully. The assignment version of [method append_text]. Clears the tag stack and inserts the new content.
</description> </description>
</method> </method>
<method name="parse_expressions_for_values"> <method name="parse_expressions_for_values">

8
scene/gui/rich_text_label.cpp
View file

@ -2815,12 +2815,12 @@ bool RichTextLabel::is_scroll_following() const {
return scroll_follow; return scroll_follow;
} }
Error RichTextLabel::parse_bbcode(const String &p_bbcode) { void RichTextLabel::parse_bbcode(const String &p_bbcode) {
clear(); clear();
return append_text(p_bbcode); append_text(p_bbcode);
} }
Error RichTextLabel::append_text(const String &p_bbcode) { void RichTextLabel::append_text(const String &p_bbcode) {
int pos = 0; int pos = 0;
List<String> tag_stack; List<String> tag_stack;
@ -3543,8 +3543,6 @@ Error RichTextLabel::append_text(const String &p_bbcode) {
break; break;
} }
} }
return OK;
} }
void RichTextLabel::scroll_to_paragraph(int p_paragraph) { void RichTextLabel::scroll_to_paragraph(int p_paragraph) {

4
scene/gui/rich_text_label.h
View file

@ -552,8 +552,8 @@ public:
String get_selected_text() const; String get_selected_text() const;
void selection_copy(); void selection_copy();
Error parse_bbcode(const String &p_bbcode); void parse_bbcode(const String &p_bbcode);
Error append_text(const String &p_bbcode); void append_text(const String &p_bbcode);
void set_use_bbcode(bool p_enable); void set_use_bbcode(bool p_enable);
bool is_using_bbcode() const; bool is_using_bbcode() const;