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 * @copydoc Toolkit::StyleManager::GetConfigurations
99 const Property::Map GetConfigurations();
102 * @brief Apply the theme style to a control.
104 * @param[in] control The control to apply style.
106 void ApplyThemeStyle( Toolkit::Control control );
109 * @brief Apply the theme style to a control at initialization.
111 * @param[in] control The control to apply style.
113 void ApplyThemeStyleAtInit( Toolkit::Control control );
116 * @copydoc Toolkit::StyleManager::ApplyStyle
118 void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
121 * Get the state/style information for the given control
122 * @param[in] control The control to get state information for
123 * @return The style information (or empty ptr if not found)
125 const StylePtr GetRecordedStyle( Toolkit::Control control );
131 * @copydoc Toolkit::StyleManager::StyleChangeSignal
132 * This signal is sent after all the controls have been updated
133 * due to style change
135 Toolkit::StyleManager::StyleChangedSignalType& StyleChangedSignal();
138 * This signal is sent to the controls following a style change.
139 * It should not be exposed in the public API
141 Toolkit::StyleManager::StyleChangedSignalType& ControlStyleChangeSignal();
144 typedef std::vector<std::string> StringList;
147 * @brief Set the current theme. Called only once per event processing cycle.
148 * @param[in] themeFile The name of the theme file to read.
150 void SetTheme( const std::string& themeFile );
153 * @brief Internal helper method to read a file from file system.
154 * @param filename The name of the file to read.
155 * @param[out] stringOut The string to return the file in
157 * @param Return true if file was found
159 bool LoadFile(const std::string& filename, std::string& stringOut);
162 * @brief Create a new builder.
164 * @param[in] constants A map of constants to be used by the builder
166 * @return Return the newly created builder
168 Toolkit::Builder CreateBuilder( const Property::Map& constants );
171 * @brief Load a JSON file into given builder
173 * @param[in] builder The builder object to load the theme file
174 * @param[in] jsonFileName The name of the JSON file to load
175 * @return Return true if file was loaded
177 bool LoadJSON( Toolkit::Builder builder, const std::string& jsonFileName );
180 * @brief Apply a style to the control using the given builder
182 * @param[in] builder The builder to apply the style from
183 * @param[in] control The control to apply the style to
185 void ApplyStyle( Toolkit::Builder builder, Toolkit::Control control );
188 * Search for a builder in the cache
190 * @param[in] key The key the builder was cached under
191 * @return Return the cached builder if found or an empty builder object if not found
193 Toolkit::Builder FindCachedBuilder( const std::string& key );
196 * Store a given builder in the cache keyed to the given key
198 * @param[in] builder The builder object to store
199 * @param[in] key The key to store the builder under
201 void CacheBuilder( Toolkit::Builder builder, const std::string& key );
204 * Callback for when style monitor raises a signal
206 * @param[in] styleMonitor The style monitor object
207 * @param[in] styleChange The style change type
209 void StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange );
212 * Emit signals to controls first, app second
214 void EmitStyleChangeSignals( StyleChange::Type styleChange );
218 StyleManager(const StyleManager&);
220 StyleManager& operator=(const StyleManager& rhs);
224 // Map to store builders keyed by JSON file name
225 typedef std::map< std::string, Toolkit::Builder > BuilderMap;
227 Toolkit::Builder mThemeBuilder; ///< Builder for all default theme properties
228 StyleMonitor mStyleMonitor; ///< Style monitor handle
230 int mDefaultFontSize; ///< Logical size, not a point-size
231 std::string mDefaultFontFamily;
232 std::string mThemeFile; ///< The full path of the current theme file
234 Property::Map mThemeBuilderConstants; ///< Contants to give the theme builder
235 Property::Map mStyleBuilderConstants; ///< Constants specific to building styles
237 BuilderMap mBuilderCache; ///< Cache of builders keyed by JSON file name
239 Toolkit::Internal::FeedbackStyle* mFeedbackStyle; ///< Feedback style
242 Toolkit::StyleManager::StyleChangedSignalType mControlStyleChangeSignal; ///< Emitted when the style( theme/font ) changes for the controls to style themselves
243 Toolkit::StyleManager::StyleChangedSignalType mStyleChangedSignal; ///< Emitted after the controls have been styled
246 } // namespace Internal
248 inline Internal::StyleManager& GetImpl( Dali::Toolkit::StyleManager& obj )
250 DALI_ASSERT_ALWAYS( obj );
252 Dali::BaseObject& handle = obj.GetBaseObject();
254 return static_cast< Internal::StyleManager& >( handle );
257 inline const Internal::StyleManager& GetImpl( const Dali::Toolkit::StyleManager& obj )
259 DALI_ASSERT_ALWAYS( obj );
261 const Dali::BaseObject& handle = obj.GetBaseObject();
263 return static_cast< const Internal::StyleManager& >( handle );
266 } // namespace Toolkit
270 #endif // __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__