unreal.WebBrowser

class unreal.WebBrowser(outer: Object | None = None, name: Name | str = 'None')

Bases: Widget

Web Browser

C++ Source:

  • Plugin: WebBrowserWidget

  • Module: WebBrowserWidget

  • File: WebBrowser.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.

  • accessible_summary_behavior (SlateAccessibleBehavior): [Read-Write] How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.

  • accessible_summary_text (Text): [Read-Write] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.

    NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.

  • cursor (MouseCursor): [Read-Write] The cursor to show when the mouse is over the widget

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Allows you to set a new flow direction

  • initial_url (str): [Read-Write] URL that the browser will initially navigate to. The URL should include the protocol, eg http://

  • is_enabled (bool): [Read-Write] Sets whether this widget can be modified interactively by the user

  • is_volatile (bool): [Read-Write] If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.

  • navigation (WidgetNavigation): [Read-Write] The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.

  • on_before_popup (OnBeforePopup): [Read-Write] Called when a popup is about to spawn.

  • on_console_message (OnConsoleMessage): [Read-Write] Called when the browser has console spew to print

  • on_url_changed (OnUrlChanged): [Read-Write] Called when the Url changes.

  • override_accessible_defaults (bool): [Read-Write] Override all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write]

  • pixel_snapping (WidgetPixelSnapping): [Read-Write] If the widget will draw snapped to the nearest pixel. Improves clarity but might cause visibile stepping in animation

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.

  • slot (PanelSlot): [Read-Write] The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • supports_transparency (bool): [Read-Write] Should the browser window support transparency.

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

  • tool_tip_widget (Widget): [Read-Only] Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] The visibility of the widget

execute_javascript(script_text) None

Executes a JavaScript string in the context of the web page

Parameters:

script_text (str) – JavaScript string to execute

get_title_text() Text

Get the current title of the web page

Return type:

Text

get_url() str

Gets the currently loaded URL.

Returns:

The URL, or empty string if no document is loaded.

Return type:

str

load_string(contents, dummy_url) None

Load a string as data to create a web page

Parameters:
  • contents (str) – String to load

  • dummy_url (str) – Dummy URL for the page

load_url(new_url) None

Load the specified URL

Parameters:

new_url (str) – New URL to load

property on_before_popup: OnBeforePopup

[Read-Write] Called when a popup is about to spawn.

Type:

(OnBeforePopup)

property on_console_message: OnConsoleMessage

[Read-Write] Called when the browser has console spew to print

Type:

(OnConsoleMessage)

property on_url_changed: OnUrlChanged

[Read-Write] Called when the Url changes.

Type:

(OnUrlChanged)