1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
// Copyright (c) 2011 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_TAB_HELPER_H_
#define CHROME_BROWSER_FAVICON_FAVICON_TAB_HELPER_H_
#pragma once
#include <vector>
#include "base/basictypes.h"
#include "base/callback.h"
#include "chrome/browser/favicon/favicon_handler_delegate.h"
#include "chrome/browser/favicon/favicon_service.h"
#include "chrome/common/favicon_url.h"
#include "content/public/browser/web_contents_observer.h"
#include "googleurl/src/gurl.h"
class FaviconHandler;
class NavigationEntry;
class SkBitmap;
// FaviconTabHelper works with FaviconHandlers to fetch the favicons.
//
// FetchFavicon fetches the given page's icons. It requests the icons from the
// history backend. If the icon is not available or expired, the icon will be
// downloaded and saved in the history backend.
//
// DownloadImage downloads the specified icon and returns it through the given
// callback.
//
class FaviconTabHelper : public content::WebContentsObserver,
public FaviconHandlerDelegate {
public:
explicit FaviconTabHelper(TabContents* tab_contents);
virtual ~FaviconTabHelper();
// Initiates loading the favicon for the specified url.
void FetchFavicon(const GURL& url);
// Returns the favicon for this tab, or IDR_DEFAULT_FAVICON if the tab does
// not have a favicon. The default implementation uses the current navigation
// entry. This will return an isNull bitmap if there are no navigation
// entries, which should rarely happen.
SkBitmap GetFavicon() const;
// Returns true if we have the favicon for the page.
bool FaviconIsValid() const;
// Returns whether the favicon should be displayed. If this returns false, no
// space is provided for the favicon, and the favicon is never displayed.
virtual bool ShouldDisplayFavicon();
// Saves the favicon for the current page.
void SaveFavicon();
// Initiates loading an image from given |image_url|. Returns a download id
// for caller to track the request. When download completes, |callback| is
// called with the three params: the download_id, a boolean flag to indicate
// whether the download succeeds and a SkBitmap as the downloaded image.
// Note that |image_size| is a hint for images with multiple sizes. The
// downloaded image is not resized to the given image_size. If 0 is passed,
// the first frame of the image is returned.
typedef base::Callback<void(int, bool, const SkBitmap&)>
ImageDownloadCallback;
int DownloadImage(const GURL& image_url,
int image_size,
history::IconType icon_type,
const ImageDownloadCallback& callback);
// Message Handler. Must be public, because also called from
// PrerenderContents.
void OnUpdateFaviconURL(int32 page_id,
const std::vector<FaviconURL>& candidates);
// FaviconHandlerDelegate methods.
virtual NavigationEntry* GetActiveEntry() OVERRIDE;
virtual void StartDownload(int id, const GURL& url, int image_size) OVERRIDE;
virtual void NotifyFaviconUpdated() OVERRIDE;
private:
// content::WebContentsObserver overrides.
virtual void NavigateToPendingEntry(
const GURL& url,
NavigationController::ReloadType reload_type) OVERRIDE;
virtual void DidNavigateMainFrame(
const content::LoadCommittedDetails& details,
const content::FrameNavigateParams& params) OVERRIDE;
virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
void OnDidDownloadFavicon(int id,
const GURL& image_url,
bool errored,
const SkBitmap& image);
Profile* profile_;
scoped_ptr<FaviconHandler> favicon_handler_;
// Handles downloading touchicons. It is NULL if
// browser_defaults::kEnableTouchIcon is false.
scoped_ptr<FaviconHandler> touch_icon_handler_;
DISALLOW_COPY_AND_ASSIGN(FaviconTabHelper);
};
#endif // CHROME_BROWSER_FAVICON_FAVICON_TAB_HELPER_H_
|
