dali-toolkit/internal/text/text-editable-control-interface.h

   1 #ifndef DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
   2 #define DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/internal/text/input-style.h>
  23
  24 namespace Dali
  25 {
  26 class Actor;
  27
  28 namespace Toolkit
  29 {
  30 namespace Text
  31 {
  32 /**
  33  * @brief An interface that the Text::Controller uses to notify about text changes and add decoration to the text control.
  34  */
  35 class EditableControlInterface
  36 {
  37 public:
  38   /**
  39    * @brief Virtual destructor.
  40    */
  41   virtual ~EditableControlInterface()
  42   {
  43   }
  44
  45   /**
  46    * @brief Called to signal that text has been inserted.
  47    */
  48   virtual void TextInserted(unsigned int position, unsigned int length, const std::string& content) = 0;
  49
  50   /**
  51    * @brief Called to signal that text has been deleted.
  52    */
  53   virtual void TextDeleted(unsigned int position, unsigned int length, const std::string& content) = 0;
  54
  55   /**
  56    * @brief Called to signal that caret (cursor position) has been moved.
  57    */
  58   virtual void CaretMoved(unsigned int position) = 0;
  59
  60   /**
  61    * @brief Called to signal that text has been inserted or deleted.
  62    *
  63    * @param[in] immediate If true, it immediately emits the signal, if false, only emits once the signal when OnRelayout() is called next time.
  64    */
  65   virtual void TextChanged(bool immediate) = 0;
  66
  67   /**
  68    * @brief Called when the number of characters to be inserted exceeds the maximum limit
  69    */
  70   virtual void MaxLengthReached() = 0;
  71
  72   /**
  73    * @brief Called to signal that input style has been changed.
  74    *
  75    * @param[in] inputStyleMask Mask with the bits of the input style that has changed.
  76    */
  77   virtual void InputStyleChanged(InputStyle::Mask inputStyleMask) = 0;
  78
  79   /**
  80    * @brief Add a decoration.
  81    *
  82    * @param[in] decoration The actor displaying a decoration.
  83    * @param[in] needsClipping Whether the actor needs clipping.
  84    */
  85   virtual void AddDecoration(Actor& actor, bool needsClipping) = 0;
  86
  87   /**
  88    * @brief Editable status (on/off).
  89    *
  90    * @return true if it can be edit, else false.
  91    */
  92   virtual bool IsEditable() const = 0;
  93
  94   /**
  95    * @brief Change the editable status (on/off) .
  96    *
  97    * @param[in] editable The editable status.
  98    */
  99   virtual void SetEditable(bool editable) = 0;
 100 };
 101
 102 } // namespace Text
 103
 104 } // namespace Toolkit
 105
 106 } // namespace Dali
 107
 108 #endif // DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H