SWebBrowserView.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Input/PopupMethodReply.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Framework/Application/IMenu.h"
#include "Framework/SlateDelegates.h"
#include "Widgets/SViewport.h"
#include "IWebBrowserSingleton.h"
 
class FWebBrowserViewport;
class IWebBrowserAdapter;
class IWebBrowserDialog;
class IWebBrowserPopupFeatures;
class IWebBrowserWindow;
struct FWebNavigationRequest;
enum class EWebBrowserDialogEventResponse;
enum class EWebBrowserDocumentState;
enum class EWebBrowserConsoleLogSeverity;
 
DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnBeforePopupDelegate, FString, FString);
DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnCreateWindowDelegate, const TWeakPtr<IWebBrowserWindow>&, const TWeakPtr<IWebBrowserPopupFeatures>&);
DECLARE_DELEGATE_RetVal_OneParam(bool, FOnCloseWindowDelegate, const TWeakPtr<IWebBrowserWindow>&);
DECLARE_DELEGATE_RetVal_OneParam(TSharedPtr<IToolTip>, FOnCreateToolTip, const FText&);
DECLARE_DELEGATE_FourParams(FOnConsoleMessageDelegate, const FString& /*Message*/, const FString& /*Source*/, int32 /*Line*/, EWebBrowserConsoleLogSeverity /*Severity*/);
DECLARE_DELEGATE(FOnFloatingCloseButtonPressedDelegate);
 
#if WITH_CEF3 || PLATFORM_APPLE
typedef SViewport SWebBrowserWidget;
#else
typedef SWidget SWebBrowserWidget;
#endif
 
