#define DALI_INTERNAL_ACCESSIBILITY_BRIDGE_ACCESSIBLE_H
/*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2023 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.
#include <vector>
// INTERNAL INCLUDES
-#include "bridge-base.h"
+#include <dali/devel-api/atspi-interfaces/accessible.h>
+#include <dali/devel-api/atspi-interfaces/component.h>
+#include <dali/internal/accessibility/bridge/bridge-base.h>
/**
* @brief The BridgeAccessible class is to correspond with Dali::Accessibility::Accessible.
class BridgeAccessible : public virtual BridgeBase
{
protected:
-
/**
* @brief Constructor.
*/
*/
void RegisterInterfaces();
+ /**
+ * @brief Returns the Accessible object of the currently executed DBus method call.
+ *
+ * @return The Accessible object
+ */
+ Dali::Accessibility::Accessible* FindSelf() const;
+
public:
/**
* @brief Enumeration for NeighborSearchMode.
*/
enum class NeighborSearchMode
{
- NORMAL = 0, ///< Normal
- RECURSE_FROM_ROOT = 1, ///< Recurse from root
- CONTINUE_AFTER_FAILED_RECURSION = 2, ///< Continue after failed recursion
- RECURSE_TO_OUTSIDE = 3, ///< Recurse to outside
+ NORMAL = 0, ///< Normal
+ RECURSE_FROM_ROOT = 1, ///< Recurse from root
+ CONTINUE_AFTER_FAILED_RECURSION = 2, ///< Continue after failed recursion
+ RECURSE_TO_OUTSIDE = 3, ///< Recurse to outside
};
using ReadingMaterialType = DBus::ValueOrError<
Dali::Accessibility::Accessible* // describedByObject
>;
- using Relation = std::tuple<uint32_t, std::vector<Dali::Accessibility::Address>>;
+ using Relation = std::tuple<uint32_t, std::vector<Dali::Accessibility::Accessible*>>;
/**
* @copydoc Dali::Accessibility::Accessible::GetChildCount()
DBus::ValueOrError<std::unordered_map<std::string, std::string>> GetAttributes();
/**
- * @copydoc Dali::Accessibility::Accessible::GetInterfaces()
+ * @copydoc Dali::Accessibility::Accessible::GetInterfacesAsStrings()
*/
- DBus::ValueOrError<std::vector<std::string>> GetInterfaces();
+ DBus::ValueOrError<std::vector<std::string>> GetInterfacesAsStrings();
/**
* @brief Gets Accessible object on which surface lies the point with given coordinates.
*
* The "Default label" is a text that could be read by screen-reader immediately
* after the navigation context has changed (window activates, popup shows up, tab changes) and before first UI element is highlighted.
- * @return The array containing the default label, its role, and its attributes
+ * @return The array containing the Accessible object being a source of default label text, its role, and its attributes
* @note This is a Tizen only feature not present in upstream ATSPI.
* Feature can be enabled/disabled for particular context root object by setting value of its accessibility attribute "default_label".
*/
ReadingMaterialType GetReadingMaterial();
/**
- * @copydoc Dali::Accessibility::Bridge::SuppressScreenReader()
- */
- void SuppressScreenReader(bool) override;
-
- /**
* @copydoc Dali::Accessibility::Accessible::DoGesture()
*/
DBus::ValueOrError<bool> DoGesture(Dali::Accessibility::Gesture type, int32_t startPositionX, int32_t startPositionY, int32_t endPositionX, int32_t endPositionY, Dali::Accessibility::GestureState state, uint32_t eventTime);
*/
DBus::ValueOrError<std::vector<Relation>> GetRelationSet();
+ /**
+ * @copydoc Dali::Accessibility::Accessible::SetListenPostRender()
+ */
+ DBus::ValueOrError<void> SetListenPostRender(bool enabled);
+
private:
/**
* @brief Calculates Neighbor candidate object in root node.
* @brief Gets valid children accessible.
*
* @param[in] children Children accessible objects
- * @param start The start node // NEED TO UPDATE! It seems not to be used anywhere in this function.
+ * @param start The start node
* @return The valid children
*/
- std::vector<Dali::Accessibility::Accessible*> GetValidChildren(const std::vector<Dali::Accessibility::Accessible*>& children, Dali::Accessibility::Accessible* start);
+ std::vector<Dali::Accessibility::Component*> GetValidChildren(const std::vector<Dali::Accessibility::Accessible*>& children, Dali::Accessibility::Accessible* start);
+
+ /**
+ * @brief Sorts children accessible based on the coordinates from top-left to bottom-right.
+ *
+ * @param[in,out] children Children accessible objects
+ * @return The sorted children
+ */
+ void SortChildrenFromTopLeft(std::vector<Dali::Accessibility::Component*>& children);
/**
* @brief Gets the currently highlighted accessible.
* @return The Component object
*/
Dali::Accessibility::Component* CalculateNavigableAccessibleAtPoint(Dali::Accessibility::Accessible* root, Dali::Accessibility::Point point, Dali::Accessibility::CoordinateType type, unsigned int maxRecursionDepth);
-
-
-protected:
- bool mIsScreenReaderSuppressed = false;
};
#endif // DALI_INTERNAL_ACCESSIBILITY_BRIDGE_ACCESSIBLE_H