Struct gdnative::api::RichTextLabel

pub struct RichTextLabel { /* fields omitted */ }

core class RichTextLabel inherits Control (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

RichTextLabel is a reference-only type. Persistent references can only exist in the unsafe Ref<RichTextLabel> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

RichTextLabel inherits methods from:

• Control
• CanvasItem
• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl RichTextLabel

Constants

pub const ALIGN_CENTER: i64

pub const ALIGN_FILL: i64

pub const ALIGN_LEFT: i64

pub const ALIGN_RIGHT: i64

pub const ITEM_ALIGN: i64

pub const ITEM_COLOR: i64

pub const ITEM_CUSTOMFX: i64

pub const ITEM_FADE: i64

pub const ITEM_FONT: i64

pub const ITEM_FRAME: i64

pub const ITEM_IMAGE: i64

pub const ITEM_INDENT: i64

pub const ITEM_LIST: i64

pub const ITEM_META: i64

pub const ITEM_NEWLINE: i64

pub const ITEM_RAINBOW: i64

pub const ITEM_SHAKE: i64

pub const ITEM_STRIKETHROUGH: i64

pub const ITEM_TABLE: i64

pub const ITEM_TEXT: i64

pub const ITEM_TORNADO: i64

pub const ITEM_UNDERLINE: i64

pub const ITEM_WAVE: i64

pub const LIST_DOTS: i64

pub const LIST_LETTERS: i64

pub const LIST_NUMBERS: i64

impl RichTextLabel

pub fn new() -> Ref<RichTextLabel, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn add_image(&self, image: impl AsArg<Texture>, width: i64, height: i64)

Adds an image's opening and closing tags to the tag stack, optionally providing a [code]width[/code] and [code]height[/code] to resize the image.
				If [code]width[/code] or [code]height[/code] is set to 0, the image size will be adjusted in order to keep the original aspect ratio.

Default Arguments

• width - 0
• height - 0

pub fn add_text(&self, text: impl Into<GodotString>)

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

pub fn append_bbcode(
    &self,
    bbcode: impl Into<GodotString>
) -> Result<(), GodotError>

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

pub fn clear(&self)

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

pub fn bbcode(&self) -> GodotString

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.
			[b]Note:[/b] It is unadvised to use [code]+=[/code] operator with [code]bbcode_text[/code] (e.g. [code]bbcode_text += "some string"[/code]) as it replaces the whole text and can cause slowdowns. Use [method append_bbcode] for adding text instead.

pub fn get_content_height(&self) -> i64

Returns the height of the content.

pub fn effects(&self) -> VariantArray<Shared>

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].

pub fn get_line_count(&self) -> i64

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

pub fn percent_visible(&self) -> f64

The range of characters to display, as a [float] between 0.0 and 1.0. When assigned an out of range value, it's the same as assigning 1.0.
			[b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count].

pub fn tab_size(&self) -> i64

The number of spaces associated with a single tab length. Does not affect [code]\t[/code] in text tags, only indent tags.

pub fn text(&self) -> GodotString

The raw text of the label.
			When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse BBCodes. Does not modify [member bbcode_text].

pub fn get_total_character_count(&self) -> i64

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

pub fn get_v_scroll(&self) -> Option<Ref<VScrollBar, Shared>>

Returns the vertical scrollbar.

pub fn visible_characters(&self) -> i64

The restricted number of characters to display in the label. If [code]-1[/code], all characters will be displayed.

pub fn get_visible_line_count(&self) -> i64

Returns the number of visible lines.

pub fn install_effect(&self, effect: impl OwnedToVariant)

Installs a custom effect. [code]effect[/code] should be a valid [RichTextEffect].

pub fn is_fit_content_height_enabled(&self) -> bool

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.

pub fn is_meta_underlined(&self) -> bool

If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code].

pub fn is_overriding_selected_font_color(&self) -> bool

If [code]true[/code], the label uses the custom font color.

pub fn is_scroll_active(&self) -> bool

If [code]true[/code], the scrollbar is visible. Setting this to [code]false[/code] does not block scrolling completely. See [method scroll_to_line].

pub fn is_scroll_following(&self) -> bool

If [code]true[/code], the window scrolls down to display new content automatically.

