2014-02-10 01:10:30 +00:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* theme.h */
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* This file is part of: */
|
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 12:16:55 +00:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 01:10:30 +00:00
|
|
|
/*************************************************************************/
|
2022-01-13 08:45:09 +00:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
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. */
|
|
|
|
|
/*************************************************************************/
|
2018-01-04 23:50:27 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#ifndef THEME_H
|
|
|
|
|
#define THEME_H
|
|
|
|
|
|
2018-09-11 16:13:45 +00:00
|
|
|
#include "core/io/resource_loader.h"
|
|
|
|
|
#include "core/resource.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
#include "scene/resources/font.h"
|
2017-03-05 15:44:50 +00:00
|
|
|
#include "scene/resources/shader.h"
|
2014-02-10 01:10:30 +00:00
|
|
|
#include "scene/resources/style_box.h"
|
|
|
|
|
#include "scene/resources/texture.h"
|
|
|
|
|
|
|
|
|
|
class Theme : public Resource {
|
2017-03-05 15:44:50 +00:00
|
|
|
GDCLASS(Theme, Resource);
|
2017-06-15 22:44:11 +00:00
|
|
|
RES_BASE_EXTENSION("theme");
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2021-06-10 21:44:42 +00:00
|
|
|
#ifdef TOOLS_ENABLED
|
|
|
|
|
friend class ThemeItemImportTree;
|
|
|
|
|
friend class ThemeItemEditorDialog;
|
2021-06-20 19:45:07 +00:00
|
|
|
friend class ThemeTypeEditor;
|
2021-06-10 21:44:42 +00:00
|
|
|
#endif
|
|
|
|
|
|
2021-06-10 13:23:00 +00:00
|
|
|
public:
|
|
|
|
|
enum DataType {
|
|
|
|
|
DATA_TYPE_COLOR,
|
|
|
|
|
DATA_TYPE_CONSTANT,
|
|
|
|
|
DATA_TYPE_FONT,
|
|
|
|
|
DATA_TYPE_ICON,
|
|
|
|
|
DATA_TYPE_STYLEBOX,
|
|
|
|
|
DATA_TYPE_MAX
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
private:
|
2021-06-10 21:44:42 +00:00
|
|
|
bool no_change_propagation = false;
|
|
|
|
|
|
2021-10-04 15:05:23 +00:00
|
|
|
void _emit_theme_changed(bool p_notify_list_changed = false);
|
2016-06-17 19:00:27 +00:00
|
|
|
|
2021-05-04 12:20:36 +00:00
|
|
|
HashMap<StringName, HashMap<StringName, Ref<Texture>>> icon_map;
|
|
|
|
|
HashMap<StringName, HashMap<StringName, Ref<StyleBox>>> style_map;
|
|
|
|
|
HashMap<StringName, HashMap<StringName, Ref<Font>>> font_map;
|
|
|
|
|
HashMap<StringName, HashMap<StringName, Ref<Shader>>> shader_map;
|
|
|
|
|
HashMap<StringName, HashMap<StringName, Color>> color_map;
|
|
|
|
|
HashMap<StringName, HashMap<StringName, int>> constant_map;
|
2022-02-10 21:26:09 +00:00
|
|
|
HashMap<StringName, StringName> variation_map;
|
|
|
|
|
HashMap<StringName, List<StringName>> variation_base_map;
|
2016-06-17 19:00:27 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_icon_list(const String &p_theme_type) const;
|
2021-06-10 12:28:47 +00:00
|
|
|
PoolVector<String> _get_icon_types() const;
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_stylebox_list(const String &p_theme_type) const;
|
2021-05-04 14:40:33 +00:00
|
|
|
PoolVector<String> _get_stylebox_types() const;
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_font_list(const String &p_theme_type) const;
|
2021-06-10 12:28:47 +00:00
|
|
|
PoolVector<String> _get_font_types() const;
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_color_list(const String &p_theme_type) const;
|
2021-06-10 12:28:47 +00:00
|
|
|
PoolVector<String> _get_color_types() const;
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_constant_list(const String &p_theme_type) const;
|
2021-06-10 12:28:47 +00:00
|
|
|
PoolVector<String> _get_constant_types() const;
|
2021-06-10 13:23:00 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
PoolVector<String> _get_theme_item_list(DataType p_data_type, const String &p_theme_type) const;
|
2021-06-10 13:23:00 +00:00
|
|
|
PoolVector<String> _get_theme_item_types(DataType p_data_type) const;
|
2022-02-10 21:26:09 +00:00
|
|
|
|
|
|
|
|
Vector<String> _get_type_variation_list(const StringName &p_theme_type) const;
|
|
|
|
|
PoolVector<String> _get_type_list(const String &p_theme_type) const;
|
2019-10-23 02:08:23 +00:00
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
protected:
|
2017-03-05 15:44:50 +00:00
|
|
|
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;
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2021-10-04 14:09:32 +00:00
|
|
|
// Universal Theme resources used when no other theme has the item.
|
2019-07-05 20:32:52 +00:00
|
|
|
static Ref<Theme> default_theme;
|
2021-10-04 14:09:32 +00:00
|
|
|
static Ref<Theme> project_default_theme;
|
|
|
|
|
|
|
|
|
|
// Universal default values, final fallback for every theme.
|
2014-02-10 01:10:30 +00:00
|
|
|
static Ref<Texture> default_icon;
|
|
|
|
|
static Ref<StyleBox> default_style;
|
|
|
|
|
static Ref<Font> default_font;
|
|
|
|
|
|
2021-10-04 14:09:32 +00:00
|
|
|
// Default values configurable for each individual theme.
|
2014-02-15 05:01:39 +00:00
|
|
|
Ref<Font> default_theme_font;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
|
static void _bind_methods();
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2021-06-10 21:44:42 +00:00
|
|
|
void _freeze_change_propagation();
|
|
|
|
|
void _unfreeze_and_propagate_changes();
|
|
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
public:
|
2014-02-10 01:10:30 +00:00
|
|
|
static Ref<Theme> get_default();
|
2017-03-05 15:44:50 +00:00
|
|
|
static void set_default(const Ref<Theme> &p_default);
|
2016-03-08 23:00:52 +00:00
|
|
|
|
2019-07-05 20:32:52 +00:00
|
|
|
static Ref<Theme> get_project_default();
|
2019-08-07 10:54:30 +00:00
|
|
|
static void set_project_default(const Ref<Theme> &p_project_default);
|
2019-07-05 20:32:52 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
static void set_default_icon(const Ref<Texture> &p_icon);
|
2017-08-11 19:10:05 +00:00
|
|
|
static void set_default_style(const Ref<StyleBox> &p_style);
|
|
|
|
|
static void set_default_font(const Ref<Font> &p_font);
|
2014-02-15 05:01:39 +00:00
|
|
|
|
2017-03-05 15:44:50 +00:00
|
|
|
void set_default_theme_font(const Ref<Font> &p_default_font);
|
2014-02-15 05:01:39 +00:00
|
|
|
Ref<Font> get_default_theme_font() const;
|
2021-10-04 14:44:53 +00:00
|
|
|
bool has_default_theme_font() const;
|
2014-02-15 05:01:39 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_icon(const StringName &p_name, const StringName &p_theme_type, const Ref<Texture> &p_icon);
|
|
|
|
|
Ref<Texture> get_icon(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_icon(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_icon_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_icon(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_icon(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_icon_list(StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_icon_type(const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_icon_type(const StringName &p_theme_type);
|
2021-06-10 12:28:47 +00:00
|
|
|
void get_icon_types(List<StringName> *p_list) const;
|
2020-09-12 16:30:40 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_shader(const StringName &p_name, const StringName &p_theme_type, const Ref<Shader> &p_shader);
|
|
|
|
|
Ref<Shader> get_shader(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_shader(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void clear_shader(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_shader_list(const StringName &p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
|
|
|
|
|
void set_stylebox(const StringName &p_name, const StringName &p_theme_type, const Ref<StyleBox> &p_style);
|
|
|
|
|
Ref<StyleBox> get_stylebox(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_stylebox(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_stylebox_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_stylebox(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_stylebox(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_stylebox_list(StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_stylebox_type(const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_stylebox_type(const StringName &p_theme_type);
|
2016-04-21 01:58:53 +00:00
|
|
|
void get_stylebox_types(List<StringName> *p_list) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_font(const StringName &p_name, const StringName &p_theme_type, const Ref<Font> &p_font);
|
|
|
|
|
Ref<Font> get_font(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_font(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_font_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_font(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_font(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_font_list(StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_font_type(const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_font_type(const StringName &p_theme_type);
|
2021-06-10 12:28:47 +00:00
|
|
|
void get_font_types(List<StringName> *p_list) const;
|
2020-09-12 16:30:40 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_color(const StringName &p_name, const StringName &p_theme_type, const Color &p_color);
|
|
|
|
|
Color get_color(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_color(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_color_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_color(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_color(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_color_list(StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_color_type(const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_color_type(const StringName &p_theme_type);
|
2021-06-10 12:28:47 +00:00
|
|
|
void get_color_types(List<StringName> *p_list) const;
|
2020-09-12 16:30:40 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_constant(const StringName &p_name, const StringName &p_theme_type, int p_constant);
|
|
|
|
|
int get_constant(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_constant(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_constant_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_constant(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_constant(const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_constant_list(StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_constant_type(const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_constant_type(const StringName &p_theme_type);
|
2021-06-10 12:28:47 +00:00
|
|
|
void get_constant_types(List<StringName> *p_list) const;
|
2014-02-10 01:10:30 +00:00
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_theme_item(DataType p_data_type, const StringName &p_name, const StringName &p_theme_type, const Variant &p_value);
|
|
|
|
|
Variant get_theme_item(DataType p_data_type, const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_theme_item(DataType p_data_type, const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
bool has_theme_item_nocheck(DataType p_data_type, const StringName &p_name, const StringName &p_theme_type) const;
|
|
|
|
|
void rename_theme_item(DataType p_data_type, const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void clear_theme_item(DataType p_data_type, const StringName &p_name, const StringName &p_theme_type);
|
|
|
|
|
void get_theme_item_list(DataType p_data_type, StringName p_theme_type, List<StringName> *p_list) const;
|
|
|
|
|
void add_theme_item_type(DataType p_data_type, const StringName &p_theme_type);
|
2022-04-05 03:46:47 +00:00
|
|
|
void remove_theme_item_type(DataType p_data_type, const StringName &p_theme_type);
|
2021-06-10 13:23:00 +00:00
|
|
|
void get_theme_item_types(DataType p_data_type, List<StringName> *p_list) const;
|
|
|
|
|
|
2022-02-10 21:26:09 +00:00
|
|
|
void set_type_variation(const StringName &p_theme_type, const StringName &p_base_type);
|
|
|
|
|
bool is_type_variation(const StringName &p_theme_type, const StringName &p_base_type) const;
|
|
|
|
|
void clear_type_variation(const StringName &p_theme_type);
|
|
|
|
|
StringName get_type_variation_base(const StringName &p_theme_type) const;
|
|
|
|
|
void get_type_variation_list(const StringName &p_base_type, List<StringName> *p_list) const;
|
|
|
|
|
|
2022-04-05 03:46:47 +00:00
|
|
|
void add_type(const StringName &p_theme_type);
|
|
|
|
|
void remove_type(const StringName &p_theme_type);
|
2014-02-10 01:10:30 +00:00
|
|
|
void get_type_list(List<StringName> *p_list) const;
|
2022-02-10 21:26:09 +00:00
|
|
|
void get_type_dependencies(const StringName &p_base_type, const StringName &p_type_variant, List<StringName> *p_list);
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
|
void copy_default_theme();
|
2019-01-25 01:40:56 +00:00
|
|
|
void copy_theme(const Ref<Theme> &p_other);
|
2021-08-13 22:06:21 +00:00
|
|
|
void merge_with(const Ref<Theme> &p_other);
|
2018-11-27 17:33:14 +00:00
|
|
|
void clear();
|
2014-02-10 01:10:30 +00:00
|
|
|
|
|
|
|
|
Theme();
|
|
|
|
|
~Theme();
|
|
|
|
|
};
|
|
|
|
|
|
2021-06-10 13:23:00 +00:00
|
|
|
VARIANT_ENUM_CAST(Theme::DataType);
|
|
|
|
|
|
2014-02-10 01:10:30 +00:00
|
|
|
#endif
|
