Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.WebBrowser.FlashCookieManager.FlashCookieManager.html

changeset 4918
71caf42a13d8
equal deleted inserted replaced
4917:682750cc7bd5 4918:71caf42a13d8
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.FlashCookieManager.FlashCookieManager</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.FlashCookieManager.FlashCookieManager</h1>
23 <p>
24 Module implementing the Flash cookie manager.
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="#FlashCookieManager">FlashCookieManager</a></td>
34 <td>Class implementing the Flash cookie manager object.</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="FlashCookieManager" ID="FlashCookieManager"></a>
43 <h2>FlashCookieManager</h2>
44 <p>
45 Class implementing the Flash cookie manager object.
46 </p>
47 <h3>Derived from</h3>
48 QObject
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>RefreshInterval</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="#FlashCookieManager.__init__">FlashCookieManager</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#FlashCookieManager.__autoRefresh">__autoRefresh</a></td>
64 <td>Private slot to refresh the list of cookies.</td>
65 </tr><tr>
66 <td><a href="#FlashCookieManager.__extractOriginFrom">__extractOriginFrom</a></td>
67 <td>Private method to extract the cookie origin given its file name.</td>
68 </tr><tr>
69 <td><a href="#FlashCookieManager.__insertFlashCookie">__insertFlashCookie</a></td>
70 <td>Private method to insert a Flash cookie into the cache.</td>
71 </tr><tr>
72 <td><a href="#FlashCookieManager.__isBlacklisted">__isBlacklisted</a></td>
73 <td>Private method to check for a blacklisted cookie.</td>
74 </tr><tr>
75 <td><a href="#FlashCookieManager.__isWhitelisted">__isWhitelisted</a></td>
76 <td>Private method to check for a whitelisted cookie.</td>
77 </tr><tr>
78 <td><a href="#FlashCookieManager.__loadFlashCookies">__loadFlashCookies</a></td>
79 <td>Private slot to load the Flash cookies to be cached.</td>
80 </tr><tr>
81 <td><a href="#FlashCookieManager.__loadFlashCookiesFromPath">__loadFlashCookiesFromPath</a></td>
82 <td>Private slot to load the Flash cookies from a path.</td>
83 </tr><tr>
84 <td><a href="#FlashCookieManager.__removeAllButWhitelisted">__removeAllButWhitelisted</a></td>
85 <td>Private method to remove all non-whitelisted cookies.</td>
86 </tr><tr>
87 <td><a href="#FlashCookieManager.__sharedObjectDirName">__sharedObjectDirName</a></td>
88 <td>Private slot to determine the path of the shared data objects.</td>
89 </tr><tr>
90 <td><a href="#FlashCookieManager.__startStopTimer">__startStopTimer</a></td>
91 <td>Private slot to start or stop the auto refresh timer.</td>
92 </tr><tr>
93 <td><a href="#FlashCookieManager.clearCache">clearCache</a></td>
94 <td>Public method to clear the list of cached Flash cookies.</td>
95 </tr><tr>
96 <td><a href="#FlashCookieManager.clearNewOrigins">clearNewOrigins</a></td>
97 <td>Public method to clear the list of newly detected Flash cookies.</td>
98 </tr><tr>
99 <td><a href="#FlashCookieManager.flashCookies">flashCookies</a></td>
100 <td>Public method to get the list of cached Flash cookies.</td>
101 </tr><tr>
102 <td><a href="#FlashCookieManager.flashPlayerDataPath">flashPlayerDataPath</a></td>
103 <td>Public method to get the Flash Player data path.</td>
104 </tr><tr>
105 <td><a href="#FlashCookieManager.newCookiesList">newCookiesList</a></td>
106 <td>Public method to get the list of newly detected Flash cookies.</td>
107 </tr><tr>
108 <td><a href="#FlashCookieManager.preferencesChanged">preferencesChanged</a></td>
109 <td>Public slot to handle a change of preferences.</td>
110 </tr><tr>
111 <td><a href="#FlashCookieManager.removeAllCookies">removeAllCookies</a></td>
112 <td>Public method to remove all flash cookies.</td>
113 </tr><tr>
114 <td><a href="#FlashCookieManager.removeCookie">removeCookie</a></td>
115 <td>Public method to remove a cookie of the list of cached cookies.</td>
116 </tr><tr>
117 <td><a href="#FlashCookieManager.setFlashCookies">setFlashCookies</a></td>
118 <td>Public method to set the list of cached Flash cookies.</td>
119 </tr><tr>
120 <td><a href="#FlashCookieManager.showFlashCookieManagerDialog">showFlashCookieManagerDialog</a></td>
121 <td>Public method to show the Flash cookies management dialog.</td>
122 </tr><tr>
123 <td><a href="#FlashCookieManager.shutdown">shutdown</a></td>
124 <td>Public method to perform shutdown actions.</td>
125 </tr>
126 </table>
127 <h3>Static Methods</h3>
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131 <a NAME="FlashCookieManager.__init__" ID="FlashCookieManager.__init__"></a>
132 <h4>FlashCookieManager (Constructor)</h4>
133 <b>FlashCookieManager</b>(<i>parent=None</i>)
134 <p>
135 Constructor
136 </p><dl>
137 <dt><i>parent</i> (QObject)</dt>
138 <dd>
139 reference to the parent object
140 </dd>
141 </dl><a NAME="FlashCookieManager.__autoRefresh" ID="FlashCookieManager.__autoRefresh"></a>
142 <h4>FlashCookieManager.__autoRefresh</h4>
143 <b>__autoRefresh</b>(<i></i>)
144 <p>
145 Private slot to refresh the list of cookies.
146 </p><a NAME="FlashCookieManager.__extractOriginFrom" ID="FlashCookieManager.__extractOriginFrom"></a>
147 <h4>FlashCookieManager.__extractOriginFrom</h4>
148 <b>__extractOriginFrom</b>(<i>path</i>)
149 <p>
150 Private method to extract the cookie origin given its file name.
151 </p><dl>
152 <dt><i>path</i> (str)</dt>
153 <dd>
154 file name of the cookie file
155 </dd>
156 </dl><dl>
157 <dt>Returns:</dt>
158 <dd>
159 cookie origin
160 </dd>
161 </dl><dl>
162 <dt>Return Type:</dt>
163 <dd>
164 str
165 </dd>
166 </dl><a NAME="FlashCookieManager.__insertFlashCookie" ID="FlashCookieManager.__insertFlashCookie"></a>
167 <h4>FlashCookieManager.__insertFlashCookie</h4>
168 <b>__insertFlashCookie</b>(<i>path</i>)
169 <p>
170 Private method to insert a Flash cookie into the cache.
171 </p><dl>
172 <dt><i>path</i> (str)</dt>
173 <dd>
174 Flash cookies path
175 </dd>
176 </dl><a NAME="FlashCookieManager.__isBlacklisted" ID="FlashCookieManager.__isBlacklisted"></a>
177 <h4>FlashCookieManager.__isBlacklisted</h4>
178 <b>__isBlacklisted</b>(<i>cookie</i>)
179 <p>
180 Private method to check for a blacklisted cookie.
181 </p><dl>
182 <dt><i>cookie</i> (FlashCookie)</dt>
183 <dd>
184 Flash cookie to be tested
185 </dd>
186 </dl><dl>
187 <dt>Returns:</dt>
188 <dd>
189 flag indicating a blacklisted cookie
190 </dd>
191 </dl><dl>
192 <dt>Return Type:</dt>
193 <dd>
194 bool
195 </dd>
196 </dl><a NAME="FlashCookieManager.__isWhitelisted" ID="FlashCookieManager.__isWhitelisted"></a>
197 <h4>FlashCookieManager.__isWhitelisted</h4>
198 <b>__isWhitelisted</b>(<i>cookie</i>)
199 <p>
200 Private method to check for a whitelisted cookie.
201 </p><dl>
202 <dt><i>cookie</i> (FlashCookie)</dt>
203 <dd>
204 Flash cookie to be tested
205 </dd>
206 </dl><dl>
207 <dt>Returns:</dt>
208 <dd>
209 flag indicating a whitelisted cookie
210 </dd>
211 </dl><dl>
212 <dt>Return Type:</dt>
213 <dd>
214 bool
215 </dd>
216 </dl><a NAME="FlashCookieManager.__loadFlashCookies" ID="FlashCookieManager.__loadFlashCookies"></a>
217 <h4>FlashCookieManager.__loadFlashCookies</h4>
218 <b>__loadFlashCookies</b>(<i></i>)
219 <p>
220 Private slot to load the Flash cookies to be cached.
221 </p><a NAME="FlashCookieManager.__loadFlashCookiesFromPath" ID="FlashCookieManager.__loadFlashCookiesFromPath"></a>
222 <h4>FlashCookieManager.__loadFlashCookiesFromPath</h4>
223 <b>__loadFlashCookiesFromPath</b>(<i>path</i>)
224 <p>
225 Private slot to load the Flash cookies from a path.
226 </p><dl>
227 <dt><i>path</i> (str)</dt>
228 <dd>
229 Flash cookies path
230 </dd>
231 </dl><a NAME="FlashCookieManager.__removeAllButWhitelisted" ID="FlashCookieManager.__removeAllButWhitelisted"></a>
232 <h4>FlashCookieManager.__removeAllButWhitelisted</h4>
233 <b>__removeAllButWhitelisted</b>(<i></i>)
234 <p>
235 Private method to remove all non-whitelisted cookies.
236 </p><a NAME="FlashCookieManager.__sharedObjectDirName" ID="FlashCookieManager.__sharedObjectDirName"></a>
237 <h4>FlashCookieManager.__sharedObjectDirName</h4>
238 <b>__sharedObjectDirName</b>(<i></i>)
239 <p>
240 Private slot to determine the path of the shared data objects.
241 </p><dl>
242 <dt>Returns:</dt>
243 <dd>
244 path of the shared data objects
245 </dd>
246 </dl><dl>
247 <dt>Return Type:</dt>
248 <dd>
249 str
250 </dd>
251 </dl><a NAME="FlashCookieManager.__startStopTimer" ID="FlashCookieManager.__startStopTimer"></a>
252 <h4>FlashCookieManager.__startStopTimer</h4>
253 <b>__startStopTimer</b>(<i></i>)
254 <p>
255 Private slot to start or stop the auto refresh timer.
256 </p><a NAME="FlashCookieManager.clearCache" ID="FlashCookieManager.clearCache"></a>
257 <h4>FlashCookieManager.clearCache</h4>
258 <b>clearCache</b>(<i></i>)
259 <p>
260 Public method to clear the list of cached Flash cookies.
261 </p><a NAME="FlashCookieManager.clearNewOrigins" ID="FlashCookieManager.clearNewOrigins"></a>
262 <h4>FlashCookieManager.clearNewOrigins</h4>
263 <b>clearNewOrigins</b>(<i></i>)
264 <p>
265 Public method to clear the list of newly detected Flash cookies.
266 </p><a NAME="FlashCookieManager.flashCookies" ID="FlashCookieManager.flashCookies"></a>
267 <h4>FlashCookieManager.flashCookies</h4>
268 <b>flashCookies</b>(<i></i>)
269 <p>
270 Public method to get the list of cached Flash cookies.
271 </p><dl>
272 <dt>Returns:</dt>
273 <dd>
274 list of Flash cookies
275 </dd>
276 </dl><dl>
277 <dt>Return Type:</dt>
278 <dd>
279 list of FlashCookie
280 </dd>
281 </dl><a NAME="FlashCookieManager.flashPlayerDataPath" ID="FlashCookieManager.flashPlayerDataPath"></a>
282 <h4>FlashCookieManager.flashPlayerDataPath</h4>
283 <b>flashPlayerDataPath</b>(<i></i>)
284 <p>
285 Public method to get the Flash Player data path.
286 </p><dl>
287 <dt>Returns:</dt>
288 <dd>
289 Flash Player data path
290 </dd>
291 </dl><dl>
292 <dt>Return Type:</dt>
293 <dd>
294 str
295 </dd>
296 </dl><a NAME="FlashCookieManager.newCookiesList" ID="FlashCookieManager.newCookiesList"></a>
297 <h4>FlashCookieManager.newCookiesList</h4>
298 <b>newCookiesList</b>(<i></i>)
299 <p>
300 Public method to get the list of newly detected Flash cookies.
301 </p><dl>
302 <dt>Returns:</dt>
303 <dd>
304 list of newly detected Flash cookies
305 </dd>
306 </dl><dl>
307 <dt>Return Type:</dt>
308 <dd>
309 list of str
310 </dd>
311 </dl><a NAME="FlashCookieManager.preferencesChanged" ID="FlashCookieManager.preferencesChanged"></a>
312 <h4>FlashCookieManager.preferencesChanged</h4>
313 <b>preferencesChanged</b>(<i></i>)
314 <p>
315 Public slot to handle a change of preferences.
316 </p><a NAME="FlashCookieManager.removeAllCookies" ID="FlashCookieManager.removeAllCookies"></a>
317 <h4>FlashCookieManager.removeAllCookies</h4>
318 <b>removeAllCookies</b>(<i></i>)
319 <p>
320 Public method to remove all flash cookies.
321 </p><a NAME="FlashCookieManager.removeCookie" ID="FlashCookieManager.removeCookie"></a>
322 <h4>FlashCookieManager.removeCookie</h4>
323 <b>removeCookie</b>(<i>cookie</i>)
324 <p>
325 Public method to remove a cookie of the list of cached cookies.
326 </p><dl>
327 <dt><i>cookie</i> (FlashCookie)</dt>
328 <dd>
329 Flash cookie to be removed
330 </dd>
331 </dl><a NAME="FlashCookieManager.setFlashCookies" ID="FlashCookieManager.setFlashCookies"></a>
332 <h4>FlashCookieManager.setFlashCookies</h4>
333 <b>setFlashCookies</b>(<i>cookies</i>)
334 <p>
335 Public method to set the list of cached Flash cookies.
336 </p><dl>
337 <dt><i>cookies</i> (list of FlashCookie)</dt>
338 <dd>
339 list of Flash cookies to store
340 </dd>
341 </dl><a NAME="FlashCookieManager.showFlashCookieManagerDialog" ID="FlashCookieManager.showFlashCookieManagerDialog"></a>
342 <h4>FlashCookieManager.showFlashCookieManagerDialog</h4>
343 <b>showFlashCookieManagerDialog</b>(<i></i>)
344 <p>
345 Public method to show the Flash cookies management dialog.
346 </p><a NAME="FlashCookieManager.shutdown" ID="FlashCookieManager.shutdown"></a>
347 <h4>FlashCookieManager.shutdown</h4>
348 <b>shutdown</b>(<i></i>)
349 <p>
350 Public method to perform shutdown actions.
351 </p>
352 <div align="right"><a href="#top">Up</a></div>
353 <hr />
354 </body></html>

Mercurial Repository: eric

eric ide

mercurial