Documentation/Source/eric6.Helpviewer.ZoomManager.ZoomManager.html

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

eric ide

mercurial