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

   1 #ifndef __DALI_TOOLKIT_TEXT_CONTROL_INTERFACE_H__
   2 #define __DALI_TOOLKIT_TEXT_CONTROL_INTERFACE_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 namespace Dali
  22 {
  23
  24 class Actor;
  25
  26 namespace Toolkit
  27 {
  28
  29 namespace Text
  30 {
  31
  32 /**
  33  * @brief An interface that the Text::Controller uses to request a text relayout.
  34  */
  35 class ControlInterface
  36 {
  37 public:
  38
  39   /**
  40    * @brief Constructor.
  41    */
  42   ControlInterface();
  43
  44   /**
  45    * @brief Virtual destructor.
  46    */
  47   virtual ~ControlInterface();
  48
  49   /**
  50    * @brief Add a decoration.
  51    *
  52    * @param[in] decoration The actor displaying a decoration.
  53    * @param[in] needsClipping Whether the actor needs clipping.
  54    */
  55   virtual void AddDecoration( Actor& actor, bool needsClipping ) = 0;
  56
  57   /**
  58    * @brief Called to request a text relayout.
  59    */
  60   virtual void RequestTextRelayout() = 0;
  61
  62   /**
  63    * @brief Called to signal that text has been inserted or deleted.
  64    */
  65   virtual void TextChanged() = 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 } // namespace Text
  74
  75 } // namespace Toolkit
  76
  77 } // namespace Dali
  78
  79 #endif // __DALI_TOOLKIT_TEXT_CONTROL_INTERFACE_H__