CEFWebInterfaceBrowserWindow.h
24.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
// Engine/Source/Runtime/WebBrowser/Private/CEF/CEFWebBrowserWindow.h
#pragma once
#include "CoreMinimal.h"
#include "Input/CursorReply.h"
#include "Input/Events.h"
#include "Input/Reply.h"
#include "Widgets/SViewport.h"
#include "WebInterfaceBrowserSingleton.h"
#if WITH_CEF3
#include "IWebInterfaceBrowserWindow.h"
#include "CEFInterfaceBrowserHandler.h"
#if PLATFORM_WINDOWS
#include "Windows/WindowsHWrapper.h"
#include "Windows/AllowWindowsPlatformTypes.h"
#include "Windows/AllowWindowsPlatformAtomics.h"
#endif
THIRD_PARTY_INCLUDES_START
#if PLATFORM_APPLE
PRAGMA_DISABLE_DEPRECATION_WARNINGS
#endif
#pragma push_macro("OVERRIDE")
# undef OVERRIDE // cef headers provide their own OVERRIDE macro
# include "include/internal/cef_ptr.h"
# include "include/cef_render_handler.h"
# include "include/cef_jsdialog_handler.h"
#pragma pop_macro("OVERRIDE")
#if PLATFORM_APPLE
PRAGMA_ENABLE_DEPRECATION_WARNINGS
#endif
THIRD_PARTY_INCLUDES_END
#if PLATFORM_WINDOWS
#include "Windows/HideWindowsPlatformAtomics.h"
#include "Windows/HideWindowsPlatformTypes.h"
#endif
#endif
class FBrowserBufferedVideo;
class FCEFInterfaceBrowserHandler;
class FCEFInterfaceJSScripting;
class FSlateUpdatableTexture;
class IWebInterfaceBrowserPopupFeatures;
class IWebInterfaceBrowserWindow;
struct Rect;
class FSlateShaderResource;
enum class EWebInterfaceBrowserDocumentState;
struct FGeometry;
struct FPointerEvent;
class UObject;
struct FInputEvent;
class FWebJSScripting;
class FCEFInterfaceImeHandler;
class ITextInputMethodSystem;
#if WITH_CEF3
/**
* Helper for containing items required for CEF browser window creation.
*/
struct FWebInterfaceBrowserWindowInfo
{
FWebInterfaceBrowserWindowInfo(CefRefPtr<CefBrowser> InBrowser, CefRefPtr<FCEFInterfaceBrowserHandler> InHandler)
: Browser(InBrowser)
, Handler(InHandler)
{}
CefRefPtr<CefBrowser> Browser;
CefRefPtr<FCEFInterfaceBrowserHandler> Handler;
};
/**
* Representation of a window drag region.
*/
struct FWebInterfaceBrowserDragRegion
{
FWebInterfaceBrowserDragRegion(const FIntRect& InRect, bool bInDraggable)
: Rect(InRect)
, bDraggable(bInDraggable)
{}
FIntRect Rect;
bool bDraggable;
};
/**
* Implementation of interface for dealing with a Web Browser window.
*/
class FCEFWebInterfaceBrowserWindow
: public IWebInterfaceBrowserWindow
, public TSharedFromThis<FCEFWebInterfaceBrowserWindow>
{
// Allow the Handler to access functions only it needs
friend class FCEFInterfaceBrowserHandler;
// The WebBrowserSingleton should be the only one creating instances of this class
friend class FWebInterfaceBrowserSingleton;
// CreateWidget should only be called by the WebBrowserView
friend class SWebInterfaceBrowserView;
private:
/**
* Creates and initializes a new instance.
*
* @param Browser The CefBrowser object representing this browser window.
* @param Handler Pointer to the CEF handler for this window.
* @param Url The Initial URL that will be loaded.
* @param ContentsToLoad Optional string to load as a web page.
* @param bShowErrorMessage Whether to show an error message in case of loading errors.
* @param bThumbMouseButtonNavigation Whether to allow forward and back navigation via the mouse thumb buttons.
* @param bUseTransparency Whether to enable transparency.
* @param bJSBindingToLoweringEnabled Whether we ToLower all JavaScript member names.
*/
FCEFWebInterfaceBrowserWindow(CefRefPtr<CefBrowser> Browser, CefRefPtr<FCEFInterfaceBrowserHandler> Handler, FString Url, TOptional<FString> ContentsToLoad, bool bShowErrorMessage, bool bThumbMouseButtonNavigation, bool bUseTransparency, bool bInUseNativeCursors, bool bJSBindingToLoweringEnabled);
/**
* Create the SWidget for this WebBrowserWindow
*/
TSharedRef<SViewport> CreateWidget();
public:
/** Virtual Destructor. */
virtual ~FCEFWebInterfaceBrowserWindow();
bool IsShowingErrorMessages() { return bShowErrorMessage; }
bool IsThumbMouseButtonNavigationEnabled() { return bThumbMouseButtonNavigation; }
bool UseTransparency() { return bUseTransparency; }
bool UseNativeCursors() { return bUseNativeCursors; }
public:
// IWebBrowserWindow Interface
virtual void LoadURL(FString NewURL) override;
virtual void LoadString(FString Contents, FString DummyURL) override;
virtual void SetViewportSize(FIntPoint WindowSize, FIntPoint WindowPos) override;
virtual FIntPoint GetViewportSize() const override { return FIntPoint::NoneValue; }
virtual FSlateShaderResource* GetTexture(bool bIsPopup = false) override;
virtual bool IsValid() const override;
virtual bool IsInitialized() const override;
virtual bool IsClosing() const override;
virtual EWebInterfaceBrowserDocumentState GetDocumentLoadingState() const override;
virtual FString GetTitle() const override;
virtual FString GetUrl() const override;
virtual void GetSource(TFunction<void (const FString&)> Callback) const override;
virtual bool OnKeyDown(const FKeyEvent& InKeyEvent) override;
virtual bool OnKeyUp(const FKeyEvent& InKeyEvent) override;
virtual bool OnKeyChar(const FCharacterEvent& InCharacterEvent) override;
virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
virtual FReply OnMouseButtonUp(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
virtual FReply OnMouseButtonDoubleClick(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
virtual FReply OnMouseMove(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
virtual void OnMouseLeave(const FPointerEvent& MouseEvent) override;
virtual void SetSupportsMouseWheel(bool bValue) override;
virtual bool GetSupportsMouseWheel() const override;
virtual FReply OnMouseWheel(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup) override;
virtual void OnFocus(bool SetFocus, bool bIsPopup) override;
virtual void OnCaptureLost() override;
virtual bool CanGoBack() const override;
virtual void GoBack() override;
virtual bool CanGoForward() const override;
virtual void GoForward() override;
virtual bool IsLoading() const override;
virtual void Reload() override;
virtual void StopLoad() override;
virtual void ExecuteJavascript(const FString& Script) override;
virtual void CloseBrowser(bool bForce) override;
virtual void BindUObject(const FString& Name, UObject* Object, bool bIsPermanent = true) override;
virtual void UnbindUObject(const FString& Name, UObject* Object = nullptr, bool bIsPermanent = true) override;
virtual void BindInputMethodSystem(ITextInputMethodSystem* TextInputMethodSystem) override;
virtual void UnbindInputMethodSystem() override;
virtual int GetLoadError() override;
virtual void SetIsDisabled(bool bValue) override;
virtual TSharedPtr<SWindow> GetParentWindow() const override;
virtual void SetParentWindow(TSharedPtr<SWindow> Window) override;
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnDocumentStateChanged, FOnDocumentStateChanged);
virtual FOnDocumentStateChanged& OnDocumentStateChanged() override
{
return DocumentStateChangedEvent;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnTitleChanged, FOnTitleChanged);
virtual FOnTitleChanged& OnTitleChanged() override
{
return TitleChangedEvent;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnUrlChanged, FOnUrlChanged);
virtual FOnUrlChanged& OnUrlChanged() override
{
return UrlChangedEvent;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnToolTip, FOnToolTip);
virtual FOnToolTip& OnToolTip() override
{
return ToolTipEvent;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnNeedsRedraw, FOnNeedsRedraw);
virtual FOnNeedsRedraw& OnNeedsRedraw() override
{
return NeedsRedrawEvent;
}
virtual FOnBeforeBrowse& OnBeforeBrowse() override
{
return BeforeBrowseDelegate;
}
virtual FOnLoadUrl& OnLoadUrl() override
{
return LoadUrlDelegate;
}
virtual FOnCreateWindow& OnCreateWindow() override
{
return WebBrowserHandler->OnCreateWindow();
}
virtual FOnCloseWindow& OnCloseWindow() override
{
return CloseWindowDelegate;
}
virtual FCursorReply OnCursorQuery( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent ) override
{
return Cursor == EMouseCursor::Default ? FCursorReply::Unhandled() : FCursorReply::Cursor(Cursor);
}
virtual FOnBeforePopupDelegate& OnBeforePopup() override
{
return WebBrowserHandler->OnBeforePopup();
}
virtual FOnBeforeResourceLoadDelegate& OnBeforeResourceLoad() override
{
if (!WebBrowserHandler->OnBeforeResourceLoad().IsBoundToObject(this))
{
WebBrowserHandler->OnBeforeResourceLoad().BindSP(this, &FCEFWebInterfaceBrowserWindow::HandleOnBeforeResourceLoad);
}
return BeforeResourceLoadDelegate;
}
virtual FOnResourceLoadCompleteDelegate& OnResourceLoadComplete() override
{
if (!WebBrowserHandler->OnResourceLoadComplete().IsBoundToObject(this))
{
WebBrowserHandler->OnResourceLoadComplete().BindSP(this, &FCEFWebInterfaceBrowserWindow::HandleOnResourceLoadComplete);
}
return ResourceLoadCompleteDelegate;
}
virtual FOnConsoleMessageDelegate& OnConsoleMessage() override
{
if (!WebBrowserHandler->OnConsoleMessage().IsBoundToObject(this))
{
WebBrowserHandler->OnConsoleMessage().BindSP(this, &FCEFWebInterfaceBrowserWindow::HandleOnConsoleMessage);
}
return ConsoleMessageDelegate;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnShowPopup, FOnShowPopup);
virtual FOnShowPopup& OnShowPopup() override
{
return ShowPopupEvent;
}
DECLARE_DERIVED_EVENT(FCEFWebInterfaceBrowserWindow, IWebInterfaceBrowserWindow::FOnDismissPopup, FOnDismissPopup);
virtual FOnDismissPopup& OnDismissPopup() override
{
return DismissPopupEvent;
}
virtual FOnShowDialog& OnShowDialog() override
{
return ShowDialogDelegate;
}
virtual FOnDismissAllDialogs& OnDismissAllDialogs() override
{
return DismissAllDialogsDelegate;
}
virtual FOnSuppressContextMenu& OnSuppressContextMenu() override
{
return SuppressContextMenuDelgate;
}
virtual FOnDragWindow& OnDragWindow() override
{
return DragWindowDelegate;
}
virtual FOnUnhandledKeyDown& OnUnhandledKeyDown() override
{
return UnhandledKeyDownDelegate;
}
virtual FOnUnhandledKeyUp& OnUnhandledKeyUp() override
{
return UnhandledKeyUpDelegate;
}
virtual FOnUnhandledKeyChar& OnUnhandledKeyChar() override
{
return UnhandledKeyCharDelegate;
}
private:
/**
* Used to obtain the internal CEF browser.
*
* @return The bound CEF browser.
*/
CefRefPtr<CefBrowser> GetCefBrowser();
/**
* Sets the Title of this window.
*
* @param InTitle The new title of this window.
*/
void SetTitle(const CefString& InTitle);
/**
* Sets the url of this window.
*
* @param InUrl The new url of this window.
*/
void SetUrl(const CefString& InUrl);
/**
* Sets the tool tip for this window.
*
* @param InToolTip The text to show in the ToolTip. Empty string for no tool tip.
*/
void SetToolTip(const CefString& InToolTip);
/**
* Get the current proportions of this window.
*
* @param Rect Reference to CefRect to store sizes.
* @return Whether Rect was set up correctly.
*/
bool GetViewRect(CefRect& Rect);
/** Notifies when document loading has failed. */
void NotifyDocumentError(CefLoadHandler::ErrorCode InErrorCode, const CefString& ErrorText, const CefString& FailedUrl);
/** Notifies clients that document loading has failed. */
void NotifyDocumentError(int ErrorCode);
/**
* Notifies clients that the loading state of the document has changed.
*
* @param IsLoading Whether the document is loading (false = completed).
*/
void NotifyDocumentLoadingStateChange(bool IsLoading);
/**
* Called when there is an update to the rendered web page.
*
* @param Type Paint type.
* @param DirtyRects List of image areas that have been changed.
* @param Buffer Pointer to the raw texture data.
* @param Width Width of the texture.
* @param Height Height of the texture.
*/
void OnPaint(CefRenderHandler::PaintElementType Type, const CefRenderHandler::RectList& DirtyRects, const void* Buffer, int Width, int Height);
/**
* Called when cursor would change due to web browser interaction.
*
* @param Cursor Handle to CEF mouse cursor.
*/
void OnCursorChange(CefCursorHandle Cursor, CefRenderHandler::CursorType Type, const CefCursorInfo& CustomCursorInfo);
/**
* Called when a message was received from the renderer process.
*
* @param Browser The CefBrowser for this window.
* @param SourceProcess The process id of the sender of the message. Currently always PID_RENDERER.
* @param Message The actual message.
* @return true if the message was handled, else false.
*/
bool OnProcessMessageReceived(CefRefPtr<CefBrowser> Browser, CefProcessId SourceProcess, CefRefPtr<CefProcessMessage> Message);
/**
* Called before browser navigation.
*
* @param Browser The CefBrowser for this window.
* @param Frame The CefFrame the request came from.
* @param Request The CefRequest containing web request info.
* @param bIsRedirect true if the navigation was a result of redirection, false otherwise.
* @return true if the navigation was handled and no further processing of the navigation request should be disabled, false if the navigation should be handled by the default CEF implementation.
*/
bool OnBeforeBrowse(CefRefPtr<CefBrowser> Browser, CefRefPtr<CefFrame> Frame, CefRefPtr<CefRequest> Request, bool bIsRedirect);
void HandleOnBeforeResourceLoad(const CefString& URL, CefRequest::ResourceType Type, FRequestHeaders& AdditionalHeaders);
void HandleOnResourceLoadComplete(const CefString& URL, CefRequest::ResourceType Type, CefRequestHandler::URLRequestStatus Status, int64 ContentLength);
void HandleOnConsoleMessage(CefRefPtr<CefBrowser> Browser, const CefString& Message, const CefString& Source, int Line);
/**
* Called before loading a resource to allow overriding the content for a request.
*
* @return string content representing the content to show for the URL or an unset value to fetch the URL normally.
*/
TOptional<FString> GetResourceContent( CefRefPtr< CefFrame > Frame, CefRefPtr< CefRequest > Request);
/**
* Convenience function to translate modifier keys from Cef keyboard event
*/
FModifierKeysState SlateModifiersFromCefModifiers(const CefKeyEvent& CefEvent);
/**
* Called when browser reports a key event that was not handled by it
*/
bool OnUnhandledKeyEvent(const CefKeyEvent& CefEvent);
/**
* Handle showing javascript dialogs
*/
bool OnJSDialog(CefJSDialogHandler::JSDialogType DialogType, const CefString& MessageText, const CefString& DefaultPromptText, CefRefPtr<CefJSDialogCallback> Callback, bool& OutSuppressMessage);
/**
* Handle showing unload confirmation dialogs
*/
bool OnBeforeUnloadDialog(const CefString& MessageText, bool IsReload, CefRefPtr<CefJSDialogCallback> Callback);
/**
* Notify when any and all pending dialogs should be canceled
*/
void OnResetDialogState();
/**
* Called when render process was terminated abnormally.
*/
void OnRenderProcessTerminated(CefRequestHandler::TerminationStatus Status);
/** Called when the browser requests a new UI window
*
* @param NewBrowserWindow The web browser window to display in the new UI window.
* @param BrowserPopupFeatures The popup features and settings for the browser window.
* @return true if the UI window was created, false otherwise.
*/
bool RequestCreateWindow(const TSharedRef<IWebInterfaceBrowserWindow>& NewBrowserWindow, const TSharedPtr<IWebInterfaceBrowserPopupFeatures>& BrowserPopupFeatures);
//bool SupportsCloseWindows();
//bool RequestCloseWindow(const TSharedRef<IWebInterfaceBrowserWindow>& BrowserWindow);
/**
* Called once the browser begins closing procedures.
*/
void OnBrowserClosing();
/**
* Called once the browser is closed.
*/
void OnBrowserClosed();
/**
* Called to set the popup menu location. Note that CEF also passes a size to this method,
* which is ignored as the correct size is usually not known until inside OnPaint.
*
* @param PopupSize The location of the popup widget.
*/
void SetPopupMenuPosition(CefRect PopupSize);
/**
* Called to request that the popup widget is shown or hidden.
*
* @param bShow true for showing the popup, false for hiding it.
*/
void ShowPopupMenu(bool bShow);
#if !PLATFORM_LINUX
/**
* Called when the IME composition DOM node has changed.
* @param Browser The CefBrowser for this window.
* @param SelectionRange The range of characters that have been selected.
* @param CharacterBounds The bounds of each character in view coordinates.
*/
void OnImeCompositionRangeChanged(
CefRefPtr<CefBrowser> Browser,
const CefRange& SelectionRange,
const CefRenderHandler::RectList& CharacterBounds);
#endif
void UpdateDragRegions(const TArray<FWebInterfaceBrowserDragRegion>& Regions);
public:
/**
* Gets the Cef Keyboard Modifiers based on a Key Event.
*
* @param KeyEvent The Key event.
* @return Bits representing keyboard modifiers.
*/
static int32 GetCefKeyboardModifiers(const FKeyEvent& KeyEvent);
/**
* Gets the Cef Mouse Modifiers based on a Mouse Event.
*
* @param InMouseEvent The Mouse event.
* @return Bits representing mouse modifiers.
*/
static int32 GetCefMouseModifiers(const FPointerEvent& InMouseEvent);
/**
* Gets the Cef Input Modifiers based on an Input Event.
*
* @param InputEvent The Input event.
* @return Bits representing input modifiers.
*/
static int32 GetCefInputModifiers(const FInputEvent& InputEvent);
public:
/**
* Called from the WebBrowserViewport tick event. Allows us to cache the geometry and use it for coordinate transformations.
*/
void UpdateCachedGeometry(const FGeometry& AllottedGeometry);
/**
* Set the Zoom Level of CEF based on the provided percentage
*
* @param Percentage The percentage to base the web browsers zoom level
*/
void SetZoomLevelByPercentage(float Percentage);
/**
* Called from the WebBrowserSingleton tick event. Should test wether the widget got a tick from Slate last frame and set the state to hidden if not.
*/
void CheckTickActivity() override;
/**
* Called from the engine tick.
*/
void UpdateVideoBuffering();
/**
* Called on every browser window when CEF launches a new render process.
* Used to ensure global JS objects are registered as soon as possible.
*/
CefRefPtr<CefDictionaryValue> GetProcessInfo();
private:
/** @return the currently valid renderer, if available */
FSlateRenderer* const GetRenderer();
/**Checks whether an error with the renderer occurred and handles it if one has */
void HandleRenderingError();
/** Releases the updatable textures */
void ReleaseTextures();
/** Creates the initial updatable textures */
bool CreateInitialTextures();
/** Executes or defers a LoadUrl navigation */
void RequestNavigationInternal(FString Url, FString Contents);
/** Specifies whether or not we have a pending deferred navigation */
bool HasPendingNavigation();
/** Executes navigation on a pending deferred navigation */
void ProcessPendingNavigation();
/** Helper that calls WasHidden on the CEF host object when the value changes */
void SetIsHidden(bool bValue);
/** Used by the key down and up handlers to convert Slate key events to the CEF equivalent. */
void PopulateCefKeyEvent(const FKeyEvent& InKeyEvent, CefKeyEvent& OutKeyEvent);
/** Used to convert a FPointerEvent to a CefMouseEvent */
CefMouseEvent GetCefMouseEvent(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bIsPopup);
/** Specifies whether or not a point falls within any tagged drag regions that are draggable. */
bool IsInDragRegion(const FIntPoint& Point);
private:
/** Current state of the document being loaded. */
EWebInterfaceBrowserDocumentState DocumentState;
/** Interface to the texture we are rendering to. */
FSlateUpdatableTexture* UpdatableTextures[2];
/** Pointer to the CEF Browser for this window. */
CefRefPtr<CefBrowser> InternalCefBrowser;
/** Pointer to the CEF handler for this window. */
CefRefPtr<FCEFInterfaceBrowserHandler> WebBrowserHandler;
/** Current title of this window. */
FString Title;
/** Current Url of this window. */
FString CurrentUrl;
/** Current tool tip. */
FString ToolTipText;
/** Current size of this window. */
FIntPoint ViewportSize;
/** Current DPI scale factor of this window. */
float ViewportDPIScaleFactor;
/** Whether this window is closing. */
bool bIsClosing;
/** Whether this window has been painted at least once. */
bool bIsInitialized;
/** Optional text to load as a web page. */
TOptional<FString> ContentsToLoad;
/** Delegate for broadcasting load state changes. */
FOnDocumentStateChanged DocumentStateChangedEvent;
/** Whether to show an error message in case of loading errors. */
bool bShowErrorMessage;
/** Whether to allow forward and back navigation via the mouse thumb buttons. */
bool bThumbMouseButtonNavigation;
/** Whether transparency is enabled. */
bool bUseTransparency;
/** Whether native cursors are enabled. */
bool bUseNativeCursors;
/** Delegate for broadcasting title changes. */
FOnTitleChanged TitleChangedEvent;
/** Delegate for broadcasting address changes. */
FOnUrlChanged UrlChangedEvent;
/** Delegate for showing or hiding tool tips. */
FOnToolTip ToolTipEvent;
/** Delegate for notifying that the window needs refreshing. */
FOnNeedsRedraw NeedsRedrawEvent;
/** Delegate that is executed prior to browser navigation. */
FOnBeforeBrowse BeforeBrowseDelegate;
/** Delegate for overriding Url contents. */
FOnLoadUrl LoadUrlDelegate;
/** Delegate for handling requests to close new windows that were created. */
FOnCloseWindow CloseWindowDelegate;
/** Delegate for handling resource load requests */
FOnBeforeResourceLoadDelegate BeforeResourceLoadDelegate;
/** Delegate that allows for responses to resource loads */
FOnResourceLoadCompleteDelegate ResourceLoadCompleteDelegate;
/** Delegate that allows for response to console logs. Typically used to capture and mirror web logs in client application logs. */
FOnConsoleMessageDelegate ConsoleMessageDelegate;
/** Delegate for handling requests to show the popup menu. */
FOnShowPopup ShowPopupEvent;
/** Delegate for handling requests to dismiss the current popup menu. */
FOnDismissPopup DismissPopupEvent;
/** Delegate for showing dialogs. */
FOnShowDialog ShowDialogDelegate;
/** Delegate for dismissing all dialogs. */
FOnDismissAllDialogs DismissAllDialogsDelegate;
/** Delegate for suppressing context menu */
FOnSuppressContextMenu SuppressContextMenuDelgate;
/** Delegate that is executed when a drag event is detected in an area of the web page tagged as a drag region. */
FOnDragWindow DragWindowDelegate;
/** Delegate for handling key down events not handled by the browser. */
FOnUnhandledKeyDown UnhandledKeyDownDelegate;
/** Delegate for handling key up events not handled by the browser. */
FOnUnhandledKeyUp UnhandledKeyUpDelegate;
/** Delegate for handling key char events not handled by the browser. */
FOnUnhandledKeyChar UnhandledKeyCharDelegate;
/** Tracks the current mouse cursor */
EMouseCursor::Type Cursor;
/** Tracks whether the widget is currently disabled or not*/
bool bIsDisabled;
/** Tracks whether the widget is currently hidden or not*/
bool bIsHidden;
/** Used to detect when the widget is hidden*/
bool bTickedLastFrame;
/** Tracks whether the widget has been resized and needs to be refreshed */
bool bNeedsResize;
/** Tracks whether or not the user initiated a window drag by clicking on a page's drag region. */
bool bDraggingWindow;
/** Used for unhandled key events forwarding*/
TOptional<FKeyEvent> PreviousKeyDownEvent;
TOptional<FKeyEvent> PreviousKeyUpEvent;
TOptional<FCharacterEvent> PreviousCharacterEvent;
bool bIgnoreKeyDownEvent;
bool bIgnoreKeyUpEvent;
bool bIgnoreCharacterEvent;
/** Used to ignore any popup menus when forwarding focus gained/lost events*/
bool bMainHasFocus;
bool bPopupHasFocus;
bool bSupportsMouseWheel;
FIntPoint PopupPosition;
bool bShowPopupRequested;
/** This is set to true when reloading after render process crash. */
bool bRecoverFromRenderProcessCrash;
int ErrorCode;
/** Used to defer navigations */
bool bDeferNavigations;
/** Used to identify a navigation that needs to fully abort before we can stop deferring navigations. */
FString PendingAbortUrl;
/** Used to store the url of pending navigation requests while we need to defer navigations. */
FString PendingLoadUrl;
TUniquePtr<FBrowserBufferedVideo> BufferedVideo;
/** Handling of passing and marshalling messages for JS integration is delegated to a helper class*/
TSharedPtr<FCEFInterfaceJSScripting> Scripting;
#if !PLATFORM_LINUX
/** Handling of foreign language character input is delegated to a helper class */
TSharedPtr<FCEFInterfaceImeHandler> Ime;
#endif
TArray<FWebInterfaceBrowserDragRegion> DragRegions;
TSharedPtr<SWindow> ParentWindow;
};
typedef FCEFWebInterfaceBrowserWindow FWebInterfaceBrowserWindow;
#endif