browser_view.h revision 8bcbed890bc3ce4d7a057a8f32cab53fa534672e
1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_VIEW_H_
6#define CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_VIEW_H_
7
8#include <map>
9#include <string>
10#include <vector>
11
12#include "base/compiler_specific.h"
13#include "base/memory/scoped_ptr.h"
14#include "base/timer/timer.h"
15#include "build/build_config.h"
16#include "chrome/browser/devtools/devtools_window.h"
17#include "chrome/browser/infobars/infobar_container.h"
18#include "chrome/browser/ui/browser.h"
19#include "chrome/browser/ui/browser_window.h"
20#include "chrome/browser/ui/omnibox/omnibox_popup_model_observer.h"
21#include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
22#include "chrome/browser/ui/views/frame/browser_frame.h"
23#include "chrome/browser/ui/views/frame/immersive_mode_controller.h"
24#include "chrome/browser/ui/views/frame/scroll_end_effect_controller.h"
25#include "chrome/browser/ui/views/load_complete_listener.h"
26#include "ui/base/accelerators/accelerator.h"
27#include "ui/base/models/simple_menu_model.h"
28#include "ui/gfx/native_widget_types.h"
29#include "ui/gfx/sys_color_change_listener.h"
30#include "ui/views/controls/button/button.h"
31#include "ui/views/controls/single_split_view_listener.h"
32#include "ui/views/controls/webview/unhandled_keyboard_event_handler.h"
33#include "ui/views/widget/widget_delegate.h"
34#include "ui/views/widget/widget_observer.h"
35#include "ui/views/window/client_view.h"
36
37#if defined(OS_WIN)
38#include "chrome/browser/hang_monitor/hung_plugin_action.h"
39#include "chrome/browser/hang_monitor/hung_window_detector.h"
40#endif
41
42// NOTE: For more information about the objects and files in this directory,
43// view: http://dev.chromium.org/developers/design-documents/browser-window
44
45class BookmarkBarView;
46class Browser;
47class BrowserViewLayout;
48class ContentsContainer;
49class DownloadShelfView;
50class FullscreenExitBubbleViews;
51class InfoBarContainerView;
52class LocationBarView;
53class StatusBubbleViews;
54class SearchViewController;
55class TabStrip;
56class TabStripModel;
57class ToolbarView;
58class TopContainerView;
59
60#if defined(OS_WIN)
61class JumpList;
62#endif
63
64namespace autofill {
65class PasswordGenerator;
66}
67
68namespace content {
69class RenderWidgetHost;
70}
71
72namespace extensions {
73class Extension;
74}
75
76namespace views {
77class AccessiblePaneView;
78class ExternalFocusTracker;
79class WebView;
80}
81
82///////////////////////////////////////////////////////////////////////////////
83// BrowserView
84//
85//  A ClientView subclass that provides the contents of a browser window,
86//  including the TabStrip, toolbars, download shelves, the content area etc.
87//
88class BrowserView : public BrowserWindow,
89                    public BrowserWindowTesting,
90                    public TabStripModelObserver,
91                    public ui::AcceleratorProvider,
92                    public views::WidgetDelegate,
93                    public views::WidgetObserver,
94                    public views::ClientView,
95                    public ImmersiveModeController::Delegate,
96                    public InfoBarContainer::Delegate,
97                    public views::SingleSplitViewListener,
98                    public gfx::SysColorChangeListener,
99                    public LoadCompleteListener::Delegate,
100                    public OmniboxPopupModelObserver {
101 public:
102  // The browser view's class name.
103  static const char kViewClassName[];
104
105  BrowserView();
106  virtual ~BrowserView();
107
108  // Takes ownership of |browser|.
109  void Init(Browser* browser);
110
111  void set_frame(BrowserFrame* frame) { frame_ = frame; }
112  BrowserFrame* frame() const { return frame_; }
113
114  // Returns a pointer to the BrowserView* interface implementation (an
115  // instance of this object, typically) for a given native window, or NULL if
116  // there is no such association.
117  //
118  // Don't use this unless you only have a NativeWindow. In nearly all
119  // situations plumb through browser and use it.
120  static BrowserView* GetBrowserViewForNativeWindow(gfx::NativeWindow window);
121
122  // Returns the BrowserView used for the specified Browser.
123  static BrowserView* GetBrowserViewForBrowser(const Browser* browser);
124
125  // Returns a Browser instance of this view.
126  Browser* browser() { return browser_.get(); }
127
128  // Initializes (or re-initializes) the status bubble.  We try to only create
129  // the bubble once and re-use it for the life of the browser, but certain
130  // events (such as changing enabling/disabling Aero on Win) can force a need
131  // to change some of the bubble's creation parameters.
132  void InitStatusBubble();
133
134  // Returns the apparent bounds of the toolbar, in BrowserView coordinates.
135  // These differ from |toolbar_.bounds()| in that they match where the toolbar
136  // background image is drawn -- slightly outside the "true" bounds
137  // horizontally. Note that this returns the bounds for the toolbar area.
138  gfx::Rect GetToolbarBounds() const;
139
140  // Returns the bounds of the content area, in the coordinates of the
141  // BrowserView's parent.
142  gfx::Rect GetClientAreaBounds() const;
143
144  // Returns the constraining bounding box that should be used to lay out the
145  // FindBar within. This is _not_ the size of the find bar, just the bounding
146  // box it should be laid out within. The coordinate system of the returned
147  // rect is in the coordinate system of the frame, since the FindBar is a child
148  // window.
149  gfx::Rect GetFindBarBoundingBox() const;
150
151  // Returns the preferred height of the TabStrip. Used to position the OTR
152  // avatar icon.
153  int GetTabStripHeight() const;
154
155  // Takes some view's origin (relative to this BrowserView) and offsets it such
156  // that it can be used as the source origin for seamlessly tiling the toolbar
157  // background image over that view.
158  gfx::Point OffsetPointForToolbarBackgroundImage(
159      const gfx::Point& point) const;
160
161  // Container for the tabstrip, toolbar, etc.
162  TopContainerView* top_container() { return top_container_; }
163
164  // Accessor for the TabStrip.
165  TabStrip* tabstrip() { return tabstrip_; }
166
167  // Accessor for the Toolbar.
168  ToolbarView* toolbar() { return toolbar_; }
169
170  // Bookmark bar may be NULL, for example for pop-ups.
171  BookmarkBarView* bookmark_bar() { return bookmark_bar_view_.get(); }
172
173  // Returns the do-nothing view which controls the z-order of the find bar
174  // widget relative to views which paint into layers and views which have an
175  // associated NativeView. The presence / visibility of this view is not
176  // indicative of the visibility of the find bar widget or even whether
177  // FindBarController is initialized.
178  View* find_bar_host_view() { return find_bar_host_view_; }
179
180  // Accessor for the InfobarContainer.
181  InfoBarContainerView* infobar_container() { return infobar_container_; }
182
183  // Accessor for the FullscreenExitBubbleViews.
184  FullscreenExitBubbleViews* fullscreen_exit_bubble() {
185    return fullscreen_bubble_.get();
186  }
187
188  // Returns true if various window components are visible.
189  bool IsTabStripVisible() const;
190
191  // Returns true if the profile associated with this Browser window is
192  // incognito.
193  bool IsOffTheRecord() const;
194
195  // Returns true if the profile associated with this Browser window is
196  // a guest session.
197  bool IsGuestSession() const;
198
199  // Returns true if the profile associated with this Browser window is
200  // not off the record or a guest session.
201  bool IsRegularOrGuestSession() const;
202
203  // Returns the resource ID to use for the OTR icon, which depends on
204  // which layout is being shown and whether we are full-screen.
205  int GetOTRIconResourceID() const;
206
207  // Returns the resource ID to use for the Guest icon, which may depend on
208  // which layout is being shown and whether we are full-screen.
209  int GetGuestIconResourceID() const;
210
211  // Returns true if the non-client view should render an avatar icon.
212  bool ShouldShowAvatar() const;
213
214  // Provides the containing frame with the accelerator for the specified
215  // command id. This can be used to provide menu item shortcut hints etc.
216  // Returns true if an accelerator was found for the specified |cmd_id|, false
217  // otherwise.
218  bool GetAccelerator(int cmd_id, ui::Accelerator* accelerator);
219
220  // Returns true if the specificed |accelerator| is registered with this view.
221  bool IsAcceleratorRegistered(const ui::Accelerator& accelerator);
222
223  // Returns the active WebContents. Used by our NonClientView's
224  // TabIconView::TabContentsProvider implementations.
225  // TODO(beng): exposing this here is a bit bogus, since it's only used to
226  // determine loading state. It'd be nicer if we could change this to be
227  // bool IsSelectedTabLoading() const; or something like that. We could even
228  // move it to a WindowDelegate subclass.
229  content::WebContents* GetActiveWebContents() const;
230
231  // Retrieves the icon to use in the frame to indicate an OTR window.
232  gfx::ImageSkia GetOTRAvatarIcon() const;
233
234  // Returns true if the Browser object associated with this BrowserView is a
235  // tabbed-type window (i.e. a browser window, not an app or popup).
236  bool IsBrowserTypeNormal() const {
237    return browser_->is_type_tabbed();
238  }
239
240  // See ImmersiveModeController for description.
241  ImmersiveModeController* immersive_mode_controller() const {
242    return immersive_mode_controller_.get();
243  }
244
245  // Restores the focused view. This is also used to set the initial focus
246  // when a new browser window is created.
247  void RestoreFocus();
248
249  void SetWindowSwitcherButton(views::Button* button);
250
251  views::Button* window_switcher_button() {
252    return window_switcher_button_;
253  }
254
255  // Called from BookmarkBarView/DownloadShelfView during their show/hide
256  // animations.
257  void ToolbarSizeChanged(bool is_animating);
258
259  // Overridden from BrowserWindow:
260  virtual void Show() OVERRIDE;
261  virtual void ShowInactive() OVERRIDE;
262  virtual void Hide() OVERRIDE;
263  virtual void SetBounds(const gfx::Rect& bounds) OVERRIDE;
264  virtual void Close() OVERRIDE;
265  virtual void Activate() OVERRIDE;
266  virtual void Deactivate() OVERRIDE;
267  virtual bool IsActive() const OVERRIDE;
268  virtual void FlashFrame(bool flash) OVERRIDE;
269  virtual bool IsAlwaysOnTop() const OVERRIDE;
270  virtual void SetAlwaysOnTop(bool always_on_top) OVERRIDE;
271  virtual gfx::NativeWindow GetNativeWindow() OVERRIDE;
272  virtual BrowserWindowTesting* GetBrowserWindowTesting() OVERRIDE;
273  virtual StatusBubble* GetStatusBubble() OVERRIDE;
274  virtual void UpdateTitleBar() OVERRIDE;
275  virtual void BookmarkBarStateChanged(
276      BookmarkBar::AnimateChangeType change_type) OVERRIDE;
277  virtual void UpdateDevTools() OVERRIDE;
278  virtual void UpdateLoadingAnimations(bool should_animate) OVERRIDE;
279  virtual void SetStarredState(bool is_starred) OVERRIDE;
280  virtual void OnActiveTabChanged(content::WebContents* old_contents,
281                                  content::WebContents* new_contents,
282                                  int index,
283                                  int reason) OVERRIDE;
284  virtual void ZoomChangedForActiveTab(bool can_show_bubble) OVERRIDE;
285  virtual gfx::Rect GetRestoredBounds() const OVERRIDE;
286  virtual ui::WindowShowState GetRestoredState() const OVERRIDE;
287  virtual gfx::Rect GetBounds() const OVERRIDE;
288  virtual bool IsMaximized() const OVERRIDE;
289  virtual bool IsMinimized() const OVERRIDE;
290  virtual void Maximize() OVERRIDE;
291  virtual void Minimize() OVERRIDE;
292  virtual void Restore() OVERRIDE;
293  virtual void EnterFullscreen(
294      const GURL& url, FullscreenExitBubbleType bubble_type) OVERRIDE;
295  virtual void ExitFullscreen() OVERRIDE;
296  virtual void UpdateFullscreenExitBubbleContent(
297      const GURL& url,
298      FullscreenExitBubbleType bubble_type) OVERRIDE;
299  virtual bool ShouldHideUIForFullscreen() const OVERRIDE;
300  virtual bool IsFullscreen() const OVERRIDE;
301  virtual bool IsFullscreenBubbleVisible() const OVERRIDE;
302#if defined(OS_WIN)
303  virtual void SetMetroSnapMode(bool enable) OVERRIDE;
304  virtual bool IsInMetroSnapMode() const OVERRIDE;
305#endif
306  virtual LocationBar* GetLocationBar() const OVERRIDE;
307  virtual void SetFocusToLocationBar(bool select_all) OVERRIDE;
308  virtual void UpdateReloadStopState(bool is_loading, bool force) OVERRIDE;
309  virtual void UpdateToolbar(content::WebContents* contents) OVERRIDE;
310  virtual void FocusToolbar() OVERRIDE;
311  virtual void FocusAppMenu() OVERRIDE;
312  virtual void FocusBookmarksToolbar() OVERRIDE;
313  virtual void FocusInfobars() OVERRIDE;
314  virtual void RotatePaneFocus(bool forwards) OVERRIDE;
315  virtual void DestroyBrowser() OVERRIDE;
316  virtual bool IsBookmarkBarVisible() const OVERRIDE;
317  virtual bool IsBookmarkBarAnimating() const OVERRIDE;
318  virtual bool IsTabStripEditable() const OVERRIDE;
319  virtual bool IsToolbarVisible() const OVERRIDE;
320  virtual gfx::Rect GetRootWindowResizerRect() const OVERRIDE;
321  virtual void DisableInactiveFrame() OVERRIDE;
322  virtual void ConfirmAddSearchProvider(TemplateURL* template_url,
323                                        Profile* profile) OVERRIDE;
324  virtual void ShowUpdateChromeDialog() OVERRIDE;
325  virtual void ShowBookmarkBubble(const GURL& url,
326                                  bool already_bookmarked) OVERRIDE;
327  virtual void ShowBookmarkPrompt() OVERRIDE;
328#if defined(ENABLE_ONE_CLICK_SIGNIN)
329  virtual void ShowOneClickSigninBubble(
330      OneClickSigninBubbleType type,
331      const string16& email,
332      const string16& error_message,
333      const StartSyncCallback& start_sync_callback) OVERRIDE;
334#endif
335  // TODO(beng): Not an override, move somewhere else.
336  void SetDownloadShelfVisible(bool visible);
337  virtual bool IsDownloadShelfVisible() const OVERRIDE;
338  virtual DownloadShelf* GetDownloadShelf() OVERRIDE;
339  virtual void ConfirmBrowserCloseWithPendingDownloads(
340      int download_count,
341      Browser::DownloadClosePreventionType dialog_type,
342      bool app_modal,
343      const base::Callback<void(bool)>& callback) OVERRIDE;
344  virtual void UserChangedTheme() OVERRIDE;
345  virtual int GetExtraRenderViewHeight() const OVERRIDE;
346  virtual void WebContentsFocused(content::WebContents* contents) OVERRIDE;
347  virtual void ShowWebsiteSettings(Profile* profile,
348                                   content::WebContents* web_contents,
349                                   const GURL& url,
350                                   const content::SSLStatus& ssl) OVERRIDE;
351  virtual void ShowAppMenu() OVERRIDE;
352  virtual bool PreHandleKeyboardEvent(
353      const content::NativeWebKeyboardEvent& event,
354      bool* is_keyboard_shortcut) OVERRIDE;
355  virtual void HandleKeyboardEvent(
356      const content::NativeWebKeyboardEvent& event) OVERRIDE;
357  virtual void Cut() OVERRIDE;
358  virtual void Copy() OVERRIDE;
359  virtual void Paste() OVERRIDE;
360  virtual WindowOpenDisposition GetDispositionForPopupBounds(
361      const gfx::Rect& bounds) OVERRIDE;
362  virtual FindBar* CreateFindBar() OVERRIDE;
363  virtual web_modal::WebContentsModalDialogHost*
364      GetWebContentsModalDialogHost() OVERRIDE;
365  virtual void ShowAvatarBubble(content::WebContents* web_contents,
366                                const gfx::Rect& rect) OVERRIDE;
367  virtual void ShowAvatarBubbleFromAvatarButton() OVERRIDE;
368  virtual void ShowPasswordGenerationBubble(
369      const gfx::Rect& rect,
370      const autofill::PasswordForm& form,
371      autofill::PasswordGenerator* password_generator) OVERRIDE;
372  virtual void OverscrollUpdate(int delta_y) OVERRIDE;
373  virtual int GetRenderViewHeightInsetWithDetachedBookmarkBar() OVERRIDE;
374
375  // Overridden from BrowserWindowTesting:
376  virtual BookmarkBarView* GetBookmarkBarView() const OVERRIDE;
377  virtual LocationBarView* GetLocationBarView() const OVERRIDE;
378  virtual views::View* GetTabContentsContainerView() const OVERRIDE;
379  virtual ToolbarView* GetToolbarView() const OVERRIDE;
380
381  // Overridden from TabStripModelObserver:
382  virtual void TabDetachedAt(content::WebContents* contents,
383                             int index) OVERRIDE;
384  virtual void TabDeactivated(content::WebContents* contents) OVERRIDE;
385  virtual void TabStripEmpty() OVERRIDE;
386
387  // Overridden from ui::AcceleratorProvider:
388  virtual bool GetAcceleratorForCommandId(int command_id,
389      ui::Accelerator* accelerator) OVERRIDE;
390
391  // Overridden from views::WidgetDelegate:
392  virtual bool CanResize() const OVERRIDE;
393  virtual bool CanMaximize() const OVERRIDE;
394  virtual bool CanActivate() const OVERRIDE;
395  virtual string16 GetWindowTitle() const OVERRIDE;
396  virtual string16 GetAccessibleWindowTitle() const OVERRIDE;
397  virtual views::View* GetInitiallyFocusedView() OVERRIDE;
398  virtual bool ShouldShowWindowTitle() const OVERRIDE;
399  virtual gfx::ImageSkia GetWindowAppIcon() OVERRIDE;
400  virtual gfx::ImageSkia GetWindowIcon() OVERRIDE;
401  virtual bool ShouldShowWindowIcon() const OVERRIDE;
402  virtual bool ExecuteWindowsCommand(int command_id) OVERRIDE;
403  virtual std::string GetWindowName() const OVERRIDE;
404  virtual void SaveWindowPlacement(const gfx::Rect& bounds,
405                                   ui::WindowShowState show_state) OVERRIDE;
406  virtual bool GetSavedWindowPlacement(
407      gfx::Rect* bounds,
408      ui::WindowShowState* show_state) const OVERRIDE;
409  virtual views::View* GetContentsView() OVERRIDE;
410  virtual views::ClientView* CreateClientView(views::Widget* widget) OVERRIDE;
411  virtual void OnWindowBeginUserBoundsChange() OVERRIDE;
412  virtual void OnWidgetMove() OVERRIDE;
413  virtual views::Widget* GetWidget() OVERRIDE;
414  virtual const views::Widget* GetWidget() const OVERRIDE;
415  virtual void GetAccessiblePanes(std::vector<View*>* panes) OVERRIDE;
416
417  // Overridden from views::WidgetObserver:
418  virtual void OnWidgetActivationChanged(views::Widget* widget,
419                                         bool active) OVERRIDE;
420
421  // Overridden from views::ClientView:
422  virtual bool CanClose() OVERRIDE;
423  virtual int NonClientHitTest(const gfx::Point& point) OVERRIDE;
424  virtual gfx::Size GetMinimumSize() OVERRIDE;
425
426  // ImmersiveModeController::Delegate overrides:
427  virtual BookmarkBarView* GetBookmarkBar() OVERRIDE;
428  virtual FullscreenController* GetFullscreenController() OVERRIDE;
429  virtual void FullscreenStateChanged() OVERRIDE;
430  virtual void SetImmersiveStyle(bool immersive) OVERRIDE;
431  virtual content::WebContents* GetWebContents() OVERRIDE;
432
433  // InfoBarContainer::Delegate overrides
434  virtual SkColor GetInfoBarSeparatorColor() const OVERRIDE;
435  virtual void InfoBarContainerStateChanged(bool is_animating) OVERRIDE;
436  virtual bool DrawInfoBarArrows(int* x) const OVERRIDE;
437
438  // views::SingleSplitViewListener overrides:
439  virtual bool SplitHandleMoved(views::SingleSplitView* sender) OVERRIDE;
440
441  // gfx::SysColorChangeListener overrides:
442  virtual void OnSysColorChange() OVERRIDE;
443
444  // Overridden from views::View:
445  virtual const char* GetClassName() const OVERRIDE;
446  virtual void Layout() OVERRIDE;
447  virtual void PaintChildren(gfx::Canvas* canvas) OVERRIDE;
448  virtual void ViewHierarchyChanged(
449      const ViewHierarchyChangedDetails& details) OVERRIDE;
450  virtual void ChildPreferredSizeChanged(View* child) OVERRIDE;
451  virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
452
453  // Overridden from ui::AcceleratorTarget:
454  virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
455
456  // OmniboxPopupModelObserver overrides
457  virtual void OnOmniboxPopupShownOrHidden() OVERRIDE;
458
459  // Testing interface:
460  views::SingleSplitView* GetContentsSplitForTest() { return contents_split_; }
461  ContentsContainer* GetContentsContainerForTest() {
462    return contents_container_;
463  }
464  views::WebView* GetContentsWebViewForTest() { return contents_web_view_; }
465
466 private:
467  // Do not friend BrowserViewLayout. Use the BrowserViewLayoutDelegate
468  // interface to keep these two classes decoupled and testable.
469  friend class BrowserViewLayoutDelegateImpl;
470  FRIEND_TEST_ALL_PREFIXES(BrowserViewTest, BrowserView);
471  FRIEND_TEST_ALL_PREFIXES(BrowserViewsAccessibilityTest,
472                           TestAboutChromeViewAccObj);
473
474  enum FullscreenType {
475    FOR_DESKTOP,
476    FOR_METRO
477  };
478
479  // Appends to |toolbars| a pointer to each AccessiblePaneView that
480  // can be traversed using F6, in the order they should be traversed.
481  void GetAccessiblePanes(std::vector<views::AccessiblePaneView*>* panes);
482
483  // Constructs and initializes the child views.
484  void InitViews();
485
486  // Callback for the loading animation(s) associated with this view.
487  void LoadingAnimationCallback();
488
489  // LoadCompleteListener::Delegate implementation. Creates and initializes the
490  // |jumplist_| after the first page load.
491  virtual void OnLoadCompleted() OVERRIDE;
492
493  // Returns the BrowserViewLayout.
494  BrowserViewLayout* GetBrowserViewLayout() const;
495
496  // Layout the Status Bubble.
497  void LayoutStatusBubble();
498
499  // Prepare to show the Bookmark Bar for the specified WebContents.
500  // Returns true if the Bookmark Bar can be shown (i.e. it's supported for this
501  // Browser type) and there should be a subsequent re-layout to show it.
502  // |contents| can be NULL.
503  bool MaybeShowBookmarkBar(content::WebContents* contents);
504
505  // Moves the bookmark bar view to the specified parent, which may be NULL,
506  // |this|, or |top_container_|. Ensures that |top_container_| stays in front
507  // of |bookmark_bar_view_|.
508  void SetBookmarkBarParent(views::View* new_parent);
509
510  // Prepare to show an Info Bar for the specified WebContents. Returns
511  // true if there is an Info Bar to show and one is supported for this Browser
512  // type, and there should be a subsequent re-layout to show it.
513  // |contents| can be NULL.
514  bool MaybeShowInfoBar(content::WebContents* contents);
515
516  // Updates devtools window for given contents. This method will show docked
517  // devtools window for inspected |web_contents| that has docked devtools
518  // and hide it for NULL or not inspected |web_contents|. It will also make
519  // sure devtools window size and position are restored for given tab.
520  void UpdateDevToolsForContents(content::WebContents* web_contents);
521
522  // Shows docked devtools.
523  void ShowDevToolsContainer();
524
525  // Hides docked devtools.
526  void HideDevToolsContainer();
527
528  // Reads split position from the current tab's devtools window and applies
529  // it to the devtools split.
530  void UpdateDevToolsSplitPosition();
531
532  // Updates various optional child Views, e.g. Bookmarks Bar, Info Bar or the
533  // Download Shelf in response to a change notification from the specified
534  // |contents|. |contents| can be NULL. In this case, all optional UI will be
535  // removed.
536  void UpdateUIForContents(content::WebContents* contents);
537
538  // Invoked to update the necessary things when our fullscreen state changes
539  // to |fullscreen|. On Windows this is invoked immediately when we toggle the
540  // full screen state. On Linux changing the fullscreen state is async, so we
541  // ask the window to change its fullscreen state, then when we get
542  // notification that it succeeded this method is invoked.
543  // If |url| is not empty, it is the URL of the page that requested fullscreen
544  // (via the fullscreen JS API).
545  // |bubble_type| determines what should be shown in the fullscreen exit
546  // bubble.
547  void ProcessFullscreen(bool fullscreen,
548                         FullscreenType fullscreen_type,
549                         const GURL& url,
550                         FullscreenExitBubbleType bubble_type);
551
552  // Returns whether immmersive fullscreen should replace fullscreen. This
553  // should only occur for "browser-fullscreen" for tabbed-typed windows (not
554  // for tab-fullscreen and not for app/popup type windows).
555  bool ShouldUseImmersiveFullscreenForUrl(const GURL& url) const;
556
557  // Copy the accelerator table from the app resources into something we can
558  // use.
559  void LoadAccelerators();
560
561  // Retrieves the command id for the specified Windows app command.
562  int GetCommandIDForAppCommandID(int app_command_id) const;
563
564  // Initialize the hung plugin detector.
565  void InitHangMonitor();
566
567  // Possibly records a user metrics action corresponding to the passed-in
568  // accelerator.  Only implemented for Chrome OS, where we're interested in
569  // learning about how frequently the top-row keys are used.
570  void UpdateAcceleratorMetrics(const ui::Accelerator& accelerator,
571                                int command_id);
572
573  // Calls |method| which is either RenderWidgetHost::Cut, ::Copy, or ::Paste,
574  // first trying the content WebContents, then the devtools WebContents, and
575  // lastly the Views::Textfield if one is focused.
576  // |windows_msg_id| is temporary until Win Aura is the default on Windows,
577  // since until then the omnibox doesn't use Views::Textfield.
578  void DoCutCopyPaste(void (content::RenderWidgetHost::*method)(),
579#if defined(OS_WIN)
580                      int windows_msg_id,
581#endif
582                      int command_id);
583
584  // Calls |method| which is either RenderWidgetHost::Cut, ::Copy, or ::Paste on
585  // the given WebContents, returning true if it consumed the event.
586  bool DoCutCopyPasteForWebContents(
587      content::WebContents* contents,
588      void (content::RenderWidgetHost::*method)());
589
590  // Shows the next app-modal dialog box, if there is one to be shown, or moves
591  // an existing showing one to the front.
592  void ActivateAppModalDialog() const;
593
594  // Returns the max top arrow height for infobar.
595  int GetMaxTopInfoBarArrowHeight();
596
597  // Last focused view that issued a tab traversal.
598  int last_focused_view_storage_id_;
599
600  // The BrowserFrame that hosts this view.
601  BrowserFrame* frame_;
602
603  // The Browser object we are associated with.
604  scoped_ptr<Browser> browser_;
605
606  // BrowserView layout (LTR one is pictured here).
607  //
608  // --------------------------------------------------------------------
609  // | TopContainerView (top_container_)                                |
610  // |  --------------------------------------------------------------  |
611  // |  | Tabs (tabstrip_)                                           |  |
612  // |  |------------------------------------------------------------|  |
613  // |  | Navigation buttons, address bar, menu (toolbar_)           |  |
614  // |  --------------------------------------------------------------  |
615  // |------------------------------------------------------------------|
616  // | All infobars (infobar_container_) [1]                            |
617  // |------------------------------------------------------------------|
618  // | Bookmarks (bookmark_bar_view_) [1]                               |
619  // |------------------------------------------------------------------|
620  // | Debugger splitter (contents_split_)                              |
621  // |  --------------------------------------------------------------  |
622  // |  | Page content (contents_container_)                         |  |
623  // |  |  --------------------------------------------------------  |  |
624  // |  |  | contents_web_view_                                   |  |  |
625  // |  |  --------------------------------------------------------  |  |
626  // |  --------------------------------------------------------------  |
627  // |  --------------------------------------------------------------  |
628  // |  | Debugger (devtools_container_)                             |  |
629  // |  |                                                            |  |
630  // |  --------------------------------------------------------------  |
631  // |------------------------------------------------------------------|
632  // | Active downloads (download_shelf_)                               |
633  // --------------------------------------------------------------------
634  //
635  // [1] The bookmark bar and info bar are swapped when on the new tab page.
636  //     Additionally when the bookmark bar is detached, contents_container_ is
637  //     positioned on top of the bar while the tab's contents are placed below
638  //     the bar.  This allows the find bar to always align with the top of
639  //     contents_container_ regardless if there's bookmark or info bars.
640
641  // The view that manages the tab strip, toolbar, and sometimes the bookmark
642  // bar. Stacked top in the view hiearachy so it can be used to slide out
643  // the top views in immersive fullscreen.
644  TopContainerView* top_container_;
645
646  // The TabStrip.
647  TabStrip* tabstrip_;
648
649  // The Toolbar containing the navigation buttons, menus and the address bar.
650  ToolbarView* toolbar_;
651
652  // This button sits next to the tabs on the right hand side and it is used
653  // only in windows metro metro mode to allow the user to flip among browser
654  // windows.
655  views::Button* window_switcher_button_;
656
657  // The Bookmark Bar View for this window. Lazily created. May be NULL for
658  // non-tabbed browsers like popups. May not be visible.
659  scoped_ptr<BookmarkBarView> bookmark_bar_view_;
660
661  // The do-nothing view which controls the z-order of the find bar widget
662  // relative to views which paint into layers and views with an associated
663  // NativeView.
664  View* find_bar_host_view_;
665
666  // The download shelf view (view at the bottom of the page).
667  scoped_ptr<DownloadShelfView> download_shelf_;
668
669  // The InfoBarContainerView that contains InfoBars for the current tab.
670  InfoBarContainerView* infobar_container_;
671
672  // The view that contains the selected WebContents.
673  views::WebView* contents_web_view_;
674
675  // The view that contains devtools window for the selected WebContents.
676  views::WebView* devtools_container_;
677
678  // The view managing the |contents_web_view_|.
679  ContentsContainer* contents_container_;
680
681  // Split view containing the contents container and devtools container.
682  views::SingleSplitView* contents_split_;
683
684  // Side to dock devtools to.
685  DevToolsDockSide devtools_dock_side_;
686
687  // Docked devtools window instance. NULL when current tab is not inspected
688  // or is inspected with undocked version of DevToolsWindow.
689  DevToolsWindow* devtools_window_;
690
691  // Tracks and stores the last focused view which is not the
692  // devtools_container_ or any of its children. Used to restore focus once
693  // the devtools_container_ is hidden.
694  scoped_ptr<views::ExternalFocusTracker> devtools_focus_tracker_;
695
696  // The Status information bubble that appears at the bottom of the window.
697  scoped_ptr<StatusBubbleViews> status_bubble_;
698
699  // A mapping between accelerators and commands.
700  std::map<ui::Accelerator, int> accelerator_table_;
701
702  // True if we have already been initialized.
703  bool initialized_;
704
705  // True if we should ignore requests to layout.  This is set while toggling
706  // fullscreen mode on and off to reduce jankiness.
707  bool ignore_layout_;
708
709  scoped_ptr<FullscreenExitBubbleViews> fullscreen_bubble_;
710
711#if defined(OS_WIN) && !defined(USE_AURA)
712  // This object is used to perform periodic actions in a worker
713  // thread. It is currently used to monitor hung plugin windows.
714  WorkerThreadTicker ticker_;
715
716  // This object is initialized with the frame window HWND. This
717  // object is also passed as a tick handler with the ticker_ object.
718  // It is used to periodically monitor for hung plugin windows
719  HungWindowDetector hung_window_detector_;
720
721  // This object is invoked by hung_window_detector_ when it detects a hung
722  // plugin window.
723  HungPluginAction hung_plugin_action_;
724
725  // Helper class to listen for completion of first page load.
726  scoped_ptr<LoadCompleteListener> load_complete_listener_;
727
728  // The custom JumpList for Windows 7.
729  scoped_refptr<JumpList> jumplist_;
730#endif
731
732  // The timer used to update frames for the Loading Animation.
733  base::RepeatingTimer<BrowserView> loading_animation_timer_;
734
735  views::UnhandledKeyboardEventHandler unhandled_keyboard_event_handler_;
736
737  // Used to measure the loading spinner animation rate.
738  base::TimeTicks last_animation_time_;
739
740  // If this flag is set then SetFocusToLocationBar() will set focus to the
741  // location bar even if the browser window is not active.
742  bool force_location_bar_focus_;
743
744  scoped_ptr<ImmersiveModeController> immersive_mode_controller_;
745
746  scoped_ptr<ScrollEndEffectController> scroll_end_effect_controller_;
747
748  gfx::ScopedSysColorChangeListener color_change_listener_;
749
750  mutable base::WeakPtrFactory<BrowserView> activate_modal_dialog_factory_;
751
752  DISALLOW_COPY_AND_ASSIGN(BrowserView);
753};
754
755#endif  // CHROME_BROWSER_UI_VIEWS_FRAME_BROWSER_VIEW_H_
756