From e141ff1c24a214e75287dcf47826c1452210c393 Mon Sep 17 00:00:00 2001
From: Tim Bentley <tim.bentley@gmail.com>
Date: Thu, 4 Oct 2012 21:12:09 +0100
Subject: [PATCH] Cleanups

---
 openlp/core/ui/media/mediacontroller.py | 41 ++++++++++++++++---------
 openlp/core/ui/slidecontroller.py       |  2 +-
 openlp/plugins/media/lib/mediaitem.py   |  4 +--
 3 files changed, 29 insertions(+), 18 deletions(-)

diff --git a/openlp/core/ui/media/mediacontroller.py b/openlp/core/ui/media/mediacontroller.py
index 501d56c21..d65316d00 100644
--- a/openlp/core/ui/media/mediacontroller.py
+++ b/openlp/core/ui/media/mediacontroller.py
@@ -88,12 +88,15 @@ class MediaController(object):
         for player in self.mediaPlayers.keys():
             self.mediaPlayers[player].isActive = player in savedPlayers
 
-    def register_controllers(self, controller):
+    def register_players(self, player):
         """
         Register each media Player controller (Webkit, Phonon, etc) and store
         for later use
+
+        ``player``
+            Individual player class which has been enabled
         """
-        self.mediaPlayers[controller.name] = controller
+        self.mediaPlayers[player.name] = player
 
     def check_available_media_players(self):
         """
@@ -117,10 +120,10 @@ class MediaController(object):
                     except ImportError:
                         log.warn(u'Failed to import %s on path %s',
                             modulename, path)
-        controller_classes = MediaPlayer.__subclasses__()
-        for controller_class in controller_classes:
-            controller = controller_class(self)
-            self.register_controllers(controller)
+        player_classes = MediaPlayer.__subclasses__()
+        for player_class in player_classes:
+            player = player_class(self)
+            self.register_players(player)
         if not self.mediaPlayers:
             return False
         savedPlayers, overriddenPlayer = get_media_players()
@@ -184,14 +187,28 @@ class MediaController(object):
                 html += player.get_media_display_html()
         return html
 
-    def add_controller_items(self, controller, control_panel):
+    def register_controller(self, controller, control_panel):
+        """
+        Registers media controls where the players will be placed to run.
+
+        ``controller``
+            The controller where a player will be placed
+
+        ``controller_panel``
+            The controllers toolbar where the widgets reside
+        """
         self.controller.append(controller)
         self.setup_generic_controls(controller, control_panel)
-        self.setup_special_controls(controller, control_panel)
 
     def setup_generic_controls(self, controller, control_panel):
         """
-        Add generic media control items (valid for all types of medias)
+        Set up controls on the control_panel for a given controller
+
+        ``controller``
+            First element is the controller which should be used
+
+        ``controller_panel``
+            First element is the controller which should be used
         """
         controller.media_info = MediaInfo()
         # Build a Media ToolBar
@@ -241,12 +258,6 @@ class MediaController(object):
         QtCore.QObject.connect(controller.volumeSlider,
             QtCore.SIGNAL(u'valueChanged(int)'), controller.sendToPlugins)
 
-    def setup_special_controls(self, controller, control_panel):
-        """
-        Special media Toolbars will be created here (e.g. for DVD Playback)
-        """
-        controller.media_info = MediaInfo()
-        # TODO: add Toolbar for DVD, ...
 
     def setup_display(self, display):
         """
diff --git a/openlp/core/ui/slidecontroller.py b/openlp/core/ui/slidecontroller.py
index 1118cf605..33c0b14e2 100644
--- a/openlp/core/ui/slidecontroller.py
+++ b/openlp/core/ui/slidecontroller.py
@@ -270,7 +270,7 @@ class SlideController(Controller):
                 'Edit and reload song preview.'), triggers=self.onEditSong)
         self.controllerLayout.addWidget(self.toolbar)
         # Build the Media Toolbar
-        self.mediaController.add_controller_items(self, self.controllerLayout)
+        self.mediaController.register_controller(self, self.controllerLayout)
         if self.isLive:
             # Build the Song Toolbar
             self.songMenu = QtGui.QToolButton(self.toolbar)
diff --git a/openlp/plugins/media/lib/mediaitem.py b/openlp/plugins/media/lib/mediaitem.py
index 507663e12..c25d2622c 100644
--- a/openlp/plugins/media/lib/mediaitem.py
+++ b/openlp/plugins/media/lib/mediaitem.py
@@ -64,8 +64,8 @@ class MediaMediaItem(MediaManagerItem):
         self.mediaObject = None
         self.mediaController = Controller(parent)
         self.mediaController.controllerLayout = QtGui.QVBoxLayout()
-        self.plugin.mediaController.add_controller_items(self.mediaController,
-            self.mediaController.controllerLayout)
+        self.plugin.mediaController.register_controller(self
+            .mediaController, self.mediaController.controllerLayout)
         self.plugin.mediaController.set_controls_visible(self.mediaController,
             False)
         self.mediaController.previewDisplay = Display(self.mediaController,