class EE::UI::AccessibilitySource

Overview

Resolves virtual accessibility elements without materializing UIWidgets for them. More…

#include <accessibilitysource.hpp>

class AccessibilitySource {
public:
    // fields

    static constexpr Int32 UnknownIndex = -2;

    // construction

    virtual ~AccessibilitySource();

    // methods

    virtual bool isValid(Uint64 id) const = 0;
    virtual AccessibilityNodeInfo getInfo(Uint64 id) const = 0;
    virtual AccessibilityRole getRole(Uint64 id) const;
    virtual AccessibilityState getState(Uint64 id) const;
    virtual AccessibilityNodeRef getParent(Uint64 id) const = 0;
    virtual size_t getChildCount(Uint64 id) const = 0;
    virtual AccessibilityNodeRef getChild(Uint64 id, size_t index) = 0;
    virtual size_t getRootChildCount() const = 0;
    virtual AccessibilityNodeRef getRootChild(size_t index) = 0;
    virtual Int32 getIndexInParent(Uint64) const;
    virtual bool getSelectedChildren(std::vector<AccessibilityNodeRef>&) const;
    virtual AccessibilityNodeRef getEmbeddedWidgetParent(const UIWidget*);
    virtual AccessibilityNodeRef hitTest(const Math::Vector2f& position) = 0;
    virtual bool performAction(Uint64 id, const AccessibilityActionRequest& request) = 0;
    virtual void invalidate();
    virtual void reset();
};

Detailed Documentation

Resolves virtual accessibility elements without materializing UIWidgets for them.

Methods

virtual AccessibilityRole getRole(Uint64 id) const

Sources may answer scalar queries without copying model display data.

virtual Int32 getIndexInParent(Uint64) const

Returns a known child index, -1 for an unexposed node, or UnknownIndex for fallback.

virtual bool getSelectedChildren(std::vector<AccessibilityNodeRef>&) const

Resolves selected root children without walking the model; false requests fallback.

virtual AccessibilityNodeRef getEmbeddedWidgetParent(const UIWidget*)

Returns the virtual node hosting a real widget embedded in this source, such as a cell editor, or an invalid ref when the widget is not embedded.