1 #ifndef DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H
2 #define DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/devel-api/adaptor-framework/style-monitor.h>
22 #include <dali/devel-api/common/map-wrapper.h>
23 #include <dali/public-api/common/vector-wrapper.h>
24 #include <dali/public-api/object/base-object.h>
25 #include <dali/public-api/object/property-map.h>
26 #include <dali/public-api/signals/connection-tracker.h>
30 #include <dali-toolkit/devel-api/builder/builder.h>
31 #include <dali-toolkit/internal/builder/style.h>
32 #include <dali-toolkit/public-api/styling/style-manager.h>
43 * @copydoc Toolkit::StyleManager
45 class StyleManager : public Dali::BaseObject, public ConnectionTracker
51 * @return The StyleManager object
53 static Toolkit::StyleManager Get();
56 * Construct a new StyleManager.
64 virtual ~StyleManager();
68 * @copydoc Toolkit::StyleManager::ApplyTheme
70 void ApplyTheme(const std::string& themeFile);
73 * @copydoc Toolkit::StyleManager::ApplyDefaultTheme
75 void ApplyDefaultTheme();
78 * @copydoc Toolkit::StyleManager::GetDefaultFontFamily
80 const std::string& GetDefaultFontFamily() const;
83 * @copydoc Toolkit::StyleManager::SetStyleConstant
85 void SetStyleConstant(const std::string& key, const Property::Value& value);
88 * @copydoc Toolkit::StyleManager::GetStyleConstant
90 bool GetStyleConstant(const std::string& key, Property::Value& valueOut);
93 * @copydoc Toolkit::StyleManager::GetConfigurations
95 const Property::Map GetConfigurations();
98 * @brief Apply the theme style to a control.
100 * @param[in] control The control to apply style.
102 void ApplyThemeStyle(Toolkit::Control control);
105 * @brief Apply the theme style to a control at initialization.
107 * @param[in] control The control to apply style.
109 void ApplyThemeStyleAtInit(Toolkit::Control control);
112 * @copydoc Toolkit::StyleManager::ApplyStyle
114 void ApplyStyle(Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName);
117 * Get the state/style information for the given control
118 * @param[in] control The control to get state information for
119 * @return The style information (or empty ptr if not found)
121 const StylePtr GetRecordedStyle(Toolkit::Control control);
127 * @copydoc Toolkit::StyleManager::StyleChangeSignal
128 * This signal is sent after all the controls have been updated
129 * due to style change
131 Toolkit::StyleManager::StyleChangedSignalType& StyleChangedSignal();
134 * This signal is sent to the controls following a style change.
135 * It should not be exposed in the public API
137 Toolkit::StyleManager::StyleChangedSignalType& ControlStyleChangeSignal();
140 typedef std::vector<std::string> StringList;
143 * @brief Set the current theme. Called only once per event processing cycle.
144 * @param[in] themeFile The name of the theme file to read.
146 void SetTheme(const std::string& themeFile);
149 * @brief Internal helper method to read a file from file system.
150 * @param filename The name of the file to read.
151 * @param[out] stringOut The string to return the file in
153 * @param Return true if file was found
155 bool LoadFile(const std::string& filename, std::string& stringOut);
158 * @brief Create a new builder.
160 * @param[in] constants A map of constants to be used by the builder
162 * @return Return the newly created builder
164 Toolkit::Builder CreateBuilder(const Property::Map& constants);
167 * @brief Load a JSON file into given builder
169 * @param[in] builder The builder object to load the theme file
170 * @param[in] jsonFileName The name of the JSON file to load
171 * @return Return true if file was loaded
173 bool LoadJSON(Toolkit::Builder builder, const std::string& jsonFileName);
176 * @brief Apply a style to the control using the given builder
178 * @param[in] builder The builder to apply the style from
179 * @param[in] control The control to apply the style to
181 void ApplyStyle(Toolkit::Builder builder, Toolkit::Control control);
184 * Search for a builder in the cache
186 * @param[in] key The key the builder was cached under
187 * @return Return the cached builder if found or an empty builder object if not found
189 Toolkit::Builder FindCachedBuilder(const std::string& key);
192 * Store a given builder in the cache keyed to the given key
194 * @param[in] builder The builder object to store
195 * @param[in] key The key to store the builder under
197 void CacheBuilder(Toolkit::Builder builder, const std::string& key);
200 * Callback for when style monitor raises a signal
202 * @param[in] styleMonitor The style monitor object
203 * @param[in] styleChange The style change type
205 void StyleMonitorChange(StyleMonitor styleMonitor, StyleChange::Type styleChange);
208 * Emit signals to controls first, app second
210 void EmitStyleChangeSignals(StyleChange::Type styleChange);
213 StyleManager(const StyleManager&);
215 StyleManager& operator=(const StyleManager& rhs);
218 // Map to store builders keyed by JSON file name
219 typedef std::map<std::string, Toolkit::Builder> BuilderMap;
221 Toolkit::Builder mThemeBuilder; ///< Builder for all default theme properties
222 StyleMonitor mStyleMonitor; ///< Style monitor handle
224 int mDefaultFontSize; ///< Logical size, not a point-size
225 std::string mDefaultFontFamily;
226 std::string mDefaultThemeFilePath; ///< The full path of the default theme file
227 std::string mThemeFile; ///< The full path of the current theme file
229 Property::Map mThemeBuilderConstants; ///< Contants to give the theme builder
230 Property::Map mStyleBuilderConstants; ///< Constants specific to building styles
232 BuilderMap mBuilderCache; ///< Cache of builders keyed by JSON file name
234 Toolkit::Internal::FeedbackStyle* mFeedbackStyle; ///< Feedback style
237 Toolkit::StyleManager::StyleChangedSignalType mControlStyleChangeSignal; ///< Emitted when the style( theme/font ) changes for the controls to style themselves
238 Toolkit::StyleManager::StyleChangedSignalType mStyleChangedSignal; ///< Emitted after the controls have been styled
241 } // namespace Internal
243 inline Internal::StyleManager& GetImpl(Dali::Toolkit::StyleManager& obj)
245 DALI_ASSERT_ALWAYS(obj);
247 Dali::BaseObject& handle = obj.GetBaseObject();
249 return static_cast<Internal::StyleManager&>(handle);
252 inline const Internal::StyleManager& GetImpl(const Dali::Toolkit::StyleManager& obj)
254 DALI_ASSERT_ALWAYS(obj);
256 const Dali::BaseObject& handle = obj.GetBaseObject();
258 return static_cast<const Internal::StyleManager&>(handle);
261 } // namespace Toolkit
265 #endif // DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H