pub fn is_selection_enabled(&self) -> bool

If [code]true[/code], the label allows text selection.

pub fn is_using_bbcode(&self) -> bool

If [code]true[/code], the label uses BBCode formatting.

pub fn newline(&self)

Adds a newline tag to the tag stack.

pub fn parse_bbcode(
    &self,
    bbcode: impl Into<GodotString>
) -> Result<(), GodotError>

The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully.

pub fn parse_expressions_for_values(
    &self,
    expressions: TypedArray<GodotString>
) -> Dictionary<Shared>

Parses BBCode parameter [code]expressions[/code] into a dictionary.

pub fn pop(&self)

Terminates the current tag. Use after [code]push_*[/code] methods to close BBCodes manually. Does not need to follow [code]add_*[/code] methods.

pub fn push_align(&self, align: i64)

Adds an [code][align][/code] tag based on the given [code]align[/code] value. See [enum Align] for possible values.

pub fn push_bold(&self)

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.

pub fn push_bold_italics(&self)

Adds a [code][font][/code] tag with a bold italics font to the tag stack.

pub fn push_cell(&self)

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

pub fn push_color(&self, color: Color)

Adds a [code][color][/code] tag to the tag stack.

pub fn push_font(&self, font: impl AsArg<Font>)

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

pub fn push_indent(&self, level: i64)

Adds an [code][indent][/code] tag to the tag stack. Multiplies [code]level[/code] by current [member tab_size] to determine new margin length.

pub fn push_italics(&self)

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.

pub fn push_list(&self, _type: i64)

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

pub fn push_meta(&self, data: impl OwnedToVariant)

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.

pub fn push_mono(&self)

Adds a [code][font][/code] tag with a monospace font to the tag stack.

pub fn push_normal(&self)

Adds a [code][font][/code] tag with a normal font to the tag stack.

pub fn push_strikethrough(&self)

Adds a [code][s][/code] tag to the tag stack.

pub fn push_table(&self, columns: i64)

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

pub fn push_underline(&self)

Adds a [code][u][/code] tag to the tag stack.

pub fn remove_line(&self, line: i64) -> bool

Removes a line of content from the label. Returns [code]true[/code] if the line exists.
				The [code]line[/code] argument is the index of the line to remove, it can take values in the interval [code][0, get_line_count() - 1][/code].

pub fn scroll_to_line(&self, line: i64)

Scrolls the window's top line to match [code]line[/code].

pub fn set_bbcode(&self, text: impl Into<GodotString>)

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.
			[b]Note:[/b] It is unadvised to use [code]+=[/code] operator with [code]bbcode_text[/code] (e.g. [code]bbcode_text += "some string"[/code]) as it replaces the whole text and can cause slowdowns. Use [method append_bbcode] for adding text instead.

pub fn set_effects(&self, effects: VariantArray<Shared>)

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].

pub fn set_fit_content_height(&self, enabled: bool)

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.

pub fn set_meta_underline(&self, enable: bool)

If [code]true[/code], the label underlines meta tags such as [code][url]{text}[/url][/code].

pub fn set_override_selected_font_color(&self, _override: bool)

If [code]true[/code], the label uses the custom font color.

pub fn set_percent_visible(&self, percent_visible: f64)

The range of characters to display, as a [float] between 0.0 and 1.0. When assigned an out of range value, it's the same as assigning 1.0.
			[b]Note:[/b] Setting this property updates [member visible_characters] based on current [method get_total_character_count].

pub fn set_scroll_active(&self, active: bool)

If [code]true[/code], the scrollbar is visible. Setting this to [code]false[/code] does not block scrolling completely. See [method scroll_to_line].

pub fn set_scroll_follow(&self, follow: bool)

If [code]true[/code], the window scrolls down to display new content automatically.

pub fn set_selection_enabled(&self, enabled: bool)

If [code]true[/code], the label allows text selection.

pub fn set_tab_size(&self, spaces: i64)

The number of spaces associated with a single tab length. Does not affect [code]\t[/code] in text tags, only indent tags.

pub fn set_table_column_expand(&self, column: i64, expand: bool, ratio: i64)

