9ddebc0c22
For this to work safely (user not call queue_free or something in the expression), a const call mode was added to Object and Variant (and optionally Script). This mode ensures only const functions can be called, making it safe to use from the editor. Co-Authored-By: reduz <reduzio@gmail.com>
334 lines
11 KiB
C++
334 lines
11 KiB
C++
/*************************************************************************/
|
|
/* spin_box.cpp */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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. */
|
|
/*************************************************************************/
|
|
|
|
#include "spin_box.h"
|
|
|
|
#include "core/input/input.h"
|
|
#include "core/math/expression.h"
|
|
|
|
Size2 SpinBox::get_minimum_size() const {
|
|
Size2 ms = line_edit->get_combined_minimum_size();
|
|
ms.width += last_w;
|
|
return ms;
|
|
}
|
|
|
|
void SpinBox::_value_changed(double p_value) {
|
|
String value = TS->format_number(String::num(get_value(), Math::range_step_decimals(get_step())));
|
|
if (!prefix.is_empty()) {
|
|
value = prefix + " " + value;
|
|
}
|
|
if (!suffix.is_empty()) {
|
|
value += " " + suffix;
|
|
}
|
|
line_edit->set_text(value);
|
|
Range::_value_changed(p_value);
|
|
}
|
|
|
|
void SpinBox::_text_submitted(const String &p_string) {
|
|
Ref<Expression> expr;
|
|
expr.instantiate();
|
|
|
|
String num = TS->parse_number(p_string);
|
|
// Ignore the prefix and suffix in the expression
|
|
Error err = expr->parse(num.trim_prefix(prefix + " ").trim_suffix(" " + suffix));
|
|
if (err != OK) {
|
|
return;
|
|
}
|
|
|
|
Variant value = expr->execute(Array(), nullptr, false, true);
|
|
if (value.get_type() != Variant::NIL) {
|
|
set_value(value);
|
|
}
|
|
_value_changed(0);
|
|
}
|
|
|
|
void SpinBox::_text_changed(const String &p_string) {
|
|
int cursor_pos = line_edit->get_caret_column();
|
|
|
|
_text_submitted(p_string);
|
|
|
|
// Line edit 'set_text' method resets the cursor position so we need to undo that.
|
|
line_edit->set_caret_column(cursor_pos);
|
|
}
|
|
|
|
LineEdit *SpinBox::get_line_edit() {
|
|
return line_edit;
|
|
}
|
|
|
|
void SpinBox::_line_edit_input(const Ref<InputEvent> &p_event) {
|
|
}
|
|
|
|
void SpinBox::_range_click_timeout() {
|
|
if (!drag.enabled && Input::get_singleton()->is_mouse_button_pressed(MouseButton::LEFT)) {
|
|
bool up = get_local_mouse_position().y < (get_size().height / 2);
|
|
set_value(get_value() + (up ? get_step() : -get_step()));
|
|
|
|
if (range_click_timer->is_one_shot()) {
|
|
range_click_timer->set_wait_time(0.075);
|
|
range_click_timer->set_one_shot(false);
|
|
range_click_timer->start();
|
|
}
|
|
|
|
} else {
|
|
range_click_timer->stop();
|
|
}
|
|
}
|
|
|
|
void SpinBox::_release_mouse() {
|
|
if (drag.enabled) {
|
|
drag.enabled = false;
|
|
Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_VISIBLE);
|
|
warp_mouse(drag.capture_pos);
|
|
}
|
|
}
|
|
|
|
void SpinBox::gui_input(const Ref<InputEvent> &p_event) {
|
|
ERR_FAIL_COND(p_event.is_null());
|
|
|
|
if (!is_editable()) {
|
|
return;
|
|
}
|
|
|
|
Ref<InputEventMouseButton> mb = p_event;
|
|
|
|
if (mb.is_valid() && mb->is_pressed()) {
|
|
bool up = mb->get_position().y < (get_size().height / 2);
|
|
|
|
switch (mb->get_button_index()) {
|
|
case MouseButton::LEFT: {
|
|
line_edit->grab_focus();
|
|
|
|
set_value(get_value() + (up ? get_step() : -get_step()));
|
|
|
|
range_click_timer->set_wait_time(0.6);
|
|
range_click_timer->set_one_shot(true);
|
|
range_click_timer->start();
|
|
|
|
drag.allowed = true;
|
|
drag.capture_pos = mb->get_position();
|
|
} break;
|
|
case MouseButton::RIGHT: {
|
|
line_edit->grab_focus();
|
|
set_value((up ? get_max() : get_min()));
|
|
} break;
|
|
case MouseButton::WHEEL_UP: {
|
|
if (line_edit->has_focus()) {
|
|
set_value(get_value() + get_step() * mb->get_factor());
|
|
accept_event();
|
|
}
|
|
} break;
|
|
case MouseButton::WHEEL_DOWN: {
|
|
if (line_edit->has_focus()) {
|
|
set_value(get_value() - get_step() * mb->get_factor());
|
|
accept_event();
|
|
}
|
|
} break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (mb.is_valid() && !mb->is_pressed() && mb->get_button_index() == MouseButton::LEFT) {
|
|
//set_default_cursor_shape(CURSOR_ARROW);
|
|
range_click_timer->stop();
|
|
_release_mouse();
|
|
drag.allowed = false;
|
|
}
|
|
|
|
Ref<InputEventMouseMotion> mm = p_event;
|
|
|
|
if (mm.is_valid() && (mm->get_button_mask() & MouseButton::MASK_LEFT) != MouseButton::NONE) {
|
|
if (drag.enabled) {
|
|
drag.diff_y += mm->get_relative().y;
|
|
float diff_y = -0.01 * Math::pow(ABS(drag.diff_y), 1.8f) * SIGN(drag.diff_y);
|
|
set_value(CLAMP(drag.base_val + get_step() * diff_y, get_min(), get_max()));
|
|
} else if (drag.allowed && drag.capture_pos.distance_to(mm->get_position()) > 2) {
|
|
Input::get_singleton()->set_mouse_mode(Input::MOUSE_MODE_CAPTURED);
|
|
drag.enabled = true;
|
|
drag.base_val = get_value();
|
|
drag.diff_y = 0;
|
|
}
|
|
}
|
|
}
|
|
|
|
void SpinBox::_line_edit_focus_exit() {
|
|
// discontinue because the focus_exit was caused by right-click context menu
|
|
if (line_edit->is_menu_visible()) {
|
|
return;
|
|
}
|
|
|
|
_text_submitted(line_edit->get_text());
|
|
}
|
|
|
|
inline void SpinBox::_adjust_width_for_icon(const Ref<Texture2D> &icon) {
|
|
int w = icon->get_width();
|
|
if ((w != last_w)) {
|
|
line_edit->set_offset(SIDE_LEFT, 0);
|
|
line_edit->set_offset(SIDE_RIGHT, -w);
|
|
last_w = w;
|
|
}
|
|
}
|
|
|
|
void SpinBox::_notification(int p_what) {
|
|
switch (p_what) {
|
|
case NOTIFICATION_DRAW: {
|
|
Ref<Texture2D> updown = get_theme_icon(SNAME("updown"));
|
|
|
|
_adjust_width_for_icon(updown);
|
|
|
|
RID ci = get_canvas_item();
|
|
Size2i size = get_size();
|
|
|
|
if (is_layout_rtl()) {
|
|
updown->draw(ci, Point2i(0, (size.height - updown->get_height()) / 2));
|
|
} else {
|
|
updown->draw(ci, Point2i(size.width - updown->get_width(), (size.height - updown->get_height()) / 2));
|
|
}
|
|
} break;
|
|
|
|
case NOTIFICATION_ENTER_TREE: {
|
|
_adjust_width_for_icon(get_theme_icon(SNAME("updown")));
|
|
_value_changed(0);
|
|
} break;
|
|
|
|
case NOTIFICATION_EXIT_TREE: {
|
|
_release_mouse();
|
|
} break;
|
|
|
|
case NOTIFICATION_TRANSLATION_CHANGED: {
|
|
_value_changed(0);
|
|
update();
|
|
} break;
|
|
|
|
case NOTIFICATION_THEME_CHANGED: {
|
|
call_deferred(SNAME("update_minimum_size"));
|
|
get_line_edit()->call_deferred(SNAME("update_minimum_size"));
|
|
} break;
|
|
|
|
case NOTIFICATION_LAYOUT_DIRECTION_CHANGED: {
|
|
update();
|
|
} break;
|
|
}
|
|
}
|
|
|
|
void SpinBox::set_horizontal_alignment(HorizontalAlignment p_alignment) {
|
|
line_edit->set_horizontal_alignment(p_alignment);
|
|
}
|
|
|
|
HorizontalAlignment SpinBox::get_horizontal_alignment() const {
|
|
return line_edit->get_horizontal_alignment();
|
|
}
|
|
|
|
void SpinBox::set_suffix(const String &p_suffix) {
|
|
suffix = p_suffix;
|
|
_value_changed(0);
|
|
}
|
|
|
|
String SpinBox::get_suffix() const {
|
|
return suffix;
|
|
}
|
|
|
|
void SpinBox::set_prefix(const String &p_prefix) {
|
|
prefix = p_prefix;
|
|
_value_changed(0);
|
|
}
|
|
|
|
String SpinBox::get_prefix() const {
|
|
return prefix;
|
|
}
|
|
|
|
void SpinBox::set_update_on_text_changed(bool p_enabled) {
|
|
if (update_on_text_changed == p_enabled) {
|
|
return;
|
|
}
|
|
|
|
update_on_text_changed = p_enabled;
|
|
|
|
if (p_enabled) {
|
|
line_edit->connect("text_changed", callable_mp(this, &SpinBox::_text_changed), Vector<Variant>(), CONNECT_DEFERRED);
|
|
} else {
|
|
line_edit->disconnect("text_changed", callable_mp(this, &SpinBox::_text_changed));
|
|
}
|
|
}
|
|
|
|
bool SpinBox::get_update_on_text_changed() const {
|
|
return update_on_text_changed;
|
|
}
|
|
|
|
void SpinBox::set_editable(bool p_enabled) {
|
|
line_edit->set_editable(p_enabled);
|
|
}
|
|
|
|
bool SpinBox::is_editable() const {
|
|
return line_edit->is_editable();
|
|
}
|
|
|
|
void SpinBox::apply() {
|
|
_text_submitted(line_edit->get_text());
|
|
}
|
|
|
|
void SpinBox::_bind_methods() {
|
|
ClassDB::bind_method(D_METHOD("set_horizontal_alignment", "alignment"), &SpinBox::set_horizontal_alignment);
|
|
ClassDB::bind_method(D_METHOD("get_horizontal_alignment"), &SpinBox::get_horizontal_alignment);
|
|
ClassDB::bind_method(D_METHOD("set_suffix", "suffix"), &SpinBox::set_suffix);
|
|
ClassDB::bind_method(D_METHOD("get_suffix"), &SpinBox::get_suffix);
|
|
ClassDB::bind_method(D_METHOD("set_prefix", "prefix"), &SpinBox::set_prefix);
|
|
ClassDB::bind_method(D_METHOD("get_prefix"), &SpinBox::get_prefix);
|
|
ClassDB::bind_method(D_METHOD("set_editable", "enabled"), &SpinBox::set_editable);
|
|
ClassDB::bind_method(D_METHOD("is_editable"), &SpinBox::is_editable);
|
|
ClassDB::bind_method(D_METHOD("set_update_on_text_changed", "enabled"), &SpinBox::set_update_on_text_changed);
|
|
ClassDB::bind_method(D_METHOD("get_update_on_text_changed"), &SpinBox::get_update_on_text_changed);
|
|
ClassDB::bind_method(D_METHOD("apply"), &SpinBox::apply);
|
|
ClassDB::bind_method(D_METHOD("get_line_edit"), &SpinBox::get_line_edit);
|
|
|
|
ADD_PROPERTY(PropertyInfo(Variant::INT, "alignment", PROPERTY_HINT_ENUM, "Left,Center,Right,Fill"), "set_horizontal_alignment", "get_horizontal_alignment");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "editable"), "set_editable", "is_editable");
|
|
ADD_PROPERTY(PropertyInfo(Variant::BOOL, "update_on_text_changed"), "set_update_on_text_changed", "get_update_on_text_changed");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "prefix"), "set_prefix", "get_prefix");
|
|
ADD_PROPERTY(PropertyInfo(Variant::STRING, "suffix"), "set_suffix", "get_suffix");
|
|
}
|
|
|
|
SpinBox::SpinBox() {
|
|
line_edit = memnew(LineEdit);
|
|
add_child(line_edit, false, INTERNAL_MODE_FRONT);
|
|
|
|
line_edit->set_anchors_and_offsets_preset(Control::PRESET_WIDE);
|
|
line_edit->set_mouse_filter(MOUSE_FILTER_PASS);
|
|
line_edit->set_horizontal_alignment(HORIZONTAL_ALIGNMENT_LEFT);
|
|
|
|
line_edit->connect("text_submitted", callable_mp(this, &SpinBox::_text_submitted), Vector<Variant>(), CONNECT_DEFERRED);
|
|
line_edit->connect("focus_exited", callable_mp(this, &SpinBox::_line_edit_focus_exit), Vector<Variant>(), CONNECT_DEFERRED);
|
|
line_edit->connect("gui_input", callable_mp(this, &SpinBox::_line_edit_input));
|
|
|
|
range_click_timer = memnew(Timer);
|
|
range_click_timer->connect("timeout", callable_mp(this, &SpinBox::_range_click_timeout));
|
|
add_child(range_click_timer, false, INTERNAL_MODE_FRONT);
|
|
}
|