RichTextLabel

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Label that displays rich text.

Member Functions

void add_image ( Texture image )
void add_text ( String text )
int append_bbcode ( String bbcode )
void clear ( )
int get_line_count ( ) const
int get_tab_size ( ) const
String get_text ( )
int get_total_character_count ( ) const
VScrollBar get_v_scroll ( )
int get_visible_line_count ( ) const
bool is_meta_underlined ( ) const
bool is_scroll_active ( ) const
bool is_scroll_following ( ) const
bool is_selection_enabled ( ) const
void newline ( )
int parse_bbcode ( String bbcode )
void pop ( )
void push_align ( int align )
void push_cell ( )
void push_color ( Color color )
void push_font ( Font font )
void push_indent ( int level )
void push_list ( int type )
void push_meta ( Variant data )
void push_table ( int columns )
void push_underline ( )
bool remove_line ( int line )
void scroll_to_line ( int line )
void set_meta_underline ( bool enable )
void set_scroll_active ( bool active )
void set_scroll_follow ( bool follow )
void set_selection_enabled ( bool enabled )
void set_tab_size ( int spaces )
void set_table_column_expand ( int column, bool expand, int ratio )
void set_text ( String text )

Signals

  • meta_clicked ( Nil meta )

Triggered when the user clicks on content between url tags. If the meta is defined in text, e.g. [url={"data"="hi"}]hi[/url], then the parameter for this signal will be a String type. If a particular type or an object is desired, the push_meta method must be used to manually insert the data into the tag stack.

  • meta_hover_ended ( Nil meta )

Triggers when the mouse exits a meta tag.

  • meta_hover_started ( Nil meta )

Triggers when the mouse enters a meta tag.

Member Variables

  • bool bbcode_enabled - If true the label uses BBCode formatting. Default value: false.
  • String bbcode_text - 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.
  • bool override_selected_font_color - If true the label uses the custom font color. Default value: false.
  • float percent_visible - The text’s visibility, as a float between 0.0 and 1.0.
  • int visible_characters - The restricted number of characters to display in the label.

Numeric Constants

  • ALIGN_LEFT = 0
  • ALIGN_CENTER = 1
  • ALIGN_RIGHT = 2
  • ALIGN_FILL = 3
  • LIST_NUMBERS = 0
  • LIST_LETTERS = 1
  • LIST_DOTS = 2
  • ITEM_FRAME = 0
  • ITEM_TEXT = 1
  • ITEM_IMAGE = 2
  • ITEM_NEWLINE = 3
  • ITEM_FONT = 4
  • ITEM_COLOR = 5
  • ITEM_UNDERLINE = 6
  • ITEM_ALIGN = 7
  • ITEM_INDENT = 8
  • ITEM_LIST = 9
  • ITEM_TABLE = 10
  • ITEM_META = 11

Description

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.

Note that assignments to bbcode_text clear the tag stack and reconstruct it from the property’s contents. Any edits made to bbcode_text will erase previous edits made from other manual sources such as append_bbcode and the push\_\* / pop methods.

Member Function Description

Adds an image’s opening and closing tags to the tag stack.

  • void add_text ( String text )

Adds raw non-bbcode-parsed text to the tag stack.

Parses bbcode and adds tags to the tag stack as needed. Returns the result of the parsing, OK if successful.

  • void clear ( )

Clears the tag stack and sets bbcode_text to an empty string.

  • int get_line_count ( ) const

Returns the total number of newlines in the tag stack’s text tags. Considers wrapped text as one line.

  • int get_tab_size ( ) const

Returns the number of spaces associated with a single tab length. Does not affect “t” in text tags, only indent tags.

Returns the raw content of bbcode_text.

  • int get_total_character_count ( ) const

Returns the total number of characters from text tags. Does not include bbcodes.

Returns the vertical scrollbar.

  • int get_visible_line_count ( ) const

Returns the number of visible lines.

  • bool is_meta_underlined ( ) const

Returns true if the label underlines meta tags such as url{text}.

  • bool is_scroll_active ( ) const

Returns true if the scrollbar is visible. Does not block scrolling completely. See scroll_to_line.

  • bool is_scroll_following ( ) const

Returns true if the window scrolls down to display new content automatically.

  • bool is_selection_enabled ( ) const

Returns true if the label allows text selection.

  • void newline ( )

Adds a newline tag to the tag stack.

The assignment version of append_bbcode. Clears the tag stack and inserts the new content. Returns OK if parses bbcode successfully.

  • void pop ( )

Terminates the current tag. Use after push\_\* methods to close bbcodes manually. Does not need to follow add\_\* methods.

  • void push_align ( int align )

Adds a [right] tag to the tag stack.

  • void push_cell ( )

Adds a [cell] tag to the tag stack. Must be inside a table tag. See push_table for details.

  • void push_color ( Color color )

Adds a [color] tag to the tag stack.

  • void push_font ( Font font )

Adds a [font] tag to the tag stack. Overrides default fonts for its duration.

  • void push_indent ( int level )

Adds an [indent] tag to the tag stack. Multiplies “level” by current tab_size to determine new margin length.

  • void push_list ( int type )

Adds a list tag to the tag stack. Similar to the bbcodes [ol] or [ul], but supports more list types. Not fully implemented!

Adds a meta tag to the tag stack. Similar to the bbcode [url=something]{text}[/url], but supports non-String metadata types.

  • void push_table ( int columns )

Adds a [table=columns] tag to the tag stack.

  • void push_underline ( )

Adds a [u] tag to the tag stack.

Removes a line of content from the label. Returns true if the line exists.

  • void scroll_to_line ( int line )

Scrolls the window’s top line to match line.

  • void set_meta_underline ( bool enable )

If true will underline meta tags such as the url bbcode. Default value: true.

  • void set_scroll_active ( bool active )

If false the vertical scrollbar is hidden. Default value: true.

  • void set_scroll_follow ( bool follow )

If true the window scrolls to reveal new content. Default value: false.

  • void set_selection_enabled ( bool enabled )

If true text can be selected.

  • void set_tab_size ( int spaces )

Sets the current tab length in spaces. Use with push_indent to redefine indent length.

  • void set_table_column_expand ( int column, bool expand, int ratio )

Edits the selected columns expansion options. If expand is true, the column expands in proportion to its expansion ratio versus the other columns’ ratios.

For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively.

Columns with a false expand will not contribute to the total ratio.

  • void set_text ( String text )

Clears the tag stack and adds a raw text tag to the top of it. Does not parse bbcodes. Does not modify bbcode_text.