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.
48 virtual void TextInserted(unsigned int position, unsigned int length, const std::string& content) = 0;
51 * @brief Called to signal that text has been deleted.
53 virtual void TextDeleted(unsigned int position, unsigned int length, const std::string& content) = 0;
56 * @brief Called to signal that caret (cursor position) has been moved.
58 virtual void CaretMoved(unsigned int position) = 0;
61 * @brief Called to signal that text has been inserted or deleted.
63 virtual void TextChanged() = 0;
66 * @brief Called when the number of characters to be inserted exceeds the maximum limit
68 virtual void MaxLengthReached() = 0;
71 * @brief Called to signal that input style has been changed.
73 * @param[in] inputStyleMask Mask with the bits of the input style that has changed.
75 virtual void InputStyleChanged(InputStyle::Mask inputStyleMask) = 0;
78 * @brief Add a decoration.
80 * @param[in] decoration The actor displaying a decoration.
81 * @param[in] needsClipping Whether the actor needs clipping.
83 virtual void AddDecoration(Actor& actor, bool needsClipping) = 0;
86 * @brief Editable status (on/off).
88 * @return true if it can be edit, else false.
90 virtual bool IsEditable() const = 0;
93 * @brief Change the editable status (on/off) .
95 * @param[in] editable The editable status.
97 virtual void SetEditable(bool editable) = 0;
102 } // namespace Toolkit
106 #endif // DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H