eric6/Documentation/Source/eric6.WebBrowser.ZoomManager.ZoomManager.html

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

eric ide

mercurial