dali/internal/accessibility/bridge/bridge-text.h

   1 #ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_H
   2 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_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 // INTERNAL INCLUDES
  22 #include <dali/internal/accessibility/bridge/bridge-base.h>
  23
  24 /**
  25  * @brief The BridgeText class is to correspond with Dali::Accessibility::Text.
  26  */
  27 class BridgeText : public virtual BridgeBase
  28 {
  29 protected:
  30   BridgeText() = default;
  31
  32   /**
  33    * @brief Registers Text functions to dbus interfaces.
  34    */
  35   void RegisterInterfaces();
  36
  37   /**
  38    * @brief Returns the Text object of the currently executed DBus method call.
  39    *
  40    * @return The Text object
  41    */
  42   Dali::Accessibility::Text* FindSelf() const;
  43
  44 public:
  45   /**
  46    * @copydoc Dali::Accessibility::Text::GetText()
  47    */
  48   DBus::ValueOrError<std::string> GetText(int startOffset, int endOffset);
  49
  50   /**
  51    * @copydoc Dali::Accessibility::Text::GetCharacterCount()
  52    */
  53   DBus::ValueOrError<int32_t> GetCharacterCount();
  54
  55   /**
  56    * @copydoc Dali::Accessibility::Text::GetCursorOffset()
  57    */
  58   DBus::ValueOrError<int32_t> GetCursorOffset();
  59
  60   /**
  61    * @copydoc Dali::Accessibility::Text::SetCursorOffset()
  62    */
  63   DBus::ValueOrError<bool> SetCursorOffset(int32_t offset);
  64
  65   /**
  66    * @copydoc Dali::Accessibility::Text::GetTextAtOffset()
  67    */
  68   DBus::ValueOrError<std::string, int, int> GetTextAtOffset(int32_t offset, uint32_t boundary);
  69
  70   /**
  71    * @copydoc Dali::Accessibility::Text::GetRangeOfSelection()
  72    */
  73   DBus::ValueOrError<int, int> GetRangeOfSelection(int32_t selectionIndex);
  74
  75   /**
  76    * @copydoc Dali::Accessibility::Text::RemoveSelection()
  77    */
  78   DBus::ValueOrError<bool> RemoveSelection(int32_t selectionIndex);
  79
  80   /**
  81    * @copydoc Dali::Accessibility::Text::SetRangeOfSelection()
  82    */
  83   DBus::ValueOrError<bool> SetRangeOfSelection(int32_t selectionIndex, int32_t startOffset, int32_t endOffset);
  84 };
  85
  86 #endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_TEXT_H