2014-10-31 12:17:05 -06:00
|
|
|
// Copyright (c) 2013 GitHub, Inc.
|
2014-04-25 03:49:37 -06:00
|
|
|
// Use of this source code is governed by the MIT license that can be
|
2013-05-02 20:53:54 -06:00
|
|
|
// found in the LICENSE file.
|
|
|
|
|
2021-11-22 00:34:31 -07:00
|
|
|
#ifndef ELECTRON_SHELL_BROWSER_BROWSER_OBSERVER_H_
|
|
|
|
#define ELECTRON_SHELL_BROWSER_BROWSER_OBSERVER_H_
|
2013-05-02 20:53:54 -06:00
|
|
|
|
2013-05-30 02:03:10 -06:00
|
|
|
#include <string>
|
|
|
|
|
2018-08-23 03:55:13 -06:00
|
|
|
#include "base/memory/scoped_refptr.h"
|
2018-10-25 00:43:50 -06:00
|
|
|
#include "base/observer_list_types.h"
|
2016-05-04 21:26:23 -06:00
|
|
|
#include "build/build_config.h"
|
2019-06-19 14:46:59 -06:00
|
|
|
#include "shell/browser/login_handler.h"
|
2016-05-04 21:26:23 -06:00
|
|
|
|
2019-06-19 15:23:04 -06:00
|
|
|
namespace electron {
|
2013-05-02 20:53:54 -06:00
|
|
|
|
2018-10-25 00:43:50 -06:00
|
|
|
class BrowserObserver : public base::CheckedObserver {
|
2013-05-02 20:53:54 -06:00
|
|
|
public:
|
2015-02-25 20:33:42 -07:00
|
|
|
// The browser is about to close all windows.
|
|
|
|
virtual void OnBeforeQuit(bool* prevent_default) {}
|
2015-02-25 22:57:25 -07:00
|
|
|
|
2013-05-02 20:53:54 -06:00
|
|
|
// The browser has closed all windows and will quit.
|
|
|
|
virtual void OnWillQuit(bool* prevent_default) {}
|
|
|
|
|
2023-11-12 20:51:56 -07:00
|
|
|
// The browser has closed all windows. If the browser is quitting, then this
|
2013-05-02 20:53:54 -06:00
|
|
|
// method will not be called, instead it will call OnWillQuit.
|
|
|
|
virtual void OnWindowAllClosed() {}
|
|
|
|
|
2014-09-25 07:47:54 -06:00
|
|
|
// The browser is quitting.
|
|
|
|
virtual void OnQuit() {}
|
|
|
|
|
2013-05-30 02:03:10 -06:00
|
|
|
// The browser has opened a file by double clicking in Finder or dragging the
|
2016-06-18 07:26:26 -06:00
|
|
|
// file to the Dock icon. (macOS only)
|
2018-04-17 19:44:10 -06:00
|
|
|
virtual void OnOpenFile(bool* prevent_default, const std::string& file_path) {
|
|
|
|
}
|
2013-05-30 02:03:10 -06:00
|
|
|
|
2013-07-10 02:10:38 -06:00
|
|
|
// Browser is used to open a url.
|
|
|
|
virtual void OnOpenURL(const std::string& url) {}
|
|
|
|
|
2015-09-14 19:34:27 -06:00
|
|
|
// The browser is activated with visible/invisible windows (usually by
|
|
|
|
// clicking on the dock icon).
|
2015-09-14 20:05:53 -06:00
|
|
|
virtual void OnActivate(bool has_visible_windows) {}
|
2015-09-14 05:28:13 -06:00
|
|
|
|
2013-05-30 05:12:14 -06:00
|
|
|
// The browser has finished loading.
|
2013-06-03 01:31:46 -06:00
|
|
|
virtual void OnWillFinishLaunching() {}
|
2022-06-23 00:28:41 -06:00
|
|
|
virtual void OnFinishLaunching(base::Value::Dict launch_info) {}
|
2013-05-30 05:12:14 -06:00
|
|
|
|
2022-06-16 01:46:11 -06:00
|
|
|
// The browser's accessibility support has changed.
|
2016-07-11 15:46:28 -06:00
|
|
|
virtual void OnAccessibilitySupportChanged() {}
|
2016-07-11 15:04:56 -06:00
|
|
|
|
2017-09-15 13:33:12 -06:00
|
|
|
// The app message loop is ready
|
|
|
|
virtual void OnPreMainMessageLoopRun() {}
|
|
|
|
|
2020-04-13 17:39:26 -06:00
|
|
|
// Called just before app threads are created, this is where first access
|
|
|
|
// to in-process GpuDataManager should be made.
|
|
|
|
// Refer https://chromium-review.googlesource.com/c/chromium/src/+/2134864
|
|
|
|
virtual void OnPreCreateThreads() {}
|
|
|
|
|
2022-02-09 19:58:52 -07:00
|
|
|
#if BUILDFLAG(IS_MAC)
|
2017-06-26 13:14:44 -06:00
|
|
|
// The browser wants to report that an user activity will resume. (macOS only)
|
2018-04-17 19:44:10 -06:00
|
|
|
virtual void OnWillContinueUserActivity(bool* prevent_default,
|
|
|
|
const std::string& type) {}
|
2017-06-26 13:14:44 -06:00
|
|
|
// The browser wants to report an user activity resuming error. (macOS only)
|
2018-04-17 19:44:10 -06:00
|
|
|
virtual void OnDidFailToContinueUserActivity(const std::string& type,
|
|
|
|
const std::string& error) {}
|
2016-06-18 07:26:26 -06:00
|
|
|
// The browser wants to resume a user activity via handoff. (macOS only)
|
2018-04-17 19:44:10 -06:00
|
|
|
virtual void OnContinueUserActivity(bool* prevent_default,
|
|
|
|
const std::string& type,
|
2022-06-23 00:28:41 -06:00
|
|
|
base::Value::Dict user_info,
|
|
|
|
base::Value::Dict details) {}
|
2017-06-26 13:14:44 -06:00
|
|
|
// The browser wants to notify that an user activity was resumed. (macOS only)
|
2022-06-23 00:28:41 -06:00
|
|
|
virtual void OnUserActivityWasContinued(const std::string& type,
|
|
|
|
base::Value::Dict user_info) {}
|
2017-06-26 13:14:44 -06:00
|
|
|
// The browser wants to update an user activity payload. (macOS only)
|
2022-06-23 00:28:41 -06:00
|
|
|
virtual void OnUpdateUserActivityState(bool* prevent_default,
|
|
|
|
const std::string& type,
|
|
|
|
base::Value::Dict user_info) {}
|
2017-06-11 02:19:01 -06:00
|
|
|
// User clicked the native macOS new tab button. (macOS only)
|
|
|
|
virtual void OnNewWindowForTab() {}
|
2020-06-16 11:03:41 -06:00
|
|
|
|
2023-04-18 08:53:39 -06:00
|
|
|
// Browser became active.
|
2020-06-16 11:03:41 -06:00
|
|
|
virtual void OnDidBecomeActive() {}
|
2023-04-18 08:53:39 -06:00
|
|
|
// Browser lost active status.
|
|
|
|
virtual void OnDidResignActive() {}
|
2016-05-04 21:26:23 -06:00
|
|
|
#endif
|
2016-04-29 18:36:04 -06:00
|
|
|
|
2013-05-02 20:53:54 -06:00
|
|
|
protected:
|
2018-10-25 00:43:50 -06:00
|
|
|
~BrowserObserver() override {}
|
2013-05-02 20:53:54 -06:00
|
|
|
};
|
|
|
|
|
2019-06-19 15:23:04 -06:00
|
|
|
} // namespace electron
|
2013-05-02 20:53:54 -06:00
|
|
|
|
2021-11-22 00:34:31 -07:00
|
|
|
#endif // ELECTRON_SHELL_BROWSER_BROWSER_OBSERVER_H_
|