description: Unregister a custom scheme handler factory. The factory may still be used by existing open browser windows, but will no longer be provided for new ones.

code: bool UnregisterSchemeHandlerFactory ( [IWebBrowserSchemeHandlerFactory](API\Runtime\WebBrowser\IWebBrowserSchemeHandlerFactory) * WebBrowserSchemeHandlerFactory )


description: Virtual Destructor

module: WebBrowser

code: virtual ~IWebBrowserSingleton()


code: bool UnregisterContext ( const [FString](API\Runtime\Core\Containers\FString) & ContextId )


code: virtual void BindInputMethodSystem ( [ITextInputMethodSystem](API\Runtime\ApplicationCore\GenericPlatform\ITextInputMethodSystem) * TextInputMethodSystem )


description: Expose aUObjectinstance to the browser runtime. Properties and Functions will be accessible from JavaScript side. As all communication with the rendering procesis asynchronous, return values (both for properties and function results) are wrapped into JS Future objects.

code: void BindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


className: IWebBrowserSingleton

description: A singleton class that takes care of general web browser tasks

code: class IWebBrowserSingleton


description: Returns true if the browser can navigate backwards.

code: bool CanGoBack() const


description: Returns true if the browser can navigate forwards.

code: bool CanGoForward() const


code: virtual void CheckTickActivity()


code: virtual bool CheckVisibility()


description: Close this window so that it can no longer be used.

code: void CloseBrowser ( bool bForce, bool bBlockTillClosed )


description: Execute Javascript on the page.

code: void ExecuteJavascript ( const [FString](API\Runtime\Core\Containers\FString) & Script )


className: FOnBeforeBrowse

description: A delegate that is invoked prior to browser navigation.

code: typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FWebNavigationRequest](API\Runtime\WebBrowser\FWebNavigationRequest) & > FOnBeforeBrowse


className: FOnBeforePopupDelegate

description: A delegate that is invoked when a popup window is attempting to open.

code: typedef TBaseDelegate_TwoParams< bool, [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > FOnBeforePopupDelegate


className: FOnBeforeResourceLoadDelegate

code: typedef TBaseDelegate_FourParams< void, [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString), [FRequestHeaders](API\Runtime\WebBrowser\IWebBrowserWindow\FRequestHeaders) &, const bool > FOnBeforeResourceLoadDelegate


className: FOnCheckVisibility

description: A delegate that is invoked to check the visibility of the native browser

code: typedef TBaseDelegate_NoParams< bool > FOnCheckVisibility


className: FOnCloseWindow

description: A delegate that is invoked when closing created popup windows.

code: typedef TBaseDelegate_OneParam< bool, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > & > FOnCloseWindow


className: FOnConsoleMessageDelegate

description: A delegate that is invoked for each console message

code: typedef TBaseDelegate_FourParams< void, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, int32, EWebBrowserConsoleLogSeverity > FOnConsoleMessageDelegate


className: FOnCreateWindow

description: A delegate that is invoked when an existing browser requests creation of a new browser window.

code: typedef TBaseDelegate_TwoParams< bool, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > &, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserPopupFeatures](API\Runtime\WebBrowser\IWebBrowserPopupFeatures) > & > FOnCreateWindow


className: FOnDismissAllDialogs

description: A delegate that is invoked when the browser needs to dismiss and reset all dialogs.

code: typedef TBaseDelegate_NoParams< void > FOnDismissAllDialogs


className: FOnDismissPopup

description: A delegate that is invoked when the browser no longer wants to show the popup menu.

code: class FOnDismissPopup : public TBaseMulticastDelegate_NoParams< void >


className: FOnDocumentStateChanged

description: A delegate that is invoked when the loading state of a document changed.

code: class FOnDocumentStateChanged : public TBaseMulticastDelegate_OneParam< void, EWebBrowserDocumentState >


className: FOnDragWindow

description: A delegate that is invoked when drag is detected in an area specified as a drag region on the web page.

code: typedef TBaseDelegate_OneParam< bool, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & > FOnDragWindow


className: FOnNeedsRedraw

description: A delegate that is invoked when the off-screen window has been repainted and requires an update.

code: class FOnNeedsRedraw : public TBaseMulticastDelegate_NoParams< void >


className: FOnLoadUrl

description: A delegate that is invoked to allow user code to override the contents of a Url.

code: typedef TBaseDelegate_ThreeParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, [FString](API\Runtime\Core\Containers\FString) & > FOnLoadUrl


className: FOnResourceLoadCompleteDelegate

description: A delegate that is invoked on completion of browser resource loads. Its primary purpose is to allow response to failures.

code: typedef TBaseDelegate_FourParams< void, [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString), int64 > FOnResourceLoadCompleteDelegate


className: FOnShowDialog

description: A delegate that is invoked when the browser needs to show a dialog.

code: typedef TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserDialog](API\Runtime\WebBrowser\IWebBrowserDialog) > & > FOnShowDialog


className: FOnShowPopup

description: A delegate that is invoked when the browser needs to show a popup menu.

code: class FOnShowPopup : public TBaseMulticastDelegate_OneParam< void, const FIntRect & >


className: FOnTitleChanged

description: A delegate to allow callbacks when a browser title changes.

code: class FOnTitleChanged : public TBaseMulticastDelegate_OneParam< void, FString >


className: FOnSuppressContextMenu

description: Should return true if this dialog wants to suppress the context menu

code: typedef TBaseDelegate_NoParams< bool > FOnSuppressContextMenu


className: FOnToolTip

description: A delegate to allow callbacks when a frame url changes.

code: class FOnToolTip : public TBaseMulticastDelegate_OneParam< void, FString >


className: FOnUnhandledKeyChar

description: A delegate that is invoked for each key char event not handled by the browser, return true if event is handled to prevent it from bubbling up.

code: typedef TBaseDelegate_OneParam< bool, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & > FOnUnhandledKeyChar


className: FOnUnhandledKeyUp

description: A delegate that is invoked for each up down event not handled by the browser, return true if event is handled to prevent it from bubbling up.

code: typedef TBaseDelegate_OneParam< bool, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & > FOnUnhandledKeyUp


className: FOnUrlChanged

code: class FOnUrlChanged : public TBaseMulticastDelegate_OneParam< void, FString >


className: FRequestHeaders

description: A delegate that is invoked before the browser loads a resource. Its primary purpose is to inject headers into the request.

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > FRequestHeaders


description: Gets the loading state of the current document.


description:
Get current load error.
an error code if the last page load resulted in an error, otherwise 0.

code: int GetLoadError()


description: Get parentSWindowfor this window

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > GetParentWindow() const


className: FOnUnhandledKeyDown

description: A delegate that is invoked for each key down event not handled by the browser, return true if event is handled to prevent it from bubbling up.

code: typedef TBaseDelegate_OneParam< bool, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & > FOnUnhandledKeyDown


description: This method has to be called asynchronously by passing a callback function, which will be called at a later point when the result is ready.

code: void GetSource ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &)> Callback ) const


description: Returns whether mouse wheel events should be handled by the window

code: bool GetSupportsMouseWheel() const


description:
Gets interface to the texture representation of the browser
A slate shader resource that can be rendered

code: [FSlateShaderResource](API\Runtime\SlateCore\Textures\FSlateShaderResource) * GetTexture ( bool bIsPopup )


description: Gets the current title of the Browser page


