mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2024-12-11 09:08:06 +01:00
215 lines
11 KiB
C++
215 lines
11 KiB
C++
// Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without
|
|
// modification, are permitted provided that the following conditions are
|
|
// met:
|
|
//
|
|
// * Redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
// * Redistributions in binary form must reproduce the above
|
|
// copyright notice, this list of conditions and the following disclaimer
|
|
// in the documentation and/or other materials provided with the
|
|
// distribution.
|
|
// * Neither the name of Google Inc. nor the name Chromium Embedded
|
|
// Framework nor the names of its contributors may be used to endorse
|
|
// or promote products derived from this software without specific prior
|
|
// written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
//
|
|
// ---------------------------------------------------------------------------
|
|
//
|
|
// The contents of this file must follow a specific format in order to
|
|
// support the CEF translator tool. See the translator.README.txt file in the
|
|
// tools directory for more information.
|
|
//
|
|
|
|
#ifndef CEF_INCLUDE_CEF_LIFE_SPAN_HANDLER_H_
|
|
#define CEF_INCLUDE_CEF_LIFE_SPAN_HANDLER_H_
|
|
#pragma once
|
|
|
|
#include "include/cef_base.h"
|
|
#include "include/cef_browser.h"
|
|
|
|
class CefClient;
|
|
|
|
///
|
|
/// Implement this interface to handle events related to browser life span. The
|
|
/// methods of this class will be called on the UI thread unless otherwise
|
|
/// indicated.
|
|
///
|
|
/*--cef(source=client)--*/
|
|
class CefLifeSpanHandler : public virtual CefBaseRefCounted {
|
|
public:
|
|
typedef cef_window_open_disposition_t WindowOpenDisposition;
|
|
|
|
///
|
|
/// 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 |popupFeatures| structure contains additional
|
|
/// information about the requested popup window. To allow creation of the
|
|
/// popup browser optionally modify |windowInfo|, |client|, |settings| 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
|
|
/// |windowInfo| 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). The
|
|
/// |extra_info| parameter provides an opportunity to specify extra
|
|
/// information specific to the created popup browser that will be passed to
|
|
/// CefRenderProcessHandler::OnBrowserCreated() in the render process.
|
|
///
|
|
/*--cef(optional_param=target_url,optional_param=target_frame_name)--*/
|
|
virtual bool OnBeforePopup(CefRefPtr<CefBrowser> browser,
|
|
CefRefPtr<CefFrame> frame,
|
|
const CefString& target_url,
|
|
const CefString& target_frame_name,
|
|
WindowOpenDisposition target_disposition,
|
|
bool user_gesture,
|
|
const CefPopupFeatures& popupFeatures,
|
|
CefWindowInfo& windowInfo,
|
|
CefRefPtr<CefClient>& client,
|
|
CefBrowserSettings& settings,
|
|
CefRefPtr<CefDictionaryValue>& extra_info,
|
|
bool* no_javascript_access) {
|
|
return false;
|
|
}
|
|
|
|
///
|
|
/// Called after a new browser is created. It is now safe to begin performing
|
|
/// actions with |browser|. CefFrameHandler callbacks related to initial main
|
|
/// frame creation will arrive before this callback. See CefFrameHandler
|
|
/// documentation for additional usage information.
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnAfterCreated(CefRefPtr<CefBrowser> browser) {}
|
|
|
|
///
|
|
/// Called when a browser has recieved a request to close. This may result
|
|
/// directly from a call to CefBrowserHost::*CloseBrowser() or indirectly if
|
|
/// the browser is parented to a top-level window created by CEF and the user
|
|
/// attempts to close that window (by clicking the 'X', for example). The
|
|
/// DoClose() method will be called after the JavaScript 'onunload' event has
|
|
/// been fired.
|
|
///
|
|
/// An application should handle top-level owner window close notifications by
|
|
/// calling CefBrowserHost::TryCloseBrowser() or
|
|
/// CefBrowserHost::CloseBrowser(false) instead of allowing the window to
|
|
/// close immediately (see the examples below). This gives CEF an opportunity
|
|
/// to process the 'onbeforeunload' event and optionally cancel the close
|
|
/// before DoClose() is called.
|
|
///
|
|
/// When windowed rendering is enabled CEF will internally create a window or
|
|
/// view to host the browser. In that case returning false from DoClose() will
|
|
/// send the standard close notification to the browser's top-level owner
|
|
/// window (e.g. WM_CLOSE on Windows, performClose: on OS X, "delete_event" on
|
|
/// Linux or CefWindowDelegate::CanClose() callback from Views). If the
|
|
/// browser's host window/view has already been destroyed (via view hierarchy
|
|
/// tear-down, for example) then DoClose() will not be called for that browser
|
|
/// since is no longer possible to cancel the close.
|
|
///
|
|
/// When windowed rendering is disabled returning false from DoClose() will
|
|
/// cause the browser object to be destroyed immediately.
|
|
///
|
|
/// If the browser's top-level owner window requires a non-standard close
|
|
/// notification then send that notification from DoClose() and return true.
|
|
///
|
|
/// The CefLifeSpanHandler::OnBeforeClose() method will be called after
|
|
/// DoClose() (if DoClose() is called) and immediately before the browser
|
|
/// object is destroyed. The application should only exit after
|
|
/// OnBeforeClose() has been called for all existing browsers.
|
|
///
|
|
/// The below examples describe what should happen during window close when
|
|
/// the browser is parented to an application-provided top-level window.
|
|
///
|
|
/// Example 1: Using CefBrowserHost::TryCloseBrowser(). This is recommended
|
|
/// for clients using standard close handling and windows created on the
|
|
/// browser process UI thread.
|
|
/// 1. User clicks the window close button which sends a close notification
|
|
/// to the application's top-level window.
|
|
/// 2. Application's top-level window receives the close notification and
|
|
/// calls TryCloseBrowser() (which internally calls CloseBrowser(false)).
|
|
/// TryCloseBrowser() returns false so the client cancels the window
|
|
/// close.
|
|
/// 3. JavaScript 'onbeforeunload' handler executes and shows the close
|
|
/// confirmation dialog (which can be overridden via
|
|
/// CefJSDialogHandler::OnBeforeUnloadDialog()).
|
|
/// 4. User approves the close.
|
|
/// 5. JavaScript 'onunload' handler executes.
|
|
/// 6. CEF sends a close notification to the application's top-level window
|
|
/// (because DoClose() returned false by default).
|
|
/// 7. Application's top-level window receives the close notification and
|
|
/// calls TryCloseBrowser(). TryCloseBrowser() returns true so the client
|
|
/// allows the window close.
|
|
/// 8. Application's top-level window is destroyed.
|
|
/// 9. Application's OnBeforeClose() handler is called and the browser object
|
|
/// is destroyed.
|
|
/// 10. Application exits by calling CefQuitMessageLoop() if no other browsers
|
|
/// exist.
|
|
///
|
|
/// Example 2: Using CefBrowserHost::CloseBrowser(false) and implementing the
|
|
/// DoClose() callback. This is recommended for clients using non-standard
|
|
/// close handling or windows that were not created on the browser process UI
|
|
/// thread.
|
|
/// 1. User clicks the window close button which sends a close notification
|
|
/// to the application's top-level window.
|
|
/// 2. Application's top-level window receives the close notification and:
|
|
/// A. Calls CefBrowserHost::CloseBrowser(false).
|
|
/// B. Cancels the window close.
|
|
/// 3. JavaScript 'onbeforeunload' handler executes and shows the close
|
|
/// confirmation dialog (which can be overridden via
|
|
/// CefJSDialogHandler::OnBeforeUnloadDialog()).
|
|
/// 4. User approves the close.
|
|
/// 5. JavaScript 'onunload' handler executes.
|
|
/// 6. Application's DoClose() handler is called. Application will:
|
|
/// A. Set a flag to indicate that the next close attempt will be allowed.
|
|
/// B. Return false.
|
|
/// 7. CEF sends an close notification to the application's top-level window.
|
|
/// 8. Application's top-level window receives the close notification and
|
|
/// allows the window to close based on the flag from #6B.
|
|
/// 9. Application's top-level window is destroyed.
|
|
/// 10. Application's OnBeforeClose() handler is called and the browser object
|
|
/// is destroyed.
|
|
/// 11. Application exits by calling CefQuitMessageLoop() if no other browsers
|
|
/// exist.
|
|
///
|
|
/*--cef()--*/
|
|
virtual bool DoClose(CefRefPtr<CefBrowser> browser) { return false; }
|
|
|
|
///
|
|
/// 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 (other than IsValid, GetIdentifier or IsSame) after this callback
|
|
/// returns. CefFrameHandler callbacks related to final main frame destruction
|
|
/// will arrive after this callback and CefBrowser::IsValid will return false
|
|
/// at that time. Any in-progress network requests associated with |browser|
|
|
/// will be aborted when the browser is destroyed, and
|
|
/// CefResourceRequestHandler callbacks related to those requests may still
|
|
/// arrive on the IO thread after this callback. See CefFrameHandler and
|
|
/// DoClose() documentation for additional usage information.
|
|
///
|
|
/*--cef()--*/
|
|
virtual void OnBeforeClose(CefRefPtr<CefBrowser> browser) {}
|
|
};
|
|
|
|
#endif // CEF_INCLUDE_CEF_LIFE_SPAN_HANDLER_H_
|