Signature Cleanups

This commit is contained in:
Tim Bentley 2010-07-05 17:00:48 +01:00
parent 4a7ea626b8
commit 08f650871a
14 changed files with 80 additions and 82 deletions

View File

@ -67,23 +67,23 @@ class Plugin(QtCore.QObject):
**Hook Functions** **Hook Functions**
``check_pre_conditions()`` ``checkPreConditions()``
Provides the Plugin with a handle to check if it can be loaded. Provides the Plugin with a handle to check if it can be loaded.
``get_media_manager_item()`` ``getMediaManagerItem()``
Returns an instance of MediaManagerItem to be used in the Media Manager. Returns an instance of MediaManagerItem to be used in the Media Manager.
``add_import_menu_item(import_menu)`` ``addImportMenuItem(import_menu)``
Add an item to the Import menu. Add an item to the Import menu.
``add_export_menu_item(export_menu)`` ``addExportMenuItem(export_menu)``
Add an item to the Export menu. Add an item to the Export menu.
``get_settings_tab()`` ``getSettingsTab()``
Returns an instance of SettingsTabItem to be used in the Settings Returns an instance of SettingsTabItem to be used in the Settings
dialog. dialog.
``add_to_menu(menubar)`` ``addToMenu(menubar)``
A method to add a menu item to anywhere in the menu, given the menu bar. A method to add a menu item to anywhere in the menu, given the menu bar.
``handle_event(event)`` ``handle_event(event)``
@ -134,9 +134,9 @@ class Plugin(QtCore.QObject):
self.pluginManager = plugin_helpers[u'pluginmanager'] self.pluginManager = plugin_helpers[u'pluginmanager']
QtCore.QObject.connect(Receiver.get_receiver(), QtCore.QObject.connect(Receiver.get_receiver(),
QtCore.SIGNAL(u'%s_add_service_item' % self.name), QtCore.SIGNAL(u'%s_add_service_item' % self.name),
self.process_add_service_event) self.processAddServiceEvent)
def check_pre_conditions(self): def checkPreConditions(self):
""" """
Provides the Plugin with a handle to check if it can be loaded. Provides the Plugin with a handle to check if it can be loaded.
Failing Preconditions does not stop a settings Tab being created Failing Preconditions does not stop a settings Tab being created
@ -145,7 +145,7 @@ class Plugin(QtCore.QObject):
""" """
return True return True
def set_status(self): def setStatus(self):
""" """
Sets the status of the plugin Sets the status of the plugin
""" """
@ -153,7 +153,7 @@ class Plugin(QtCore.QObject):
self.settingsSection + u'/status', self.settingsSection + u'/status',
QtCore.QVariant(PluginStatus.Inactive)).toInt()[0] QtCore.QVariant(PluginStatus.Inactive)).toInt()[0]
def toggle_status(self, new_status): def toggleStatus(self, new_status):
""" """
Changes the status of the plugin and remembers it Changes the status of the plugin and remembers it
""" """
@ -161,7 +161,7 @@ class Plugin(QtCore.QObject):
QtCore.QSettings().setValue( QtCore.QSettings().setValue(
self.settingsSection + u'/status', QtCore.QVariant(self.status)) self.settingsSection + u'/status', QtCore.QVariant(self.status))
def is_active(self): def isActive(self):
""" """
Indicates if the plugin is active Indicates if the plugin is active
@ -169,14 +169,14 @@ class Plugin(QtCore.QObject):
""" """
return self.status == PluginStatus.Active return self.status == PluginStatus.Active
def get_media_manager_item(self): def getMediaManagerItem(self):
""" """
Construct a MediaManagerItem object with all the buttons and things Construct a MediaManagerItem object with all the buttons and things
you need, and return it for integration into openlp.org. you need, and return it for integration into openlp.org.
""" """
pass pass
def add_import_menu_item(self, importMenu): def addImportMenuItem(self, importMenu):
""" """
Create a menu item and add it to the "Import" menu. Create a menu item and add it to the "Import" menu.
@ -185,7 +185,7 @@ class Plugin(QtCore.QObject):
""" """
pass pass
def add_export_menu_item(self, exportMenu): def addExportMenuItem(self, exportMenu):
""" """
Create a menu item and add it to the "Export" menu. Create a menu item and add it to the "Export" menu.
@ -194,7 +194,7 @@ class Plugin(QtCore.QObject):
""" """
pass pass
def add_tools_menu_item(self, toolsMenu): def addToolsMenuItem(self, toolsMenu):
""" """
Create a menu item and add it to the "Tools" menu. Create a menu item and add it to the "Tools" menu.
@ -203,13 +203,13 @@ class Plugin(QtCore.QObject):
""" """
pass pass
def get_settings_tab(self): def getSettingsTab(self):
""" """
Create a tab for the settings window. Create a tab for the settings window.
""" """
pass pass
def add_to_menu(self, menubar): def addToMenu(self, menubar):
""" """
Add menu items to the menu, given the menubar. Add menu items to the menu, given the menubar.
@ -218,11 +218,11 @@ class Plugin(QtCore.QObject):
""" """
pass pass
def process_add_service_event(self, replace=False): def processAddServiceEvent(self, replace=False):
""" """
Generic Drag and drop handler triggered from service_manager. Generic Drag and drop handler triggered from service_manager.
""" """
log.debug(u'process_add_service_event event called for plugin %s' % log.debug(u'processAddServiceEvent event called for plugin %s' %
self.name) self.name)
if replace: if replace:
self.mediaItem.onAddEditClick() self.mediaItem.onAddEditClick()
@ -243,15 +243,15 @@ class Plugin(QtCore.QObject):
""" """
if self.mediaItem: if self.mediaItem:
self.mediaItem.initialise() self.mediaItem.initialise()
self.insert_toolbox_item() self.insertToolboxItem()
def finalise(self): def finalise(self):
""" """
Called by the plugin Manager to cleanup things. Called by the plugin Manager to cleanup things.
""" """
self.remove_toolbox_item() self.removeToolboxItem()
def remove_toolbox_item(self): def removeToolboxItem(self):
""" """
Called by the plugin to remove toolbar Called by the plugin to remove toolbar
""" """
@ -260,7 +260,7 @@ class Plugin(QtCore.QObject):
if self.settings_tab: if self.settings_tab:
self.settingsForm.removeTab(self.name) self.settingsForm.removeTab(self.name)
def insert_toolbox_item(self): def insertToolboxItem(self):
""" """
Called by plugin to replace toolbar Called by plugin to replace toolbar
""" """
@ -269,7 +269,7 @@ class Plugin(QtCore.QObject):
if self.settings_tab: if self.settings_tab:
self.settingsForm.insertTab(self.settings_tab, self.weight) self.settingsForm.insertTab(self.settings_tab, self.weight)
def can_delete_theme(self, theme): def canDeleteTheme(self, theme):
""" """
Called to ask the plugin if a theme can be deleted Called to ask the plugin if a theme can be deleted
""" """

