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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
|
// 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 CONTENT_PUBLIC_BROWSER_HOST_ZOOM_MAP_H_
#define CONTENT_PUBLIC_BROWSER_HOST_ZOOM_MAP_H_
#include <map>
#include <string>
#include <vector>
#include "base/basictypes.h"
#include "base/callback.h"
#include "base/callback_list.h"
#include "content/common/content_export.h"
#include "url/gurl.h"
namespace content {
class NavigationEntry;
class BrowserContext;
class ResourceContext;
class SiteInstance;
class WebContents;
// Maps hostnames to custom zoom levels. Written on the UI thread and read on
// any thread. One instance per browser context. Must be created on the UI
// thread, and it'll delete itself on the UI thread as well.
// Zoom can be defined at three levels: default zoom, zoom for host, and zoom
// for host with specific scheme. Setting any of the levels leaves settings
// for other settings intact. Getting the zoom level starts at the most
// specific setting and progresses to the less specific: first the zoom for the
// host and scheme pair is checked, secondly the zoom for the host only and
// lastly default zoom.
class HostZoomMap {
public:
// Enum that indicates what was the scope of zoom level change.
enum ZoomLevelChangeMode {
ZOOM_CHANGED_FOR_HOST, // Zoom level changed for host.
ZOOM_CHANGED_FOR_SCHEME_AND_HOST, // Zoom level changed for scheme/host
// pair.
ZOOM_CHANGED_TEMPORARY_ZOOM, // Temporary zoom change for specific
// renderer, no scheme/host is specified.
};
// Structure used to notify about zoom changes. Host and/or scheme are empty
// if not applicable to |mode|.
struct ZoomLevelChange {
ZoomLevelChangeMode mode;
std::string host;
std::string scheme;
double zoom_level;
};
typedef std::vector<ZoomLevelChange> ZoomLevelVector;
// Extracts the URL from NavigationEntry, substituting the error page
// URL in the event that the error page is showing.
CONTENT_EXPORT static GURL GetURLFromEntry(const NavigationEntry* entry);
CONTENT_EXPORT static HostZoomMap* GetDefaultForBrowserContext(
BrowserContext* browser_context);
// Returns the HostZoomMap associated with this SiteInstance. The SiteInstance
// may serve multiple WebContents, and the HostZoomMap is the same for all of
// these WebContents.
CONTENT_EXPORT static HostZoomMap* Get(SiteInstance* instance);
// Returns the HostZoomMap associated with this WebContent's main frame. If
// multiple WebContents share the same SiteInstance, then they share a single
// HostZoomMap.
CONTENT_EXPORT static HostZoomMap* GetForWebContents(
const WebContents* contents);
// Returns the current zoom level for the specified WebContents. May be
// temporary or host-specific.
CONTENT_EXPORT static double GetZoomLevel(const WebContents* web_contents);
// Sets the current zoom level for the specified WebContents. The level may
// be temporary or host-specific depending on the particular WebContents.
CONTENT_EXPORT static void SetZoomLevel(const WebContents* web_contents,
double level);
// Send an IPC to refresh any displayed error page's zoom levels. Needs to
// be called since error pages don't get loaded via the normal channel.
CONTENT_EXPORT static void SendErrorPageZoomLevelRefresh(
const WebContents* web_contents);
// Copy the zoom levels from the given map. Can only be called on the UI
// thread.
virtual void CopyFrom(HostZoomMap* copy) = 0;
// Here |host| is the host portion of URL, or (in the absence of a host)
// the complete spec of the URL.
// Returns the zoom for the specified |scheme| and |host|. See class
// description for details.
//
// This may be called on any thread.
virtual double GetZoomLevelForHostAndScheme(
const std::string& scheme,
const std::string& host) const = 0;
// Returns true if the specified |scheme| and/or |host| has a zoom level
// currently set.
//
// This may be called on any thread.
virtual bool HasZoomLevel(const std::string& scheme,
const std::string& host) const = 0;
// Returns all non-temporary zoom levels. Can be called on any thread.
virtual ZoomLevelVector GetAllZoomLevels() const = 0;
// Here |host| is the host portion of URL, or (in the absence of a host)
// the complete spec of the URL.
// Sets the zoom level for the |host| to |level|. If the level matches the
// current default zoom level, the host is erased from the saved preferences;
// otherwise the new value is written out.
// Zoom levels specified for both scheme and host are not affected.
//
// This should only be called on the UI thread.
virtual void SetZoomLevelForHost(const std::string& host, double level) = 0;
// Here |host| is the host portion of URL, or (in the absence of a host)
// the complete spec of the URL.
// Sets the zoom level for the |scheme|/|host| pair to |level|. No values
// will be erased during this operation, and this value will not be stored in
// the preferences.
//
// This should only be called on the UI thread.
virtual void SetZoomLevelForHostAndScheme(const std::string& scheme,
const std::string& host,
double level) = 0;
// Returns whether the view manages its zoom level independently of other
// views displaying content from the same host.
virtual bool UsesTemporaryZoomLevel(int render_process_id,
int render_view_id) const = 0;
// Sets the temporary zoom level that's only valid for the lifetime of this
// WebContents.
//
// This should only be called on the UI thread.
virtual void SetTemporaryZoomLevel(int render_process_id,
int render_view_id,
double level) = 0;
// Clears the temporary zoom level stored for this WebContents.
//
// This should only be called on the UI thread.
virtual void ClearTemporaryZoomLevel(int render_process_id,
int render_view_id) = 0;
// Get/Set the default zoom level for pages that don't override it.
virtual double GetDefaultZoomLevel() const = 0;
virtual void SetDefaultZoomLevel(double level) = 0;;
typedef base::Callback<void(const ZoomLevelChange&)> ZoomLevelChangedCallback;
typedef base::CallbackList<void(const ZoomLevelChange&)>::Subscription
Subscription;
// Add and remove zoom level changed callbacks.
virtual scoped_ptr<Subscription> AddZoomLevelChangedCallback(
const ZoomLevelChangedCallback& callback) = 0;
protected:
virtual ~HostZoomMap() {}
};
} // namespace content
#endif // CONTENT_PUBLIC_BROWSER_HOST_ZOOM_MAP_H_
|