Struct TextParagraph

#[repr(C)]
pub struct TextParagraph { /* private fields */ }

Godot class TextParagraph.

Inherits RefCounted.

Related symbols:

• text_paragraph: sidecar module with related enum/flag types
• ITextParagraph: virtual methods

See also Godot docs for TextParagraph.

Construction

This class is reference-counted. You can create a new instance using TextParagraph::new_gd().

Implementations

impl TextParagraph

pub fn clear(&mut self)

pub fn set_direction(&mut self, direction: Direction)

pub fn get_direction(&self) -> Direction

pub fn set_custom_punctuation( &mut self, custom_punctuation: impl AsArg<GString>, )

pub fn get_custom_punctuation(&self) -> GString

pub fn set_orientation(&mut self, orientation: Orientation)

pub fn get_orientation(&self) -> Orientation

pub fn set_preserve_invalid(&mut self, enabled: bool)

pub fn get_preserve_invalid(&self) -> bool

pub fn set_preserve_control(&mut self, enabled: bool)

pub fn get_preserve_control(&self) -> bool

pub fn set_bidi_override(&mut self, override_: &Array<Variant>)

pub fn set_dropcap( &mut self, text: impl AsArg<GString>, font: impl AsObjectArg<Font>, font_size: i32, ) -> bool

To set the default parameters, use Self::set_dropcap_ex and its builder methods. See the book for detailed usage instructions.

pub fn set_dropcap_ex<'a>( &'a mut self, text: impl AsArg<GString> + 'a, font: impl AsObjectArg<Font>, font_size: i32, ) -> ExSetDropcap<'a>

pub fn clear_dropcap(&mut self)

pub fn add_string( &mut self, text: impl AsArg<GString>, font: impl AsObjectArg<Font>, font_size: i32, ) -> bool

To set the default parameters, use Self::add_string_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_string_ex<'a>( &'a mut self, text: impl AsArg<GString> + 'a, font: impl AsObjectArg<Font>, font_size: i32, ) -> ExAddString<'a>

pub fn add_object(&mut self, key: &Variant, size: Vector2) -> bool

To set the default parameters, use Self::add_object_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_object_ex<'a>( &'a mut self, key: &'a Variant, size: Vector2, ) -> ExAddObject<'a>

pub fn resize_object(&mut self, key: &Variant, size: Vector2) -> bool

To set the default parameters, use Self::resize_object_ex and its builder methods. See the book for detailed usage instructions.

pub fn resize_object_ex<'a>( &'a mut self, key: &'a Variant, size: Vector2, ) -> ExResizeObject<'a>

pub fn set_alignment(&mut self, alignment: HorizontalAlignment)

pub fn get_alignment(&self) -> HorizontalAlignment

pub fn tab_align(&mut self, tab_stops: &PackedFloat32Array)

pub fn set_break_flags(&mut self, flags: LineBreakFlag)

pub fn get_break_flags(&self) -> LineBreakFlag

pub fn set_justification_flags(&mut self, flags: JustificationFlag)

pub fn get_justification_flags(&self) -> JustificationFlag

pub fn set_text_overrun_behavior(&mut self, overrun_behavior: OverrunBehavior)

pub fn get_text_overrun_behavior(&self) -> OverrunBehavior

pub fn set_ellipsis_char(&mut self, char: impl AsArg<GString>)

pub fn get_ellipsis_char(&self) -> GString

pub fn set_width(&mut self, width: f32)

pub fn get_width(&self) -> f32

pub fn get_non_wrapped_size(&self) -> Vector2

pub fn get_size(&self) -> Vector2

pub fn get_rid(&self) -> Rid

pub fn get_line_rid(&self, line: i32) -> Rid

pub fn get_dropcap_rid(&self) -> Rid

pub fn get_line_count(&self) -> i32

pub fn set_max_lines_visible(&mut self, max_lines_visible: i32)

pub fn get_max_lines_visible(&self) -> i32

pub fn get_line_objects(&self, line: i32) -> Array<Variant>

pub fn get_line_object_rect(&self, line: i32, key: &Variant) -> Rect2

pub fn get_line_size(&self, line: i32) -> Vector2

pub fn get_line_range(&self, line: i32) -> Vector2i

pub fn get_line_ascent(&self, line: i32) -> f32

pub fn get_line_descent(&self, line: i32) -> f32

pub fn get_line_width(&self, line: i32) -> f32

pub fn get_line_underline_position(&self, line: i32) -> f32

pub fn get_line_underline_thickness(&self, line: i32) -> f32

pub fn get_dropcap_size(&self) -> Vector2

pub fn get_dropcap_lines(&self) -> i32

pub fn draw(&self, canvas: Rid, pos: Vector2)

To set the default parameters, use Self::draw_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_ex<'a>(&'a self, canvas: Rid, pos: Vector2) -> ExDraw<'a>

pub fn draw_outline(&self, canvas: Rid, pos: Vector2)

To set the default parameters, use Self::draw_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_outline_ex<'a>( &'a self, canvas: Rid, pos: Vector2, ) -> ExDrawOutline<'a>

pub fn draw_line(&self, canvas: Rid, pos: Vector2, line: i32)

To set the default parameters, use Self::draw_line_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_line_ex<'a>( &'a self, canvas: Rid, pos: Vector2, line: i32, ) -> ExDrawLine<'a>

pub fn draw_line_outline(&self, canvas: Rid, pos: Vector2, line: i32)

To set the default parameters, use Self::draw_line_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_line_outline_ex<'a>( &'a self, canvas: Rid, pos: Vector2, line: i32, ) -> ExDrawLineOutline<'a>

pub fn draw_dropcap(&self, canvas: Rid, pos: Vector2)

To set the default parameters, use Self::draw_dropcap_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_dropcap_ex<'a>( &'a self, canvas: Rid, pos: Vector2, ) -> ExDrawDropcap<'a>

pub fn draw_dropcap_outline(&self, canvas: Rid, pos: Vector2)

To set the default parameters, use Self::draw_dropcap_outline_ex and its builder methods. See the book for detailed usage instructions.

pub fn draw_dropcap_outline_ex<'a>( &'a self, canvas: Rid, pos: Vector2, ) -> ExDrawDropcapOutline<'a>

pub fn hit_test(&self, coords: Vector2) -> i32

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: impl AsArg<GString>) -> bool

pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)

pub fn get(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )

pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool

pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant

pub fn set_script(&mut self, script: &Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)

pub fn remove_meta(&mut self, name: impl AsArg<StringName>)

pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant

To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.

pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>

pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)

To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.

pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>

pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)

pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )

pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant

pub fn has_method(&self, method: impl AsArg<StringName>) -> bool

pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32

pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )

pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: impl AsArg<StringName>) -> GString

To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>

pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString

To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.

pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for TextParagraph

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for TextParagraph

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

Formats the value using the given formatter.

impl Deref for TextParagraph

type Target = RefCounted

The resulting type after dereferencing.

fn deref(&self) -> &<TextParagraph as Deref>::Target

Dereferences the value.

impl DerefMut for TextParagraph

fn deref_mut(&mut self) -> &mut <TextParagraph as Deref>::Target

Mutably dereferences the value.

impl GodotClass for TextParagraph

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = RefCounted

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for TextParagraph

impl Inherits<Object> for TextParagraph

impl Inherits<RefCounted> for TextParagraph