2023-01-05 13:25:55 +01:00
|
|
|
/**************************************************************************/
|
|
|
|
/* spin_box.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. */
|
|
|
|
/**************************************************************************/
|
2018-01-05 00:50:27 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifndef SPIN_BOX_H
|
|
|
|
#define SPIN_BOX_H
|
|
|
|
|
|
|
|
#include "scene/gui/line_edit.h"
|
|
|
|
#include "scene/gui/range.h"
|
2015-12-08 19:04:56 +01:00
|
|
|
#include "scene/main/timer.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
class SpinBox : public Range {
|
2017-03-05 16:44:50 +01:00
|
|
|
GDCLASS(SpinBox, Range);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
LineEdit *line_edit = nullptr;
|
2020-04-27 12:24:27 +02:00
|
|
|
bool update_on_text_changed = false;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2024-03-04 02:07:15 +01:00
|
|
|
struct SizingCache {
|
|
|
|
int buttons_block_width = 0;
|
|
|
|
int buttons_width = 0;
|
|
|
|
int buttons_vertical_separation = 0;
|
|
|
|
int buttons_left = 0;
|
|
|
|
int button_up_height = 0;
|
|
|
|
int button_down_height = 0;
|
|
|
|
int second_button_top = 0;
|
|
|
|
int buttons_separator_top = 0;
|
|
|
|
int field_and_buttons_separator_left = 0;
|
|
|
|
int field_and_buttons_separator_width = 0;
|
|
|
|
} sizing_cache;
|
|
|
|
|
2022-04-04 15:06:57 +02:00
|
|
|
Timer *range_click_timer = nullptr;
|
2015-12-08 19:04:56 +01:00
|
|
|
void _range_click_timeout();
|
2024-03-04 02:07:15 +01:00
|
|
|
void _release_mouse_from_drag_mode();
|
2015-12-08 19:04:56 +01:00
|
|
|
|
2023-10-08 14:03:08 +02:00
|
|
|
void _update_text(bool p_keep_line_edit = false);
|
2021-06-16 18:43:34 +02:00
|
|
|
void _text_submitted(const String &p_string);
|
2020-04-27 12:24:27 +02:00
|
|
|
void _text_changed(const String &p_string);
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
String prefix;
|
|
|
|
String suffix;
|
2023-10-08 14:03:08 +02:00
|
|
|
String last_updated_text;
|
2019-11-15 16:04:34 +01:00
|
|
|
double custom_arrow_step = 0.0;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-05-20 17:38:03 +02:00
|
|
|
void _line_edit_input(const Ref<InputEvent> &p_event);
|
2015-08-29 06:43:21 +02:00
|
|
|
|
|
|
|
struct Drag {
|
2022-07-15 01:33:00 +02:00
|
|
|
double base_val = 0.0;
|
2021-01-15 06:42:15 +01:00
|
|
|
bool allowed = false;
|
|
|
|
bool enabled = false;
|
2015-08-29 06:43:21 +02:00
|
|
|
Vector2 capture_pos;
|
2022-07-15 01:33:00 +02:00
|
|
|
double diff_y = 0.0;
|
2015-08-29 06:43:21 +02:00
|
|
|
} drag;
|
|
|
|
|
2024-03-04 02:07:15 +01:00
|
|
|
struct StateCache {
|
|
|
|
bool up_button_hovered = false;
|
|
|
|
bool up_button_pressed = false;
|
|
|
|
bool up_button_disabled = false;
|
|
|
|
bool down_button_hovered = false;
|
|
|
|
bool down_button_pressed = false;
|
|
|
|
bool down_button_disabled = false;
|
|
|
|
} state_cache;
|
|
|
|
|
2022-08-17 13:27:19 +02:00
|
|
|
void _line_edit_focus_enter();
|
2014-02-10 02:10:30 +01:00
|
|
|
void _line_edit_focus_exit();
|
|
|
|
|
2024-03-04 02:07:15 +01:00
|
|
|
inline void _compute_sizes();
|
|
|
|
inline int _get_widest_button_icon_width();
|
2018-02-05 22:42:30 +01:00
|
|
|
|
2022-08-31 14:02:40 +02:00
|
|
|
struct ThemeCache {
|
|
|
|
Ref<Texture2D> updown_icon;
|
2024-03-04 02:07:15 +01:00
|
|
|
Ref<Texture2D> up_icon;
|
|
|
|
Ref<Texture2D> up_hover_icon;
|
|
|
|
Ref<Texture2D> up_pressed_icon;
|
|
|
|
Ref<Texture2D> up_disabled_icon;
|
|
|
|
Ref<Texture2D> down_icon;
|
|
|
|
Ref<Texture2D> down_hover_icon;
|
|
|
|
Ref<Texture2D> down_pressed_icon;
|
|
|
|
Ref<Texture2D> down_disabled_icon;
|
|
|
|
|
|
|
|
Ref<StyleBox> up_base_stylebox;
|
|
|
|
Ref<StyleBox> up_hover_stylebox;
|
|
|
|
Ref<StyleBox> up_pressed_stylebox;
|
|
|
|
Ref<StyleBox> up_disabled_stylebox;
|
|
|
|
Ref<StyleBox> down_base_stylebox;
|
|
|
|
Ref<StyleBox> down_hover_stylebox;
|
|
|
|
Ref<StyleBox> down_pressed_stylebox;
|
|
|
|
Ref<StyleBox> down_disabled_stylebox;
|
|
|
|
|
|
|
|
Color up_icon_modulate;
|
|
|
|
Color up_hover_icon_modulate;
|
|
|
|
Color up_pressed_icon_modulate;
|
|
|
|
Color up_disabled_icon_modulate;
|
|
|
|
Color down_icon_modulate;
|
|
|
|
Color down_hover_icon_modulate;
|
|
|
|
Color down_pressed_icon_modulate;
|
|
|
|
Color down_disabled_icon_modulate;
|
|
|
|
|
|
|
|
Ref<StyleBox> field_and_buttons_separator;
|
|
|
|
Ref<StyleBox> up_down_buttons_separator;
|
|
|
|
|
|
|
|
int buttons_vertical_separation = 0;
|
|
|
|
int field_and_buttons_separation = 0;
|
|
|
|
int buttons_width = 0;
|
|
|
|
int set_min_buttons_width_from_icons = 0;
|
|
|
|
|
2022-08-31 14:02:40 +02:00
|
|
|
} theme_cache;
|
|
|
|
|
2024-03-04 02:07:15 +01:00
|
|
|
void _mouse_exited();
|
|
|
|
void _update_buttons_state_for_current_value();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
protected:
|
2021-08-22 17:37:22 +02:00
|
|
|
virtual void gui_input(const Ref<InputEvent> &p_event) override;
|
2024-03-04 02:07:15 +01:00
|
|
|
void _value_changed(double p_value) override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
void _notification(int p_what);
|
|
|
|
static void _bind_methods();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
public:
|
2014-02-10 02:10:30 +01:00
|
|
|
LineEdit *get_line_edit();
|
|
|
|
|
2020-07-10 12:34:39 +02:00
|
|
|
virtual Size2 get_minimum_size() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-11-25 03:58:47 +01:00
|
|
|
void set_horizontal_alignment(HorizontalAlignment p_alignment);
|
|
|
|
HorizontalAlignment get_horizontal_alignment() const;
|
2018-08-25 05:17:07 +02:00
|
|
|
|
2021-10-08 23:26:13 +02:00
|
|
|
void set_editable(bool p_enabled);
|
2014-02-10 02:10:30 +01:00
|
|
|
bool is_editable() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_suffix(const String &p_suffix);
|
2014-02-10 02:10:30 +01:00
|
|
|
String get_suffix() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_prefix(const String &p_prefix);
|
2014-02-10 02:10:30 +01:00
|
|
|
String get_prefix() const;
|
|
|
|
|
2021-10-08 23:26:13 +02:00
|
|
|
void set_update_on_text_changed(bool p_enabled);
|
2020-04-27 12:24:27 +02:00
|
|
|
bool get_update_on_text_changed() const;
|
|
|
|
|
2022-10-16 14:37:35 +02:00
|
|
|
void set_select_all_on_focus(bool p_enabled);
|
|
|
|
bool is_select_all_on_focus() const;
|
|
|
|
|
2020-01-09 14:44:23 +01:00
|
|
|
void apply();
|
2019-11-15 16:04:34 +01:00
|
|
|
void set_custom_arrow_step(const double p_custom_arrow_step);
|
|
|
|
double get_custom_arrow_step() const;
|
2020-01-09 14:44:23 +01:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
SpinBox();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif // SPIN_BOX_H
|