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/devel-api/styling/style-manager.h>
  31 #include <dali-toolkit/devel-api/builder/builder.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 class FeedbackStyle;
  43
  44 /**
  45  * @copydoc Toolkit::StyleManager
  46  */
  47 class StyleManager : public Dali::BaseObject, public ConnectionTracker
  48 {
  49 public:
  50
  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   /**
  64    * @copydoc Toolkit::StyleManager::SetOrientationValue
  65    */
  66   void SetOrientationValue( int orientation );
  67
  68   /**
  69    * @copydoc Toolkit::StyleManager::GetOrientationValue
  70    */
  71   int GetOrientationValue();
  72
  73   /**
  74    * @copydoc Toolkit::StyleManager::SetOrientation( Orientation orientation )
  75    */
  76   void SetOrientation( Orientation orientation );
  77
  78   /**
  79    * @copydoc Toolkit::StyleManager::GetOrientation
  80    */
  81   Orientation GetOrientation();
  82
  83   /**
  84    * @copydoc Toolkit::StyleManager::SetStyleConstant
  85    */
  86   void SetStyleConstant( const std::string& key, const Property::Value& value );
  87
  88   /**
  89    * @copydoc Toolkit::StyleManager::GetStyleConstant
  90    */
  91   bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
  92
  93   /**
  94    * @copydoc Toolkit::StyleManager::RequestThemeChange
  95    */
  96   void RequestThemeChange( const std::string& themeFile );
  97
  98   /**
  99    * @copydoc Toolkit::StyleManager::RequestDefaultTheme
 100    */
 101   void RequestDefaultTheme();
 102
 103   /**
 104    * Determine if a theme change has been requested
 105    * @return Whether a theme request is pending
 106    */
 107   bool IsThemeRequestPending();
 108
 109   /**
 110    * @brief Apply the theme style to a control.
 111    *
 112    * @param[in] control The control to apply style.
 113    */
 114   void ApplyThemeStyle( Toolkit::Control control );
 115
 116   /**
 117    * @brief Apply the theme style to a control at initialization.
 118    *
 119    * @param[in] control The control to apply style.
 120    */
 121   void ApplyThemeStyleAtInit( Toolkit::Control control );
 122
 123   /**
 124    * @copydoc Toolkit::StyleManager::ApplyStyle
 125    */
 126   void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
 127
 128 public:
 129   // SIGNALS
 130
 131   /**
 132    * @copydoc Toolkit::StyleManager::StyleChangeSignal
 133    */
 134   Toolkit::StyleManager::StyleChangeSignalType& StyleChangeSignal();
 135
 136 protected:
 137
 138   /**
 139    * @brief Destructor
 140    */
 141   virtual ~StyleManager();
 142
 143
 144 public:
 145
 146   /**
 147    * @brief Set the current theme. Called only once per event processing cycle.
 148    */
 149   void SetTheme();
 150
 151 private:
 152
 153   typedef std::vector<std::string> StringList;
 154
 155   /**
 156    * @brief Internal helper method to read a file from file system.
 157    * @param filename The name of the file to read.
 158    * @param[out] stringOut The string to return the file in
 159    *
 160    * @param Return true if file was found
 161    */
 162   bool LoadFile(const std::string& filename, std::string& stringOut);
 163
 164   /**
 165    * @brief Create a new builder.
 166    *
 167    * @param[in] constants A map of constants to be used by the builder
 168    *
 169    * @return Return the newly created builder
 170    */
 171   Toolkit::Builder CreateBuilder( const Property::Map& constants );
 172
 173   /**
 174    * @brief Load a JSON file into given builder
 175    *
 176    * @param[in] builder The builder object to load the theme file
 177    * @param[in] jsonFileName The name of the JSON file to load
 178    * @return Return true if file was loaded
 179    */
 180   bool LoadJSON( Toolkit::Builder builder, const std::string& jsonFileName );
 181
 182   /**
 183    * @brief Collect qualifiers (e.g. Landscape, portrait etc) for a given style
 184    *
 185    * @param[in,out] qualifiersOut The list to populate with qualifiers
 186    */
 187   void CollectQualifiers( StringList& qualifiersOut );
 188
 189   /**
 190    * @brief Construct a qualified style name out of qualifiers
 191    *
 192    * A qualifed style name will be in the format: style-qualifier0-qualifier1-qualifierN
 193    *
 194    * @param[in] styleName The root name of the style
 195    * @param[in] qualifiers List of qualifier names
 196    * @param[out] qualifiedStyleOut The qualified style name
 197    */
 198   void BuildQualifiedStyleName( const std::string& styleName, const StringList& qualifiers, std::string& qualifiedStyleOut );
 199
 200   /**
 201    * @brief Apply a style to the control using the given builder
 202    *
 203    * @param[in] builder The builder to apply the style from
 204    * @param[in] control The control to apply the style to
 205    */
 206   void ApplyStyle( Toolkit::Builder builder, Toolkit::Control control );
 207
 208   /**
 209    * @brief Callback for orientation changes
 210    *
 211    * @param[in] orientation The orientation object
 212    */
 213   void OnOrientationChanged( Orientation orientation );
 214
 215   /**
 216    * Search for a builder in the cache
 217    *
 218    * @param[in] key The key the builder was cached under
 219    * @return Return the cached builder if found or an empty builder object if not found
 220    */
 221   Toolkit::Builder FindCachedBuilder( const std::string& key );
 222
 223   /**
 224    * Store a given builder in the cache keyed to the given key
 225    *
 226    * @param[in] builder The builder object to store
 227    * @param[in] key The key to store the builder under
 228    */
 229   void CacheBuilder( Toolkit::Builder builder, const std::string& key );
 230
 231   /**
 232    * Callback for when style monitor raises a signal
 233    *
 234    * @param[in] styleMonitor The style monitor object
 235    * @param[in] styleChange The style change type
 236    */
 237   void StyleMonitorChange( StyleMonitor styleMonitor, StyleChange::Type styleChange );
 238
 239   // Undefined
 240   StyleManager(const StyleManager&);
 241
 242   StyleManager& operator=(const StyleManager& rhs);
 243
 244 private:
 245
 246   // Map to store builders keyed by JSON file name
 247   typedef std::map< std::string, Toolkit::Builder > BuilderMap;
 248
 249   Toolkit::Builder mThemeBuilder;     ///< Builder for all default theme properties
 250   StyleMonitor mStyleMonitor;         ///< Style monitor handle
 251
 252   Orientation mOrientation;           ///< Handle to application orientation object
 253   int mOrientationDegrees;            ///< Directly set value of orientation
 254
 255   int mDefaultFontSize;               ///< Logical size, not a point-size
 256
 257   std::string mThemeFile;             ///< The full path of the current theme file
 258
 259   Property::Map mThemeBuilderConstants;   ///< Contants to give the theme builder
 260   Property::Map mStyleBuilderConstants;   ///< Constants specific to building styles
 261
 262   BuilderMap mBuilderCache;           ///< Cache of builders keyed by JSON file name
 263
 264   Toolkit::Internal::FeedbackStyle* mFeedbackStyle; ///< Feedback style
 265
 266   // Signals
 267   Toolkit::StyleManager::StyleChangeSignalType       mStyleChangeSignal;         ///< Emitted when the style( theme/font ) changes
 268 };
 269
 270 } // namespace Internal
 271
 272 inline Internal::StyleManager& GetImpl( Dali::Toolkit::StyleManager& obj )
 273 {
 274   DALI_ASSERT_ALWAYS( obj );
 275
 276   Dali::BaseObject& handle = obj.GetBaseObject();
 277
 278   return static_cast< Internal::StyleManager& >( handle );
 279 }
 280
 281 inline const Internal::StyleManager& GetImpl( const Dali::Toolkit::StyleManager& obj )
 282 {
 283   DALI_ASSERT_ALWAYS( obj );
 284
 285   const Dali::BaseObject& handle = obj.GetBaseObject();
 286
 287   return static_cast< const Internal::StyleManager& >( handle );
 288 }
 289
 290 } // namespace Toolkit
 291
 292 } // namespace Dali
 293
 294 #endif // __DALI_TOOLKIT_INTERNAL_STYLE_MANAGER_H__
 295