components/favicon/core/favicon_client.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_CLIENT_H_
   6 #define COMPONENTS_FAVICON_CORE_FAVICON_CLIENT_H_
   7
   8 #include <vector>
   9
  10 #include "base/macros.h"
  11 #include "base/task/cancelable_task_tracker.h"
  12 #include "components/favicon_base/favicon_callback.h"
  13
  14 class GURL;
  15
  16 namespace favicon {
  17
  18 // This class abstracts operations that depend on the embedder's environment,
  19 // e.g. Chrome.
  20 class FaviconClient {
  21  public:
  22   FaviconClient() {}
  23   virtual ~FaviconClient() {}
  24
  25   // Returns true if the specified URL is a native application page URL.
  26   // If this returns true the favicon for the page must be fetched using
  27   // GetFaviconForNativeApplicationURL().
  28   virtual bool IsNativeApplicationURL(const GURL& url) = 0;
  29
  30   // Requests the favicon for a native application page URL for the sizes
  31   // specified by |desired_sizes_in_pixel|. Returns a TaskId to use to cancel
  32   // the request using |tracker| or kBadTaskId if the request cannot be
  33   // scheduled. |callback| will be called with the favicon results.
  34   virtual base::CancelableTaskTracker::TaskId GetFaviconForNativeApplicationURL(
  35       const GURL& url,
  36       const std::vector<int>& desired_sizes_in_pixel,
  37       const favicon_base::FaviconResultsCallback& callback,
  38       base::CancelableTaskTracker* tracker) = 0;
  39
  40  private:
  41   DISALLOW_COPY_AND_ASSIGN(FaviconClient);
  42 };
  43
  44 }  // namespace favicon
  45
  46 #endif  // COMPONENTS_FAVICON_CORE_FAVICON_CLIENT_H_