diff options
Diffstat (limited to 'doc/classes/TextParagraph.xml')
| -rw-r--r-- | doc/classes/TextParagraph.xml | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml new file mode 100644 index 0000000000..aa35acdbd2 --- /dev/null +++ b/doc/classes/TextParagraph.xml @@ -0,0 +1,323 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextParagraph" inherits="RefCounted" version="4.0"> + <brief_description> + Holds a paragraph of text. + </brief_description> + <description> + Abstraction over [TextServer] for handling paragraph of text. + </description> + <tutorials> + </tutorials> + <methods> + <method name="add_object"> + <return type="bool" /> + <argument index="0" name="key" type="Variant" /> + <argument index="1" name="size" type="Vector2" /> + <argument index="2" name="inline_align" type="int" enum="InlineAlign" default="5" /> + <argument index="3" name="length" type="int" default="1" /> + <description> + Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. + </description> + </method> + <method name="add_string"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> + <argument index="1" name="fonts" type="Font" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="opentype_features" type="Dictionary" default="{ +}" /> + <argument index="4" name="language" type="String" default="""" /> + <description> + Adds text span and font to draw it. + </description> + </method> + <method name="clear"> + <return type="void" /> + <description> + Clears text paragraph (removes text and inline objects). + </description> + </method> + <method name="clear_dropcap"> + <return type="void" /> + <description> + Removes dropcap. + </description> + </method> + <method name="draw" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <argument index="3" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="draw_dropcap" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="draw_dropcap_outline" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="outline_size" type="int" default="1" /> + <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw drop cap outline into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="draw_line" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="line" type="int" /> + <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="draw_line_outline" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="line" type="int" /> + <argument index="3" name="outline_size" type="int" default="1" /> + <argument index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw outline of the single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="draw_outline" qualifiers="const"> + <return type="void" /> + <argument index="0" name="canvas" type="RID" /> + <argument index="1" name="pos" type="Vector2" /> + <argument index="2" name="outline_size" type="int" default="1" /> + <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <argument index="4" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <description> + Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + </description> + </method> + <method name="get_dropcap_lines" qualifiers="const"> + <return type="int" /> + <description> + Returns number of lines used by dropcap. + </description> + </method> + <method name="get_dropcap_rid" qualifiers="const"> + <return type="RID" /> + <description> + Return drop cap text buffer RID. + </description> + </method> + <method name="get_dropcap_size" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns drop cap bounding box size. + </description> + </method> + <method name="get_line_ascent" qualifiers="const"> + <return type="float" /> + <argument index="0" name="line" type="int" /> + <description> + Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). + </description> + </method> + <method name="get_line_count" qualifiers="const"> + <return type="int" /> + <description> + Returns number of lines in the paragraph. + </description> + </method> + <method name="get_line_descent" qualifiers="const"> + <return type="float" /> + <argument index="0" name="line" type="int" /> + <description> + Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). + </description> + </method> + <method name="get_line_object_rect" qualifiers="const"> + <return type="Rect2" /> + <argument index="0" name="line" type="int" /> + <argument index="1" name="key" type="Variant" /> + <description> + Returns bounding rectangle of the inline object. + </description> + </method> + <method name="get_line_objects" qualifiers="const"> + <return type="Array" /> + <argument index="0" name="line" type="int" /> + <description> + Returns array of inline objects in the line. + </description> + </method> + <method name="get_line_range" qualifiers="const"> + <return type="Vector2i" /> + <argument index="0" name="line" type="int" /> + <description> + Returns character range of the line. + </description> + </method> + <method name="get_line_rid" qualifiers="const"> + <return type="RID" /> + <argument index="0" name="line" type="int" /> + <description> + Returns TextServer line buffer RID. + </description> + </method> + <method name="get_line_size" qualifiers="const"> + <return type="Vector2" /> + <argument index="0" name="line" type="int" /> + <description> + Returns size of the bounding box of the line of text. + </description> + </method> + <method name="get_line_underline_position" qualifiers="const"> + <return type="float" /> + <argument index="0" name="line" type="int" /> + <description> + Returns pixel offset of the underline below the baseline. + </description> + </method> + <method name="get_line_underline_thickness" qualifiers="const"> + <return type="float" /> + <argument index="0" name="line" type="int" /> + <description> + Returns thickness of the underline. + </description> + </method> + <method name="get_line_width" qualifiers="const"> + <return type="float" /> + <argument index="0" name="line" type="int" /> + <description> + Returns width (for horizontal layout) or height (for vertical) of the line of text. + </description> + </method> + <method name="get_non_wraped_size" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the size of the bounding box of the paragraph, without line breaks. + </description> + </method> + <method name="get_rid" qualifiers="const"> + <return type="RID" /> + <description> + Returns TextServer full string buffer RID. + </description> + </method> + <method name="get_size" qualifiers="const"> + <return type="Vector2" /> + <description> + Returns the size of the bounding box of the paragraph. + </description> + </method> + <method name="get_spacing_bottom" qualifiers="const"> + <return type="int" /> + <description> + Returns extra spacing at the bottom of the line. See [member Font.spacing_bottom]. + </description> + </method> + <method name="get_spacing_top" qualifiers="const"> + <return type="int" /> + <description> + Returns extra spacing at the top of the line. See [member Font.spacing_top]. + </description> + </method> + <method name="hit_test" qualifiers="const"> + <return type="int" /> + <argument index="0" name="coords" type="Vector2" /> + <description> + Returns caret character offset at the specified coordinates. This function always returns a valid position. + </description> + </method> + <method name="resize_object"> + <return type="bool" /> + <argument index="0" name="key" type="Variant" /> + <argument index="1" name="size" type="Vector2" /> + <argument index="2" name="inline_align" type="int" enum="InlineAlign" default="5" /> + <description> + Sets new size and alignment of embedded object. + </description> + </method> + <method name="set_bidi_override"> + <return type="void" /> + <argument index="0" name="override" type="Array" /> + <description> + Overrides BiDi for the structured text. + Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. + </description> + </method> + <method name="set_dropcap"> + <return type="bool" /> + <argument index="0" name="text" type="String" /> + <argument index="1" name="fonts" type="Font" /> + <argument index="2" name="size" type="int" /> + <argument index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <argument index="4" name="opentype_features" type="Dictionary" default="{ +}" /> + <argument index="5" name="language" type="String" default="""" /> + <description> + Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. + </description> + </method> + <method name="tab_align"> + <return type="void" /> + <argument index="0" name="tab_stops" type="PackedFloat32Array" /> + <description> + Aligns paragraph to the given tab-stops. + </description> + </method> + </methods> + <members> + <member name="align" type="int" setter="set_align" getter="get_align" enum="HAlign" default="0"> + Paragraph horizontal alignment. + </member> + <member name="direction" type="int" setter="set_direction" getter="get_direction" enum="TextServer.Direction" default="0"> + Text writing direction. + </member> + <member name="flags" type="int" setter="set_flags" getter="get_flags" default="51"> + Line breaking and alignment rules. For more info see [TextServer]. + </member> + <member name="max_lines_visible" type="int" setter="set_max_lines_visible" getter="get_max_lines_visible" default="-1"> + Limits the lines of text shown. + </member> + <member name="orientation" type="int" setter="set_orientation" getter="get_orientation" enum="TextServer.Orientation" default="0"> + Text orientation. + </member> + <member name="preserve_control" type="bool" setter="set_preserve_control" getter="get_preserve_control" default="false"> + If set to [code]true[/code] text will display control characters. + </member> + <member name="preserve_invalid" type="bool" setter="set_preserve_invalid" getter="get_preserve_invalid" default="true"> + If set to [code]true[/code] text will display invalid characters. + </member> + <member name="text_overrun_behavior" type="int" setter="set_text_overrun_behavior" getter="get_text_overrun_behavior" enum="TextParagraph.OverrunBehavior" default="0"> + Sets the clipping behavior when the text exceeds the paragraph's set width. See [enum OverrunBehavior] for a description of all modes. + </member> + <member name="width" type="float" setter="set_width" getter="get_width" default="-1.0"> + Paragraph width. + </member> + </members> + <constants> + <constant name="OVERRUN_NO_TRIMMING" value="0" enum="OverrunBehavior"> + No text trimming is performed. + </constant> + <constant name="OVERRUN_TRIM_CHAR" value="1" enum="OverrunBehavior"> + Trims the text per character. + </constant> + <constant name="OVERRUN_TRIM_WORD" value="2" enum="OverrunBehavior"> + Trims the text per word. + </constant> + <constant name="OVERRUN_TRIM_ELLIPSIS" value="3" enum="OverrunBehavior"> + Trims the text per character and adds an ellipsis to indicate that parts are hidden. + </constant> + <constant name="OVERRUN_TRIM_WORD_ELLIPSIS" value="4" enum="OverrunBehavior"> + Trims the text per word and adds an ellipsis to indicate that parts are hidden. + </constant> + </constants> +</class> |