eric7/Documentation/Source/eric7.WebBrowser.ZoomManager.ZoomManager.html

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

eric ide

mercurial