chrome/browser/custom_home_pages_table_model.h

   1 // Copyright (c) 2011 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_CUSTOM_HOME_PAGES_TABLE_MODEL_H_
   6 #define CHROME_BROWSER_CUSTOM_HOME_PAGES_TABLE_MODEL_H_
   7 #pragma once
   8
   9 #include <string>
  10 #include <vector>
  11
  12 #include "base/compiler_specific.h"
  13 #include "chrome/browser/history/history.h"
  14 #include "chrome/browser/favicon/favicon_service.h"
  15 #include "ui/base/models/table_model.h"
  16
  17 class GURL;
  18 class Profile;
  19 class SkBitmap;
  20
  21 namespace ui {
  22 class TableModelObserver;
  23 }
  24
  25 // CustomHomePagesTableModel is the model for the TableView showing the list
  26 // of pages the user wants opened on startup.
  27
  28 class CustomHomePagesTableModel : public ui::TableModel {
  29  public:
  30   explicit CustomHomePagesTableModel(Profile* profile);
  31   virtual ~CustomHomePagesTableModel();
  32
  33   // Sets the set of urls that this model contains.
  34   void SetURLs(const std::vector<GURL>& urls);
  35
  36   // Collect all entries indexed by |index_list|, and moves them to be right
  37   // before the element addressed by |insert_before|. Used by Drag&Drop.
  38   // Expects |index_list| to be ordered ascending.
  39   void MoveURLs(int insert_before, const std::vector<int>& index_list);
  40
  41   // Adds an entry at the specified index.
  42   void Add(int index, const GURL& url);
  43
  44   // Removes the entry at the specified index.
  45   void Remove(int index);
  46
  47   // Clears any entries and fills the list with pages currently opened in the
  48   // browser.
  49   void SetToCurrentlyOpenPages();
  50
  51   // Returns the set of urls this model contains.
  52   std::vector<GURL> GetURLs();
  53
  54   // TableModel overrides:
  55   virtual int RowCount() OVERRIDE;
  56   virtual string16 GetText(int row, int column_id) OVERRIDE;
  57   virtual SkBitmap GetIcon(int row) OVERRIDE;
  58   virtual string16 GetTooltip(int row) OVERRIDE;
  59   virtual void SetObserver(ui::TableModelObserver* observer) OVERRIDE;
  60
  61  private:
  62   // Each item in the model is represented as an Entry. Entry stores the URL,
  63   // title, and favicon of the page.
  64   struct Entry;
  65
  66   // Loads the title and favicon for the specified entry.
  67   void LoadTitleAndFavicon(Entry* entry);
  68
  69   // Callback from history service. Updates the title of the Entry whose
  70   // |title_handle| matches |handle| and notifies the observer of the change.
  71   void OnGotTitle(HistoryService::Handle handle,
  72                   bool found_url,
  73                   const history::URLRow* row,
  74                   history::VisitVector* visits);
  75
  76   // Callback from history service. Updates the icon of the Entry whose
  77   // |favicon_handle| matches |handle| and notifies the observer of the change.
  78   void OnGotFavicon(FaviconService::Handle handle,
  79                     history::FaviconData favicon);
  80
  81   // Returns the entry whose |member| matches |handle| and sets |entry_index| to
  82   // the index of the entry.
  83   Entry* GetEntryByLoadHandle(CancelableRequestProvider::Handle Entry::* member,
  84                               CancelableRequestProvider::Handle handle,
  85                               int* entry_index);
  86
  87   // Returns the URL for a particular row, formatted for display to the user.
  88   string16 FormattedURL(int row) const;
  89
  90   // Set of entries we're showing.
  91   std::vector<Entry> entries_;
  92
  93   // Default icon to show when one can't be found for the URL.
  94   SkBitmap* default_favicon_;
  95
  96   // Profile used to load titles and icons.
  97   Profile* profile_;
  98
  99   ui::TableModelObserver* observer_;
 100
 101   // Used in loading titles and favicons.
 102   CancelableRequestConsumer history_query_consumer_;
 103   CancelableRequestConsumer favicon_query_consumer_;
 104
 105   DISALLOW_COPY_AND_ASSIGN(CustomHomePagesTableModel);
 106 };
 107
 108 #endif  // CHROME_BROWSER_CUSTOM_HOME_PAGES_TABLE_MODEL_H_