components/favicon/core/favicon_driver.h

   1 // Copyright 2014 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 COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_H_
   6 #define COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_H_
   7
   8 #include <base/macros.h>
   9
  10 class GURL;
  11
  12 namespace gfx {
  13 class Image;
  14 }
  15
  16 namespace favicon {
  17
  18 // Interface that allows Favicon core code to interact with its driver (i.e.,
  19 // obtain information from it and give information to it). A concrete
  20 // implementation must be provided by the driver.
  21 class FaviconDriver {
  22  public:
  23   // Starts the download for the given favicon. When finished, the driver
  24   // will call OnDidDownloadFavicon() with the results.
  25   // Returns the unique id of the download request. The id will be passed
  26   // in OnDidDownloadFavicon().
  27   // Bitmaps with pixel sizes larger than |max_bitmap_size| are filtered out
  28   // from the bitmap results. If there are no bitmap results <=
  29   // |max_bitmap_size|, the smallest bitmap is resized to |max_bitmap_size| and
  30   // is the only result. A |max_bitmap_size| of 0 means unlimited.
  31   virtual int StartDownload(const GURL& url, int max_bitmap_size) = 0;
  32
  33   // Returns whether the user is operating in an off-the-record context.
  34   virtual bool IsOffTheRecord() = 0;
  35
  36   // Returns whether |url| is bookmarked.
  37   virtual bool IsBookmarked(const GURL& url) = 0;
  38
  39   // Returns the bitmap of the current page's favicon. Requires GetActiveURL()
  40   // to be valid.
  41   virtual const gfx::Image GetActiveFaviconImage() = 0;
  42
  43   // Returns the URL of the current page's favicon. Requires GetActiveURL() to
  44   // be valid.
  45   virtual const GURL GetActiveFaviconURL() = 0;
  46
  47   // Returns whether the page's favicon is valid (returns false if the default
  48   // favicon is being used). Requires GetActiveURL() to be valid.
  49   virtual bool GetActiveFaviconValidity() = 0;
  50
  51   // Returns the URL of the current page, if any. Returns an invalid
  52   // URL otherwise.
  53   virtual const GURL GetActiveURL() = 0;
  54
  55   // Notifies the driver a favicon image is available. |image| is not
  56   // necessarily 16x16. |icon_url| is the url the image is from. If
  57   // |is_active_favicon| is true the image corresponds to the favicon
  58   // (possibly empty) of the page.
  59   virtual void OnFaviconAvailable(const gfx::Image& image,
  60                                   const GURL& icon_url,
  61                                   bool is_active_favicon) = 0;
  62
  63  protected:
  64   FaviconDriver() {}
  65   virtual ~FaviconDriver() {}
  66
  67  private:
  68   DISALLOW_COPY_AND_ASSIGN(FaviconDriver);
  69 };
  70
  71 }  // namespace favicon
  72
  73 #endif  // COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_H_