IWebBrowserWindow.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Input/CursorReply.h"
#include "Input/Reply.h"
#include "Widgets/SWindow.h"
#include "SWebBrowser.h"
 
class Error;
class FSlateShaderResource;
class IWebBrowserDialog;
class IWebBrowserPopupFeatures;
enum class EWebBrowserDialogEventResponse;
 
enum class EWebBrowserDocumentState
{
    Completed,
    Error,
    Loading,
    NoDocument
};
 
enum class EWebBrowserConsoleLogSeverity
{
    Default,
    Verbose,
    Debug,
    Info,
    Warning,
    Error,
    Fatal
};
 
 
enum class EWebTransitionSource
{
    Unknown,
    Link,
    Explicit,
    AutoSubframe,
    ManualSubframe,
    FormSubmit,
    Reload
};
 
enum class EWebTransitionSourceQualifier
{
    Unknown,
    Blocked,
    ForwardBack,
    ChainStart,
    ChainEnd,
    ClientRedirect,
    ServerRedirect
};
 
 
struct FWebNavigationRequest
{
    bool bIsRedirect;
    bool bIsMainFrame;
    bool bIsExplicitTransition;
    EWebTransitionSource TransitionSource;
    EWebTransitionSourceQualifier TransitionSourceQualifier;
};
 
class IWebBrowserWindow
{
public:
 
    virtual void LoadURL(FString NewURL) = 0;
 
    virtual void LoadString(FString Contents, FString DummyURL) = 0;
 
    virtual void SetViewportSize(FIntPoint WindowSize, FIntPoint WindowPos = FIntPoint::NoneValue) = 0;
 
    virtual FIntPoint GetViewportSize() const = 0;
 
    virtual FSlateShaderResource* GetTexture(bool bIsPopup = false) = 0;
 
    virtual bool IsValid() const = 0;
 
    virtual bool IsInitialized() const = 0;
 
    virtual bool IsClosing() const = 0;
 
    virtual EWebBrowserDocumentState GetDocumentLoadingState() const = 0;
 
    virtual FString GetTitle() const = 0;
 
    virtual FString GetUrl() const = 0;
 
    virtual void GetSource(TFunction<void (const FString&)> Callback) const = 0;
 
    virtual bool OnKeyDown(const FKeyEvent& InKeyEvent) = 0;
 
    virtual bool OnKeyUp(const FKeyEvent& InKeyEvent) = 0;
 
    virtual bool OnKeyChar(const FCharacterEvent& InCharacterEvent) = 0;
 
    virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) = 0;
 
    virtual FReply OnMouseButtonUp(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) = 0;
 
    virtual FReply OnMouseButtonDoubleClick(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) = 0;
 
    virtual FReply OnMouseMove(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) = 0;
 
    virtual void OnMouseLeave(const FPointerEvent& MouseEvent) = 0;
 
    virtual void SetSupportsMouseWheel(bool bValue) = 0;
 
    virtual bool GetSupportsMouseWheel() const = 0;
 
    virtual FReply OnMouseWheel(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) = 0;
 
    virtual FReply OnTouchGesture(const FGeometry& MyGeometry, const FPointerEvent& GestureEvent, bool bIsPopup) = 0;
 
    virtual FCursorReply OnCursorQuery(const FGeometry& MyGeometry, const FPointerEvent& CursorEvent) = 0;
 
    virtual void OnFocus(bool SetFocus, bool bIsPopup) = 0;
 
    virtual void OnCaptureLost() = 0;
 
    virtual bool CanGoBack() const = 0;
 
    virtual void GoBack() = 0;
 
    virtual bool CanGoForward() const = 0;
 
    virtual void GoForward() = 0;
 
    virtual bool IsLoading() const = 0;
 
    virtual void Reload() = 0;
 
    virtual void StopLoad() = 0;
 
    virtual void ExecuteJavascript(const FString& Script) = 0;
 
    virtual void CloseBrowser(bool bForce, bool bBlockTillClosed = false) = 0;
 
    virtual void BindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true) = 0;
 
    virtual void UnbindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true) = 0;
 
    virtual void BindInputMethodSystem(ITextInputMethodSystem* TextInputMethodSystem) {}
 
    virtual void UnbindInputMethodSystem() {}
 
    virtual int GetLoadError() = 0;
    
    virtual void SetIsDisabled(bool bValue) = 0;
 
    virtual TSharedPtr<class SWindow> GetParentWindow() const = 0;
 
    virtual void SetParentWindow(TSharedPtr<class SWindow> Window) = 0;
 
    virtual void ShowFloatingCloseButton(bool bShow, bool bDraggable) = 0;
 
    virtual void CheckTickActivity() {};
    
    virtual void SetParentDockTab(TSharedPtr<class SDockTab> DockTab) {};
 
