src/chrome/browser/ui/android/tab_model/tab_model.h

   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_ANDROID_TAB_MODEL_TAB_MODEL_H_
   6 #define CHROME_BROWSER_UI_ANDROID_TAB_MODEL_TAB_MODEL_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "chrome/browser/sessions/session_id.h"
  10 #include "chrome/browser/sync/glue/synced_window_delegate.h"
  11 #include "chrome/browser/ui/toolbar/toolbar_model.h"
  12 #include "chrome/browser/ui/toolbar/toolbar_model_delegate.h"
  13 #include "content/public/browser/notification_observer.h"
  14 #include "content/public/browser/notification_registrar.h"
  15
  16 namespace browser_sync {
  17 class SyncedWindowDelegate;
  18 class SyncedWindowDelegateAndroid;
  19 }
  20
  21 namespace content {
  22 class WebContents;
  23 }
  24
  25 class Profile;
  26 class TabAndroid;
  27
  28 // Abstract representation of a Tab Model for Android.  Since Android does
  29 // not use Browser/BrowserList, this is required to allow Chrome to interact
  30 // with Android's Tabs and Tab Model.
  31 class TabModel : public content::NotificationObserver,
  32                  public ToolbarModelDelegate {
  33  public:
  34   explicit TabModel(Profile* profile);
  35   virtual ~TabModel();
  36
  37   // Implementation of ToolbarDelegate
  38   virtual content::WebContents* GetActiveWebContents() const OVERRIDE;
  39
  40   virtual Profile* GetProfile() const;
  41   virtual bool IsOffTheRecord() const;
  42   virtual browser_sync::SyncedWindowDelegate* GetSyncedWindowDelegate() const;
  43   virtual SessionID::id_type GetSessionId() const;
  44
  45   virtual int GetTabCount() const = 0;
  46   virtual int GetActiveIndex() const = 0;
  47   virtual content::WebContents* GetWebContentsAt(int index) const = 0;
  48   virtual TabAndroid* GetTabAt(int index) const = 0;
  49
  50   virtual void SetActiveIndex(int index) = 0;
  51   virtual void CloseTabAt(int index) = 0;
  52
  53   // Used for restoring tabs from synced foreign sessions.
  54   virtual void CreateTab(content::WebContents* web_contents) = 0;
  55
  56   // Used for creating a new tab with a given URL.
  57   virtual content::WebContents* CreateTabForTesting(const GURL& url) = 0;
  58
  59   // Return true if we are currently restoring sessions asynchronously.
  60   virtual bool IsSessionRestoreInProgress() const = 0;
  61
  62   virtual void OpenClearBrowsingData() const = 0;
  63
  64   // Returns search terms extracted from the current url if possible.
  65   string16 GetSearchTermsForCurrentTab();
  66
  67   // Returns the parameter that is used to trigger query extraction.
  68   std::string GetQueryExtractionParam();
  69
  70   // Calls through to the ToolbarModel's GetCorpusNameForMobile -- see
  71   // comments in toolbar_model.h.
  72   string16 GetCorpusNameForCurrentTab();
  73
  74  protected:
  75   // Instructs the TabModel to broadcast a notification that all tabs are now
  76   // loaded from storage.
  77   void BroadcastSessionRestoreComplete();
  78
  79   ToolbarModel* GetToolbarModel();
  80
  81  private:
  82   // Determines how TabModel will interact with the profile.
  83   virtual void Observe(int type,
  84                        const content::NotificationSource& source,
  85                        const content::NotificationDetails& details) OVERRIDE;
  86
  87   // The profile associated with this TabModel.
  88   Profile* profile_;
  89
  90   // Describes if this TabModel contains an off-the-record profile.
  91   bool is_off_the_record_;
  92
  93   // The SyncedWindowDelegate associated with this TabModel.
  94   scoped_ptr<browser_sync::SyncedWindowDelegateAndroid> synced_window_delegate_;
  95
  96   scoped_ptr<ToolbarModel> toolbar_model_;
  97
  98   // Unique identifier of this TabModel for session restore. This id is only
  99   // unique within the current session, and is not guaranteed to be unique
 100   // across sessions.
 101   SessionID session_id_;
 102
 103   // The Registrar used to register TabModel for notifications.
 104   content::NotificationRegistrar registrar_;
 105
 106   DISALLOW_COPY_AND_ASSIGN(TabModel);
 107 };
 108
 109 #endif  // CHROME_BROWSER_UI_ANDROID_TAB_MODEL_TAB_MODEL_H_