LinuxWindow.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Logging/LogMacros.h"
#include "Templates/SharedPointer.h"
#include "GenericPlatform/GenericWindow.h"
 
#include <SDL3/SDL.h>
 
class FLinuxApplication;
struct FGenericWindowDefinition;
 
DECLARE_LOG_CATEGORY_EXTERN( LogLinuxWindow, Log, All );
DECLARE_LOG_CATEGORY_EXTERN( LogLinuxWindowType, Log, All );
DECLARE_LOG_CATEGORY_EXTERN( LogLinuxWindowEvent, Log, All );
 
typedef SDL_Window*     SDL_HWindow;
 
enum class EWindowActivationPolicy;
 
class FLinuxWindow : public FGenericWindow
{
public:
    APPLICATIONCORE_API ~FLinuxWindow();
 
    static APPLICATIONCORE_API TSharedRef< FLinuxWindow > Make();
 
    APPLICATIONCORE_API SDL_HWindow GetHWnd() const;
 
    APPLICATIONCORE_API void Initialize( class FLinuxApplication* const Application, const TSharedRef< FGenericWindowDefinition >& InDefinition, const TSharedPtr< FLinuxWindow >& InParent, const bool bShowImmediately );
 
    APPLICATIONCORE_API bool IsRegularWindow() const;
 
    APPLICATIONCORE_API bool IsPopupMenuWindow() const;
 
    APPLICATIONCORE_API bool IsTooltipWindow() const;
 
    APPLICATIONCORE_API bool IsNotificationWindow() const;
 
    APPLICATIONCORE_API bool IsTopLevelWindow() const;
 
    APPLICATIONCORE_API bool IsModalWindow() const;
 
    APPLICATIONCORE_API bool IsDialogWindow() const;
 
    APPLICATIONCORE_API bool IsDragAndDropWindow() const;
 
    APPLICATIONCORE_API bool IsUtilityWindow() const;
 
    APPLICATIONCORE_API EWindowActivationPolicy GetActivationPolicy() const;
 
    APPLICATIONCORE_API bool IsFocusWhenFirstShown() const;
 
    APPLICATIONCORE_API const TSharedPtr< FLinuxWindow >& GetParent() const;
 
    APPLICATIONCORE_API uint32 GetID() const;
 
    APPLICATIONCORE_API void LogInfo();
 
    APPLICATIONCORE_API bool IsNativeMoving() const;
    APPLICATIONCORE_API bool BeginNativeMove();
    APPLICATIONCORE_API void AfterNativeMove();
    APPLICATIONCORE_API void EndNativeMove();
 
    enum NativeResizeDirection 
    {
        ResizeSouthWest = 0,
        ResizeSouth,
        ResizeSouthEast,
        ResizeEast,
        ResizeNorthEast,
        ResizeNorth,
        ResizeNorthWest,
        ResizeWest,
 
        InvalidDirection
    };
 
    APPLICATIONCORE_API bool IsNativeResizing() const;
    APPLICATIONCORE_API bool BeginNativeResize( NativeResizeDirection Direction );
    APPLICATIONCORE_API void AfterNativeResize();
    APPLICATIONCORE_API void EndNativeResize();
 
public:
    APPLICATIONCORE_API virtual void ReshapeWindow( int32 X, int32 Y, int32 Width, int32 Height ) override;
 
    virtual void* GetOSWindowHandle() const  override { return HWnd; }
 
    //  not finished
    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 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 IsVisible() const override;
 
    APPLICATIONCORE_API virtual bool IsMinimized() 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 bool IsForegroundWindow() const override;
    APPLICATIONCORE_API virtual void SetText(const TCHAR* const Text) override;
 
    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 void GetNativeBordersSize(int32& OutLeftBorderWidth, int32& OutTopBorderHeight) const;
 
    APPLICATIONCORE_API void CacheNativeProperties();
 
private:
 
    APPLICATIONCORE_API FLinuxWindow();
 
private:
 
    FLinuxApplication* OwningApplication;
 
    SDL_HWindow HWnd;
 
    int32 RegionWidth;
    int32 RegionHeight;
    
    EWindowMode::Type WindowMode;
 
    RECT PreFullscreenWindowRect;
 
    int32 VirtualWidth;
    int32 VirtualHeight;
 
    bool bIsVisible;
 
    bool bWasFullscreen;
 
    bool bIsPopupWindow;
 
    bool bIsTooltipWindow;
 
    bool bIsConsoleWindow;
 
    bool bIsDialogWindow;
 
    bool bIsNotificationWindow;
 
    bool bIsTopLevelWindow;
 
    bool bIsDragAndDropWindow;
 
    bool bIsUtilityWindow;
 
    bool bIsPointerInsideWindow;
 
    uint32 WindowSDLID;
 
    TSharedPtr< FLinuxWindow > ParentWindow;
    static APPLICATIONCORE_API SDL_HitTestResult HitTest( SDL_Window *SDLwin, const SDL_Point *point, void *data );
 
    int32 LeftBorderWidth;
 
    int32 TopBorderHeight;
 
    bool bValidNativePropertiesCache;
 
    float DPIScaleFactor;
};