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