1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_CREATE_BROWSER_WINDOW_H_
#define CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_CREATE_BROWSER_WINDOW_H_
#include <string>
#include "base/functional/callback.h"
#include "base/memory/raw_ref.h"
#include "build/build_config.h"
#include "chrome/browser/ui/browser_window/public/browser_window_interface.h"
#include "ui/base/mojom/window_show_state.mojom.h"
#include "ui/gfx/geometry/rect.h"
// Parameters used when creating a new browser window.
struct BrowserWindowCreateParams {
BrowserWindowCreateParams(BrowserWindowInterface::Type type,
Profile& profile,
bool from_user_gesture);
BrowserWindowCreateParams(Profile& profile, bool from_user_gesture);
BrowserWindowCreateParams(BrowserWindowCreateParams&&);
BrowserWindowCreateParams(const BrowserWindowCreateParams&) = delete;
BrowserWindowCreateParams& operator=(const BrowserWindowCreateParams&) =
delete;
BrowserWindowCreateParams& operator=(BrowserWindowCreateParams&&);
~BrowserWindowCreateParams();
// The type of browser window to create.
// See BrowserWindowInterface::Type for more details.
BrowserWindowInterface::Type type = BrowserWindowInterface::TYPE_NORMAL;
// Whether the browser was created by a user gesture.
bool from_user_gesture = false;
// The profile to be associated with the browser window.
raw_ref<Profile> profile;
// The initial bounds of the window. If unsupplied, default bounds will be
// used.
gfx::Rect initial_bounds;
// Whether the browser window is displaying only a trusted source, in which
// case some security UI may not be shown.
bool is_trusted_source = false;
// The app name associated with the browser window.
std::string app_name;
// The initial state of the browser window.
ui::mojom::WindowShowState initial_show_state =
ui::mojom::WindowShowState::kDefault;
};
// Creates a new browser window according to the given `create_params`.
//
// This may fail, in which case null is returned.
//
// Otherwise, a `BrowserWindowInterface` will be synchronously returned.
// However, due to OS differences, we can't guarantee the browser window is
// fully initialized. If the browser window isn't fully initialized, calls to
// `BrowserWindowInterface` APIs that will change the window will be queued
// first, then executed once the OS has fully initialized the window. We
// recommend all code calling this function to anticipate this scenario.
//
// If you need to ensure the browser window is fully initialized, please use the
// asynchronous version of this function.
BrowserWindowInterface* CreateBrowserWindow(
BrowserWindowCreateParams create_params);
// The asynchronous version of `CreateBrowserWindow`. The given `callback` will
// always be invoked asynchronously with the newly created
// `BrowserWindowInterface`.
//
// On all platforms, if the `BrowserWindowInterface` passed to the `callback` is
// not null, the `BrowserWindowInterface` has been fully initialized.
void CreateBrowserWindow(
BrowserWindowCreateParams create_params,
base::OnceCallback<void(BrowserWindowInterface*)> callback);
// Returns whether a browser window can currently be created for the specified
// // profile. This condition may change during runtime for a given `profile`
// (e.g. a profile may support Browser windows but creating a Browser is
// disallowed during shutdown).
BrowserWindowInterface::CreationStatus GetBrowserWindowCreationStatusForProfile(
Profile& profile);
#endif // CHROME_BROWSER_UI_BROWSER_WINDOW_PUBLIC_CREATE_BROWSER_WINDOW_H_
|