eric6/Documentation/Source/eric6.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashPlugin.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.WebPlugins.ClickToFlash.ClickToFlashPlugin</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.WebPlugins.ClickToFlash.ClickToFlashPlugin</h1>
23 <p>
24 Module implementing the Flash blocker plug-in.
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="#ClickToFlashPlugin">ClickToFlashPlugin</a></td>
34 <td>Class implementing the flash blocker plug-in.</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="ClickToFlashPlugin" ID="ClickToFlashPlugin"></a>
43 <h2>ClickToFlashPlugin</h2>
44 <p>
45 Class implementing the flash blocker plug-in.
46 </p>
47 <h3>Derived from</h3>
48 WebPluginInterface
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>ClickToFlashData</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr>
56 <td><a href="#ClickToFlashPlugin.getIconName">getIconName</a></td>
57 <td>Class method to get the icon name for the mime type.</td>
58 </tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#ClickToFlashPlugin.__init__">ClickToFlashPlugin</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#ClickToFlashPlugin.__enabled">__enabled</a></td>
67 <td>Private method to check, if the plug-in is enabled.</td>
68 </tr><tr>
69 <td><a href="#ClickToFlashPlugin.__load">__load</a></td>
70 <td>Private method to load the configuration.</td>
71 </tr><tr>
72 <td><a href="#ClickToFlashPlugin.__save">__save</a></td>
73 <td>Private method to save the configuration.</td>
74 </tr><tr>
75 <td><a href="#ClickToFlashPlugin.addToWhitelist">addToWhitelist</a></td>
76 <td>Public method to add a host to the whitelist.</td>
77 </tr><tr>
78 <td><a href="#ClickToFlashPlugin.configure">configure</a></td>
79 <td>Public method to configure the plug-in.</td>
80 </tr><tr>
81 <td><a href="#ClickToFlashPlugin.create">create</a></td>
82 <td>Public method to create a plug-in instance for the given data.</td>
83 </tr><tr>
84 <td><a href="#ClickToFlashPlugin.isAnonymous">isAnonymous</a></td>
85 <td>Public method to indicate an anonymous plug-in.</td>
86 </tr><tr>
87 <td><a href="#ClickToFlashPlugin.metaPlugin">metaPlugin</a></td>
88 <td>Public method to create a meta plug-in object containing plug-in info.</td>
89 </tr><tr>
90 <td><a href="#ClickToFlashPlugin.onWhitelist">onWhitelist</a></td>
91 <td>Public method to check, if a host is on the whitelist.</td>
92 </tr><tr>
93 <td><a href="#ClickToFlashPlugin.removeFromWhitelist">removeFromWhitelist</a></td>
94 <td>Public method to remove a host from the whitelist.</td>
95 </tr>
96 </table>
97 <h3>Static Methods</h3>
98 <table>
99 <tr><td>None</td></tr>
100 </table>
101 <a NAME="ClickToFlashPlugin.getIconName" ID="ClickToFlashPlugin.getIconName"></a>
102 <h4>ClickToFlashPlugin.getIconName (class method)</h4>
103 <b>getIconName</b>(<i>mimeType</i>)
104 <p>
105 Class method to get the icon name for the mime type.
106 </p><dl>
107 <dt><i>mimeType</i></dt>
108 <dd>
109 mime type to get the icon for (string)
110 </dd>
111 </dl><dl>
112 <dt>Returns:</dt>
113 <dd>
114 name of the icon file (string)
115 </dd>
116 </dl><a NAME="ClickToFlashPlugin.__init__" ID="ClickToFlashPlugin.__init__"></a>
117 <h4>ClickToFlashPlugin (Constructor)</h4>
118 <b>ClickToFlashPlugin</b>(<i></i>)
119 <p>
120 Constructor
121 </p><a NAME="ClickToFlashPlugin.__enabled" ID="ClickToFlashPlugin.__enabled"></a>
122 <h4>ClickToFlashPlugin.__enabled</h4>
123 <b>__enabled</b>(<i></i>)
124 <p>
125 Private method to check, if the plug-in is enabled.
126 </p><dl>
127 <dt>Returns:</dt>
128 <dd>
129 enabled status (boolean)
130 </dd>
131 </dl><a NAME="ClickToFlashPlugin.__load" ID="ClickToFlashPlugin.__load"></a>
132 <h4>ClickToFlashPlugin.__load</h4>
133 <b>__load</b>(<i></i>)
134 <p>
135 Private method to load the configuration.
136 </p><a NAME="ClickToFlashPlugin.__save" ID="ClickToFlashPlugin.__save"></a>
137 <h4>ClickToFlashPlugin.__save</h4>
138 <b>__save</b>(<i></i>)
139 <p>
140 Private method to save the configuration.
141 </p><a NAME="ClickToFlashPlugin.addToWhitelist" ID="ClickToFlashPlugin.addToWhitelist"></a>
142 <h4>ClickToFlashPlugin.addToWhitelist</h4>
143 <b>addToWhitelist</b>(<i>host</i>)
144 <p>
145 Public method to add a host to the whitelist.
146 </p><dl>
147 <dt><i>host</i></dt>
148 <dd>
149 host to be added (string)
150 </dd>
151 </dl><a NAME="ClickToFlashPlugin.configure" ID="ClickToFlashPlugin.configure"></a>
152 <h4>ClickToFlashPlugin.configure</h4>
153 <b>configure</b>(<i></i>)
154 <p>
155 Public method to configure the plug-in.
156 </p><a NAME="ClickToFlashPlugin.create" ID="ClickToFlashPlugin.create"></a>
157 <h4>ClickToFlashPlugin.create</h4>
158 <b>create</b>(<i>mimeType, url, argumentNames, argumentValues</i>)
159 <p>
160 Public method to create a plug-in instance for the given data.
161 </p><dl>
162 <dt><i>mimeType</i></dt>
163 <dd>
164 MIME type for the plug-in (string)
165 </dd><dt><i>url</i></dt>
166 <dd>
167 URL for the plug-in (QUrl)
168 </dd><dt><i>argumentNames</i></dt>
169 <dd>
170 list of argument names (list of strings)
171 </dd><dt><i>argumentValues</i></dt>
172 <dd>
173 list of argument values (list of strings)
174 </dd>
175 </dl><dl>
176 <dt>Returns:</dt>
177 <dd>
178 reference to the created object (QWidget)
179 </dd>
180 </dl><a NAME="ClickToFlashPlugin.isAnonymous" ID="ClickToFlashPlugin.isAnonymous"></a>
181 <h4>ClickToFlashPlugin.isAnonymous</h4>
182 <b>isAnonymous</b>(<i></i>)
183 <p>
184 Public method to indicate an anonymous plug-in.
185 </p><dl>
186 <dt>Returns:</dt>
187 <dd>
188 flag indicating anonymous state (boolean)
189 </dd>
190 </dl><a NAME="ClickToFlashPlugin.metaPlugin" ID="ClickToFlashPlugin.metaPlugin"></a>
191 <h4>ClickToFlashPlugin.metaPlugin</h4>
192 <b>metaPlugin</b>(<i></i>)
193 <p>
194 Public method to create a meta plug-in object containing plug-in info.
195 </p><dl>
196 <dt>Returns:</dt>
197 <dd>
198 meta plug-in object (QWebPluginFactory.Plugin)
199 </dd>
200 </dl><a NAME="ClickToFlashPlugin.onWhitelist" ID="ClickToFlashPlugin.onWhitelist"></a>
201 <h4>ClickToFlashPlugin.onWhitelist</h4>
202 <b>onWhitelist</b>(<i>host</i>)
203 <p>
204 Public method to check, if a host is on the whitelist.
205 </p><dl>
206 <dt><i>host</i></dt>
207 <dd>
208 host to check for (string)
209 </dd>
210 </dl><dl>
211 <dt>Returns:</dt>
212 <dd>
213 flag indicating presence in the whitelist (boolean)
214 </dd>
215 </dl><a NAME="ClickToFlashPlugin.removeFromWhitelist" ID="ClickToFlashPlugin.removeFromWhitelist"></a>
216 <h4>ClickToFlashPlugin.removeFromWhitelist</h4>
217 <b>removeFromWhitelist</b>(<i>host</i>)
218 <p>
219 Public method to remove a host from the whitelist.
220 </p><dl>
221 <dt><i>host</i></dt>
222 <dd>
223 host to be removed (string)
224 </dd>
225 </dl>
226 <div align="right"><a href="#top">Up</a></div>
227 <hr />
228 </body></html>

eric ide

mercurial