class SWebBrowserView
    : public SCompoundWidget
{
public:
    DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnBeforeBrowse, const FString& /*Url*/, const FWebNavigationRequest& /*Request*/)
    DECLARE_DELEGATE_RetVal_ThreeParams(bool, FOnLoadUrl, const FString& /*Method*/, const FString& /*Url*/, FString& /* Response */)
    DECLARE_DELEGATE_RetVal_OneParam(EWebBrowserDialogEventResponse, FOnShowDialog, const TWeakPtr<IWebBrowserDialog>&);
    DECLARE_DELEGATE_RetVal(bool, FOnSuppressContextMenu);
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnDragWindow, const FPointerEvent& /* MouseEvent */);
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyDown, const FKeyEvent& /*KeyEvent*/);
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyUp, const FKeyEvent& /*KeyEvent*/);
    DECLARE_DELEGATE_RetVal_OneParam(bool, FOnUnhandledKeyChar, const FCharacterEvent& /*CharacterEvent*/);
 
 
    SLATE_BEGIN_ARGS(SWebBrowserView)
        : _InitialURL(TEXT("https://www.google.com"))
        , _ShowErrorMessage(true)
        , _SupportsTransparency(false)
        , _InterceptLoadRequests(true)
        , _SupportsThumbMouseButtonNavigation(true)
        , _BackgroundColor(255,255,255,255)
        , _BrowserFrameRate(24)
        , _PopupMenuMethod(TOptional<EPopupMethod>())
        , _ContextSettings()
        , _AltRetryDomains(TArray<FString>())
        , _ViewportSize(FVector2D::ZeroVector)
    { }
 
        SLATE_ARGUMENT(TSharedPtr<SWindow>, ParentWindow)
 
        
        SLATE_ARGUMENT(FString, InitialURL)
 
        
        SLATE_ARGUMENT(TOptional<FString>, ContentsToLoad)
 
        
        SLATE_ARGUMENT(bool, ShowErrorMessage)
 
        
        SLATE_ARGUMENT(bool, SupportsTransparency)
 
        
        SLATE_ARGUMENT(bool, InterceptLoadRequests)
 
        
        SLATE_ARGUMENT(bool, SupportsThumbMouseButtonNavigation)
 
        
        SLATE_ARGUMENT(FColor, BackgroundColor)
 
        
        SLATE_ARGUMENT(int, BrowserFrameRate)
 
        
        SLATE_ARGUMENT(TOptional<EPopupMethod>, PopupMenuMethod)
 
        
        SLATE_ARGUMENT(TOptional<FBrowserContextSettings>, ContextSettings)
 
        
        SLATE_ARGUMENT(TArray<FString>, AltRetryDomains)
 
        
        SLATE_ATTRIBUTE(FVector2D, ViewportSize);
 
        SLATE_EVENT(FSimpleDelegate, OnLoadCompleted)
 
        SLATE_EVENT(FSimpleDelegate, OnLoadError)
 
        SLATE_EVENT(FSimpleDelegate, OnLoadStarted)
 
        SLATE_EVENT(FOnTextChanged, OnTitleChanged)
 
        SLATE_EVENT(FOnTextChanged, OnUrlChanged)
 
        SLATE_EVENT(FOnBeforePopupDelegate, OnBeforePopup)
 
        SLATE_EVENT(FOnCreateWindowDelegate, OnCreateWindow)
 
        SLATE_EVENT(FOnCloseWindowDelegate, OnCloseWindow)
 
        SLATE_EVENT(FOnFloatingCloseButtonPressedDelegate, OnFloatingCloseButtonPressed)
 
        SLATE_EVENT(FOnBeforeBrowse, OnBeforeNavigation)
 
        SLATE_EVENT(FOnLoadUrl, OnLoadUrl)
 
        SLATE_EVENT(FOnShowDialog, OnShowDialog)
 
        SLATE_EVENT(FSimpleDelegate, OnDismissAllDialogs)
 
        SLATE_EVENT(FOnSuppressContextMenu, OnSuppressContextMenu);
 
        SLATE_EVENT(FOnCreateToolTip, OnCreateToolTip)
 
        SLATE_EVENT(FOnDragWindow, OnDragWindow)
 
        SLATE_EVENT(FOnUnhandledKeyDown, OnUnhandledKeyDown)
 
        SLATE_EVENT(FOnUnhandledKeyUp, OnUnhandledKeyUp)
 
        SLATE_EVENT(FOnUnhandledKeyChar, OnUnhandledKeyChar)
 
        SLATE_EVENT(FOnConsoleMessageDelegate, OnConsoleMessage)
 
    SLATE_END_ARGS()
 
 
    WEBBROWSER_API SWebBrowserView();
 
    WEBBROWSER_API ~SWebBrowserView();
 
    virtual bool SupportsKeyboardFocus() const override {return true;}
 
    virtual FReply OnFocusReceived(const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent) override;
 
    WEBBROWSER_API void Construct(const FArguments& InArgs, const TSharedPtr<IWebBrowserWindow>& InWebBrowserWindow = nullptr);
 
    WEBBROWSER_API virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
 
    WEBBROWSER_API void LoadURL(FString NewURL);
 
    WEBBROWSER_API void LoadString(FString Contents, FString DummyURL);
 
    WEBBROWSER_API void Reload();
 
    WEBBROWSER_API void StopLoad();
 
    WEBBROWSER_API FText GetTitleText() const;
 
    WEBBROWSER_API FString GetUrl() const;
 
    WEBBROWSER_API FText GetAddressBarUrlText() const;
 
    WEBBROWSER_API bool IsLoaded() const;
 
    WEBBROWSER_API bool IsLoading() const;
 
    WEBBROWSER_API bool IsInitialized() const;
 
    WEBBROWSER_API void ExecuteJavascript(const FString& ScriptText);
 
    WEBBROWSER_API void GetSource(TFunction<void (const FString&)> Callback) const ;
 
    WEBBROWSER_API void BindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true);
 
    WEBBROWSER_API void UnbindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true);
 
    WEBBROWSER_API void BindAdapter(const TSharedRef<IWebBrowserAdapter>& Adapter);
 
    WEBBROWSER_API void UnbindAdapter(const TSharedRef<IWebBrowserAdapter>& Adapter);
 
    WEBBROWSER_API void BindInputMethodSystem(ITextInputMethodSystem* TextInputMethodSystem);
 
    WEBBROWSER_API void UnbindInputMethodSystem();
 
    WEBBROWSER_API bool CanGoBack() const;
 
    WEBBROWSER_API void GoBack();
 
    WEBBROWSER_API bool CanGoForward() const;
 
    WEBBROWSER_API void GoForward();
 
    WEBBROWSER_API void SetParentWindow(TSharedPtr<SWindow> Window);
 
    WEBBROWSER_API void SetBrowserKeyboardFocus();
 
    WEBBROWSER_API void CloseBrowser();
 
    WEBBROWSER_API void ShowFloatingCloseButton(bool bShow, bool bDraggable);
 
    WEBBROWSER_API TSharedPtr<IWebBrowserWindow> GetBrowserWindow() const;
 
