blob: 12119148fe07635e44d60e20399c6e1a46cac5e1 [file] [log] [blame]
// Copyright 2014 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.
#include "base/macros.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "content/public/browser/web_contents_observer.h"
#include "ui/events/event_observer.h"
#include "ui/views/bubble/bubble_dialog_delegate_view.h"
#include "ui/views/event_monitor.h"
namespace content {
class NotificationDetails;
class NotificationSource;
class WebContents;
} // namespace content
// Base class for bubbles that are shown from location bar icons. The bubble
// will automatically close when the browser transitions in or out of fullscreen
// mode.
// TODO( Move to chrome/browser/ui/views/page_action/.
class LocationBarBubbleDelegateView : public views::BubbleDialogDelegateView,
public content::NotificationObserver,
public content::WebContentsObserver {
enum DisplayReason {
// The bubble appears as a direct result of a user action (clicking on the
// location bar icon).
// The bubble appears spontaneously over the course of the user's
// interaction with Chrome (e.g. due to some change in the feature's
// status).
// Constructs LocationBarBubbleDelegateView. Anchors the bubble to
// |anchor_view| when it is not nullptr or alternatively, to |anchor_point|.
// Registers with a fullscreen controller identified by |web_contents| to
// close the bubble if the fullscreen state changes.
LocationBarBubbleDelegateView(views::View* anchor_view,
const gfx::Point& anchor_point,
content::WebContents* web_contents);
~LocationBarBubbleDelegateView() override;
// Displays the bubble with appearance and behavior tailored for |reason|.
// If |allow_refocus_alert| is set to true (default), inactive bubbles will
// have an additional screen reader alert instructing the user to use a
// hotkey combination to focus the bubble; if it's set to false, no additional
// alert is provided (use false for transient bubbles to avoid confusing the
// user).
void ShowForReason(DisplayReason reason, bool allow_refocus_alert = true);
// content::NotificationObserver:
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
// content::WebContentsObserver:
void OnVisibilityChanged(content::Visibility visibility) override;
void WebContentsDestroyed() override;
// views::BubbleDialogDelegateView:
gfx::Rect GetAnchorBoundsInScreen() const override;
// If the bubble is not anchored to a view, places the bubble in the top right
// (left in RTL) of the |screen_bounds| that contain web contents's browser
// window. Because the positioning is based on the size of the bubble, this
// must be called after the bubble is created.
void AdjustForFullscreen(const gfx::Rect& screen_bounds);
// The class listens for WebContentsView events and closes the bubble. Useful
// for bubbles that do not start out focused but need to close when the user
// interacts with the web view.
class WebContentMouseHandler : public ui::EventObserver {
WebContentMouseHandler(LocationBarBubbleDelegateView* bubble,
content::WebContents* web_contents);
~WebContentMouseHandler() override;
// ui::EventObserver:
void OnEvent(const ui::Event& event) override;
LocationBarBubbleDelegateView* bubble_;
content::WebContents* web_contents_;
std::unique_ptr<views::EventMonitor> event_monitor_;
// Closes the bubble.
virtual void CloseBubble();
// Used to register for fullscreen change notifications.
content::NotificationRegistrar registrar_;