Signals - HTML Surface

These callbacks require you to run Steam.run_callbacks() in your _process() function to receive them.

html_browser_ready

A new browser was created and is ready for use.

Returns:

browser_handle (uint32)

html_can_go_backandforward

Called when page history status has changed the ability to go backwards and forward.

Returns:

browser_handle (uint32)
go_back (bool)
go_forward (bool)

html_changed_title

Called when the current page in a browser gets a new title.

Returns:

browser_handle (uint32)
title (string)

html_close_browser

Called when the browser has been requested to close due to user interaction; usually because of a javascript window.close() call.

Returns:

browser_handle (uint32)

html_file_open_dialog

Called when a browser surface has received a file open dialog from a input type="file" click or similar, you must call FileLoadDialogResponse with the file(s) the user selected.

Returns:

browser_handle (uint32)
title (string)
initial_file (string)

html_finished_request

Called when a browser has finished loading a page.

Returns:

browser_handle (uint32)
url (string)
title (string)

html_hide_tooltip

Called when a a browser wants to hide a tooltip.

Returns:

browser_handle (uint32)

html_horizontal_scroll

Provides details on the visibility and size of the horizontal scrollbar.

Returns:

browser_handle (uint32)
scroll_data (dictionary)
- scroll_max (uint32)
- scroll_current (uint32)
- page_scale (float)
- visible (bool)
- page_size (uint32)

html_js_alert

Called when the browser wants to display a Javascript alert dialog, call jsDialogResponse when the user dismisses this dialog; or right away to ignore it.

Returns:

browser_handle (uint32)
message (string)

html_js_confirm

Called when the browser wants to display a Javascript confirmation dialog, call jsDialogResponse when the user dismisses this dialog; or right away to ignore it.

Returns:

browser_handle (uint32)
message (string)

html_link_at_position

Result of a call to getLinkAtPosition.

Returns:

browser_handle (uint32)
link_data (dictionary)
- x (uint32)
- y (uint32)
- url (string)
- input (bool)
- live_link (bool)

html_needs_paint

Called when a browser surface has a pending paint. This is where you get the actual image data to render to the screen.

Returns:

browser_handle (uint32)
page_data (dictionary)
- bgra (string)
- wide (uint32)
- tall (uint32)
- update_x (uint32)
- update_y (uint32)
- update_wide (uint32)
- update_tall (uint32)
- scroll_x (uint32)
- scroll_y (uint32)
- page_scale (float)
- page_serial (uint32)

html_new_window

A browser has created a new HTML window.

Returns:

browser_handle (uint32)
window_data (dictionary)
- url (string)
- x (uint32)
- y (uint32)
- wide (uint32)
- tall (uint32)
- new_handle (uint32)

html_open_link_in_new_tab

The browser has requested to load a url in a new tab.

Returns:

browser_handle (uint32)
url (string)

html_search_results

Results from a search.

Returns:

browser_handle (uint32)
results (uint32)
current_match (uint32)

html_set_cursor

Called when a browser wants to change the mouse cursor.

Returns:

browser_handle (uint32)
mouse_cursor (uint32)

html_show_tooltip

Called when a browser wants to display a tooltip.

Returns:

browser_handle (uint32)
message (string)

html_start_request

Called when a browser wants to navigate to a new page.

Returns:

browser_handle (uint32)
url (string)
target (string)
post_data (string)
redirect (bool)

html_status_text

Called when a browser wants you to display an informational message. This is most commonly used when you hover over links.

Returns:

browser_handle (uint32)
message (string)

html_update_tooltip

Called when the text of an existing tooltip has been updated.

Returns:

browser_handle (uint32)
message (string)

html_url_changed

Called when the browser is navigating to a new url.

Returns:

browser_handle (uint32)
url_data (dictionary)
- url (string)
- post_data (string)
- redirect (bool)
- title (string)
- new_navigation (bool)

html_vertical_scroll

Provides details on the visibility and size of the vertical scrollbar.

Returns:

browser_handle (uint32)
- scroll_max (uint32)
- scroll_current (uint32)
- page_scale (float)
- visible (bool)
- page_size (uint32)
scroll_data (dictionary)