godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #96548 from timothyqiu/item-list-signals 

Improve documentation of some `ItemList` signals
This commit is contained in:
Rémi Verschelde 2024-09-27 13:53:22 +02:00
parent 83b2ca3107 76691afd94
commit 61fce325ca
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/classes/ItemList.xml
View File

@ -407,13 +407,14 @@
<param index="0" name="at_position" type="Vector2" /> <param index="0" name="at_position" type="Vector2" />
<param index="1" name="mouse_button_index" type="int" /> <param index="1" name="mouse_button_index" type="int" />
<description> <description>
Triggered when any mouse click is issued within the rect of the list but on empty space. Emitted when any mouse click is issued within the rect of the list but on empty space.
[param at_position] is the click position in this control's local coordinate system.
</description> </description>
</signal> </signal>
<signal name="item_activated"> <signal name="item_activated">
<param index="0" name="index" type="int" /> <param index="0" name="index" type="int" />
<description> <description>
Triggered when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. Emitted when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd].
</description> </description>
</signal> </signal>
<signal name="item_clicked"> <signal name="item_clicked">
@ -421,14 +422,14 @@
<param index="1" name="at_position" type="Vector2" /> <param index="1" name="at_position" type="Vector2" />
<param index="2" name="mouse_button_index" type="int" /> <param index="2" name="mouse_button_index" type="int" />
<description> <description>
Triggered when specified list item has been clicked with any mouse button. Emitted when specified list item has been clicked with any mouse button.
The click position is also provided to allow appropriate popup of context menus at the correct location. [param at_position] is the click position in this control's local coordinate system.
</description> </description>
</signal> </signal>
<signal name="item_selected"> <signal name="item_selected">
<param index="0" name="index" type="int" /> <param index="0" name="index" type="int" />
<description> <description>
Triggered when specified item has been selected. Emitted when specified item has been selected. Only applicable in single selection mode.
[member allow_reselect] must be enabled to reselect an item. [member allow_reselect] must be enabled to reselect an item.
</description> </description>
</signal> </signal>
@ -436,7 +437,7 @@
<param index="0" name="index" type="int" /> <param index="0" name="index" type="int" />
<param index="1" name="selected" type="bool" /> <param index="1" name="selected" type="bool" />
<description> <description>
Triggered when a multiple selection is altered on a list allowing multiple selection. Emitted when a multiple selection is altered on a list allowing multiple selection.
</description> </description>
</signal> </signal>
</signals> </signals>