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

   1 #ifndef DALI_INTERNAL_ACCESSIBILITY_BRIDGE_EDITABLE_TEXT_H
   2 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_EDITABLE_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/editable-text.h>
  23 #include <dali/internal/accessibility/bridge/bridge-base.h>
  24
  25 /**
  26  * @brief The BridgeEditableText class is to correspond with Dali::Accessibility::EditableText.
  27  */
  28 class BridgeEditableText : public virtual BridgeBase
  29 {
  30 protected:
  31   BridgeEditableText() = default;
  32
  33   /**
  34    * @brief Registers EditableText functions to dbus interfaces.
  35    */
  36   void RegisterInterfaces();
  37
  38   /**
  39    * @brief Returns the EditableText object of the currently executed DBus method call.
  40    *
  41    * @return The EditableText object
  42    */
  43   Dali::Accessibility::EditableText* FindSelf() const;
  44
  45 public:
  46   /**
  47    * @copydoc Dali::Accessibility::EditableText::CopyText()
  48    */
  49   DBus::ValueOrError<bool> CopyText(int32_t startPosition, int32_t endPosition);
  50
  51   /**
  52    * @copydoc Dali::Accessibility::EditableText::CutText()
  53    */
  54   DBus::ValueOrError<bool> CutText(int32_t startPosition, int32_t endPosition);
  55
  56   /**
  57    * @copydoc Dali::Accessibility::EditableText::DeleteText()
  58    */
  59   DBus::ValueOrError<bool> DeleteText(int32_t startPosition, int32_t endPosition);
  60
  61   /**
  62    * @copydoc Dali::Accessibility::EditableText::InsertText()
  63    */
  64   DBus::ValueOrError<bool> InsertText(int32_t startPosition, std::string text, int32_t length);
  65
  66   /**
  67    * @brief Pastes text at position.
  68    *
  69    * @param[in] position The text position
  70    * @return True on success, false otherwise
  71    * @note Currently, this function is not implemented yet.
  72    */
  73   DBus::ValueOrError<bool> PasteText(int32_t position);
  74
  75   /**
  76    * @copydoc Dali::Accessibility::EditableText::SetTextContents()
  77    */
  78   DBus::ValueOrError<bool> SetTextContents(std::string newContents);
  79 };
  80
  81 #endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_EDITABLE_TEXT_H