Merge "VectorImageRenderer: Remove TizenVectorImageRenderer dependency" into devel...

[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / accessibility-impl.h

diff --git a/dali/devel-api/adaptor-framework/accessibility-impl.h b/dali/devel-api/adaptor-framework/accessibility-impl.h
index 304f2c1..dfe1f6b 100644 (file)
--- a/dali/devel-api/adaptor-framework/accessibility-impl.h
+++ b/dali/devel-api/adaptor-framework/accessibility-impl.h
@@ -47,6 +47,7 @@ class DALI_ADAPTOR_API Value;
 class DALI_ADAPTOR_API Component;
 class DALI_ADAPTOR_API Collection;
 class DALI_ADAPTOR_API Action;
+class DALI_ADAPTOR_API Application;
 
 /**
  * @brief Base class for different accessibility bridges.
@@ -72,6 +73,8 @@ struct DALI_ADAPTOR_API Bridge
 
   /**
    * @brief Gets bus name which bridge is initialized on.
+   *
+   * @return The bus name
    */
   virtual const std::string& GetBusName() const = 0;
 
@@ -143,14 +146,14 @@ struct DALI_ADAPTOR_API Bridge
   virtual Accessible* FindByPath(const std::string& path) const = 0;
 
   /**
-   * @brief Shows application on accessibility bus.
+   * @brief Notifies accessibility dbus that window has just been shown.
    */
-  virtual void ApplicationShown() = 0;
+  virtual void WindowShown() = 0;
 
   /**
-   * @brief Hides application on accessibility bus.
+   * @brief Notifies accessibility dbus that window has just been hidden.
    */
-  virtual void ApplicationHidden() = 0;
+  virtual void WindowHidden() = 0;
 
   /**
    * @brief Initializes accessibility bus.
@@ -171,7 +174,7 @@ struct DALI_ADAPTOR_API Bridge
     {
       return ForceUpResult::ALREADY_UP;
     }
-    mData = std::make_shared<Data>();
+    mData          = std::make_shared<Data>();
     mData->mBridge = this;
     return ForceUpResult::JUST_STARTED;
   }
@@ -218,6 +221,14 @@ struct DALI_ADAPTOR_API Bridge
   virtual void EmitTextChanged(Accessible* obj, TextChangedState state, unsigned int position, unsigned int length, const std::string& content) = 0;
 
   /**
+   * @brief Emits MoveOuted event on at-spi bus.
+   *
+   * @param[in] obj Accessible object
+   * @param[in] type Direction type when an Accessible object moves out of screen
+   **/
+  virtual void EmitMovedOutOfScreen(Accessible* obj, ScreenRelativeMoveType type) = 0;
+
+  /**
    * @brief Emits state-changed event on at-spi bus.
    *
    * @param[in] obj The accessible object
@@ -371,7 +382,7 @@ protected:
     ENABLED
   };
 
-  inline static AutoInitState autoInitState = AutoInitState::ENABLED;
+  inline static AutoInitState mAutoInitState = AutoInitState::ENABLED;
 
   /**
    * @brief Registers accessible object to be known in bridge object.
@@ -534,6 +545,13 @@ public:
   void EmitTextCursorMoved(unsigned int cursorPosition);
 
   /**
+   * @brief Emits "MoveOuted" event.
+   *
+   * @param[in] type moved out of screen type
+   */
+  void EmitMovedOutOfScreen(ScreenRelativeMoveType type);
+
+  /**
    * @brief Emits "highlighted" event.
    *
    * @param[in] event The enumerated window event
@@ -858,6 +876,31 @@ public:
 };
 
 /**
+ * @brief An interface identifying the root object
+ * associated with a running application.
+ *
+ * @note Provides global properties describing
+ * application's runtime environment.
+ */
+class Application : public virtual Accessible
+{
+public:
+  /**
+   * @brief Gets name of graphic user interface framework used by an application.
+   *
+   * @return String with name
+   */
+  virtual std::string GetToolkitName() = 0;
+
+  /**
+   * @brief Gets version of graphic user interface framework used by an application.
+   *
+   * @return String with version
+   */
+  virtual std::string GetVersion() = 0;
+};
+
+/**
  * @brief Interface enabling advanced quering of accessibility objects.
  *
  * @note since all mathods can be implemented inside bridge,
@@ -961,7 +1004,7 @@ public:
   virtual Accessible* GetAccessibleAtPoint(Point point, CoordinateType type);
 
   /**
-   * @brief Checks if current object contains given point.
+   * @brief Checks if the current object contains the given point inside.
    *
    * @param[in] point The two-dimensional point
    * @param[in] type The enumeration with type of coordinate system
@@ -971,7 +1014,7 @@ public:
    * @remarks This method is `Contains` in DBus method.
    * @see Dali::Accessibility::Point
    */
-  virtual bool IsAccessibleContainedAtPoint(Point point, CoordinateType type);
+  virtual bool IsAccessibleContainingPoint(Point point, CoordinateType type);
 };
 
 /**