dali/devel-api/adaptor-framework/style-monitor.h

   1 #ifndef DALI_STYLE_MONITOR_H
   2 #define DALI_STYLE_MONITOR_H
   3
   4 /*
   5  * Copyright (c) 2022 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
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 #include <dali/public-api/object/base-handle.h>
  25 #include <dali/public-api/signals/dali-signal.h>
  26
  27 // INTERNAL INCLUDES
  28 #include <dali/public-api/adaptor-framework/style-change.h>
  29
  30 namespace Dali
  31 {
  32 namespace Internal DALI_INTERNAL
  33 {
  34 namespace Adaptor
  35 {
  36 class StyleMonitor;
  37 }
  38 } // namespace DALI_INTERNAL
  39
  40 /**
  41  * @brief Monitors the platform for style changes.
  42  *
  43  * This is a handle to the adaptor's style monitor which holds the platform's style information.
  44  * It provides a signal when any aspect of the default style changes on the device.
  45  * @see Adaptor::GetStyleMonitor
  46  */
  47 class DALI_ADAPTOR_API StyleMonitor : public BaseHandle
  48 {
  49 public:                                                                        // Typedefs
  50   typedef Signal<void(StyleMonitor, StyleChange::Type)> StyleChangeSignalType; ///< StyleChange Signal type
  51
  52 public: // Creation & Destruction
  53   /**
  54    * @brief Create an uninitialized StyleMonitor handle.
  55    *
  56    * Tthis can be set by retrieving the style monitor from the Adaptor
  57    * or the Application classes.  Calling member functions when
  58    * uninitialized is not allowed.
  59    */
  60   StyleMonitor();
  61
  62   /**
  63    * @brief Creates a copy of the handle.
  64    *
  65    * The copy will point to the same implementation as the original.
  66    * @param[in]  monitor  The Style Monitor to copy from.
  67    */
  68   StyleMonitor(const StyleMonitor& monitor);
  69
  70   /**
  71    * @brief Assignment operator.
  72    *
  73    * The handle points to the same implementation as the one being copied from.
  74    * @param[in]  monitor  The Style Monitor to copy from.
  75    * @return reference to this object
  76    */
  77   StyleMonitor& operator=(const StyleMonitor& monitor);
  78
  79   /**
  80    * @brief Creates a move of the handle.
  81    *
  82    * The move will point to the same implementation as the original.
  83    * @param[in]  monitor  The Style Monitor to move from.
  84    */
  85   StyleMonitor(StyleMonitor&& monitor);
  86
  87   /**
  88    * @brief Move assignment operator.
  89    *
  90    * The handle points to the same implementation as the one being moved from.
  91    * @param[in]  monitor  The Style Monitor to move from.
  92    * @return reference to this object
  93    */
  94   StyleMonitor& operator=(StyleMonitor&& monitor);
  95
  96   /**
  97    * @brief Retrieve the initialized instance of the StyleMonitor.
  98    * @return Handle to StyleMonitor.
  99    */
 100   static StyleMonitor Get();
 101
 102   /**
 103    * @brief Destructor
 104    *
 105    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 106    */
 107   ~StyleMonitor();
 108
 109   /**
 110    * @brief Downcast an Object handle to StyleMonitor handle.
 111    *
 112    * If handle points to a StyleMonitor object the downcast produces a
 113    * valid handle. If not the returned handle is left uninitialized.
 114    *
 115    * @param[in] handle to An object @return handle to a Timer object
 116    * or an uninitialized handle
 117    */
 118   static StyleMonitor DownCast(BaseHandle handle);
 119
 120 public: // Style Information
 121   /**
 122    * @brief Retrieves the default font family.
 123    * @return The default font family.
 124    */
 125   std::string GetDefaultFontFamily() const;
 126
 127   /**
 128    * @brief Retrieves the default font style.
 129    * @return The default font style.
 130    */
 131   std::string GetDefaultFontStyle() const;
 132
 133   /**
 134    * @brief Retrieves the default font size.
 135    *
 136    * This is an logical size, which is mapped to a UI Control specific point-size in stylesheets.
 137    * For example if zero the smallest size, this could potentially map to TextLabel point-size 8.
 138    * @return The default font size, or a negative value if not set.
 139    */
 140   int GetDefaultFontSize() const;
 141
 142   /**
 143    * @brief Retrieves the user defined Theme.
 144    * @return The user defined Theme.
 145    */
 146   const std::string& GetTheme() const;
 147
 148   /**
 149    * @brief Sets an user defined Theme.
 150    * @param[in] themeFilePath Path of the user defined theme
 151    */
 152   void SetTheme(const std::string& themeFilePath);
 153
 154   /**
 155    * @brief Utility to load a theme file
 156    * @param filename of the theme
 157    * @param output to write the contents to
 158    * @return true if the load is successful
 159    */
 160   bool LoadThemeFile(const std::string& filename, std::string& output);
 161
 162 public: // Signals
 163   /**
 164    * @brief This signal is emitted whenever the style changes on the device.
 165    *
 166    * A callback of the following type may be connected:
 167    * @code
 168    *   void YourCallbackName(StyleMonitor styleMonitor, StyleChange change);
 169    * @endcode
 170    * @return The signal to connect to.
 171    */
 172   StyleChangeSignalType& StyleChangeSignal();
 173
 174 public: // Not intended for application developers
 175   /**
 176    * @brief This constructor is used internally to create a handle from an object pointer.
 177    * @param [in] styleMonitor A pointer the internal style monitor.
 178    */
 179   explicit DALI_INTERNAL StyleMonitor(Internal::Adaptor::StyleMonitor* styleMonitor);
 180 };
 181
 182 } // namespace Dali
 183
 184 #endif // DALI_STYLE_MONITOR_H