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

   1 #ifndef DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H
   2 #define DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H
   3
   4 /*
   5  * Copyright (c) 2020 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 namespace Toolkit
  25 {
  26
  27 using  Uint32Pair = std::pair<uint32_t,uint32_t>;
  28 using  string = std::string;
  29 namespace Text
  30 {
  31
  32 /**
  33  * @brief An interface that the Text::Controller used for text selection functionality.
  34  */
  35 class SelectableControlInterface
  36 {
  37 public:
  38
  39   /**
  40    * @brief Virtual destructor.
  41    */
  42   virtual ~SelectableControlInterface() = default;
  43
  44   /**
  45    * @brief Called to set the selection postions in the texts.
  46    * @param start start selection position (pass NULL to ignore).
  47    * @param end end selection position (pass NULL to ignore).
  48    */
  49   virtual void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) = 0;
  50
  51   /**
  52    * @brief Called to return the selection postions in the texts.
  53    * @return pair contains start and end positions.
  54    */
  55   virtual Uint32Pair GetTextSelectionRange() const = 0;
  56
  57   /**
  58    * @brief Called to select the whole texts.
  59    */
  60   virtual void SelectWholeText() = 0;
  61
  62   /**
  63    * @brief Called to unselect the whole texts.
  64    */
  65   virtual void SelectNone() = 0;
  66
  67   /**
  68    * @brief Retrive Selected text.
  69    * @return The seletced text.
  70    */
  71   virtual string GetSelectedText() const = 0;
  72 };
  73
  74 } // namespace Text
  75
  76 } // namespace Toolkit
  77
  78 } // namespace Dali
  79
  80 #endif // DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H