SWebBrowser.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Layout/Visibility.h"
#include "Input/Reply.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
#include "SWebBrowserView.h"
 
class IWebBrowserAdapter;
class IWebBrowserDialog;
class IWebBrowserWindow;
class SEditableTextBox;
struct FWebNavigationRequest;
enum class EWebBrowserDialogEventResponse;
 
DECLARE_DELEGATE_RetVal(bool, FOnSuppressContextMenu);
 
class SWebBrowser
    : public SCompoundWidget
{
public:
    DECLARE_DELEGATE_RetVal_TwoParams(bool, FOnBeforeBrowse, const FString&, 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_OneParam(bool, FOnDragWindow, const FPointerEvent& /* MouseEvent */);
 
    SLATE_BEGIN_ARGS(SWebBrowser)
        : _InitialURL(TEXT("https://www.google.com"))
        , _ShowControls(true)
        , _ShowAddressBar(false)
        , _ShowErrorMessage(true)
        , _SupportsTransparency(false)
        , _SupportsThumbMouseButtonNavigation(true)
        , _ShowInitialThrobber(true)
        , _BackgroundColor(255,255,255,255)
        , _BrowserFrameRate(24)
        , _PopupMenuMethod(TOptional<EPopupMethod>())
        , _UseSmoothResizing(true)
        , _ViewportSize(FVector2D::ZeroVector)
    { }
 
        SLATE_ARGUMENT(TSharedPtr<SWindow>, ParentWindow)
 
        
        SLATE_ARGUMENT(FString, InitialURL)
 
        
        SLATE_ARGUMENT(TOptional<FString>, ContentsToLoad)
 
        
        SLATE_ARGUMENT(bool, ShowControls)
 
        
        SLATE_ARGUMENT(bool, ShowAddressBar)
 
        
        SLATE_ARGUMENT(bool, ShowErrorMessage)
 
        
        SLATE_ARGUMENT(bool, SupportsTransparency)
 
        
        SLATE_ARGUMENT(bool, SupportsThumbMouseButtonNavigation)
 
        
        SLATE_ARGUMENT(bool, ShowInitialThrobber)
 
        
        SLATE_ARGUMENT(FColor, BackgroundColor)
 
        
        SLATE_ARGUMENT(int , BrowserFrameRate)
 
        
        SLATE_ARGUMENT(TOptional<EPopupMethod>, PopupMenuMethod)
 
        
        SLATE_ARGUMENT(bool, UseSmoothResizing);
        
        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(FOnBeforeBrowse, OnBeforeNavigation)
 
        SLATE_EVENT(FOnLoadUrl, OnLoadUrl)
 
        SLATE_EVENT(FOnShowDialog, OnShowDialog)
 
        SLATE_EVENT(FSimpleDelegate, OnDismissAllDialogs)
 
        SLATE_EVENT(FOnSuppressContextMenu, OnSuppressContextMenu);
 
        SLATE_EVENT(FOnDragWindow, OnDragWindow);
 
        SLATE_EVENT(FOnConsoleMessageDelegate, OnConsoleMessage);
 
    SLATE_END_ARGS()
 
 
    WEBBROWSER_API SWebBrowser();
 
    WEBBROWSER_API ~SWebBrowser();
 
    virtual bool SupportsKeyboardFocus() const override {return true;}
 
    virtual void Tick(const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override;
    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 Construct(const FArguments& InArgs, const TSharedPtr<IWebBrowserWindow>& InWebBrowserWindow = nullptr);
 
    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 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);
 
private:
 
    WEBBROWSER_API FReply OnBackClicked();
 
    WEBBROWSER_API FReply OnForwardClicked();
 
    WEBBROWSER_API FText GetReloadButtonText() const;
 
    WEBBROWSER_API FReply OnReloadClicked();
 
    WEBBROWSER_API void OnUrlTextCommitted( const FText& NewText, ETextCommit::Type CommitType );
 
    WEBBROWSER_API EVisibility GetViewportVisibility() const;
 
    WEBBROWSER_API EVisibility GetLoadingThrobberVisibility() const;
 
private:
 
    TSharedPtr<SWebBrowserView> BrowserView;
 
    TSharedPtr< SEditableTextBox > InputText;
 
    FSimpleDelegate OnLoadCompleted;
 
    FSimpleDelegate OnLoadError;
 
    FSimpleDelegate OnLoadStarted;
 
    FOnTextChanged OnTitleChanged;
 
    FOnTextChanged OnUrlChanged;
 
    FOnBeforePopupDelegate OnBeforePopup;
 
    FOnConsoleMessageDelegate OnConsoleMessage;
 
    FOnCreateWindowDelegate OnCreateWindow;
 
    FOnCloseWindowDelegate OnCloseWindow;
 
    FOnBeforeBrowse OnBeforeNavigation;
 
    FOnLoadUrl OnLoadUrl;
 
    FOnShowDialog OnShowDialog;
 
    FSimpleDelegate OnDismissAllDialogs;
 
    bool bShowInitialThrobber;
 
    TSharedPtr<IWebBrowserWindow> WebBrowserWindow;
};