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 namespace Text
  29 {
  30
  31 /**
  32  * @brief An interface that the Text::Controller used for text selection functionality.
  33  */
  34 class SelectableControlInterface
  35 {
  36 public:
  37
  38   /**
  39    * @brief Virtual destructor.
  40    */
  41   virtual ~SelectableControlInterface() = default;
  42
  43   /**
  44    * @brief Called to set the selection postions in the texts.
  45    * @param start start selection position (pass NULL to ignore).
  46    * @param end end selection position (pass NULL to ignore).
  47    */
  48   virtual void SetTextSelectionRange(const uint32_t *start, const uint32_t *end) = 0;
  49
  50   /**
  51    * @brief Called to return the selection postions in the texts.
  52    * @return pair contains start and end positions.
  53    */
  54   virtual Uint32Pair GetTextSelectionRange() const = 0;
  55 };
  56
  57 } // namespace Text
  58
  59 } // namespace Toolkit
  60
  61 } // namespace Dali
  62
  63 #endif // DALI_TOOLKIT_TEXT_SELECTABLE_CONTROL_INTERFACE_H