mirror of
https://github.com/godotengine/godot
synced 2024-09-30 14:22:06 +00:00
d829b43ab5
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>
41 lines
1.6 KiB
XML
41 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="ButtonGroup" inherits="Resource" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Group of Buttons.
|
|
</brief_description>
|
|
<description>
|
|
Group of [BaseButton]. The members of this group are treated like radio buttons in the sense that only one button can be pressed at the same time. Some types of buttons (such as [CheckBox]) may have a special appearance for this state.
|
|
Every member of the ButtonGroup should have [member BaseButton.toggle_mode] set to [code]true[/code].
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="get_buttons">
|
|
<return type="BaseButton[]" />
|
|
<description>
|
|
Returns an [Array] of [Button]s who have this as their [ButtonGroup] (see [member BaseButton.button_group]).
|
|
</description>
|
|
</method>
|
|
<method name="get_pressed_button">
|
|
<return type="BaseButton" />
|
|
<description>
|
|
Returns the current pressed button.
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<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>
|
|
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="true" />
|
|
</members>
|
|
<signals>
|
|
<signal name="pressed">
|
|
<param index="0" name="button" type="BaseButton" />
|
|
<description>
|
|
Emitted when one of the buttons of the group is pressed.
|
|
</description>
|
|
</signal>
|
|
</signals>
|
|
</class>
|