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