description:
Gets the currently loaded URL.
The URL, or empty string if no document is loaded.


description: Gets the current size of the web browser viewport if available, FIntPoint::NoneValue otherwise

code: FIntPoint GetViewportSize() const


description: Navigate backwards.

code: void GoBack()


description: Navigate forwards.

code: void GoForward()


description: Checks whether the web browser is currently being shut down

code: bool IsClosing() const


description: Checks whether the web browser has finished loaded the initial page.

code: bool IsInitialized() const


description: Returns true if the browser is currently loading.

code: bool IsLoading() const


description: Checks whether the web browser is valid and ready for use

code: bool IsValid() const


description: Load a string as data to create a web page

code: void LoadString ( [FString](API\Runtime\Core\Containers\FString) Contents, [FString](API\Runtime\Core\Containers\FString) DummyURL )


description: Load the specified URL

code: void LoadURL ( [FString](API\Runtime\Core\Containers\FString) NewURL )


description: Called when Capture lost

code: void OnCaptureLost()


code: virtual [FOnCheckVisibility](API\Runtime\WebBrowser\IWebBrowserWindow\FOnCheckVisibility) & OnCheckVisibility()


description: The system asks each widget under the mouse to provide a cursor. This event is bubbled.FCursorReply::Unhandled()if the event is not handled; returnFCursorReply::Cursor()otherwise.

code: [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent )


description: Called when browser receives/loses focus

code: void OnFocus ( bool SetFocus, bool bIsPopup )


description: Notify the browser of a character event

code: bool OnKeyChar ( const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


description: Notify the browser that a key has been released

code: bool OnKeyUp ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Notify the browser that a key has been pressed

code: bool OnKeyDown ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Notify the browser of a double click eventFReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, bool bIsPopup )


description: Notify the browser that a mouse button was pressed within itFReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, bool bIsPopup )


description: Notify the browser that a mouse button was released within itFReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, bool bIsPopup )


description: Notify the browser that a mouse has left the window

code: void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description: Notify the browser that a mouse moved within itFReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, bool bIsPopup )


description: Called when the mouse wheel is spunFReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent, bool bIsPopup )


description: Called when a touch gesture is performed.FReply::Handled()if the mouse event was handled,FReply::Unhandled()oterwise

code: [FReply](API\Runtime\SlateCore\Input\FReply) OnTouchGesture ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & GestureEvent, bool bIsPopup )


description: Reload the current page.

code: void Reload()


description: Disable or enable web view.

code: void SetIsDisabled ( bool bValue )


description: Sets whether mouse wheel events should be handled by the window

code: void SetSupportsMouseWheel ( bool bValue )


description: Set parentSWindowfor this window

code: void SetParentWindow ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > Window )


description: Set the desired size of the web browser viewport

code: void SetViewportSize ( FIntPoint WindowSize, FIntPoint WindowPos )


description: Stop loading the page.

code: void StopLoad()


code: virtual void UnbindInputMethodSystem()


description: Remove an existing script binding registered by BindUObject.

code: void UnbindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


description: Virtual Destructor.

code: virtual ~IWebBrowserWindow()


className: IWebBrowserWindow

description: Interface for dealing with a Web Browser window

code: class IWebBrowserWindow


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > Create ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FCEFWebBrowserWindow > & BrowserWindowParent, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< FWebBrowserWindowInfo > & BrowserWindowInfo )


className: IWebBrowserWindowFactory

code: class IWebBrowserWindowFactory


code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > Create ( void * OSWindowHandle, [FString](API\Runtime\Core\Containers\FString) InitialURL, bool bUseTransparency, bool bThumbMouseButtonNavigation, bool InterceptLoadRequests, [TOptional](API\Runtime\Core\IO\TOptional)< [FString](API\Runtime\Core\Containers\FString) > ContentsToLoad, bool ShowErrorMessage, [FColor](API\Runtime\Core\Math\FColor) BackgroundColor )


code: void BindAdapter ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > & Adapter )


description: Expose aUObjectinstance to the browser runtime. Properties and Functions will be accessible from JavaScript side. As all communication with the rendering procesis asynchronous, return values (both for properties and function results) are wrapped into JS Future objects.

code: void BindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


code: void BindInputMethodSystem ( [ITextInputMethodSystem](API\Runtime\ApplicationCore\GenericPlatform\ITextInputMethodSystem) * TextInputMethodSystem )


description: Returns true if the browser can navigate backwards.

code: bool CanGoBack() const


description: Returns true if the browser can navigate forwards.

code: bool CanGoForward() const


description: Construct the widget.

code: void Construct ( const [FArguments](API\Runtime\WebBrowser\SWebBrowser\FArguments) & InArgs, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > & InWebBrowserWindow )


description: Execute javascript on the current window

code: void ExecuteJavascript ( const [FString](API\Runtime\Core\Containers\FString) & ScriptText )


description: Opaque background color used before a document is loaded and when no document color is specified.

code: WidgetArgsType & BackgroundColor &40; FColor InArg &41;


description: The frames per second rate that the browser will attempt to use.

code: WidgetArgsType & BrowserFrameRate &40; int InArg &41;


description: Optional string to load contents as a web page.

code: WidgetArgsType & ContentsToLoad &40; TOptional< FString > InArg &41;


description: Called before browser navigation.

code: WidgetArgsType & OnBeforeNavigation &40; const FOnBeforeBrowse & InDelegate &41;


description: Called before a popup window happens

code: WidgetArgsType & OnBeforePopup &40; const FOnBeforePopupDelegate & InDelegate &41;


description: Called when a browser window close event is detected

code: WidgetArgsType & OnCloseWindow &40; const FOnCloseWindowDelegate & InDelegate &41;


description: Called for each console message

code: WidgetArgsType & OnConsoleMessage &40; const FOnConsoleMessageDelegate & InDelegate &41;


description: Called when the browser requests the creation of a new window

code: WidgetArgsType & OnCreateWindow &40; const FOnCreateWindowDelegate & InDelegate &41;


description: Called when drag is detected in a web page area tagged as a drag region.

code: WidgetArgsType & OnDragWindow &40; const FOnDragWindow & InDelegate &41;


description: Called when document loading failed.

code: WidgetArgsType & OnLoadError &40; const FSimpleDelegate & InDelegate &41;


description: Called when document loading completed.

code: WidgetArgsType & OnLoadCompleted &40; const FSimpleDelegate & InDelegate &41;


description: Called to dismiss any dialogs shown via OnShowDialog.

code: WidgetArgsType & OnDismissAllDialogs &40; const FSimpleDelegate & InDelegate &41;


description: Called when document loading started.

code: WidgetArgsType & OnLoadStarted &40; const FSimpleDelegate & InDelegate &41;


description: Called to allow bypassing page content on load.

code: WidgetArgsType & OnLoadUrl &40; const FOnLoadUrl & InDelegate &41;


description: Called when the browser needs to show a dialog to the user.

code: WidgetArgsType & OnShowDialog &40; const FOnShowDialog & InDelegate &41;


code: WidgetArgsType & OnSuppressContextMenu &40; const FOnSuppressContextMenu & InDelegate &41;


description: Called when the Url changes.

code: WidgetArgsType & OnUrlChanged &40; const FOnTextChanged & InDelegate &41;


description: Called when document title changed.

code: WidgetArgsType & OnTitleChanged &40; const FOnTextChanged & InDelegate &41;