View File

@ -109,9 +109,9 @@ class PluginManager(object):
log.exception(u'loaded plugin %s has no helpers', unicode(p)) log.exception(u'loaded plugin %s has no helpers', unicode(p))
plugins_list = sorted(plugin_objects, self.order_by_weight) plugins_list = sorted(plugin_objects, self.order_by_weight)
for plugin in plugins_list: for plugin in plugins_list:
if plugin.check_pre_conditions(): if plugin.checkPreConditions():
log.debug(u'Plugin %s active', unicode(plugin.name)) log.debug(u'Plugin %s active', unicode(plugin.name))
plugin.set_status() plugin.setStatus()
else: else:
plugin.status = PluginStatus.Disabled plugin.status = PluginStatus.Disabled
self.plugins.append(plugin) self.plugins.append(plugin)
@ -138,7 +138,7 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
if plugin.status is not PluginStatus.Disabled: if plugin.status is not PluginStatus.Disabled:
plugin.mediaItem = plugin.get_media_manager_item() plugin.mediaItem = plugin.getMediaManagerItem()
def hook_settings_tabs(self, settingsform=None): def hook_settings_tabs(self, settingsform=None):
""" """
@ -151,7 +151,7 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
if plugin.status is not PluginStatus.Disabled: if plugin.status is not PluginStatus.Disabled:
plugin.settings_tab = plugin.get_settings_tab() plugin.settings_tab = plugin.getSettingsTab()
if plugin.settings_tab: if plugin.settings_tab:
log.debug(u'Inserting settings tab item from %s' % log.debug(u'Inserting settings tab item from %s' %
plugin.name) plugin.name)
@ -169,7 +169,7 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
if plugin.status is not PluginStatus.Disabled: if plugin.status is not PluginStatus.Disabled:
plugin.add_import_menu_item(import_menu) plugin.addImportMenuItem(import_menu)
def hook_export_menu(self, export_menu): def hook_export_menu(self, export_menu):
""" """
@ -181,7 +181,7 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
if plugin.status is not PluginStatus.Disabled: if plugin.status is not PluginStatus.Disabled:
plugin.add_export_menu_item(export_menu) plugin.addExportMenuItem(export_menu)
def hook_tools_menu(self, tools_menu): def hook_tools_menu(self, tools_menu):
""" """
@ -193,7 +193,7 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
if plugin.status is not PluginStatus.Disabled: if plugin.status is not PluginStatus.Disabled:
plugin.add_tools_menu_item(tools_menu) plugin.addToolsMenuItem(tools_menu)
def initialise_plugins(self): def initialise_plugins(self):
""" """
@ -202,12 +202,12 @@ class PluginManager(object):
""" """
for plugin in self.plugins: for plugin in self.plugins:
log.info(u'initialising plugins %s in a %s state' log.info(u'initialising plugins %s in a %s state'
% (plugin.name, plugin.is_active())) % (plugin.name, plugin.isActive()))
if plugin.is_active(): if plugin.isActive():
plugin.initialise() plugin.initialise()
log.info(u'Initialisation Complete for %s ' % plugin.name) log.info(u'Initialisation Complete for %s ' % plugin.name)
if not plugin.is_active(): if not plugin.isActive():
plugin.remove_toolbox_item() plugin.removeToolboxItem()
def finalise_plugins(self): def finalise_plugins(self):
""" """
@ -216,7 +216,6 @@ class PluginManager(object):
""" """
log.info(u'finalising plugins') log.info(u'finalising plugins')
for plugin in self.plugins: for plugin in self.plugins:
if plugin.is_active(): if plugin.isActive():
plugin.finalise() plugin.finalise()
log.info(u'Finalisation Complete for %s ' % plugin.name) log.info(u'Finalisation Complete for %s ' % plugin.name)

