Module wui_tab_api

Module wui_tab_api 

Source
Expand description

For controlling individual tabs

Modules§

c_api

Functions§

close_tab
Close a tab
copy_pixel_buffer
Copy the pixel buffer for a tab NOTE: This creates a copy internally and is save to operate on. The format is BGRA (directly from CEF)
create_tab
Create a new tab NOTE: Just because a tab is created does not mean it is “valid”. Wait for the correct tab state with wait_for_tab_state and make sure everything is drawn before displaying to avoid artefacts
get_callbacks
get_tab_info
Get information about a tab
load_url_tab
Load a URL in a tab NOTE: Loading a tab is potentially infinitely complex depending on your setup, the page location, networking and reroute conditions. Make sure you know what you are loading. I.g. it’s a good idea to load a local file.
resize_tab
Resize a tab WARNING: There is a small time after resizing where elements may not be where you expect them to. This is due to the locking and callback nature of the system internally. This means that during this time click events might not “hit” the expected elements. In general it is a good idea to not display UI elements while resizing to the user anyways. Resizing should also not happen particularly often for most UI elements. For an exact time when everything is “valid” again should be when a onPaint event has fired after resizing.
set_callbacks
wait_for_tab_state
Block calling thread until the tab is in the desired state NOTE: This blocks the current thread execution on a mutex condvar until the desired state is achieved. This can potentially block indefinitely.