From 05bf2ec6fa6f3a4bcf83b0c9cc9abd05fed44387 Mon Sep 17 00:00:00 2001 From: Andreas Preikschat Date: Sat, 22 Oct 2011 13:09:01 +0200 Subject: [PATCH] removed obsolete signals and rearranged the docs --- openlp/core/__init__.py | 2 +- openlp/core/lib/eventreceiver.py | 271 +++++++++--------- openlp/core/ui/maindisplay.py | 6 +- openlp/core/ui/mainwindow.py | 4 +- openlp/core/ui/slidecontroller.py | 20 +- openlp/plugins/alerts/lib/alertsmanager.py | 6 +- .../presentations/lib/messagelistener.py | 8 +- 7 files changed, 157 insertions(+), 160 deletions(-) diff --git a/openlp/core/__init__.py b/openlp/core/__init__.py index 3c8bdfe71..82a30b19f 100644 --- a/openlp/core/__init__.py +++ b/openlp/core/__init__.py @@ -143,7 +143,7 @@ class OpenLP(QtGui.QApplication): u'general/update check', QtCore.QVariant(True)).toBool() if update_check: VersionThread(self.mainWindow).start() - Receiver.send_message(u'maindisplay_blank_check') + Receiver.send_message(u'live_display_blank_check') self.mainWindow.appStartup() DelayStartThread(self.mainWindow).start() # Skip exec_() for gui tests diff --git a/openlp/core/lib/eventreceiver.py b/openlp/core/lib/eventreceiver.py index 2d4134ee3..3970794e4 100644 --- a/openlp/core/lib/eventreceiver.py +++ b/openlp/core/lib/eventreceiver.py @@ -35,193 +35,190 @@ log = logging.getLogger(__name__) class EventReceiver(QtCore.QObject): """ - Class to allow events to be passed from different parts of the - system. This is a private class and should not be used directly - but rather via the Receiver class. + Class to allow events to be passed from different parts of the system. This + is a private class and should not be used directly but rather via the + Receiver class. + + **Mainwindow related and generic signals** + + ``mainwindow_status_text`` + Changes the bottom status bar text on the maindisplay window. + + ``openlp_warning_message`` + Displays a standalone Warning Message. + + ``openlp_error_message`` + Displays a standalone Error Message. + + ``openlp_information_message`` + Displays a standalone Information Message. + + ``cursor_busy`` + Makes the cursor got to a busy form. + + ``cursor_normal`` + Resets the cursor to default. ``openlp_process_events`` - Requests the Application to flush the events queue + Requests the Application to flush the events queue. ``openlp_version_check`` Version has changed so pop up window. + ``openlp_stop_wizard`` + Stops a wizard before completion. + + **Setting related signals** + ``config_updated`` - Informs components the config has changed + Informs components that the config has changed. ``config_screen_changed`` - The display monitor has been changed + The display monitor has been changed. + + **Slidecontroller signals** ``slidecontroller_{live|preview}_next`` - Moves to the next slide + Moves to the next slide. ``slidecontroller_{live|preview}_next_noloop`` - Moves to the next slide without auto advance + Moves to the next slide without auto advance. ``slidecontroller_{live|preview}_previous`` - Moves to the previous slide + Moves to the previous slide. ``slidecontroller_{live|preview}_previous_noloop`` - Moves to the previous slide, without auto advance + Moves to the previous slide, without auto advance. ``slidecontroller_{live|preview}_set`` - Moves to a specific slide, by index + Moves to a specific slide, by index. ``slidecontroller_{live|preview}_started`` - Broadcasts that an item has been made live/previewed + Broadcasts that an item has been made live/previewed. ``slidecontroller_{live|preview}_change`` Informs the slidecontroller that a slide change has occurred and to - update itself + update itself. ``slidecontroller_{live|preview}_changed`` - Broadcasts that the slidecontroller has changed the current slide + Broadcasts that the slidecontroller has changed the current slide. ``slidecontroller_{live|preview}_blank`` - Request that the output screen is blanked + Request that the output screen is blanked. ``slidecontroller_{live|preview}_unblank`` - Request that the output screen is unblanked + Request that the output screen is unblanked. ``slidecontroller_live_spin_delay`` - Pushes out the loop delay + Pushes out the loop delay. ``slidecontroller_live_stop_loop`` - Stop the loop on the main display + Stop the loop on the main display. + + **Servicemanager related signals** ``servicemanager_previous_item`` - Display the previous item in the service + Display the previous item in the service. ``servicemanager_preview_live`` - Requests a Preview item from the Service Manager to update live and - add a new item to the preview panel + Requests a Preview item from the Service Manager to update live and add + a new item to the preview panel. ``servicemanager_next_item`` - Display the next item in the service + Display the next item in the service. ``servicemanager_set_item`` - Go live on a specific item, by index - - ``maindisplay_blank`` - Blank the maindisplay window - - ``maindisplay_hide`` - Hide the maindisplay window - - ``maindisplay_show`` - Return the maindisplay window - - ``maindisplay_active`` - The maindisplay has been made active - - ``maindisplay_status_text`` - Changes the bottom status bar text on the maindisplay window - - ``maindisplay_blank_check`` - Check to see if the blank display message is required - - ``videodisplay_start`` - Open a media item and prepare for playing - - ``videodisplay_play`` - Start playing a media item - - ``videodisplay_pause`` - Pause a media item - - ``videodisplay_stop`` - Stop playing a media item - - ``videodisplay_background`` - Replace the background video - - ``theme_update_list`` - send out message with new themes - - ``theme_update_global`` - Tell the components we have a new global theme - - ``{plugin}_start`` - Requests a plugin to start a external program - Path and file provided in message - - ``{plugin}_first`` - Requests a plugin to handle a first event - - ``{plugin}_previous`` - Requests a plugin to handle a previous event - - ``{plugin}_next`` - Requests a plugin to handle a next event - - ``{plugin}_last`` - Requests a plugin to handle a last event - - ``{plugin}_slide`` - Requests a plugin to handle a go to specific slide event - - ``{plugin}_stop`` - Requests a plugin to handle a stop event - - ``{plugin}_blank`` - Requests a plugin to handle a blank screen event - - ``{plugin}_unblank`` - Requests a plugin to handle an unblank screen event - - ``{plugin}_edit`` - Requests a plugin edit a database item with the key as the payload - - ``{plugin}_edit_clear`` - Editing has been completed - - ``{plugin}_load_list`` - Tells the the plugin to reload the media manager list - - ``{plugin}_preview`` - Tells the plugin it's item can be previewed - - ``{plugin}_add_service_item`` - Ask the plugin to push the selected items to the service item - - ``{plugin}_service_load`` - Ask the plugin to process an individual service item after it has been - loaded + Go live on a specific item, by index. ``service_item_update`` Passes back to the service manager the service item after it has been - processed by the plugin + processed by the plugin. - ``alerts_text`` - Displays an alert message - - ``bibles_nobook`` - Attempt to find book resulted in no match - - ``openlp_stop_wizard`` - Stops a wizard before completion - - ``remotes_poll_request`` - Waits for openlp to do something "interesting" and sends a - remotes_poll_response signal when it does - - ``openlp_warning_message`` - Displays a standalone Warning Message - - ``openlp_error_message`` - Displays a standalone Error Message - - ``openlp_information_message`` - Displays a standalone Information Message - - ``cursor_busy`` - Makes the cursor got to a busy form - - ``cursor_normal`` - Resets the cursor to default + **Display signals** ``update_display_css`` CSS has been updated which needs to be changed on the main display. + **Live Display signals** + + ``live_display_hide`` + Hide the live display. + + ``live_display_show`` + Return the live display. + + ``live_display_active`` + The live display has been made active. + + ``live_display_blank_check`` + Check to see if the blank display message is required. + + **Theme related singlas** + + ``theme_update_list`` + send out message with new themes. + + ``theme_update_global`` + Tell the components we have a new global theme. + + **Plugin specific signals** + + ``{plugin}_start`` + Requests a plugin to start a external program. Path and file have to + be provided in the message. + + ``{plugin}_first`` + Requests a plugin to handle a first event. + + ``{plugin}_previous`` + Requests a plugin to handle a previous event. + + ``{plugin}_next`` + Requests a plugin to handle a next event. + + ``{plugin}_last`` + Requests a plugin to handle a last event. + + ``{plugin}_slide`` + Requests a plugin to handle a go to specific slide event. + + ``{plugin}_stop`` + Requests a plugin to handle a stop event. + + ``{plugin}_blank`` + Requests a plugin to handle a blank screen event. + + ``{plugin}_unblank`` + Requests a plugin to handle an unblank screen event. + + ``{plugin}_edit`` + Requests a plugin edit a database item with the key as the payload. + + ``{plugin}_edit_clear`` + Editing has been completed. + + ``{plugin}_load_list`` + Tells the the plugin to reload the media manager list. + + ``{plugin}_preview`` + Tells the plugin it's item can be previewed. + + ``{plugin}_add_service_item`` + Ask the plugin to push the selected items to the service item. + + ``{plugin}_service_load`` + Ask the plugin to process an individual service item after it has been + loaded. + + ``alerts_text`` + Displays an alert message. + + ``bibles_nobook`` + Attempt to find book resulted in no match. + + ``remotes_poll_request`` + Waits for openlp to do something "interesting" and sends a + ``remotes_poll_response`` signal when it does. """ def __init__(self): diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index d2de599f9..aa94454b7 100644 --- a/openlp/core/ui/maindisplay.py +++ b/openlp/core/ui/maindisplay.py @@ -77,9 +77,9 @@ class MainDisplay(QtGui.QGraphicsView): self.setAttribute(QtCore.Qt.WA_DeleteOnClose) if self.isLive: QtCore.QObject.connect(Receiver.get_receiver(), - QtCore.SIGNAL(u'maindisplay_hide'), self.hideDisplay) + QtCore.SIGNAL(u'live_display_hide'), self.hideDisplay) QtCore.QObject.connect(Receiver.get_receiver(), - QtCore.SIGNAL(u'maindisplay_show'), self.showDisplay) + QtCore.SIGNAL(u'live_display_show'), self.showDisplay) QtCore.QObject.connect(Receiver.get_receiver(), QtCore.SIGNAL(u'openlp_phonon_creation'), self.createMediaObject) @@ -570,7 +570,7 @@ class MainDisplay(QtGui.QGraphicsView): self.hideMode = None # Trigger actions when display is active again if self.isLive: - Receiver.send_message(u'maindisplay_active') + Receiver.send_message(u'live_display_active') def __hideMouse(self): # Hide mouse cursor when moved over display if enabled in settings diff --git a/openlp/core/ui/mainwindow.py b/openlp/core/ui/mainwindow.py index 9d58ff82a..47570cd8a 100644 --- a/openlp/core/ui/mainwindow.py +++ b/openlp/core/ui/mainwindow.py @@ -611,11 +611,11 @@ class MainWindow(QtGui.QMainWindow, Ui_MainWindow): QtCore.QObject.connect(Receiver.get_receiver(), QtCore.SIGNAL(u'openlp_version_check'), self.versionNotice) QtCore.QObject.connect(Receiver.get_receiver(), - QtCore.SIGNAL(u'maindisplay_blank_check'), self.blankCheck) + QtCore.SIGNAL(u'live_display_blank_check'), self.blankCheck) QtCore.QObject.connect(Receiver.get_receiver(), QtCore.SIGNAL(u'config_screen_changed'), self.screenChanged) QtCore.QObject.connect(Receiver.get_receiver(), - QtCore.SIGNAL(u'maindisplay_status_text'), self.showStatusMessage) + QtCore.SIGNAL(u'mainwindow_status_text'), self.showStatusMessage) # Media Manager QtCore.QObject.connect(self.mediaToolBox, QtCore.SIGNAL(u'currentChanged(int)'), self.onMediaToolBoxChanged) diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py index 7e6e0d54e..97c30436e 100644 --- a/openlp/core/ui/slidecontroller.py +++ b/openlp/core/ui/slidecontroller.py @@ -743,9 +743,9 @@ class SlideController(QtGui.QWidget): elif display_type == u'blanked': self.onBlankDisplay(True) else: - Receiver.send_message(u'maindisplay_show') + Receiver.send_message(u'live_display_show') else: - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) def onSlideBlank(self): """ @@ -831,21 +831,21 @@ class SlideController(QtGui.QWidget): if self.serviceItem is not None: if hide_mode: if not self.serviceItem.is_command(): - Receiver.send_message(u'maindisplay_hide', hide_mode) + Receiver.send_message(u'live_display_hide', hide_mode) Receiver.send_message(u'%s_blank' % self.serviceItem.name.lower(), [self.serviceItem, self.isLive, hide_mode]) else: if not self.serviceItem.is_command(): - Receiver.send_message(u'maindisplay_show') + Receiver.send_message(u'live_display_show') Receiver.send_message(u'%s_unblank' % self.serviceItem.name.lower(), [self.serviceItem, self.isLive]) else: if hide_mode: - Receiver.send_message(u'maindisplay_hide', hide_mode) + Receiver.send_message(u'live_display_hide', hide_mode) else: - Receiver.send_message(u'maindisplay_show') + Receiver.send_message(u'live_display_show') def hidePlugin(self, hide): """ @@ -854,21 +854,21 @@ class SlideController(QtGui.QWidget): log.debug(u'hidePlugin %s ', hide) if self.serviceItem is not None: if hide: - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) Receiver.send_message(u'%s_hide' % self.serviceItem.name.lower(), [self.serviceItem, self.isLive]) else: if not self.serviceItem.is_command(): - Receiver.send_message(u'maindisplay_show') + Receiver.send_message(u'live_display_show') Receiver.send_message(u'%s_unblank' % self.serviceItem.name.lower(), [self.serviceItem, self.isLive]) else: if hide: - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) else: - Receiver.send_message(u'maindisplay_show') + Receiver.send_message(u'live_display_show') def onSlideSelected(self, start=False): """ diff --git a/openlp/plugins/alerts/lib/alertsmanager.py b/openlp/plugins/alerts/lib/alertsmanager.py index dcf3acafe..8e91aecf5 100644 --- a/openlp/plugins/alerts/lib/alertsmanager.py +++ b/openlp/plugins/alerts/lib/alertsmanager.py @@ -45,7 +45,7 @@ class AlertsManager(QtCore.QObject): self.timer_id = 0 self.alertList = [] QtCore.QObject.connect(Receiver.get_receiver(), - QtCore.SIGNAL(u'maindisplay_active'), self.generateAlert) + QtCore.SIGNAL(u'live_display_active'), self.generateAlert) QtCore.QObject.connect(Receiver.get_receiver(), QtCore.SIGNAL(u'alerts_text'), self.onAlertText) @@ -69,11 +69,11 @@ class AlertsManager(QtCore.QObject): log.debug(u'display alert called %s' % text) self.alertList.append(text) if self.timer_id != 0: - Receiver.send_message(u'maindisplay_status_text', + Receiver.send_message(u'mainwindow_status_text', translate('AlertsPlugin.AlertsManager', 'Alert message created and displayed.')) return - Receiver.send_message(u'maindisplay_status_text', u'') + Receiver.send_message(u'mainwindow_status_text', u'') self.generateAlert() def generateAlert(self): diff --git a/openlp/plugins/presentations/lib/messagelistener.py b/openlp/plugins/presentations/lib/messagelistener.py index d9cc9bdf0..0f38cf02f 100644 --- a/openlp/plugins/presentations/lib/messagelistener.py +++ b/openlp/plugins/presentations/lib/messagelistener.py @@ -68,7 +68,7 @@ class Controller(object): self.doc.slidenumber = slide_no if self.is_live: if hide_mode == HideMode.Screen: - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) self.stop() elif hide_mode == HideMode.Theme: self.blank(hide_mode) @@ -76,7 +76,7 @@ class Controller(object): self.blank(hide_mode) else: self.doc.start_presentation() - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) self.doc.slidenumber = 0 if slide_no > 1: self.slide(slide_no) @@ -196,7 +196,7 @@ class Controller(object): if not self.doc.is_active(): return if hide_mode == HideMode.Theme: - Receiver.send_message(u'maindisplay_hide', HideMode.Theme) + Receiver.send_message(u'live_display_hide', HideMode.Theme) self.doc.blank_screen() def stop(self): @@ -224,7 +224,7 @@ class Controller(object): self.doc.slidenumber != self.doc.get_slide_number(): self.doc.goto_slide(self.doc.slidenumber) self.doc.unblank_screen() - Receiver.send_message(u'maindisplay_hide', HideMode.Screen) + Receiver.send_message(u'live_display_hide', HideMode.Screen) def poll(self): self.doc.poll_slidenumber(self.is_live)