src/chrome/browser/ui/bookmarks/bookmark_tab_helper.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_BOOKMARKS_BOOKMARK_TAB_HELPER_H_
   6 #define CHROME_BROWSER_UI_BOOKMARKS_BOOKMARK_TAB_HELPER_H_
   7
   8 #include "components/bookmarks/core/browser/base_bookmark_model_observer.h"
   9 #include "content/public/browser/web_contents_observer.h"
  10 #include "content/public/browser/web_contents_user_data.h"
  11
  12 struct BookmarkNodeData;
  13 class BookmarkTabHelperDelegate;
  14
  15 namespace content {
  16 class WebContents;
  17 }
  18
  19 // Per-tab class to manage bookmarks.
  20 class BookmarkTabHelper
  21     : public BaseBookmarkModelObserver,
  22       public content::WebContentsObserver,
  23       public content::WebContentsUserData<BookmarkTabHelper> {
  24  public:
  25   // Interface for forwarding bookmark drag and drop to extenstions.
  26   class BookmarkDrag {
  27    public:
  28     virtual void OnDragEnter(const BookmarkNodeData& data) = 0;
  29     virtual void OnDragOver(const BookmarkNodeData& data) = 0;
  30     virtual void OnDragLeave(const BookmarkNodeData& data) = 0;
  31     virtual void OnDrop(const BookmarkNodeData& data) = 0;
  32
  33    protected:
  34     virtual ~BookmarkDrag() {}
  35   };
  36
  37   virtual ~BookmarkTabHelper();
  38
  39   void set_delegate(BookmarkTabHelperDelegate* delegate) {
  40     delegate_ = delegate;
  41   }
  42
  43   // It is up to callers to call set_bookmark_drag_delegate(NULL) when
  44   // |bookmark_drag| is deleted since this class does not take ownership of
  45   // |bookmark_drag|.
  46   void set_bookmark_drag_delegate(BookmarkDrag* bookmark_drag) {
  47     bookmark_drag_ = bookmark_drag;
  48   }
  49   BookmarkDrag* bookmark_drag_delegate() { return bookmark_drag_; }
  50
  51   bool is_starred() const { return is_starred_; }
  52
  53   // Returns true if the bookmark bar should be shown detached.
  54   bool ShouldShowBookmarkBar() const;
  55
  56  private:
  57   friend class content::WebContentsUserData<BookmarkTabHelper>;
  58
  59   explicit BookmarkTabHelper(content::WebContents* web_contents);
  60
  61   // Updates the starred state from the BookmarkModel. If the state has changed,
  62   // the delegate is notified.
  63   void UpdateStarredStateForCurrentURL();
  64
  65   // Overridden from BaseBookmarkModelObserver:
  66   virtual void BookmarkModelChanged() OVERRIDE;
  67   virtual void BookmarkModelLoaded(BookmarkModel* model,
  68                                    bool ids_reassigned) OVERRIDE;
  69   virtual void BookmarkNodeAdded(BookmarkModel* model,
  70                                  const BookmarkNode* parent,
  71                                  int index) OVERRIDE;
  72   virtual void BookmarkNodeRemoved(BookmarkModel* model,
  73                                    const BookmarkNode* parent,
  74                                    int old_index,
  75                                    const BookmarkNode* node,
  76                                    const std::set<GURL>& removed_urls) OVERRIDE;
  77   virtual void BookmarkAllNodesRemoved(
  78       BookmarkModel* model,
  79       const std::set<GURL>& removed_urls) OVERRIDE;
  80
  81   virtual void BookmarkNodeChanged(BookmarkModel* model,
  82                                    const BookmarkNode* node) OVERRIDE;
  83
  84   // Overridden from content::WebContentsObserver:
  85   virtual void DidNavigateMainFrame(
  86       const content::LoadCommittedDetails& details,
  87       const content::FrameNavigateParams& params) OVERRIDE;
  88
  89   // Whether the current URL is starred.
  90   bool is_starred_;
  91
  92   BookmarkModel* bookmark_model_;
  93
  94   // Our delegate, to notify when the url starred changed.
  95   BookmarkTabHelperDelegate* delegate_;
  96
  97   // The BookmarkDrag is used to forward bookmark drag and drop events to
  98   // extensions.
  99   BookmarkDrag* bookmark_drag_;
 100
 101   DISALLOW_COPY_AND_ASSIGN(BookmarkTabHelper);
 102 };
 103
 104 #endif  // CHROME_BROWSER_UI_BOOKMARKS_BOOKMARK_TAB_HELPER_H_