View File

@ -115,10 +115,10 @@ class PluginForm(QtGui.QDialog, Ui_PluginViewDialog):
if self.programaticChange: if self.programaticChange:
return return
if status == 0: if status == 0:
self.activePlugin.toggle_status(PluginStatus.Active) self.activePlugin.toggleStatus(PluginStatus.Active)
self.activePlugin.initialise() self.activePlugin.initialise()
else: else:
self.activePlugin.toggle_status(PluginStatus.Inactive) self.activePlugin.toggleStatus(PluginStatus.Inactive)
self.activePlugin.finalise() self.activePlugin.finalise()
status_text = 'Inactive' status_text = 'Inactive'
if self.activePlugin.status == PluginStatus.Active: if self.activePlugin.status == PluginStatus.Active:

View File

@ -212,7 +212,7 @@ class ThemeManager(QtGui.QWidget):
QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Ok)) QtGui.QMessageBox.StandardButtons(QtGui.QMessageBox.Ok))
else: else:
for plugin in self.parent.plugin_manager.plugins: for plugin in self.parent.plugin_manager.plugins:
if not plugin.can_delete_theme(theme): if not plugin.canDeleteTheme(theme):
QtGui.QMessageBox.critical(self, QtGui.QMessageBox.critical(self,
translate('ThemeManager', 'Error'), translate('ThemeManager', 'Error'),
unicode(translate('ThemeManager', unicode(translate('ThemeManager',
@ -682,4 +682,3 @@ class ThemeManager(QtGui.QWidget):
#theme.theme_mode #theme.theme_mode
theme.theme_name = theme.theme_name.strip() theme.theme_name = theme.theme_name.strip()
#theme.theme_version #theme.theme_version

View File

@ -47,14 +47,14 @@ class alertsPlugin(Plugin):
self.alertForm = AlertForm(self.manager, self) self.alertForm = AlertForm(self.manager, self)
self.status = PluginStatus.Active self.status = PluginStatus.Active
def get_settings_tab(self): def getSettingsTab(self):
""" """
Return the settings tab for the Alerts plugin Return the settings tab for the Alerts plugin
""" """
self.alertsTab = AlertsTab(self) self.alertsTab = AlertsTab(self)
return self.alertsTab return self.alertsTab
def add_tools_menu_item(self, tools_menu): def addToolsMenuItem(self, tools_menu):
""" """
Give the alerts plugin the opportunity to add items to the Give the alerts plugin the opportunity to add items to the
**Tools** menu. **Tools** menu.

View File

@ -57,14 +57,14 @@ class BiblePlugin(Plugin):
self.ImportBibleItem.setVisible(False) self.ImportBibleItem.setVisible(False)
self.ExportBibleItem.setVisible(False) self.ExportBibleItem.setVisible(False)
def get_settings_tab(self): def getSettingsTab(self):
return BiblesTab(self.name) return BiblesTab(self.name)
def get_media_manager_item(self): def getMediaManagerItem(self):
# Create the BibleManagerItem object # Create the BibleManagerItem object
return BibleMediaItem(self, self.icon, self.name) return BibleMediaItem(self, self.icon, self.name)
def add_import_menu_item(self, import_menu): def addImportMenuItem(self, import_menu):
self.ImportBibleItem = QtGui.QAction(import_menu) self.ImportBibleItem = QtGui.QAction(import_menu)
self.ImportBibleItem.setObjectName(u'ImportBibleItem') self.ImportBibleItem.setObjectName(u'ImportBibleItem')
import_menu.addAction(self.ImportBibleItem) import_menu.addAction(self.ImportBibleItem)
@ -75,7 +75,7 @@ class BiblePlugin(Plugin):
QtCore.SIGNAL(u'triggered()'), self.onBibleImportClick) QtCore.SIGNAL(u'triggered()'), self.onBibleImportClick)
self.ImportBibleItem.setVisible(False) self.ImportBibleItem.setVisible(False)
def add_export_menu_item(self, export_menu): def addExportMenuItem(self, export_menu):
self.ExportBibleItem = QtGui.QAction(export_menu) self.ExportBibleItem = QtGui.QAction(export_menu)
self.ExportBibleItem.setObjectName(u'ExportBibleItem') self.ExportBibleItem.setObjectName(u'ExportBibleItem')
export_menu.addAction(self.ExportBibleItem) export_menu.addAction(self.ExportBibleItem)
@ -94,7 +94,7 @@ class BiblePlugin(Plugin):
'displayed on the screen during the service.') 'displayed on the screen during the service.')
return about_text return about_text
def can_delete_theme(self, theme): def canDeleteTheme(self, theme):
if self.settings_tab.bible_theme == theme: if self.settings_tab.bible_theme == theme:
return False return False
return True return True

View File

@ -53,10 +53,10 @@ class CustomPlugin(Plugin):
self.icon = build_icon(u':/plugins/plugin_custom.png') self.icon = build_icon(u':/plugins/plugin_custom.png')
self.status = PluginStatus.Active self.status = PluginStatus.Active
def get_settings_tab(self): def getSettingsTab(self):
return CustomTab(self.name) return CustomTab(self.name)
def get_media_manager_item(self): def getMediaManagerItem(self):
# Create the CustomManagerItem object # Create the CustomManagerItem object
return CustomMediaItem(self, self.icon, self.name) return CustomMediaItem(self, self.icon, self.name)
@ -68,7 +68,7 @@ class CustomPlugin(Plugin):
'songs plugin.<br>') 'songs plugin.<br>')
return about_text return about_text
def can_delete_theme(self, theme): def canDeleteTheme(self, theme):
if not self.custommanager.get_all_objects_filtered(CustomSlide, if not self.custommanager.get_all_objects_filtered(CustomSlide,
CustomSlide.theme_name == theme): CustomSlide.theme_name == theme):
return True return True