description: A reference to the parent window.

code: WidgetArgsType & ParentWindow &40; TSharedPtr< SWindow > InArg &41;


description: Override the popup menu method used for popup menus. If not set, parent widgets will be queried instead.

code: WidgetArgsType & PopupMenuMethod &40; TOptional< EPopupMethod > InArg &41;


description: Whether to show an error message in case of loading errors.

code: WidgetArgsType & ShowErrorMessage &40; bool InArg &41;


description: Whether to show an address bar.

code: WidgetArgsType & ShowAddressBar &40; bool InArg &41;


description: Whether to show standard controls like Back, Forward, Reload etc.

code: WidgetArgsType & ShowControls &40; bool InArg &41;


description: Whether to allow forward and back navigation via the mouse thumb buttons.

code: WidgetArgsType & SupportsThumbMouseButtonNavigation &40; bool InArg &41;


description: Whether to show a throbber overlay during browser initialization.

code: WidgetArgsType & ShowInitialThrobber &40; bool InArg &41;


description: Should this browser window support transparency.

code: WidgetArgsType & SupportsTransparency &40; bool InArg &41;


description: Desired size of the web browser viewport.

code: WidgetArgsType & ViewportSize &40; const TAttribute< FVector2D > & InAttribute &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SWebBrowser >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnBeforeBrowse

code: typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FWebNavigationRequest](API\Runtime\WebBrowser\FWebNavigationRequest) & > FOnBeforeBrowse


className: FOnDragWindow

code: typedef TBaseDelegate_OneParam< bool, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & > FOnDragWindow


code: typedef TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserDialog](API\Runtime\WebBrowser\IWebBrowserDialog) > & > FOnShowDialog


description:
Gets the URL that appears in the address bar, this may not be the URL that is currently loaded in the frame.
The address bar URL.


className: FOnLoadUrl

code: typedef TBaseDelegate_ThreeParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, [FString](API\Runtime\Core\Containers\FString) & > FOnLoadUrl


description: This method has to be called asynchronously by passing a callback function, which will be called at a later point when the result is ready.

code: void GetSource ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &)> Callback ) const


description: Get the current title of the web page.


description:
Gets the currently loaded URL.
The URL, or empty string if no document is loaded.


description: Navigate backwards.

code: void GoBack()


description: Navigate forwards.

code: void GoForward()


description: Whether the document finished loading.

code: bool IsLoaded() const


description: Whether the document is currently being loaded.

code: bool IsLoading() const


description: Load the specified URL.

code: void LoadURL ( [FString](API\Runtime\Core\Containers\FString) NewURL )


description: Load a string as data to create a web page.

code: void LoadString ( [FString](API\Runtime\Core\Containers\FString) Contents, [FString](API\Runtime\Core\Containers\FString) DummyURL )


description: Set parentSWindowfor this browser.

code: void SetParentWindow ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > Window )


description: Reload the current page.

code: void Reload()


description: Stop loading the page.

code: void StopLoad()


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


code: void UnbindAdapter ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > & Adapter )


description: Default constructor.

code: SWebBrowser()


code: void UnbindInputMethodSystem()


description: Remove an existing script binding registered by BindUObject.

code: void UnbindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


code: void BindAdapter ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > & Adapter )


className: SWebBrowser

code: class SWebBrowser : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void BindInputMethodSystem ( [ITextInputMethodSystem](API\Runtime\ApplicationCore\GenericPlatform\ITextInputMethodSystem) * TextInputMethodSystem )


description: Returns true if the browser can navigate backwards.

code: bool CanGoBack() const


description: Expose aUObjectinstance to the browser runtime. Properties and Functions will be accessible from JavaScript side. As all communication with the rendering procesis asynchronous, return values (both for properties and function results) are wrapped into JS Future objects.

code: void BindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


description: Returns true if the browser can navigate forwards.

code: bool CanGoForward() const


description: Close the underlying browser object before we destruct this view. This will block until that object is fully destroyed. Calling this is optional, CEF has object lifetime requirements that mean on shutdown you must destroy browsers before exit.

code: void CloseBrowser()


description: Execute javascript on the current window

code: void ExecuteJavascript ( const [FString](API\Runtime\Core\Containers\FString) & ScriptText )


description: Construct the widget.

code: void Construct ( const [FArguments](API\Runtime\WebBrowser\SWebBrowserView\FArguments) & InArgs, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IWebBrowserWindow](API\Runtime\WebBrowser\IWebBrowserWindow) > & InWebBrowserWindow )


description: Domains to retry if original domain cannot connect.

code: WidgetArgsType & AltRetryDomains &40; TArray< FString > InArg &41;


description: Opaque background color used before a document is loaded and when no document color is specified.

code: WidgetArgsType & BackgroundColor &40; FColor InArg &41;


description: The frames per second rate that the browser will attempt to use.

code: WidgetArgsType & BrowserFrameRate &40; int InArg &41;


description: Optional string to load contents as a web page.

code: WidgetArgsType & ContentsToLoad &40; TOptional< FString > InArg &41;


description: Override the default global context settings for this specific window. If not set, the global default will be used.

code: WidgetArgsType & ContextSettings &40; TOptional< FBrowserContextSettings > InArg &41;


description: URL that the browser will initially navigate to.

code: WidgetArgsType & InitialURL &40; FString InArg &41;


description: Should this browser window intercept resource loading requests. If false the BrowserContext will instead. Defaults to True.

code: WidgetArgsType & InterceptLoadRequests &40; bool InArg &41;


description: Called before browser navigation.

code: WidgetArgsType & OnBeforeNavigation &40; const FOnBeforeBrowse & InDelegate &41;


description: Called before a popup window happens

code: WidgetArgsType & OnBeforePopup &40; const FOnBeforePopupDelegate & InDelegate &41;


description: Called for each console message

code: WidgetArgsType & OnConsoleMessage &40; const FOnConsoleMessageDelegate & InDelegate &41;


description: Called to allow overriding of ToolTip widget construction.

code: WidgetArgsType & OnCreateToolTip &40; const FOnCreateToolTip & InDelegate &41;


description: Called when a browser window close event is detected

code: WidgetArgsType & OnCloseWindow &40; const FOnCloseWindowDelegate & InDelegate &41;


description: Called when the browser requests the creation of a new window

code: WidgetArgsType & OnCreateWindow &40; const FOnCreateWindowDelegate & InDelegate &41;


description: Called when drag is detected in a web page area tagged as a drag region.

code: WidgetArgsType & OnDragWindow &40; const FOnDragWindow & InDelegate &41;


description: Called to dismiss any dialogs shown via OnShowDialog.

code: WidgetArgsType & OnDismissAllDialogs &40; const FSimpleDelegate & InDelegate &41;


description: Called when document loading completed.

code: WidgetArgsType & OnLoadCompleted &40; const FSimpleDelegate & InDelegate &41;


description: Called when document loading failed.

code: WidgetArgsType & OnLoadError &40; const FSimpleDelegate & InDelegate &41;


description: Called to allow supression of the browser context menu.

code: WidgetArgsType & OnSuppressContextMenu &40; const FOnSuppressContextMenu & InDelegate &41;


description: Called when document loading started.

code: WidgetArgsType & OnLoadStarted &40; const FSimpleDelegate & InDelegate &41;


description: Called to allow bypassing page content on load.

code: WidgetArgsType & OnLoadUrl &40; const FOnLoadUrl & InDelegate &41;


