Struct TextParagraph

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

Expand description

Godot class TextParagraph.

Inherits RefCounted.

Related symbols:

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

§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: 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: GString, font: impl AsObjectArg, 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: GString, font: impl AsObjectArg, font_size: i32, ) -> ExSetDropcap<'a>

pub fn clear_dropcap(&mut self)

pub fn add_string( &mut self, text: GString, font: impl AsObjectArg, 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: GString, font: impl AsObjectArg, font_size: i32, ) -> ExAddString<'a>

pub fn add_object<'a>(&mut self, key: &'a 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<'a>(&mut self, key: &'a 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: 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: GString) -> bool

pub fn set(&mut self, property: StringName, value: &Variant)

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

pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)

pub fn get_indexed(&self, property_path: 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: StringName) -> bool

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

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

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: &Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: 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: StringName) -> ExGetMeta<'a>

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

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

pub fn add_user_signal(&mut self, signal: 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: GString, ) -> ExAddUserSignal<'a>

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

pub fn remove_user_signal(&mut self, signal: StringName)

pub fn emit_signal(&mut self, signal: 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: 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: 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: 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: 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: 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: StringName, value: &Variant)

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

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

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

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

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

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

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

pub fn connect(&mut self, signal: 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: StringName, callable: Callable, ) -> ExConnect<'a>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: 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: 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: StringName) -> ExTr<'a>

pub fn tr_n( &self, message: StringName, plural_message: 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: StringName, plural_message: StringName, 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.