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/devel-api/styling/style-manager.h>
31 #include <dali-toolkit/devel-api/builder/builder.h>
45 * @copydoc Toolkit::StyleManager
47 class StyleManager : public Dali::BaseObject, public ConnectionTracker
54 * @return The StyleManager object
56 static Toolkit::StyleManager Get();
59 * Construct a new StyleManager.
64 * @copydoc Toolkit::StyleManager::SetOrientationValue
66 void SetOrientationValue( int orientation );
69 * @copydoc Toolkit::StyleManager::GetOrientationValue
71 int GetOrientationValue();
74 * @copydoc Toolkit::StyleManager::SetOrientation( Orientation orientation )
76 void SetOrientation( Orientation orientation );
79 * @copydoc Toolkit::StyleManager::GetOrientation
81 Orientation GetOrientation();
84 * @copydoc Toolkit::StyleManager::GetDefaultFontFamily
86 std::string GetDefaultFontFamily() const;
89 * @copydoc Toolkit::StyleManager::SetStyleConstant
91 void SetStyleConstant( const std::string& key, const Property::Value& value );
94 * @copydoc Toolkit::StyleManager::GetStyleConstant
96 bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
99 * @copydoc Toolkit::StyleManager::RequestThemeChange
101 void RequestThemeChange( const std::string& themeFile );
104 * @copydoc Toolkit::StyleManager::RequestDefaultTheme
106 void RequestDefaultTheme();
109 * Determine if a theme change has been requested
110 * @return Whether a theme request is pending
112 bool IsThemeRequestPending();
115 * @brief Apply the theme style to a control.
117 * @param[in] control The control to apply style.
119 void ApplyThemeStyle( Toolkit::Control control );
122 * @brief Apply the theme style to a control at initialization.
124 * @param[in] control The control to apply style.
126 void ApplyThemeStyleAtInit( Toolkit::Control control );
129 * @copydoc Toolkit::StyleManager::ApplyStyle
131 void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
137 * @copydoc Toolkit::StyleManager::StyleChangeSignal
139 Toolkit::StyleManager::StyleChangeSignalType& StyleChangeSignal();
146 virtual ~StyleManager();
152 * @brief Set the current theme. Called only once per event processing cycle.
158 typedef std::vector<std::string> StringList;
161 * @brief Internal helper method to read a file from file system.
162 * @param filename The name of the file to read.
163 * @param[out] stringOut The string to return the file in
165 * @param Return true if file was found
167 bool LoadFile(const std::string& filename, std::string& stringOut);
170 * @brief Create a new builder.
172 * @param[in] constants A map of constants to be used by the builder
174 * @return Return the newly created builder
176 Toolkit::Builder CreateBuilder( const Property::Map& constants );
179 * @brief Load a JSON file into given builder
181 * @param[in] builder The builder object to load the theme file
182 * @param[in] jsonFileName The name of the JSON file to load
183 * @return Return true if file was loaded
185 bool LoadJSON( Toolkit::Builder builder, const std::string& jsonFileName );
188 * @brief Collect qualifiers (e.g. Landscape, portrait etc) for a given style
190 * @param[in,out] qualifiersOut The list to populate with qualifiers
192 void CollectQualifiers( StringList& qualifiersOut );
195 * @brief Construct a qualified style name out of qualifiers
197 * A qualifed style name will be in the format: style-qualifier0-qualifier1-qualifierN
199 * @param[in] styleName The root name of the style
200 * @param[in] qualifiers List of qualifier names
201 * @param[out] qualifiedStyleOut The qualified style name
203 void BuildQualifiedStyleName( const std::string& styleName, const StringList& qualifiers, std::string& qualifiedStyleOut );
206 * @brief Apply a style to the control using the given builder
208 * @param[in] builder The builder to apply the style from
209 * @param[in] control The control to apply the style to
211 void ApplyStyle( Toolkit::Builder builder, Toolkit::Control control );
214 * @brief Callback for orientation changes
216 * @param[in] orientation The orientation object
218 void OnOrientationChanged( Orientation orientation );
221 * Search for a builder in the cache
223 * @param[in] key The key the builder was cached under
224 * @return Return the cached builder if found or an empty builder object if not found
226 Toolkit::Builder FindCachedBuilder( const std::string& key );
229 * Store a given builder in the cache keyed to the given key
231 * @param[in] builder The builder object to store
232 * @param[in] key The key to store the builder under
234 void CacheBuilder( Toolkit::Builder builder, const std::string& key );
237 * Callback for when style monitor raises a signal
239 * @param[in] styleMonitor The style monitor object
240 * @param[in] styleChange The style change type
242 void StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange );
245 StyleManager(const StyleManager&);
247 StyleManager& operator=(const StyleManager& rhs);
251 // Map to store builders keyed by JSON file name
252 typedef std::map< std::string, Toolkit::Builder > BuilderMap;
254 Toolkit::Builder mThemeBuilder; ///< Builder for all default theme properties
255 StyleMonitor mStyleMonitor; ///< Style monitor handle
257 Orientation mOrientation; ///< Handle to application orientation object
258 int mOrientationDegrees; ///< Directly set value of orientation
260 int mDefaultFontSize; ///< Logical size, not a point-size
262 std::string mDefaultFontFamily;
264 std::string mThemeFile; ///< The full path of the current theme file
266 Property::Map mThemeBuilderConstants; ///< Contants to give the theme builder
267 Property::Map mStyleBuilderConstants; ///< Constants specific to building styles
269 BuilderMap mBuilderCache; ///< Cache of builders keyed by JSON file name
271 Toolkit::Internal::FeedbackStyle* mFeedbackStyle; ///< Feedback style
274 Toolkit::StyleManager::StyleChangeSignalType mStyleChangeSignal; ///< Emitted when the style( theme/font ) changes
277 } // namespace Internal
279 inline Internal::StyleManager& GetImpl( Dali::Toolkit::StyleManager& obj )
281 DALI_ASSERT_ALWAYS( obj );
283 Dali::BaseObject& handle = obj.GetBaseObject();
285 return static_cast< Internal::StyleManager& >( handle );
288 inline const Internal::StyleManager& GetImpl( const Dali::Toolkit::StyleManager& obj )
290 DALI_ASSERT_ALWAYS( obj );
292 const Dali::BaseObject& handle = obj.GetBaseObject();
294 return static_cast< const Internal::StyleManager& >( handle );
297 } // namespace Toolkit
301 #endif // __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__