blob: 15246f8f60b3c254393bf5b3198d70fef8679407 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_FRAME_H_
#define CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_FRAME_H_
#include "base/compiler_specific.h"
#include "base/logging.h"
#include "base/macros.h"
#include "base/scoped_observer.h"
#include "build/build_config.h"
#include "chrome/browser/ui/views/frame/browser_non_client_frame_view.h"
#include "content/public/browser/keyboard_event_processing_result.h"
#include "ui/base/material_design/material_design_controller.h"
#include "ui/base/material_design/material_design_controller_observer.h"
#include "ui/views/context_menu_controller.h"
#include "ui/views/widget/widget.h"
class BrowserRootView;
class BrowserView;
class NativeBrowserFrame;
class NonClientFrameView;
class SystemMenuModelBuilder;
namespace content {
struct NativeWebKeyboardEvent;
}
namespace gfx {
class Rect;
}
namespace ui {
class EventHandler;
class MenuModel;
}
namespace views {
class MenuRunner;
class View;
}
// This is a virtual interface that allows system specific browser frames.
class BrowserFrame : public views::Widget,
public views::ContextMenuController,
public ui::MaterialDesignControllerObserver {
public:
explicit BrowserFrame(BrowserView* browser_view);
~BrowserFrame() override;
// Initialize the frame (creates the underlying native window).
void InitBrowserFrame();
// Determine the distance of the left edge of the minimize button from the
// left edge of the window. Used in our Non-Client View's Layout.
int GetMinimizeButtonOffset() const;
// Retrieves the bounds, in non-client view coordinates for the specified
// TabStrip view.
gfx::Rect GetBoundsForTabStrip(const views::View* tabstrip) const;
// Returns the inset of the topmost view in the client view from the top of
// the non-client view. The topmost view depends on the window type. The
// topmost view is the tab strip for tabbed browser windows, the toolbar for
// popups, the web contents for app windows and varies for fullscreen windows.
int GetTopInset() const;
// Returns the amount that the theme background should be inset.
int GetThemeBackgroundXInset() const;
// Tells the frame to update the throbber.
void UpdateThrobber(bool running);
// Returns the NonClientFrameView of this frame.
BrowserNonClientFrameView* GetFrameView() const;
// Returns |true| if we should use the custom frame.
bool UseCustomFrame() const;
// Returns true when the window placement should be saved.
bool ShouldSaveWindowPlacement() const;
// Retrieves the window placement (show state and bounds) for restoring.
void GetWindowPlacement(gfx::Rect* bounds,
ui::WindowShowState* show_state) const;
// Returns HANDLED if the |event| was handled by the platform implementation
// before sending it to the renderer. E.g., it may be swallowed by a native
// menu bar. Returns NOT_HANDLED_IS_SHORTCUT if the event was not handled, but
// would be handled as a shortcut if the renderer chooses not to handle it.
// Otherwise returns NOT_HANDLED.
content::KeyboardEventProcessingResult PreHandleKeyboardEvent(
const content::NativeWebKeyboardEvent& event);
// Returns true if the |event| was handled by the platform implementation,
// if the renderer did not process it.
bool HandleKeyboardEvent(const content::NativeWebKeyboardEvent& event);
// Called when BrowserView creates all it's child views.
void OnBrowserViewInitViewsComplete();
// views::Widget:
views::internal::RootView* CreateRootView() override;
views::NonClientFrameView* CreateNonClientFrameView() override;
bool GetAccelerator(int command_id,
ui::Accelerator* accelerator) const override;
const ui::ThemeProvider* GetThemeProvider() const override;
const ui::NativeTheme* GetNativeTheme() const override;
void OnNativeWidgetWorkspaceChanged() override;
void OnNativeThemeUpdated(ui::NativeTheme* observed_theme) override;
// views::ContextMenuController:
void ShowContextMenuForView(views::View* source,
const gfx::Point& p,
ui::MenuSourceType source_type) override;
// Returns the menu model. BrowserFrame owns the returned model.
// Note that in multi user mode this will upon each call create a new model.
ui::MenuModel* GetSystemMenuModel();
NativeBrowserFrame* native_browser_frame() const {
return native_browser_frame_;
}
protected:
// ui::MaterialDesignControllerObserver:
void OnTouchUiChanged() override;
private:
// Callback for MenuRunner.
void OnMenuClosed();
NativeBrowserFrame* native_browser_frame_;
// A weak reference to the root view associated with the window. We save a
// copy as a BrowserRootView to avoid evil casting later, when we need to call
// functions that only exist on BrowserRootView (versus RootView).
BrowserRootView* root_view_;
// A pointer to our NonClientFrameView as a BrowserNonClientFrameView.
BrowserNonClientFrameView* browser_frame_view_;
// The BrowserView is our ClientView. This is a pointer to it.
BrowserView* browser_view_;
std::unique_ptr<SystemMenuModelBuilder> menu_model_builder_;
// Used to show the system menu. Only used if
// NativeBrowserFrame::UsesNativeSystemMenu() returns false.
std::unique_ptr<views::MenuRunner> menu_runner_;
std::unique_ptr<ui::EventHandler> browser_command_handler_;
ScopedObserver<ui::MaterialDesignController,
ui::MaterialDesignControllerObserver>
md_observer_{this};
DISALLOW_COPY_AND_ASSIGN(BrowserFrame);
};
#endif // CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_FRAME_H_