49714b0963
This removes hardcoded actions from things like LineEdit and TextEdit. Previously, things like copy, paste, etc were all hardcoded to Ctrl+C, Ctrl+V, etc. They could not be changed. This allows the possibility of them being changed, by making them use the action map. This has the added benefit of greatly simplifying the input handling logic in those controls. The logic which was previously in a huge and hard to follow switch statement has been extracted to individual methods.
329 lines
9.3 KiB
C++
329 lines
9.3 KiB
C++
/*************************************************************************/
|
|
/* line_edit.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 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. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef LINE_EDIT_H
|
|
#define LINE_EDIT_H
|
|
|
|
#include "scene/gui/control.h"
|
|
#include "scene/gui/popup_menu.h"
|
|
|
|
class LineEdit : public Control {
|
|
GDCLASS(LineEdit, Control);
|
|
|
|
public:
|
|
enum Align {
|
|
ALIGN_LEFT,
|
|
ALIGN_CENTER,
|
|
ALIGN_RIGHT,
|
|
ALIGN_FILL
|
|
};
|
|
|
|
enum MenuItems {
|
|
MENU_CUT,
|
|
MENU_COPY,
|
|
MENU_PASTE,
|
|
MENU_CLEAR,
|
|
MENU_SELECT_ALL,
|
|
MENU_UNDO,
|
|
MENU_REDO,
|
|
MENU_DIR_INHERITED,
|
|
MENU_DIR_AUTO,
|
|
MENU_DIR_LTR,
|
|
MENU_DIR_RTL,
|
|
MENU_DISPLAY_UCC,
|
|
MENU_INSERT_LRM,
|
|
MENU_INSERT_RLM,
|
|
MENU_INSERT_LRE,
|
|
MENU_INSERT_RLE,
|
|
MENU_INSERT_LRO,
|
|
MENU_INSERT_RLO,
|
|
MENU_INSERT_PDF,
|
|
MENU_INSERT_ALM,
|
|
MENU_INSERT_LRI,
|
|
MENU_INSERT_RLI,
|
|
MENU_INSERT_FSI,
|
|
MENU_INSERT_PDI,
|
|
MENU_INSERT_ZWJ,
|
|
MENU_INSERT_ZWNJ,
|
|
MENU_INSERT_WJ,
|
|
MENU_INSERT_SHY,
|
|
MENU_MAX
|
|
};
|
|
|
|
private:
|
|
Align align = ALIGN_LEFT;
|
|
|
|
bool editable = false;
|
|
bool pass = false;
|
|
bool text_changed_dirty = false;
|
|
|
|
String undo_text;
|
|
String text;
|
|
String placeholder;
|
|
String placeholder_translated;
|
|
String secret_character = "*";
|
|
float placeholder_alpha = 0.6;
|
|
String ime_text;
|
|
Point2 ime_selection;
|
|
|
|
RID text_rid;
|
|
float full_width = 0.0;
|
|
|
|
bool selecting_enabled = true;
|
|
|
|
bool context_menu_enabled = true;
|
|
PopupMenu *menu = nullptr;
|
|
PopupMenu *menu_dir = nullptr;
|
|
PopupMenu *menu_ctl = nullptr;
|
|
|
|
bool mid_grapheme_caret_enabled = false;
|
|
|
|
int cursor_pos = 0;
|
|
int scroll_offset = 0;
|
|
int max_length = 0; // 0 for no maximum.
|
|
|
|
Dictionary opentype_features;
|
|
String language;
|
|
TextDirection text_direction = TEXT_DIRECTION_AUTO;
|
|
TextDirection input_direction = TEXT_DIRECTION_LTR;
|
|
Control::StructuredTextParser st_parser = STRUCTURED_TEXT_DEFAULT;
|
|
Array st_args;
|
|
bool draw_control_chars = false;
|
|
|
|
bool expand_to_text_length = false;
|
|
bool window_has_focus = true;
|
|
|
|
bool clear_button_enabled = false;
|
|
|
|
bool shortcut_keys_enabled = true;
|
|
|
|
bool virtual_keyboard_enabled = true;
|
|
|
|
Ref<Texture2D> right_icon;
|
|
|
|
struct Selection {
|
|
int begin = 0;
|
|
int end = 0;
|
|
int cursor_start = 0;
|
|
bool enabled = false;
|
|
bool creating = false;
|
|
bool doubleclick = false;
|
|
bool drag_attempt = false;
|
|
} selection;
|
|
|
|
struct TextOperation {
|
|
int cursor_pos = 0;
|
|
int scroll_offset = 0;
|
|
int cached_width = 0;
|
|
String text;
|
|
};
|
|
List<TextOperation> undo_stack;
|
|
List<TextOperation>::Element *undo_stack_pos = nullptr;
|
|
|
|
struct ClearButtonStatus {
|
|
bool press_attempt = false;
|
|
bool pressing_inside = false;
|
|
} clear_button_status;
|
|
|
|
bool caret_blink_enabled = false;
|
|
bool caret_force_displayed = false;
|
|
bool draw_caret = true;
|
|
Timer *caret_blink_timer = nullptr;
|
|
|
|
bool _is_over_clear_button(const Point2 &p_pos) const;
|
|
|
|
void _clear_undo_stack();
|
|
void _clear_redo();
|
|
void _create_undo_state();
|
|
|
|
int _get_menu_action_accelerator(const String &p_action);
|
|
void _generate_context_menu();
|
|
|
|
void _shape();
|
|
void _fit_to_width();
|
|
void _text_changed();
|
|
void _emit_text_change();
|
|
|
|
void shift_selection_check_pre(bool);
|
|
void shift_selection_check_post(bool);
|
|
|
|
void selection_fill_at_cursor();
|
|
void set_scroll_offset(int p_pos);
|
|
int get_scroll_offset() const;
|
|
|
|
void set_cursor_at_pixel_pos(int p_x);
|
|
Vector2i get_cursor_pixel_pos();
|
|
|
|
void _reset_caret_blink_timer();
|
|
void _toggle_draw_caret();
|
|
|
|
void clear_internal();
|
|
void changed_internal();
|
|
|
|
void _editor_settings_changed();
|
|
|
|
void _swap_current_input_direction();
|
|
void _move_cursor_left(bool p_select, bool p_move_by_word = false);
|
|
void _move_cursor_right(bool p_select, bool p_move_by_word = false);
|
|
void _move_cursor_start(bool p_select);
|
|
void _move_cursor_end(bool p_select);
|
|
void _backspace(bool p_word = false, bool p_all_to_left = false);
|
|
void _delete(bool p_word = false, bool p_all_to_right = false);
|
|
|
|
void _gui_input(Ref<InputEvent> p_event);
|
|
void _notification(int p_what);
|
|
|
|
protected:
|
|
static void _bind_methods();
|
|
|
|
bool _set(const StringName &p_name, const Variant &p_value);
|
|
bool _get(const StringName &p_name, Variant &r_ret) const;
|
|
void _get_property_list(List<PropertyInfo> *p_list) const;
|
|
|
|
public:
|
|
void set_align(Align p_align);
|
|
Align get_align() const;
|
|
|
|
virtual Variant get_drag_data(const Point2 &p_point) override;
|
|
virtual bool can_drop_data(const Point2 &p_point, const Variant &p_data) const override;
|
|
virtual void drop_data(const Point2 &p_point, const Variant &p_data) override;
|
|
|
|
virtual CursorShape get_cursor_shape(const Point2 &p_pos) const override;
|
|
|
|
void menu_option(int p_option);
|
|
void set_context_menu_enabled(bool p_enable);
|
|
bool is_context_menu_enabled();
|
|
PopupMenu *get_menu() const;
|
|
|
|
void select(int p_from = 0, int p_to = -1);
|
|
void select_all();
|
|
void selection_delete();
|
|
void deselect();
|
|
|
|
void delete_char();
|
|
void delete_text(int p_from_column, int p_to_column);
|
|
|
|
void set_text(String p_text);
|
|
String get_text() const;
|
|
|
|
void set_text_direction(TextDirection p_text_direction);
|
|
TextDirection get_text_direction() const;
|
|
|
|
void set_opentype_feature(const String &p_name, int p_value);
|
|
int get_opentype_feature(const String &p_name) const;
|
|
void clear_opentype_features();
|
|
|
|
void set_language(const String &p_language);
|
|
String get_language() const;
|
|
|
|
void set_draw_control_chars(bool p_draw_control_chars);
|
|
bool get_draw_control_chars() const;
|
|
|
|
void set_structured_text_bidi_override(Control::StructuredTextParser p_parser);
|
|
Control::StructuredTextParser get_structured_text_bidi_override() const;
|
|
|
|
void set_structured_text_bidi_override_options(Array p_args);
|
|
Array get_structured_text_bidi_override_options() const;
|
|
|
|
void set_placeholder(String p_text);
|
|
String get_placeholder() const;
|
|
|
|
void set_placeholder_alpha(float p_alpha);
|
|
float get_placeholder_alpha() const;
|
|
|
|
void set_cursor_position(int p_pos);
|
|
int get_cursor_position() const;
|
|
|
|
void set_max_length(int p_max_length);
|
|
int get_max_length() const;
|
|
|
|
void append_at_cursor(String p_text);
|
|
void clear();
|
|
|
|
void set_mid_grapheme_caret_enabled(const bool p_enabled);
|
|
bool get_mid_grapheme_caret_enabled() const;
|
|
|
|
bool cursor_get_blink_enabled() const;
|
|
void cursor_set_blink_enabled(const bool p_enabled);
|
|
|
|
float cursor_get_blink_speed() const;
|
|
void cursor_set_blink_speed(const float p_speed);
|
|
|
|
bool cursor_get_force_displayed() const;
|
|
void cursor_set_force_displayed(const bool p_enabled);
|
|
|
|
void copy_text();
|
|
void cut_text();
|
|
void paste_text();
|
|
void undo();
|
|
void redo();
|
|
|
|
void set_editable(bool p_editable);
|
|
bool is_editable() const;
|
|
|
|
void set_secret(bool p_secret);
|
|
bool is_secret() const;
|
|
|
|
void set_secret_character(const String &p_string);
|
|
String get_secret_character() const;
|
|
|
|
virtual Size2 get_minimum_size() const override;
|
|
|
|
void set_expand_to_text_length(bool p_enabled);
|
|
bool get_expand_to_text_length() const;
|
|
|
|
void set_clear_button_enabled(bool p_enabled);
|
|
bool is_clear_button_enabled() const;
|
|
|
|
void set_shortcut_keys_enabled(bool p_enabled);
|
|
bool is_shortcut_keys_enabled() const;
|
|
|
|
void set_virtual_keyboard_enabled(bool p_enable);
|
|
bool is_virtual_keyboard_enabled() const;
|
|
|
|
void set_selecting_enabled(bool p_enabled);
|
|
bool is_selecting_enabled() const;
|
|
|
|
void set_right_icon(const Ref<Texture2D> &p_icon);
|
|
Ref<Texture2D> get_right_icon();
|
|
|
|
virtual bool is_text_field() const override;
|
|
|
|
void show_virtual_keyboard();
|
|
|
|
LineEdit();
|
|
~LineEdit();
|
|
};
|
|
|
|
VARIANT_ENUM_CAST(LineEdit::Align);
|
|
VARIANT_ENUM_CAST(LineEdit::MenuItems);
|
|
|
|
#endif
|