Skip to content

Commit 2a3de7a

Browse files
bruvzgbruvzg
committed
[RTL] Add optional push_meta argument to control how meta underline is drawn.
1 parent 7d2ca2d commit 2a3de7a

File tree

5 files changed

+67
-6
lines changed

5 files changed

+67
-6
lines changed

‎doc/classes/RichTextLabel.xml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -428,8 +428,10 @@
428428
<method name="push_meta">
429429
<return type="void" />
430430
<param index="0" name="data" type="Variant" />
431+
<param index="1" name="underline_mode" type="int" enum="RichTextLabel.MetaUnderline" default="1" />
431432
<description>
432433
Adds a meta tag to the tag stack. Similar to the BBCode [code skip-lint][url=something]{text}[/url][/code], but supports non-[String] metadata types.
434+
If [member meta_underlined] is [code]true[/code], meta tags display an underline. This behavior can be customized with [param underline_mode].
433435
[b]Note:[/b] Meta tags do nothing by default when clicked. To assign behavior when clicked, connect [signal meta_clicked] to a function that is called when the meta tag is clicked.
434436
</description>
435437
</method>
@@ -723,6 +725,15 @@
723725
<constant name="MENU_MAX" value="2" enum="MenuItems">
724726
Represents the size of the [enum MenuItems] enum.
725727
</constant>
728+
<constant name="META_UNDERLINE_NEVER" value="0" enum="MetaUnderline">
729+
Meta tag does not display an underline, even if [member meta_underlined] is [code]true[/code].
730+
</constant>
731+
<constant name="META_UNDERLINE_ALWAYS" value="1" enum="MetaUnderline">
732+
If [member meta_underlined] is [code]true[/code], meta tag always display an underline.
733+
</constant>
734+
<constant name="META_UNDERLINE_ON_HOVER" value="2" enum="MetaUnderline">
735+
If [member meta_underlined] is [code]true[/code], meta tag display an underline when the mouse cursor is over it.
736+
</constant>
726737
<constant name="UPDATE_TEXTURE" value="1" enum="ImageUpdateMask" is_bitfield="true">
727738
If this bit is set, [method update_image] changes image texture.
728739
</constant>

‎misc/extension_api_validation/4.2-stable.expected‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,3 +224,10 @@ Validate extension JSON: JSON file: Field was added in a way that breaks compati
224224
Added a return value for add_bone.
225225
Should not affect existing regular use - the return value would just be unused.
226226
Compatibility method registered.
227+
228+
229+
GH-89024
230+
--------
231+
Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/push_meta/arguments': size changed value in new API, from 1 to 2.
232+
233+
Added optional argument. Compatibility method registered.

‎scene/gui/rich_text_label.compat.inc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,16 @@
3030

3131
#ifndef DISABLE_DEPRECATED
3232

33+
void RichTextLabel::_push_meta_bind_compat_89024(const Variant &p_meta) {
34+
push_meta(p_meta, RichTextLabel::MetaUnderline::META_UNDERLINE_ALWAYS);
35+
}
36+
3337
void RichTextLabel::_add_image_bind_compat_80410(const Ref<Texture2D> &p_image, const int p_width, const int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region) {
3438
add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, Variant(), false, String(), false);
3539
}
3640

3741
void RichTextLabel::_bind_compatibility_methods() {
42+
ClassDB::bind_compatibility_method(D_METHOD("push_meta", "data"), &RichTextLabel::_push_meta_bind_compat_89024);
3843
ClassDB::bind_compatibility_method(D_METHOD("add_image", "image", "width", "height", "color", "inline_align", "region"), &RichTextLabel::_add_image_bind_compat_80410, DEFVAL(0), DEFVAL(0), DEFVAL(Color(1.0, 1.0, 1.0)), DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(Rect2()));
3944
}
4045

