asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: Clarify expected type of Object * parameters in Tree methods

Browse source 
They're meant to be `TreeItem *` but this can't be bound in Variant.

Fixes #20538.

(cherry picked from commit 81f2ce4e46)
This commit is contained in:
Rémi Verschelde 2022-01-25 00:54:21 +01:00
parent 4f1f76c7ce
commit 2eb12f1d71
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/Tree.xml
View file

@ -32,7 +32,7 @@
<argument index="0" name="parent" type="Object" default="null" />
<argument index="1" name="idx" type="int" default="-1" />
<description>
Creates an item in the tree and adds it as a child of [code]parent[/code].
Creates an item in the tree and adds it as a child of [code]parent[/code], which can be either a valid [TreeItem] or [code]null[/code].
If [code]parent[/code] is [code]null[/code], the root item will be the parent, or the new item will be the root itself if the tree is empty.
The new item will be the [code]idx[/code]th child of parent, or it will be the last child if there are not enough siblings.
</description>
@ -111,7 +111,7 @@
<argument index="0" name="item" type="Object" />
<argument index="1" name="column" type="int" default="-1" />
<description>
Returns the rectangle area for the specified item. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
Returns the rectangle area for the specified [TreeItem]. If [code]column[/code] is specified, only get the position and size of that column, otherwise get the rectangle containing all columns.
</description>
</method>
<method name="get_item_at_position" qualifiers="const">
@ -125,7 +125,7 @@
<return type="TreeItem" />
<argument index="0" name="from" type="Object" />
<description>
Returns the next selected item after the given one, or [code]null[/code] if the end is reached.
Returns the next selected [TreeItem] after the given one, or [code]null[/code] if the end is reached.
If [code]from[/code] is [code]null[/code], this returns the first selected item.
</description>
</method>
@ -167,7 +167,7 @@
<return type="void" />
<argument index="0" name="item" type="Object" />
<description>
Causes the [Tree] to jump to the specified item.
Causes the [Tree] to jump to the specified [TreeItem].
</description>
</method>
<method name="set_column_expand">