virtualx-engine/scene/resources/theme.h

227 lines
12 KiB
C++
Raw Permalink Normal View History

/**************************************************************************/
/* theme.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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. */
/**************************************************************************/
2014-02-10 02:10:30 +01:00
#ifndef THEME_H
#define THEME_H
#include "core/io/resource_loader.h"
#include "core/resource.h"
2014-02-10 02:10:30 +01:00
#include "scene/resources/font.h"
#include "scene/resources/shader.h"
2014-02-10 02:10:30 +01:00
#include "scene/resources/style_box.h"
#include "scene/resources/texture.h"
class Theme : public Resource {
GDCLASS(Theme, Resource);
RES_BASE_EXTENSION("theme");
2016-03-09 00:00:52 +01:00
#ifdef TOOLS_ENABLED
friend class ThemeItemImportTree;
friend class ThemeItemEditorDialog;
friend class ThemeTypeEditor;
#endif
public:
enum DataType {
DATA_TYPE_COLOR,
DATA_TYPE_CONSTANT,
DATA_TYPE_FONT,
DATA_TYPE_ICON,
DATA_TYPE_STYLEBOX,
DATA_TYPE_MAX
};
private:
bool no_change_propagation = false;
void _emit_theme_changed(bool p_notify_list_changed = false);
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 22:26:09 +01:00
HashMap<StringName, StringName> variation_map;
HashMap<StringName, List<StringName>> variation_base_map;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_icon_list(const String &p_theme_type) const;
PoolVector<String> _get_icon_types() const;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_stylebox_list(const String &p_theme_type) const;
PoolVector<String> _get_stylebox_types() const;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_font_list(const String &p_theme_type) const;
PoolVector<String> _get_font_types() const;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_color_list(const String &p_theme_type) const;
PoolVector<String> _get_color_types() const;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_constant_list(const String &p_theme_type) const;
PoolVector<String> _get_constant_types() const;
2022-02-10 22:26:09 +01:00
PoolVector<String> _get_theme_item_list(DataType p_data_type, const String &p_theme_type) const;
PoolVector<String> _get_theme_item_types(DataType p_data_type) const;
2022-02-10 22:26:09 +01:00
Vector<String> _get_type_variation_list(const StringName &p_theme_type) const;
PoolVector<String> _get_type_list(const String &p_theme_type) const;
2014-02-10 02:10:30 +01:00
protected:
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-09 00:00:52 +01:00
// Universal Theme resources used when no other theme has the item.
static Ref<Theme> default_theme;
static Ref<Theme> project_default_theme;
// Universal default values, final fallback for every theme.
2014-02-10 02:10:30 +01:00
static Ref<Texture> default_icon;
static Ref<StyleBox> default_style;
static Ref<Font> default_font;
// Default values configurable for each individual theme.
Ref<Font> default_theme_font;
2014-02-10 02:10:30 +01:00
static void _bind_methods();
2016-03-09 00:00:52 +01:00
void _freeze_change_propagation();
void _unfreeze_and_propagate_changes();
public:
2014-02-10 02:10:30 +01:00
static Ref<Theme> get_default();
static void set_default(const Ref<Theme> &p_default);
2016-03-09 00:00:52 +01:00
static Ref<Theme> get_project_default();
static void set_project_default(const Ref<Theme> &p_project_default);
static void set_default_icon(const Ref<Texture> &p_icon);
static void set_default_style(const Ref<StyleBox> &p_style);
static void set_default_font(const Ref<Font> &p_font);
2022-04-26 14:03:11 +02:00
static bool is_valid_type_name(const String &p_name);
static bool is_valid_item_name(const String &p_name);
void set_default_theme_font(const Ref<Font> &p_default_font);
Ref<Font> get_default_theme_font() const;
bool has_default_theme_font() const;
2022-02-10 22:26:09 +01: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);
void remove_icon_type(const StringName &p_theme_type);
void get_icon_types(List<StringName> *p_list) const;
2022-02-10 22:26:09 +01: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);
void remove_stylebox_type(const StringName &p_theme_type);
void get_stylebox_types(List<StringName> *p_list) const;
2014-02-10 02:10:30 +01:00
2022-02-10 22:26:09 +01: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);
void remove_font_type(const StringName &p_theme_type);
void get_font_types(List<StringName> *p_list) const;
2022-02-10 22:26:09 +01: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);
void remove_color_type(const StringName &p_theme_type);
void get_color_types(List<StringName> *p_list) const;
2022-02-10 22:26:09 +01: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);
void remove_constant_type(const StringName &p_theme_type);
void get_constant_types(List<StringName> *p_list) const;
2014-02-10 02:10:30 +01:00
2022-02-10 22:26:09 +01: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);
void remove_theme_item_type(DataType p_data_type, const StringName &p_theme_type);
void get_theme_item_types(DataType p_data_type, List<StringName> *p_list) const;
2022-02-10 22:26:09 +01: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;
void add_type(const StringName &p_theme_type);
void remove_type(const StringName &p_theme_type);
2014-02-10 02:10:30 +01:00
void get_type_list(List<StringName> *p_list) const;
2022-02-10 22:26:09 +01:00
void get_type_dependencies(const StringName &p_base_type, const StringName &p_type_variant, List<StringName> *p_list);
2014-02-10 02:10:30 +01:00
void copy_default_theme();
void copy_theme(const Ref<Theme> &p_other);
void merge_with(const Ref<Theme> &p_other);
void clear();
2014-02-10 02:10:30 +01:00
Theme();
~Theme();
};
VARIANT_ENUM_CAST(Theme::DataType);
#endif // THEME_H