Mercurial Repositories > eric / file comparison

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

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

Mercurial Repository: eric

eric ide

mercurial