SlateCoreAccessibleWidgets.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#if WITH_ACCESSIBILITY
 
#include "CoreMinimal.h"
#include "GenericPlatform/Accessibility/GenericAccessibleInterfaces.h"
 
class SWidget;
class SWindow;
 
class FSlateAccessibleWidget : public IAccessibleWidget
{
    friend class FSlateAccessibleMessageHandler;
public:
    SLATECORE_API FSlateAccessibleWidget(TWeakPtr<SWidget> InWidget, EAccessibleWidgetType InWidgetType = EAccessibleWidgetType::Unknown);
    SLATECORE_API virtual ~FSlateAccessibleWidget();
 
    // IAccessibleWidget
    SLATECORE_API virtual AccessibleWidgetId GetId() const override final;
    SLATECORE_API virtual bool IsValid() const override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetWindow() const override final;
    SLATECORE_API virtual FBox2D GetBounds() const override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetParent() override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetNextSibling() override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetPreviousSibling() override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetNextWidgetInHierarchy() override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetPreviousWidgetInHierarchy() override final;
    SLATECORE_API virtual TSharedPtr<IAccessibleWidget> GetChildAt(int32 Index) override final;
    SLATECORE_API virtual int32 GetNumberOfChildren() override final;
    SLATECORE_API virtual FString GetClassName() const override final;
    SLATECORE_API virtual bool IsEnabled() const override final;
    SLATECORE_API virtual bool IsHidden() const override final;
    SLATECORE_API virtual bool SupportsFocus() const override final;
    SLATECORE_API virtual bool SupportsAccessibleFocus() const override final;
    SLATECORE_API virtual bool CanCurrentlyAcceptAccessibleFocus() const override final;
    SLATECORE_API virtual bool HasUserFocus(const FAccessibleUserIndex UserIndex) const override final;
    SLATECORE_API virtual bool SetUserFocus(const FAccessibleUserIndex UserIndex) override final;
 
    virtual EAccessibleWidgetType GetWidgetType() const override { return WidgetType; }
    SLATECORE_API virtual FString GetWidgetName() const override;
    SLATECORE_API virtual FString GetHelpText() const override;
    // ~
 
    SLATECORE_API void UpdateParent(TSharedPtr<IAccessibleWidget> NewParent);
 
protected:
    TWeakPtr<SWidget> Widget;
    EAccessibleWidgetType WidgetType;
    TWeakPtr<FSlateAccessibleWidget> Parent;
    TArray<TWeakPtr<FSlateAccessibleWidget>> Children;
    TArray<TWeakPtr<FSlateAccessibleWidget>> ChildrenBuffer;
    int32 SiblingIndex;
    AccessibleWidgetId Id;
 
private:
    SLATECORE_API TSharedPtr<SWindow> GetSlateWindow() const;
};
 
// SWindow
class FSlateAccessibleWindow
    : public FSlateAccessibleWidget
    , public IAccessibleWindow
{
public:
    FSlateAccessibleWindow(TWeakPtr<SWidget> InWidget) : FSlateAccessibleWidget(InWidget, EAccessibleWidgetType::Window) {}
    virtual ~FSlateAccessibleWindow() {}
 
    // IAccessibleWidget
    virtual IAccessibleWindow* AsWindow() override { return this; }
    virtual FString GetWidgetName() const override;
    // ~
 
    // IAccessibleWindow
    virtual TSharedPtr<FGenericWindow> GetNativeWindow() const override;
    virtual TSharedPtr<IAccessibleWidget> GetChildAtPosition(int32 X, int32 Y) override;
    virtual TSharedPtr<IAccessibleWidget> GetUserFocusedWidget(const FAccessibleUserIndex UserIndex) const override;
    virtual void Close() override;
    virtual bool SupportsDisplayState(EWindowDisplayState State) const override;
    virtual EWindowDisplayState GetDisplayState() const override;
    virtual void SetDisplayState(EWindowDisplayState State) override;
    virtual bool IsModal() const override;
    // ~
};
// ~
 
// SImage
class FSlateAccessibleImage
    : public FSlateAccessibleWidget
{
public:
    FSlateAccessibleImage(TWeakPtr<SWidget> InWidget) : FSlateAccessibleWidget(InWidget, EAccessibleWidgetType::Image) {}
    virtual ~FSlateAccessibleImage() {}
 
    // IAccessibleWidget
    SLATECORE_API virtual FString GetHelpText() const override;
    // ~
};
// ~
 
#endif