View File

@ -39,10 +39,10 @@ class ImagePlugin(Plugin):
self.icon = build_icon(u':/plugins/plugin_images.png') self.icon = build_icon(u':/plugins/plugin_images.png')
self.status = PluginStatus.Active self.status = PluginStatus.Active
def get_settings_tab(self): def getSettingsTab(self):
return ImageTab(self.name) return ImageTab(self.name)
def get_media_manager_item(self): def getMediaManagerItem(self):
# Create the MediaManagerItem object # Create the MediaManagerItem object
return ImageMediaItem(self, self.icon, self.name) return ImageMediaItem(self, self.icon, self.name)

View File

@ -67,7 +67,7 @@ class MediaPlugin(Plugin):
type = u'' type = u''
return list, type return list, type
def get_media_manager_item(self): def getMediaManagerItem(self):
# Create the MediaManagerItem object # Create the MediaManagerItem object
return MediaMediaItem(self, self.icon, self.name) return MediaMediaItem(self, self.icon, self.name)

View File

@ -173,7 +173,7 @@ class PowerpointDocument(PresentationDocument):
return True return True
def is_active(self): def isActive(self):
""" """
Returns true if a presentation is currently active Returns true if a presentation is currently active
""" """
@ -206,7 +206,7 @@ class PowerpointDocument(PresentationDocument):
""" """
Returns true if screen is blank Returns true if screen is blank
""" """
if self.is_active(): if self.isActive():
return self.presentation.SlideShowWindow.View.State == 3 return self.presentation.SlideShowWindow.View.State == 3
else: else:
return False return False

