[ATSPI] Add more descriptions to Bridge objects
[platform/core/uifw/dali-adaptor.git] / dali / internal / accessibility / bridge / bridge-selection.h
index ceb920d..5892544 100644 (file)
 // INTERNAL INCLUDES
 #include <dali/internal/accessibility/bridge/bridge-base.h>
 
+/**
+ * @brief The BridgeSelection class is to correspond with Dali::Accessibility::Selection.
+ */
 class BridgeSelection : public virtual BridgeBase
 {
 protected:
   BridgeSelection() = default;
 
+  /**
+   * @brief Registers Selection functions to dbus interfaces.
+   */
   void RegisterInterfaces();
 
+  /**
+   * @brief Returns the Selection object of the currently executed DBus method call.
+   *
+   * @return The Selection object
+   */
   Dali::Accessibility::Selection* FindSelf() const;
 
 public:
+  /**
+   * @copydoc Dali::Accessibility::Selection::GetSelectedChildrenCount()
+   */
   DBus::ValueOrError<int32_t> GetSelectedChildrenCount();
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::GetSelectedChild()
+   */
   DBus::ValueOrError<Dali::Accessibility::Accessible*> GetSelectedChild(int32_t selectedChildIndex);
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::SelectChild()
+   */
   DBus::ValueOrError<bool> SelectChild(int32_t childIndex);
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::DeselectSelectedChild()
+   */
   DBus::ValueOrError<bool> DeselectSelectedChild(int32_t selectedChildIndex);
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::IsChildSelected()
+   */
   DBus::ValueOrError<bool> IsChildSelected(int32_t childIndex);
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::SelectAll()
+   */
   DBus::ValueOrError<bool> SelectAll();
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::ClearSelection()
+   */
   DBus::ValueOrError<bool> ClearSelection();
+
+  /**
+   * @copydoc Dali::Accessibility::Selection::DeselectChild()
+   */
   DBus::ValueOrError<bool> DeselectChild(int32_t childIndex);
 };