description: Called when the browser needs to show a dialog to the user.

code: WidgetArgsType & OnShowDialog &40; const FOnShowDialog & InDelegate &41;


description: Called to allow the handling of any key char events not handled by the browser.

code: WidgetArgsType & OnUnhandledKeyChar &40; const FOnUnhandledKeyChar & InDelegate &41;


description: Called when document title changed.

code: WidgetArgsType & OnTitleChanged &40; const FOnTextChanged & InDelegate &41;


description: Called to allow the handling of any key down events not handled by the browser.

code: WidgetArgsType & OnUnhandledKeyDown &40; const FOnUnhandledKeyDown & InDelegate &41;


description: Called to allow the handling of any key up events not handled by the browser.

code: WidgetArgsType & OnUnhandledKeyUp &40; const FOnUnhandledKeyUp & InDelegate &41;


description: Called when the Url changes.

code: WidgetArgsType & OnUrlChanged &40; const FOnTextChanged & InDelegate &41;


description: A reference to the parent window.

code: WidgetArgsType & ParentWindow &40; TSharedPtr< SWindow > InArg &41;


description: Override the popup menu method used for popup menus. If not set, parent widgets will be queried instead.

code: WidgetArgsType & PopupMenuMethod &40; TOptional< EPopupMethod > InArg &41;


description: Whether to allow forward and back navigation via the mouse thumb buttons.

code: WidgetArgsType & SupportsThumbMouseButtonNavigation &40; bool InArg &41;


description: Desired size of the web browser viewport.

code: WidgetArgsType & ViewportSize &40; const TAttribute< FVector2D > & InAttribute &41;


description: Should this browser window support transparency.

code: WidgetArgsType & SupportsTransparency &40; bool InArg &41;


description: Whether to show an error message in case of loading errors.

code: WidgetArgsType & ShowErrorMessage &40; bool InArg &41;


code: typedef FArguments WidgetArgsType


code: struct FArguments : public [TSlateBaseNamedArgs< SWebBrowserView >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: typedef TBaseDelegate_OneParam< bool, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & > FOnDragWindow


code: typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FWebNavigationRequest](API\Runtime\WebBrowser\FWebNavigationRequest) & > FOnBeforeBrowse


code: typedef TBaseDelegate_ThreeParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [FString](API\Runtime\Core\Containers\FString) &, [FString](API\Runtime\Core\Containers\FString) & > FOnLoadUrl


className: FOnShowDialog

code: typedef TBaseDelegate_OneParam< EWebBrowserDialogEventResponse, const [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [IWebBrowserDialog](API\Runtime\WebBrowser\IWebBrowserDialog) > & > FOnShowDialog


code: typedef TBaseDelegate_NoParams< bool > FOnSuppressContextMenu


code: typedef TBaseDelegate_OneParam< bool, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & > FOnUnhandledKeyChar


code: typedef TBaseDelegate_OneParam< bool, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & > FOnUnhandledKeyDown


description: This method has to be called asynchronously by passing a callback function, which will be called at a later point when the result is ready.

code: void GetSource ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FString](API\Runtime\Core\Containers\FString) &)> Callback ) const


description:
Gets the URL that appears in the address bar, this may not be the URL that is currently loaded in the frame.
The address bar URL.


code: typedef TBaseDelegate_OneParam< bool, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & > FOnUnhandledKeyUp


description: Get the current title of the web page.


description: Navigate backwards.

code: void GoBack()


description:
Gets the currently loaded URL.
The URL, or empty string if no document is loaded.


description: Navigate forwards.

code: void GoForward()


code: bool HandleSuppressContextMenu()


description: Whether the browser widget is done initializing.

code: bool IsInitialized() const


description: Whether the document finished loading.

code: bool IsLoaded() const


description: Load a string as data to create a web page.

code: void LoadString ( [FString](API\Runtime\Core\Containers\FString) Contents, [FString](API\Runtime\Core\Containers\FString) DummyURL )


description: Whether the document is currently being loaded.

code: bool IsLoading() const


description: Load the specified URL.

code: void LoadURL ( [FString](API\Runtime\Core\Containers\FString) NewURL )


description:
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
The maximum layer ID attained by this widget or any of its children.

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


description: Reload the current page.

code: void Reload()


description: Update the underlying browser widget to match the KB focus in slate. This is used to work around a CEF bug that loses focus state on navigations

code: void SetBrowserKeyboardFocus()


description: Set parentSWindowfor this browser.

code: void SetParentWindow ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWindow](API\Runtime\SlateCore\Widgets\SWindow) > Window )


description: Stop loading the page.

code: void StopLoad()


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


code: void UnbindInputMethodSystem()


description: Remove an existing script binding registered by BindUObject.

code: void UnbindUObject ( const [FString](API\Runtime\Core\Containers\FString) & Name, [UObject](API\Runtime\CoreUObject\UObject\UObject) * Object, bool bIsPermanent )


code: void UnbindAdapter ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebBrowserAdapter](API\Runtime\WebBrowser\IWebBrowserAdapter) > & Adapter )


description: Default constructor.

code: SWebBrowserView()


description: Clear the texture using the given clear color.

module: WebBrowserTexture

code: void ClearTexture ( const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & ClearColor )


className: SWebBrowserView

code: class SWebBrowserView : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: ConvertSample

code: void CopySample ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebBrowserTextureSample](API\Runtime\WebBrowserTexture\FWebBrowserTextureSample), ESPMode::ThreadSafe > & Sample, const [FLinearColor](API\Runtime\Core\Math\FLinearColor) & ClearColor )


className: FRenderParams

description: Parameters for the Render method.

code: struct FRenderParams

ClearColor

type: FLinearColor

description: The clear color to use when clearing the texture.

PlayerGuid

type: FGuid

description: Guid associated with the texture.

SampleSource

type: TWeakPtr<FWebB...

description: The sample source to render.


description: The resource's friendly name. Typically aUObjectname.

code: virtual [FString](API\Runtime\Core\Containers\FString) GetFriendlyName() const


description: Returns the width of the texture in pixels.

code: virtual uint32 GetSizeX() const


description: Properties.

code: virtual FIntPoint GetSizeXY() const


description: Returns the height of the texture in pixels.

code: virtual uint32 GetSizeY() const


description: Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


description: Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

code: virtual void ReleaseRHI()


description: Set the owner's texture reference to the given texture.

code: void UpdateTextureReference ( FRHITexture2D * NewTexture )


description: This method is called on the render thread by the WebBrowserTexture that owns this texture resource to clear or redraw the resource using the given parameters.

code: void Render ( const [FRenderParams](API\Runtime\WebBrowserTexture\FWebBrowserTextureResource\FRenderParams) & Params )


description: Calculates the current resource size and notifies the owner texture.

code: void UpdateResourceSize()


description: Virtual destructor.

code: virtual ~FWebBrowserTextureResource()


description: Creates and initializes a new instance.

code: FWebBrowserTextureResource ( [UWebBrowserTexture](API\Runtime\WebBrowserTexture\UWebBrowserTexture) & InOwner, FIntPoint & InOwnerDim, SIZE_T & InOwnerSize )


code: virtual const void * GetBuffer()


className: FWebBrowserTextureResource

description: Texture resource type for webbrowser textures.

code: class FWebBrowserTextureResource : public [FRenderTarget](API\Runtime\Engine\FRenderTarget), public [FTextureResource](API\Runtime\Engine\FTextureResource)