View File

@ -43,7 +43,7 @@ class PresentationPlugin(Plugin):
self.icon = build_icon(u':/plugins/plugin_presentations.png') self.icon = build_icon(u':/plugins/plugin_presentations.png')
self.status = PluginStatus.Active self.status = PluginStatus.Active
def get_settings_tab(self): def getSettingsTab(self):
""" """
Create the settings Tab Create the settings Tab
""" """
@ -52,7 +52,7 @@ class PresentationPlugin(Plugin):
def initialise(self): def initialise(self):
log.info(u'Presentations Initialising') log.info(u'Presentations Initialising')
Plugin.initialise(self) Plugin.initialise(self)
self.insert_toolbox_item() self.insertToolboxItem()
for controller in self.controllers: for controller in self.controllers:
if self.controllers[controller].enabled: if self.controllers[controller].enabled:
self.controllers[controller].start_process() self.controllers[controller].start_process()
@ -66,7 +66,7 @@ class PresentationPlugin(Plugin):
controller.kill() controller.kill()
Plugin.finalise(self) Plugin.finalise(self)
def get_media_manager_item(self): def getMediaManagerItem(self):
""" """
Create the Media Manager List Create the Media Manager List
""" """
@ -76,12 +76,12 @@ class PresentationPlugin(Plugin):
def registerControllers(self, controller): def registerControllers(self, controller):
self.controllers[controller.name] = controller self.controllers[controller.name] = controller
def check_pre_conditions(self): def checkPreConditions(self):
""" """
Check to see if we have any presentation software available Check to see if we have any presentation software available
If Not do not install the plugin. If Not do not install the plugin.
""" """
log.debug(u'check_pre_conditions') log.debug(u'checkPreConditions')
controller_dir = os.path.join( controller_dir = os.path.join(
AppLocation.get_directory(AppLocation.PluginsDir), AppLocation.get_directory(AppLocation.PluginsDir),
u'presentations', u'lib') u'presentations', u'lib')

