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

Clarified usage of TreeItem get_next*() and get_prev*() functions.

Browse source
This commit is contained in:
Derwent Ready (drentsoft) 2020-10-11 00:14:17 +01:00 committed by Rémi Verschelde
parent 2b6dadd46b
commit df5a922880
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/TreeItem.xml
View file

@ -223,14 +223,14 @@
<method name="get_next" qualifiers="const">
<return type="TreeItem" />
<description>
Returns the next TreeItem in the tree or a null object if there is none.
Returns the next sibling TreeItem in the tree or a null object if there is none.
</description>
</method>
<method name="get_next_visible">
<return type="TreeItem" />
<argument index="0" name="wrap" type="bool" default="false" />
<description>
Returns the next visible TreeItem in the tree or a null object if there is none.
Returns the next visible sibling TreeItem in the tree or a null object if there is none.
If [code]wrap[/code] is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns [code]null[/code].
</description>
</method>
@ -243,14 +243,14 @@
<method name="get_prev">
<return type="TreeItem" />
<description>
Returns the previous TreeItem in the tree or a null object if there is none.
Returns the previous sibling TreeItem in the tree or a null object if there is none.
</description>
</method>
<method name="get_prev_visible">
<return type="TreeItem" />
<argument index="0" name="wrap" type="bool" default="false" />
<description>
Returns the previous visible TreeItem in the tree or a null object if there is none.
Returns the previous visible sibling TreeItem in the tree or a null object if there is none.
If [code]wrap[/code] is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns [code]null[/code].
</description>
</method>