godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ButtonGroup.xml

38 lines
1.3 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 13:18:53 +00:00
<class name="ButtonGroup" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Group of Buttons.
</brief_description>
<description>
Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed.
Mention about BaseButton.toggle_mode in ButtonGroup description
2018-02-21 06:53:30 +00:00
[member BaseButton.toggle_mode] should be [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
Expose ButtonGroup's "get_buttons()" to GDScript
2018-12-14 05:39:31 +00:00
<method name="get_buttons">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Array" />
Expose ButtonGroup's "get_buttons()" to GDScript
2018-12-14 05:39:31 +00:00
<description>
Rename button group property to button_group
2020-10-24 05:19:18 +00:00
Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.button_group]).
Expose ButtonGroup's "get_buttons()" to GDScript
2018-12-14 05:39:31 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_pressed_button">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="BaseButton" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Expose ButtonGroup's "get_buttons()" to GDScript
2018-12-14 05:39:31 +00:00
Returns the current pressed button.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
<members>
Make overridden properties link to parent definition Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-02 19:38:49 +00:00
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />
Run doctool after overridden properties changes
2019-09-03 10:44:58 +00:00
</members>
Adds a pressed signal to ButtonGroup
2021-05-06 10:16:27 +00:00
<signals>
<signal name="pressed">
Improve some signal bindings to use specific `Object` subtypes
2022-01-28 14:35:25 +00:00
<argument index="0" name="button" type="BaseButton" />
Adds a pressed signal to ButtonGroup
2021-05-06 10:16:27 +00:00
<description>
Emitted when one of the buttons of the group is pressed.
</description>
</signal>
</signals>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</class>