godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
261fe7ce6a
godot/scene/resources/theme.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

231 lines
12 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 12:25:55 +00:00
/**************************************************************************/
/* 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. */
/**************************************************************************/
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-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00: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 22:33:38 +00:00
#include "core/io/resource.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "scene/resources/font.h"
#include "scene/resources/style_box.h"
#include "scene/resources/texture.h"
class Theme : public Resource {
ObjectTypeDB was renamed to ClassDB. Types are meant to be more generic to Variant. All usages of "type" to refer to classes were renamed to "class" ClassDB has been exposed to GDScript. OBJ_TYPE() macro is now GDCLASS()
2017-01-03 02:03:46 +00:00
GDCLASS(Theme, Resource);
Rename Godot-specific resource extensions
2017-06-15 22:44:11 +00:00
RES_BASE_EXTENSION("theme");
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 14:28:02 +00:00
#ifdef TOOLS_ENABLED
friend class ThemeItemImportTree;
friend class ThemeItemEditorDialog;
Overhaul the theme editor and improve user experience
2021-03-13 19:30:26 +00:00
friend class ThemeTypeEditor;
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 14:28:02 +00:00
#endif
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
public:
Define some Theme data structures with using for readability
2022-05-18 14:24:26 +00:00
using ThemeIconMap = HashMap<StringName, Ref<Texture2D>>;
using ThemeStyleMap = HashMap<StringName, Ref<StyleBox>>;
using ThemeFontMap = HashMap<StringName, Ref<Font>>;
using ThemeFontSizeMap = HashMap<StringName, int>;
using ThemeColorMap = HashMap<StringName, Color>;
using ThemeConstantMap = HashMap<StringName, int>;
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
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 14:28:02 +00:00
bool no_change_propagation = false;
Make Theme report property list changes less often
2021-10-04 14:26:43 +00: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 19:00:27 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 14:50:28 +00:00
Vector<String> _get_icon_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 14:50:28 +00:00
Vector<String> _get_stylebox_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 14:50:28 +00:00
Vector<String> _get_font_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 11:35:58 +00:00
Vector<String> _get_font_size_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 14:50:28 +00:00
Vector<String> _get_color_type_list() const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 14:50:28 +00:00
Vector<String> _get_constant_type_list() const;
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00: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 11:35:58 +00:00
Vector<String> _get_theme_item_type_list(DataType p_data_type) const;
Add type variations to Theme
2021-07-04 20:42:23 +00: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 14:50:28 +00: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 02:08:23 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00: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;
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Reorganize Theme resource code for better maintainability
2021-10-02 16:26:20 +00:00
// Default values configurable for each individual theme.
Correctly use fallback Theme values as last resort
2021-12-31 15:53:43 +00:00
float default_base_scale = 0.0;
Ref<Font> default_font;
int default_font_size = -1;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
HashMap<StringName, ThemeIconMap> icon_map;
HashMap<StringName, ThemeStyleMap> style_map;
HashMap<StringName, ThemeFontMap> font_map;
HashMap<StringName, ThemeFontSizeMap> font_size_map;
HashMap<StringName, ThemeColorMap> color_map;
HashMap<StringName, ThemeConstantMap> constant_map;
HashMap<StringName, StringName> variation_map;
HashMap<StringName, List<StringName>> variation_base_map;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
static void _bind_methods();
remove trailing whitespace
2016-03-08 23:00:52 +00:00
Prevent Theme resource from emitting changes during bulk operations
2021-05-31 14:28:02 +00: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 17:18:45 +00: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 15:44:50 +00:00
public:
Validate theme type/item names
2022-04-26 10:21:34 +00:00
static bool is_valid_type_name(const String &p_name);
static bool is_valid_item_name(const String &p_name);
Correctly use fallback Theme values as last resort
2021-12-31 15:53:43 +00:00
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 11:22:16 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_icon(const StringName &p_name, const StringName &p_theme_type, const Ref<Texture2D> &p_icon);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual Ref<Texture2D> get_icon(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_icon_type(const StringName &p_theme_type);
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00: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 16:20:11 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_stylebox(const StringName &p_name, const StringName &p_theme_type, const Ref<StyleBox> &p_style);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual Ref<StyleBox> get_stylebox(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_stylebox_type(const StringName &p_theme_type);
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
void get_stylebox_type_list(List<StringName> *p_list) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_font(const StringName &p_name, const StringName &p_theme_type, const Ref<Font> &p_font);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual Ref<Font> get_font(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_font_type(const StringName &p_theme_type);
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00: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 11:22:16 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_font_size(const StringName &p_name, const StringName &p_theme_type, int p_font_size);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual int get_font_size(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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 an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_font_size_type(const StringName &p_theme_type);
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00: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 16:20:11 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_color(const StringName &p_name, const StringName &p_theme_type, const Color &p_color);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual Color get_color(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_color_type(const StringName &p_theme_type);
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00: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 16:20:11 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
void set_constant(const StringName &p_name, const StringName &p_theme_type, int p_constant);
Warn about accessing non-existing editor theme items
2023-09-13 11:14:06 +00:00
virtual int get_constant(const StringName &p_name, const StringName &p_theme_type) const;
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +00:00
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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_constant_type(const StringName &p_theme_type);
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
void get_constant_type_list(List<StringName> *p_list) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Add theme_custom_type property to Control and Window
2021-03-30 17:16:33 +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);
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void remove_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 11:35:58 +00:00
void get_theme_item_type_list(DataType p_data_type, List<StringName> *p_list) const;
Add type variations to Theme
2021-07-04 20:42:23 +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;
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
void add_type(const StringName &p_theme_type);
void remove_type(const StringName &p_theme_type);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
void get_type_list(List<StringName> *p_list) const;
Add type variations to Theme
2021-07-04 20:42:23 +00: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 01:10:30 +00:00
Add support for partial custom editor themes
2021-08-13 23:01:15 +00: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 17:33:14 +00:00
void clear();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
Theme();
~Theme();
};
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
VARIANT_ENUM_CAST(Theme::DataType);
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // THEME_H
Reference in New Issue Copy Permalink