Mercurial Repositories > eric / file comparison

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

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

changeset 4918
71caf42a13d8
child 4971
0f21662c0d2d
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
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>
50 <h3>Derived from</h3>
51 QObject
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#ZoomManager.__init__">ZoomManager</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#ZoomManager.__keyFromUrl">__keyFromUrl</a></td>
67 <td>Private method to generate a DB key for an URL.</td>
68 </tr><tr>
69 <td><a href="#ZoomManager.allSiteNames">allSiteNames</a></td>
70 <td>Public method to get a list of all site names.</td>
71 </tr><tr>
72 <td><a href="#ZoomManager.clear">clear</a></td>
73 <td>Public method to clear the saved zoom values.</td>
74 </tr><tr>
75 <td><a href="#ZoomManager.close">close</a></td>
76 <td>Public method to close the zoom manager.</td>
77 </tr><tr>
78 <td><a href="#ZoomManager.load">load</a></td>
79 <td>Public method to load the bookmarks.</td>
80 </tr><tr>
81 <td><a href="#ZoomManager.removeZoomValue">removeZoomValue</a></td>
82 <td>Public method to remove a zoom value entry.</td>
83 </tr><tr>
84 <td><a href="#ZoomManager.save">save</a></td>
85 <td>Public method to save the zoom values.</td>
86 </tr><tr>
87 <td><a href="#ZoomManager.setZoomValue">setZoomValue</a></td>
88 <td>Public method to record the zoom value for the given URL.</td>
89 </tr><tr>
90 <td><a href="#ZoomManager.siteInfo">siteInfo</a></td>
91 <td>Public method to get the zoom value for the site.</td>
92 </tr><tr>
93 <td><a href="#ZoomManager.sitesCount">sitesCount</a></td>
94 <td>Public method to get the number of available sites.</td>
95 </tr><tr>
96 <td><a href="#ZoomManager.zoomValue">zoomValue</a></td>
97 <td>Public method to get the zoom value for an URL.</td>
98 </tr>
99 </table>
100 <h3>Static Methods</h3>
101 <table>
102 <tr><td>None</td></tr>
103 </table>
104 <a NAME="ZoomManager.__init__" ID="ZoomManager.__init__"></a>
105 <h4>ZoomManager (Constructor)</h4>
106 <b>ZoomManager</b>(<i>parent=None</i>)
107 <p>
108 Constructor
109 </p><dl>
110 <dt><i>parent</i></dt>
111 <dd>
112 reference to the parent object (QObject)
113 </dd>
114 </dl><a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a>
115 <h4>ZoomManager.__keyFromUrl</h4>
116 <b>__keyFromUrl</b>(<i>url</i>)
117 <p>
118 Private method to generate a DB key for an URL.
119 </p><dl>
120 <dt><i>url</i> (QUrl)</dt>
121 <dd>
122 URL to generate a key for
123 </dd>
124 </dl><dl>
125 <dt>Returns:</dt>
126 <dd>
127 key for the given URL
128 </dd>
129 </dl><dl>
130 <dt>Return Type:</dt>
131 <dd>
132 str
133 </dd>
134 </dl><a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a>
135 <h4>ZoomManager.allSiteNames</h4>
136 <b>allSiteNames</b>(<i></i>)
137 <p>
138 Public method to get a list of all site names.
139 </p><dl>
140 <dt>Returns:</dt>
141 <dd>
142 sorted list of all site names
143 </dd>
144 </dl><dl>
145 <dt>Return Type:</dt>
146 <dd>
147 list of str
148 </dd>
149 </dl><a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a>
150 <h4>ZoomManager.clear</h4>
151 <b>clear</b>(<i></i>)
152 <p>
153 Public method to clear the saved zoom values.
154 </p><a NAME="ZoomManager.close" ID="ZoomManager.close"></a>
155 <h4>ZoomManager.close</h4>
156 <b>close</b>(<i></i>)
157 <p>
158 Public method to close the zoom manager.
159 </p><a NAME="ZoomManager.load" ID="ZoomManager.load"></a>
160 <h4>ZoomManager.load</h4>
161 <b>load</b>(<i></i>)
162 <p>
163 Public method to load the bookmarks.
164 </p><a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a>
165 <h4>ZoomManager.removeZoomValue</h4>
166 <b>removeZoomValue</b>(<i>site</i>)
167 <p>
168 Public method to remove a zoom value entry.
169 </p><dl>
170 <dt><i>site</i> (str)</dt>
171 <dd>
172 web site name
173 </dd>
174 </dl><a NAME="ZoomManager.save" ID="ZoomManager.save"></a>
175 <h4>ZoomManager.save</h4>
176 <b>save</b>(<i></i>)
177 <p>
178 Public method to save the zoom values.
179 </p><a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a>
180 <h4>ZoomManager.setZoomValue</h4>
181 <b>setZoomValue</b>(<i>url, zoomValue</i>)
182 <p>
183 Public method to record the zoom value for the given URL.
184 </p><p>
185 Note: Only zoom values not equal 100% are recorded.
186 </p><dl>
187 <dt><i>url</i> (QUrl)</dt>
188 <dd>
189 URL of the page to remember the zoom value for
190 </dd><dt><i>zoomValue</i> (int)</dt>
191 <dd>
192 zoom value for the URL
193 </dd>
194 </dl><a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a>
195 <h4>ZoomManager.siteInfo</h4>
196 <b>siteInfo</b>(<i>site</i>)
197 <p>
198 Public method to get the zoom value for the site.
199 </p><dl>
200 <dt><i>site</i> (str)</dt>
201 <dd>
202 web site name
203 </dd>
204 </dl><dl>
205 <dt>Returns:</dt>
206 <dd>
207 zoom value for the site
208 </dd>
209 </dl><dl>
210 <dt>Return Type:</dt>
211 <dd>
212 int
213 </dd>
214 </dl><a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a>
215 <h4>ZoomManager.sitesCount</h4>
216 <b>sitesCount</b>(<i></i>)
217 <p>
218 Public method to get the number of available sites.
219 </p><dl>
220 <dt>Returns:</dt>
221 <dd>
222 number of sites
223 </dd>
224 </dl><dl>
225 <dt>Return Type:</dt>
226 <dd>
227 int
228 </dd>
229 </dl><a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a>
230 <h4>ZoomManager.zoomValue</h4>
231 <b>zoomValue</b>(<i>url</i>)
232 <p>
233 Public method to get the zoom value for an URL.
234 </p><dl>
235 <dt><i>url</i> (QUrl)</dt>
236 <dd>
237 URL of the page to get the zoom value for
238 </dd>
239 </dl><dl>
240 <dt>Returns:</dt>
241 <dd>
242 zoomValue zoom value for the URL
243 </dd>
244 </dl><dl>
245 <dt>Return Type:</dt>
246 <dd>
247 int
248 </dd>
249 </dl>
250 <div align="right"><a href="#top">Up</a></div>
251 <hr /><hr />
252 <a NAME="instance" ID="instance"></a>
253 <h2>instance</h2>
254 <b>instance</b>(<i></i>)
255 <p>
256 Global function to get a reference to the zoom manager and create it, if
257 it hasn't been yet.
258 </p><dl>
259 <dt>Returns:</dt>
260 <dd>
261 reference to the zoom manager object
262 </dd>
263 </dl><dl>
264 <dt>Return Type:</dt>
265 <dd>
266 ZoomManager
267 </dd>
268 </dl>
269 <div align="right"><a href="#top">Up</a></div>
270 <hr />
271 </body></html>

Mercurial Repository: eric

eric ide

mercurial