WindowsUIAWidgetProvider.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_ACCESSIBILITY && UE_WINDOWS_USING_UIA
 
#include "Windows/Accessibility/WindowsUIABaseProvider.h"
#include "Misc/Variant.h"
 
class FWindowsUIAManager;
class IAccessibleWidget;
 
class FWindowsUIAWidgetProvider
    : public FWindowsUIABaseProvider
    , public IRawElementProviderSimple
    , public IRawElementProviderFragment
{
    friend class FWindowsUIAManager;
public:
    // IUnknown
    virtual HRESULT STDCALL QueryInterface(REFIID riid, void** ppInterface) override;
    virtual ULONG STDCALL AddRef() override;
    virtual ULONG STDCALL Release() override;
    // ~
 
    // IRawElementProviderSimple
    virtual HRESULT STDCALL get_ProviderOptions(ProviderOptions* pRetVal) override;
    virtual HRESULT STDCALL GetPatternProvider(PATTERNID patternId, IUnknown** pRetVal) override;
    virtual HRESULT STDCALL GetPropertyValue(PROPERTYID propertyId, VARIANT* pRetVal) override;
    virtual HRESULT STDCALL get_HostRawElementProvider(IRawElementProviderSimple** pRetVal) override;
    // ~
 
    // IRawElementProviderFragment
    virtual HRESULT STDCALL Navigate(NavigateDirection direction, IRawElementProviderFragment** pRetVal) override;
    virtual HRESULT STDCALL GetRuntimeId(SAFEARRAY** pRetVal) override;
    virtual HRESULT STDCALL get_BoundingRectangle(UiaRect* pRetVal) override;
    virtual HRESULT STDCALL GetEmbeddedFragmentRoots(SAFEARRAY** pRetVal) override;
    virtual HRESULT STDCALL SetFocus() override;
    virtual HRESULT STDCALL get_FragmentRoot(IRawElementProviderFragmentRoot** pRetVal) override;
    // ~
 
    bool SupportsInterface(PATTERNID PatternId) const;
 
protected:
    FWindowsUIAWidgetProvider(FWindowsUIAManager& InManager, TSharedRef<IAccessibleWidget> InWidget);
    virtual ~FWindowsUIAWidgetProvider();
 
//  void UpdateCachedProperties();
//private:
//  void UpdateCachedProperty(PROPERTYID PropertyId);
//  TMap<int32, FVariant> CachedPropertyValues;
};
 
class FWindowsUIAWindowProvider
    : public FWindowsUIAWidgetProvider
    , public IRawElementProviderFragmentRoot
{
    friend class FWindowsUIAManager;
public:
    // IUnknown
    virtual HRESULT STDCALL QueryInterface(REFIID riid, void** ppInterface) override;
    virtual ULONG STDCALL AddRef() override;
    virtual ULONG STDCALL Release() override;
    // ~
 
    // IRawElementProviderSimple
    virtual HRESULT STDCALL get_HostRawElementProvider(IRawElementProviderSimple** pRetVal) override;
    virtual HRESULT STDCALL GetPatternProvider(PATTERNID patternId, IUnknown** pRetVal) override;
    // ~
 
    // IRawElementProviderFragmentRoot
    virtual HRESULT STDCALL ElementProviderFromPoint(double x, double y, IRawElementProviderFragment** pRetVal) override;
    virtual HRESULT STDCALL GetFocus(IRawElementProviderFragment** pRetVal) override;
    // ~
 
protected:
    FWindowsUIAWindowProvider(FWindowsUIAManager& InManager, TSharedRef<IAccessibleWidget> InWidget);
    virtual ~FWindowsUIAWindowProvider();
};
 
class FScopedWidgetProvider
{
public:
    FScopedWidgetProvider(FWindowsUIAWidgetProvider& InProvider)
        : Provider(InProvider)
    {
    }
    ~FScopedWidgetProvider()
    {
        Provider.Release();
    }
    FWindowsUIAWidgetProvider& Provider;
};
 
#endif