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) 2016 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
  27 class Actor;
  28
  29 namespace Toolkit
  30 {
  31
  32 namespace Text
  33 {
  34
  35 /**
  36  * @brief An interface that the Text::Controller uses to notify about text changes and add decoration to the text control.
  37  */
  38 class EditableControlInterface
  39 {
  40 public:
  41
  42   /**
  43    * @brief Virtual destructor.
  44    */
  45   virtual ~EditableControlInterface()
  46   {}
  47
  48   /**
  49    * @brief Called to signal that text has been inserted.
  50    */
  51   virtual void TextInserted( unsigned int position, unsigned int length, const std::string &content ) = 0;
  52
  53   /**
  54    * @brief Called to signal that text has been deleted.
  55    */
  56   virtual void TextDeleted( unsigned int position, unsigned int length, const std::string &content ) = 0;
  57
  58   /**
  59    * @brief Called to signal that caret (cursor position) has been moved.
  60    */
  61   virtual void CaretMoved( unsigned int position ) = 0;
  62
  63   /**
  64    * @brief Called to signal that text has been inserted or deleted.
  65    */
  66   virtual void TextChanged() = 0;
  67
  68   /**
  69    * @brief Called when the number of characters to be inserted exceeds the maximum limit
  70    */
  71   virtual void MaxLengthReached() = 0;
  72
  73   /**
  74    * @brief Called to signal that input style has been changed.
  75    *
  76    * @param[in] inputStyleMask Mask with the bits of the input style that has changed.
  77    */
  78   virtual void InputStyleChanged( InputStyle::Mask inputStyleMask ) = 0;
  79
  80   /**
  81    * @brief Add a decoration.
  82    *
  83    * @param[in] decoration The actor displaying a decoration.
  84    * @param[in] needsClipping Whether the actor needs clipping.
  85    */
  86   virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
  87
  88   /**
  89    * @brief Editable status (on/off).
  90    *
  91    * @return true if it can be edit, else false.
  92    */
  93   virtual bool IsEditable() const = 0;
  94
  95   /**
  96    * @brief Change the editable status (on/off) .
  97    *
  98    * @param[in] editable The editable status.
  99    */
 100   virtual void SetEditable( bool editable ) = 0;
 101 };
 102
 103 } // namespace Text
 104
 105 } // namespace Toolkit
 106
 107 } // namespace Dali
 108
 109 #endif // DALI_TOOLKIT_TEXT_EDITABLE_CONTROL_INTERFACE_H