1/**************************************************************************/
2/* editor_validation_panel.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef EDITOR_VALIDATION_PANEL_H
32#define EDITOR_VALIDATION_PANEL_H
33
34#include "scene/gui/panel_container.h"
35
36class Button;
37class Label;
38class VBoxContainer;
39
40class EditorValidationPanel : public PanelContainer {
41 GDCLASS(EditorValidationPanel, PanelContainer);
42
43public:
44 enum MessageType {
45 MSG_OK,
46 MSG_WARNING,
47 MSG_ERROR,
48 MSG_INFO,
49 };
50
51 static const int MSG_ID_DEFAULT = 0; // Avoids hard-coding ID in dialogs with single-line validation.
52
53private:
54 VBoxContainer *message_container = nullptr;
55
56 HashMap<int, String> valid_messages;
57 HashMap<int, Label *> labels;
58
59 bool valid = false;
60 bool pending_update = false;
61
62 struct ThemeCache {
63 Color valid_color;
64 Color warning_color;
65 Color error_color;
66 } theme_cache;
67
68 void _update();
69
70 Callable update_callback;
71 Button *accept_button = nullptr;
72
73protected:
74 void _notification(int p_what);
75
76public:
77 void add_line(int p_id, const String &p_valid_message = "");
78 void set_accept_button(Button *p_button);
79 void set_update_callback(const Callable &p_callback);
80
81 void update();
82 void set_message(int p_id, const String &p_text, MessageType p_type, bool p_auto_prefix = true);
83 bool is_valid() const;
84
85 EditorValidationPanel();
86};
87
88#endif // EDITOR_VALIDATION_PANEL_H
89