1 #ifndef __DALI_COLOR_CONTROLLER_H__
2 #define __DALI_COLOR_CONTROLLER_H__
5 * Copyright (c) 2015 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.
23 #include <dali/public-api/object/base-handle.h>
24 #include <dali/public-api/math/vector4.h>
29 namespace Internal DALI_INTERNAL
33 class ColorController;
38 * Color controller currently caches the changeable color table which updates with the theme change
40 * It provides the functionality of retrieving a RGBA color by passing in the color code string.
42 class DALI_IMPORT_API ColorController : public BaseHandle
47 * @brief Create an uninitialized ColorController handle.
52 * @brief Creates a copy of the handle.
54 * The copy will point to the same implementation as the original.
55 * @param[in] colorController The Color Controller to copy from.
57 ColorController( const ColorController& colorController);
60 * @brief This assignment operator is required for (smart) pointer semantics.
62 * @param [in] rhs A reference to the copied handle
63 * @return A reference to this
65 ColorController& operator=(const ColorController& rhs);
68 * @brief Retrieve the initialized instance of the ColorController.
70 * @return Handle to ColorController.
72 static ColorController Get();
77 * This is non-virtual since derived Handle types must not contain data or virtual methods.
82 * @brief Retrieve the RGB value by given the color code.
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
88 bool RetrieveColor( const std::string& colorCode, Vector4& colorValue );
91 * @brief Retrieve the RGB values by given the color code.
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
99 bool RetrieveColor( const std::string& colorCode , Vector4& textColor, Vector4& textOutlineColor, Vector4& textShadowColor);
102 public: // Not intended for application developers
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.
107 explicit DALI_INTERNAL ColorController(Internal::Adaptor::ColorController* colorController);
113 #endif /* __DALI_COLOR_CONTROLLER_H__ */