core_tab_helper.h revision 7d4cd473f85ac64c3747c96c277f9e506a0d2246 
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_TAB_CONTENTS_CORE_TAB_HELPER_H_
6#define CHROME_BROWSER_UI_TAB_CONTENTS_CORE_TAB_HELPER_H_
7
8#include "base/time.h"
9#include "content/public/browser/web_contents_observer.h"
10#include "content/public/browser/web_contents_user_data.h"
11
12class CoreTabHelperDelegate;
13
14// Per-tab class to handle functionality that is core to the operation of tabs.
15class CoreTabHelper : public content::WebContentsObserver,
16                      public content::WebContentsUserData<CoreTabHelper> {
17 public:
18  virtual ~CoreTabHelper();
19
20  // Initial title assigned to NavigationEntries from Navigate.
21  static string16 GetDefaultTitle();
22
23  // Returns a human-readable description the tab's loading state.
24  string16 GetStatusText() const;
25
26  // Notification that tab closing has started.  This can be called multiple
27  // times, subsequent calls are ignored.
28  void OnCloseStarted();
29
30  // Notification that tab closing was cancelled. This can happen when a user
31  // cancels a window close via another tab's beforeunload dialog.
32  void OnCloseCanceled();
33
34  // Set the time during close when unload is started. Normally, this is set
35  // after the beforeunload dialog. However, for a window close, it is set
36  // after all the beforeunload dialogs have finished.
37  void OnUnloadStarted();
38
39  // Set the time during close when the tab is no longer visible.
40  void OnUnloadDetachedStarted();
41
42  CoreTabHelperDelegate* delegate() const { return delegate_; }
43  void set_delegate(CoreTabHelperDelegate* d) { delegate_ = d; }
44
45  void set_new_tab_start_time(const base::TimeTicks& time) {
46    new_tab_start_time_ = time;
47  }
48
49  base::TimeTicks new_tab_start_time() const { return new_tab_start_time_; }
50
51 private:
52  explicit CoreTabHelper(content::WebContents* web_contents);
53  friend class content::WebContentsUserData<CoreTabHelper>;
54
55  // content::WebContentsObserver overrides:
56  virtual void WasShown() OVERRIDE;
57  virtual void WebContentsDestroyed(
58      content::WebContents* web_contents) OVERRIDE;
59  virtual void BeforeUnloadFired(const base::TimeTicks& proceed_time) OVERRIDE;
60  virtual void BeforeUnloadDialogCancelled() OVERRIDE;
61
62  // Delegate for notifying our owner about stuff. Not owned by us.
63  CoreTabHelperDelegate* delegate_;
64
65  // The time when we started to create the new tab page.  This time is from
66  // before we created this WebContents.
67  base::TimeTicks new_tab_start_time_;
68
69  // The time that we started to close this WebContents.
70  base::TimeTicks close_start_time_;
71
72  // The time when onbeforeunload ended.
73  base::TimeTicks before_unload_end_time_;
74
75  // The time when the tab was removed from view during close.
76  base::TimeTicks unload_detached_start_time_;
77
78  DISALLOW_COPY_AND_ASSIGN(CoreTabHelper);
79};
80
81#endif  // CHROME_BROWSER_UI_TAB_CONTENTS_CORE_TAB_HELPER_H_
82