summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorbruvzg <7645683+bruvzg@users.noreply.github.com>2021-06-14 10:11:37 +0300
committerbruvzg <7645683+bruvzg@users.noreply.github.com>2021-08-08 22:35:47 +0300
commit7c3c5603d0a3208d6bee186f50857b15a02419d6 (patch)
tree8cb3e7dba7f9218988dcd02f31a21adf83c630f5 /doc
parente010e05b3dd842ba86a68dee60e0d7be6f9aae50 (diff)
[Text Server] Improve object (image/table) inline alignment.
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/@GlobalScope.xml30
-rw-r--r--doc/classes/RichTextLabel.xml4
-rw-r--r--doc/classes/TextLine.xml4
-rw-r--r--doc/classes/TextParagraph.xml4
-rw-r--r--doc/classes/TextServer.xml4
5 files changed, 38 insertions, 8 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml
index c86812742c..7edcf6da82 100644
--- a/doc/classes/@GlobalScope.xml
+++ b/doc/classes/@GlobalScope.xml
@@ -1128,6 +1128,36 @@
<constant name="VALIGN_BOTTOM" value="2" enum="VAlign">
Vertical bottom alignment, usually for text-derived classes.
</constant>
+ <constant name="INLINE_ALIGN_TOP_TO" value="0" enum="InlineAlign">
+ Aligns the top of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGN_TO_*[/code] constant.
+ </constant>
+ <constant name="INLINE_ALIGN_CENTER_TO" value="1" enum="InlineAlign">
+ Aligns the center of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGN_TO_*[/code] constant.
+ </constant>
+ <constant name="INLINE_ALIGN_BOTTOM_TO" value="2" enum="InlineAlign">
+ Aligns the bottom of the inline object (e.g. image, table) to the position of the text specified by [code]INLINE_ALIGN_TO_*[/code] constant.
+ </constant>
+ <constant name="INLINE_ALIGN_TO_TOP" value="0" enum="InlineAlign">
+ Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGN_*_TO[/code] constant to the top of the text.
+ </constant>
+ <constant name="INLINE_ALIGN_TO_CENTER" value="4" enum="InlineAlign">
+ Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGN_*_TO[/code] constant to the center of the text.
+ </constant>
+ <constant name="INLINE_ALIGN_TO_BASELINE" value="8" enum="InlineAlign">
+ Aligns the position of the inline object (e.g. image, table) specified by [code]INLINE_ALIGN_*_TO[/code] constant to the baseline of the text.
+ </constant>
+ <constant name="INLINE_ALIGN_TO_BOTTOM" value="12" enum="InlineAlign">
+ Aligns inline object (e.g. image, table) to the bottom of the text.
+ </constant>
+ <constant name="INLINE_ALIGN_TOP" value="0" enum="InlineAlign">
+ Aligns top of the inline object (e.g. image, table) to the top of the text. Equvalent to [code]INLINE_ALIGN_TOP_TO | INLINE_ALIGN_TO_TOP[/code].
+ </constant>
+ <constant name="INLINE_ALIGN_CENTER" value="5" enum="InlineAlign">
+ Aligns center of the inline object (e.g. image, table) to the center of the text. Equvalent to [code]INLINE_ALIGN_CENTER_TO | INLINE_ALIGN_TO_CENTER[/code].
+ </constant>
+ <constant name="INLINE_ALIGN_BOTTOM" value="14" enum="InlineAlign">
+ Aligns bottom of the inline object (e.g. image, table) to the bottom of the text. Equvalent to [code]INLINE_ALIGN_BOTTOM_TO | INLINE_ALIGN_TO_BOTTOM[/code].
+ </constant>
<constant name="SPKEY" value="16777216">
Keycodes with this bit applied are non-printable.
</constant>
diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml
index 538e93d505..7bbcc5e0b5 100644
--- a/doc/classes/RichTextLabel.xml
+++ b/doc/classes/RichTextLabel.xml
@@ -21,7 +21,7 @@
<argument index="1" name="width" type="int" default="0" />
<argument index="2" name="height" type="int" default="0" />
<argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" />
- <argument index="4" name="inline_align" type="int" enum="VAlign" default="0" />
+ <argument index="4" name="inline_align" type="int" enum="InlineAlign" default="5" />
<description>
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 and a [code]color[/code] to tint 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.
@@ -288,7 +288,7 @@
<method name="push_table">
<return type="void" />
<argument index="0" name="columns" type="int" />
- <argument index="1" name="inline_align" type="int" enum="VAlign" default="0" />
+ <argument index="1" name="inline_align" type="int" enum="InlineAlign" default="0" />
<description>
Adds a [code][table=columns,inline_align][/code] tag to the tag stack.
</description>
diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml
index cc66f56d65..daa7298418 100644
--- a/doc/classes/TextLine.xml
+++ b/doc/classes/TextLine.xml
@@ -13,7 +13,7 @@
<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="VAlign" default="1" />
+ <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.
@@ -122,7 +122,7 @@
<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="VAlign" default="1" />
+ <argument index="2" name="inline_align" type="int" enum="InlineAlign" default="5" />
<description>
Sets new size and alignment of embedded object.
</description>
diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml
index 9050f9246a..811fe32eb2 100644
--- a/doc/classes/TextParagraph.xml
+++ b/doc/classes/TextParagraph.xml
@@ -13,7 +13,7 @@
<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="VAlign" default="1" />
+ <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.
@@ -240,7 +240,7 @@
<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="VAlign" default="1" />
+ <argument index="2" name="inline_align" type="int" enum="InlineAlign" default="5" />
<description>
Sets new size and alignment of embedded object.
</description>
diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml
index dbf7ae93aa..ac56be4392 100644
--- a/doc/classes/TextServer.xml
+++ b/doc/classes/TextServer.xml
@@ -541,7 +541,7 @@
<argument index="0" name="shaped" type="RID" />
<argument index="1" name="key" type="Variant" />
<argument index="2" name="size" type="Vector2" />
- <argument index="3" name="inline_align" type="int" enum="VAlign" default="1" />
+ <argument index="3" name="inline_align" type="int" enum="InlineAlign" default="5" />
<argument index="4" 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.
@@ -817,7 +817,7 @@
<argument index="0" name="shaped" type="RID" />
<argument index="1" name="key" type="Variant" />
<argument index="2" name="size" type="Vector2" />
- <argument index="3" name="inline_align" type="int" enum="VAlign" default="1" />
+ <argument index="3" name="inline_align" type="int" enum="InlineAlign" default="5" />
<description>
Sets new size and alignment of embedded object.
</description>