[AT-SPI] do not keep window in ApplicationAccessible
[platform/core/uifw/dali-adaptor.git] / dali / internal / accessibility / bridge / bridge-editable-text.h
index e7d707b..742a8d7 100644 (file)
@@ -2,7 +2,7 @@
 #define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_EDITABLE_TEXT_H
 
 /*
- * Copyright (c) 2019 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  */
 
 // INTERNAL INCLUDES
+#include <dali/devel-api/atspi-interfaces/editable-text.h>
 #include <dali/internal/accessibility/bridge/bridge-base.h>
 
+/**
+ * @brief The BridgeEditableText class is to correspond with Dali::Accessibility::EditableText.
+ */
 class BridgeEditableText : public virtual BridgeBase
 {
 protected:
   BridgeEditableText() = default;
 
+  /**
+   * @brief Registers EditableText functions to dbus interfaces.
+   */
   void RegisterInterfaces();
 
+  /**
+   * @brief Returns the EditableText object of the currently executed DBus method call.
+   *
+   * @return The EditableText object
+   */
   Dali::Accessibility::EditableText* FindSelf() const;
 
 public:
-  DBus::ValueOrError< bool > CopyText( int32_t startPos, int32_t endPos );
-  DBus::ValueOrError< bool > CutText( int32_t startPos, int32_t endPos );
-  DBus::ValueOrError< bool > PasteText( int32_t pos );
+  /**
+   * @copydoc Dali::Accessibility::EditableText::CopyText()
+   */
+  DBus::ValueOrError<bool> CopyText(int32_t startPosition, int32_t endPosition);
+
+  /**
+   * @copydoc Dali::Accessibility::EditableText::CutText()
+   */
+  DBus::ValueOrError<bool> CutText(int32_t startPosition, int32_t endPosition);
+
+  /**
+   * @copydoc Dali::Accessibility::EditableText::DeleteText()
+   */
+  DBus::ValueOrError<bool> DeleteText(int32_t startPosition, int32_t endPosition);
+
+  /**
+   * @copydoc Dali::Accessibility::EditableText::InsertText()
+   */
+  DBus::ValueOrError<bool> InsertText(int32_t startPosition, std::string text, int32_t length);
+
+  /**
+   * @brief Pastes text at position.
+   *
+   * @param[in] position The text position
+   * @return True on success, false otherwise
+   * @note Currently, this function is not implemented yet.
+   */
+  DBus::ValueOrError<bool> PasteText(int32_t position);
+
+  /**
+   * @copydoc Dali::Accessibility::EditableText::SetTextContents()
+   */
+  DBus::ValueOrError<bool> SetTextContents(std::string newContents);
 };
 
 #endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_EDITABLE_TEXT_H