mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
6e73aa0497
godot/doc/classes/TextLine.xml

189 lines
7.6 KiB
XML
Raw Normal View History

[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Rename Reference to RefCounted
2021-06-05 00:03:15 +08:00
<class name="TextLine" inherits="RefCounted" version="4.0">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<brief_description>
Holds a line of text.
</brief_description>
<description>
Abstraction over [TextServer] for handling single line of text.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="key" type="Variant" />
<argument index="1" name="size" type="Vector2" />
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 10:58:47 +08:00
<argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" />
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<argument index="3" name="length" type="int" default="1" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="text" type="String" />
<argument index="1" name="fonts" type="Font" />
<argument index="2" name="size" type="int" />
Dictionary: Serialize empty dict as `{}` instead of `{\n}` Also make sure to always convert multiline dictionaries to a single line for its EditorHelp representation, as multiline values break formatting.
2022-01-18 18:31:15 +08:00
<argument index="3" name="opentype_features" type="Dictionary" default="{}" />
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<argument index="4" name="language" type="String" default="&quot;&quot;" />
[TextServer] Add function to change font, font size, and OpenType features without invalidating line break points, justification points, or recreating shaped text buffer.
2022-01-20 15:30:42 +08:00
<argument index="5" name="meta" type="Variant" default="null" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Adds text span and font to draw it.
</description>
</method>
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Clears text line (removes text and inline objects).
</description>
</method>
<method name="draw" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<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)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Draw 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">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<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)" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Draw 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="get_line_ascent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
</description>
</method>
<method name="get_line_descent" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
</description>
</method>
<method name="get_line_underline_position" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns pixel offset of the underline below the baseline.
</description>
</method>
<method name="get_line_underline_thickness" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns thickness of the underline.
</description>
</method>
<method name="get_line_width" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns width (for horizontal layout) or height (for vertical) of the text.
</description>
</method>
<method name="get_object_rect" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Rect2" />
<argument index="0" name="key" type="Variant" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns bounding rectangle of the inline object.
</description>
</method>
<method name="get_objects" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns array of inline objects.
</description>
</method>
<method name="get_rid" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="RID" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns TextServer buffer RID.
</description>
</method>
<method name="get_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Vector2" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns size of the bounding box of the text.
</description>
</method>
<method name="hit_test" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
<argument index="0" name="coords" type="float" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
</description>
</method>
<method name="resize_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
<argument index="0" name="key" type="Variant" />
<argument index="1" name="size" type="Vector2" />
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 10:58:47 +08:00
<argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Sets new size and alignment of embedded object.
</description>
</method>
<method name="set_bidi_override">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="override" type="Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<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="tab_align">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
<argument index="0" name="tab_stops" type="PackedFloat32Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Aligns text to the given tab-stops.
</description>
</method>
</methods>
<members>
align to horizontal_alignment, valign to vertical_alignment, related
2021-11-25 10:58:47 +08:00
<member name="alignment" type="int" setter="set_horizontal_alignment" getter="get_horizontal_alignment" enum="HorizontalAlignment" default="0">
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</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="3">
Line Alignment rules. For more info see [TextServer].
</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>
Various text layout improvements (TextLine, TextParagraph, Label, TextServer)
2021-08-11 06:09:48 +08:00
<member name="text_overrun_behavior" type="int" setter="set_text_overrun_behavior" getter="get_text_overrun_behavior" enum="TextLine.OverrunBehavior" default="3">
Sets the clipping behavior when the text exceeds the text line's set width. See [enum OverrunBehavior] for a description of all modes.
</member>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<member name="width" type="float" setter="set_width" getter="get_width" default="-1.0">
Text line width.
</member>
</members>
<constants>
Various text layout improvements (TextLine, TextParagraph, Label, TextServer)
2021-08-11 06:09:48 +08:00
<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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</constants>
</class>
Reference in New Issue Copy Permalink