Skip to content

Latest commit

 

History

History
128 lines (100 loc) · 4.7 KB

LifespanHandler.md

File metadata and controls

128 lines (100 loc) · 4.7 KB
Raw

API categories | API index

LifespanHandler (interface)

Implement this interface to handle events related to browser life span. The methods of this class will be called on the UI thread.

Related code snippets:

Table of contents:

Callbacks

DoClose

Parameter Type
browser Browser
Return bool

Called when a browser has recieved a request to close. This may result directly from a call to Browser.CloseBrowser or indirectly if the browser is a top-level OS window created by CEF and the user attempts to close the window. This method will be called after the Javascript 'onunload' event has been fired. It will not be called for browsers after the associated OS window has been destroyed (for those browsers it is no longer possible to cancel the close).

See complete description of this callback in [cef_life_span_handler.h] (..|src|include|cef_life_span_handler.h).

_OnAfterCreated

Parameter Type
browser Browser
Return void

Called after a new browser is created. This callback will be the first notification that references |browser|.

This callback will be executed during browser creation, thus you must call cefpython.SetGlobalClientCallback() to use it. The callback name was prefixed with "_" to distinguish this special behavior.

OnBeforeClose

Parameter Type
browser Browser
Return void

Called just before a browser is destroyed. Release all references to the browser object and do not attempt to execute any methods on the browser object after this callback returns. This callback will be the last notification that references |browser|. See DoClose() documentation for additional usage information.

OnBeforePopup

Parameter Type
browser Browser
frame Frame
target_url string
target_frame_name string
target_disposition WindowOpenDisposition
user_gesture bool
popup_features None
window_info_out list[WindowInfo]
client None
browser_settings_out list[BrowserSettings]
no_javascript_access_out list[bool]
Return bool

Description from upstream CEF:

Called on the UI thread before a new popup browser is created. The |browser| and |frame| values represent the source of the popup request. The |target_url| and |target_frame_name| values indicate where the popup browser should navigate and may be empty if not specified with the request. The |target_disposition| value indicates where the user intended to open the popup (e.g. current tab, new tab, etc). The |user_gesture| value will be true if the popup was opened via explicit user gesture (e.g. clicking a link) or false if the popup opened automatically (e.g. via the DomContentLoaded event). The |popup_features| structure contains additional information about the requested popup window. To allow creation of the popup browser optionally modify |windowInfo|, |client|, |browserSettings| and |no_javascript_access| and return false. To cancel creation of the popup browser return true. The |client| and |settings| values will default to the source browser's values. If the |no_javascript_access| value is set to false the new browser will not be scriptable and may not be hosted in the same renderer process as the source browser. Any modifications to |window_info| will be ignored if the parent browser is wrapped in a CefBrowserView. Popup browser creation will be canceled if the parent browser is destroyed before the popup browser creation completes (indicated by a call to OnAfterCreated for the popup browser).

WindowOpenDisposition constants in the cefpython module:

  • WOD_UNKNOWN,
  • WOD_CURRENT_TAB,
  • WOD_SINGLETON_TAB,
  • WOD_NEW_FOREGROUND_TAB,
  • WOD_NEW_BACKGROUND_TAB,
  • WOD_NEW_POPUP,
  • WOD_NEW_WINDOW,
  • WOD_SAVE_TO_DISK,
  • WOD_OFF_THE_RECORD,
  • WOD_IGNORE_ACTION

Note that if you return True and create the popup window yourself, then the popup window and parent window will not be able to script each other. There will be no "window.opener" property available in the popup window. To avoid this issue create a hidden window when your application starts. Parent the new popup browser to the hidden window in OnBeforePopup. After the browser exists (OnAfterCreated) create the desired target window and re-parent the browser to that target window.