1 #ifndef DALI_COLOR_CONTROLLER_H
2 #define DALI_COLOR_CONTROLLER_H
5 * Copyright (c) 2020 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.
22 #include <dali/public-api/math/vector4.h>
23 #include <dali/public-api/object/base-handle.h>
27 #include <dali/public-api/dali-adaptor-common.h>
31 namespace Internal DALI_INTERNAL
35 class ColorController;
38 } // namespace DALI_INTERNAL
41 * Color controller currently caches the changeable color table which updates with the theme change
43 * It provides the functionality of retrieving a RGBA color by passing in the color code string.
45 class DALI_ADAPTOR_API ColorController : public BaseHandle
49 * @brief Create an uninitialized ColorController handle.
54 * @brief Creates a copy of the handle.
56 * The copy will point to the same implementation as the original.
57 * @param[in] colorController The Color Controller to copy from.
59 ColorController(const ColorController& colorController);
62 * @brief This assignment operator is required for (smart) pointer semantics.
64 * @param [in] rhs A reference to the copied handle
65 * @return A reference to this
67 ColorController& operator=(const ColorController& rhs);
70 * @brief Retrieve the initialized instance of the ColorController.
72 * @return Handle to ColorController.
74 static ColorController Get();
79 * This is non-virtual since derived Handle types must not contain data or virtual methods.
84 * @brief Retrieve the RGBA value by given the color code.
86 * @param[in] colorCode The color code string.
87 * @param[out] colorValue The RGBA color
88 * @return true if the color code exists, otherwise false
90 bool RetrieveColor(const std::string& colorCode, Vector4& colorValue);
93 * @brief Retrieve the RGBA values by given the color code.
95 * @param[in] colorCode The color code string.
96 * @param[out] textColor The text color.
97 * @param[out] textOutlineColor The text outline color.
98 * @param[out] textShadowColor The text shadow color.
99 * @return true if the color code exists, otherwise false
101 bool RetrieveColor(const std::string& colorCode, Vector4& textColor, Vector4& textOutlineColor, Vector4& textShadowColor);
103 public: // Not intended for application developers
105 * @brief This constructor is used internally to create a handle from an object pointer.
106 * @param [in] colorController A pointer the internal color controller.
108 explicit DALI_INTERNAL ColorController(Internal::Adaptor::ColorController* colorController);
113 #endif // DALI_COLOR_CONTROLLER_H