code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetOffset() const


code: virtual FIntPoint GetDim() const


code: virtual [FLinearColor](API\Runtime\Core\Math\FLinearColor) GetScaleRotation() const


code: virtual uint32 GetStride() const


description:
Initialize the sample.
true on success, false otherwise.

code: bool Initialize ( const FIntPoint & InDim )


description:
Get a writable pointer to the sample buffer.
Sample buffer.

code: void * GetMutableBuffer()


description: InitializeTexture

code: void InitializeBuffer ( void * InBuffer, bool Copy )


description: InitializeTexture

code: int32 InitializeBufferForCopy()


description: Set the sample Scale, Rotation, Offset.

code: void SetScaleRotationOffset ( FVector4 & InScaleRotation, FVector4 & InOffset )


description: InitializeBuffer

code: FRHITexture2D * InitializeTexture()


description: Virtual destructor.

code: virtual ~FWebBrowserTextureSample()


className: FWebBrowserTextureSample

description: Texture sample generated by the WebBrowser.

code: class FWebBrowserTextureSample : public [IMediaPoolable](API\Runtime\MediaUtils\IMediaPoolable)


description: Perform any pending flushes.

code: void DoPendingFlushes()


className: FWebBrowserTextureSamplePool

description: Implements a pool for WebBrowser's texture sample objects.

code: class FWebBrowserTextureSamplePool : public [TMediaObjectPool< FWebBrowserTextureSample >](API\Runtime\MediaUtils\TMediaObjectPool)


code: virtual bool Dequeue ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebBrowserTextureSample](API\Runtime\WebBrowserTexture\FWebBrowserTextureSample), ESPMode::ThreadSafe > & OutSample )


description: Peek

code: int32 Num() const


code: virtual bool Enqueue ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebBrowserTextureSample](API\Runtime\WebBrowserTexture\FWebBrowserTextureSample), ESPMode::ThreadSafe > & Sample )


code: virtual bool Peek ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebBrowserTextureSample](API\Runtime\WebBrowserTexture\FWebBrowserTextureSample), ESPMode::ThreadSafe > & OutSample )


code: virtual void RequestFlush()


description: Virtual destructor.


description: Default constructor.

code: FWebBrowserTextureSampleQueue()


className: FWebBrowserTextureSampleQueue

code: class FWebBrowserTextureSampleQueue


description: Called before destroying the object. This is called immediately upon deciding to destroy the object, to allow the object to begin an asynchronous cleanup process.

code: virtual void BeginDestroy()


className: IWebBrowserTextureModule

description: WebBrowserTextureModule interface

code: class IWebBrowserTextureModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: GetWidth

code: float GetAspectRatio() const


description: Implemented by subclasses to create a new resource for the texture.

code: virtual [FTextureResource](API\Runtime\Engine\FTextureResource) * CreateResource()


description: Return a one line description of an object for viewing in the thumbnail view of the generic browser


description: Access the GUID which defines this texture's resources externally throughFExternalTextureRegistry

code: virtual [FGuid](API\Runtime\Core\Misc\FGuid) GetExternalTextureGuid() const


description: GetWidth

code: int32 GetHeight() const


description: the array size of the surface represented by the texture.

code: virtual uint32 GetSurfaceArraySize() const


description: the depth of the surface represented by the texture.

code: virtual float GetSurfaceDepth() const


description: the height of the surface represented by the texture.

code: virtual float GetSurfaceHeight() const


description: the width of the surface represented by the texture.

code: virtual float GetSurfaceWidth() const


description: Get Texture Class

code: virtual ETextureClass GetTextureClass() const


description: The material value type of this texture.

code: virtual EMaterialValueType GetMaterialType() const


description: Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

code: virtual void GetResourceSizeEx ( [FResourceSizeEx](API\Runtime\Core\ProfilingDebugging\FResourceSizeEx) & CumulativeResourceSize )


description: GetHeight

code: int32 GetWidth() const


code: void TickResource ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWebBrowserTextureSample](API\Runtime\WebBrowserTexture\FWebBrowserTextureSample), ESPMode::ThreadSafe > Sample )


description: Unregister the player's external texture GUID.

code: void UnregisterPlayerGuid()


code: UWebBrowserTexture ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UWebBrowserTexture

description: probably should have derived fromUTexture2DDynamic(notUTexture)

code: class UWebBrowserTexture : public [UTexture](API\Runtime\Engine\Engine\UTexture)

AddressX

type: TEnumAsByte< Te...

description: The addressing mode to use for the X axis.

AddressY

description: The addressing mode to use for the Y axis.

AutoClear

type: bool

description: Whether to clear the texture when no media is being played (default = enabled).

ClearColor

description: The color used to clear the texture if AutoClear is enabled (default = black).


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

module: WebSockets

code: static [FWebSocketsModule](API\Runtime\WebSockets\FWebSocketsModule) & Get()


className: Singleton

description: Singleton for the module while loaded and available

code: static [FWebSocketsModule](API\Runtime\WebSockets\FWebSocketsModule) * Singleton = nullptr;


description: FWebSocketModule.

code: FWebSocketsModule()


code: void SetExternalTextureGuid ( [FGuid](API\Runtime\Core\Misc\FGuid) guid )


className: FWebSocketsModule

description: Module for web socket implementations

code: class FWebSocketsModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Close the current connection.

code: void Close ( int32 Code, const [FString](API\Runtime\Core\Containers\FString) & Reason )


description: Initiate a client connection to the server. Use this after setting up event handlers or to reconnect after connection errors.

code: void Connect()


className: FWebSocketConnectedEvent

description: Delegate called when a web socket connection has been established successfully.

code: class FWebSocketConnectedEvent : public TBaseMulticastDelegate_NoParams< void >


className: FWebSocketConnectionErrorEvent

description: Delegate called when a web socket connection could not be established.

code: class FWebSocketConnectionErrorEvent : public TBaseMulticastDelegate_OneParam< void, const FString & >


className: FWebSocketBinaryMessageEvent

description: Delegate called when web socket binary data has been received. bIsLastFragment will be true if it is the last fragment of the current packet.

code: class FWebSocketBinaryMessageEvent : public TBaseMulticastDelegate_ThreeParams< void, const void *, SIZE_T, bool >


className: FWebSocketClosedEvent

description: Delegate called when a web socket connection has been closed.

code: class FWebSocketClosedEvent : public TBaseMulticastDelegate_ThreeParams< void, int32, const FString &, bool >


className: FWebSocketMessageEvent

description: Delegate called when a web socket text message has been received. Assumes the payload is encoded as UTF8. For binary data, bind to OnRawMessage instead.

code: class FWebSocketMessageEvent : public TBaseMulticastDelegate_OneParam< void, const FString & >


className: FWebSocketRawMessageEvent

description: Delegate called when any web socket data has been received. May be called multiple times for a message if the message was split into multiple frames. This is called for every web socket fragment. BytesRemaining is the number of bytes left in the current fragment.

code: class FWebSocketRawMessageEvent : public TBaseMulticastDelegate_ThreeParams< void, const void *, SIZE_T, SIZE_T >


className: FWebSocketMessageSentEvent

description: Delegate called when a web socket text message has been sent. Assume UTF-8 encoding.

code: class FWebSocketMessageSentEvent : public TBaseMulticastDelegate_OneParam< void, const FString & >


