eric6/Documentation/Source/eric6.Helpviewer.WebPlugins.WebPluginInterface.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.WebPluginInterface</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.WebPluginInterface</h1>
23 <p>
24 Module implementing the web plug-in interface.
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="#WebPluginInterface">WebPluginInterface</a></td>
34 <td>Class implementing the web plug-in interface.</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="WebPluginInterface" ID="WebPluginInterface"></a>
43 <h2>WebPluginInterface</h2>
44 <p>
45 Class implementing the web plug-in interface.
46 </p>
47 <h3>Derived from</h3>
48 object
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</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="#WebPluginInterface.configure">configure</a></td>
61 <td>Public method to configure the plug-in.</td>
62 </tr><tr>
63 <td><a href="#WebPluginInterface.create">create</a></td>
64 <td>Public method to create a plug-in instance for the given data.</td>
65 </tr><tr>
66 <td><a href="#WebPluginInterface.isAnonymous">isAnonymous</a></td>
67 <td>Public method to indicate an anonymous plug-in.</td>
68 </tr><tr>
69 <td><a href="#WebPluginInterface.metaPlugin">metaPlugin</a></td>
70 <td>Public method to create a meta plug-in object containing plug-in info.</td>
71 </tr>
72 </table>
73 <h3>Static Methods</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <a NAME="WebPluginInterface.configure" ID="WebPluginInterface.configure"></a>
78 <h4>WebPluginInterface.configure</h4>
79 <b>configure</b>(<i></i>)
80 <p>
81 Public method to configure the plug-in.
82 </p><dl>
83 <dt>Raises <b>NotImplementedError</b>:</dt>
84 <dd>
85 raised to indicate that this method
86 must be implemented by subclasses
87 </dd>
88 </dl><a NAME="WebPluginInterface.create" ID="WebPluginInterface.create"></a>
89 <h4>WebPluginInterface.create</h4>
90 <b>create</b>(<i>mimeType, url, argumentNames, argumentValues</i>)
91 <p>
92 Public method to create a plug-in instance for the given data.
93 </p><dl>
94 <dt><i>mimeType</i></dt>
95 <dd>
96 MIME type for the plug-in (string)
97 </dd><dt><i>url</i></dt>
98 <dd>
99 URL for the plug-in (QUrl)
100 </dd><dt><i>argumentNames</i></dt>
101 <dd>
102 list of argument names (list of strings)
103 </dd><dt><i>argumentValues</i></dt>
104 <dd>
105 list of argument values (list of strings)
106 </dd>
107 </dl><dl>
108 <dt>Returns:</dt>
109 <dd>
110 reference to the created object (QWidget)
111 </dd>
112 </dl><dl>
113 <dt>Raises <b>NotImplementedError</b>:</dt>
114 <dd>
115 raised to indicate that this method
116 must be implemented by subclasses
117 </dd>
118 </dl><a NAME="WebPluginInterface.isAnonymous" ID="WebPluginInterface.isAnonymous"></a>
119 <h4>WebPluginInterface.isAnonymous</h4>
120 <b>isAnonymous</b>(<i></i>)
121 <p>
122 Public method to indicate an anonymous plug-in.
123 </p><dl>
124 <dt>Returns:</dt>
125 <dd>
126 flag indicating anonymous state (boolean)
127 </dd>
128 </dl><a NAME="WebPluginInterface.metaPlugin" ID="WebPluginInterface.metaPlugin"></a>
129 <h4>WebPluginInterface.metaPlugin</h4>
130 <b>metaPlugin</b>(<i></i>)
131 <p>
132 Public method to create a meta plug-in object containing plug-in info.
133 </p><dl>
134 <dt>Returns:</dt>
135 <dd>
136 meta plug-in object (QWebPluginFactory.Plugin)
137 </dd>
138 </dl><dl>
139 <dt>Raises <b>NotImplementedError</b>:</dt>
140 <dd>
141 raised to indicate that this method
142 must be implemented by subclasses
143 </dd>
144 </dl>
145 <div align="right"><a href="#top">Up</a></div>
146 <hr />
147 </body></html>

eric ide

mercurial