Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash.html

Documentation/Source/eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash.html

changeset 1651
bc68f24d5658
child 2367
78f6c8193d37
equal deleted inserted replaced
1649:1b7cd7409170 1651:bc68f24d5658
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Helpviewer.WebPlugins.ClickToFlash.ClickToFlash</h1>
24 <p>
25 Module implementing the Flash blocker.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ClickToFlash">ClickToFlash</a></td>
35 <td>Class implementing the Flash blocker.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="ClickToFlash" ID="ClickToFlash"></a>
44 <h2>ClickToFlash</h2>
45 <p>
46 Class implementing the Flash blocker.
47 </p>
48 <h3>Derived from</h3>
49 QWidget, Ui_ClickToFlash
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>_acceptedArgNames</td></tr><tr><td>_acceptedArgValues</td></tr><tr><td>_acceptedUrl</td></tr>
53 </table>
54 <h3>Class Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#ClickToFlash.isAlreadyAccepted">isAlreadyAccepted</a></td>
58 <td>Class method to check, if the given parameter combination is being accepted.</td>
59 </tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#ClickToFlash.__init__">ClickToFlash</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#ClickToFlash.__addToWhitelist">__addToWhitelist</a></td>
68 <td>Private slot to add the host to the whitelist.</td>
69 </tr><tr>
70 <td><a href="#ClickToFlash.__checkElement">__checkElement</a></td>
71 <td>Private slot to check an element against the saved arguments.</td>
72 </tr><tr>
73 <td><a href="#ClickToFlash.__checkUrlOnElement">__checkUrlOnElement</a></td>
74 <td>Private slot to check the URL of an element.</td>
75 </tr><tr>
76 <td><a href="#ClickToFlash.__configure">__configure</a></td>
77 <td>Private slot to configure the whitelist.</td>
78 </tr><tr>
79 <td><a href="#ClickToFlash.__elide">__elide</a></td>
80 <td>Private method to elide some text.</td>
81 </tr><tr>
82 <td><a href="#ClickToFlash.__findElement">__findElement</a></td>
83 <td>Private method to find the element belonging to this ClickToFlash instance.</td>
84 </tr><tr>
85 <td><a href="#ClickToFlash.__hideAdBlocked">__hideAdBlocked</a></td>
86 <td>Private slot to hide the object.</td>
87 </tr><tr>
88 <td><a href="#ClickToFlash.__load">__load</a></td>
89 <td>Private slot to load the flash content.</td>
90 </tr><tr>
91 <td><a href="#ClickToFlash.__removeFromWhitelist">__removeFromWhitelist</a></td>
92 <td>Private slot to remove the host from the whitelist.</td>
93 </tr><tr>
94 <td><a href="#ClickToFlash.__showContextMenu">__showContextMenu</a></td>
95 <td>Private slot to show the context menu.</td>
96 </tr><tr>
97 <td><a href="#ClickToFlash.__showInfo">__showInfo</a></td>
98 <td>Private slot to show information about the blocked object.</td>
99 </tr><tr>
100 <td><a href="#ClickToFlash.on_loadFlashButton_clicked">on_loadFlashButton_clicked</a></td>
101 <td>Private slot handling the flash activation.</td>
102 </tr><tr>
103 <td><a href="#ClickToFlash.swapping">swapping</a></td>
104 <td>Public method to check, if the plug-in is swapping.</td>
105 </tr>
106 </table>
107 <h3>Static Methods</h3>
108 <table>
109 <tr><td>None</td></tr>
110 </table>
111 <a NAME="ClickToFlash.isAlreadyAccepted" ID="ClickToFlash.isAlreadyAccepted"></a>
112 <h4>ClickToFlash.isAlreadyAccepted (class method)</h4>
113 <b>isAlreadyAccepted</b>(<i>url, argumentNames, argumentValues</i>)
114 <p>
115 Class method to check, if the given parameter combination is being accepted.
116 </p><dl>
117 <dt><i>url</i></dt>
118 <dd>
119 URL to be checked for (QUrl)
120 </dd><dt><i>argumentNames</i></dt>
121 <dd>
122 argument names to be checked for (list of strings)
123 </dd><dt><i>argumentValues</i></dt>
124 <dd>
125 argument values to be checked for (list of strings)
126 </dd>
127 </dl><a NAME="ClickToFlash.__init__" ID="ClickToFlash.__init__"></a>
128 <h4>ClickToFlash (Constructor)</h4>
129 <b>ClickToFlash</b>(<i>plugin, mimeType, url, argumentNames, argumentValues, parent=None</i>)
130 <p>
131 Constructor
132 </p><dl>
133 <dt><i>plugin</i></dt>
134 <dd>
135 reference to the plug-in (ClickToFlashPlugin)
136 </dd><dt><i>mimeType</i></dt>
137 <dd>
138 MIME type for the plug-in (string)
139 </dd><dt><i>url</i></dt>
140 <dd>
141 requested URL (QUrl)
142 </dd><dt><i>argumentNames</i></dt>
143 <dd>
144 list of argument names (list of strings)
145 </dd><dt><i>argumentValues</i></dt>
146 <dd>
147 list of argument values (list of strings)
148 </dd><dt><i>parent</i></dt>
149 <dd>
150 reference to the parent widget (QWidget)
151 </dd>
152 </dl><a NAME="ClickToFlash.__addToWhitelist" ID="ClickToFlash.__addToWhitelist"></a>
153 <h4>ClickToFlash.__addToWhitelist</h4>
154 <b>__addToWhitelist</b>(<i></i>)
155 <p>
156 Private slot to add the host to the whitelist.
157 </p><a NAME="ClickToFlash.__checkElement" ID="ClickToFlash.__checkElement"></a>
158 <h4>ClickToFlash.__checkElement</h4>
159 <b>__checkElement</b>(<i>element</i>)
160 <p>
161 Private slot to check an element against the saved arguments.
162 </p><dl>
163 <dt><i>element</i></dt>
164 <dd>
165 reference to the element to check (QWebElement)
166 </dd>
167 </dl><dl>
168 <dt>Returns:</dt>
169 <dd>
170 flag indicating a positive result (boolean)
171 </dd>
172 </dl><a NAME="ClickToFlash.__checkUrlOnElement" ID="ClickToFlash.__checkUrlOnElement"></a>
173 <h4>ClickToFlash.__checkUrlOnElement</h4>
174 <b>__checkUrlOnElement</b>(<i>element, view</i>)
175 <p>
176 Private slot to check the URL of an element.
177 </p><dl>
178 <dt><i>element</i></dt>
179 <dd>
180 reference to the element to check (QWebElement)
181 </dd><dt><i>view</i></dt>
182 <dd>
183 reference to the view object (QWebView)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 flag indicating a positive result (boolean)
189 </dd>
190 </dl><a NAME="ClickToFlash.__configure" ID="ClickToFlash.__configure"></a>
191 <h4>ClickToFlash.__configure</h4>
192 <b>__configure</b>(<i></i>)
193 <p>
194 Private slot to configure the whitelist.
195 </p><a NAME="ClickToFlash.__elide" ID="ClickToFlash.__elide"></a>
196 <h4>ClickToFlash.__elide</h4>
197 <b>__elide</b>(<i>txt, mode=Qt.ElideMiddle, length=40</i>)
198 <p>
199 Private method to elide some text.
200 </p><dl>
201 <dt><i>txt</i></dt>
202 <dd>
203 text to be elided (string)
204 </dd><dt><i>mode=</i></dt>
205 <dd>
206 elide mode (Qt.TextElideMode)
207 </dd><dt><i>length=</i></dt>
208 <dd>
209 amount of characters to be used (integer)
210 </dd>
211 </dl><dl>
212 <dt>Returns:</dt>
213 <dd>
214 the elided text (string)
215 </dd>
216 </dl><a NAME="ClickToFlash.__findElement" ID="ClickToFlash.__findElement"></a>
217 <h4>ClickToFlash.__findElement</h4>
218 <b>__findElement</b>(<i></i>)
219 <p>
220 Private method to find the element belonging to this ClickToFlash instance.
221 </p><a NAME="ClickToFlash.__hideAdBlocked" ID="ClickToFlash.__hideAdBlocked"></a>
222 <h4>ClickToFlash.__hideAdBlocked</h4>
223 <b>__hideAdBlocked</b>(<i></i>)
224 <p>
225 Private slot to hide the object.
226 </p><a NAME="ClickToFlash.__load" ID="ClickToFlash.__load"></a>
227 <h4>ClickToFlash.__load</h4>
228 <b>__load</b>(<i>all=False</i>)
229 <p>
230 Private slot to load the flash content.
231 </p><dl>
232 <dt><i>all</i></dt>
233 <dd>
234 flag indicating to load all flash players. (boolean)
235 </dd>
236 </dl><a NAME="ClickToFlash.__removeFromWhitelist" ID="ClickToFlash.__removeFromWhitelist"></a>
237 <h4>ClickToFlash.__removeFromWhitelist</h4>
238 <b>__removeFromWhitelist</b>(<i></i>)
239 <p>
240 Private slot to remove the host from the whitelist.
241 </p><a NAME="ClickToFlash.__showContextMenu" ID="ClickToFlash.__showContextMenu"></a>
242 <h4>ClickToFlash.__showContextMenu</h4>
243 <b>__showContextMenu</b>(<i></i>)
244 <p>
245 Private slot to show the context menu.
246 </p><a NAME="ClickToFlash.__showInfo" ID="ClickToFlash.__showInfo"></a>
247 <h4>ClickToFlash.__showInfo</h4>
248 <b>__showInfo</b>(<i></i>)
249 <p>
250 Private slot to show information about the blocked object.
251 </p><a NAME="ClickToFlash.on_loadFlashButton_clicked" ID="ClickToFlash.on_loadFlashButton_clicked"></a>
252 <h4>ClickToFlash.on_loadFlashButton_clicked</h4>
253 <b>on_loadFlashButton_clicked</b>(<i></i>)
254 <p>
255 Private slot handling the flash activation.
256 </p><a NAME="ClickToFlash.swapping" ID="ClickToFlash.swapping"></a>
257 <h4>ClickToFlash.swapping</h4>
258 <b>swapping</b>(<i></i>)
259 <p>
260 Public method to check, if the plug-in is swapping.
261 </p><dl>
262 <dt>Returns:</dt>
263 <dd>
264 flag indicating the swapping status (boolean)
265 </dd>
266 </dl>
267 <div align="right"><a href="#top">Up</a></div>
268 <hr />
269 </body></html>

Mercurial Repository: eric

eric ide

mercurial