struct CCL::IAccessibilityProvider

Overview

Basic accessibility provider interface for elements on screen. More…

#include <iaccessibility.h>

struct IAccessibilityProvider: public CCL::IUnknown
{
    // methods

    virtual AccessibilityElementRole CCL_API getElementRole () const = 0;
    virtual void CCL_API getElementName (String& name) const = 0;
    virtual int CCL_API getElementState () const = 0;
    virtual tresult CCL_API setElementFocus () = 0;

    virtual tresult CCL_API getElementBounds (
        Rect& bounds,
        AccessibilityCoordSpace space
    ) const = 0;

    virtual IAccessibilityProvider*CCL_API getParentIProvider () const = 0;
    virtual const IContainer*CCL_API getChildrenIProvider () const = 0;
    virtual IAccessibilityProvider*CCL_API findElementIProvider (AccessibilityDirection direction) const = 0;

    virtual IAccessibilityProvider*CCL_API findElementIProviderAt (
        PointRef pos,
        AccessibilityCoordSpace space
    ) const = 0;

    virtual IAccessibilityProvider*CCL_API geFocusElementIProvider () const = 0;
    virtual IView*CCL_API getIView () const = 0;
    virtual tresult CCL_API makeVisible (tbool relaxed = false) = 0;
    DECLARE_STRINGID_MEMBER (kChildProviderAdded);
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Basic accessibility provider interface for elements on screen.

Methods

virtual AccessibilityElementRole CCL_API getElementRole () const = 0

Get element type, used to determine possible interaction.

virtual void CCL_API getElementName (String& name) const = 0

Get element name, used by screen reader.

virtual int CCL_API getElementState () const = 0

Get current state of element (.

See also:

AccessibilityElementState).

virtual tresult CCL_API setElementFocus () = 0

Set focus to this element.

virtual tresult CCL_API getElementBounds (
    Rect& bounds,
    AccessibilityCoordSpace space
) const = 0

Get element bounding rectangle in given coordinate space.

virtual IAccessibilityProvider*CCL_API getParentIProvider () const = 0

Get parent provider.

virtual const IContainer*CCL_API getChildrenIProvider () const = 0

Get container with children.

virtual IAccessibilityProvider*CCL_API findElementIProvider (AccessibilityDirection direction) const = 0

Find element by navigating in given direction.

virtual IAccessibilityProvider*CCL_API findElementIProviderAt (
    PointRef pos,
    AccessibilityCoordSpace space
) const = 0

Find element at position in given coordinate space.

virtual IAccessibilityProvider*CCL_API geFocusElementIProvider () const = 0

Get focus element provider.

virtual IView*CCL_API getIView () const = 0

Get view owning this element.

virtual tresult CCL_API makeVisible (tbool relaxed = false) = 0

Request to make the element visible (e.g.

by scrolling).

DECLARE_STRINGID_MEMBER (kChildProviderAdded)

< args[0]: IAccessibilityProvider