description: Inquire if this web socket instance is connected to a server.

code: bool IsConnected()


description: Transmit data over the connection.

code: void Send ( const [FString](API\Runtime\Core\Containers\FString) & Data )


description: Transmit data over the connection.

code: void Send ( const void * Data, SIZE_T Size, bool bIsBinary )


description: Optionally change memory limit for receiving UTF-8 text on this socket. Default from config TextMessageMemoryLimit under [WebSockets] or 1MB.

code: void SetTextMessageMemoryLimit ( uint64 TextMessageMemoryLimit )


description: Web sockets start-up: call before creating any web sockets

code: void InitWebSockets ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > Protocols )


description:
Instantiates a new web socket for the current platform
newIWebSocketinstance

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IWebSocket](API\Runtime\WebSockets\IWebSocket) > CreateWebSocket ( const [FString](API\Runtime\Core\Containers\FString) & Url, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & Protocols, const [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > & UpgradeHeaders )


className: IWebSocketsManager

code: class IWebSocketsManager


description: Web sockets teardown: call at shutdown, in particular after all use of SSL has finished

code: void ShutdownWebSockets()


description: Virtual destructor

code: virtual ~IWebSocketsManager()


description: The desired Carousel scroll direction

module: WidgetCarousel

code: namespace EWidgetCarouselScrollDirection { enum Type { Carousel_Left, Carousel_Right, Carousel_Center, } }


description:
Blend the widget fade / transform to the desired value.
True if still blending, false otherwise

code: bool BlendWidget ( const float & DeltaTime, const float & DesiredValue, const float & Speed, float & OutCurrentValue )


description:
FTextGetPositionText() const { returnFText::FromString(FString::Printf(TEXT("%.2f, %.2f, %.2f"), SlideValue, DesiredSlideValue, SlideInCurve.GetLerp())); } Get the FX widget to display.
The FX widget.


description:
Get the slide position - used by the FX widget to get its position.
The slide position.

code: FVector2D GetSlide() const


code: const float GetSlideValue() const


description: Scroll out the widget.

code: void PeakIn ( [EWidgetCarouselScrollDirection::Type](API\Runtime\WidgetCarousel\EWidgetCarouselScrollDirection__-) ScrollDirection )


description: Scroll in the widget.  The scroll direction.

code: void ScrollIn ( [EWidgetCarouselScrollDirection::Type](API\Runtime\WidgetCarousel\EWidgetCarouselScrollDirection__-) ScrollDirection )


description: Set the fade rate. The widget fade in and out at this amount per frame.

code: void SetFadeRate ( float DesiredFadeRate )


description: Get the widget opacity.

code: void SetOpacity ( float InOpacity )


description: Set the slide position.

code: void SetSlide ( float InSlide, bool bClearTransition )


description: Set the desired move speed.

code: void SetMoveSpeed ( float DesiredMoveSpeed )


description: Set the desired left limit. The widget will go to this position when scrolling out and left.

code: void SetSliderLeftLimit ( float DesiredLeftLimit )


code: void SetSliderPeakLeftLimit ( float DesiredLimit )


description: Set the optimal slide position. The widget will go to this position when in view.

code: void SetSliderOptimalPostion ( float DesiredOptimalSlideValue )


code: void SetSliderPeakRightLimit ( float DesiredLimit )


description: Set the desired right limit. The widget will go to this position when scrolling out and right.

code: void SetSliderRightLimit ( float DesiredRightLimit )


description: Tick the widget - animate the slide / fade.

code: void Tick ( float DeltaTime )


code: void SetVisibility ( [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisibility )


description: Set the content of the widget to display.

code: void SetWidgetContent ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InContent )


description: Construct the display widget.

code: FCarouselDisplayItem()


className: FCarouselDisplayItem

description: The Carousel display widget that gets animated by the carousel widget

code: struct FCarouselDisplayItem : public [TSharedFromThis< FCarouselDisplayItem >](API\Runtime\Core\Templates\TSharedFromThis)

bFade

description: Holds if the widget is fading in or out.

bFadeInAndOut

description: Holds if the widget should fade in or out.

bPeak

description: Hold if the widget is peaking.

bTransition

description: Holds if widget is in transition.

DesiredOpacityValue

type: float

description: The desired opacity value.

DesiredSlideValue

description: The desired slide value.

FadeRate

description: The amount by which a widget fades per frame.

FXWidget

type: TSharedPtr<SFx...

description: Holds the FX widget that does the transitioning.

MoveSpeed

description: The maximum move speed of the widget.

OpacityValue

description: Holds the Opacity Value. 0 == transparent.

OptimalSlideValue

description: The slide value to display the widget on screen.

PeakDistance

description: The Peak Distance.

PeakSpeed

description: The Peak speed.

PeakValueLeftLimit

description: The left peak position.

PeakValueRightLimit

description: The right peak position.

SlideInCurve

type: FCurveSequence

description: Holds the peak curve.

SlideValue

description: The slide position.

SlideValueLeftLimit

description: The max left position.

SlideValueRightLimit

description: The max right position.

Visibility

type: EVisibility

description: The current visibility of the display item.


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


className: FWidgetCarouselModule

description: Implements the WidgetCarousel module.

code: class FWidgetCarouselModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


description: The Slate style set for the widget carousel

code: static const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) & Get()


description: Reloads textures used by slate renderer

code: static void ReloadTextures()


className: WidgetCarouselStyleInstance

description: Module style set

code: static [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FSlateStyleSet](API\Runtime\SlateCore\Styling\FSlateStyleSet) > WidgetCarouselStyleInstance = NULL;


className: FWidgetCarouselModuleStyle

description: Manages the style which provides resources for the add content dialog.

code: class FWidgetCarouselModuleStyle


code: static const [FWidgetCarouselNavigationBarStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationBarStyl-) & GetDefault()


description: This method must be implemented by inherited structures.

code: virtual void GetResources ( [TArray](API\Runtime\Core\Containers\TArray)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & OutBrushes ) const


description:
This method must be implemented by inherited structures.
Widget style name.

code: virtual const [FName](API\Runtime\Core\UObject\FName) GetTypeName() const


code: [FWidgetCarouselNavigationBarStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationBarStyl-) & SetCenterButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) & InCenterButtonStyle )


code: [FWidgetCarouselNavigationBarStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationBarStyl-) & SetHighlightBrush ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InHighlightBrush )


code: [FWidgetCarouselNavigationBarStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationBarStyl-) & SetRightButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) & InRightButtonStyle )


code: [FWidgetCarouselNavigationBarStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationBarStyl-) & SetLeftButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) & InLeftButtonStyle )


className: TypeName

code: static const [FName](API\Runtime\Core\UObject\FName) TypeName;


className: FWidgetCarouselNavigationBarStyle

code: struct FWidgetCarouselNavigationBarStyle : public [FSlateWidgetStyle](API\Runtime\SlateCore\Styling\FSlateWidgetStyle)

CenterButtonStyle

type: FButtonStyle

HighlightBrush

type: FSlateBrush


description: Navigation bar style

code: FWidgetCarouselNavigationBarStyle()


code: static const [FWidgetCarouselNavigationButtonStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationButtonS-) & GetDefault()


code: [FWidgetCarouselNavigationButtonStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationButtonS-) & SetInnerButtonStyle ( const [FButtonStyle](API\Runtime\SlateCore\Styling\FButtonStyle) & InInnerButtonStyle )


code: [FWidgetCarouselNavigationButtonStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationButtonS-) & SetNavigationButtonLeftImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InNavigationButtonLeftImage )


code: [FWidgetCarouselNavigationButtonStyle](API\Runtime\WidgetCarousel\FWidgetCarouselNavigationButtonS-) & SetNavigationButtonRightImage ( const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) & InNavigationButtonRightImage )


description: Navigation button style

code: FWidgetCarouselNavigationButtonStyle()


className: FWidgetCarouselNavigationButtonStyle

code: struct FWidgetCarouselNavigationButtonStyle : public [FSlateWidgetStyle](API\Runtime\SlateCore\Styling\FSlateWidgetStyle)


code: void Construct ( const [FArguments](API\Runtime\WidgetCarousel\SCarouselNavigationBar\FArguments) & InArgs )


description: The index of the currently selected item.

code: WidgetArgsType & CurrentItemIndex &40; const TAttribute< int32 > & InAttribute &41;


description: The amount of offset which should be applied to the selected item indicator.

code: WidgetArgsType & CurrentSlideAmount &40; const TAttribute< float > & InAttribute &41;


code: WidgetArgsType & Style &40; const FWidgetCarouselNavigationBarStyle &42; InArg &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description: Called when the selected index changes.

code: WidgetArgsType & OnSelectedIndexChanged &40; const FOnSelectedIndexChanged & InDelegate &41;


description: The number of items to generate navigation buttons for.

code: WidgetArgsType & ItemCount &40; int32 InArg &41;


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SCarouselNavigationBar >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnSelectedIndexChanged

code: typedef TBaseDelegate_OneParam< void, int32 > FOnSelectedIndexChanged


code: void SetItemCount ( int32 InItemCount )


className: SCarouselNavigationBar

description: A horizontal bar of buttons for navigating to a specific item in the widget carousel.

code: class SCarouselNavigationBar : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


code: void Construct ( const [FArguments](API\Runtime\WidgetCarousel\SCarouselNavigationButton\FArguments) & InArgs )


className: ENavigationButtonDirection

code: enum ENavigationButtonDirection { Left, Right, }


description: Specifies which direction should be used to setup the button's visuals and layout.

code: WidgetArgsType & Direction &40; ENavigationButtonDirection InArg &41;


description: Called when the button is clicked

code: WidgetArgsType & OnClicked &40; const FOnClicked & InDelegate &41;


description: Called when the carousel should shift it's image to give a preview of the next image

code: WidgetArgsType & OnBeginPeek &40; const FOnBeginPeek & InDelegate &41;


code: WidgetArgsType & OnEndPeek &40; const FOnEndPeek & InDelegate &41;


code: WidgetArgsType & Style &40; const FWidgetCarouselNavigationButtonStyle &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SCarouselNavigationButton >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


className: FOnBeginPeek

code: typedef TBaseDelegate_NoParams< void > FOnBeginPeek


className: FOnEndPeek

code: typedef TBaseDelegate_NoParams< void > FOnEndPeek


code: void Construct &40; const FArguments & InArgs &41;


code: NamedSlotProperty< FArguments > Content&40;&41;


description: Called when the button is hovered


code: WidgetArgsType & HAlign &40; EHorizontalAlignment InArg &41;


code: FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;


code: WidgetArgsType & VAlign &40; EVerticalAlignment InArg &41;


code: WidgetArgsType & Padding &40; const TAttribute< FMargin > & InAttribute &41;


code: typedef FArguments WidgetArgsType


description:
operator[](
constTSharedRef<SWidget>& InChild)

code: struct FArguments : public TSlateBaseNamedArgs< SPeekBorder >


description: The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.

code: virtual void OnMouseLeave &40; const FPointerEvent & MouseEvent &41;


className: SPeekBorder

code: class SPeekBorder : public [SBorder](API\Runtime\Slate\Widgets\Layout\SBorder)


className: SCarouselNavigationButton

description: A widget used to navigate the carousel widget

code: class SCarouselNavigationButton : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


description: Constructs the widget.

code: void Construct ( const [FArguments](API\Runtime\WidgetCarousel\SWidgetCarousel\FArguments) & InArgs )


description: The fade rate

code: WidgetArgsType & FadeRate &40; const TAttribute< float > & InAttribute &41;


description: The move speed

code: WidgetArgsType & MoveSpeed &40; const TAttribute< float > & InAttribute &41;


description: Called when we change a widget

code: WidgetArgsType & OnGenerateWidget &40; const FOnGenerateWidget & InDelegate &41;


description: The left limit

code: WidgetArgsType & PeakValueLeftLimit &40; const TAttribute< float > & InAttribute &41;


description: Event triggered when the current page changes

code: WidgetArgsType & OnPageChanged &40; const FOnCarouselPageChanged & InDelegate &41;


description: The system will use this event to notify a widget that the cursor has entered it. This event is uses a custom bubble strategy.

code: virtual void OnMouseEnter &40; const FGeometry & MyGeometry, const FPointerEvent & MouseEvent &41;


description: The left limit

code: WidgetArgsType & SlideValueLeftLimit &40; const TAttribute< float > & InAttribute &41;


description: The right limit

code: WidgetArgsType & SlideValueRightLimit &40; const TAttribute< float > & InAttribute &41;


description: The data source

code: WidgetArgsType & WidgetItemsSource &40; const TArray< ItemType > &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SWidgetCarousel< ItemType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: The right limit

code: WidgetArgsType & PeakValueRightLimit &40; const TAttribute< float > & InAttribute &41;


className: FOnCarouselPageChanged

code: typedef TBaseDelegate_OneParam< void, int32 > FOnCarouselPageChanged


code: void GenerateCurrentWidgets()


code: int32 GetLeftWidgetIndex ( int32 Index )


description: Regenerate the widgets to display them.

code: void GenerateWidgets()


code: int32 GetRightWidgetIndex ( int32 Index )


description:
Get the current widget index.
The visible widget index

code: int32 GetWidgetIndex()


code: void Peak ( [EWidgetCarouselScrollDirection::Type](API\Runtime\WidgetCarousel\EWidgetCarouselScrollDirection__-) Direction )


code: EActiveTimerReturnType RegisteredTick ( double InCurrentTime, float InDeltaTime )


description: Set the item source, and scroll to the first item.

code: void SetItemSource ( const [TArray](API\Runtime\Core\Containers\TArray)< ItemType > * InWidgetItemsSource )


description: Sets the active widget to display at the specified index.

code: void SetActiveWidgetIndex ( int32 Index )


description: Scroll left.

code: void SetPreviousWidget()


description: Scroll right.

code: void SetNextWidget()


description: Swap the buffer index.

code: void SwapBuffer ( [EWidgetCarouselScrollDirection::Type](API\Runtime\WidgetCarousel\EWidgetCarouselScrollDirection__-) ScrollDirection, int32 OverrideWidget )


className: SWidgetCarousel

description: A widget Carousel displays widgets that can be scrolled in and out.

code: template<typename ItemType> class SWidgetCarousel : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

CenterCarouselWidget

type: TSharedPtr<FCa...

FadeRate

description: The fade rate.

ItemsSource

type: constTArray< I...

description: Pointer to the array of data items that we are observing.

LeftCarouselWidget

description: Holds the CarouselWidgets.

