Files
UnrealEngineUWP/Engine/Source/Runtime/WebBrowser/Private/SWebBrowser.cpp

372 lines
7.9 KiB
C++
Raw Normal View History

// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved.
#include "SWebBrowser.h"
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340) #lockdown Nick.Penwarden #rb none ========================== MAJOR FEATURES + CHANGES ========================== Change 3209340 on 2016/11/23 by Ben.Marsh Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h. Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms. * Every header now includes everything it needs to compile. * There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first. * There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h. * Every .cpp file includes its matching .h file first. * This helps validate that each header is including everything it needs to compile. * No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more. * You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there. * There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible. * No engine code explicitly includes a precompiled header any more. * We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies. * PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files. Tool used to generate this transform is at Engine\Source\Programs\IncludeTool. [CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
#include "Widgets/Text/STextBlock.h"
#include "Widgets/Input/SEditableTextBox.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/Images/SThrobber.h"
#define LOCTEXT_NAMESPACE "WebBrowser"
SWebBrowser::SWebBrowser()
{
}
SWebBrowser::~SWebBrowser()
{
}
void SWebBrowser::Construct(const FArguments& InArgs, const TSharedPtr<IWebBrowserWindow>& BrowserWindow)
{
OnLoadCompleted = InArgs._OnLoadCompleted;
OnLoadError = InArgs._OnLoadError;
OnLoadStarted = InArgs._OnLoadStarted;
OnTitleChanged = InArgs._OnTitleChanged;
OnUrlChanged = InArgs._OnUrlChanged;
OnBeforeNavigation = InArgs._OnBeforeNavigation;
OnLoadUrl = InArgs._OnLoadUrl;
OnShowDialog = InArgs._OnShowDialog;
OnDismissAllDialogs = InArgs._OnDismissAllDialogs;
OnBeforePopup = InArgs._OnBeforePopup;
OnCreateWindow = InArgs._OnCreateWindow;
OnCloseWindow = InArgs._OnCloseWindow;
bShowInitialThrobber = InArgs._ShowInitialThrobber;
ChildSlot
[
SNew(SVerticalBox)
+SVerticalBox::Slot()
.AutoHeight()
[
SNew(SHorizontalBox)
.Visibility((InArgs._ShowControls || InArgs._ShowAddressBar) ? EVisibility::Visible : EVisibility::Collapsed)
+ SHorizontalBox::Slot()
.Padding(0, 5)
.AutoWidth()
[
SNew(SHorizontalBox)
.Visibility(InArgs._ShowControls ? EVisibility::Visible : EVisibility::Collapsed)
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(SButton)
.Text(LOCTEXT("Back","Back"))
.IsEnabled(this, &SWebBrowser::CanGoBack)
.OnClicked(this, &SWebBrowser::OnBackClicked)
]
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(SButton)
.Text(LOCTEXT("Forward", "Forward"))
.IsEnabled(this, &SWebBrowser::CanGoForward)
.OnClicked(this, &SWebBrowser::OnForwardClicked)
]
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(SButton)
.Text(this, &SWebBrowser::GetReloadButtonText)
.OnClicked(this, &SWebBrowser::OnReloadClicked)
]
+SHorizontalBox::Slot()
.FillWidth(1.0f)
.VAlign(VAlign_Center)
.HAlign(HAlign_Right)
.Padding(5)
[
SNew(STextBlock)
.Visibility(InArgs._ShowAddressBar ? EVisibility::Collapsed : EVisibility::Visible )
.Text(this, &SWebBrowser::GetTitleText)
.Justification(ETextJustify::Right)
]
]
+SHorizontalBox::Slot()
.VAlign(VAlign_Center)
.HAlign(HAlign_Fill)
.Padding(5.f, 5.f)
[
// @todo: A proper addressbar widget should go here, for now we use a simple textbox.
SAssignNew(InputText, SEditableTextBox)
.Visibility(InArgs._ShowAddressBar ? EVisibility::Visible : EVisibility::Collapsed)
.OnTextCommitted(this, &SWebBrowser::OnUrlTextCommitted)
.Text(this, &SWebBrowser::GetAddressBarUrlText)
.SelectAllTextWhenFocused(true)
.ClearKeyboardFocusOnCommit(true)
.RevertTextOnEscape(true)
]
]
+SVerticalBox::Slot()
[
SNew(SOverlay)
+ SOverlay::Slot()
[
SAssignNew(BrowserView, SWebBrowserView, BrowserWindow)
.ParentWindow(InArgs._ParentWindow)
.InitialURL(InArgs._InitialURL)
.ContentsToLoad(InArgs._ContentsToLoad)
.ShowErrorMessage(InArgs._ShowErrorMessage)
.SupportsTransparency(InArgs._SupportsTransparency)
.SupportsThumbMouseButtonNavigation(InArgs._SupportsThumbMouseButtonNavigation)
.BackgroundColor(InArgs._BackgroundColor)
.PopupMenuMethod(InArgs._PopupMenuMethod)
.ViewportSize(InArgs._ViewportSize)
.OnLoadCompleted(OnLoadCompleted)
.OnLoadError(OnLoadError)
.OnLoadStarted(OnLoadStarted)
.OnTitleChanged(OnTitleChanged)
.OnUrlChanged(OnUrlChanged)
.OnBeforePopup(OnBeforePopup)
.OnCreateWindow(OnCreateWindow)
.OnCloseWindow(OnCloseWindow)
.OnBeforeNavigation(OnBeforeNavigation)
.OnLoadUrl(OnLoadUrl)
.OnShowDialog(OnShowDialog)
.OnDismissAllDialogs(OnDismissAllDialogs)
.Visibility(this, &SWebBrowser::GetViewportVisibility)
.OnSuppressContextMenu(InArgs._OnSuppressContextMenu)
]
+ SOverlay::Slot()
.HAlign(HAlign_Center)
.VAlign(VAlign_Center)
[
SNew(SCircularThrobber)
.Radius(10.0f)
.ToolTipText(LOCTEXT("LoadingThrobberToolTip", "Loading page..."))
.Visibility(this, &SWebBrowser::GetLoadingThrobberVisibility)
]
]
];
}
void SWebBrowser::LoadURL(FString NewURL)
{
if (BrowserView.IsValid())
{
BrowserView->LoadURL(NewURL);
}
}
void SWebBrowser::LoadString(FString Contents, FString DummyURL)
{
if (BrowserView.IsValid())
{
BrowserView->LoadString(Contents, DummyURL);
}
}
void SWebBrowser::Reload()
{
if (BrowserView.IsValid())
{
BrowserView->Reload();
}
}
void SWebBrowser::StopLoad()
{
if (BrowserView.IsValid())
{
BrowserView->StopLoad();
}
}
FText SWebBrowser::GetTitleText() const
{
if (BrowserView.IsValid())
{
return BrowserView->GetTitleText();
}
return LOCTEXT("InvalidWindow", "Browser Window is not valid/supported");
}
FString SWebBrowser::GetUrl() const
{
if (BrowserView.IsValid())
{
return BrowserView->GetUrl();
}
return FString();
}
FText SWebBrowser::GetAddressBarUrlText() const
{
if(BrowserView.IsValid())
{
return BrowserView->GetAddressBarUrlText();
}
return FText::GetEmpty();
}
bool SWebBrowser::IsLoaded() const
{
if (BrowserView.IsValid())
{
return BrowserView->IsLoaded();
}
return false;
}
bool SWebBrowser::IsLoading() const
{
if (BrowserView.IsValid())
{
return BrowserView->IsLoading();
}
return false;
}
bool SWebBrowser::CanGoBack() const
{
if (BrowserView.IsValid())
{
return BrowserView->CanGoBack();
}
return false;
}
void SWebBrowser::GoBack()
{
if (BrowserView.IsValid())
{
BrowserView->GoBack();
}
}
FReply SWebBrowser::OnBackClicked()
{
GoBack();
return FReply::Handled();
}
bool SWebBrowser::CanGoForward() const
{
if (BrowserView.IsValid())
{
return BrowserView->CanGoForward();
}
return false;
}
void SWebBrowser::GoForward()
{
if (BrowserView.IsValid())
{
BrowserView->GoForward();
}
}
FReply SWebBrowser::OnForwardClicked()
{
GoForward();
return FReply::Handled();
}
FText SWebBrowser::GetReloadButtonText() const
{
static FText ReloadText = LOCTEXT("Reload", "Reload");
static FText StopText = LOCTEXT("StopText", "Stop");
if (BrowserView.IsValid())
{
if (BrowserView->IsLoading())
{
return StopText;
}
}
return ReloadText;
}
FReply SWebBrowser::OnReloadClicked()
{
if (IsLoading())
{
StopLoad();
}
else
{
Reload();
}
return FReply::Handled();
}
void SWebBrowser::OnUrlTextCommitted( const FText& NewText, ETextCommit::Type CommitType )
{
if(CommitType == ETextCommit::OnEnter)
{
LoadURL(NewText.ToString());
}
}
EVisibility SWebBrowser::GetViewportVisibility() const
{
if (!bShowInitialThrobber || BrowserView->IsInitialized())
{
return EVisibility::Visible;
}
return EVisibility::Hidden;
}
EVisibility SWebBrowser::GetLoadingThrobberVisibility() const
{
if (bShowInitialThrobber && !BrowserView->IsInitialized())
{
return EVisibility::Visible;
}
return EVisibility::Hidden;
}
void SWebBrowser::ExecuteJavascript(const FString& ScriptText)
{
if (BrowserView.IsValid())
{
BrowserView->ExecuteJavascript(ScriptText);
}
}
void SWebBrowser::GetSource(TFunction<void (const FString&)> Callback) const
{
if (BrowserView.IsValid())
{
BrowserView->GetSource(Callback);
}
}
void SWebBrowser::BindUObject(const FString& Name, UObject* Object, bool bIsPermanent)
{
if (BrowserView.IsValid())
{
BrowserView->BindUObject(Name, Object, bIsPermanent);
}
}
void SWebBrowser::UnbindUObject(const FString& Name, UObject* Object, bool bIsPermanent)
{
if (BrowserView.IsValid())
{
BrowserView->UnbindUObject(Name, Object, bIsPermanent);
}
}
void SWebBrowser::BindAdapter(const TSharedRef<IWebBrowserAdapter>& Adapter)
{
if (BrowserView.IsValid())
{
BrowserView->BindAdapter(Adapter);
}
}
void SWebBrowser::UnbindAdapter(const TSharedRef<IWebBrowserAdapter>& Adapter)
{
if (BrowserView.IsValid())
{
BrowserView->UnbindAdapter(Adapter);
}
}
#undef LOCTEXT_NAMESPACE