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) 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 namespace Dali
  22 {
  23 namespace Toolkit
  24 {
  25 using Uint32Pair = std::pair<uint32_t, uint32_t>;
  26 using string     = std::string;
  27 namespace Text
  28 {
  29 /**
  30  * @brief An interface that the Text::Controller used for text selection functionality.
  31  */
  32 class SelectableControlInterface
  33 {
  34 public:
  35   /**
  36    * @brief Virtual destructor.
  37    */
  38   virtual ~SelectableControlInterface() = default;
  39
  40   /**
  41    * @brief Called to set the selection postions in the texts.
  42    * @param start start selection position (pass NULL to ignore).
  43    * @param end end selection position (pass NULL to ignore).
  44    */
  45   virtual void SetTextSelectionRange(const uint32_t* start, const uint32_t* end) = 0;
  46
  47   /**
  48    * @brief Called to return the selection postions in the texts.
  49    * @return pair contains start and end positions.
  50    */
  51   virtual Uint32Pair GetTextSelectionRange() const = 0;
  52
  53   /**
  54    * @brief Called to select the whole texts.
  55    */
  56   virtual void SelectWholeText() = 0;
  57
  58   /**
  59    * @brief Called to unselect the whole texts.
  60    */
  61   virtual void SelectNone() = 0;
  62
  63   /**
  64    * @brief Called to set the selection postions in the texts.
  65    * @param start start selection position.
  66    * @param end end selection position.
  67    */
  68   virtual void SelectText(const uint32_t start, const uint32_t end) = 0;
  69
  70   /**
  71    * @brief Retrive Selected text.
  72    * @return The seletced text.
  73    */
  74   virtual string GetSelectedText() const = 0;
  75
  76   /**
  77    * @brief Called when the selection has been changed.
  78    *
  79    * @param oldStart the selection handles start position before the change.
  80    * @param oldEnd   the selection handles end position before the change.
  81    * @param newStart the selection handles start position after the change.
  82    * @param newEnd   the selection handles end position after the change.
  83    */
  84   virtual void SelectionChanged(uint32_t oldStart, uint32_t oldEnd, uint32_t newStart, uint32_t newEnd) = 0;
  85 };
  86
  87 } // namespace Text
  88
  89 } // namespace Toolkit
  90
  91 } // namespace Dali
  92
  93 #endif // DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H