godot/scene/gui/base_button.h

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

164 lines
5.3 KiB
C++
Raw Normal View History

/**************************************************************************/
/* base_button.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef BASE_BUTTON_H
#define BASE_BUTTON_H
#include "core/input/shortcut.h"
2014-02-10 01:10:30 +00:00
#include "scene/gui/control.h"
class ButtonGroup;
class BaseButton : public Control {
GDCLASS(BaseButton, Control);
public:
enum ActionMode {
ACTION_MODE_BUTTON_PRESS,
ACTION_MODE_BUTTON_RELEASE,
};
private:
2023-01-09 09:14:51 +00:00
BitField<MouseButtonMask> button_mask = MouseButtonMask::LEFT;
bool toggle_mode = false;
bool shortcut_in_tooltip = true;
bool was_mouse_pressed = false;
bool keep_pressed_outside = false;
Ref<Shortcut> shortcut;
ObjectID shortcut_context;
bool shortcut_feedback = true;
2016-03-08 23:00:52 +00:00
ActionMode action_mode = ACTION_MODE_BUTTON_RELEASE;
2014-02-10 01:10:30 +00:00
struct Status {
bool pressed = false;
bool hovering = false;
bool press_attempt = false;
bool pressing_inside = false;
bool shortcut_press = false;
2014-02-10 01:10:30 +00:00
bool disabled = false;
2014-02-10 01:10:30 +00:00
} status;
2016-03-08 23:00:52 +00:00
Ref<ButtonGroup> button_group;
2014-02-10 01:10:30 +00:00
void _unpress_group();
void _pressed();
void _toggled(bool p_pressed);
void on_action_event(Ref<InputEvent> p_event);
2014-02-10 01:10:30 +00:00
protected:
virtual void pressed();
virtual void toggled(bool p_pressed);
static void _bind_methods();
virtual void gui_input(const Ref<InputEvent> &p_event) override;
virtual void shortcut_input(const Ref<InputEvent> &p_event) override;
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
bool _was_pressed_by_mouse() const;
GDVIRTUAL0(_pressed)
GDVIRTUAL1(_toggled, bool)
2014-02-10 01:10:30 +00:00
public:
enum DrawMode {
DRAW_NORMAL,
DRAW_PRESSED,
DRAW_HOVER,
DRAW_DISABLED,
DRAW_HOVER_PRESSED,
};
DrawMode get_draw_mode() const;
2014-02-10 01:10:30 +00:00
/* Signals */
2016-03-08 23:00:52 +00:00
bool is_pressed() const; ///< return whether button is pressed (toggled in)
bool is_pressing() const; ///< return whether button is pressed (toggled in)
bool is_hovered() const;
void set_pressed(bool p_pressed); // Only works in toggle mode.
void set_pressed_no_signal(bool p_pressed);
2014-02-10 01:10:30 +00:00
void set_toggle_mode(bool p_on);
bool is_toggle_mode() const;
2016-03-08 23:00:52 +00:00
void set_shortcut_in_tooltip(bool p_on);
bool is_shortcut_in_tooltip_enabled() const;
2014-02-10 01:10:30 +00:00
void set_disabled(bool p_disabled);
bool is_disabled() const;
void set_action_mode(ActionMode p_mode);
ActionMode get_action_mode() const;
2014-02-10 01:10:30 +00:00
void set_keep_pressed_outside(bool p_on);
bool is_keep_pressed_outside() const;
void set_button_mask(BitField<MouseButtonMask> p_mask);
BitField<MouseButtonMask> get_button_mask() const;
void set_shortcut(const Ref<Shortcut> &p_shortcut);
Ref<Shortcut> get_shortcut() const;
2020-07-10 10:34:39 +00:00
virtual String get_tooltip(const Point2 &p_pos) const override;
2014-02-10 01:10:30 +00:00
void set_button_group(const Ref<ButtonGroup> &p_group);
Ref<ButtonGroup> get_button_group() const;
void set_shortcut_feedback(bool p_feedback);
bool is_shortcut_feedback() const;
PackedStringArray get_configuration_warnings() const override;
2016-03-08 23:00:52 +00:00
BaseButton();
2014-02-10 01:10:30 +00:00
~BaseButton();
};
VARIANT_ENUM_CAST(BaseButton::DrawMode)
VARIANT_ENUM_CAST(BaseButton::ActionMode)
class ButtonGroup : public Resource {
GDCLASS(ButtonGroup, Resource);
friend class BaseButton;
HashSet<BaseButton *> buttons;
protected:
static void _bind_methods();
public:
BaseButton *get_pressed_button();
void get_buttons(List<BaseButton *> *r_buttons);
TypedArray<BaseButton> _get_buttons();
ButtonGroup();
};
#endif // BASE_BUTTON_H