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