plugin_provider.py
Go to the documentation of this file.
1 # Copyright (c) 2011, Dirk Thomas, Dorian Scholz, TU Darmstadt
2 # All rights reserved.
3 #
4 # Redistribution and use in source and binary forms, with or without
5 # modification, are permitted provided that the following conditions
6 # are met:
7 #
8 # * Redistributions of source code must retain the above copyright
9 # notice, this list of conditions and the following disclaimer.
10 # * Redistributions in binary form must reproduce the above
11 # copyright notice, this list of conditions and the following
12 # disclaimer in the documentation and/or other materials provided
13 # with the distribution.
14 # * Neither the name of the TU Darmstadt nor the names of its
15 # contributors may be used to endorse or promote products derived
16 # from this software without specific prior written permission.
17 #
18 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
30 
31 from python_qt_binding.QtCore import QObject
32 
33 
34 class PluginProvider(QObject):
35  """Interface for discovering, loading and unloading of plugins."""
36 
37  def __init__(self):
38  super(PluginProvider, self).__init__()
39  self.setObjectName('PluginProvider')
40 
41  def discover(self, discovery_data):
42  """
43  Discover the plugins.
44 
45  @param discovery_data:
46  The settings containing any discovery data which is cached between invocations
47  @return: Dictionary of plugin ids to `PluginDescriptor`s
48  """
49  raise NotImplementedError
50 
51  def load(self, plugin_id, plugin_context):
52  """
53  Load a plugin and pass the `PluginContext`.
54 
55  @return: The created plugin instance
56  @raise PluginLoadError
57  """
58  raise NotImplementedError
59 
60  def unload(self, plugin_instance):
61  """Unload a plugin."""
62  raise NotImplementedError
63 
64  def shutdown(self):
65  """Notify of shutdown."""
66  pass
def load(self, plugin_id, plugin_context)
def discover(self, discovery_data)
def unload(self, plugin_instance)


qt_gui
Author(s): Dirk Thomas
autogenerated on Sun Nov 1 2020 04:03:22