1 #ifndef __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__
2 #define __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__
5 * Copyright (c) 2014 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.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/devel-api/common/map-wrapper.h>
24 #include <dali/devel-api/adaptor-framework/style-monitor.h>
25 #include <dali/public-api/object/base-object.h>
26 #include <dali/public-api/object/property-map.h>
27 #include <dali/public-api/signals/connection-tracker.h>
30 #include <dali-toolkit/public-api/styling/style-manager.h>
31 #include <dali-toolkit/devel-api/builder/builder.h>
32 #include <dali-toolkit/internal/builder/style.h>
46 * @copydoc Toolkit::StyleManager
48 class StyleManager : public Dali::BaseObject, public ConnectionTracker
54 * @return The StyleManager object
56 static Toolkit::StyleManager Get();
59 * Construct a new StyleManager.
67 virtual ~StyleManager();
72 * @copydoc Toolkit::StyleManager::ApplyTheme
74 void ApplyTheme( const std::string& themeFile );
77 * @copydoc Toolkit::StyleManager::ApplyDefaultTheme
79 void ApplyDefaultTheme();
82 * @copydoc Toolkit::StyleManager::GetDefaultFontFamily
84 const std::string& GetDefaultFontFamily() const;
87 * @copydoc Toolkit::StyleManager::SetStyleConstant
89 void SetStyleConstant( const std::string& key, const Property::Value& value );
92 * @copydoc Toolkit::StyleManager::GetStyleConstant
94 bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
97 * @brief Apply the theme style to a control.
99 * @param[in] control The control to apply style.
101 void ApplyThemeStyle( Toolkit::Control control );
104 * @brief Apply the theme style to a control at initialization.
106 * @param[in] control The control to apply style.
108 void ApplyThemeStyleAtInit( Toolkit::Control control );
111 * @copydoc Toolkit::StyleManager::ApplyStyle
113 void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
116 * Get the state/style information for the given control
117 * @param[in] control The control to get state information for
118 * @return The style information (or empty ptr if not found)
120 const StylePtr GetRecordedStyle( Toolkit::Control control );
126 * @copydoc Toolkit::StyleManager::StyleChangeSignal
127 * This signal is sent after all the controls have been updated
128 * due to style change
130 Toolkit::StyleManager::StyleChangedSignalType& StyleChangedSignal();
133 * This signal is sent to the controls following a style change.
134 * It should not be exposed in the public API
136 Toolkit::StyleManager::StyleChangedSignalType& ControlStyleChangeSignal();
139 typedef std::vector<std::string> StringList;
142 * @brief Set the current theme. Called only once per event processing cycle.
143 * @param[in] themeFile The name of the theme file to read.
145 void SetTheme( const std::string& themeFile );
148 * @brief Internal helper method to read a file from file system.
149 * @param filename The name of the file to read.
150 * @param[out] stringOut The string to return the file in
152 * @param Return true if file was found
154 bool LoadFile(const std::string& filename, std::string& stringOut);
157 * @brief Create a new builder.
159 * @param[in] constants A map of constants to be used by the builder
161 * @return Return the newly created builder
163 Toolkit::Builder CreateBuilder( const Property::Map& constants );
166 * @brief Load a JSON file into given builder
168 * @param[in] builder The builder object to load the theme file
169 * @param[in] jsonFileName The name of the JSON file to load
170 * @return Return true if file was loaded
172 bool LoadJSON( Toolkit::Builder builder, const std::string& jsonFileName );
175 * @brief Apply a style to the control using the given builder
177 * @param[in] builder The builder to apply the style from
178 * @param[in] control The control to apply the style to
180 void ApplyStyle( Toolkit::Builder builder, Toolkit::Control control );
183 * Search for a builder in the cache
185 * @param[in] key The key the builder was cached under
186 * @return Return the cached builder if found or an empty builder object if not found
188 Toolkit::Builder FindCachedBuilder( const std::string& key );
191 * Store a given builder in the cache keyed to the given key
193 * @param[in] builder The builder object to store
194 * @param[in] key The key to store the builder under
196 void CacheBuilder( Toolkit::Builder builder, const std::string& key );
199 * Callback for when style monitor raises a signal
201 * @param[in] styleMonitor The style monitor object
202 * @param[in] styleChange The style change type
204 void StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange );
207 * Emit signals to controls first, app second
209 void EmitStyleChangeSignals( StyleChange::Type styleChange );
213 StyleManager(const StyleManager&);
215 StyleManager& operator=(const StyleManager& rhs);
219 // Map to store builders keyed by JSON file name
220 typedef std::map< std::string, Toolkit::Builder > BuilderMap;
222 Toolkit::Builder mThemeBuilder; ///< Builder for all default theme properties
223 StyleMonitor mStyleMonitor; ///< Style monitor handle
225 int mDefaultFontSize; ///< Logical size, not a point-size
226 std::string mDefaultFontFamily;
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__