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

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.ZoomManager.ZoomManager</h1> 9 <h1>eric7.WebBrowser.ZoomManager.ZoomManager</h1>
10
11 <p> 10 <p>
12 Module implementing a manager for site specific zoom level settings. 11 Module implementing a manager for site specific zoom level settings.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>_ZoomManager</td></tr> 16 <tr><td>_ZoomManager</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#ZoomManager">ZoomManager</a></td> 22 <td><a href="#ZoomManager">ZoomManager</a></td>
25 <td>Class implementing a manager for site specific zoom level settings.</td> 23 <td>Class implementing a manager for site specific zoom level settings.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#instance">instance</a></td> 30 <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> 31 <td>Global function to get a reference to the zoom manager and create it, if it hasn't been yet.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="ZoomManager" ID="ZoomManager"></a> 37 <a NAME="ZoomManager" ID="ZoomManager"></a>
40 <h2>ZoomManager</h2> 38 <h2>ZoomManager</h2>
41
42 <p> 39 <p>
43 Class implementing a manager for site specific zoom level settings. 40 Class implementing a manager for site specific zoom level settings.
44 </p> 41 </p>
42
45 <h3>Signals</h3> 43 <h3>Signals</h3>
46 <dl> 44 <dl>
47 45
48 <dt>changed()</dt> 46 <dt>changed()</dt>
49 <dd> 47 <dd>
51 </dd> 49 </dd>
52 </dl> 50 </dl>
53 <h3>Derived from</h3> 51 <h3>Derived from</h3>
54 QObject 52 QObject
55 <h3>Class Attributes</h3> 53 <h3>Class Attributes</h3>
56
57 <table> 54 <table>
58 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
59 </table> 56 </table>
57
60 <h3>Class Methods</h3> 58 <h3>Class Methods</h3>
61
62 <table> 59 <table>
63 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
64 </table> 61 </table>
62
65 <h3>Methods</h3> 63 <h3>Methods</h3>
66 64 <table>
67 <table>
68
69 <tr> 65 <tr>
70 <td><a href="#ZoomManager.__init__">ZoomManager</a></td> 66 <td><a href="#ZoomManager.__init__">ZoomManager</a></td>
71 <td>Constructor</td> 67 <td>Constructor</td>
72 </tr> 68 </tr>
73 <tr> 69 <tr>
113 <tr> 109 <tr>
114 <td><a href="#ZoomManager.zoomValue">zoomValue</a></td> 110 <td><a href="#ZoomManager.zoomValue">zoomValue</a></td>
115 <td>Public method to get the zoom value for an URL.</td> 111 <td>Public method to get the zoom value for an URL.</td>
116 </tr> 112 </tr>
117 </table> 113 </table>
114
118 <h3>Static Methods</h3> 115 <h3>Static Methods</h3>
119
120 <table> 116 <table>
121 <tr><td>None</td></tr> 117 <tr><td>None</td></tr>
122 </table> 118 </table>
119
123 120
124 <a NAME="ZoomManager.__init__" ID="ZoomManager.__init__"></a> 121 <a NAME="ZoomManager.__init__" ID="ZoomManager.__init__"></a>
125 <h4>ZoomManager (Constructor)</h4> 122 <h4>ZoomManager (Constructor)</h4>
126 <b>ZoomManager</b>(<i>parent=None</i>) 123 <b>ZoomManager</b>(<i>parent=None</i>)
127
128 <p> 124 <p>
129 Constructor 125 Constructor
130 </p> 126 </p>
127
131 <dl> 128 <dl>
132 129
133 <dt><i>parent</i> (QObject)</dt> 130 <dt><i>parent</i> (QObject)</dt>
134 <dd> 131 <dd>
135 reference to the parent object 132 reference to the parent object
136 </dd> 133 </dd>
137 </dl> 134 </dl>
138 <a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a> 135 <a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a>
139 <h4>ZoomManager.__keyFromUrl</h4> 136 <h4>ZoomManager.__keyFromUrl</h4>
140 <b>__keyFromUrl</b>(<i>url</i>) 137 <b>__keyFromUrl</b>(<i>url</i>)
141
142 <p> 138 <p>
143 Private method to generate a DB key for an URL. 139 Private method to generate a DB key for an URL.
144 </p> 140 </p>
141
145 <dl> 142 <dl>
146 143
147 <dt><i>url</i> (QUrl)</dt> 144 <dt><i>url</i> (QUrl)</dt>
148 <dd> 145 <dd>
149 URL to generate a key for 146 URL to generate a key for
162 </dd> 159 </dd>
163 </dl> 160 </dl>
164 <a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a> 161 <a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a>
165 <h4>ZoomManager.allSiteNames</h4> 162 <h4>ZoomManager.allSiteNames</h4>
166 <b>allSiteNames</b>(<i></i>) 163 <b>allSiteNames</b>(<i></i>)
167
168 <p> 164 <p>
169 Public method to get a list of all site names. 165 Public method to get a list of all site names.
170 </p> 166 </p>
167
171 <dl> 168 <dl>
172 <dt>Return:</dt> 169 <dt>Return:</dt>
173 <dd> 170 <dd>
174 sorted list of all site names 171 sorted list of all site names
175 </dd> 172 </dd>
181 </dd> 178 </dd>
182 </dl> 179 </dl>
183 <a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a> 180 <a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a>
184 <h4>ZoomManager.clear</h4> 181 <h4>ZoomManager.clear</h4>
185 <b>clear</b>(<i></i>) 182 <b>clear</b>(<i></i>)
186
187 <p> 183 <p>
188 Public method to clear the saved zoom values. 184 Public method to clear the saved zoom values.
189 </p> 185 </p>
186
190 <a NAME="ZoomManager.close" ID="ZoomManager.close"></a> 187 <a NAME="ZoomManager.close" ID="ZoomManager.close"></a>
191 <h4>ZoomManager.close</h4> 188 <h4>ZoomManager.close</h4>
192 <b>close</b>(<i></i>) 189 <b>close</b>(<i></i>)
193
194 <p> 190 <p>
195 Public method to close the zoom manager. 191 Public method to close the zoom manager.
196 </p> 192 </p>
193
197 <a NAME="ZoomManager.load" ID="ZoomManager.load"></a> 194 <a NAME="ZoomManager.load" ID="ZoomManager.load"></a>
198 <h4>ZoomManager.load</h4> 195 <h4>ZoomManager.load</h4>
199 <b>load</b>(<i></i>) 196 <b>load</b>(<i></i>)
200
201 <p> 197 <p>
202 Public method to load the bookmarks. 198 Public method to load the bookmarks.
203 </p> 199 </p>
200
204 <a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a> 201 <a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a>
205 <h4>ZoomManager.removeZoomValue</h4> 202 <h4>ZoomManager.removeZoomValue</h4>
206 <b>removeZoomValue</b>(<i>site</i>) 203 <b>removeZoomValue</b>(<i>site</i>)
207
208 <p> 204 <p>
209 Public method to remove a zoom value entry. 205 Public method to remove a zoom value entry.
210 </p> 206 </p>
207
211 <dl> 208 <dl>
212 209
213 <dt><i>site</i> (str)</dt> 210 <dt><i>site</i> (str)</dt>
214 <dd> 211 <dd>
215 web site name 212 web site name
216 </dd> 213 </dd>
217 </dl> 214 </dl>
218 <a NAME="ZoomManager.save" ID="ZoomManager.save"></a> 215 <a NAME="ZoomManager.save" ID="ZoomManager.save"></a>
219 <h4>ZoomManager.save</h4> 216 <h4>ZoomManager.save</h4>
220 <b>save</b>(<i></i>) 217 <b>save</b>(<i></i>)
221
222 <p> 218 <p>
223 Public method to save the zoom values. 219 Public method to save the zoom values.
224 </p> 220 </p>
221
225 <a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a> 222 <a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a>
226 <h4>ZoomManager.setZoomValue</h4> 223 <h4>ZoomManager.setZoomValue</h4>
227 <b>setZoomValue</b>(<i>url, zoomValue</i>) 224 <b>setZoomValue</b>(<i>url, zoomValue</i>)
228
229 <p> 225 <p>
230 Public method to record the zoom value for the given URL. 226 Public method to record the zoom value for the given URL.
231 </p> 227 </p>
232 <p> 228 <p>
233 Note: Only zoom values not equal 100% are recorded. 229 Note: Only zoom values not equal 100% are recorded.
234 </p> 230 </p>
231
235 <dl> 232 <dl>
236 233
237 <dt><i>url</i> (QUrl)</dt> 234 <dt><i>url</i> (QUrl)</dt>
238 <dd> 235 <dd>
239 URL of the page to remember the zoom value for 236 URL of the page to remember the zoom value for
244 </dd> 241 </dd>
245 </dl> 242 </dl>
246 <a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a> 243 <a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a>
247 <h4>ZoomManager.siteInfo</h4> 244 <h4>ZoomManager.siteInfo</h4>
248 <b>siteInfo</b>(<i>site</i>) 245 <b>siteInfo</b>(<i>site</i>)
249
250 <p> 246 <p>
251 Public method to get the zoom value for the site. 247 Public method to get the zoom value for the site.
252 </p> 248 </p>
249
253 <dl> 250 <dl>
254 251
255 <dt><i>site</i> (str)</dt> 252 <dt><i>site</i> (str)</dt>
256 <dd> 253 <dd>
257 web site name 254 web site name
270 </dd> 267 </dd>
271 </dl> 268 </dl>
272 <a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a> 269 <a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a>
273 <h4>ZoomManager.sitesCount</h4> 270 <h4>ZoomManager.sitesCount</h4>
274 <b>sitesCount</b>(<i></i>) 271 <b>sitesCount</b>(<i></i>)
275
276 <p> 272 <p>
277 Public method to get the number of available sites. 273 Public method to get the number of available sites.
278 </p> 274 </p>
275
279 <dl> 276 <dl>
280 <dt>Return:</dt> 277 <dt>Return:</dt>
281 <dd> 278 <dd>
282 number of sites 279 number of sites
283 </dd> 280 </dd>
289 </dd> 286 </dd>
290 </dl> 287 </dl>
291 <a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a> 288 <a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a>
292 <h4>ZoomManager.zoomValue</h4> 289 <h4>ZoomManager.zoomValue</h4>
293 <b>zoomValue</b>(<i>url</i>) 290 <b>zoomValue</b>(<i>url</i>)
294
295 <p> 291 <p>
296 Public method to get the zoom value for an URL. 292 Public method to get the zoom value for an URL.
297 </p> 293 </p>
294
298 <dl> 295 <dl>
299 296
300 <dt><i>url</i> (QUrl)</dt> 297 <dt><i>url</i> (QUrl)</dt>
301 <dd> 298 <dd>
302 URL of the page to get the zoom value for 299 URL of the page to get the zoom value for
318 <hr /> 315 <hr />
319 <hr /> 316 <hr />
320 <a NAME="instance" ID="instance"></a> 317 <a NAME="instance" ID="instance"></a>
321 <h2>instance</h2> 318 <h2>instance</h2>
322 <b>instance</b>(<i></i>) 319 <b>instance</b>(<i></i>)
323
324 <p> 320 <p>
325 Global function to get a reference to the zoom manager and create it, if 321 Global function to get a reference to the zoom manager and create it, if
326 it hasn't been yet. 322 it hasn't been yet.
327 </p> 323 </p>
324
328 <dl> 325 <dl>
329 <dt>Return:</dt> 326 <dt>Return:</dt>
330 <dd> 327 <dd>
331 reference to the zoom manager object 328 reference to the zoom manager object
332 </dd> 329 </dd>

eric ide

mercurial