173 lines
8.2 KiB
C
173 lines
8.2 KiB
C
|
// Copyright (c) 2014 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.
|
||
|
|
//
|
||
|
|
// ---------------------------------------------------------------------------
|
||
|
|
//
|
||
|
|
// This file was generated by the CEF translator tool and should not edited
|
||
|
|
// by hand. See the translator.README.txt file in the tools directory for
|
||
|
|
// more information.
|
||
|
|
//
|
||
|
|
|
||
|
|
#ifndef CEF_INCLUDE_CAPI_CEF_LIFE_SPAN_HANDLER_CAPI_H_
|
||
|
|
#define CEF_INCLUDE_CAPI_CEF_LIFE_SPAN_HANDLER_CAPI_H_
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#include "include/capi/cef_base_capi.h"
|
||
|
|
#include "include/capi/cef_browser_capi.h"
|
||
|
|
|
||
|
|
struct _cef_client_t;
|
||
|
|
|
||
|
|
///
|
||
|
|
// Implement this structure to handle events related to browser life span. The
|
||
|
|
// functions of this structure will be called on the UI thread unless otherwise
|
||
|
|
// indicated.
|
||
|
|
///
|
||
|
|
typedef struct _cef_life_span_handler_t {
|
||
|
|
///
|
||
|
|
// Base structure.
|
||
|
|
///
|
||
|
|
cef_base_t base;
|
||
|
|
|
||
|
|
///
|
||
|
|
// Called on the IO thread before a new popup window is created. The |browser|
|
||
|
|
// and |frame| parameters represent the source of the popup request. The
|
||
|
|
// |target_url| and |target_frame_name| values may be NULL if none were
|
||
|
|
// specified with the request. The |popupFeatures| structure contains
|
||
|
|
// information about the requested popup window. To allow creation of the
|
||
|
|
// popup window optionally modify |windowInfo|, |client|, |settings| and
|
||
|
|
// |no_javascript_access| and return false (0). To cancel creation of the
|
||
|
|
// popup window return true (1). The |client| and |settings| values will
|
||
|
|
// default to the source browser's values. The |no_javascript_access| value
|
||
|
|
// indicates whether the new browser window should be scriptable and in the
|
||
|
|
// same process as the source browser.
|
||
|
|
int (CEF_CALLBACK *on_before_popup)(struct _cef_life_span_handler_t* self,
|
||
|
|
struct _cef_browser_t* browser, struct _cef_frame_t* frame,
|
||
|
|
const cef_string_t* target_url, const cef_string_t* target_frame_name,
|
||
|
|
const struct _cef_popup_features_t* popupFeatures,
|
||
|
|
struct _cef_window_info_t* windowInfo, struct _cef_client_t** client,
|
||
|
|
struct _cef_browser_settings_t* settings, int* no_javascript_access);
|
||
|
|
|
||
|
|
///
|
||
|
|
// Called after a new browser is created.
|
||
|
|
///
|
||
|
|
void (CEF_CALLBACK *on_after_created)(struct _cef_life_span_handler_t* self,
|
||
|
|
struct _cef_browser_t* browser);
|
||
|
|
|
||
|
|
///
|
||
|
|
// Called when a modal window is about to display and the modal loop should
|
||
|
|
// begin running. Return false (0) to use the default modal loop
|
||
|
|
// implementation or true (1) to use a custom implementation.
|
||
|
|
///
|
||
|
|
int (CEF_CALLBACK *run_modal)(struct _cef_life_span_handler_t* self,
|
||
|
|
struct _cef_browser_t* browser);
|
||
|
|
|
||
|
|
///
|
||
|
|
// Called when a browser has recieved a request to close. This may result
|
||
|
|
// directly from a call to cef_browser_host_t::close_browser() or indirectly
|
||
|
|
// if the browser is a top-level OS window created by CEF and the user
|
||
|
|
// attempts to close the window. This function 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).
|
||
|
|
//
|
||
|
|
// If CEF created an OS window for the browser returning false (0) will send
|
||
|
|
// an OS close notification to the browser window's top-level owner (e.g.
|
||
|
|
// WM_CLOSE on Windows, performClose: on OS-X and "delete_event" on Linux). If
|
||
|
|
// no OS window exists (window rendering disabled) returning false (0) will
|
||
|
|
// cause the browser object to be destroyed immediately. Return true (1) if
|
||
|
|
// the browser is parented to another window and that other window needs to
|
||
|
|
// receive close notification via some non-standard technique.
|
||
|
|
//
|
||
|
|
// If an application provides its own top-level window it should handle OS
|
||
|
|
// close notifications by calling cef_browser_host_t::CloseBrowser(false (0))
|
||
|
|
// instead of immediately closing (see the example below). This gives CEF an
|
||
|
|
// opportunity to process the 'onbeforeunload' event and optionally cancel the
|
||
|
|
// close before do_close() is called.
|
||
|
|
//
|
||
|
|
// The cef_life_span_handler_t::OnBeforeclose() function will be called
|
||
|
|
// immediately before the browser object is destroyed. The application should
|
||
|
|
// only exit after OnBeforeclose() has been called for all existing browsers.
|
||
|
|
//
|
||
|
|
// If the browser represents a modal window and a custom modal loop
|
||
|
|
// implementation was provided in cef_life_span_handler_t::run_modal() this
|
||
|
|
// callback should be used to restore the opener window to a usable state.
|
||
|
|
//
|
||
|
|
// By way of example consider what should happen during window close when the
|
||
|
|
// browser is parented to an application-provided top-level OS window. 1.
|
||
|
|
// User clicks the window close button which sends an OS close
|
||
|
|
// notification (e.g. WM_CLOSE on Windows, performClose: on OS-X and
|
||
|
|
// "delete_event" on Linux).
|
||
|
|
// 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 do_close() handler is called. Application will:
|
||
|
|
// A. Call CefBrowserHost::ParentWindowWillClose() to notify CEF that the
|
||
|
|
// parent window will be closing.
|
||
|
|
// B. Set a flag to indicate that the next close attempt will be allowed.
|
||
|
|
// C. Return false.
|
||
|
|
// 7. CEF sends an OS close notification. 8. Application's top-level window
|
||
|
|
// receives the OS close notification and
|
||
|
|
// allows the window to close based on the flag from #6B.
|
||
|
|
// 9. Browser OS window is destroyed. 10. Application's
|
||
|
|
// cef_life_span_handler_t::OnBeforeclose() handler is called and
|
||
|
|
// the browser object is destroyed.
|
||
|
|
// 11. Application exits by calling cef_quit_message_loop() if no other
|
||
|
|
// browsers
|
||
|
|
// exist.
|
||
|
|
///
|
||
|
|
int (CEF_CALLBACK *do_close)(struct _cef_life_span_handler_t* self,
|
||
|
|
struct _cef_browser_t* browser);
|
||
|
|
|
||
|
|
///
|
||
|
|
// Called just before a browser is destroyed. Release all references to the
|
||
|
|
// browser object and do not attempt to execute any functions on the browser
|
||
|
|
// object after this callback returns. If this is a modal window and a custom
|
||
|
|
// modal loop implementation was provided in run_modal() this callback should
|
||
|
|
// be used to exit the custom modal loop. See do_close() documentation for
|
||
|
|
// additional usage information.
|
||
|
|
///
|
||
|
|
void (CEF_CALLBACK *on_before_close)(struct _cef_life_span_handler_t* self,
|
||
|
|
struct _cef_browser_t* browser);
|
||
|
|
} cef_life_span_handler_t;
|
||
|
|
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif // CEF_INCLUDE_CAPI_CEF_LIFE_SPAN_HANDLER_CAPI_H_
|