Edits the selected column's expansion options. If [code]expand[/code] is [code]true[/code], 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.
				If [code]expand[/code] is [code]false[/code], the column will not contribute to the total ratio.

pub fn set_text(&self, text: impl Into<GodotString>)

The raw text of the label.
			When set, clears the tag stack and adds a raw text tag to the top of it. Does not parse BBCodes. Does not modify [member bbcode_text].

pub fn set_use_bbcode(&self, enable: bool)

If [code]true[/code], the label uses BBCode formatting.

pub fn set_visible_characters(&self, amount: i64)

The restricted number of characters to display in the label. If [code]-1[/code], all characters will be displayed.

Methods from Deref<Target = Control>

pub const ANCHOR_BEGIN: i64

pub const ANCHOR_END: i64

pub const CURSOR_ARROW: i64

pub const CURSOR_BDIAGSIZE: i64

pub const CURSOR_BUSY: i64

pub const CURSOR_CAN_DROP: i64

pub const CURSOR_CROSS: i64

pub const CURSOR_DRAG: i64

pub const CURSOR_FDIAGSIZE: i64

pub const CURSOR_FORBIDDEN: i64

pub const CURSOR_HELP: i64

pub const CURSOR_HSIZE: i64

pub const CURSOR_HSPLIT: i64

pub const CURSOR_IBEAM: i64

pub const CURSOR_MOVE: i64

pub const CURSOR_POINTING_HAND: i64

pub const CURSOR_VSIZE: i64

pub const CURSOR_VSPLIT: i64

pub const CURSOR_WAIT: i64

pub const FOCUS_ALL: i64

pub const FOCUS_CLICK: i64

pub const FOCUS_NONE: i64

pub const GROW_DIRECTION_BEGIN: i64

pub const GROW_DIRECTION_BOTH: i64

pub const GROW_DIRECTION_END: i64

pub const MOUSE_FILTER_IGNORE: i64

pub const MOUSE_FILTER_PASS: i64

pub const MOUSE_FILTER_STOP: i64

pub const NOTIFICATION_FOCUS_ENTER: i64

pub const NOTIFICATION_FOCUS_EXIT: i64

pub const NOTIFICATION_MODAL_CLOSE: i64

pub const NOTIFICATION_MOUSE_ENTER: i64

pub const NOTIFICATION_MOUSE_EXIT: i64

pub const NOTIFICATION_RESIZED: i64

pub const NOTIFICATION_SCROLL_BEGIN: i64

pub const NOTIFICATION_SCROLL_END: i64

pub const NOTIFICATION_THEME_CHANGED: i64

pub const PRESET_BOTTOM_LEFT: i64

pub const PRESET_BOTTOM_RIGHT: i64

pub const PRESET_BOTTOM_WIDE: i64

pub const PRESET_CENTER: i64

pub const PRESET_CENTER_BOTTOM: i64

pub const PRESET_CENTER_LEFT: i64

pub const PRESET_CENTER_RIGHT: i64

pub const PRESET_CENTER_TOP: i64

pub const PRESET_HCENTER_WIDE: i64

pub const PRESET_LEFT_WIDE: i64

pub const PRESET_MODE_KEEP_HEIGHT: i64

pub const PRESET_MODE_KEEP_SIZE: i64

pub const PRESET_MODE_KEEP_WIDTH: i64

pub const PRESET_MODE_MINSIZE: i64

pub const PRESET_RIGHT_WIDE: i64

pub const PRESET_TOP_LEFT: i64

pub const PRESET_TOP_RIGHT: i64

pub const PRESET_TOP_WIDE: i64

pub const PRESET_VCENTER_WIDE: i64

pub const PRESET_WIDE: i64

pub const SIZE_EXPAND: i64

pub const SIZE_EXPAND_FILL: i64

pub const SIZE_FILL: i64

pub const SIZE_SHRINK_CENTER: i64

pub const SIZE_SHRINK_END: i64

pub fn accept_event(&self)

Marks an input event as handled. Once you accept an input event, it stops propagating, even to nodes listening to [method Node._unhandled_input] or [method Node._unhandled_key_input].

pub fn add_color_override(&self, name: impl Into<GodotString>, color: Color)

