Find Favicon in priority of icon_type.

chrome/browser/favicon/favicon_service.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_
 #define CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_
 
 #include <vector>
 
 #include "base/callback.h"
@@ skipping 49 matching lines @@
   // passed in URL and icon types which most which closely match the passed in
   // |desired_size_in_dip| at the scale factors supported by the current
   // platform (eg MacOS) in addition to 1x.
   // |FaviconImageResult::icon_url| is the favicon that the favicon bitmaps in
   // |image| originate from.
   // TODO(pkotwicz): Enable constructing |image| from bitmaps from several
   // icon URLs.
   typedef base::Callback<void(const chrome::FaviconImageResult&)>
       FaviconImageCallback;
 
-  // Callback for GetRawFavicon() and GetRawFaviconForURL().
+  // Callback for GetRawFavicon(), GetRawFaviconForURL() and
+  // GetLargestRawFavicon().
   // FaviconBitmapResult::bitmap_data is the bitmap in the thumbnail database
-  // for the passed in URL and icon types whose pixel size best matches the
-  // passed in |desired_size_in_dip| and |desired_scale_factor|. Returns an
-  // invalid chrome::FaviconBitmapResult if there are no matches.
+  // for the passed in URL and icon types.
+  // For GetRawFavicon() and GetRawFaviconForURL(), the returned bitmap's pixel
+  // size best matches the passed in |desired_size_in_dip| and
+  // |desired_scale_factor|.
+  // For GetLargestRawFavicon() the returned bitmap is the largest one whose
+  // pixel size is larger than |minimum_size_in_pixels| in the order of
+  // |icon_types|, or the largest one of all |icon_types| if no icon is larger
+  // than |minimum_size_in_pixels|.
+  // Returns an invalid chrome::FaviconBitmapResult if there are no matches.

[michaelbai, 2013/10/18 17:31:49]

Not sure whether we should have the detail description here, it seems
duplicated, should user look for the method's document?

[sky, 2013/10/18 19:29:00]

I agree. I was only thinking you need update the first sentence. Maybe the whole
comment should be nuked and replaced with something like see function for
details on value.

   typedef base::Callback<void(const chrome::FaviconBitmapResult&)>
       FaviconRawCallback;
 
   // Callback for GetFavicon() and GetFaviconForURL().
   //
   // The first argument is the set of bitmaps for the passed in URL and
   // icon types whose pixel sizes best match the passed in
   // |desired_size_in_dip| at the scale factors supported by the current
   // platform (eg MacOS) in addition to 1x. The vector has at most one result
   // for each of the scale factors. There are less entries if a single result
@@ skipping 80 matching lines @@
       const FaviconForURLParams& params,
       const FaviconImageCallback& callback,
       CancelableTaskTracker* tracker);
 
   CancelableTaskTracker::TaskId GetRawFaviconForURL(
       const FaviconForURLParams& params,
       ui::ScaleFactor desired_scale_factor,
       const FaviconRawCallback& callback,
       CancelableTaskTracker* tracker);
 
+  // See HistoryService::GetLargestFaviconForURL().
+  CancelableTaskTracker::TaskId GetLargestRawFaviconForURL(
+      Profile* profile,
+      const GURL& page_url,
+      const std::vector<int>& icon_types,
+      int minimum_size_in_pixels,
+      const FaviconRawCallback& callback,
+      CancelableTaskTracker* tracker);
+
   CancelableTaskTracker::TaskId GetFaviconForURL(
       const FaviconForURLParams& params,
       const FaviconResultsCallback& callback,
       CancelableTaskTracker* tracker);
 
   // Used to request a bitmap for the favicon with |favicon_id| which is not
   // resized from the size it is stored at in the database. If there are
   // multiple favicon bitmaps for |favicon_id|, the largest favicon bitmap is
   // returned.
   CancelableTaskTracker::TaskId GetLargestRawFaviconForID(
@@ skipping 76 matching lines @@
   void RunFaviconRawCallbackWithBitmapResults(
       const FaviconRawCallback& callback,
       int desired_size_in_dip,
       ui::ScaleFactor desired_scale_factor,
       const std::vector<chrome::FaviconBitmapResult>& favicon_bitmap_results);
 
   DISALLOW_COPY_AND_ASSIGN(FaviconService);
 };
 
 #endif  // CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_