4848class CefApp ;
4949
5050// /
51- // This function should be called from the application entry point function to
52- // execute a secondary process. It can be used to run secondary processes from
53- // the browser client executable (default behavior) or from a separate
54- // executable specified by the CefSettings .browser_subprocess_path value. If
55- // called for the browser process (identified by no "type" command-line value)
56- // it will return immediately with a value of -1. If called for a recognized
57- // secondary process it will block until the process should exit and then return
58- // the process exit code. The |application| parameter may be empty. The
59- // |windows_sandbox_info| parameter is only used on Windows and may be NULL (see
60- // cef_sandbox_win.h for details).
51+ // / This function should be called from the application entry point function to
52+ // / execute a secondary process. It can be used to run secondary processes from
53+ // / the browser client executable (default behavior) or from a separate
54+ // / executable specified by the cef_settings_t .browser_subprocess_path value. If
55+ // / called for the browser process (identified by no "type" command-line value)
56+ // / it will return immediately with a value of -1. If called for a recognized
57+ // / secondary process it will block until the process should exit and then
58+ // / return the process exit code. The |application| parameter may be empty. The
59+ // / |windows_sandbox_info| parameter is only used on Windows and may be NULL
60+ // / (see cef_sandbox_win.h for details).
6161// /
6262/* --cef(api_hash_check,optional_param=application,
6363 optional_param=windows_sandbox_info)--*/
@@ -66,11 +66,11 @@ int CefExecuteProcess(const CefMainArgs& args,
6666 void * windows_sandbox_info);
6767
6868// /
69- // This function should be called on the main application thread to initialize
70- // the CEF browser process. The |application| parameter may be empty. A return
71- // value of true indicates that it succeeded and false indicates that it failed.
72- // The |windows_sandbox_info| parameter is only used on Windows and may be NULL
73- // (see cef_sandbox_win.h for details).
69+ // / This function should be called on the main application thread to initialize
70+ // / the CEF browser process. The |application| parameter may be empty. A return
71+ // / value of true indicates that it succeeded and false indicates that it
72+ // / failed. The |windows_sandbox_info| parameter is only used on Windows and may
73+ // / be NULL (see cef_sandbox_win.h for details).
7474// /
7575/* --cef(api_hash_check,optional_param=application,
7676 optional_param=windows_sandbox_info)--*/
@@ -80,119 +80,121 @@ bool CefInitialize(const CefMainArgs& args,
8080 void * windows_sandbox_info);
8181
8282// /
83- // This function should be called on the main application thread to shut down
84- // the CEF browser process before the application exits.
83+ // / This function should be called on the main application thread to shut down
84+ // / the CEF browser process before the application exits.
8585// /
8686/* --cef()--*/
8787void CefShutdown ();
8888
8989// /
90- // Perform a single iteration of CEF message loop processing. This function is
91- // provided for cases where the CEF message loop must be integrated into an
92- // existing application message loop. Use of this function is not recommended
93- // for most users; use either the CefRunMessageLoop() function or
94- // CefSettings.multi_threaded_message_loop if possible. When using this function
95- // care must be taken to balance performance against excessive CPU usage. It is
96- // recommended to enable the CefSettings.external_message_pump option when using
97- // this function so that CefBrowserProcessHandler::OnScheduleMessagePumpWork()
98- // callbacks can facilitate the scheduling process. This function should only be
99- // called on the main application thread and only if CefInitialize() is called
100- // with a CefSettings.multi_threaded_message_loop value of false. This function
101- // will not block.
90+ // / Perform a single iteration of CEF message loop processing. This function is
91+ // / provided for cases where the CEF message loop must be integrated into an
92+ // / existing application message loop. Use of this function is not recommended
93+ // / for most users; use either the CefRunMessageLoop() function or
94+ // / cef_settings_t.multi_threaded_message_loop if possible. When using this
95+ // / function care must be taken to balance performance against excessive CPU
96+ // / usage. It is recommended to enable the cef_settings_t.external_message_pump
97+ // / option when using this function so that
98+ // / CefBrowserProcessHandler::OnScheduleMessagePumpWork() callbacks can
99+ // / facilitate the scheduling process. This function should only be called on
100+ // / the main application thread and only if CefInitialize() is called with a
101+ // / cef_settings_t.multi_threaded_message_loop value of false. This function
102+ // / will not block.
102103// /
103104/* --cef()--*/
104105void CefDoMessageLoopWork ();
105106
106107// /
107- // Run the CEF message loop. Use this function instead of an application-
108- // provided message loop to get the best balance between performance and CPU
109- // usage. This function should only be called on the main application thread and
110- // only if CefInitialize() is called with a
111- // CefSettings .multi_threaded_message_loop value of false. This function will
112- // block until a quit message is received by the system.
108+ // / Run the CEF message loop. Use this function instead of an application-
109+ // / provided message loop to get the best balance between performance and CPU
110+ // / usage. This function should only be called on the main application thread
111+ // / and only if CefInitialize() is called with a
112+ // / cef_settings_t .multi_threaded_message_loop value of false. This function
113+ // / will block until a quit message is received by the system.
113114// /
114115/* --cef()--*/
115116void CefRunMessageLoop ();
116117
117118// /
118- // Quit the CEF message loop that was started by calling CefRunMessageLoop().
119- // This function should only be called on the main application thread and only
120- // if CefRunMessageLoop() was used.
119+ // / Quit the CEF message loop that was started by calling CefRunMessageLoop().
120+ // / This function should only be called on the main application thread and only
121+ // / if CefRunMessageLoop() was used.
121122// /
122123/* --cef()--*/
123124void CefQuitMessageLoop ();
124125
125126// /
126- // Set to true before calling Windows APIs like TrackPopupMenu that enter a
127- // modal message loop. Set to false after exiting the modal message loop.
127+ // / Set to true before calling Windows APIs like TrackPopupMenu that enter a
128+ // / modal message loop. Set to false after exiting the modal message loop.
128129// /
129130/* --cef()--*/
130131void CefSetOSModalLoop (bool osModalLoop);
131132
132133// /
133- // Call during process startup to enable High-DPI support on Windows 7 or newer.
134- // Older versions of Windows should be left DPI-unaware because they do not
135- // support DirectWrite and GDI fonts are kerned very badly.
134+ // / Call during process startup to enable High-DPI support on Windows 7 or
135+ // / newer. Older versions of Windows should be left DPI-unaware because they do
136+ // / not support DirectWrite and GDI fonts are kerned very badly.
136137// /
137138/* --cef(capi_name=cef_enable_highdpi_support)--*/
138139void CefEnableHighDPISupport ();
139140
140141// /
141- // Implement this interface to provide handler implementations. Methods will be
142- // called by the process and/or thread indicated.
142+ // / Implement this interface to provide handler implementations. Methods will be
143+ // / called by the process and/or thread indicated.
143144// /
144145/* --cef(source=client,no_debugct_check)--*/
145146class CefApp : public virtual CefBaseRefCounted {
146147 public:
147148 // /
148- // Provides an opportunity to view and/or modify command-line arguments before
149- // processing by CEF and Chromium. The |process_type| value will be empty for
150- // the browser process. Do not keep a reference to the CefCommandLine object
151- // passed to this method. The CefSettings.command_line_args_disabled value
152- // can be used to start with an empty command-line object. Any values
153- // specified in CefSettings that equate to command-line arguments will be set
154- // before this method is called. Be cautious when using this method to modify
155- // command-line arguments for non-browser processes as this may result in
156- // undefined behavior including crashes.
149+ // / Provides an opportunity to view and/or modify command-line arguments
150+ // / before processing by CEF and Chromium. The |process_type| value will be
151+ // / empty for the browser process. Do not keep a reference to the
152+ // / CefCommandLine object passed to this method. The
153+ // / cef_settings_t.command_line_args_disabled value can be used to start with
154+ // / an empty command-line object. Any values specified in CefSettings that
155+ // / equate to command-line arguments will be set before this method is called.
156+ // / Be cautious when using this method to modify command-line arguments for
157+ // / non-browser processes as this may result in undefined behavior including
158+ // / crashes.
157159 // /
158160 /* --cef(optional_param=process_type)--*/
159161 virtual void OnBeforeCommandLineProcessing (
160162 const CefString& process_type,
161163 CefRefPtr<CefCommandLine> command_line) {}
162164
163165 // /
164- // Provides an opportunity to register custom schemes. Do not keep a reference
165- // to the |registrar| object. This method is called on the main thread for
166- // each process and the registered schemes should be the same across all
167- // processes.
166+ // / Provides an opportunity to register custom schemes. Do not keep a
167+ // / reference to the |registrar| object. This method is called on the main
168+ // / thread for each process and the registered schemes should be the same
169+ // / across all processes.
168170 // /
169171 /* --cef()--*/
170172 virtual void OnRegisterCustomSchemes (
171173 CefRawPtr<CefSchemeRegistrar> registrar) {}
172174
173175 // /
174- // Return the handler for resource bundle events. If
175- // CefSettings .pack_loading_disabled is true a handler must be returned. If no
176- // handler is returned resources will be loaded from pack files. This method
177- // is called by the browser and render processes on multiple threads.
176+ // / Return the handler for resource bundle events. If
177+ // / cef_settings_t .pack_loading_disabled is true a handler must be returned.
178+ // / If no handler is returned resources will be loaded from pack files. This
179+ // / method is called by the browser and render processes on multiple threads.
178180 // /
179181 /* --cef()--*/
180182 virtual CefRefPtr<CefResourceBundleHandler> GetResourceBundleHandler () {
181183 return nullptr ;
182184 }
183185
184186 // /
185- // Return the handler for functionality specific to the browser process. This
186- // method is called on multiple threads in the browser process.
187+ // / Return the handler for functionality specific to the browser process. This
188+ // / method is called on multiple threads in the browser process.
187189 // /
188190 /* --cef()--*/
189191 virtual CefRefPtr<CefBrowserProcessHandler> GetBrowserProcessHandler () {
190192 return nullptr ;
191193 }
192194
193195 // /
194- // Return the handler for functionality specific to the render process. This
195- // method is called on the render process main thread.
196+ // / Return the handler for functionality specific to the render process. This
197+ // / method is called on the render process main thread.
196198 // /
197199 /* --cef()--*/
198200 virtual CefRefPtr<CefRenderProcessHandler> GetRenderProcessHandler () {
0 commit comments