Overrides the [Color] with given [code]name[/code] in the [member theme] resource the control uses.
				[b]Note:[/b] Unlike other theme overrides, there is no way to undo a color override without manually assigning the previous color.
				[b]Example of overriding a label's color and resetting it later:[/b]
				[codeblock]
				# Override the child node "MyLabel"'s font color to orange.
				$MyLabel.add_color_override("font_color", Color(1, 0.5, 0))

				# Reset the color by creating a new node to get the default value:
				var default_label_color = Label.new().get_color("font_color")
				$MyLabel.add_color_override("font_color", default_label_color)
				[/codeblock]

pub fn add_constant_override(&self, name: impl Into<GodotString>, constant: i64)

Overrides an integer constant with given [code]name[/code] in the [member theme] resource the control uses. If the [code]constant[/code] is [code]0[/code], the override is cleared and the constant from assigned [Theme] is used.

pub fn add_font_override(
    &self,
    name: impl Into<GodotString>,
    font: impl AsArg<Font>
)

Overrides the font with given [code]name[/code] in the [member theme] resource the control uses. If [code]font[/code] is [code]null[/code] or invalid, the override is cleared and the font from assigned [Theme] is used.

pub fn add_icon_override(
    &self,
    name: impl Into<GodotString>,
    texture: impl AsArg<Texture>
)

Overrides the icon with given [code]name[/code] in the [member theme] resource the control uses. If [code]icon[/code] is [code]null[/code] or invalid, the override is cleared and the icon from assigned [Theme] is used.

pub fn add_shader_override(
    &self,
    name: impl Into<GodotString>,
    shader: impl AsArg<Shader>
)

Overrides the [Shader] with given [code]name[/code] in the [member theme] resource the control uses. If [code]shader[/code] is [code]null[/code] or invalid, the override is cleared and the shader from assigned [Theme] is used.

pub fn add_stylebox_override(
    &self,
    name: impl Into<GodotString>,
    stylebox: impl AsArg<StyleBox>
)

Overrides the [StyleBox] with given [code]name[/code] in the [member theme] resource the control uses. If [code]stylebox[/code] is empty or invalid, the override is cleared and the [StyleBox] from assigned [Theme] is used.
				[b]Example of modifying a property in a StyleBox by duplicating it:[/b]
				[codeblock]
				# The snippet below assumes the child node MyButton has a StyleBoxFlat assigned.
				# Resources are shared across instances, so we need to duplicate it
				# to avoid modifying the appearance of all other buttons.
				var new_stylebox_normal = $MyButton.get_stylebox("normal").duplicate()
				new_stylebox_normal.border_width_top = 3
				new_stylebox_normal.border_color = Color(0, 1, 0.5)
				$MyButton.add_stylebox_override("normal", new_stylebox_normal)

				# Remove the stylebox override:
				$MyButton.add_stylebox_override("normal", null)
				[/codeblock]

pub fn force_drag(
    &self,
    data: impl OwnedToVariant,
    preview: impl AsArg<Control>
)

Forces drag and bypasses [method get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control.
				The methods [method can_drop_data] and [method drop_data] must be implemented on controls that want to receive drop data.

pub fn anchor(&self, margin: i64) -> f64

Anchors the top edge of the node to the origin, the center or the end of its parent control. It changes how the top margin updates when the node moves or changes size. You can use  one of the [enum Anchor] constants for convenience.

pub fn get_begin(&self) -> Vector2D<f32, UnknownUnit>

Returns [member margin_left] and [member margin_top]. See also [member rect_position].

pub fn get_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Color

Returns a color from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].
				[codeblock]
				func _ready():
				    modulate = get_color("font_color", "Button") #get the color defined for button fonts
				[/codeblock]

Default Arguments

• type - ""

pub fn get_combined_minimum_size(&self) -> Vector2D<f32, UnknownUnit>

Returns combined minimum size from [member rect_min_size] and [method get_minimum_size].

pub fn get_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> i64

Returns a constant from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].

Default Arguments

• type - ""

pub fn get_cursor_shape(
    &self,
    position: Vector2D<f32, UnknownUnit>
) -> CursorShape

Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape].

Default Arguments

• position - Vector2( 0, 0 )

pub fn custom_minimum_size(&self) -> Vector2D<f32, UnknownUnit>