private:
 
    WEBBROWSER_API void SetupParentWindowHandlers();
 
    WEBBROWSER_API void HandleBrowserWindowDocumentStateChanged(EWebBrowserDocumentState NewState);
 
    WEBBROWSER_API void HandleBrowserWindowNeedsRedraw();
 
    WEBBROWSER_API void HandleTitleChanged(FString NewTitle);
 
    WEBBROWSER_API void HandleUrlChanged(FString NewUrl);
 
    WEBBROWSER_API void HandleToolTip(FString ToolTipText);
 
    WEBBROWSER_API bool HandleBeforeNavigation(const FString& Url, const FWebNavigationRequest& Request);
 
    WEBBROWSER_API bool HandleLoadUrl(const FString& Method, const FString& Url, FString& OutResponse);
 
    WEBBROWSER_API bool HandleCreateWindow(const TWeakPtr<IWebBrowserWindow>& NewBrowserWindow, const TWeakPtr<IWebBrowserPopupFeatures>& PopupFeatures);
 
    WEBBROWSER_API bool HandleCloseWindow(const TWeakPtr<IWebBrowserWindow>& BrowserWindow);
 
    WEBBROWSER_API void HandleFloatingCloseButtonPressed();
 
    WEBBROWSER_API EWebBrowserDialogEventResponse HandleShowDialog(const TWeakPtr<IWebBrowserDialog>& DialogParams);
 
    WEBBROWSER_API void HandleDismissAllDialogs();
 
    WEBBROWSER_API bool HandleBeforePopup(FString URL, FString Target);
 
    WEBBROWSER_API void HandleShowPopup(const FIntRect& PopupSize);
 
    WEBBROWSER_API void HandleDismissPopup();
 
    WEBBROWSER_API void HandleMenuDismissed(TSharedRef<IMenu>);
 
    virtual FPopupMethodReply OnQueryPopupMethod() const override
    {
        return PopupMenuMethod.IsSet()
            ? FPopupMethodReply::UseMethod(PopupMenuMethod.GetValue())
            : FPopupMethodReply::Unhandled();
    }
 
    WEBBROWSER_API void HandleWindowDeactivated();
    WEBBROWSER_API void HandleWindowActivated();
    WEBBROWSER_API bool UnhandledKeyDown(const FKeyEvent& KeyEvent);
    WEBBROWSER_API bool UnhandledKeyUp(const FKeyEvent& KeyEvent);
    WEBBROWSER_API bool UnhandledKeyChar(const FCharacterEvent& CharacterEvent);
 
    WEBBROWSER_API bool HandleDrag(const FPointerEvent& MouseEvent);
    WEBBROWSER_API void HandleConsoleMessage(const FString& Message, const FString& Source, int32 Line, EWebBrowserConsoleLogSeverity Serverity);
 
    WEBBROWSER_API TOptional<FSlateRenderTransform> GetPopupRenderTransform() const;
private:
 
    TSharedPtr<IWebBrowserWindow> BrowserWindow;
    mutable TWeakPtr<SWindow> SlateParentWindowPtr;
    TSharedPtr<FWebBrowserViewport> BrowserViewport;
    TSharedPtr<FWebBrowserViewport> MenuViewport;
    TSharedPtr<SWebBrowserWidget> BrowserWidget;
 
    TArray<TSharedRef<IWebBrowserAdapter>> Adapters;
 
    TWeakPtr<IMenu> PopupMenuPtr;
 
    TOptional<EPopupMethod> PopupMenuMethod;
 
    FText AddressBarUrl;
 
    FSimpleDelegate OnLoadCompleted;
 
    FSimpleDelegate OnLoadError;
 
    FSimpleDelegate OnLoadStarted;
 
    FOnTextChanged OnTitleChanged;
 
    FOnTextChanged OnUrlChanged;
 
    FOnBeforePopupDelegate OnBeforePopup;
 
    FOnCreateWindowDelegate OnCreateWindow;
 
    FOnCloseWindowDelegate OnCloseWindow;
 
    FOnFloatingCloseButtonPressedDelegate OnFloatingCloseButtonPressed;
 
    FOnBeforeBrowse OnBeforeNavigation;
 
    FOnLoadUrl OnLoadUrl;
 
    FOnShowDialog OnShowDialog;
 
    FSimpleDelegate OnDismissAllDialogs;
 
    FOnSuppressContextMenu OnSuppressContextMenu;
 
    FOnCreateToolTip OnCreateToolTip;
 
    FOnDragWindow OnDragWindow;
 
    FOnUnhandledKeyDown OnUnhandledKeyDown;
 
    FOnUnhandledKeyUp OnUnhandledKeyUp;
 
    FOnUnhandledKeyChar OnUnhandledKeyChar;
 
    FOnConsoleMessageDelegate OnConsoleMessage;
 
protected:
    WEBBROWSER_API bool HandleSuppressContextMenu();
 
};