Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option for ButtonGroups to be unpressed #76279

Merged
merged 1 commit into from
Apr 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/classes/ButtonGroup.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
</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>
Expand Down
13 changes: 12 additions & 1 deletion scene/gui/base_button.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ void BaseButton::_unpress_group() {
return;
}

if (toggle_mode) {
if (toggle_mode && !button_group->is_allow_unpress()) {
status.pressed = true;
}

Expand Down Expand Up @@ -537,9 +537,20 @@ BaseButton *ButtonGroup::get_pressed_button() {
return nullptr;
}

void ButtonGroup::set_allow_unpress(bool p_enabled) {
allow_unpress = p_enabled;
}
bool ButtonGroup::is_allow_unpress() {
return allow_unpress;
}

void ButtonGroup::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_pressed_button"), &ButtonGroup::get_pressed_button);
ClassDB::bind_method(D_METHOD("get_buttons"), &ButtonGroup::_get_buttons);
ClassDB::bind_method(D_METHOD("set_allow_unpress", "enabled"), &ButtonGroup::set_allow_unpress);
ClassDB::bind_method(D_METHOD("is_allow_unpress"), &ButtonGroup::is_allow_unpress);

ADD_PROPERTY(PropertyInfo(Variant::BOOL, "allow_unpress"), "set_allow_unpress", "is_allow_unpress");

ADD_SIGNAL(MethodInfo("pressed", PropertyInfo(Variant::OBJECT, "button", PROPERTY_HINT_RESOURCE_TYPE, "BaseButton")));
}
Expand Down
3 changes: 3 additions & 0 deletions scene/gui/base_button.h
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ class ButtonGroup : public Resource {
GDCLASS(ButtonGroup, Resource);
friend class BaseButton;
HashSet<BaseButton *> buttons;
bool allow_unpress = false;

protected:
static void _bind_methods();
Expand All @@ -160,6 +161,8 @@ class ButtonGroup : public Resource {
BaseButton *get_pressed_button();
void get_buttons(List<BaseButton *> *r_buttons);
TypedArray<BaseButton> _get_buttons();
void set_allow_unpress(bool p_enabled);
bool is_allow_unpress();
ButtonGroup();
};

Expand Down