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