dali-toolkit/internal/styling/style-manager-impl.h

   1 #ifndef __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__
   2 #define __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <string>
  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>
  28
  29 // INTERNAL INCLUDES
  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>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Toolkit
  38 {
  39
  40 namespace Internal
  41 {
  42
  43 class FeedbackStyle;
  44
  45 /**
  46  * @copydoc Toolkit::StyleManager
  47  */
  48 class StyleManager : public Dali::BaseObject, public ConnectionTracker
  49 {
  50 public:
  51   /**
  52    * Singleton access
  53    *
  54    * @return The StyleManager object
  55    */
  56   static Toolkit::StyleManager Get();
  57
  58   /**
  59    * Construct a new StyleManager.
  60    */
  61   StyleManager();
  62
  63 protected:
  64   /**
  65    * @brief Destructor
  66    */
  67   virtual ~StyleManager();
  68
  69 public: // Public API
  70
  71   /**
  72    * @copydoc Toolkit::StyleManager::ApplyTheme
  73    */
  74   void ApplyTheme( const std::string& themeFile );
  75
  76   /**
  77    * @copydoc Toolkit::StyleManager::ApplyDefaultTheme
  78    */
  79   void ApplyDefaultTheme();
  80
  81   /**
  82    * @copydoc Toolkit::StyleManager::GetDefaultFontFamily
  83    */
  84   const std::string& GetDefaultFontFamily() const;
  85
  86   /**
  87    * @copydoc Toolkit::StyleManager::SetStyleConstant
  88    */
  89   void SetStyleConstant( const std::string& key, const Property::Value& value );
  90
  91   /**
  92    * @copydoc Toolkit::StyleManager::GetStyleConstant
  93    */
  94   bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
  95
  96   /**
  97    * @brief Apply the theme style to a control.
  98    *
  99    * @param[in] control The control to apply style.
 100    */
 101   void ApplyThemeStyle( Toolkit::Control control );
 102
 103   /**
 104    * @brief Apply the theme style to a control at initialization.
 105    *
 106    * @param[in] control The control to apply style.
 107    */
 108   void ApplyThemeStyleAtInit( Toolkit::Control control );
 109
 110   /**
 111    * @copydoc Toolkit::StyleManager::ApplyStyle
 112    */
 113   void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
 114
 115   /**
 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)
 119    */
 120   const StylePtr GetRecordedStyle( Toolkit::Control control );
 121
 122 public:
 123   // SIGNALS
 124
 125   /**
 126    * @copydoc Toolkit::StyleManager::StyleChangeSignal
 127    * This signal is sent after all the controls have been updated
 128    * due to style change
 129    */
 130   Toolkit::StyleManager::StyleChangedSignalType& StyleChangedSignal();
 131
 132   /**
 133    * This signal is sent to the controls following a style change.
 134    * It should not be exposed in the public API
 135    */
 136   Toolkit::StyleManager::StyleChangedSignalType& ControlStyleChangeSignal();
 137
 138 private:
 139   typedef std::vector<std::string> StringList;
 140
 141   /**
 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.
 144    */
 145   void SetTheme( const std::string& themeFile );
 146
 147   /**
 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
 151    *
 152    * @param Return true if file was found
 153    */
 154   bool LoadFile(const std::string& filename, std::string& stringOut);
 155
 156   /**
 157    * @brief Create a new builder.
 158    *
 159    * @param[in] constants A map of constants to be used by the builder
 160    *
 161    * @return Return the newly created builder
 162    */
 163   Toolkit::Builder CreateBuilder( const Property::Map& constants );
 164
 165   /**
 166    * @brief Load a JSON file into given builder
 167    *
 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
 171    */
 172   bool LoadJSON( Toolkit::Builder builder, const std::string& jsonFileName );
 173
 174   /**
 175    * @brief Apply a style to the control using the given builder
 176    *
 177    * @param[in] builder The builder to apply the style from
 178    * @param[in] control The control to apply the style to
 179    */
 180   void ApplyStyle( Toolkit::Builder builder, Toolkit::Control control );
 181
 182   /**
 183    * Search for a builder in the cache
 184    *
 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
 187    */
 188   Toolkit::Builder FindCachedBuilder( const std::string& key );
 189
 190   /**
 191    * Store a given builder in the cache keyed to the given key
 192    *
 193    * @param[in] builder The builder object to store
 194    * @param[in] key The key to store the builder under
 195    */
 196   void CacheBuilder( Toolkit::Builder builder, const std::string& key );
 197
 198   /**
 199    * Callback for when style monitor raises a signal
 200    *
 201    * @param[in] styleMonitor The style monitor object
 202    * @param[in] styleChange The style change type
 203    */
 204   void StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange );
 205
 206   /**
 207    * Emit signals to controls first, app second
 208    */
 209   void EmitStyleChangeSignals( StyleChange::Type styleChange );
 210
 211
 212   // Undefined
 213   StyleManager(const StyleManager&);
 214
 215   StyleManager& operator=(const StyleManager& rhs);
 216
 217 private:
 218
 219   // Map to store builders keyed by JSON file name
 220   typedef std::map< std::string, Toolkit::Builder > BuilderMap;
 221
 222   Toolkit::Builder mThemeBuilder;     ///< Builder for all default theme properties
 223   StyleMonitor mStyleMonitor;         ///< Style monitor handle
 224
 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
 228
 229   Property::Map mThemeBuilderConstants;   ///< Contants to give the theme builder
 230   Property::Map mStyleBuilderConstants;   ///< Constants specific to building styles
 231
 232   BuilderMap mBuilderCache;           ///< Cache of builders keyed by JSON file name
 233
 234   Toolkit::Internal::FeedbackStyle* mFeedbackStyle; ///< Feedback style
 235
 236   // Signals
 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
 239 };
 240
 241 } // namespace Internal
 242
 243 inline Internal::StyleManager& GetImpl( Dali::Toolkit::StyleManager& obj )
 244 {
 245   DALI_ASSERT_ALWAYS( obj );
 246
 247   Dali::BaseObject& handle = obj.GetBaseObject();
 248
 249   return static_cast< Internal::StyleManager& >( handle );
 250 }
 251
 252 inline const Internal::StyleManager& GetImpl( const Dali::Toolkit::StyleManager& obj )
 253 {
 254   DALI_ASSERT_ALWAYS( obj );
 255
 256   const Dali::BaseObject& handle = obj.GetBaseObject();
 257
 258   return static_cast< const Internal::StyleManager& >( handle );
 259 }
 260
 261 } // namespace Toolkit
 262
 263 } // namespace Dali
 264
 265 #endif // __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__