Documentation/Source/eric6.Helpviewer.FlashCookieManager.FlashCookieManager.html

changeset 6942
2602857055c5
parent 6941
f99d60d6b59b
child 6943
da5c9f5c11c6
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.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.Helpviewer.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.removeCookie">removeCookie</a></td>
112 <td>Public method to remove a cookie of the list of cached cookies.</td>
113 </tr><tr>
114 <td><a href="#FlashCookieManager.setFlashCookies">setFlashCookies</a></td>
115 <td>Public method to set the list of cached Flash cookies.</td>
116 </tr><tr>
117 <td><a href="#FlashCookieManager.showFlashCookieManagerDialog">showFlashCookieManagerDialog</a></td>
118 <td>Public method to show the Flash cookies management dialog.</td>
119 </tr><tr>
120 <td><a href="#FlashCookieManager.shutdown">shutdown</a></td>
121 <td>Public method to perform shutdown actions.</td>
122 </tr>
123 </table>
124 <h3>Static Methods</h3>
125 <table>
126 <tr><td>None</td></tr>
127 </table>
128 <a NAME="FlashCookieManager.__init__" ID="FlashCookieManager.__init__"></a>
129 <h4>FlashCookieManager (Constructor)</h4>
130 <b>FlashCookieManager</b>(<i>parent=None</i>)
131 <p>
132 Constructor
133 </p><dl>
134 <dt><i>parent</i> (QObject)</dt>
135 <dd>
136 reference to the parent object
137 </dd>
138 </dl><a NAME="FlashCookieManager.__autoRefresh" ID="FlashCookieManager.__autoRefresh"></a>
139 <h4>FlashCookieManager.__autoRefresh</h4>
140 <b>__autoRefresh</b>(<i></i>)
141 <p>
142 Private slot to refresh the list of cookies.
143 </p><a NAME="FlashCookieManager.__extractOriginFrom" ID="FlashCookieManager.__extractOriginFrom"></a>
144 <h4>FlashCookieManager.__extractOriginFrom</h4>
145 <b>__extractOriginFrom</b>(<i>path</i>)
146 <p>
147 Private method to extract the cookie origin given its file name.
148 </p><dl>
149 <dt><i>path</i> (str)</dt>
150 <dd>
151 file name of the cookie file
152 </dd>
153 </dl><dl>
154 <dt>Returns:</dt>
155 <dd>
156 cookie origin
157 </dd>
158 </dl><dl>
159 <dt>Return Type:</dt>
160 <dd>
161 str
162 </dd>
163 </dl><a NAME="FlashCookieManager.__insertFlashCookie" ID="FlashCookieManager.__insertFlashCookie"></a>
164 <h4>FlashCookieManager.__insertFlashCookie</h4>
165 <b>__insertFlashCookie</b>(<i>path</i>)
166 <p>
167 Private method to insert a Flash cookie into the cache.
168 </p><dl>
169 <dt><i>path</i> (str)</dt>
170 <dd>
171 Flash cookies path
172 </dd>
173 </dl><a NAME="FlashCookieManager.__isBlacklisted" ID="FlashCookieManager.__isBlacklisted"></a>
174 <h4>FlashCookieManager.__isBlacklisted</h4>
175 <b>__isBlacklisted</b>(<i>cookie</i>)
176 <p>
177 Private method to check for a blacklisted cookie.
178 </p><dl>
179 <dt><i>cookie</i> (FlashCookie)</dt>
180 <dd>
181 Flash cookie to be tested
182 </dd>
183 </dl><dl>
184 <dt>Returns:</dt>
185 <dd>
186 flag indicating a blacklisted cookie
187 </dd>
188 </dl><dl>
189 <dt>Return Type:</dt>
190 <dd>
191 bool
192 </dd>
193 </dl><a NAME="FlashCookieManager.__isWhitelisted" ID="FlashCookieManager.__isWhitelisted"></a>
194 <h4>FlashCookieManager.__isWhitelisted</h4>
195 <b>__isWhitelisted</b>(<i>cookie</i>)
196 <p>
197 Private method to check for a whitelisted cookie.
198 </p><dl>
199 <dt><i>cookie</i> (FlashCookie)</dt>
200 <dd>
201 Flash cookie to be tested
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 flag indicating a whitelisted cookie
207 </dd>
208 </dl><dl>
209 <dt>Return Type:</dt>
210 <dd>
211 bool
212 </dd>
213 </dl><a NAME="FlashCookieManager.__loadFlashCookies" ID="FlashCookieManager.__loadFlashCookies"></a>
214 <h4>FlashCookieManager.__loadFlashCookies</h4>
215 <b>__loadFlashCookies</b>(<i></i>)
216 <p>
217 Private slot to load the Flash cookies to be cached.
218 </p><a NAME="FlashCookieManager.__loadFlashCookiesFromPath" ID="FlashCookieManager.__loadFlashCookiesFromPath"></a>
219 <h4>FlashCookieManager.__loadFlashCookiesFromPath</h4>
220 <b>__loadFlashCookiesFromPath</b>(<i>path</i>)
221 <p>
222 Private slot to load the Flash cookies from a path.
223 </p><dl>
224 <dt><i>path</i> (str)</dt>
225 <dd>
226 Flash cookies path
227 </dd>
228 </dl><a NAME="FlashCookieManager.__removeAllButWhitelisted" ID="FlashCookieManager.__removeAllButWhitelisted"></a>
229 <h4>FlashCookieManager.__removeAllButWhitelisted</h4>
230 <b>__removeAllButWhitelisted</b>(<i></i>)
231 <p>
232 Private method to remove all non-whitelisted cookies.
233 </p><a NAME="FlashCookieManager.__sharedObjectDirName" ID="FlashCookieManager.__sharedObjectDirName"></a>
234 <h4>FlashCookieManager.__sharedObjectDirName</h4>
235 <b>__sharedObjectDirName</b>(<i></i>)
236 <p>
237 Private slot to determine the path of the shared data objects.
238 </p><dl>
239 <dt>Returns:</dt>
240 <dd>
241 path of the shared data objects
242 </dd>
243 </dl><dl>
244 <dt>Return Type:</dt>
245 <dd>
246 str
247 </dd>
248 </dl><a NAME="FlashCookieManager.__startStopTimer" ID="FlashCookieManager.__startStopTimer"></a>
249 <h4>FlashCookieManager.__startStopTimer</h4>
250 <b>__startStopTimer</b>(<i></i>)
251 <p>
252 Private slot to start or stop the auto refresh timer.
253 </p><a NAME="FlashCookieManager.clearCache" ID="FlashCookieManager.clearCache"></a>
254 <h4>FlashCookieManager.clearCache</h4>
255 <b>clearCache</b>(<i></i>)
256 <p>
257 Public method to clear the list of cached Flash cookies.
258 </p><a NAME="FlashCookieManager.clearNewOrigins" ID="FlashCookieManager.clearNewOrigins"></a>
259 <h4>FlashCookieManager.clearNewOrigins</h4>
260 <b>clearNewOrigins</b>(<i></i>)
261 <p>
262 Public method to clear the list of newly detected Flash cookies.
263 </p><a NAME="FlashCookieManager.flashCookies" ID="FlashCookieManager.flashCookies"></a>
264 <h4>FlashCookieManager.flashCookies</h4>
265 <b>flashCookies</b>(<i></i>)
266 <p>
267 Public method to get the list of cached Flash cookies.
268 </p><dl>
269 <dt>Returns:</dt>
270 <dd>
271 list of Flash cookies
272 </dd>
273 </dl><dl>
274 <dt>Return Type:</dt>
275 <dd>
276 list of FlashCookie
277 </dd>
278 </dl><a NAME="FlashCookieManager.flashPlayerDataPath" ID="FlashCookieManager.flashPlayerDataPath"></a>
279 <h4>FlashCookieManager.flashPlayerDataPath</h4>
280 <b>flashPlayerDataPath</b>(<i></i>)
281 <p>
282 Public method to get the Flash Player data path.
283 </p><dl>
284 <dt>Returns:</dt>
285 <dd>
286 Flash Player data path
287 </dd>
288 </dl><dl>
289 <dt>Return Type:</dt>
290 <dd>
291 str
292 </dd>
293 </dl><a NAME="FlashCookieManager.newCookiesList" ID="FlashCookieManager.newCookiesList"></a>
294 <h4>FlashCookieManager.newCookiesList</h4>
295 <b>newCookiesList</b>(<i></i>)
296 <p>
297 Public method to get the list of newly detected Flash cookies.
298 </p><dl>
299 <dt>Returns:</dt>
300 <dd>
301 list of newly detected Flash cookies
302 </dd>
303 </dl><dl>
304 <dt>Return Type:</dt>
305 <dd>
306 list of str
307 </dd>
308 </dl><a NAME="FlashCookieManager.preferencesChanged" ID="FlashCookieManager.preferencesChanged"></a>
309 <h4>FlashCookieManager.preferencesChanged</h4>
310 <b>preferencesChanged</b>(<i></i>)
311 <p>
312 Public slot to handle a change of preferences.
313 </p><a NAME="FlashCookieManager.removeCookie" ID="FlashCookieManager.removeCookie"></a>
314 <h4>FlashCookieManager.removeCookie</h4>
315 <b>removeCookie</b>(<i>cookie</i>)
316 <p>
317 Public method to remove a cookie of the list of cached cookies.
318 </p><dl>
319 <dt><i>cookie</i> (FlashCookie)</dt>
320 <dd>
321 Flash cookie to be removed
322 </dd>
323 </dl><a NAME="FlashCookieManager.setFlashCookies" ID="FlashCookieManager.setFlashCookies"></a>
324 <h4>FlashCookieManager.setFlashCookies</h4>
325 <b>setFlashCookies</b>(<i>cookies</i>)
326 <p>
327 Public method to set the list of cached Flash cookies.
328 </p><dl>
329 <dt><i>cookies</i> (list of FlashCookie)</dt>
330 <dd>
331 list of Flash cookies to store
332 </dd>
333 </dl><a NAME="FlashCookieManager.showFlashCookieManagerDialog" ID="FlashCookieManager.showFlashCookieManagerDialog"></a>
334 <h4>FlashCookieManager.showFlashCookieManagerDialog</h4>
335 <b>showFlashCookieManagerDialog</b>(<i></i>)
336 <p>
337 Public method to show the Flash cookies management dialog.
338 </p><a NAME="FlashCookieManager.shutdown" ID="FlashCookieManager.shutdown"></a>
339 <h4>FlashCookieManager.shutdown</h4>
340 <b>shutdown</b>(<i></i>)
341 <p>
342 Public method to perform shutdown actions.
343 </p>
344 <div align="right"><a href="#top">Up</a></div>
345 <hr />
346 </body></html>

eric ide

mercurial