diff --git a/openlp/core/lib/baselistwithdnd.py b/openlp/core/lib/baselistwithdnd.py index fab27695b..31b6f7709 100644 --- a/openlp/core/lib/baselistwithdnd.py +++ b/openlp/core/lib/baselistwithdnd.py @@ -22,15 +22,19 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Extend QListWidget to handle drag and drop functionality +""" from PyQt4 import QtCore, QtGui class BaseListWithDnD(QtGui.QListWidget): """ - Please put a short description of what this class does in here. + Provide a list widget to store objects and handle drag and drop events """ - def __init__(self, parent=None): + """ + Initialise the list widget + """ QtGui.QListWidget.__init__(self, parent) # this must be set by the class which is inheriting assert(self.PluginName) diff --git a/openlp/core/lib/dockwidget.py b/openlp/core/lib/dockwidget.py index 083c99184..729e29d33 100644 --- a/openlp/core/lib/dockwidget.py +++ b/openlp/core/lib/dockwidget.py @@ -22,7 +22,10 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide additional functionality required by OpenLP from the inherited +QDockWidget. +""" import logging from PyQt4 import QtGui diff --git a/openlp/core/lib/eventreceiver.py b/openlp/core/lib/eventreceiver.py index 76b19957c..e942fcfe6 100644 --- a/openlp/core/lib/eventreceiver.py +++ b/openlp/core/lib/eventreceiver.py @@ -22,7 +22,9 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide event handling code for OpenLP +""" import logging from PyQt4 import QtCore @@ -241,7 +243,11 @@ class Receiver(object): ``Receiver.send_message(u'<>', data)`` To receive a Message - ``QtCore.QObject.connect(Receiver.get_receiver(), QtCore.SIGNAL(u'<>'), <>)`` + ``QtCore.QObject.connect( + Receiver.get_receiver(), + QtCore.SIGNAL(u'<>'), + <> + )`` """ eventreceiver = EventReceiver() diff --git a/openlp/core/lib/mediamanageritem.py b/openlp/core/lib/mediamanageritem.py index 2e30032c7..2983eaca2 100644 --- a/openlp/core/lib/mediamanageritem.py +++ b/openlp/core/lib/mediamanageritem.py @@ -22,7 +22,9 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provides the generic functions for interfacing plugins with the Media Manager. +""" import logging import os @@ -204,7 +206,9 @@ class MediaManagerItem(QtGui.QWidget): self.addListViewToToolBar() def addMiddleHeaderBar(self): - # Create buttons for the toolbar + """ + Create buttons for the media item toolbar + """ ## Import Button ## if self.hasImportIcon: self.addToolbarButton( @@ -267,6 +271,9 @@ class MediaManagerItem(QtGui.QWidget): u':/general/general_add.png', self.onAddClick) def addListViewToToolBar(self): + """ + Creates the main widget for listing items the media item is tracking + """ #Add the List widget self.ListView = self.ListViewWithDnD_class(self) self.ListView.uniformItemSizes = True @@ -344,6 +351,9 @@ class MediaManagerItem(QtGui.QWidget): pass def onFileClick(self): + """ + Add a file to the list widget to make it available for showing + """ files = QtGui.QFileDialog.getOpenFileNames( self, self.OnNewPrompt, SettingsManager.get_last_dir(self.settingsSection), @@ -357,6 +367,9 @@ class MediaManagerItem(QtGui.QWidget): self.settingsSection, self.getFileList()) def getFileList(self): + """ + Return the current list of files + """ count = 0 filelist = [] while count < self.ListView.count(): @@ -380,6 +393,15 @@ class MediaManagerItem(QtGui.QWidget): return False def IconFromFile(self, file, thumb): + """ + Create a thumbnail icon from a given file + + ``file`` + The file to create the icon from + + ``thumb`` + The filename to save the thumbnail to + """ icon = build_icon(unicode(file)) pixmap = icon.pixmap(QtCore.QSize(88, 50)) ext = os.path.splitext(thumb)[1].lower() @@ -407,6 +429,10 @@ class MediaManagerItem(QtGui.QWidget): u'to be defined by the plugin') def onPreviewClick(self): + """ + Preview an item by building a service item then adding that service + item to the preview slide controller. + """ if not self.ListView.selectedIndexes() and not self.remoteTriggered: QtGui.QMessageBox.information(self, translate('MediaManagerItem', 'No Items Selected'), @@ -420,6 +446,10 @@ class MediaManagerItem(QtGui.QWidget): self.parent.preview_controller.addServiceItem(service_item) def onLiveClick(self): + """ + Send an item live by building a service item then adding that service + item to the live slide controller. + """ if not self.ListView.selectedIndexes(): QtGui.QMessageBox.information(self, translate('MediaManagerItem', 'No Items Selected'), @@ -433,6 +463,9 @@ class MediaManagerItem(QtGui.QWidget): self.parent.live_controller.addServiceItem(service_item) def onAddClick(self): + """ + Add a selected item to the current service + """ if not self.ListView.selectedIndexes() and not self.remoteTriggered: QtGui.QMessageBox.information(self, translate('MediaManagerItem', 'No Items Selected'), @@ -457,6 +490,9 @@ class MediaManagerItem(QtGui.QWidget): self.parent.service_manager.addServiceItem(service_item) def onAddEditClick(self): + """ + Add a selected item to an existing item in the current service. + """ if not self.ListView.selectedIndexes() and not self.remoteTriggered: QtGui.QMessageBox.information(self, translate('MediaManagerItem', 'No items selected'), diff --git a/openlp/core/lib/plugin.py b/openlp/core/lib/plugin.py index 0c22723a4..a5d712dfb 100644 --- a/openlp/core/lib/plugin.py +++ b/openlp/core/lib/plugin.py @@ -22,7 +22,9 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide the generic plugin functionality for OpenLP plugins. +""" import logging from PyQt4 import QtCore diff --git a/openlp/core/lib/serviceitem.py b/openlp/core/lib/serviceitem.py index d9c434987..dfcad984a 100644 --- a/openlp/core/lib/serviceitem.py +++ b/openlp/core/lib/serviceitem.py @@ -304,7 +304,7 @@ class ServiceItem(object): def merge(self, other): """ Updates the _uuid with the value from the original one - The _uuid is unique for a give service item but this allows one to + The _uuid is unique for a given service item but this allows one to replace an original version. """ self._uuid = other._uuid diff --git a/openlp/core/lib/settingsmanager.py b/openlp/core/lib/settingsmanager.py index b3d16595e..74a5d4866 100644 --- a/openlp/core/lib/settingsmanager.py +++ b/openlp/core/lib/settingsmanager.py @@ -22,7 +22,12 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide handling for persisting OpenLP settings. OpenLP uses QSettings to +manage settings persistence. QSettings provides a single API for saving and +retrieving settings from the application but writes to disk in an OS dependant +format. +""" import os from PyQt4 import QtCore @@ -56,6 +61,9 @@ class SettingsManager(object): u'user interface/preview panel', QtCore.QVariant(True)).toBool() def togglePreviewPanel(self, isVisible): + """ + Toggle the preview panel visibility. + """ QtCore.QSettings().setValue(u'user interface/preview panel', QtCore.QVariant(isVisible)) diff --git a/openlp/core/lib/themexmlhandler.py b/openlp/core/lib/themexmlhandler.py index 779dc3507..a5b4137ce 100644 --- a/openlp/core/lib/themexmlhandler.py +++ b/openlp/core/lib/themexmlhandler.py @@ -22,7 +22,9 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide the theme XML and handling functions for OpenLP v2 themes. +""" import os from xml.dom.minidom import Document diff --git a/openlp/core/lib/toolbar.py b/openlp/core/lib/toolbar.py index b2b05b8c0..a2979746e 100644 --- a/openlp/core/lib/toolbar.py +++ b/openlp/core/lib/toolbar.py @@ -22,7 +22,9 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +Provide common toolbar handling for OpenLP +""" import logging from PyQt4 import QtCore, QtGui