• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2012 Marshall A. Greenblatt. All rights reserved.
2 //
3 // Redistribution and use in source and binary forms, with or without
4 // modification, are permitted provided that the following conditions are
5 // met:
6 //
7 //    * Redistributions of source code must retain the above copyright
8 // notice, this list of conditions and the following disclaimer.
9 //    * Redistributions in binary form must reproduce the above
10 // copyright notice, this list of conditions and the following disclaimer
11 // in the documentation and/or other materials provided with the
12 // distribution.
13 //    * Neither the name of Google Inc. nor the name Chromium Embedded
14 // Framework nor the names of its contributors may be used to endorse
15 // or promote products derived from this software without specific prior
16 // written permission.
17 //
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // ---------------------------------------------------------------------------
31 //
32 // The contents of this file must follow a specific format in order to
33 // support the CEF translator tool. See the translator.README.txt file in the
34 // tools directory for more information.
35 //
36 
37 #ifndef CEF_INCLUDE_CEF_BROWSER_PROCESS_HANDLER_H_
38 #define CEF_INCLUDE_CEF_BROWSER_PROCESS_HANDLER_H_
39 #pragma once
40 
41 #include "include/cef_base.h"
42 #include "include/cef_client.h"
43 #include "include/cef_command_line.h"
44 #include "include/cef_values.h"
45 
46 ///
47 // Class used to implement browser process callbacks. The methods of this class
48 // will be called on the browser process main thread unless otherwise indicated.
49 ///
50 /*--cef(source=client,no_debugct_check)--*/
51 class CefBrowserProcessHandler : public virtual CefBaseRefCounted {
52  public:
53   ///
54   // Called on the browser process UI thread immediately after the CEF context
55   // has been initialized.
56   ///
57   /*--cef()--*/
OnContextInitialized()58   virtual void OnContextInitialized() {}
59 
60   ///
61   // Called before a child process is launched. Will be called on the browser
62   // process UI thread when launching a render process and on the browser
63   // process IO thread when launching a GPU or plugin process. Provides an
64   // opportunity to modify the child process command line. Do not keep a
65   // reference to |command_line| outside of this method.
66   ///
67   /*--cef()--*/
OnBeforeChildProcessLaunch(CefRefPtr<CefCommandLine> command_line)68   virtual void OnBeforeChildProcessLaunch(
69       CefRefPtr<CefCommandLine> command_line) {}
70 
71   ///
72   // Called from any thread when work has been scheduled for the browser process
73   // main (UI) thread. This callback is used in combination with CefSettings.
74   // external_message_pump and CefDoMessageLoopWork() in cases where the CEF
75   // message loop must be integrated into an existing application message loop
76   // (see additional comments and warnings on CefDoMessageLoopWork). This
77   // callback should schedule a CefDoMessageLoopWork() call to happen on the
78   // main (UI) thread. |delay_ms| is the requested delay in milliseconds. If
79   // |delay_ms| is <= 0 then the call should happen reasonably soon. If
80   // |delay_ms| is > 0 then the call should be scheduled to happen after the
81   // specified delay and any currently pending scheduled call should be
82   // cancelled.
83   ///
84   /*--cef()--*/
OnScheduleMessagePumpWork(int64 delay_ms)85   virtual void OnScheduleMessagePumpWork(int64 delay_ms) {}
86 
87   ///
88   // Return the default client for use with a newly created browser window. If
89   // null is returned the browser will be unmanaged (no callbacks will be
90   // executed for that browser) and application shutdown will be blocked until
91   // the browser window is closed manually. This method is currently only used
92   // with the chrome runtime.
93   ///
94   /*--cef()--*/
GetDefaultClient()95   virtual CefRefPtr<CefClient> GetDefaultClient() { return nullptr; }
96 };
97 
98 #endif  // CEF_INCLUDE_CEF_BROWSER_PROCESS_HANDLER_H_
99