|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.ZoomManager.ZoomManager</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.WebBrowser.ZoomManager.ZoomManager</h1> |
|
23 <p> |
|
24 Module implementing a manager for site specific zoom level settings. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>_ZoomManager</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#ZoomManager">ZoomManager</a></td> |
|
34 <td>Class implementing a manager for site specific zoom level settings.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr> |
|
40 <td><a href="#instance">instance</a></td> |
|
41 <td>Global function to get a reference to the zoom manager and create it, if it hasn't been yet.</td> |
|
42 </tr> |
|
43 </table> |
|
44 <hr /><hr /> |
|
45 <a NAME="ZoomManager" ID="ZoomManager"></a> |
|
46 <h2>ZoomManager</h2> |
|
47 <p> |
|
48 Class implementing a manager for site specific zoom level settings. |
|
49 </p><h3>Signals</h3> |
|
50 <dl> |
|
51 <dt>changed()</dt> |
|
52 <dd> |
|
53 emitted to indicate a change of the zoom level |
|
54 </dd> |
|
55 </dl> |
|
56 <h3>Derived from</h3> |
|
57 QObject |
|
58 <h3>Class Attributes</h3> |
|
59 <table> |
|
60 <tr><td>None</td></tr> |
|
61 </table> |
|
62 <h3>Class Methods</h3> |
|
63 <table> |
|
64 <tr><td>None</td></tr> |
|
65 </table> |
|
66 <h3>Methods</h3> |
|
67 <table> |
|
68 <tr> |
|
69 <td><a href="#ZoomManager.__init__">ZoomManager</a></td> |
|
70 <td>Constructor</td> |
|
71 </tr><tr> |
|
72 <td><a href="#ZoomManager.__keyFromUrl">__keyFromUrl</a></td> |
|
73 <td>Private method to generate a DB key for an URL.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#ZoomManager.allSiteNames">allSiteNames</a></td> |
|
76 <td>Public method to get a list of all site names.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#ZoomManager.clear">clear</a></td> |
|
79 <td>Public method to clear the saved zoom values.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#ZoomManager.close">close</a></td> |
|
82 <td>Public method to close the zoom manager.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#ZoomManager.load">load</a></td> |
|
85 <td>Public method to load the bookmarks.</td> |
|
86 </tr><tr> |
|
87 <td><a href="#ZoomManager.removeZoomValue">removeZoomValue</a></td> |
|
88 <td>Public method to remove a zoom value entry.</td> |
|
89 </tr><tr> |
|
90 <td><a href="#ZoomManager.save">save</a></td> |
|
91 <td>Public method to save the zoom values.</td> |
|
92 </tr><tr> |
|
93 <td><a href="#ZoomManager.setZoomValue">setZoomValue</a></td> |
|
94 <td>Public method to record the zoom value for the given URL.</td> |
|
95 </tr><tr> |
|
96 <td><a href="#ZoomManager.siteInfo">siteInfo</a></td> |
|
97 <td>Public method to get the zoom value for the site.</td> |
|
98 </tr><tr> |
|
99 <td><a href="#ZoomManager.sitesCount">sitesCount</a></td> |
|
100 <td>Public method to get the number of available sites.</td> |
|
101 </tr><tr> |
|
102 <td><a href="#ZoomManager.zoomValue">zoomValue</a></td> |
|
103 <td>Public method to get the zoom value for an URL.</td> |
|
104 </tr> |
|
105 </table> |
|
106 <h3>Static Methods</h3> |
|
107 <table> |
|
108 <tr><td>None</td></tr> |
|
109 </table> |
|
110 <a NAME="ZoomManager.__init__" ID="ZoomManager.__init__"></a> |
|
111 <h4>ZoomManager (Constructor)</h4> |
|
112 <b>ZoomManager</b>(<i>parent=None</i>) |
|
113 <p> |
|
114 Constructor |
|
115 </p><dl> |
|
116 <dt><i>parent</i></dt> |
|
117 <dd> |
|
118 reference to the parent object (QObject) |
|
119 </dd> |
|
120 </dl><a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a> |
|
121 <h4>ZoomManager.__keyFromUrl</h4> |
|
122 <b>__keyFromUrl</b>(<i>url</i>) |
|
123 <p> |
|
124 Private method to generate a DB key for an URL. |
|
125 </p><dl> |
|
126 <dt><i>url</i> (QUrl)</dt> |
|
127 <dd> |
|
128 URL to generate a key for |
|
129 </dd> |
|
130 </dl><dl> |
|
131 <dt>Returns:</dt> |
|
132 <dd> |
|
133 key for the given URL |
|
134 </dd> |
|
135 </dl><dl> |
|
136 <dt>Return Type:</dt> |
|
137 <dd> |
|
138 str |
|
139 </dd> |
|
140 </dl><a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a> |
|
141 <h4>ZoomManager.allSiteNames</h4> |
|
142 <b>allSiteNames</b>(<i></i>) |
|
143 <p> |
|
144 Public method to get a list of all site names. |
|
145 </p><dl> |
|
146 <dt>Returns:</dt> |
|
147 <dd> |
|
148 sorted list of all site names |
|
149 </dd> |
|
150 </dl><dl> |
|
151 <dt>Return Type:</dt> |
|
152 <dd> |
|
153 list of str |
|
154 </dd> |
|
155 </dl><a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a> |
|
156 <h4>ZoomManager.clear</h4> |
|
157 <b>clear</b>(<i></i>) |
|
158 <p> |
|
159 Public method to clear the saved zoom values. |
|
160 </p><a NAME="ZoomManager.close" ID="ZoomManager.close"></a> |
|
161 <h4>ZoomManager.close</h4> |
|
162 <b>close</b>(<i></i>) |
|
163 <p> |
|
164 Public method to close the zoom manager. |
|
165 </p><a NAME="ZoomManager.load" ID="ZoomManager.load"></a> |
|
166 <h4>ZoomManager.load</h4> |
|
167 <b>load</b>(<i></i>) |
|
168 <p> |
|
169 Public method to load the bookmarks. |
|
170 </p><a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a> |
|
171 <h4>ZoomManager.removeZoomValue</h4> |
|
172 <b>removeZoomValue</b>(<i>site</i>) |
|
173 <p> |
|
174 Public method to remove a zoom value entry. |
|
175 </p><dl> |
|
176 <dt><i>site</i> (str)</dt> |
|
177 <dd> |
|
178 web site name |
|
179 </dd> |
|
180 </dl><a NAME="ZoomManager.save" ID="ZoomManager.save"></a> |
|
181 <h4>ZoomManager.save</h4> |
|
182 <b>save</b>(<i></i>) |
|
183 <p> |
|
184 Public method to save the zoom values. |
|
185 </p><a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a> |
|
186 <h4>ZoomManager.setZoomValue</h4> |
|
187 <b>setZoomValue</b>(<i>url, zoomValue</i>) |
|
188 <p> |
|
189 Public method to record the zoom value for the given URL. |
|
190 </p><p> |
|
191 Note: Only zoom values not equal 100% are recorded. |
|
192 </p><dl> |
|
193 <dt><i>url</i> (QUrl)</dt> |
|
194 <dd> |
|
195 URL of the page to remember the zoom value for |
|
196 </dd><dt><i>zoomValue</i> (int)</dt> |
|
197 <dd> |
|
198 zoom value for the URL |
|
199 </dd> |
|
200 </dl><a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a> |
|
201 <h4>ZoomManager.siteInfo</h4> |
|
202 <b>siteInfo</b>(<i>site</i>) |
|
203 <p> |
|
204 Public method to get the zoom value for the site. |
|
205 </p><dl> |
|
206 <dt><i>site</i> (str)</dt> |
|
207 <dd> |
|
208 web site name |
|
209 </dd> |
|
210 </dl><dl> |
|
211 <dt>Returns:</dt> |
|
212 <dd> |
|
213 zoom value for the site |
|
214 </dd> |
|
215 </dl><dl> |
|
216 <dt>Return Type:</dt> |
|
217 <dd> |
|
218 int |
|
219 </dd> |
|
220 </dl><a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a> |
|
221 <h4>ZoomManager.sitesCount</h4> |
|
222 <b>sitesCount</b>(<i></i>) |
|
223 <p> |
|
224 Public method to get the number of available sites. |
|
225 </p><dl> |
|
226 <dt>Returns:</dt> |
|
227 <dd> |
|
228 number of sites |
|
229 </dd> |
|
230 </dl><dl> |
|
231 <dt>Return Type:</dt> |
|
232 <dd> |
|
233 int |
|
234 </dd> |
|
235 </dl><a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a> |
|
236 <h4>ZoomManager.zoomValue</h4> |
|
237 <b>zoomValue</b>(<i>url</i>) |
|
238 <p> |
|
239 Public method to get the zoom value for an URL. |
|
240 </p><dl> |
|
241 <dt><i>url</i> (QUrl)</dt> |
|
242 <dd> |
|
243 URL of the page to get the zoom value for |
|
244 </dd> |
|
245 </dl><dl> |
|
246 <dt>Returns:</dt> |
|
247 <dd> |
|
248 zoomValue zoom value for the URL |
|
249 </dd> |
|
250 </dl><dl> |
|
251 <dt>Return Type:</dt> |
|
252 <dd> |
|
253 int |
|
254 </dd> |
|
255 </dl> |
|
256 <div align="right"><a href="#top">Up</a></div> |
|
257 <hr /><hr /> |
|
258 <a NAME="instance" ID="instance"></a> |
|
259 <h2>instance</h2> |
|
260 <b>instance</b>(<i></i>) |
|
261 <p> |
|
262 Global function to get a reference to the zoom manager and create it, if |
|
263 it hasn't been yet. |
|
264 </p><dl> |
|
265 <dt>Returns:</dt> |
|
266 <dd> |
|
267 reference to the zoom manager object |
|
268 </dd> |
|
269 </dl><dl> |
|
270 <dt>Return Type:</dt> |
|
271 <dd> |
|
272 ZoomManager |
|
273 </dd> |
|
274 </dl> |
|
275 <div align="right"><a href="#top">Up</a></div> |
|
276 <hr /> |
|
277 </body></html> |