The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.

pub fn default_cursor_shape(&self) -> CursorShape

The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
			[b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system.

pub fn get_end(&self) -> Vector2D<f32, UnknownUnit>

Returns [member margin_right] and [member margin_bottom].

pub fn focus_mode(&self) -> FocusMode

The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.

pub fn focus_neighbour(&self, margin: i64) -> NodePath

Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the [code]ui_top[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one.

pub fn focus_next(&self) -> NodePath

Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_next[/code] input action.
			If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.

pub fn get_focus_owner(&self) -> Option<Ref<Control, Shared>>

Returns the control that has the keyboard focus or [code]null[/code] if none.

pub fn focus_previous(&self) -> NodePath

Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_prev[/code] input action.
			If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.

pub fn get_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<Font, Shared>>

Returns a font from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].

Default Arguments

• type - ""

pub fn global_position(&self) -> Vector2D<f32, UnknownUnit>

The node's global position, relative to the world (usually to the top-left corner of the window).

pub fn get_global_rect(&self) -> Rect<f32, UnknownUnit>

Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size].

pub fn h_grow_direction(&self) -> GrowDirection

Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

pub fn h_size_flags(&self) -> i64

Tells the parent [Container] nodes how they should resize and place the node on the X axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

pub fn get_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<Texture, Shared>>

Returns an icon from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].

Default Arguments

• type - ""

pub fn margin(&self, margin: i64) -> f64

Distance between the node's top edge and its parent control, based on [member anchor_top].
			Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.

pub fn get_minimum_size(&self) -> Vector2D<f32, UnknownUnit>

Returns the minimum size for this control. See [member rect_min_size].

pub fn mouse_filter(&self) -> MouseFilter

Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does.

pub fn get_parent_area_size(&self) -> Vector2D<f32, UnknownUnit>

Returns the width/height occupied in the parent control.

pub fn get_parent_control(&self) -> Option<Ref<Control, Shared>>

Returns the parent control node.

pub fn pivot_offset(&self) -> Vector2D<f32, UnknownUnit>

By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle.

pub fn position(&self) -> Vector2D<f32, UnknownUnit>

The node's position, relative to its parent. It corresponds to the rectangle's top-left corner. The property is not affected by [member rect_pivot_offset].

pub fn get_rect(&self) -> Rect<f32, UnknownUnit>

Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size].

pub fn get_rotation(&self) -> f64

Returns the rotation (in radians).

pub fn rotation_degrees(&self) -> f64

The node's rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot's position.

pub fn scale(&self) -> Vector2D<f32, UnknownUnit>

