OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ | 5 #ifndef CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ |
6 #define CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ | 6 #define CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ |
7 | 7 |
8 #include <vector> | 8 #include <vector> |
9 | 9 |
10 #include "base/basictypes.h" | 10 #include "base/basictypes.h" |
11 #include "base/memory/ref_counted.h" | 11 #include "base/memory/ref_counted.h" |
12 #include "chrome/common/favicon_url.h" | |
13 #include "content/public/browser/web_contents_observer.h" | 12 #include "content/public/browser/web_contents_observer.h" |
13 #include "content/public/common/favicon_url.h" | |
14 | 14 |
15 namespace content { | 15 namespace content { |
16 class WebContents; | 16 class WebContents; |
17 } | 17 } |
18 | 18 |
19 namespace gfx { | 19 namespace gfx { |
20 class Image; | 20 class Image; |
21 } | 21 } |
22 | 22 |
23 class GURL; | 23 class GURL; |
24 class FaviconDownloadHelperDelegate; | 24 class FaviconDownloadHelperDelegate; |
25 class SkBitmap; | 25 class SkBitmap; |
26 | 26 |
27 // FaviconDownloadHelper handles requests to download favicons, and listens for | 27 // FaviconDownloadHelper handles requests to download favicons, and listens for |
28 // the IPC messages from the renderer. | 28 // the IPC messages from the renderer. |
29 class FaviconDownloadHelper : public content::WebContentsObserver { | 29 class FaviconDownloadHelper : public content::WebContentsObserver { |
30 public: | 30 public: |
31 FaviconDownloadHelper(content::WebContents* web_contents, | 31 FaviconDownloadHelper(content::WebContents* web_contents, |
32 FaviconDownloadHelperDelegate* delegate); | 32 FaviconDownloadHelperDelegate* delegate); |
33 | 33 |
34 virtual ~FaviconDownloadHelper(); | 34 virtual ~FaviconDownloadHelper(); |
35 | 35 |
36 // Download the favicon at |url|. Returns the unique id of the download | 36 // Starts the download of the given favicon |url| and returns the unique id of |
37 // request. The id will be passed to | 37 // the download request. When the download is finished, an |
38 // FaviconDownloadHelperDelegate::OnDidDownloadFavicon() once the favicon has | 38 // IconHostMsg_DidDownloadFavicon IPC message will be sent and passed on to |
jam
2012/11/27 01:16:31
nit: don't describe the implementation details, es
Cait (Slow)
2012/11/28 00:11:45
Done.
| |
39 // been retrieved. | 39 // the delegate via FaviconDownloadHelperDelegate::OnDidDownloadFavicon(). |
40 // Note that |image_size| is a hint for images with multiple sizes. The | 40 // Note that |image_size| is a hint for images with multiple sizes. The |
41 // downloaded image is not resized to the given image_size. If 0 is passed, | 41 // downloaded image is not resized to the given image_size. If 0 is passed, |
42 // the first frame of the image is returned. | 42 // the first frame of the image is returned. |
43 int DownloadFavicon(const GURL& url, int image_size); | 43 int DownloadFavicon(const GURL& url, int image_size); |
44 | 44 |
45 protected: | 45 protected: |
46 // content::WebContentsObserver overrides. | 46 // content::WebContentsObserver overrides. |
47 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; | 47 virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE; |
48 | 48 |
49 private: | 49 private: |
50 typedef std::set<int> DownloadIdList; | 50 typedef std::set<int> DownloadIdList; |
51 | 51 |
52 // Message handler for IconHostMsg_DidDownloadFavicon. Called when the icon | 52 // Message handler for IconHostMsg_DidDownloadFavicon. Called when the icon |
53 // at |image_url| has been downloaded. | 53 // at |image_url| has been downloaded. |
54 // |bitmaps| is a list of all the frames of the icon at |image_url|. | 54 // |bitmaps| is a list of all the frames of the icon at |image_url|. |
55 void OnDidDownloadFavicon(int id, | 55 void OnDidDownloadFavicon(int id, |
56 const GURL& image_url, | 56 const GURL& image_url, |
57 bool errored, | 57 bool errored, |
58 int requested_size, | 58 int requested_size, |
59 const std::vector<SkBitmap>& bitmaps); | 59 const std::vector<SkBitmap>& bitmaps); |
60 | 60 |
61 // Message Handler, called when the FaviconURL associated with the specified | 61 // Message Handler, called when the FaviconURL associated with the specified |
62 // page is updated. | 62 // page is updated. |
63 void OnUpdateFaviconURL(int32 page_id, | 63 void OnUpdateFaviconURL(int32 page_id, |
64 const std::vector<FaviconURL>& candidates); | 64 const std::vector<content::FaviconURL>& candidates); |
65 | 65 |
66 // Delegate to pass Favicon bitmaps back to. Weak. | 66 // Delegate to pass Favicon bitmaps back to. Weak. |
67 FaviconDownloadHelperDelegate* delegate_; | 67 FaviconDownloadHelperDelegate* delegate_; |
68 | 68 |
69 // Ids of pending downloads. | 69 // Ids of pending downloads. |
70 DownloadIdList download_ids_; | 70 DownloadIdList download_ids_; |
71 | 71 |
72 DISALLOW_IMPLICIT_CONSTRUCTORS(FaviconDownloadHelper); | 72 DISALLOW_IMPLICIT_CONSTRUCTORS(FaviconDownloadHelper); |
73 }; | 73 }; |
74 | 74 |
75 #endif // CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ | 75 #endif // CHROME_BROWSER_FAVICON_FAVICON_DOWNLOAD_HELPER_H_ |
OLD | NEW |