summaryrefslogtreecommitdiff
path: root/clPlugin.py
blob: a2522e90d57dfc391cca87b34e0c6900c00ef227 (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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
from PyQt4 import QtGui, QtSvg, QtCore

from clMonty import monty
from clSettings import settings, mpdSettings
from misc import *
import log

class Plugin:
	name=None
	dockWidget=None
	settingsWidget=None
	settings=None
	winMain=None
	loaded=None
	listeners=[]
	
	def __init__(self, winMain, name):
		self.name=name
		self.winMain=winMain
		self.loaded=False
		self.listeners=[]

	def getName(self, lower=False):
		if lower:
			return self.name.lower()
		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 log(self, msg, level=log.LOG_NORMAL):
		log.normal("%s: %s"%(self.getName(), msg))
	def normal(self, msg):
		self.log(msg)
	def important(self, msg):
		self.log(msg, log.LOG_IMPORTANT)
	def extended(self, msg):
		self.log(msg, log.LOG_EXTENDED)
	def debug(self, msg):
		self.log(msg, log.LOG_DEBUG)
	
	def load(self):
		self.extended("loading")
		if len(self.listeners):
			self.debug("adding %s listeners"%(len(self.listeners)))
			for listener in self.listeners:
				monty.addListener(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 self.loaded==False:
			return
		self.extended("unloading")
		if len(self.listeners):
			self.debug("removing %s listeners"%(len(self.listeners)))
			for listener in self.listeners:
				monty.removeListener(listener[0], listener[1])

		self._unload()
		self.winMain.removeDock(self.getDockWidget())
		self.dockWidget=None
		self.settingsWidget=None
		self.loaded=False
	def isLoaded(self):
		return self.loaded
	
	def addMontyListener(self, event, callback):
		self.listeners.append([event, callback])
	
	def getDockWidget(self, opts=None):
		try:
			if not self.dockWidget:
				self.dockWidget=self._getDockWidget()
				self.dockWidget.setFeatures(opts)
				self.dockWidget.setAllowedAreas(QtCore.Qt.AllDockWidgetAreas)
		except:
			pass
		return self.dockWidget

	def getSettingsWidget(self):
		if not self.settingsWidget:
			self.settings=self._getSettings()
			if len(self.settings):
				self.settingsWidget=QtGui.QWidget(None)
				layout=QtGui.QGridLayout()
				self.settingsWidget.setLayout(layout)
				for i in xrange(len(self.settings)):
					setting=self.settings[i]
					try:
						setting[4]
					except:
						setting.append(settings)
					tooltip="%s\n\n(%s)"%(setting[2],setting[0])
					label=QtGui.QLabel(setting[1])
					wg=setting[3]
					label.setToolTip(tooltip)
					wg.setToolTip(tooltip)
					layout.addWidget(label)
					layout.addWidget(wg, i, 1)

				layout.addWidget(Button('Save settings for '+self.getName(), self.saveSettings), i+1,1)

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

	def saveSettings(self):
		for i in xrange(len(self.settings)):
			setting=self.settings[i]
			name=setting[0]
			obj=setting[3]
			settingsMgr=setting[4]
			if isinstance(obj,QtGui.QLineEdit):
				settingsMgr.set(setting[0], setting[3].text())
			elif isinstance(obj,QtGui.QComboBox):
				settingsMgr.set(setting[0], setting[3].currentIndex())
			elif isinstance(obj,QtGui.QTextEdit):
				settingsMgr.set(setting[0], setting[3].toPlainText())
			elif isinstance(obj,QtGui.QPushButton):
				# what the *#$ should we do with this? Just skip!
				print "I don't know what to with my object!"
				pass
			else:
				print "Can't handle %s"%(obj.__class__)
		self.afterSaveSettings()
	
	def getSettingWidget(self, name):
		for i in xrange(len(self.settings)):
			setting=self.settings[i]
			if name==setting[0]:
				return setting[3]
		return None
		
	
	def afterSaveSettings(self):
		"""Override this one."""
		pass
	def _getDockWidget(self):
		"""Override this one."""
		return None
	def _getSettings(self):
		"""Override this one.

		This method must return a list of arrays.
		Format: [ [setting, title, tooltip, widget, opt settingsmgr]+ ]"""
		return []
	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