summaryrefslogtreecommitdiff
path: root/clPlugin.py
blob: efbd502ba6ae562c7586edb90c097d36959eb38e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
from PyQt4 import QtGui, QtCore
from PyQt4.QtCore import QVariant
import logging

import plugins
from misc import *

class Plugin:
    name       = None
    dockWidget = None
    settings   = None
    winMain    = None
    loaded     = None
    listeners  = None
    mpclient      = None
    DEFAULTS   = {}

    def __init__(self, winMain, name):
        self.name      = name
        self.winMain   = winMain
        self.loaded    = False
        self.listeners = []
        self.mpclient     = winMain.mpclient
        self.settings  = QtCore.QSettings(ORGNAME, APPNAME)

        #init settings
        self.settings.beginGroup(self.name)
        for key in self.DEFAULTS:
            if not self.settings.contains(key):
                self.settings.setValue(key, QVariant(self.DEFAULTS[key]))
        self.settings.endGroup()

    def getName(self):
        return self.name
    def getInfo(self):
        return ''
    def getExtInfo(self):
        return ''
    def getWinMain(self):
        return self.winMain
    def setStatus(self, status):
        self.winMain.setStatus(status)

    def load(self):
        logging.info("loading")
        if len(self.listeners):
            logging.debug("adding %s listeners"%(len(self.listeners)))
            for listener in self.listeners:
                self.mpclient.add_listener(listener[0], listener[1])

        self._load()
        opts=QtGui.QDockWidget.DockWidgetClosable|QtGui.QDockWidget.DockWidgetMovable
        self.winMain.addDock(self.getDockWidget(opts))
        self.loaded=True
    def unload(self):
        if not self.loaded:
            return
        logging.info("unloading")
        if len(self.listeners):
            logging.debug("removing %s listeners"%(len(self.listeners)))
            for listener in self.listeners:
                self.mpclient.removeListener(listener[0], listener[1])

        self._unload()
        dock_widget = self.getDockWidget()
        if dock_widget:
            self.winMain.removeDock(dock_widget)
        self.dockWidget     = None
        self.settingsWidget = None
        self.loaded         = False
    def isLoaded(self):
        return self.loaded

    def addListener(self, event, callback):
        self.listeners.append([event, callback])

    def getDockWidget(self, opts=None):
        self.dockWidget = self._getDockWidget()
        if self.dockWidget and opts:
            self.dockWidget.setFeatures(opts)
            self.dockWidget.setAllowedAreas(QtCore.Qt.AllDockWidgetAreas)
        return self.dockWidget

    class SettingsWidget(QtGui.QWidget):
        """ plugins should subclass this"""
        plugin = None
        settings = None

        def __init__(self, plugin):
            QtGui.QWidget.__init__(self)
            self.plugin = plugin
            self.settings = QtCore.QSettings(ORGNAME, APPNAME)

        def save_settings(self):
            """ reimplement this"""
            self.plugin.saveSettings()

        def _add_widget(self, widget, label = '', tooltip = ''):
            """adds a widget with label"""
            if not self.layout():
                logging.error('Attempted to call add_widget with no layout set.')
            widget.setToolTip(tooltip)
            layout = QtGui.QHBoxLayout()
            layout.addWidget(QtGui.QLabel(label))
            layout.addWidget(widget)
            self.layout().addLayout(layout)

    def get_settings_widget(self):
        """Should return subclassed SettingsWidget."""
        return

    def resetSettingCache(self):
        #self.settings=None
        self.settingsWidget=None

    def _getPluginClassname(self, cl):
        """Returns the name of a plugin (without 'plugin'-prefix)"""
        return str(cl).split('.')[-1].lower()[len('plugin'):]

    def _getDockWidget(self):
        """Override this one."""
        return None
    def _createDock(self, widget):
        """Creates a QDockWidget with parent $parent containing widget $widget."""
        dock=QtGui.QDockWidget(self.name, self.winMain)
        dock.setObjectName(self.name)
        dock.setWidget(widget)

        return dock
    def _load(self):
        """Override this one."""
        return
    def _unload(self):
        """Override this one."""
        return