1 #ifndef DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
2 #define DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
5 * Copyright (c) 2016 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>
36 * @brief An interface that the Text::Controller uses to notify about text changes and add decoration to the text control.
38 class EditableControlInterface
43 * @brief Virtual destructor.
45 virtual ~EditableControlInterface()
49 * @brief Called to signal that text has been inserted.
51 virtual void TextInserted( unsigned int position, unsigned int length, const std::string &content ) = 0;
54 * @brief Called to signal that text has been deleted.
56 virtual void TextDeleted( unsigned int position, unsigned int length, const std::string &content ) = 0;
59 * @brief Called to signal that caret (cursor position) has been moved.
61 virtual void CaretMoved( unsigned int position ) = 0;
64 * @brief Called to signal that text has been inserted or deleted.
66 virtual void TextChanged() = 0;
69 * @brief Called when the number of characters to be inserted exceeds the maximum limit
71 virtual void MaxLengthReached() = 0;
74 * @brief Called to signal that input style has been changed.
76 * @param[in] inputStyleMask Mask with the bits of the input style that has changed.
78 virtual void InputStyleChanged( InputStyle::Mask inputStyleMask ) = 0;
81 * @brief Add a decoration.
83 * @param[in] decoration The actor displaying a decoration.
84 * @param[in] needsClipping Whether the actor needs clipping.
86 virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
89 * @brief Editable status (on/off).
91 * @return true if it can be edit, else false.
93 virtual bool IsEditable() const = 0;
96 * @brief Change the editable status (on/off) .
98 * @param[in] editable The editable status.
100 virtual void SetEditable( bool editable ) = 0;
105 } // namespace Toolkit
109 #endif // DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H