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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

41 lines
1.7 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" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="ButtonGroup" inherits="Resource" 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>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A group of buttons that doesn't allow more than one button to be pressed at a time.
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>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A group of [BaseButton]-derived buttons. The buttons in a [ButtonGroup] are treated like radio buttons: No more than one button can be pressed at a time. Some types of buttons (such as [CheckBox]) may have a special appearance in this state.
Every member of a [ButtonGroup] should have [member BaseButton.toggle_mode] set to [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">
Replace Array return types with TypedArray
2022-08-05 01:41:48 +00:00
<return type="BaseButton[]" />
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>
Add option for ButtonGroups to be unpressed Add an option for ButtonGroups to be unpressed Apply suggestions from code review Co-Authored-By: Tomek <kobewi4e@gmail.com> Co-Authored-By: Yuri Rubinsky <chaosus89@gmail.com> Co-Authored-By: kleonc <9283098+kleonc@users.noreply.github.com>
2023-04-20 02:37:52 +00:00
<member name="allow_unpress" type="bool" setter="set_allow_unpress" getter="is_allow_unpress" default="false">
If [code]true[/code], it is possible to unpress all buttons in this [ButtonGroup].
</member>
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">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>