‎scene/gui/rich_text_label.cpp‎

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1223,8 +1223,25 @@ int RichTextLabel::_draw_line(ItemFrame *p_frame, int p_line, const Vector2 &p_o
12231223
for (int i = 0; i < gl_size; i++) {
12241224
bool selected = selection.active && (sel_start != -1) && (glyphs[i].start >= sel_start) && (glyphs[i].end <= sel_end);
12251225
Item *it = _get_item_at_pos(it_from, it_to, glyphs[i].start);
1226+
bool has_ul = _find_underline(it);
1227+
if (!has_ul && underline_meta) {
1228+
ItemMeta *meta = nullptr;
1229+
if (_find_meta(it, nullptr, &meta) && meta) {
1230+
switch (meta->underline) {
1231+
case META_UNDERLINE_ALWAYS: {
1232+
has_ul = true;
1233+
} break;
1234+
case META_UNDERLINE_NEVER: {
1235+
has_ul = false;
1236+
} break;
1237+
case META_UNDERLINE_ON_HOVER: {
1238+
has_ul = (meta == meta_hovering);
1239+
} break;
1240+
}
1241+
}
1242+
}
12261243
Color font_color = _find_color(it, p_base_color);
1227-
if (_find_underline(it) || (_find_meta(it, nullptr) && underline_meta)) {
1244+
if (has_ul) {
12281245
if (ul_started && font_color != ul_color_prev) {
12291246
float y_off = TS->shaped_text_get_underline_position(rid);
12301247
float underline_width = MAX(1.0, TS->shaped_text_get_underline_thickness(rid) * theme_cache.base_scale);
@@ -2242,6 +2259,7 @@ void RichTextLabel::gui_input(const Ref<InputEvent> &p_event) {
22422259

22432260
Variant meta;
22442261
ItemMeta *item_meta;
2262+
ItemMeta *prev_meta = meta_hovering;
22452263
if (c_item && !outside && _find_meta(c_item, &meta, &item_meta)) {
22462264
if (meta_hovering != item_meta) {
22472265
if (meta_hovering) {
@@ -2250,11 +2268,17 @@ void RichTextLabel::gui_input(const Ref<InputEvent> &p_event) {
22502268
meta_hovering = item_meta;
22512269
current_meta = meta;
22522270
emit_signal(SNAME("meta_hover_started"), meta);
2271+
if ((item_meta && item_meta->underline == META_UNDERLINE_ON_HOVER) || (prev_meta && prev_meta->underline == META_UNDERLINE_ON_HOVER)) {
2272+
queue_redraw();
2273+
}
22532274
}
22542275
} else if (meta_hovering) {
22552276
meta_hovering = nullptr;
22562277
emit_signal(SNAME("meta_hover_ended"), current_meta);
22572278
current_meta = false;
2279+
if (prev_meta->underline == META_UNDERLINE_ON_HOVER) {
2280+
queue_redraw();
2281+
}
22582282
}
22592283
}
22602284
}
@@ -3650,7 +3674,7 @@ void RichTextLabel::push_list(int p_level, ListType p_list, bool p_capitalize, c
36503674
_add_item(item, true, true);
36513675
}
36523676

3653-
void RichTextLabel::push_meta(const Variant &p_meta) {
3677+
void RichTextLabel::push_meta(const Variant &p_meta, MetaUnderline p_underline_mode) {
36543678
_stop_thread();
36553679
MutexLock data_lock(data_mutex);
36563680

@@ -3659,6 +3683,7 @@ void RichTextLabel::push_meta(const Variant &p_meta) {
36593683
item->owner = get_instance_id();
36603684
item->rid = items.make_rid(item);
36613685
item->meta = p_meta;
3686+
item->underline = p_underline_mode;
36623687
_add_item(item, true);
36633688
}
36643689

@@ -4573,14 +4598,14 @@ void RichTextLabel::append_text(const String &p_bbcode) {
45734598
end = p_bbcode.length();
45744599
}
45754600
String url = p_bbcode.substr(brk_end + 1, end - brk_end - 1).unquote();
4576-
push_meta(url);
4601+
push_meta(url, META_UNDERLINE_ALWAYS);
45774602

45784603
pos = brk_end + 1;
45794604
tag_stack.push_front(tag);
45804605

45814606
} else if (tag.begins_with("url=")) {
45824607
String url = tag.substr(4, tag.length()).unquote();
4583-
push_meta(url);
4608+
push_meta(url, META_UNDERLINE_ALWAYS);
45844609
pos = brk_end + 1;
45854610
tag_stack.push_front("url");
45864611
} else if (tag.begins_with("hint=")) {
@@ -5891,7 +5916,7 @@ void RichTextLabel::_bind_methods() {
58915916
ClassDB::bind_method(D_METHOD("push_paragraph", "alignment", "base_direction", "language", "st_parser", "justification_flags", "tab_stops"), &RichTextLabel::push_paragraph, DEFVAL(TextServer::DIRECTION_AUTO), DEFVAL(""), DEFVAL(TextServer::STRUCTURED_TEXT_DEFAULT), DEFVAL(TextServer::JUSTIFICATION_WORD_BOUND | TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_SKIP_LAST_LINE | TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE), DEFVAL(PackedFloat32Array()));
58925917
ClassDB::bind_method(D_METHOD("push_indent", "level"), &RichTextLabel::push_indent);
58935918
ClassDB::bind_method(D_METHOD("push_list", "level", "type", "capitalize", "bullet"), &RichTextLabel::push_list, DEFVAL(String::utf8("•")));
5894-
ClassDB::bind_method(D_METHOD("push_meta", "data"), &RichTextLabel::push_meta);
5919+
ClassDB::bind_method(D_METHOD("push_meta", "data", "underline_mode"), &RichTextLabel::push_meta, DEFVAL(META_UNDERLINE_ALWAYS));
58955920
ClassDB::bind_method(D_METHOD("push_hint", "description"), &RichTextLabel::push_hint);
58965921
ClassDB::bind_method(D_METHOD("push_language", "language"), &RichTextLabel::push_language);
58975922
ClassDB::bind_method(D_METHOD("push_underline"), &RichTextLabel::push_underline);
@@ -6081,6 +6106,10 @@ void RichTextLabel::_bind_methods() {
60816106
BIND_ENUM_CONSTANT(MENU_SELECT_ALL);
60826107
BIND_ENUM_CONSTANT(MENU_MAX);
60836108

6109+
BIND_ENUM_CONSTANT(META_UNDERLINE_NEVER);
6110+
BIND_ENUM_CONSTANT(META_UNDERLINE_ALWAYS);
6111+
BIND_ENUM_CONSTANT(META_UNDERLINE_ON_HOVER);
6112+
60846113
BIND_BITFIELD_FLAG(UPDATE_TEXTURE);
60856114
BIND_BITFIELD_FLAG(UPDATE_SIZE);
60866115
BIND_BITFIELD_FLAG(UPDATE_COLOR);

‎scene/gui/rich_text_label.h‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ class RichTextLabel : public Control {
5151
LIST_DOTS
5252
};
5353

54+
enum MetaUnderline {
55+
META_UNDERLINE_NEVER,
56+
META_UNDERLINE_ALWAYS,
57+
META_UNDERLINE_ON_HOVER,
58+
};
59+
5460
enum ItemType {
5561
ITEM_FRAME,
5662
ITEM_TEXT,
@@ -117,6 +123,7 @@ class RichTextLabel : public Control {
117123
static void _bind_methods();
118124

119125
#ifndef DISABLE_DEPRECATED
126+
void _push_meta_bind_compat_89024(const Variant &p_meta);
120127
void _add_image_bind_compat_80410(const Ref<Texture2D> &p_image, const int p_width, const int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region);
121128
static void _bind_compatibility_methods();
122129
#endif
@@ -271,6 +278,7 @@ class RichTextLabel : public Control {
271278

272279
struct ItemMeta : public Item {
273280
Variant meta;
281+
MetaUnderline underline = META_UNDERLINE_ALWAYS;
274282
ItemMeta() { type = ITEM_META; }
275283
};
276284

@@ -668,7 +676,7 @@ class RichTextLabel : public Control {
668676
void push_paragraph(HorizontalAlignment p_alignment, Control::TextDirection p_direction = Control::TEXT_DIRECTION_INHERITED, const String &p_language = "", TextServer::StructuredTextParser p_st_parser = TextServer::STRUCTURED_TEXT_DEFAULT, BitField<TextServer::JustificationFlag> p_jst_flags = TextServer::JUSTIFICATION_WORD_BOUND | TextServer::JUSTIFICATION_KASHIDA | TextServer::JUSTIFICATION_SKIP_LAST_LINE | TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE, const PackedFloat32Array &p_tab_stops = PackedFloat32Array());
669677
void push_indent(int p_level);
670678
void push_list(int p_level, ListType p_list, bool p_capitalize, const String &p_bullet = String::utf8("•"));
671-
void push_meta(const Variant &p_meta);
679+
void push_meta(const Variant &p_meta, MetaUnderline p_underline_mode = META_UNDERLINE_ALWAYS);
672680
void push_hint(const String &p_string);
673681
void push_table(int p_columns, InlineAlignment p_alignment = INLINE_ALIGNMENT_TOP, int p_align_to_row = -1);
674682
void push_fade(int p_start_index, int p_length);
@@ -824,6 +832,7 @@ class RichTextLabel : public Control {
824832

825833
VARIANT_ENUM_CAST(RichTextLabel::ListType);
826834
VARIANT_ENUM_CAST(RichTextLabel::MenuItems);
835+
VARIANT_ENUM_CAST(RichTextLabel::MetaUnderline);
827836
VARIANT_BITFIELD_CAST(RichTextLabel::ImageUpdateMask);
828837

829838
#endif // RICH_TEXT_LABEL_H

0 commit comments

Comments
 (0)