diff options
| author | Kevin Fischer <46539626+Phischermen@users.noreply.github.com> | 2021-09-17 08:50:24 -0700 |
|---|---|---|
| committer | Kevin Fischer <46539626+Phischermen@users.noreply.github.com> | 2022-01-18 19:21:59 -0800 |
| commit | a4bac268c9cfedd6faba83a85ec52884a07e72d5 (patch) | |
| tree | c587c8d913b024a764498f903868e05e64b366e0 /doc | |
| parent | deefce7bb53afcf77c79732af74f1856210a8cc6 (diff) | |
Addded methods to propagate checks & refactored classes to use new methods.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Tree.xml | 7 | ||||
| -rw-r--r-- | doc/classes/TreeItem.xml | 8 |
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 10bbdc0301..c80e823d51 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -357,6 +357,13 @@ Emitted when a cell is selected. </description> </signal> + <signal name="check_propagated_to_item"> + <argument index="0" name="item" type="TreeItem" /> + <argument index="1" name="column" type="int" /> + <description> + Emitted when [method TreeItem.propagate_check] is called. Connect to this signal to process the items that are affected when [method TreeItem.propagate_check] is invoked. The order that the items affected will be processed is as follows: the item that invoked the method, children of that item, and finally parents of that item. + </description> + </signal> <signal name="column_title_pressed"> <argument index="0" name="column" type="int" /> <description> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 7da98788bb..0090fb555f 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -385,6 +385,14 @@ [b]Note:[/b] You can't move to the root or move the root. </description> </method> + <method name="propagate_check"> + <return type="void" /> + <argument index="0" name="column" type="int" /> + <argument index="1" name="emit_signal" type="bool" default="true" /> + <description> + Propagates this item's checked status to its children and parents for the given [code]column[/code]. It is possible to process the items affected by this method call by connecting to [signal Tree.check_propagated_to_item]. The order that the items affected will be processed is as follows: the item invoking this method, children of that item, and finally parents of that item. If [code]emit_signal[/code] is set to false, then [signal Tree.check_propagated_to_item] will not be emitted. + </description> + </method> <method name="remove_child"> <return type="void" /> <argument index="0" name="child" type="Object" /> |