WindowsWindow.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
 
#include "GenericPlatform/GenericWindow.h"
#include "Templates/SharedPointer.h"
 
#include "Windows/AllowWindowsPlatformTypes.h"
#include <Ole2.h>
#include <oleidl.h>
#include "Windows/HideWindowsPlatformTypes.h"
 
class FWindowsApplication;
enum class EWindowTransparency;
 
class FWindowsWindow
    : public FGenericWindow
    , public IDropTarget
{
public:
 
    static APPLICATIONCORE_API const TCHAR AppWindowClass[];
 
public:
 
    APPLICATIONCORE_API ~FWindowsWindow();
 
    static APPLICATIONCORE_API TSharedRef<FWindowsWindow> Make();
 
    APPLICATIONCORE_API HWND GetHWnd() const;
 
    APPLICATIONCORE_API void Initialize( class FWindowsApplication* const Application, const TSharedRef<FGenericWindowDefinition>& InDefinition, HINSTANCE InHInstance, const TSharedPtr<FWindowsWindow>& InParent, const bool bShowImmediately );
 
    APPLICATIONCORE_API bool IsRegularWindow() const;
 
    APPLICATIONCORE_API void AdjustWindowRegion(int32 Width, int32 Height);
 
    APPLICATIONCORE_API virtual void AdjustCachedSize(FVector2D& Size) const override;
 
    virtual float GetDPIScaleFactor() const override
    {
        return DPIScaleFactor;
    }
 
    virtual void SetDPIScaleFactor(float Value) override
    {
        DPIScaleFactor = Value;
    }
 
    APPLICATIONCORE_API virtual bool IsManualManageDPIChanges() const override;
 
    APPLICATIONCORE_API virtual void SetManualManageDPIChanges(const bool bManualDPIChanges) override;
 
    APPLICATIONCORE_API void OnParentWindowMinimized();
 
    APPLICATIONCORE_API void OnParentWindowRestored();
 
    APPLICATIONCORE_API void OnTransparencySupportChanged(EWindowTransparency NewTransparency);
 
    float GetAspectRatio() const { return AspectRatio; }
 
    APPLICATIONCORE_API bool IsEnabled();
 
    // Attempts to retrieve the window's pixels using PrintWindow (https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-printwindow).
    // Only the client area's pixels are retrieved, which excludes the title bar, border, etc.
    APPLICATIONCORE_API TArray<FColor> GetWindowPixels(uint32& OutWidth, uint32& OutHeight);
 
public:
 
    // FGenericWindow interface
 
    APPLICATIONCORE_API virtual void ReshapeWindow( int32 X, int32 Y, int32 Width, int32 Height ) override;
    APPLICATIONCORE_API virtual bool GetFullScreenInfo( int32& X, int32& Y, int32& Width, int32& Height ) const override;
    APPLICATIONCORE_API virtual void MoveWindowTo ( int32 X, int32 Y ) override;
    APPLICATIONCORE_API virtual void BringToFront( bool bForce = false ) override;
    APPLICATIONCORE_API virtual void HACK_ForceToFront() override;
    APPLICATIONCORE_API virtual void Destroy() override;
    APPLICATIONCORE_API virtual void Minimize() override;
    APPLICATIONCORE_API virtual void Maximize() override;
    APPLICATIONCORE_API virtual void Restore() override;
    APPLICATIONCORE_API virtual void Show() override;
    APPLICATIONCORE_API virtual void Hide() override;
    APPLICATIONCORE_API virtual void SetWindowMode( EWindowMode::Type NewWindowMode ) override;
    virtual EWindowMode::Type GetWindowMode() const override { return WindowMode; } 
    APPLICATIONCORE_API virtual bool IsMaximized() const override;
    APPLICATIONCORE_API virtual bool IsMinimized() const override;
    APPLICATIONCORE_API virtual bool IsVisible() const override;
    APPLICATIONCORE_API virtual bool GetRestoredDimensions(int32& X, int32& Y, int32& Width, int32& Height) override;
    APPLICATIONCORE_API virtual void SetWindowFocus() override;
    APPLICATIONCORE_API virtual void SetOpacity( const float InOpacity ) override;
    APPLICATIONCORE_API virtual void Enable( bool bEnable ) override;
    APPLICATIONCORE_API virtual bool IsPointInWindow( int32 X, int32 Y ) const override;
    APPLICATIONCORE_API virtual int32 GetWindowBorderSize() const override;
    APPLICATIONCORE_API virtual int32 GetWindowTitleBarSize() const override;
    virtual void* GetOSWindowHandle() const  override { return HWnd; }
    APPLICATIONCORE_API virtual bool IsForegroundWindow() const override;
    APPLICATIONCORE_API virtual bool IsFullscreenSupported() const override;
    APPLICATIONCORE_API virtual void SetText(const TCHAR* const Text) override;
    APPLICATIONCORE_API virtual void DrawAttention(const FWindowDrawAttentionParameters& Parameters) override;
 
public:
 
    // IUnknown interface
 
    APPLICATIONCORE_API HRESULT STDCALL QueryInterface(REFIID iid, void ** ppvObject) override;
    APPLICATIONCORE_API ULONG STDCALL AddRef(void) override;
    APPLICATIONCORE_API ULONG STDCALL Release(void) override;
 
public:
 
    // IDropTarget interface
 
    APPLICATIONCORE_API virtual HRESULT STDCALL DragEnter( __RPC__in_opt IDataObject *DataObjectPointer, ::DWORD KeyState, POINTL CursorPosition, __RPC__inout ::DWORD *CursorEffect) override;
    APPLICATIONCORE_API virtual HRESULT STDCALL DragOver( ::DWORD KeyState, POINTL CursorPosition, __RPC__inout ::DWORD *CursorEffect) override;
    APPLICATIONCORE_API virtual HRESULT STDCALL DragLeave( void ) override;
    APPLICATIONCORE_API virtual HRESULT STDCALL Drop( __RPC__in_opt IDataObject *DataObjectPointer, ::DWORD KeyState, POINTL CursorPosition, __RPC__inout ::DWORD *CursorEffect) override;
 
private:
 
    APPLICATIONCORE_API FWindowsWindow();
 
    APPLICATIONCORE_API void UpdateVisibility();
 
    APPLICATIONCORE_API HRGN MakeWindowRegionObject(bool bIncludeBorderWhenMaximized) const;
 
    APPLICATIONCORE_API void DisableTouchFeedback();
 
private:
 
    FWindowsApplication* OwningApplication;
 
    HWND HWnd;
 
    int32 RegionWidth;
    int32 RegionHeight;
    
    EWindowMode::Type WindowMode;
 
    int32 OLEReferenceCount;
        
    WINDOWPLACEMENT PreFullscreenWindowPlacement;
 
    WINDOWPLACEMENT PreParentMinimizedWindowPlacement;
 
    int32 VirtualWidth;
    int32 VirtualHeight;
 
    float AspectRatio;
 
    bool bIsVisible : 1;
 
    bool bIsFirstTimeVisible : 1;
 
    bool bInitiallyMinimized : 1;
    bool bInitiallyMaximized : 1;
 
    float DPIScaleFactor;
 
    bool bHandleManualDPIChanges = false;
};