public:
 
    DECLARE_EVENT_OneParam(IWebBrowserWindow, FOnDocumentStateChanged, EWebBrowserDocumentState /*NewState*/);
    virtual FOnDocumentStateChanged& OnDocumentStateChanged() = 0;
 
    DECLARE_EVENT_OneParam(IWebBrowserWindow, FOnTitleChanged, FString /*NewTitle*/);
    virtual FOnTitleChanged& OnTitleChanged() = 0;
 
    DECLARE_EVENT_OneParam(IWebBrowserWindow, FOnUrlChanged, FString /*NewUrl*/);
    virtual FOnUrlChanged& OnUrlChanged() = 0;
 
    DECLARE_EVENT_OneParam(IWebBrowserWindow, FOnToolTip, FString /*ToolTipText*/);
    virtual FOnToolTip& OnToolTip() = 0;
 
    DECLARE_EVENT(IWebBrowserWindow, FOnNeedsRedraw)
    virtual FOnNeedsRedraw& OnNeedsRedraw() = 0;
    
    DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnBeforeBrowse, const FString& /*Url*/, const FWebNavigationRequest& /*Request*/)
    virtual FOnBeforeBrowse& OnBeforeBrowse() = 0;
    
    DECLARE_DELEGATE_RetVal_ThreeParams(bool, FOnLoadUrl, const FString& /*Method*/, const FString& /*Url*/, FString& /*OutBody*/)
    virtual FOnLoadUrl& OnLoadUrl() = 0;
 
    DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnBeforePopupDelegate, FString, FString);
    virtual FOnBeforePopupDelegate& OnBeforePopup() = 0;
 
    typedef TMap<FString, FString> FRequestHeaders;
    DECLARE_DELEGATE_FourParams(FOnBeforeResourceLoadDelegate, FString /*Url*/, FString /*ResourceType*/, FRequestHeaders& /*AdditionalHeaders*/, const bool /*AllowUserCredentials*/);
    virtual FOnBeforeResourceLoadDelegate& OnBeforeResourceLoad() = 0;
 
    DECLARE_DELEGATE_FourParams(FOnResourceLoadCompleteDelegate, FString /*Url*/, FString /*ResourceType*/, FString /*RequestStatus*/, int64 /*ContentLength*/);
    virtual FOnResourceLoadCompleteDelegate& OnResourceLoadComplete() = 0;
 
    DECLARE_DELEGATE_FourParams(FOnConsoleMessageDelegate, const FString& /*Message*/, const FString& /*Source*/, int32 /*Line*/, EWebBrowserConsoleLogSeverity /*severity*/);
    virtual FOnConsoleMessageDelegate& OnConsoleMessage() = 0;
 
    DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnCreateWindow, const TWeakPtr<IWebBrowserWindow>& /*NewBrowserWindow*/, const TWeakPtr<IWebBrowserPopupFeatures>& /* PopupFeatures*/)
    virtual FOnCreateWindow& OnCreateWindow() = 0;
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnCloseWindow, const TWeakPtr<IWebBrowserWindow>& /*BrowserWindow*/)
    virtual FOnCloseWindow& OnCloseWindow() = 0;
 
    DECLARE_DELEGATE(FOnFloatingCloseButtonPressed)
    virtual FOnFloatingCloseButtonPressed& OnFloatingCloseButtonPressed() = 0;
 
    DECLARE_EVENT_OneParam(IWebBrowserWindow, FOnShowPopup, const FIntRect& /*PopupSize*/)
    virtual FOnShowPopup& OnShowPopup() = 0;
 
    DECLARE_EVENT(IWebBrowserWindow, FOnDismissPopup)
    virtual FOnDismissPopup& OnDismissPopup() = 0;
 
    DECLARE_DELEGATE_RetVal_OneParam(EWebBrowserDialogEventResponse, FOnShowDialog, const TWeakPtr<IWebBrowserDialog>& /*DialogParams*/)
    virtual FOnShowDialog& OnShowDialog() = 0;
 
    DECLARE_DELEGATE(FOnDismissAllDialogs)
    virtual FOnDismissAllDialogs& OnDismissAllDialogs() = 0;
 
    DECLARE_DELEGATE_RetVal(bool, FOnSuppressContextMenu);
    virtual FOnSuppressContextMenu& OnSuppressContextMenu() = 0;
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyDown, const FKeyEvent& /*KeyEvent*/);
    virtual FOnUnhandledKeyDown& OnUnhandledKeyDown() = 0;
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyUp, const FKeyEvent& /*KeyEvent*/);
    virtual FOnUnhandledKeyUp& OnUnhandledKeyUp() = 0;
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyChar, const FCharacterEvent& /*CharacterEvent*/);
    virtual FOnUnhandledKeyChar& OnUnhandledKeyChar() = 0;
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnDragWindow, const FPointerEvent& /*MouseEvent*/)
    virtual FOnDragWindow& OnDragWindow() = 0;
 
    DECLARE_DELEGATE_RetVal(bool, FOnCheckVisibility);
    virtual FOnCheckVisibility& OnCheckVisibility()
    {
        return OnCheckVisibilityDelegate;
    }
 
    virtual bool CheckVisibility()
    {
        return !OnCheckVisibilityDelegate.IsBound() || OnCheckVisibilityDelegate.Execute();
    }
 
protected:
 
    virtual ~IWebBrowserWindow() { };
 
private:
    FOnCheckVisibility OnCheckVisibilityDelegate;
 
};