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

Clarify TreeItem return values

Browse source
This commit is contained in:
TheDuriel 2020-07-20 14:38:34 +02:00
parent 639252d0f8
commit 0ff1ca4655
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/classes/TreeItem.xml
View file

@ -118,7 +118,7 @@
<return type="TreeItem"> <return type="TreeItem">
</return> </return>
<description> <description>
Returns the TreeItem's child items. Returns the TreeItem's first child item or a null object if there is none.
</description> </description>
</method> </method>
<method name="get_custom_bg_color" qualifiers="const"> <method name="get_custom_bg_color" qualifiers="const">
@ -196,7 +196,7 @@
<return type="TreeItem"> <return type="TreeItem">
</return> </return>
<description> <description>
Returns the next TreeItem in the tree. Returns the next TreeItem in the tree or a null object if there is none.
</description> </description>
</method> </method>
<method name="get_next_visible"> <method name="get_next_visible">
@ -205,7 +205,7 @@
<argument index="0" name="wrap" type="bool" default="false"> <argument index="0" name="wrap" type="bool" default="false">
</argument> </argument>
<description> <description>
Returns the next visible TreeItem in the tree. Returns the next visible 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]. 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> </description>
</method> </method>
@ -213,14 +213,14 @@
<return type="TreeItem"> <return type="TreeItem">
</return> </return>
<description> <description>
Returns the parent TreeItem. Returns the parent TreeItem or a null object if there is none.
</description> </description>
</method> </method>
<method name="get_prev"> <method name="get_prev">
<return type="TreeItem"> <return type="TreeItem">
</return> </return>
<description> <description>
Returns the previous TreeItem in the tree. Returns the previous TreeItem in the tree or a null object if there is none.
</description> </description>
</method> </method>
<method name="get_prev_visible"> <method name="get_prev_visible">
@ -229,7 +229,7 @@
<argument index="0" name="wrap" type="bool" default="false"> <argument index="0" name="wrap" type="bool" default="false">
</argument> </argument>
<description> <description>
Returns the previous visible TreeItem in the tree. Returns the previous visible 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]. 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> </description>
</method> </method>