View File

@ -48,7 +48,7 @@ class RemotesPlugin(Plugin):
""" """
log.debug(u'initialise') log.debug(u'initialise')
Plugin.initialise(self) Plugin.initialise(self)
self.insert_toolbox_item() self.insertToolboxItem()
self.server = HttpServer(self) self.server = HttpServer(self)
def finalise(self): def finalise(self):
@ -60,7 +60,7 @@ class RemotesPlugin(Plugin):
if self.server: if self.server:
self.server.close() self.server.close()
def get_settings_tab(self): def getSettingsTab(self):
""" """
Create the settings Tab Create the settings Tab
""" """

View File

@ -61,7 +61,7 @@ class SongsPlugin(Plugin):
self.icon = build_icon(u':/plugins/plugin_songs.png') self.icon = build_icon(u':/plugins/plugin_songs.png')
self.status = PluginStatus.Active self.status = PluginStatus.Active
def get_settings_tab(self): def getSettingsTab(self):
return SongsTab(self.name) return SongsTab(self.name)
def initialise(self): def initialise(self):
@ -70,14 +70,14 @@ class SongsPlugin(Plugin):
self.mediaItem.displayResultsSong( self.mediaItem.displayResultsSong(
self.manager.get_all_objects(Song, Song.title)) self.manager.get_all_objects(Song, Song.title))
def get_media_manager_item(self): def getMediaManagerItem(self):
""" """
Create the MediaManagerItem object, which is displaed in the Create the MediaManagerItem object, which is displaed in the
Media Manager. Media Manager.
""" """
return SongMediaItem(self, self.icon, self.name) return SongMediaItem(self, self.icon, self.name)
def add_import_menu_item(self, import_menu): def addImportMenuItem(self, import_menu):
""" """
Give the Songs plugin the opportunity to add items to the Give the Songs plugin the opportunity to add items to the
**Import** menu. **Import** menu.
@ -137,7 +137,7 @@ class SongsPlugin(Plugin):
QtCore.QObject.connect(self.ImportOooItem, QtCore.QObject.connect(self.ImportOooItem,
QtCore.SIGNAL(u'triggered()'), self.onImportOooItemClick) QtCore.SIGNAL(u'triggered()'), self.onImportOooItemClick)
def add_export_menu_item(self, export_menu): def addExportMenuItem(self, export_menu):
""" """
Give the Songs plugin the opportunity to add items to the Give the Songs plugin the opportunity to add items to the
**Export** menu. **Export** menu.
@ -191,7 +191,7 @@ class SongsPlugin(Plugin):
'This plugin allows songs to be managed and displayed.') 'This plugin allows songs to be managed and displayed.')
return about_text return about_text
def can_delete_theme(self, theme): def canDeleteTheme(self, theme):
if not self.manager.get_all_objects_filtered(Song, if not self.manager.get_all_objects_filtered(Song,
Song.theme_name == theme): Song.theme_name == theme):
return True return True

View File

@ -46,7 +46,7 @@ class SongUsagePlugin(Plugin):
self.songusagemanager = None self.songusagemanager = None
self.songusageActive = False self.songusageActive = False
def add_tools_menu_item(self, tools_menu): def addToolsMenuItem(self, tools_menu):
""" """
Give the SongUsage plugin the opportunity to add items to the Give the SongUsage plugin the opportunity to add items to the
**Tools** menu. **Tools** menu.