The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. The Control's [member hint_tooltip] will also scale according to this value.
			[b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually.
			[b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instanced. To set the Control's scale when it's instanced, wait for one frame using [code]yield(get_tree(), "idle_frame")[/code] then set its [member rect_scale] property.

pub fn size(&self) -> Vector2D<f32, UnknownUnit>

The size of the node's bounding rectangle, in pixels. [Container] nodes update this property automatically.

pub fn stretch_ratio(&self) -> f64

If the node and at least one of its neighbours uses the [constant SIZE_EXPAND] size flag, the parent [Container] will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.

pub fn get_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> Option<Ref<StyleBox, Shared>>

Returns a [StyleBox] from assigned [Theme] with given [code]name[/code] and associated with [Control] of given [code]type[/code].

Default Arguments

• type - ""

pub fn theme(&self) -> Option<Ref<Theme, Shared>>

Changing this property replaces the current [Theme] resource this node and all its [Control] children use.

pub fn get_tooltip(
    &self,
    at_position: Vector2D<f32, UnknownUnit>
) -> GodotString

Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip].

Default Arguments

• at_position - Vector2( 0, 0 )

pub fn v_grow_direction(&self) -> GrowDirection

Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

pub fn v_size_flags(&self) -> i64

Tells the parent [Container] nodes how they should resize and place the node on the Y axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

pub fn grab_click_focus(&self)

Creates an [InputEventMouseButton] that attempts to click the control. If the event is received, the control acquires focus.
				[codeblock]
				func _process(delta):
				    grab_click_focus() #when clicking another Control node, this node will be clicked instead
				[/codeblock]

pub fn grab_focus(&self)

Steal the focus from another control and become the focused control (see [member focus_mode]).

pub fn has_color(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [Color] with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].

Default Arguments

• type - ""

pub fn has_color_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if [Color] with given [code]name[/code] has a valid override in this [Control] node.

pub fn has_constant(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if constant with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].

Default Arguments

• type - ""

pub fn has_constant_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if constant with given [code]name[/code] has a valid override in this [Control] node.

pub fn has_focus(&self) -> bool

Returns [code]true[/code] if this is the current focused control. See [member focus_mode].

pub fn has_font(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if font with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].

Default Arguments

• type - ""

pub fn has_font_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if font with given [code]name[/code] has a valid override in this [Control] node.

pub fn has_icon(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if icon with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].

Default Arguments

• type - ""

pub fn has_icon_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if icon with given [code]name[/code] has a valid override in this [Control] node.

pub fn has_shader_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if [Shader] with given [code]name[/code] has a valid override in this [Control] node.

pub fn has_stylebox(
    &self,
    name: impl Into<GodotString>,
    _type: impl Into<GodotString>
) -> bool

Returns [code]true[/code] if [StyleBox] with given [code]name[/code] and associated with [Control] of given [code]type[/code] exists in assigned [Theme].

Default Arguments

• type - ""

pub fn has_stylebox_override(&self, name: impl Into<GodotString>) -> bool

Returns [code]true[/code] if [StyleBox] with given [code]name[/code] has a valid override in this [Control] node.

pub fn is_clipping_contents(&self) -> bool

Enables whether rendering of [CanvasItem] based children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered.

pub fn minimum_size_changed(&self)

Invalidates the size cache in this node and in parent nodes up to toplevel. Intended to be used with [method get_minimum_size] when the return value is changed. Setting [member rect_min_size] directly calls this method automatically.

pub fn release_focus(&self)

Give up the focus. No other control will be able to receive keyboard input.

pub fn set_anchor(
    &self,
    margin: i64,
    anchor: f64,
    keep_margin: bool,
    push_opposite_anchor: bool
)

Sets the anchor identified by [code]margin[/code] constant from [enum Margin] enum to value [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top].
				If [code]keep_margin[/code] is [code]true[/code], margins aren't updated after this operation.
				If [code]push_opposite_anchor[/code] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [code]push_opposite_anchor[/code] was [code]false[/code], the left anchor would get value 0.5.

Default Arguments

• keep_margin - false
• push_opposite_anchor - true

pub fn set_anchor_and_margin(
    &self,
    margin: i64,
    anchor: f64,
    offset: f64,
    push_opposite_anchor: bool
)

Works the same as [method set_anchor], but instead of [code]keep_margin[/code] argument and automatic update of margin, it allows to set the margin offset yourself (see [method set_margin]).

Default Arguments

• push_opposite_anchor - false

pub fn set_anchors_and_margins_preset(
    &self,
    preset: i64,
    resize_mode: i64,
    margin: i64
)

Sets both anchor preset and margin preset. See [method set_anchors_preset] and [method set_margins_preset].

Default Arguments

• resize_mode - 0
• margin - 0

pub fn set_anchors_preset(&self, preset: i64, keep_margins: bool)

Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is code equivalent of using the Layout menu in 2D editor.
				If [code]keep_margins[/code] is [code]true[/code], control's position will also be updated.

Default Arguments

• keep_margins - false

pub fn set_begin(&self, position: Vector2D<f32, UnknownUnit>)

Sets [member margin_left] and [member margin_top] at the same time. Equivalent of changing [member rect_position].

pub fn set_clip_contents(&self, enable: bool)

Enables whether rendering of [CanvasItem] based children should be clipped to this control's rectangle. If [code]true[/code], parts of a child which would be visibly outside of this control's rectangle will not be rendered.

pub fn set_custom_minimum_size(&self, size: Vector2D<f32, UnknownUnit>)

The minimum size of the node's bounding rectangle. If you set it to a value greater than (0, 0), the node's bounding rectangle will always have at least this size, even if its content is smaller. If it's set to (0, 0), the node sizes automatically to fit its content, be it a texture or child nodes.

pub fn set_default_cursor_shape(&self, shape: i64)

The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors.
			[b]Note:[/b] On Linux, shapes may vary depending on the cursor theme of the system.

pub fn set_drag_forwarding(&self, target: impl AsArg<Control>)

Forwards the handling of this control's drag and drop to [code]target[/code] control.
				Forwarding can be implemented in the target control similar to the methods [method get_drag_data], [method can_drop_data], and [method drop_data] but with two differences:
				1. The function name must be suffixed with [b]_fw[/b]
				2. The function must take an extra argument that is the control doing the forwarding
				[codeblock]
				# ThisControl.gd
				extends Control
				func _ready():
				    set_drag_forwarding(target_control)

				# TargetControl.gd
				extends Control
				func can_drop_data_fw(position, data, from_control):
				    return true

				func drop_data_fw(position, data, from_control):
				    my_handle_data(data)

				func get_drag_data_fw(position, from_control):
				    set_drag_preview(my_preview)
				    return my_data()
				[/codeblock]

pub fn set_drag_preview(&self, control: impl AsArg<Control>)

Shows the given control at the mouse pointer. A good time to call this method is in [method get_drag_data]. The control must not be in the scene tree.
				[codeblock]
				export (Color, RGBA) var color = Color(1, 0, 0, 1)

				func get_drag_data(position):
				    # Use a control that is not in the tree
				    var cpb = ColorPickerButton.new()
				    cpb.color = color
				    cpb.rect_size = Vector2(50, 50)
				    set_drag_preview(cpb)
				    return color
				[/codeblock]

pub fn set_end(&self, position: Vector2D<f32, UnknownUnit>)

Sets [member margin_right] and [member margin_bottom] at the same time.

pub fn set_focus_mode(&self, mode: i64)

The focus access mode for the control (None, Click or All). Only one Control can be focused at the same time, and it will receive keyboard signals.

pub fn set_focus_neighbour(&self, margin: i64, neighbour: impl Into<NodePath>)

Tells Godot which node it should give keyboard focus to if the user presses the top arrow on the keyboard or top on a gamepad by default. You can change the key by editing the [code]ui_top[/code] input action. The node must be a [Control]. If this property is not set, Godot will give focus to the closest [Control] to the bottom of this one.

pub fn set_focus_next(&self, next: impl Into<NodePath>)

Tells Godot which node it should give keyboard focus to if the user presses Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_next[/code] input action.
			If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.

pub fn set_focus_previous(&self, previous: impl Into<NodePath>)

Tells Godot which node it should give keyboard focus to if the user presses Shift+Tab on a keyboard by default. You can change the key by editing the [code]ui_focus_prev[/code] input action.
			If this property is not set, Godot will select a "best guess" based on surrounding nodes in the scene tree.

pub fn set_global_position(
    &self,
    position: Vector2D<f32, UnknownUnit>,
    keep_margins: bool
)

Sets the [member rect_global_position] to given [code]position[/code].
				If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins.

Default Arguments

• keep_margins - false

pub fn set_h_grow_direction(&self, direction: i64)

Controls the direction on the horizontal axis in which the control should grow if its horizontal minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

pub fn set_h_size_flags(&self, flags: i64)

Tells the parent [Container] nodes how they should resize and place the node on the X axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

pub fn set_margin(&self, margin: i64, offset: f64)

Distance between the node's top edge and its parent control, based on [member anchor_top].
			Margins are often controlled by one or multiple parent [Container] nodes, so you should not modify them manually if your node is a direct child of a [Container]. Margins update automatically when you move or resize the node.

pub fn set_margins_preset(&self, preset: i64, resize_mode: i64, margin: i64)

Sets the margins to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is code equivalent of using the Layout menu in 2D editor.
				Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code].
				Use parameter [code]margin[/code] to determine the gap between the [Control] and the edges.

