OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 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 COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ | 5 #ifndef COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ |
6 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ | 6 #define COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ |
7 | 7 |
8 #include <set> | 8 #include <set> |
9 #include <utility> | 9 #include <utility> |
10 #include <vector> | 10 #include <vector> |
11 | 11 |
12 #include "base/callback_forward.h" | 12 #include "base/callback_forward.h" |
13 #include "base/task/cancelable_task_tracker.h" | 13 #include "base/task/cancelable_task_tracker.h" |
| 14 #include "components/favicon_base/favicon_callback.h" |
14 | 15 |
15 class BookmarkNode; | 16 class BookmarkNode; |
16 class GURL; | 17 class GURL; |
17 | 18 |
18 namespace base { | 19 namespace base { |
19 struct UserMetricsAction; | 20 struct UserMetricsAction; |
20 } | 21 } |
21 | 22 |
22 namespace favicon_base { | |
23 struct FaviconImageResult; | |
24 } | |
25 | |
26 // This class abstracts operations that depends on the embedder's environment, | 23 // This class abstracts operations that depends on the embedder's environment, |
27 // e.g. Chrome. | 24 // e.g. Chrome. |
28 class BookmarkClient { | 25 class BookmarkClient { |
29 public: | 26 public: |
30 // Callback for GetFaviconImageForURL(). | |
31 typedef base::Callback<void(const favicon_base::FaviconImageResult&)> | |
32 FaviconImageCallback; | |
33 | |
34 // Types representing a set of BookmarkNode and a mapping from BookmarkNode | 27 // Types representing a set of BookmarkNode and a mapping from BookmarkNode |
35 // to the number of time the corresponding URL has been typed by the user in | 28 // to the number of time the corresponding URL has been typed by the user in |
36 // the Omnibox. | 29 // the Omnibox. |
37 typedef std::set<const BookmarkNode*> NodeSet; | 30 typedef std::set<const BookmarkNode*> NodeSet; |
38 typedef std::pair<const BookmarkNode*, int> NodeTypedCountPair; | 31 typedef std::pair<const BookmarkNode*, int> NodeTypedCountPair; |
39 typedef std::vector<NodeTypedCountPair> NodeTypedCountPairs; | 32 typedef std::vector<NodeTypedCountPair> NodeTypedCountPairs; |
40 | 33 |
41 // Returns true if the embedder favors touch icons over favicons. | 34 // Returns true if the embedder favors touch icons over favicons. |
42 virtual bool PreferTouchIcon(); | 35 virtual bool PreferTouchIcon(); |
43 | 36 |
44 // Requests the favicon of any of |icon_types| whose pixel sizes most | 37 // Requests the favicon of any of |icon_types| whose pixel sizes most |
45 // closely match |desired_size_in_dip| (if value is 0, the largest favicon | 38 // closely match |desired_size_in_dip| (if value is 0, the largest favicon |
46 // is returned) and desired scale factor for |page_url|. |callback| is run | 39 // is returned) and desired scale factor for |page_url|. |callback| is run |
47 // when the bits have been fetched. |icon_types| can be any combination of | 40 // when the bits have been fetched. |icon_types| can be any combination of |
48 // IconType value, but only one icon will be returned. | 41 // IconType value, but only one icon will be returned. |
49 virtual base::CancelableTaskTracker::TaskId GetFaviconImageForURL( | 42 virtual base::CancelableTaskTracker::TaskId GetFaviconImageForURL( |
50 const GURL& page_url, | 43 const GURL& page_url, |
51 int icon_types, | 44 int icon_types, |
52 int desired_size_in_dip, | 45 int desired_size_in_dip, |
53 const FaviconImageCallback& callback, | 46 const favicon_base::FaviconImageCallback& callback, |
54 base::CancelableTaskTracker* tracker); | 47 base::CancelableTaskTracker* tracker); |
55 | 48 |
56 // Returns true if the embedder supports typed count for URL. | 49 // Returns true if the embedder supports typed count for URL. |
57 virtual bool SupportsTypedCountForNodes(); | 50 virtual bool SupportsTypedCountForNodes(); |
58 | 51 |
59 // Retrieves the number of time each BookmarkNode URL has been typed in | 52 // Retrieves the number of time each BookmarkNode URL has been typed in |
60 // the Omnibox by the user. | 53 // the Omnibox by the user. |
61 virtual void GetTypedCountForNodes( | 54 virtual void GetTypedCountForNodes( |
62 const NodeSet& nodes, | 55 const NodeSet& nodes, |
63 NodeTypedCountPairs* node_typed_count_pairs); | 56 NodeTypedCountPairs* node_typed_count_pairs); |
64 | 57 |
65 // Returns whether the embedder wants permanent node of type |node_type| | 58 // Returns whether the embedder wants permanent node of type |node_type| |
66 // to always be visible or to only show them when not empty. | 59 // to always be visible or to only show them when not empty. |
67 virtual bool IsPermanentNodeVisible(int node_type) = 0; | 60 virtual bool IsPermanentNodeVisible(int node_type) = 0; |
68 | 61 |
69 // Wrapper around RecordAction defined in base/metrics/user_metrics.h | 62 // Wrapper around RecordAction defined in base/metrics/user_metrics.h |
70 // that ensure that the action is posted from the correct thread. | 63 // that ensure that the action is posted from the correct thread. |
71 virtual void RecordAction(const base::UserMetricsAction& action) = 0; | 64 virtual void RecordAction(const base::UserMetricsAction& action) = 0; |
72 | 65 |
73 protected: | 66 protected: |
74 virtual ~BookmarkClient() {} | 67 virtual ~BookmarkClient() {} |
75 }; | 68 }; |
76 | 69 |
77 #endif // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ | 70 #endif // COMPONENTS_BOOKMARKS_BROWSER_BOOKMARK_CLIENT_H_ |
OLD | NEW |