# API

# webview.create_window

webview.create_window(title, url='', html='', js_api=None, width=800, height=600, \
                      x=None, y=None, resizable=True, fullscreen=False, \
                      min_size=(200, 100), hidden=False, frameless=False, \
                      minimized=False, on_top=False, confirm_close=False, \
                      background_color='#FFF', text_select=False)

Create a new pywebview window and returns its instance. Window is not shown until the GUI loop is started. If the function is invoked during the GUI loop, the window is displayed immediately.

title - Window title
url - URL to load. If the URL does not have a protocol prefix, it is resolved as a path relative to the application entry point. Alternatively a WSGI server object can be passed to start a local web server.
html - HTML code to load. If both URL and HTML are specified, HTML takes precedence.
js_api - Expose a python object to the DOM of the current pywebview window. Methods of the js_api object can be executed from Javascript by calling window.pywebview.api.<methodname>(<parameters>). Please note that the calling Javascript function receives a promise that will contain the return value of the python function. Only basic Python objects (like int, str, dict, ...) can be returned to Javascript.
width - Window width. Default is 800px.
height - Window height. Default is 600px.
x - Window x coordinate. Default is centered.
y - Window y coordinate. Default is centered.
resizable - Whether window can be resized. Default is True
fullscreen - Start in fullscreen mode. Default is False
min_size - a (width, height) tuple that specifies a minimum window size. Default is 200x100
hidden - Create a window hidden by default. Default is False
frameless - Create a frameless window. Default is False.
easy_drag - Easy drag mode for frameless windows. Window can be moved by dragging any point. Default is True. Note that easy_drag has no effect with normal windows. To control dragging on an element basis, see drag area for details.
minimized - Start in minimized mode
on_top - Set window to be always on top of other windows. Default is False.
confirm_close - Whether to display a window close confirmation dialog. Default is False
background_color - Background color of the window displayed before WebView is loaded. Specified as a hex color. Default is white.
transparent - Create a transparent window. Not supported on Windows. Default is False. Note that this setting does not hide or make window chrome transparent. To hide window chrome set frameless to True.
text_select - Enables document text selection. Default is False. To control text selection on per element basis, use user-select (opens new window) CSS property.

# webview.start

webview.start(func=None, args=None, localization={}, gui=None, debug=False, \
              http_server=False, user_agent=None)

Start a GUI loop and display previously created windows. This function must be called from a main thread.

func - function to invoke upon starting the GUI loop.
args - function arguments. Can be either a single value or a tuple of values.
localization - a dictionary with localized strings. Default strings and their keys are defined in localization.py
gui - force a specific GUI. Allowed values are cef, qt or gtk depending on a platform. See Renderer for details.
debug - enable debug mode. See Debugging for details.
http_server - enable built-in HTTP server. If enabled, local files will be served using a local HTTP server on a random port. For each window, a separate HTTP server is spawned. This option is ignored for non-local URLs.
user_agent - change user agent string. Not supported in EdgeHTML.

# Examples

# webview.screens

webview.screens

Return a list of available displays (as Screen objects) with the primary display as the first element of the list.

# Examples

Simple window

# webview.token

webview.token

A CSRF token property unique to the session. The same token is exposed as window.pywebview.token. See Security for usage details.

# Screen object

Represents a display found on the system.

# height

screen.height

Get display height.

# width

screen.width

Get display width.

# Window object

Represents a window that hosts webview. window object is returned by create_window function.

# on_top

window.on_top

Get or set whether the window is always on top

# x

window.x

Get X coordinate of the top-left corrner of the window

# y

window.y

Get Y coordinate of the top-left corrner of the window

# width

window.width

Get width of the window

# height

window.height

Get height of the window

# create_file_dialog

window.create_file_dialog(dialog_type=OPEN_DIALOG, directory='', allow_multiple=False, save_filename='', file_types=())`

Create an open file (webview.OPEN_DIALOG), open folder (webview.FOLDER_DIALOG) or save file (webview.SAVE_DIALOG) dialog.

Return a tuple of selected files, None if cancelled.

allow_multiple=True enables multiple selection.
directory Initial directory.
save_filename Default filename for save file dialog.
file_types A tuple of supported file type strings in the open file dialog. A file type string must follow this format "Description (*.ext1;*.ext2...)".

If the argument is not specified, then the "All files (*.*)" mask is used by default. The 'All files' string can be changed in the localization dictionary.

# Examples

# destroy

window.destroy()

Destroy the window.

# API

# webview.create_window

# webview.start

# Examples

# webview.screens

# Examples

# webview.token

# Screen object

# height

# width

# Window object

# on_top

# x

# y

# width

# height

# create_file_dialog

# Examples

# destroy

# evaluate_js

# get_current_url

# get_elements

# hide

# load_css

# load_html

# load_url

# minimize

# move

# resize

# restore

# set_title

# show

# toggle_fullscreen

# Events

# events.closed

# events.closing

# events.loaded

# events.minimized

# events.restore

# events.maximized

# events.resized

# events.shown

# DOM events

# Drag area