1 #ifndef DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
5 * Copyright (c) 2021 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-toolkit/internal/text/input-style.h>
33 * @brief An interface that the Text::Controller uses to notify about text changes and add decoration to the text control.
35 class EditableControlInterface
39 * @brief Virtual destructor.
41 virtual ~EditableControlInterface()
46 * @brief Called to signal that text has been inserted or deleted.
48 * @param[in] immediate If true, it immediately emits the signal, if false, only emits once the signal when OnRelayout() is called next time.
50 virtual void TextChanged(bool immediate) = 0;
53 * @brief Called when the number of characters to be inserted exceeds the maximum limit
55 virtual void MaxLengthReached() = 0;
58 * @brief Called to signal that input style has been changed.
60 * @param[in] inputStyleMask Mask with the bits of the input style that has changed.
62 virtual void InputStyleChanged(InputStyle::Mask inputStyleMask) = 0;
65 * @brief Add a decoration.
67 * @param[in] decoration The actor displaying a decoration.
68 * @param[in] needsClipping Whether the actor needs clipping.
70 virtual void AddDecoration(Actor& actor, bool needsClipping) = 0;
73 * @brief Gets the color of the control.
75 * @param[out] The color of the control.
77 virtual void GetControlBackgroundColor(Vector4& color) const = 0;
80 * @brief Editable status (on/off).
82 * @return true if it can be edit, else false.
84 virtual bool IsEditable() const = 0;
87 * @brief Change the editable status (on/off) .
89 * @param[in] editable The editable status.
91 virtual void SetEditable(bool editable) = 0;
96 } // namespace Toolkit
100 #endif // DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H