GenericWindow.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Math/MathFwd.h"
#include "Templates/SharedPointer.h"
 
struct FGenericWindowDefinition;
 
namespace EWindowMode
{
    enum Type : int
    {
        Fullscreen,
        WindowedFullscreen,
        Windowed,
 
        NumWindowModes
    };
 
    inline Type ConvertIntToWindowMode(int32 InWindowMode)
    {
        Type WindowMode = Windowed;
        switch (InWindowMode)
        {
        case 0:
            WindowMode = Fullscreen;
            break;
        case 1:
            WindowMode = WindowedFullscreen;
            break;
        case 2:
        default:
            WindowMode = Windowed;
            break;
        }
        return WindowMode;
    }
}
 
inline const TCHAR* LexToString(EWindowMode::Type WindowMode)
{
    switch (WindowMode)
    {
    case EWindowMode::Fullscreen: return TEXT("Fullscreen");
    case EWindowMode::WindowedFullscreen: return TEXT("WindowedFullscreen");
    case EWindowMode::Windowed: return TEXT("Windowed");
    case EWindowMode::NumWindowModes:
    default: return TEXT("Unknown");
    }
}
 
enum class EWindowDrawAttentionRequestType
{
    UntilActivated,
 
    Stop,
};
 
struct FWindowDrawAttentionParameters
{
    FWindowDrawAttentionParameters() = default;
 
    explicit FWindowDrawAttentionParameters(
        EWindowDrawAttentionRequestType InRequestType
    )
        : RequestType(InRequestType)
    {
    }
 
    EWindowDrawAttentionRequestType RequestType = EWindowDrawAttentionRequestType::UntilActivated;
};
 
class FGenericWindow
{
public:
 
    APPLICATIONCORE_API FGenericWindow();
 
    APPLICATIONCORE_API virtual ~FGenericWindow();
 
    APPLICATIONCORE_API virtual void ReshapeWindow( int32 X, int32 Y, int32 Width, int32 Height );
 
    APPLICATIONCORE_API virtual bool GetFullScreenInfo( int32& X, int32& Y, int32& Width, int32& Height ) const;
 
    APPLICATIONCORE_API virtual void MoveWindowTo ( int32 X, int32 Y );
 
    APPLICATIONCORE_API virtual void BringToFront( bool bForce = false );
 
    APPLICATIONCORE_API virtual void HACK_ForceToFront();
 
    APPLICATIONCORE_API virtual void Destroy();
 
    APPLICATIONCORE_API virtual void Minimize();
 
    APPLICATIONCORE_API virtual void Maximize();
 
    APPLICATIONCORE_API virtual void Restore();
 
    APPLICATIONCORE_API virtual void Show();
 
    APPLICATIONCORE_API virtual void Hide();
 
    APPLICATIONCORE_API virtual void SetWindowMode( EWindowMode::Type InNewWindowMode );
 
    APPLICATIONCORE_API virtual EWindowMode::Type GetWindowMode() const;
 
    APPLICATIONCORE_API virtual bool IsMaximized() const;
 
    APPLICATIONCORE_API virtual bool IsMinimized() const;
 
    APPLICATIONCORE_API virtual bool IsVisible() const;
 
    APPLICATIONCORE_API virtual bool GetRestoredDimensions(int32& X, int32& Y, int32& Width, int32& Height);
 
    APPLICATIONCORE_API virtual void SetWindowFocus();
 
    APPLICATIONCORE_API virtual void SetOpacity( const float InOpacity );
 
    APPLICATIONCORE_API virtual void Enable( bool bEnable );
 
    APPLICATIONCORE_API virtual bool IsPointInWindow( int32 X, int32 Y ) const;
    
    APPLICATIONCORE_API virtual int32 GetWindowBorderSize() const;
 
    APPLICATIONCORE_API virtual int32 GetWindowTitleBarSize() const;
 
    APPLICATIONCORE_API virtual void* GetOSWindowHandle() const;
 
    APPLICATIONCORE_API virtual bool IsForegroundWindow() const;
 
    APPLICATIONCORE_API virtual bool IsFullscreenSupported() const;
 
    APPLICATIONCORE_API virtual void SetText(const TCHAR* const Text);
 
    APPLICATIONCORE_API virtual const FGenericWindowDefinition& GetDefinition() const;
 
    APPLICATIONCORE_API virtual bool IsDefinitionValid() const;
 
    APPLICATIONCORE_API virtual void AdjustCachedSize( FVector2D& Size ) const;
 
    APPLICATIONCORE_API virtual float GetDPIScaleFactor() const;
 
    APPLICATIONCORE_API virtual void SetDPIScaleFactor(const float Factor);
 
    APPLICATIONCORE_API virtual bool IsManualManageDPIChanges() const;
 
    APPLICATIONCORE_API virtual void SetManualManageDPIChanges(const bool bAutoHandle);
 
    APPLICATIONCORE_API virtual void DrawAttention(const FWindowDrawAttentionParameters& Parameters);
 
    APPLICATIONCORE_API virtual void SetNativeWindowButtonsVisibility(bool bVisible);
 
protected:
 
    TSharedPtr< FGenericWindowDefinition > Definition;
};