Default Arguments

• resize_mode - 0
• margin - 0

pub fn set_mouse_filter(&self, filter: i64)

Controls whether the control will be able to receive mouse button input events through [method _gui_input] and how these events should be handled. Also controls whether the control can receive the [signal mouse_entered], and [signal mouse_exited] signals. See the constants to learn what each does.

pub fn set_pivot_offset(&self, pivot_offset: Vector2D<f32, UnknownUnit>)

By default, the node's pivot is its top-left corner. When you change its [member rect_scale], it will scale around this pivot. Set this property to [member rect_size] / 2 to center the pivot in the node's rectangle.

pub fn set_position(
    &self,
    position: Vector2D<f32, UnknownUnit>,
    keep_margins: bool
)

Sets the [member rect_position] to given [code]position[/code].
				If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins.

Default Arguments

• keep_margins - false

pub fn set_rotation(&self, radians: f64)

Sets the rotation (in radians).

pub fn set_rotation_degrees(&self, degrees: f64)

The node's rotation around its pivot, in degrees. See [member rect_pivot_offset] to change the pivot's position.

pub fn set_scale(&self, scale: Vector2D<f32, UnknownUnit>)

The node's scale, relative to its [member rect_size]. Change this property to scale the node around its [member rect_pivot_offset]. The Control's [member hint_tooltip] will also scale according to this value.
			[b]Note:[/b] This property is mainly intended to be used for animation purposes. Text inside the Control will look pixelated or blurry when the Control is scaled. To support multiple resolutions in your project, use an appropriate viewport stretch mode as described in the [url=https://docs.godotengine.org/en/latest/tutorials/viewports/multiple_resolutions.html]documentation[/url] instead of scaling Controls individually.
			[b]Note:[/b] If the Control node is a child of a [Container] node, the scale will be reset to [code]Vector2(1, 1)[/code] when the scene is instanced. To set the Control's scale when it's instanced, wait for one frame using [code]yield(get_tree(), "idle_frame")[/code] then set its [member rect_scale] property.

pub fn set_size(&self, size: Vector2D<f32, UnknownUnit>, keep_margins: bool)

Sets the size (see [member rect_size]).
				If [code]keep_margins[/code] is [code]true[/code], control's anchors will be updated instead of margins.

Default Arguments

• keep_margins - false

pub fn set_stretch_ratio(&self, ratio: f64)

If the node and at least one of its neighbours uses the [constant SIZE_EXPAND] size flag, the parent [Container] will let it take more or less space depending on this property. If this node has a stretch ratio of 2 and its neighbour a ratio of 1, this node will take two thirds of the available space.

pub fn set_theme(&self, theme: impl AsArg<Theme>)

Changing this property replaces the current [Theme] resource this node and all its [Control] children use.

pub fn set_tooltip(&self, tooltip: impl Into<GodotString>)

Changes the tooltip text. The tooltip appears when the user's mouse cursor stays idle over this control for a few moments, provided that the [member mouse_filter] property is not [constant MOUSE_FILTER_IGNORE]. You can change the time required for the tooltip to appear with [code]gui/timers/tooltip_delay_sec[/code] option in Project Settings.

pub fn set_v_grow_direction(&self, direction: i64)

Controls the direction on the vertical axis in which the control should grow if its vertical minimum size is changed to be greater than its current size, as the control always has to be at least the minimum size.

pub fn set_v_size_flags(&self, flags: i64)

Tells the parent [Container] nodes how they should resize and place the node on the Y axis. Use one of the [enum SizeFlags] constants to change the flags. See the constants to learn what each does.

pub fn show_modal(&self, exclusive: bool)

Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus.
				If [code]exclusive[/code] is [code]true[/code], other controls will not receive input and clicking outside this control will not close it.

Default Arguments

• exclusive - false

pub fn warp_mouse(&self, to_position: Vector2D<f32, UnknownUnit>)

Moves the mouse cursor to [code]to_position[/code], relative to [member rect_position] of this [Control].

Trait Implementations

impl Debug for RichTextLabel

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for RichTextLabel

type Target = Control

The resulting type after dereferencing.

fn deref(&self) -> &Control

Dereferences the value.

impl DerefMut for RichTextLabel

fn deref_mut(&mut self) -> &mut Control

Mutably dereferences the value.

impl GodotObject for RichTextLabel

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for RichTextLabel

fn construct() -> Ref<RichTextLabel, Unique>

impl QueueFree for RichTextLabel

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CanvasItem> for RichTextLabel

impl SubClass<Control> for RichTextLabel

impl SubClass<Node> for RichTextLabel

impl SubClass<Object> for RichTextLabel