Helpviewer/WebPlugins/WebPluginInterface.py

changeset 2954
bf0215fe12d1
parent 2302
f29e9405c851
child 2962
d6c9d1ca2da4
equal deleted inserted replaced
2953:703452a2876f 2954:bf0215fe12d1
4 # 4 #
5 5
6 """ 6 """
7 Module implementing the web plug-in interface. 7 Module implementing the web plug-in interface.
8 """ 8 """
9
10 from PyQt4.QtGui import QWidget
11 from PyQt4.QtWebKit import QWebPluginFactory
9 12
10 13
11 class WebPluginInterface(object): 14 class WebPluginInterface(object):
12 """ 15 """
13 Class implementing the web plug-in interface. 16 Class implementing the web plug-in interface.
15 def metaPlugin(self): 18 def metaPlugin(self):
16 """ 19 """
17 Public method to create a meta plug-in object containing plug-in info. 20 Public method to create a meta plug-in object containing plug-in info.
18 21
19 @return meta plug-in object (QWebPluginFactory.Plugin) 22 @return meta plug-in object (QWebPluginFactory.Plugin)
23 @exception NotImplementedError raised to indicate that this method
24 must be implemented by subclasses
20 """ 25 """
21 raise NotImplementedError 26 raise NotImplementedError
27 return QWebPluginFactory.Plugin()
22 28
23 def create(self, mimeType, url, argumentNames, argumentValues): 29 def create(self, mimeType, url, argumentNames, argumentValues):
24 """ 30 """
25 Public method to create a plug-in instance for the given data. 31 Public method to create a plug-in instance for the given data.
26 32
27 @param mimeType MIME type for the plug-in (string) 33 @param mimeType MIME type for the plug-in (string)
28 @param url URL for the plug-in (QUrl) 34 @param url URL for the plug-in (QUrl)
29 @param argumentNames list of argument names (list of strings) 35 @param argumentNames list of argument names (list of strings)
30 @param argumentValues list of argument values (list of strings) 36 @param argumentValues list of argument values (list of strings)
31 @return reference to the created object (QWidget) 37 @return reference to the created object (QWidget)
38 @exception NotImplementedError raised to indicate that this method
39 must be implemented by subclasses
32 """ 40 """
33 raise NotImplementedError 41 raise NotImplementedError
42 return QWidget()
34 43
35 def configure(self): 44 def configure(self):
36 """ 45 """
37 Public method to configure the plug-in. 46 Public method to configure the plug-in.
47
48 @exception NotImplementedError raised to indicate that this method
49 must be implemented by subclasses
38 """ 50 """
39 raise NotImplementedError 51 raise NotImplementedError
40 52
41 def isAnonymous(self): 53 def isAnonymous(self):
42 """ 54 """
43 Public method to indicate an anonymous plug-in. 55 Public method to indicate an anonymous plug-in.
56
57 @return flag indicating anonymous state (boolean)
44 """ 58 """
45 return False 59 return False

eric ide

mercurial