label.cpp 43 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159
  1. /**************************************************************************/
  2. /* label.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "label.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/string/print_string.h"
  33. #include "core/string/translation.h"
  34. #include "scene/gui/container.h"
  35. #include "scene/theme/theme_db.h"
  36. #include "servers/text_server.h"
  37. void Label::set_autowrap_mode(TextServer::AutowrapMode p_mode) {
  38. if (autowrap_mode == p_mode) {
  39. return;
  40. }
  41. autowrap_mode = p_mode;
  42. lines_dirty = true;
  43. queue_redraw();
  44. update_configuration_warnings();
  45. if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
  46. update_minimum_size();
  47. }
  48. }
  49. TextServer::AutowrapMode Label::get_autowrap_mode() const {
  50. return autowrap_mode;
  51. }
  52. void Label::set_justification_flags(BitField<TextServer::JustificationFlag> p_flags) {
  53. if (jst_flags == p_flags) {
  54. return;
  55. }
  56. jst_flags = p_flags;
  57. lines_dirty = true;
  58. queue_redraw();
  59. }
  60. BitField<TextServer::JustificationFlag> Label::get_justification_flags() const {
  61. return jst_flags;
  62. }
  63. void Label::set_uppercase(bool p_uppercase) {
  64. if (uppercase == p_uppercase) {
  65. return;
  66. }
  67. uppercase = p_uppercase;
  68. dirty = true;
  69. queue_redraw();
  70. }
  71. bool Label::is_uppercase() const {
  72. return uppercase;
  73. }
  74. int Label::get_line_height(int p_line) const {
  75. Ref<Font> font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
  76. if (p_line >= 0 && p_line < lines_rid.size()) {
  77. return TS->shaped_text_get_size(lines_rid[p_line]).y;
  78. } else if (lines_rid.size() > 0) {
  79. int h = 0;
  80. for (int i = 0; i < lines_rid.size(); i++) {
  81. h = MAX(h, TS->shaped_text_get_size(lines_rid[i]).y);
  82. }
  83. return h;
  84. } else {
  85. int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
  86. return font->get_height(font_size);
  87. }
  88. }
  89. void Label::_shape() {
  90. Ref<StyleBox> style = theme_cache.normal_style;
  91. int width = (get_size().width - style->get_minimum_size().width);
  92. if (dirty || font_dirty) {
  93. if (dirty) {
  94. TS->shaped_text_clear(text_rid);
  95. }
  96. if (text_direction == Control::TEXT_DIRECTION_INHERITED) {
  97. TS->shaped_text_set_direction(text_rid, is_layout_rtl() ? TextServer::DIRECTION_RTL : TextServer::DIRECTION_LTR);
  98. } else {
  99. TS->shaped_text_set_direction(text_rid, (TextServer::Direction)text_direction);
  100. }
  101. const Ref<Font> &font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
  102. int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
  103. ERR_FAIL_COND(font.is_null());
  104. String txt = (uppercase) ? TS->string_to_upper(xl_text, language) : xl_text;
  105. if (visible_chars >= 0 && visible_chars_behavior == TextServer::VC_CHARS_BEFORE_SHAPING) {
  106. txt = txt.substr(0, visible_chars);
  107. }
  108. if (dirty) {
  109. TS->shaped_text_add_string(text_rid, txt, font->get_rids(), font_size, font->get_opentype_features(), language);
  110. } else {
  111. int spans = TS->shaped_get_span_count(text_rid);
  112. for (int i = 0; i < spans; i++) {
  113. TS->shaped_set_span_update_font(text_rid, i, font->get_rids(), font_size, font->get_opentype_features());
  114. }
  115. }
  116. TS->shaped_text_set_bidi_override(text_rid, structured_text_parser(st_parser, st_args, txt));
  117. if (!tab_stops.is_empty()) {
  118. TS->shaped_text_tab_align(text_rid, tab_stops);
  119. }
  120. dirty = false;
  121. font_dirty = false;
  122. lines_dirty = true;
  123. }
  124. if (lines_dirty) {
  125. for (int i = 0; i < lines_rid.size(); i++) {
  126. TS->free_rid(lines_rid[i]);
  127. }
  128. lines_rid.clear();
  129. BitField<TextServer::LineBreakFlag> autowrap_flags = TextServer::BREAK_MANDATORY;
  130. switch (autowrap_mode) {
  131. case TextServer::AUTOWRAP_WORD_SMART:
  132. autowrap_flags = TextServer::BREAK_WORD_BOUND | TextServer::BREAK_ADAPTIVE | TextServer::BREAK_MANDATORY;
  133. break;
  134. case TextServer::AUTOWRAP_WORD:
  135. autowrap_flags = TextServer::BREAK_WORD_BOUND | TextServer::BREAK_MANDATORY;
  136. break;
  137. case TextServer::AUTOWRAP_ARBITRARY:
  138. autowrap_flags = TextServer::BREAK_GRAPHEME_BOUND | TextServer::BREAK_MANDATORY;
  139. break;
  140. case TextServer::AUTOWRAP_OFF:
  141. break;
  142. }
  143. autowrap_flags = autowrap_flags | TextServer::BREAK_TRIM_EDGE_SPACES;
  144. PackedInt32Array line_breaks = TS->shaped_text_get_line_breaks(text_rid, width, 0, autowrap_flags);
  145. for (int i = 0; i < line_breaks.size(); i = i + 2) {
  146. RID line = TS->shaped_text_substr(text_rid, line_breaks[i], line_breaks[i + 1] - line_breaks[i]);
  147. if (!tab_stops.is_empty()) {
  148. TS->shaped_text_tab_align(line, tab_stops);
  149. }
  150. lines_rid.push_back(line);
  151. }
  152. }
  153. if (xl_text.length() == 0) {
  154. minsize = Size2(1, get_line_height());
  155. return;
  156. }
  157. if (autowrap_mode == TextServer::AUTOWRAP_OFF) {
  158. minsize.width = 0.0f;
  159. for (int i = 0; i < lines_rid.size(); i++) {
  160. if (minsize.width < TS->shaped_text_get_size(lines_rid[i]).x) {
  161. minsize.width = TS->shaped_text_get_size(lines_rid[i]).x;
  162. }
  163. }
  164. }
  165. if (lines_dirty) {
  166. BitField<TextServer::TextOverrunFlag> overrun_flags = TextServer::OVERRUN_NO_TRIM;
  167. switch (overrun_behavior) {
  168. case TextServer::OVERRUN_TRIM_WORD_ELLIPSIS:
  169. overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
  170. overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
  171. overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
  172. break;
  173. case TextServer::OVERRUN_TRIM_ELLIPSIS:
  174. overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
  175. overrun_flags.set_flag(TextServer::OVERRUN_ADD_ELLIPSIS);
  176. break;
  177. case TextServer::OVERRUN_TRIM_WORD:
  178. overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
  179. overrun_flags.set_flag(TextServer::OVERRUN_TRIM_WORD_ONLY);
  180. break;
  181. case TextServer::OVERRUN_TRIM_CHAR:
  182. overrun_flags.set_flag(TextServer::OVERRUN_TRIM);
  183. break;
  184. case TextServer::OVERRUN_NO_TRIMMING:
  185. break;
  186. }
  187. // Fill after min_size calculation.
  188. BitField<TextServer::JustificationFlag> line_jst_flags = jst_flags;
  189. if (!tab_stops.is_empty()) {
  190. line_jst_flags.set_flag(TextServer::JUSTIFICATION_AFTER_LAST_TAB);
  191. }
  192. if (autowrap_mode != TextServer::AUTOWRAP_OFF) {
  193. int visible_lines = get_visible_line_count();
  194. bool lines_hidden = visible_lines > 0 && visible_lines < lines_rid.size();
  195. if (lines_hidden) {
  196. overrun_flags.set_flag(TextServer::OVERRUN_ENFORCE_ELLIPSIS);
  197. }
  198. if (horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL) {
  199. int jst_to_line = visible_lines;
  200. if (lines_rid.size() == 1 && line_jst_flags.has_flag(TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE)) {
  201. jst_to_line = lines_rid.size();
  202. } else {
  203. if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE)) {
  204. jst_to_line = visible_lines - 1;
  205. }
  206. if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS)) {
  207. for (int i = visible_lines - 1; i >= 0; i--) {
  208. if (TS->shaped_text_has_visible_chars(lines_rid[i])) {
  209. jst_to_line = i;
  210. break;
  211. }
  212. }
  213. }
  214. }
  215. for (int i = 0; i < lines_rid.size(); i++) {
  216. if (i < jst_to_line) {
  217. TS->shaped_text_fit_to_width(lines_rid[i], width, line_jst_flags);
  218. } else if (i == (visible_lines - 1)) {
  219. TS->shaped_text_set_custom_ellipsis(lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
  220. TS->shaped_text_overrun_trim_to_width(lines_rid[i], width, overrun_flags);
  221. }
  222. }
  223. } else if (lines_hidden) {
  224. TS->shaped_text_set_custom_ellipsis(lines_rid[visible_lines - 1], (el_char.length() > 0) ? el_char[0] : 0x2026);
  225. TS->shaped_text_overrun_trim_to_width(lines_rid[visible_lines - 1], width, overrun_flags);
  226. }
  227. } else {
  228. // Autowrap disabled.
  229. int jst_to_line = lines_rid.size();
  230. if (lines_rid.size() == 1 && line_jst_flags.has_flag(TextServer::JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE)) {
  231. jst_to_line = lines_rid.size();
  232. } else {
  233. if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE)) {
  234. jst_to_line = lines_rid.size() - 1;
  235. }
  236. if (line_jst_flags.has_flag(TextServer::JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS)) {
  237. for (int i = lines_rid.size() - 1; i >= 0; i--) {
  238. if (TS->shaped_text_has_visible_chars(lines_rid[i])) {
  239. jst_to_line = i;
  240. break;
  241. }
  242. }
  243. }
  244. }
  245. for (int i = 0; i < lines_rid.size(); i++) {
  246. if (i < jst_to_line && horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL) {
  247. TS->shaped_text_fit_to_width(lines_rid[i], width, line_jst_flags);
  248. overrun_flags.set_flag(TextServer::OVERRUN_JUSTIFICATION_AWARE);
  249. TS->shaped_text_set_custom_ellipsis(lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
  250. TS->shaped_text_overrun_trim_to_width(lines_rid[i], width, overrun_flags);
  251. TS->shaped_text_fit_to_width(lines_rid[i], width, line_jst_flags | TextServer::JUSTIFICATION_CONSTRAIN_ELLIPSIS);
  252. } else {
  253. TS->shaped_text_set_custom_ellipsis(lines_rid[i], (el_char.length() > 0) ? el_char[0] : 0x2026);
  254. TS->shaped_text_overrun_trim_to_width(lines_rid[i], width, overrun_flags);
  255. }
  256. }
  257. }
  258. lines_dirty = false;
  259. }
  260. _update_visible();
  261. if (autowrap_mode == TextServer::AUTOWRAP_OFF || !clip || overrun_behavior == TextServer::OVERRUN_NO_TRIMMING) {
  262. update_minimum_size();
  263. }
  264. }
  265. void Label::_update_visible() {
  266. int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
  267. Ref<StyleBox> style = theme_cache.normal_style;
  268. int lines_visible = lines_rid.size();
  269. if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
  270. lines_visible = max_lines_visible;
  271. }
  272. minsize.height = 0;
  273. int last_line = MIN(lines_rid.size(), lines_visible + lines_skipped);
  274. for (int64_t i = lines_skipped; i < last_line; i++) {
  275. minsize.height += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
  276. }
  277. if (minsize.height > 0) {
  278. minsize.height -= line_spacing;
  279. }
  280. }
  281. inline void draw_glyph(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_color, const Vector2 &p_ofs) {
  282. if (p_gl.font_rid != RID()) {
  283. TS->font_draw_glyph(p_gl.font_rid, p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_color);
  284. } else {
  285. TS->draw_hex_code_box(p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_color);
  286. }
  287. }
  288. inline void draw_glyph_shadow(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_shadow_color, int p_shadow_outline_size, const Vector2 &p_ofs, const Vector2 &shadow_ofs) {
  289. if (p_gl.font_rid != RID()) {
  290. if (p_font_shadow_color.a > 0) {
  291. TS->font_draw_glyph(p_gl.font_rid, p_canvas, p_gl.font_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off) + shadow_ofs, p_gl.index, p_font_shadow_color);
  292. }
  293. if (p_font_shadow_color.a > 0 && p_shadow_outline_size > 0) {
  294. TS->font_draw_glyph_outline(p_gl.font_rid, p_canvas, p_gl.font_size, p_shadow_outline_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off) + shadow_ofs, p_gl.index, p_font_shadow_color);
  295. }
  296. }
  297. }
  298. inline void draw_glyph_outline(const Glyph &p_gl, const RID &p_canvas, const Color &p_font_outline_color, int p_outline_size, const Vector2 &p_ofs) {
  299. if (p_gl.font_rid != RID()) {
  300. if (p_font_outline_color.a != 0.0 && p_outline_size > 0) {
  301. TS->font_draw_glyph_outline(p_gl.font_rid, p_canvas, p_gl.font_size, p_outline_size, p_ofs + Vector2(p_gl.x_off, p_gl.y_off), p_gl.index, p_font_outline_color);
  302. }
  303. }
  304. }
  305. void Label::_ensure_shaped() const {
  306. if (dirty || font_dirty || lines_dirty) {
  307. const_cast<Label *>(this)->_shape();
  308. }
  309. }
  310. RID Label::get_line_rid(int p_line) const {
  311. return lines_rid[p_line];
  312. }
  313. Rect2 Label::get_line_rect(int p_line) const {
  314. // Returns a rect providing the line's horizontal offset and total size. To determine the vertical
  315. // offset, use r_offset and r_line_spacing from get_layout_data.
  316. bool rtl = TS->shaped_text_get_inferred_direction(text_rid) == TextServer::DIRECTION_RTL;
  317. bool rtl_layout = is_layout_rtl();
  318. Ref<StyleBox> style = theme_cache.normal_style;
  319. Size2 size = get_size();
  320. Size2 line_size = TS->shaped_text_get_size(lines_rid[p_line]);
  321. Vector2 offset;
  322. switch (horizontal_alignment) {
  323. case HORIZONTAL_ALIGNMENT_FILL:
  324. if (rtl && autowrap_mode != TextServer::AUTOWRAP_OFF) {
  325. offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
  326. } else {
  327. offset.x = style->get_offset().x;
  328. }
  329. break;
  330. case HORIZONTAL_ALIGNMENT_LEFT: {
  331. if (rtl_layout) {
  332. offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
  333. } else {
  334. offset.x = style->get_offset().x;
  335. }
  336. } break;
  337. case HORIZONTAL_ALIGNMENT_CENTER: {
  338. offset.x = int(size.width - line_size.width) / 2;
  339. } break;
  340. case HORIZONTAL_ALIGNMENT_RIGHT: {
  341. if (rtl_layout) {
  342. offset.x = style->get_offset().x;
  343. } else {
  344. offset.x = int(size.width - style->get_margin(SIDE_RIGHT) - line_size.width);
  345. }
  346. } break;
  347. }
  348. return Rect2(offset, line_size);
  349. }
  350. void Label::get_layout_data(Vector2 &r_offset, int &r_line_limit, int &r_line_spacing) const {
  351. // Computes several common parameters involved in laying out and rendering text set to this label.
  352. // Only vertical margin is considered in r_offset: use get_line_rect to get the horizontal offset
  353. // for a given line of text.
  354. Size2 size = get_size();
  355. Ref<StyleBox> style = theme_cache.normal_style;
  356. int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
  357. float total_h = 0.0;
  358. int lines_visible = 0;
  359. // Get number of lines to fit to the height.
  360. for (int64_t i = lines_skipped; i < lines_rid.size(); i++) {
  361. total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
  362. if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
  363. break;
  364. }
  365. lines_visible++;
  366. }
  367. if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
  368. lines_visible = max_lines_visible;
  369. }
  370. r_line_limit = MIN(lines_rid.size(), lines_visible + lines_skipped);
  371. // Get real total height.
  372. total_h = 0;
  373. for (int64_t i = lines_skipped; i < r_line_limit; i++) {
  374. total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
  375. }
  376. total_h += style->get_margin(SIDE_TOP) + style->get_margin(SIDE_BOTTOM);
  377. int vbegin = 0, vsep = 0;
  378. if (lines_visible > 0) {
  379. switch (vertical_alignment) {
  380. case VERTICAL_ALIGNMENT_TOP: {
  381. // Nothing.
  382. } break;
  383. case VERTICAL_ALIGNMENT_CENTER: {
  384. vbegin = (size.y - (total_h - line_spacing)) / 2;
  385. vsep = 0;
  386. } break;
  387. case VERTICAL_ALIGNMENT_BOTTOM: {
  388. vbegin = size.y - (total_h - line_spacing);
  389. vsep = 0;
  390. } break;
  391. case VERTICAL_ALIGNMENT_FILL: {
  392. vbegin = 0;
  393. if (lines_visible > 1) {
  394. vsep = (size.y - (total_h - line_spacing)) / (lines_visible - 1);
  395. } else {
  396. vsep = 0;
  397. }
  398. } break;
  399. }
  400. }
  401. r_offset = { 0, style->get_offset().y + vbegin };
  402. r_line_spacing = line_spacing + vsep;
  403. }
  404. PackedStringArray Label::get_configuration_warnings() const {
  405. PackedStringArray warnings = Control::get_configuration_warnings();
  406. // FIXME: This is not ideal and the sizing model should be fixed,
  407. // but for now we have to warn about this impossible to resolve combination.
  408. // See GH-83546.
  409. if (is_inside_tree() && get_tree()->get_edited_scene_root() != this) {
  410. // If the Label happens to be the root node of the edited scene, we don't need
  411. // to check what its parent is. It's going to be some node from the editor tree
  412. // and it can be a container, but that makes no difference to the user.
  413. Container *parent_container = Object::cast_to<Container>(get_parent_control());
  414. if (parent_container && autowrap_mode != TextServer::AUTOWRAP_OFF && get_custom_minimum_size() == Size2()) {
  415. warnings.push_back(RTR("Labels with autowrapping enabled must have a custom minimum size configured to work correctly inside a container."));
  416. }
  417. }
  418. // Ensure that the font can render all of the required glyphs.
  419. Ref<Font> font;
  420. if (settings.is_valid()) {
  421. font = settings->get_font();
  422. }
  423. if (font.is_null()) {
  424. font = theme_cache.font;
  425. }
  426. if (font.is_valid()) {
  427. _ensure_shaped();
  428. const Glyph *glyph = TS->shaped_text_get_glyphs(text_rid);
  429. int64_t glyph_count = TS->shaped_text_get_glyph_count(text_rid);
  430. for (int64_t i = 0; i < glyph_count; i++) {
  431. if (glyph[i].font_rid == RID()) {
  432. warnings.push_back(RTR("The current font does not support rendering one or more characters used in this Label's text."));
  433. break;
  434. }
  435. }
  436. }
  437. return warnings;
  438. }
  439. void Label::_notification(int p_what) {
  440. switch (p_what) {
  441. case NOTIFICATION_TRANSLATION_CHANGED: {
  442. String new_text = atr(text);
  443. if (new_text == xl_text) {
  444. return; // Nothing new.
  445. }
  446. xl_text = new_text;
  447. if (visible_ratio < 1) {
  448. visible_chars = get_total_character_count() * visible_ratio;
  449. }
  450. dirty = true;
  451. queue_redraw();
  452. update_configuration_warnings();
  453. } break;
  454. case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
  455. queue_redraw();
  456. } break;
  457. case NOTIFICATION_DRAW: {
  458. if (clip) {
  459. RenderingServer::get_singleton()->canvas_item_set_clip(get_canvas_item(), true);
  460. }
  461. // When a shaped text is invalidated by an external source, we want to reshape it.
  462. if (!TS->shaped_text_is_ready(text_rid)) {
  463. dirty = true;
  464. }
  465. for (const RID &line_rid : lines_rid) {
  466. if (!TS->shaped_text_is_ready(line_rid)) {
  467. lines_dirty = true;
  468. break;
  469. }
  470. }
  471. _ensure_shaped();
  472. RID ci = get_canvas_item();
  473. bool has_settings = settings.is_valid();
  474. Size2 string_size;
  475. Ref<StyleBox> style = theme_cache.normal_style;
  476. Color font_color = has_settings ? settings->get_font_color() : theme_cache.font_color;
  477. Color font_shadow_color = has_settings ? settings->get_shadow_color() : theme_cache.font_shadow_color;
  478. Point2 shadow_ofs = has_settings ? settings->get_shadow_offset() : theme_cache.font_shadow_offset;
  479. Color font_outline_color = has_settings ? settings->get_outline_color() : theme_cache.font_outline_color;
  480. int outline_size = has_settings ? settings->get_outline_size() : theme_cache.font_outline_size;
  481. int shadow_outline_size = has_settings ? settings->get_shadow_size() : theme_cache.font_shadow_outline_size;
  482. bool rtl = (TS->shaped_text_get_inferred_direction(text_rid) == TextServer::DIRECTION_RTL);
  483. bool rtl_layout = is_layout_rtl();
  484. style->draw(ci, Rect2(Point2(0, 0), get_size()));
  485. bool trim_chars = (visible_chars >= 0) && (visible_chars_behavior == TextServer::VC_CHARS_AFTER_SHAPING);
  486. bool trim_glyphs_ltr = (visible_chars >= 0) && ((visible_chars_behavior == TextServer::VC_GLYPHS_LTR) || ((visible_chars_behavior == TextServer::VC_GLYPHS_AUTO) && !rtl_layout));
  487. bool trim_glyphs_rtl = (visible_chars >= 0) && ((visible_chars_behavior == TextServer::VC_GLYPHS_RTL) || ((visible_chars_behavior == TextServer::VC_GLYPHS_AUTO) && rtl_layout));
  488. Vector2 ofs;
  489. int line_limit;
  490. int line_spacing;
  491. get_layout_data(ofs, line_limit, line_spacing);
  492. int processed_glyphs = 0;
  493. int total_glyphs = 0;
  494. for (int64_t i = lines_skipped; i < line_limit; i++) {
  495. total_glyphs += TS->shaped_text_get_glyph_count(lines_rid[i]) + TS->shaped_text_get_ellipsis_glyph_count(lines_rid[i]);
  496. }
  497. int visible_glyphs = total_glyphs * visible_ratio;
  498. for (int i = lines_skipped; i < line_limit; i++) {
  499. Vector2 line_offset = get_line_rect(i).position;
  500. ofs.x = line_offset.x;
  501. ofs.y += TS->shaped_text_get_ascent(lines_rid[i]);
  502. const Glyph *glyphs = TS->shaped_text_get_glyphs(lines_rid[i]);
  503. int gl_size = TS->shaped_text_get_glyph_count(lines_rid[i]);
  504. int ellipsis_pos = TS->shaped_text_get_ellipsis_pos(lines_rid[i]);
  505. int trim_pos = TS->shaped_text_get_trim_pos(lines_rid[i]);
  506. const Glyph *ellipsis_glyphs = TS->shaped_text_get_ellipsis_glyphs(lines_rid[i]);
  507. int ellipsis_gl_size = TS->shaped_text_get_ellipsis_glyph_count(lines_rid[i]);
  508. // Draw shadow, outline and text. Note: Do not merge this into the single loop iteration, to prevent overlaps.
  509. for (int step = DRAW_STEP_SHADOW; step < DRAW_STEP_MAX; step++) {
  510. if (step == DRAW_STEP_SHADOW && (font_shadow_color.a == 0)) {
  511. continue;
  512. }
  513. if (step == DRAW_STEP_OUTLINE && (outline_size <= 0 || font_outline_color.a == 0)) {
  514. continue;
  515. }
  516. int processed_glyphs_step = processed_glyphs;
  517. Vector2 offset_step = ofs;
  518. // Draw RTL ellipsis string when necessary.
  519. if (rtl && ellipsis_pos >= 0) {
  520. for (int gl_idx = ellipsis_gl_size - 1; gl_idx >= 0; gl_idx--) {
  521. for (int j = 0; j < ellipsis_glyphs[gl_idx].repeat; j++) {
  522. bool skip = (trim_chars && ellipsis_glyphs[gl_idx].end > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
  523. if (!skip) {
  524. if (step == DRAW_STEP_SHADOW) {
  525. draw_glyph_shadow(ellipsis_glyphs[gl_idx], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
  526. } else if (step == DRAW_STEP_OUTLINE) {
  527. draw_glyph_outline(ellipsis_glyphs[gl_idx], ci, font_outline_color, outline_size, offset_step);
  528. } else if (step == DRAW_STEP_TEXT) {
  529. draw_glyph(ellipsis_glyphs[gl_idx], ci, font_color, offset_step);
  530. }
  531. }
  532. processed_glyphs_step++;
  533. offset_step.x += ellipsis_glyphs[gl_idx].advance;
  534. }
  535. }
  536. }
  537. // Draw main text.
  538. for (int j = 0; j < gl_size; j++) {
  539. // Trim when necessary.
  540. if (trim_pos >= 0) {
  541. if (rtl) {
  542. if (j < trim_pos) {
  543. continue;
  544. }
  545. } else {
  546. if (j >= trim_pos) {
  547. break;
  548. }
  549. }
  550. }
  551. for (int k = 0; k < glyphs[j].repeat; k++) {
  552. bool skip = (trim_chars && glyphs[j].end > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
  553. if (!skip) {
  554. if (step == DRAW_STEP_SHADOW) {
  555. draw_glyph_shadow(glyphs[j], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
  556. } else if (step == DRAW_STEP_OUTLINE) {
  557. draw_glyph_outline(glyphs[j], ci, font_outline_color, outline_size, offset_step);
  558. } else if (step == DRAW_STEP_TEXT) {
  559. draw_glyph(glyphs[j], ci, font_color, offset_step);
  560. }
  561. }
  562. processed_glyphs_step++;
  563. offset_step.x += glyphs[j].advance;
  564. }
  565. }
  566. // Draw LTR ellipsis string when necessary.
  567. if (!rtl && ellipsis_pos >= 0) {
  568. for (int gl_idx = 0; gl_idx < ellipsis_gl_size; gl_idx++) {
  569. for (int j = 0; j < ellipsis_glyphs[gl_idx].repeat; j++) {
  570. bool skip = (trim_chars && ellipsis_glyphs[gl_idx].end > visible_chars) || (trim_glyphs_ltr && (processed_glyphs_step >= visible_glyphs)) || (trim_glyphs_rtl && (processed_glyphs_step < total_glyphs - visible_glyphs));
  571. if (!skip) {
  572. if (step == DRAW_STEP_SHADOW) {
  573. draw_glyph_shadow(ellipsis_glyphs[gl_idx], ci, font_shadow_color, shadow_outline_size, offset_step, shadow_ofs);
  574. } else if (step == DRAW_STEP_OUTLINE) {
  575. draw_glyph_outline(ellipsis_glyphs[gl_idx], ci, font_outline_color, outline_size, offset_step);
  576. } else if (step == DRAW_STEP_TEXT) {
  577. draw_glyph(ellipsis_glyphs[gl_idx], ci, font_color, offset_step);
  578. }
  579. }
  580. processed_glyphs_step++;
  581. offset_step.x += ellipsis_glyphs[gl_idx].advance;
  582. }
  583. }
  584. }
  585. }
  586. ofs.y += TS->shaped_text_get_descent(lines_rid[i]) + line_spacing;
  587. }
  588. } break;
  589. case NOTIFICATION_THEME_CHANGED: {
  590. font_dirty = true;
  591. queue_redraw();
  592. } break;
  593. case NOTIFICATION_RESIZED: {
  594. lines_dirty = true;
  595. } break;
  596. }
  597. }
  598. Rect2 Label::get_character_bounds(int p_pos) const {
  599. _ensure_shaped();
  600. Vector2 ofs;
  601. int line_limit;
  602. int line_spacing;
  603. get_layout_data(ofs, line_limit, line_spacing);
  604. for (int i = lines_skipped; i < line_limit; i++) {
  605. Rect2 line_rect = get_line_rect(i);
  606. ofs.x = line_rect.position.x;
  607. int v_size = TS->shaped_text_get_glyph_count(lines_rid[i]);
  608. const Glyph *glyphs = TS->shaped_text_get_glyphs(lines_rid[i]);
  609. float gl_off = 0.0f;
  610. for (int j = 0; j < v_size; j++) {
  611. if ((glyphs[j].count > 0) && ((glyphs[j].index != 0) || ((glyphs[j].flags & TextServer::GRAPHEME_IS_SPACE) == TextServer::GRAPHEME_IS_SPACE))) {
  612. if (p_pos >= glyphs[j].start && p_pos < glyphs[j].end) {
  613. float advance = 0.f;
  614. for (int k = 0; k < glyphs[j].count; k++) {
  615. advance += glyphs[j + k].advance;
  616. }
  617. Rect2 rect;
  618. rect.position = ofs + Vector2(gl_off, 0);
  619. rect.size = Vector2(advance, line_rect.size.y);
  620. return rect;
  621. }
  622. }
  623. gl_off += glyphs[j].advance * glyphs[j].repeat;
  624. }
  625. ofs.y += TS->shaped_text_get_ascent(lines_rid[i]) + TS->shaped_text_get_descent(lines_rid[i]) + line_spacing;
  626. }
  627. return Rect2();
  628. }
  629. Size2 Label::get_minimum_size() const {
  630. _ensure_shaped();
  631. Size2 min_size = minsize;
  632. const Ref<Font> &font = (settings.is_valid() && settings->get_font().is_valid()) ? settings->get_font() : theme_cache.font;
  633. int font_size = settings.is_valid() ? settings->get_font_size() : theme_cache.font_size;
  634. min_size.height = MAX(min_size.height, font->get_height(font_size) + font->get_spacing(TextServer::SPACING_TOP) + font->get_spacing(TextServer::SPACING_BOTTOM));
  635. Size2 min_style = theme_cache.normal_style->get_minimum_size();
  636. if (autowrap_mode != TextServer::AUTOWRAP_OFF) {
  637. return Size2(1, (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) ? 1 : min_size.height) + min_style;
  638. } else {
  639. if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
  640. min_size.width = 1;
  641. }
  642. return min_size + min_style;
  643. }
  644. }
  645. #ifndef DISABLE_DEPRECATED
  646. bool Label::_set(const StringName &p_name, const Variant &p_value) {
  647. if (p_name == SNAME("valign")) {
  648. set_vertical_alignment((VerticalAlignment)p_value.operator int());
  649. return true;
  650. } else if (p_name == SNAME("align")) {
  651. set_horizontal_alignment((HorizontalAlignment)p_value.operator int());
  652. return true;
  653. }
  654. return false;
  655. }
  656. #endif
  657. int Label::get_line_count() const {
  658. if (!is_inside_tree()) {
  659. return 1;
  660. }
  661. _ensure_shaped();
  662. return lines_rid.size();
  663. }
  664. int Label::get_visible_line_count() const {
  665. Ref<StyleBox> style = theme_cache.normal_style;
  666. int line_spacing = settings.is_valid() ? settings->get_line_spacing() : theme_cache.line_spacing;
  667. int lines_visible = 0;
  668. float total_h = 0.0;
  669. for (int64_t i = lines_skipped; i < lines_rid.size(); i++) {
  670. total_h += TS->shaped_text_get_size(lines_rid[i]).y + line_spacing;
  671. if (total_h > (get_size().height - style->get_minimum_size().height + line_spacing)) {
  672. break;
  673. }
  674. lines_visible++;
  675. }
  676. if (lines_visible > lines_rid.size()) {
  677. lines_visible = lines_rid.size();
  678. }
  679. if (max_lines_visible >= 0 && lines_visible > max_lines_visible) {
  680. lines_visible = max_lines_visible;
  681. }
  682. return lines_visible;
  683. }
  684. void Label::set_horizontal_alignment(HorizontalAlignment p_alignment) {
  685. ERR_FAIL_INDEX((int)p_alignment, 4);
  686. if (horizontal_alignment == p_alignment) {
  687. return;
  688. }
  689. if (horizontal_alignment == HORIZONTAL_ALIGNMENT_FILL || p_alignment == HORIZONTAL_ALIGNMENT_FILL) {
  690. lines_dirty = true; // Reshape lines.
  691. }
  692. horizontal_alignment = p_alignment;
  693. queue_redraw();
  694. }
  695. HorizontalAlignment Label::get_horizontal_alignment() const {
  696. return horizontal_alignment;
  697. }
  698. void Label::set_vertical_alignment(VerticalAlignment p_alignment) {
  699. ERR_FAIL_INDEX((int)p_alignment, 4);
  700. if (vertical_alignment == p_alignment) {
  701. return;
  702. }
  703. vertical_alignment = p_alignment;
  704. queue_redraw();
  705. }
  706. VerticalAlignment Label::get_vertical_alignment() const {
  707. return vertical_alignment;
  708. }
  709. void Label::set_text(const String &p_string) {
  710. if (text == p_string) {
  711. return;
  712. }
  713. text = p_string;
  714. xl_text = atr(p_string);
  715. dirty = true;
  716. if (visible_ratio < 1) {
  717. visible_chars = get_total_character_count() * visible_ratio;
  718. }
  719. queue_redraw();
  720. update_minimum_size();
  721. update_configuration_warnings();
  722. }
  723. void Label::_invalidate() {
  724. font_dirty = true;
  725. queue_redraw();
  726. }
  727. void Label::set_label_settings(const Ref<LabelSettings> &p_settings) {
  728. if (settings != p_settings) {
  729. if (settings.is_valid()) {
  730. settings->disconnect_changed(callable_mp(this, &Label::_invalidate));
  731. }
  732. settings = p_settings;
  733. if (settings.is_valid()) {
  734. settings->connect_changed(callable_mp(this, &Label::_invalidate), CONNECT_REFERENCE_COUNTED);
  735. }
  736. _invalidate();
  737. }
  738. }
  739. Ref<LabelSettings> Label::get_label_settings() const {
  740. return settings;
  741. }
  742. void Label::set_text_direction(Control::TextDirection p_text_direction) {
  743. ERR_FAIL_COND((int)p_text_direction < -1 || (int)p_text_direction > 3);
  744. if (text_direction != p_text_direction) {
  745. text_direction = p_text_direction;
  746. font_dirty = true;
  747. queue_redraw();
  748. }
  749. }
  750. void Label::set_structured_text_bidi_override(TextServer::StructuredTextParser p_parser) {
  751. if (st_parser != p_parser) {
  752. st_parser = p_parser;
  753. dirty = true;
  754. queue_redraw();
  755. }
  756. }
  757. TextServer::StructuredTextParser Label::get_structured_text_bidi_override() const {
  758. return st_parser;
  759. }
  760. void Label::set_structured_text_bidi_override_options(Array p_args) {
  761. if (st_args == p_args) {
  762. return;
  763. }
  764. st_args = p_args;
  765. dirty = true;
  766. queue_redraw();
  767. }
  768. Array Label::get_structured_text_bidi_override_options() const {
  769. return st_args;
  770. }
  771. Control::TextDirection Label::get_text_direction() const {
  772. return text_direction;
  773. }
  774. void Label::set_language(const String &p_language) {
  775. if (language != p_language) {
  776. language = p_language;
  777. dirty = true;
  778. queue_redraw();
  779. }
  780. }
  781. String Label::get_language() const {
  782. return language;
  783. }
  784. void Label::set_clip_text(bool p_clip) {
  785. if (clip == p_clip) {
  786. return;
  787. }
  788. clip = p_clip;
  789. queue_redraw();
  790. update_minimum_size();
  791. }
  792. bool Label::is_clipping_text() const {
  793. return clip;
  794. }
  795. void Label::set_tab_stops(const PackedFloat32Array &p_tab_stops) {
  796. if (tab_stops != p_tab_stops) {
  797. tab_stops = p_tab_stops;
  798. dirty = true;
  799. queue_redraw();
  800. }
  801. }
  802. PackedFloat32Array Label::get_tab_stops() const {
  803. return tab_stops;
  804. }
  805. void Label::set_text_overrun_behavior(TextServer::OverrunBehavior p_behavior) {
  806. if (overrun_behavior == p_behavior) {
  807. return;
  808. }
  809. overrun_behavior = p_behavior;
  810. lines_dirty = true;
  811. queue_redraw();
  812. if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
  813. update_minimum_size();
  814. }
  815. }
  816. TextServer::OverrunBehavior Label::get_text_overrun_behavior() const {
  817. return overrun_behavior;
  818. }
  819. void Label::set_ellipsis_char(const String &p_char) {
  820. String c = p_char;
  821. if (c.length() > 1) {
  822. WARN_PRINT("Ellipsis must be exactly one character long (" + itos(c.length()) + " characters given).");
  823. c = c.left(1);
  824. }
  825. if (el_char == c) {
  826. return;
  827. }
  828. el_char = c;
  829. lines_dirty = true;
  830. queue_redraw();
  831. if (clip || overrun_behavior != TextServer::OVERRUN_NO_TRIMMING) {
  832. update_minimum_size();
  833. }
  834. }
  835. String Label::get_ellipsis_char() const {
  836. return el_char;
  837. }
  838. String Label::get_text() const {
  839. return text;
  840. }
  841. void Label::set_visible_characters(int p_amount) {
  842. if (visible_chars != p_amount) {
  843. visible_chars = p_amount;
  844. if (get_total_character_count() > 0) {
  845. visible_ratio = (float)p_amount / (float)get_total_character_count();
  846. } else {
  847. visible_ratio = 1.0;
  848. }
  849. if (visible_chars_behavior == TextServer::VC_CHARS_BEFORE_SHAPING) {
  850. dirty = true;
  851. }
  852. queue_redraw();
  853. }
  854. }
  855. int Label::get_visible_characters() const {
  856. return visible_chars;
  857. }
  858. void Label::set_visible_ratio(float p_ratio) {
  859. if (visible_ratio != p_ratio) {
  860. if (p_ratio >= 1.0) {
  861. visible_chars = -1;
  862. visible_ratio = 1.0;
  863. } else if (p_ratio < 0.0) {
  864. visible_chars = 0;
  865. visible_ratio = 0.0;
  866. } else {
  867. visible_chars = get_total_character_count() * p_ratio;
  868. visible_ratio = p_ratio;
  869. }
  870. if (visible_chars_behavior == TextServer::VC_CHARS_BEFORE_SHAPING) {
  871. dirty = true;
  872. }
  873. queue_redraw();
  874. }
  875. }
  876. float Label::get_visible_ratio() const {
  877. return visible_ratio;
  878. }
  879. TextServer::VisibleCharactersBehavior Label::get_visible_characters_behavior() const {
  880. return visible_chars_behavior;
  881. }
  882. void Label::set_visible_characters_behavior(TextServer::VisibleCharactersBehavior p_behavior) {
  883. if (visible_chars_behavior != p_behavior) {
  884. visible_chars_behavior = p_behavior;
  885. dirty = true;
  886. queue_redraw();
  887. }
  888. }
  889. void Label::set_lines_skipped(int p_lines) {
  890. ERR_FAIL_COND(p_lines < 0);
  891. if (lines_skipped == p_lines) {
  892. return;
  893. }
  894. lines_skipped = p_lines;
  895. _update_visible();
  896. queue_redraw();
  897. }
  898. int Label::get_lines_skipped() const {
  899. return lines_skipped;
  900. }
  901. void Label::set_max_lines_visible(int p_lines) {
  902. if (max_lines_visible == p_lines) {
  903. return;
  904. }
  905. max_lines_visible = p_lines;
  906. _update_visible();
  907. queue_redraw();
  908. }
  909. int Label::get_max_lines_visible() const {
  910. return max_lines_visible;
  911. }
  912. int Label::get_total_character_count() const {
  913. _ensure_shaped();
  914. return xl_text.length();
  915. }
  916. void Label::_bind_methods() {
  917. ClassDB::bind_method(D_METHOD("set_horizontal_alignment", "alignment"), &Label::set_horizontal_alignment);
  918. ClassDB::bind_method(D_METHOD("get_horizontal_alignment"), &Label::get_horizontal_alignment);
  919. ClassDB::bind_method(D_METHOD("set_vertical_alignment", "alignment"), &Label::set_vertical_alignment);
  920. ClassDB::bind_method(D_METHOD("get_vertical_alignment"), &Label::get_vertical_alignment);
  921. ClassDB::bind_method(D_METHOD("set_text", "text"), &Label::set_text);
  922. ClassDB::bind_method(D_METHOD("get_text"), &Label::get_text);
  923. ClassDB::bind_method(D_METHOD("set_label_settings", "settings"), &Label::set_label_settings);
  924. ClassDB::bind_method(D_METHOD("get_label_settings"), &Label::get_label_settings);
  925. ClassDB::bind_method(D_METHOD("set_text_direction", "direction"), &Label::set_text_direction);
  926. ClassDB::bind_method(D_METHOD("get_text_direction"), &Label::get_text_direction);
  927. ClassDB::bind_method(D_METHOD("set_language", "language"), &Label::set_language);
  928. ClassDB::bind_method(D_METHOD("get_language"), &Label::get_language);
  929. ClassDB::bind_method(D_METHOD("set_autowrap_mode", "autowrap_mode"), &Label::set_autowrap_mode);
  930. ClassDB::bind_method(D_METHOD("get_autowrap_mode"), &Label::get_autowrap_mode);
  931. ClassDB::bind_method(D_METHOD("set_justification_flags", "justification_flags"), &Label::set_justification_flags);
  932. ClassDB::bind_method(D_METHOD("get_justification_flags"), &Label::get_justification_flags);
  933. ClassDB::bind_method(D_METHOD("set_clip_text", "enable"), &Label::set_clip_text);
  934. ClassDB::bind_method(D_METHOD("is_clipping_text"), &Label::is_clipping_text);
  935. ClassDB::bind_method(D_METHOD("set_tab_stops", "tab_stops"), &Label::set_tab_stops);
  936. ClassDB::bind_method(D_METHOD("get_tab_stops"), &Label::get_tab_stops);
  937. ClassDB::bind_method(D_METHOD("set_text_overrun_behavior", "overrun_behavior"), &Label::set_text_overrun_behavior);
  938. ClassDB::bind_method(D_METHOD("get_text_overrun_behavior"), &Label::get_text_overrun_behavior);
  939. ClassDB::bind_method(D_METHOD("set_ellipsis_char", "char"), &Label::set_ellipsis_char);
  940. ClassDB::bind_method(D_METHOD("get_ellipsis_char"), &Label::get_ellipsis_char);
  941. ClassDB::bind_method(D_METHOD("set_uppercase", "enable"), &Label::set_uppercase);
  942. ClassDB::bind_method(D_METHOD("is_uppercase"), &Label::is_uppercase);
  943. ClassDB::bind_method(D_METHOD("get_line_height", "line"), &Label::get_line_height, DEFVAL(-1));
  944. ClassDB::bind_method(D_METHOD("get_line_count"), &Label::get_line_count);
  945. ClassDB::bind_method(D_METHOD("get_visible_line_count"), &Label::get_visible_line_count);
  946. ClassDB::bind_method(D_METHOD("get_total_character_count"), &Label::get_total_character_count);
  947. ClassDB::bind_method(D_METHOD("set_visible_characters", "amount"), &Label::set_visible_characters);
  948. ClassDB::bind_method(D_METHOD("get_visible_characters"), &Label::get_visible_characters);
  949. ClassDB::bind_method(D_METHOD("get_visible_characters_behavior"), &Label::get_visible_characters_behavior);
  950. ClassDB::bind_method(D_METHOD("set_visible_characters_behavior", "behavior"), &Label::set_visible_characters_behavior);
  951. ClassDB::bind_method(D_METHOD("set_visible_ratio", "ratio"), &Label::set_visible_ratio);
  952. ClassDB::bind_method(D_METHOD("get_visible_ratio"), &Label::get_visible_ratio);
  953. ClassDB::bind_method(D_METHOD("set_lines_skipped", "lines_skipped"), &Label::set_lines_skipped);
  954. ClassDB::bind_method(D_METHOD("get_lines_skipped"), &Label::get_lines_skipped);
  955. ClassDB::bind_method(D_METHOD("set_max_lines_visible", "lines_visible"), &Label::set_max_lines_visible);
  956. ClassDB::bind_method(D_METHOD("get_max_lines_visible"), &Label::get_max_lines_visible);
  957. ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override", "parser"), &Label::set_structured_text_bidi_override);
  958. ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override"), &Label::get_structured_text_bidi_override);
  959. ClassDB::bind_method(D_METHOD("set_structured_text_bidi_override_options", "args"), &Label::set_structured_text_bidi_override_options);
  960. ClassDB::bind_method(D_METHOD("get_structured_text_bidi_override_options"), &Label::get_structured_text_bidi_override_options);
  961. ClassDB::bind_method(D_METHOD("get_character_bounds", "pos"), &Label::get_character_bounds);
  962. ADD_PROPERTY(PropertyInfo(Variant::STRING, "text", PROPERTY_HINT_MULTILINE_TEXT), "set_text", "get_text");
  963. ADD_PROPERTY(PropertyInfo(Variant::OBJECT, "label_settings", PROPERTY_HINT_RESOURCE_TYPE, "LabelSettings"), "set_label_settings", "get_label_settings");
  964. ADD_PROPERTY(PropertyInfo(Variant::INT, "horizontal_alignment", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_horizontal_alignment", "get_horizontal_alignment");
  965. ADD_PROPERTY(PropertyInfo(Variant::INT, "vertical_alignment", PROPERTY_HINT_ENUM, "Top,Center,Bottom,Fill"), "set_vertical_alignment", "get_vertical_alignment");
  966. ADD_PROPERTY(PropertyInfo(Variant::INT, "autowrap_mode", PROPERTY_HINT_ENUM, "Off,Arbitrary,Word,Word (Smart)"), "set_autowrap_mode", "get_autowrap_mode");
  967. ADD_PROPERTY(PropertyInfo(Variant::INT, "justification_flags", PROPERTY_HINT_FLAGS, "Kashida Justification:1,Word Justification:2,Justify Only After Last Tab:8,Skip Last Line:32,Skip Last Line With Visible Characters:64,Do Not Skip Single Line:128"), "set_justification_flags", "get_justification_flags");
  968. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "clip_text"), "set_clip_text", "is_clipping_text");
  969. ADD_PROPERTY(PropertyInfo(Variant::INT, "text_overrun_behavior", PROPERTY_HINT_ENUM, "Trim Nothing,Trim Characters,Trim Words,Ellipsis,Word Ellipsis"), "set_text_overrun_behavior", "get_text_overrun_behavior");
  970. ADD_PROPERTY(PropertyInfo(Variant::STRING, "ellipsis_char"), "set_ellipsis_char", "get_ellipsis_char");
  971. ADD_PROPERTY(PropertyInfo(Variant::BOOL, "uppercase"), "set_uppercase", "is_uppercase");
  972. ADD_PROPERTY(PropertyInfo(Variant::PACKED_FLOAT32_ARRAY, "tab_stops"), "set_tab_stops", "get_tab_stops");
  973. ADD_GROUP("Displayed Text", "");
  974. ADD_PROPERTY(PropertyInfo(Variant::INT, "lines_skipped", PROPERTY_HINT_RANGE, "0,999,1"), "set_lines_skipped", "get_lines_skipped");
  975. ADD_PROPERTY(PropertyInfo(Variant::INT, "max_lines_visible", PROPERTY_HINT_RANGE, "-1,999,1"), "set_max_lines_visible", "get_max_lines_visible");
  976. // Note: "visible_characters" and "visible_ratio" should be set after "text" to be correctly applied.
  977. ADD_PROPERTY(PropertyInfo(Variant::INT, "visible_characters", PROPERTY_HINT_RANGE, "-1,128000,1"), "set_visible_characters", "get_visible_characters");
  978. ADD_PROPERTY(PropertyInfo(Variant::INT, "visible_characters_behavior", PROPERTY_HINT_ENUM, "Characters Before Shaping,Characters After Shaping,Glyphs (Layout Direction),Glyphs (Left-to-Right),Glyphs (Right-to-Left)"), "set_visible_characters_behavior", "get_visible_characters_behavior");
  979. ADD_PROPERTY(PropertyInfo(Variant::FLOAT, "visible_ratio", PROPERTY_HINT_RANGE, "0,1,0.001"), "set_visible_ratio", "get_visible_ratio");
  980. ADD_GROUP("BiDi", "");
  981. ADD_PROPERTY(PropertyInfo(Variant::INT, "text_direction", PROPERTY_HINT_ENUM, "Auto,Left-to-Right,Right-to-Left,Inherited"), "set_text_direction", "get_text_direction");
  982. ADD_PROPERTY(PropertyInfo(Variant::STRING, "language", PROPERTY_HINT_LOCALE_ID, ""), "set_language", "get_language");
  983. ADD_PROPERTY(PropertyInfo(Variant::INT, "structured_text_bidi_override", PROPERTY_HINT_ENUM, "Default,URI,File,Email,List,None,Custom"), "set_structured_text_bidi_override", "get_structured_text_bidi_override");
  984. ADD_PROPERTY(PropertyInfo(Variant::ARRAY, "structured_text_bidi_override_options"), "set_structured_text_bidi_override_options", "get_structured_text_bidi_override_options");
  985. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_STYLEBOX, Label, normal_style, "normal");
  986. BIND_THEME_ITEM(Theme::DATA_TYPE_CONSTANT, Label, line_spacing);
  987. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT, Label, font);
  988. BIND_THEME_ITEM(Theme::DATA_TYPE_FONT_SIZE, Label, font_size);
  989. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, Label, font_color);
  990. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, Label, font_shadow_color);
  991. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, Label, font_shadow_offset.x, "shadow_offset_x");
  992. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, Label, font_shadow_offset.y, "shadow_offset_y");
  993. BIND_THEME_ITEM(Theme::DATA_TYPE_COLOR, Label, font_outline_color);
  994. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, Label, font_outline_size, "outline_size");
  995. BIND_THEME_ITEM_CUSTOM(Theme::DATA_TYPE_CONSTANT, Label, font_shadow_outline_size, "shadow_outline_size");
  996. }
  997. Label::Label(const String &p_text) {
  998. text_rid = TS->create_shaped_text();
  999. set_mouse_filter(MOUSE_FILTER_IGNORE);
  1000. set_text(p_text);
  1001. set_v_size_flags(SIZE_SHRINK_CENTER);
  1002. }
  1003. Label::~Label() {
  1004. for (int i = 0; i < lines_rid.size(); i++) {
  1005. TS->free_rid(lines_rid[i]);
  1006. }
  1007. lines_rid.clear();
  1008. TS->free_rid(text_rid);
  1009. }