00001 # Copyright (c) 2011, Dirk Thomas, Dorian Scholz, TU Darmstadt 00002 # All rights reserved. 00003 # 00004 # Redistribution and use in source and binary forms, with or without 00005 # modification, are permitted provided that the following conditions 00006 # are met: 00007 # 00008 # * Redistributions of source code must retain the above copyright 00009 # notice, this list of conditions and the following disclaimer. 00010 # * Redistributions in binary form must reproduce the above 00011 # copyright notice, this list of conditions and the following 00012 # disclaimer in the documentation and/or other materials provided 00013 # with the distribution. 00014 # * Neither the name of the TU Darmstadt nor the names of its 00015 # contributors may be used to endorse or promote products derived 00016 # from this software without specific prior written permission. 00017 # 00018 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 00019 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 00020 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 00021 # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 00022 # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 00023 # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 00024 # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00025 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00026 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00027 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 00028 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00029 # POSSIBILITY OF SUCH DAMAGE. 00030 00031 from python_qt_binding.QtCore import QObject 00032 00033 00034 class PluginProvider(QObject): 00035 00036 """Interface for discovering, loading and unloading of plugins.""" 00037 00038 def __init__(self): 00039 super(PluginProvider, self).__init__() 00040 self.setObjectName('PluginProvider') 00041 00042 def discover(self, discovery_data): 00043 """ 00044 Discover the plugins. 00045 @param discovery_data: The settings containing any discovery data which is cached between invocations 00046 @return: Dictionary of plugin ids to `PluginDescriptor`s 00047 """ 00048 raise NotImplementedError 00049 00050 def load(self, plugin_id, plugin_context): 00051 """ 00052 Load a plugin and pass the `PluginContext`. 00053 @return: The created plugin instance 00054 @raise PluginLoadError 00055 """ 00056 raise NotImplementedError 00057 00058 def unload(self, plugin_instance): 00059 """Unload a plugin.""" 00060 raise NotImplementedError 00061 00062 def shutdown(self): 00063 """Notify of shutdown.""" 00064 pass