adaptors/devel-api/adaptor-framework/color-controller.h

   1 #ifndef __DALI_COLOR_CONTROLLER_H__
   2 #define __DALI_COLOR_CONTROLLER_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 #include <dali/public-api/object/base-handle.h>
  24 #include <dali/public-api/math/vector4.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal DALI_INTERNAL
  30 {
  31 namespace Adaptor
  32 {
  33 class ColorController;
  34 }
  35 }
  36
  37 /**
  38  * Color controller currently caches the changeable color table which updates with the theme change
  39  *
  40  * It provides the functionality of retrieving a RGBA color by passing in the color code string.
  41  */
  42 class DALI_IMPORT_API ColorController : public BaseHandle
  43 {
  44 public:
  45
  46   /**
  47    * @brief Create an uninitialized ColorController handle.
  48    */
  49   ColorController();
  50
  51   /**
  52    * @brief Creates a copy of the handle.
  53    *
  54    * The copy will point to the same implementation as the original.
  55    * @param[in]  colorController  The Color Controller to copy from.
  56    */
  57   ColorController( const ColorController& colorController);
  58
  59   /**
  60    * @brief This assignment operator is required for (smart) pointer semantics.
  61    *
  62    * @param [in] rhs  A reference to the copied handle
  63    * @return A reference to this
  64    */
  65   ColorController& operator=(const ColorController& rhs);
  66
  67   /**
  68    * @brief Retrieve the initialized instance of the ColorController.
  69    *
  70    * @return Handle to ColorController.
  71    */
  72   static ColorController Get();
  73
  74   /**
  75    * @brief Destructor
  76    *
  77    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  78    */
  79   ~ColorController();
  80
  81   /**
  82    * @brief Retrieve the RGB value by given the color code.
  83    *
  84    * @param[in] colorCode The color code string.
  85    * @param[out] colorValue The RGBA color
  86    * @return true if the color code exists, otherwise false
  87    */
  88   bool RetrieveColor( const std::string& colorCode, Vector4& colorValue );
  89
  90   /**
  91     * @brief Retrieve the RGB values by given the color code.
  92     *
  93     * @param[in] colorCode The color code string.
  94     * @param[out] textColor The text color.
  95     * @param[out] textOutlineColor The text outline color.
  96     * @param[out] textShadowColor The text shadow color.
  97     * @return true if the color code exists, otherwise false
  98     */
  99   bool RetrieveColor( const std::string& colorCode , Vector4& textColor, Vector4& textOutlineColor, Vector4& textShadowColor);
 100
 101
 102 public: // Not intended for application developers
 103   /**
 104    * @brief This constructor is used internally to create a handle from an object pointer.
 105    * @param [in] colorController A pointer the internal color controller.
 106    */
 107   explicit DALI_INTERNAL ColorController(Internal::Adaptor::ColorController* colorController);
 108 };
 109
 110
 111 } //namespace Dali
 112
 113 #endif /* __DALI_COLOR_CONTROLLER_H__ */