godot/scene/gui/line_edit.h

190 lines
5.0 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* line_edit.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* http://www.godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
2014-02-10 01:10:30 +00:00
/* */
/* 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"
2014-02-10 01:10:30 +00:00
/**
@author Juan Linietsky <reduzio@gmail.com>
*/
class LineEdit : public Control {
2016-03-08 23:00:52 +00:00
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_MAX
};
private:
Align align;
2014-02-10 01:10:30 +00:00
bool editable;
bool pass;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
String undo_text;
String text;
String placeholder;
2016-06-28 03:45:17 +00:00
float placeholder_alpha;
2016-03-08 23:00:52 +00:00
PopupMenu *menu;
2014-02-10 01:10:30 +00:00
int cursor_pos;
int window_pos;
int max_length; // 0 for no maximum
int cached_width;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
struct Selection {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
int begin;
int end;
int cursor_start;
bool enabled;
bool creating;
bool doubleclick;
bool drag_attempt;
} selection;
2016-03-08 23:00:52 +00:00
2016-06-20 23:05:52 +00:00
Timer *caret_blink_timer;
void _text_changed();
bool expand_to_text_length;
2016-06-20 23:05:52 +00:00
bool caret_blink_enabled;
bool draw_caret;
bool window_has_focus;
2016-06-20 23:05:52 +00:00
2014-02-10 01:10:30 +00:00
void shift_selection_check_pre(bool);
void shift_selection_check_post(bool);
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void selection_clear();
void selection_fill_at_cursor();
void selection_delete();
void set_window_pos(int p_pos);
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void set_cursor_at_pixel_pos(int p_x);
2016-03-08 23:00:52 +00:00
2016-06-20 23:05:52 +00:00
void _reset_caret_blink_timer();
void _toggle_draw_caret();
2014-02-10 01:10:30 +00:00
void clear_internal();
void changed_internal();
2016-03-08 23:00:52 +00:00
#ifdef TOOLS_ENABLED
void _editor_settings_changed();
#endif
2014-02-10 01:10:30 +00:00
void _gui_input(InputEvent p_event);
2014-02-10 01:10:30 +00:00
void _notification(int p_what);
2016-03-08 23:00:52 +00:00
2016-03-08 23:00:52 +00:00
protected:
static void _bind_methods();
2014-02-10 01:10:30 +00:00
public:
void set_align(Align p_align);
Align get_align() const;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
virtual Variant get_drag_data(const Point2& p_point);
virtual bool can_drop_data(const Point2& p_point,const Variant& p_data) const;
virtual void drop_data(const Point2& p_point,const Variant& p_data);
void menu_option(int p_option);
PopupMenu *get_menu() const;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void select_all();
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void delete_char();
2016-06-18 14:15:26 +00:00
void delete_text(int p_from_column, int p_to_column);
2014-02-10 01:10:30 +00:00
void set_text(String p_text);
String get_text() const;
void set_placeholder(String p_text);
String get_placeholder() const;
2016-06-28 03:45:17 +00:00
void set_placeholder_alpha(float p_alpha);
float get_placeholder_alpha() const;
2014-02-10 01:10:30 +00:00
void set_cursor_pos(int p_pos);
int get_cursor_pos() const;
void set_max_length(int p_max_length);
int get_max_length() const;
void append_at_cursor(String p_text);
void clear();
2016-03-08 23:00:52 +00:00
2016-06-20 23:05:52 +00:00
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);
void copy_text();
void cut_text();
void paste_text();
void undo();
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void set_editable(bool p_editable);
bool is_editable() const;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
void set_secret(bool p_secret);
bool is_secret() const;
void select(int p_from=0, int p_to=-1);
virtual Size2 get_minimum_size() const;
2015-10-17 13:29:54 +00:00
void set_expand_to_text_length(bool p_len);
bool get_expand_to_text_length() const;
virtual bool is_text_field() const;
2014-02-10 01:10:30 +00:00
LineEdit();
~LineEdit();
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
};
VARIANT_ENUM_CAST(LineEdit::Align);
2014-02-10 01:10:30 +00:00
#endif