Merge lp:~springermac/openlp/bug-1395848 into lp:openlp

[Jonathan Springer]

Fix bug 1395848 by setting the WindowStaysOnTop window flag when the MainDisplay is not on the primary screen.

[Jonathan Springer (springermac)]

lp:~springermac/openlp/bug-1395848 (revision 2540)
[SUCCESS] https//ci.openlp.io/job/Branch-01-Pull/1027/
[SUCCESS] https//ci.openlp.io/job/Branch-02-Functional-Tests/950/
[SUCCESS] https//ci.openlp.io/job/Branch-03-Interface-Tests/892/
[SUCCESS] https//ci.openlp.io/job/Branch-04a-Windows_Functional_Tests/779/
[SUCCESS] https//ci.openlp.io/job/Branch-04b-Windows_Interface_Tests/377/
[SUCCESS] https//ci.openlp.io/job/Branch-05a-Code_Analysis/508/
[SUCCESS] https//ci.openlp.io/job/Branch-05b-Test_Coverage/379/

[Tim Bentley (trb143)]

Can these be two tests with two asserts instead of 4 tests with one assert?

[Jonathan Springer (springermac)]

lp:~springermac/openlp/bug-1395848 (revision 2541)
[SUCCESS] https//ci.openlp.io/job/Branch-01-Pull/1028/
[SUCCESS] https//ci.openlp.io/job/Branch-02-Functional-Tests/951/
[SUCCESS] https//ci.openlp.io/job/Branch-03-Interface-Tests/893/
[SUCCESS] https//ci.openlp.io/job/Branch-04a-Windows_Functional_Tests/780/
[SUCCESS] https//ci.openlp.io/job/Branch-04b-Windows_Interface_Tests/378/
[SUCCESS] https//ci.openlp.io/job/Branch-05a-Code_Analysis/509/
[SUCCESS] https//ci.openlp.io/job/Branch-05b-Test_Coverage/380/

[Tim Bentley (trb143)]

review: Approve

[Raoul Snyman (raoul-snyman)]

I'll need to test this out on Linux to make sure it doesn't mess with anything on there. Let's ask ElderP or tgc to test out on Windows.

[Raoul Snyman (raoul-snyman)]

Seems to work fine.

review: Approve

=== modified file 'openlp/core/ui/maindisplay.py'
--- openlp/core/ui/maindisplay.py	2015-04-02 20:32:20 +0000
+++ openlp/core/ui/maindisplay.py	2015-05-26 04:55:20 +0000
@@ -164,6 +164,8 @@
             # and menu bar
             if self.screens.current['primary']:
                 self.setWindowState(QtCore.Qt.WindowFullScreen)
+            else:
+                window_flags |= QtCore.Qt.WindowStaysOnTopHint
         self.setWindowFlags(window_flags)
         self.setAttribute(QtCore.Qt.WA_DeleteOnClose)
         self.set_transparency(False)

=== modified file 'tests/functional/openlp_core_ui/test_maindisplay.py'
--- tests/functional/openlp_core_ui/test_maindisplay.py	2015-01-19 08:34:29 +0000
+++ tests/functional/openlp_core_ui/test_maindisplay.py	2015-05-26 04:55:20 +0000
@@ -34,12 +34,6 @@
 from tests.helpers.testmixin import TestMixin
 from tests.functional import MagicMock, patch
 
-SCREEN = {
-    'primary': False,
-    'number': 1,
-    'size': QtCore.QRect(0, 0, 1024, 768)
-}
-
 
 class TestMainDisplay(TestCase, TestMixin):
 
@@ -49,9 +43,10 @@
         """
         # Mocked out desktop object
         self.desktop = MagicMock()
-        self.desktop.primaryScreen.return_value = SCREEN['primary']
-        self.desktop.screenCount.return_value = SCREEN['number']
-        self.desktop.screenGeometry.return_value = SCREEN['size']
+        self.desktop.primaryScreen.return_value = 0
+        self.desktop.screenCount.return_value = 2
+        self.desktop.screenGeometry.side_effect = lambda x: {0: QtCore.QRect(0, 0, 1024, 768),
+                                                             1: QtCore.QRect(0, 0, 1024, 768)}[x]
         self.screens = ScreenList.create(self.desktop)
         Registry.create()
         self.registry = Registry()
@@ -69,16 +64,16 @@
 
     def initial_main_display_test(self):
         """
-        Test the initial Main Display state .
+        Test the initial Main Display state
         """
-        # GIVEN: A new slideController instance.
+        # GIVEN: A new SlideController instance.
         display = MagicMock()
         display.is_live = True
 
-        # WHEN: the default controller is built.
+        # WHEN: The default controller is built.
         main_display = MainDisplay(display)
 
-        # THEN: The controller should not be a live controller.
+        # THEN: The controller should be a live controller.
         self.assertEqual(main_display.is_live, True, 'The main display should be a live controller')
 
     def set_transparency_enabled_test(self):
@@ -138,3 +133,42 @@
         # THEN: The plugins should have each been given an opportunity to add their bit to the CSS
         mocked_songs_plugin.refresh_css.assert_called_with(main_display.frame)
         mocked_bibles_plugin.refresh_css.assert_called_with(main_display.frame)
+
+    @patch('openlp.core.ui.maindisplay.is_macosx')
+    def macosx_non_primary_screen_window_flags_state_test(self, is_macosx):
+        """
+        Test that on Mac OS X when the current screen isn't primary we set the proper window flags and window state
+        """
+        # GIVEN: A new SlideController instance on Mac OS X with the current display not being primary.
+        is_macosx.return_value = True
+        self.screens.set_current_display(1)
+        display = MagicMock()
+
+        # WHEN: The default controller is built.
+        main_display = MainDisplay(display)
+
+        # THEN: The window flags and state should be the same as those needed on Mac OS X for the non primary display.
+        self.assertEqual(QtCore.Qt.WindowStaysOnTopHint | QtCore.Qt.Window | QtCore.Qt.FramelessWindowHint,
+                         main_display.windowFlags(),
+                         'The window flags should be Qt.WindowStaysOnTop, Qt.Window, and Qt.FramelessWindowHint.')
+        self.assertNotEqual(QtCore.Qt.WindowFullScreen, main_display.windowState(),
+                            'The window state should not be full screen.')
+
+    @patch('openlp.core.ui.maindisplay.is_macosx')
+    def macosx_primary_screen_window_flags_state_test(self, is_macosx):
+        """
+        Test that on Mac OS X when the current screen is primary we set the proper window flags and window state
+        """
+        # GIVEN: A new SlideController instance on Mac OS X with the current display being primary.
+        is_macosx.return_value = True
+        self.screens.set_current_display(0)
+        display = MagicMock()
+
+        # WHEN: The default controller is built.
+        main_display = MainDisplay(display)
+
+        # THEN: The window flags and state should be the same as those needed on Mac OS X for the primary display.
+        self.assertEqual(QtCore.Qt.Window | QtCore.Qt.FramelessWindowHint, main_display.windowFlags(),
+                         'The window flags should be Qt.Window and Qt.FramelessWindowHint.')
+        self.assertEqual(QtCore.Qt.WindowFullScreen, main_display.windowState(),
+                         'The window state should be full screen.')