MoveSpeed

description: Holds the move speed.

OnGenerateWidget

type: FOnGenerateWidg...

description: Hold the delegate to be invoked when a widget changes.

OnPageChanged

type: FOnCarouselPage...

description: Hold the delegate to be invoked when the current page changes.

PeakValueLeftLimit

description: Holds The peak left limit.

PeakValueRightLimit

description: The peak right limit.

SlideValueLeftLimit

description: Holds The left limit.

SlideValueRightLimit

description: The right limit.

WidgetDisplayBox

type: TSharedPtr<SHo...

description: Holds the widget display box.

WidgetIndex

description: Holds the visible widget index.


code: WidgetArgsType & NavigationButtonStyle &40; const FWidgetCarouselNavigationButtonStyle &42; InArg &41;


code: WidgetArgsType & NavigationBarStyle &40; const FWidgetCarouselNavigationBarStyle &42; InArg &41;


code: void Construct ( const [FArguments](API\Runtime\WidgetCarousel\SWidgetCarouselWithNavigation\FArguments) & InArgs )


description: Called when we change a widget

code: WidgetArgsType & OnGenerateWidget &40; const FOnGenerateWidget & InDelegate &41;


code: typedef FArguments WidgetArgsType


description: The data source

code: WidgetArgsType & WidgetItemsSource &40; const TArray< ItemType > &42; InArg &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SWidgetCarouselWithNavigation< ItemType > >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


code: ~SWidgetCarouselWithNavigation()


className: FOnGenerateWidget

code: typedef TSlateDelegates< ItemType >::[FOnGenerateWidget](API\Runtime\WidgetCarousel\SWidgetCarouselWithNavigation\FOnGenerateWidget) FOnGenerateWidget


className: SWidgetCarouselWithNavigation

description: A widget carousel which includes embedded left and right navigation buttons and a navigation bar below.

code: template<typename ItemType> class SWidgetCarouselWithNavigation : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)


module: XmlParser

code: namespace EConstructMethod { enum Type { ConstructFromFile, ConstructFromBuffer, } }


description:
Quickly parse an XML file. Pass in your implementation of theIFastXmlCallbackinterface with code to handle parsed elements and attributes, along with either the full path to the XML file to load, or a string with the full XML file content.
Returns true if loading was successful, or false if anything went wrong or the user canceled. When false is returned, an error message string will be set in the OutErrorMessage variable, along with the line number that parsing failed at in OutErrorLineNumber.

code: static bool ParseXmlFile ( class [IFastXmlCallback](API\Runtime\XmlParser\IFastXmlCallback) * Callback, const TCHAR * XmlFilePath, TCHAR * XmlFileContents, class [FFeedbackContext](API\Runtime\Core\Misc\FFeedbackContext) * FeedbackContext, const bool bShowSlowTaskDialog, const bool bShowCancelButton, [FText](API\Runtime\Core\Internationalization\FText) & OutErrorMessage, int32 & OutErrorLineNumber )


description: Gets the tag of the attribute

code: const [FString](API\Runtime\Core\Containers\FString) & GetTag() const


className: FFastXml

description: Remember to add a module dependency on "XmlParser" in order to be able to call FFastXml::ParserXmlFile().

code: class FFastXml


className: FXmlAttribute

code: class FXmlAttribute


code: FXmlAttribute ( const [FString](API\Runtime\Core\Containers\FString) & InTag, const [FString](API\Runtime\Core\Containers\FString) & InValue )


description: Gets the value of the attribute

code: const [FString](API\Runtime\Core\Containers\FString) & GetValue() const


description: Clears the file of all internals. Note: Makes any existing pointers toFXmlNode's INVALID

code: void Clear()


description: Gets the last error message from the class


description:
Returns the root node of the loaded file. nullptr if no file loaded. It is assumed that there will always be one and only one root node.
Pointer to root node

code: const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetRootNode() const


description: Loads the file with the passed path. Path is either treated as a filename to open, or as a text buffer to load.

code: bool LoadFile ( const [FString](API\Runtime\Core\Containers\FString) & Path, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )


code: [FXmlFile](API\Runtime\XmlParser\FXmlFile) & operator= ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )


description: Constructs the file without a path

code: FXmlFile()


description:
Write to disk, UTF-16 format only at the moment
Whether writing the XML to a file succeeded

code: bool Save ( const [FString](API\Runtime\Core\Containers\FString) & Path )


description: Checks to see if a file is loaded

code: bool IsValid() const


code: FXmlFile ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )


description: Constructs the file with the passed path. InFile is either treated as a filename to open, or as a text buffer to load.

code: FXmlFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )


className: FXmlFile

description: Class representing an XML file

code: class FXmlFile


description: Finds the first child node that contains the specified tag

code: const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const


description: Adds a child node to this node

code: void AppendChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag, const [FString](API\Runtime\Core\Containers\FString) & InContent, const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )


code: [FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag )


description: Gets an attribute that corresponds with the passed-in tag

code: [FString](API\Runtime\Core\Containers\FString) GetAttribute ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const


description:
Gets all of the attributes in this node
List of attributes in this node

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & GetAttributes() const


description: Gets a list of children nodes

code: const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlNode](API\Runtime\XmlParser\FXmlNode) * > & GetChildrenNodes() const


description: Gets the first child of this node which can be iterated into with GetNextNode

code: const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetFirstChildNode() const


description: Gets the value of the node

code: const [FString](API\Runtime\Core\Containers\FString) & GetContent() const


description: Gets the next node in a list of nodes

code: const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetNextNode() const


description: Gets the tag of the node

code: const [FString](API\Runtime\Core\Containers\FString) & GetTag() const


description: Sets the new value of the node

code: void SetContent ( const [FString](API\Runtime\Core\Containers\FString) & InContent )


description: Sets the attributes of the node

code: void SetAttributes ( const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )


className: FXmlNode

description: No destructors are accessible with public or protected access.

code: class FXmlNode


description:
Called when an XML attribute is encountered for the current scope's element.
You should return true to continue processing the file, or false to stop processing immediately.

code: bool ProcessAttribute ( const TCHAR * AttributeName, const TCHAR * AttributeValue )


description: Called when a comment is encountered. This can happen pretty much anywhere in the file.

code: bool ProcessComment ( const TCHAR * Comment )


description:
Called when an element's scope ends in the XML file
You should return true to continue processing the file, or false to stop processing immediately.

code: bool ProcessClose ( const TCHAR * Element )


description:
Called when a new XML element is encountered, starting a new scope. You'll receive a call toProcessClose()when this element's scope has ended.
You should return true to continue processing the file, or false to stop processing immediately.

code: bool ProcessElement ( const TCHAR * ElementName, const TCHAR * ElementData, int32 XmlFileLineNumber )


className: IFastXmlCallback

description: Create your own class that implements theIFastXmlCallbackinterface to process the XML elements as they are loaded byFFastXml::ParseXmlFile(). You'll receive aProcessElement()call for every XML element that is encountered, along with a correspondingProcessClose()when that element's scope has ended.ProcessAttribute()will be called for any attributes found within the scope of the current element.

code: class IFastXmlCallback


description:
Called after the XML's header is parsed. This is usually the first call that you'll get back.
You should return true to continue processing the file, or false to stop processing immediately.

code: bool ProcessXmlDeclaration ( const TCHAR * ElementData, int32 XmlFileLineNumber )