asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/scene/resources/theme.h

242 lines
12 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/*************************************************************************/
/* theme.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 14:16:55 +02:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 21:27:34 +01:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01: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. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-05 00:50:27 +01:00
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#ifndef THEME_H
#define THEME_H
Reorganized core/ directory, it was too fatty already -Removed FuncRef, since Callable makes it obsolete -Removed int_types.h as its obsolete in c++11+ -Changed color names code
2020-11-07 23:33:38 +01:00
#include "core/io/resource.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 18:13:45 +02:00
#include "core/io/resource_loader.h"
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#include "scene/resources/font.h"
#include "scene/resources/style_box.h"
#include "scene/resources/texture.h"
class Theme : public Resource {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
GDCLASS(Theme, Resource);
Rename Godot-specific resource extensions
2017-06-16 00:44:11 +02:00
RES_BASE_EXTENSION("theme");
remove trailing whitespace
2016-03-09 00:00:52 +01:00
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 16:28:02 +02:00
#ifdef TOOLS_ENABLED
friend class ThemeItemImportTree;
friend class ThemeItemEditorDialog;
Overhaul the theme editor and improve user experience
2021-03-13 20:30:26 +01:00
friend class ThemeTypeEditor;
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 16:28:02 +02:00
#endif
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
public:
enum DataType {
DATA_TYPE_COLOR,
DATA_TYPE_CONSTANT,
DATA_TYPE_FONT,
DATA_TYPE_FONT_SIZE,
DATA_TYPE_ICON,
DATA_TYPE_STYLEBOX,
DATA_TYPE_MAX
};
private:
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 16:28:02 +02:00
bool no_change_propagation = false;
Make Theme report property list changes less often
2021-10-04 16:26:43 +02:00
void _emit_theme_changed(bool p_notify_list_changed = false);
Keep track of when fonts change, so theme or controls that use fonts as overrides get properly updated. closes #4622 , probably closes many other issues too
2016-06-17 21:00:27 +02:00
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 07:33:00 +01:00
HashMap<StringName, HashMap<StringName, Ref<Texture2D>>> icon_map;
HashMap<StringName, HashMap<StringName, Ref<StyleBox>>> style_map;
HashMap<StringName, HashMap<StringName, Ref<Font>>> font_map;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 13:22:16 +02:00
HashMap<StringName, HashMap<StringName, int>> font_size_map;
Style: Set clang-format Standard to Cpp11 For us, it practically only changes the fact that `A<A<int>>` is now used instead of the C++03 compatible `A<A<int> >`. Note: clang-format 10+ changed the `Standard` arguments to fully specified `c++11`, `c++14`, etc. versions, but we can't use `c++17` now if we want to preserve compatibility with clang-format 8 and 9. `Cpp11` is still supported as deprecated alias for `Latest`.
2020-03-17 07:33:00 +01:00
HashMap<StringName, HashMap<StringName, Color>> color_map;
HashMap<StringName, HashMap<StringName, int>> constant_map;
Add type variations to Theme
2021-07-04 22:42:23 +02:00
HashMap<StringName, StringName> variation_map;
HashMap<StringName, List<StringName>> variation_base_map;
Keep track of when fonts change, so theme or controls that use fonts as overrides get properly updated. closes #4622 , probably closes many other issues too
2016-06-17 21:00:27 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_icon_list(const String &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_icon_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_stylebox_list(const String &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_stylebox_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_font_list(const String &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_font_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_font_size_list(const String &p_theme_type) const;
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
Vector<String> _get_font_size_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_color_list(const String &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_color_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_constant_list(const String &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_constant_type_list() const;
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
Vector<String> _get_theme_item_list(DataType p_data_type, const String &p_theme_type) const;
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
Vector<String> _get_theme_item_type_list(DataType p_data_type) const;
Add type variations to Theme
2021-07-04 22:42:23 +02:00
Vector<String> _get_type_variation_list(const StringName &p_theme_type) const;
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
Vector<String> _get_type_list() const;
Theme code refactoring - Move GDScript-exposed function definitions from header to source file - Add null check to functions taking list pointers as parameters - Call clear() in copy_theme() if null is passed
2019-10-23 04:08:23 +02:00
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
protected:
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01: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;
remove trailing whitespace
2016-03-09 00:00:52 +01:00
Reorganize Theme resource code for better maintainability
2021-10-02 18:26:20 +02:00
// Universal Theme resources used when no other theme has the item.
Keep track of default theme and project custom default theme seperatelly Fixes #30288
2019-07-05 22:32:52 +02:00
static Ref<Theme> default_theme;
Reorganize Theme resource code for better maintainability
2021-10-02 18:26:20 +02:00
static Ref<Theme> project_default_theme;
// Universal default values, final fallback for every theme.
Correctly use fallback Theme values as last resort
2021-12-31 16:53:43 +01:00
static float fallback_base_scale;
static Ref<Texture2D> fallback_icon;
static Ref<StyleBox> fallback_style;
static Ref<Font> fallback_font;
static int fallback_font_size;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Reorganize Theme resource code for better maintainability
2021-10-02 18:26:20 +02:00
// Default values configurable for each individual theme.
Correctly use fallback Theme values as last resort
2021-12-31 16:53:43 +01:00
float default_base_scale = 0.0;
Ref<Font> default_font;
int default_font_size = -1;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
static void _bind_methods();
remove trailing whitespace
2016-03-09 00:00:52 +01:00
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 16:28:02 +02:00
void _freeze_change_propagation();
void _unfreeze_and_propagate_changes();
Improve resource load cache -Added a new method in Resource: reset_state , used for reloading the same resource from disk -Added a new cache mode "replace" in ResourceLoader, which reuses existing loaded sub-resources but resets their data from disk (or replaces them if they chaged type) -Because the correct sub-resource paths are always loaded now, this fixes bugs with subresource folding or subresource ordering when saving.
2021-02-11 18:18:45 +01:00
virtual void reset_state() override;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
public:
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
static Ref<Theme> get_default();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
static void set_default(const Ref<Theme> &p_default);
remove trailing whitespace
2016-03-09 00:00:52 +01:00
Keep track of default theme and project custom default theme seperatelly Fixes #30288
2019-07-05 22:32:52 +02:00
static Ref<Theme> get_project_default();
Add some code changes/fixes proposed by Coverity and Clang Tidy
2019-08-07 12:54:30 +02:00
static void set_project_default(const Ref<Theme> &p_project_default);
Keep track of default theme and project custom default theme seperatelly Fixes #30288
2019-07-05 22:32:52 +02:00
Correctly use fallback Theme values as last resort
2021-12-31 16:53:43 +01:00
static void set_fallback_base_scale(float p_base_scale);
static void set_fallback_icon(const Ref<Texture2D> &p_icon);
static void set_fallback_style(const Ref<StyleBox> &p_style);
static void set_fallback_font(const Ref<Font> &p_font);
static void set_fallback_font_size(int p_font_size);
static float get_fallback_base_scale();
static Ref<Texture2D> get_fallback_icon();
static Ref<StyleBox> get_fallback_style();
static Ref<Font> get_fallback_font();
static int get_fallback_font_size();
void set_default_base_scale(float p_base_scale);
float get_default_base_scale() const;
bool has_default_base_scale() const;
void set_default_font(const Ref<Font> &p_default_font);
Ref<Font> get_default_font() const;
bool has_default_font() const;
void set_default_font_size(int p_font_size);
int get_default_font_size() const;
bool has_default_font_size() const;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 13:22:16 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
void set_icon(const StringName &p_name, const StringName &p_theme_type, const Ref<Texture2D> &p_icon);
Ref<Texture2D> 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);
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
void get_icon_type_list(List<StringName> *p_list) const;
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 18:20:11 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
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);
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
void get_stylebox_type_list(List<StringName> *p_list) const;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02: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);
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
void get_font_type_list(List<StringName> *p_list) const;
[Complex Text Layouts] Refactor Font class, default themes and controls to use Text Server interface. Implement interface mirroring. Add TextLine and TextParagraph classes. Handle UTF-16 input on macOS and Windows.
2020-09-03 13:22:16 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02:00
void set_font_size(const StringName &p_name, const StringName &p_theme_type, int p_font_size);
int get_font_size(const StringName &p_name, const StringName &p_theme_type) const;
bool has_font_size(const StringName &p_name, const StringName &p_theme_type) const;
bool has_font_size_nocheck(const StringName &p_name, const StringName &p_theme_type) const;
void rename_font_size(const StringName &p_old_name, const StringName &p_name, const StringName &p_theme_type);
void clear_font_size(const StringName &p_name, const StringName &p_theme_type);
void get_font_size_list(StringName p_theme_type, List<StringName> *p_list) const;
void add_font_size_type(const StringName &p_theme_type);
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
void get_font_size_type_list(List<StringName> *p_list) const;
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 18:20:11 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02: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);
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
void get_color_type_list(List<StringName> *p_list) const;
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order.
2020-09-12 18:20:11 +02:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02: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);
Remove unused argument in Theme method and expose missing methods
2020-04-10 16:50:28 +02:00
void get_constant_type_list(List<StringName> *p_list) const;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Add theme_custom_type property to Control and Window
2021-03-30 19:16:33 +02: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);
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
void get_theme_item_type_list(DataType p_data_type, List<StringName> *p_list) const;
Add type variations to Theme
2021-07-04 22:42:23 +02: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;
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
void get_type_list(List<StringName> *p_list) const;
Add type variations to Theme
2021-07-04 22:42:23 +02:00
void get_type_dependencies(const StringName &p_base_type, const StringName &p_type_variant, List<StringName> *p_list);
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Add support for partial custom editor themes
2021-08-14 01:01:15 +02:00
void merge_with(const Ref<Theme> &p_other);
Changed theme notifications to work with newly introduced reference counted connections. Closes #21265, Fixes #6145. Probably fixes more theme notification related open issues, should check.
2018-11-27 18:33:14 +01:00
void clear();
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
Theme();
~Theme();
};
Add utility methods to Theme, improve error messages and documentation
2021-03-22 12:35:58 +01:00
VARIANT_ENUM_CAST(Theme::DataType);
GODOT IS OPEN SOURCE
2014-02-10 02:10:30 +01:00
#endif
Reference in a new issue Copy permalink