chrome/browser/ui/cocoa/tabs/tab_strip_model_observer_bridge.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_COCOA_TABS_TAB_STRIP_MODEL_OBSERVER_BRIDGE_H_
   6 #define CHROME_BROWSER_UI_COCOA_TABS_TAB_STRIP_MODEL_OBSERVER_BRIDGE_H_
   7
   8 #import <Foundation/Foundation.h>
   9
  10 #include "base/compiler_specific.h"
  11 #include "chrome/browser/ui/tabs/tab_strip_model_observer.h"
  12
  13 class TabStripModel;
  14
  15 namespace content {
  16 class WebContents;
  17 }
  18
  19 // A C++ bridge class to handle receiving notifications from the C++ tab strip
  20 // model. When the caller allocates a bridge, it automatically registers for
  21 // notifications from |model| and passes messages to |controller| via the
  22 // informal protocol below. The owner of this object is responsible for deleting
  23 // it (and thus unhooking notifications) before |controller| is destroyed.
  24 class TabStripModelObserverBridge : public TabStripModelObserver {
  25  public:
  26   TabStripModelObserverBridge(TabStripModel* model, id controller);
  27   ~TabStripModelObserverBridge() override;
  28
  29   // Overridden from TabStripModelObserver
  30   void TabInsertedAt(content::WebContents* contents,
  31                      int index,
  32                      bool foreground) override;
  33   void TabClosingAt(TabStripModel* tab_strip_model,
  34                     content::WebContents* contents,
  35                     int index) override;
  36   void TabDetachedAt(content::WebContents* contents, int index) override;
  37   void TabDeactivated(content::WebContents* contents) override;
  38   void ActiveTabChanged(content::WebContents* old_contents,
  39                         content::WebContents* new_contents,
  40                         int index,
  41                         int reason) override;
  42   void TabSelectionChanged(TabStripModel* tab_strip_model,
  43                            const ui::ListSelectionModel& old_model) override;
  44   void TabMoved(content::WebContents* contents,
  45                 int from_index,
  46                 int to_index) override;
  47   void TabChangedAt(content::WebContents* contents,
  48                     int index,
  49                     TabChangeType change_type) override;
  50   void TabReplacedAt(TabStripModel* tab_strip_model,
  51                      content::WebContents* old_contents,
  52                      content::WebContents* new_contents,
  53                      int index) override;
  54   void TabPinnedStateChanged(content::WebContents* contents,
  55                              int index) override;
  56   void TabStripEmpty() override;
  57   void TabStripModelDeleted() override;
  58
  59  private:
  60   id controller_;  // weak, owns me
  61   TabStripModel* model_;  // weak, owned by Browser
  62 };
  63
  64 // A collection of methods which can be selectively implemented by any
  65 // Cocoa object to receive updates about changes to a tab strip model. It is
  66 // ok to not implement them, the calling code checks before calling.
  67 @interface NSObject(TabStripModelBridge)
  68 - (void)insertTabWithContents:(content::WebContents*)contents
  69                       atIndex:(NSInteger)index
  70                  inForeground:(bool)inForeground;
  71 - (void)tabClosingWithContents:(content::WebContents*)contents
  72                        atIndex:(NSInteger)index;
  73 - (void)tabDetachedWithContents:(content::WebContents*)contents
  74                         atIndex:(NSInteger)index;
  75 - (void)tabDeactivatedWithContents:(content::WebContents*)contents;
  76 - (void)activateTabWithContents:(content::WebContents*)newContents
  77                previousContents:(content::WebContents*)oldContents
  78                         atIndex:(NSInteger)index
  79                          reason:(int)reason;
  80 - (void)tabMovedWithContents:(content::WebContents*)contents
  81                    fromIndex:(NSInteger)from
  82                      toIndex:(NSInteger)to;
  83 - (void)tabChangedWithContents:(content::WebContents*)contents
  84                        atIndex:(NSInteger)index
  85                     changeType:(TabStripModelObserver::TabChangeType)change;
  86 - (void)tabReplacedWithContents:(content::WebContents*)newContents
  87                previousContents:(content::WebContents*)oldContents
  88                         atIndex:(NSInteger)index;
  89 - (void)tabPinnedStateChangedWithContents:(content::WebContents*)contents
  90                                   atIndex:(NSInteger)index;
  91 - (void)tabStripEmpty;
  92 - (void)tabStripModelDeleted;
  93 - (void)tabSelectionChanged;
  94 @end
  95
  96 #endif  // CHROME_BROWSER_UI_COCOA_TABS_TAB_STRIP_MODEL_OBSERVER_BRIDGE_H_