Create Screen objects (rather than dictionaries) and capture more details about the screens

This commit is contained in:
Raoul Snyman 2017-12-01 14:53:32 -07:00
parent af5fd0e58b
commit d4daa05686
5 changed files with 136 additions and 151 deletions

View File

@ -62,6 +62,30 @@ def media_players_conv(string):
return string
def upgrade_monitor(number, x_position, y_position, height, width, can_override, can_display_on_monitor):
"""
Upgrade them monitor setting from a few single entries to a composite JSON entry
:param int number: The old monitor number
:param int x_position: The X position
:param int y_position: The Y position
:param bool can_override: Are the screen positions overridden
:param bool can_display_on_monitor: Can OpenLP display on the monitor
:returns dict: Dictionary with the new value
"""
return {
number: {
'displayGeometry': {
'x': x_position,
'y': y_position,
'height': height,
'width': width
}
},
'canDisplayOnMonitor': can_display_on_monitor
}
class Settings(QtCore.QSettings):
"""
Class to wrap QSettings.
@ -255,7 +279,9 @@ class Settings(QtCore.QSettings):
('core/logo file', 'core/logo file', [(str_to_path, None)]),
('presentations/last directory', 'presentations/last directory', [(str_to_path, None)]),
('images/last directory', 'images/last directory', [(str_to_path, None)]),
('media/last directory', 'media/last directory', [(str_to_path, None)])
('media/last directory', 'media/last directory', [(str_to_path, None)]),
(['core/monitor', 'core/x position', 'core/y position', 'core/height', 'core/width', 'core/override',
'core/display on monitor'], 'core/monitors', [(upgrade_monitor, [1, 0, 0, None, None, False, False])])
]
@staticmethod
@ -539,7 +565,7 @@ class Settings(QtCore.QSettings):
elif isinstance(default_value, list):
return []
elif isinstance(setting, str):
if '__Path__' in setting:
if '__Path__' in setting or setting.startswith('{'):
return json.loads(setting, cls=OpenLPJsonDecoder)
# Convert the setting to the correct type.
if isinstance(default_value, bool):

View File

@ -23,8 +23,8 @@
The :mod:`screen` module provides management functionality for a machines'
displays.
"""
import json
import logging
import copy
from PyQt5 import QtCore
@ -35,6 +35,37 @@ from openlp.core.common.i18n import translate
log = logging.getLogger(__name__)
class Screen(object):
"""
A Python representation of a screen
"""
def __init__(self, number=None, geometry=None, is_primary=False, is_display=False):
"""
Set up the screen object
:param int number: The Qt number of this screen
:param QRect geometry: The geometry of this screen as a QRect object
:param bool is_primary: Whether or not this screen is the primary screen
:param bool is_display: Whether or not this screen should be used to display lyrics
"""
self.number = number
self.geometry = geometry
self.display_geometry = geometry
self.is_primary = is_primary
self.is_display = is_display
def __str__(self):
"""
Return a string for displaying this screen
:return str: A nicely formatted string
"""
name = '{screen} {number:d}'.format(screen=translate('OpenLP.ScreenList', 'Screen'), number=self.number + 1)
if self.is_primary:
name = '{name} ({primary})'.format(name=name, primary=translate('OpenLP.ScreenList', 'primary'))
return name
class ScreenList(object):
"""
Wrapper to handle the parameters of the display screen.
@ -52,6 +83,13 @@ class ScreenList(object):
cls.__instance__ = object.__new__(cls)
return cls.__instance__
def __iter__(self):
"""
Convert this object into an iterable, so that we can iterate over it instead of the inner list
"""
for screen in self.screens:
yield screen
@classmethod
def create(cls, desktop):
"""
@ -61,18 +99,15 @@ class ScreenList(object):
"""
screen_list = cls()
screen_list.desktop = desktop
screen_list.preview = None
screen_list.current = None
screen_list.override = None
screen_list.screen_list = []
screen_list.display_count = 0
screen_list.screens = []
screen_list.screen_count_changed()
screen_list.load_screen_settings()
desktop.resized.connect(screen_list.screen_resolution_changed)
desktop.screenCountChanged.connect(screen_list.screen_count_changed)
screen_list.desktop.resized.connect(screen_list.on_screen_resolution_changed)
screen_list.desktop.screenCountChanged.connect(screen_list.on_screen_count_changed)
screen_list.desktop.primaryScreenChanged.connect(screen_list.on_primary_screen_changed)
return screen_list
def screen_resolution_changed(self, number):
def on_screen_resolution_changed(self, number):
"""
Called when the resolution of a screen has changed.
@ -80,24 +115,14 @@ class ScreenList(object):
The number of the screen, which size has changed.
"""
log.info('screen_resolution_changed {number:d}'.format(number=number))
for screen in self.screen_list:
if number == screen['number']:
new_screen = {
'number': number,
'size': self.desktop.screenGeometry(number),
'primary': self.desktop.primaryScreen() == number
}
self.remove_screen(number)
self.add_screen(new_screen)
# The screen's default size is used, that is why we have to
# update the override screen.
if screen == self.override:
self.override = copy.deepcopy(new_screen)
self.set_override_display()
for screen in self.screens:
if number == screen.number:
screen.geometry = self.desktop.screenGeometry(number)
screen.is_primary = self.desktop.primaryScreen() == number
Registry().execute('config_screen_changed')
break
def screen_count_changed(self, changed_screen=-1):
def on_screen_count_changed(self, changed_screen=None):
"""
Called when a screen has been added or removed.
@ -105,130 +130,66 @@ class ScreenList(object):
The screen's number which has been (un)plugged.
"""
# Do not log at start up.
if changed_screen != -1:
log.info('screen_count_changed {count:d}'.format(count=self.desktop.screenCount()))
screen_count = self.desktop.screenCount()
if changed_screen is not None:
log.info('screen_count_changed {count:d}'.format(count=screen_count))
# Remove unplugged screens.
for screen in copy.deepcopy(self.screen_list):
if screen['number'] == self.desktop.screenCount():
self.remove_screen(screen['number'])
del self.screens[screen_count - 1:]
# Add new screens.
for number in range(self.desktop.screenCount()):
if not self.screen_exists(number):
self.add_screen({
'number': number,
'size': self.desktop.screenGeometry(number),
'primary': (self.desktop.primaryScreen() == number)
})
if not self.has_screen(number):
self.screens.append(Screen(number, self.desktop.getGeometry(number),
self.desktop.primaryScreen() == number))
# We do not want to send this message at start up.
if changed_screen != -1:
if changed_screen is not None:
# Reload setting tabs to apply possible changes.
Registry().execute('config_screen_changed')
def get_screen_list(self):
def on_primary_screen_changed(self):
"""
Returns a list with the screens. This should only be used to display
available screens to the user::
The primary screen has changed, let's sort it out and then notify everyone
"""
for screen in self.screens:
screen.is_primary = self.desktop.primaryScreen() == screen.number
Registry().execute('config_screen_changed')
def get_display_screen_list(self):
"""
Returns a list with the screens. This should only be used to display available screens to the user::
['Screen 1 (primary)', 'Screen 2']
"""
screen_list = []
for screen in self.screen_list:
for screen in self.screens:
screen_name = '{name} {number:d}'.format(name=translate('OpenLP.ScreenList', 'Screen'),
number=screen['number'] + 1)
if screen['primary']:
number=screen.number + 1)
if screen.is_primary:
screen_name = '{name} ({primary})'.format(name=screen_name,
primary=translate('OpenLP.ScreenList', 'primary'))
screen_list.append(screen_name)
return screen_list
def add_screen(self, screen):
"""
Add a screen to the list of known screens.
:param screen: A dict with the screen properties:
::
{
'primary': True,
'number': 0,
'size': PyQt5.QtCore.QRect(0, 0, 1024, 768)
}
"""
log.info('Screen {number:d} found with resolution {size}'.format(number=screen['number'], size=screen['size']))
if screen['primary']:
self.current = screen
self.override = copy.deepcopy(self.current)
self.screen_list.append(screen)
self.display_count += 1
def remove_screen(self, number):
"""
Remove a screen from the list of known screens.
:param number: The screen number (int).
"""
log.info('remove_screen {number:d}'.format(number=number))
for screen in self.screen_list:
if screen['number'] == number:
self.screen_list.remove(screen)
self.display_count -= 1
break
def screen_exists(self, number):
def has_screen(self, number):
"""
Confirms a screen is known.
:param number: The screen number (int).
"""
for screen in self.screen_list:
if screen['number'] == number:
for screen in self.screens:
if screen.number == number:
return True
return False
def set_current_display(self, number):
"""
Set up the current screen dimensions.
:param number: The screen number (int).
"""
log.debug('set_current_display {number}'.format(number=number))
if number + 1 > self.display_count:
self.current = self.screen_list[0]
else:
self.current = self.screen_list[number]
self.preview = copy.deepcopy(self.current)
self.override = copy.deepcopy(self.current)
if self.display_count == 1:
self.preview = self.screen_list[0]
def set_override_display(self):
"""
Replace the current size with the override values, as the user wants to have their own screen attributes.
"""
log.debug('set_override_display')
self.current = copy.deepcopy(self.override)
self.preview = copy.deepcopy(self.current)
def reset_current_display(self):
"""
Replace the current values with the correct values, as the user wants to use the correct screen attributes.
"""
log.debug('reset_current_display')
self.set_current_display(self.current['number'])
def which_screen(self, window):
def get_number_for_window(self, window):
"""
Return the screen number that the centre of the passed window is in.
:param window: A QWidget we are finding the location of.
"""
x = window.x() + (window.width() // 2)
y = window.y() + (window.height() // 2)
for screen in self.screen_list:
size = screen['size']
if x >= size.x() and x <= (size.x() + size.width()) and y >= size.y() and y <= (size.y() + size.height()):
return screen['number']
for screen in self.screens:
if screen.geometry == window.geometry() or screen.display_geometry == window.geometry():
return screen
return None
def load_screen_settings(self):
"""
@ -237,27 +198,12 @@ class ScreenList(object):
# Add the screen settings to the settings dict. This has to be done here due to cyclic dependency.
# Do not do this anywhere else.
screen_settings = {
'core/x position': self.current['size'].x(),
'core/y position': self.current['size'].y(),
'core/monitor': self.display_count - 1,
'core/height': self.current['size'].height(),
'core/width': self.current['size'].width()
'core/monitors': '{}'
}
Settings.extend_default_settings(screen_settings)
settings = Settings()
settings.beginGroup('core')
monitor = settings.value('monitor')
self.set_current_display(monitor)
self.display = settings.value('display on monitor')
override_display = settings.value('override position')
x = settings.value('x position')
y = settings.value('y position')
width = settings.value('width')
height = settings.value('height')
self.override['size'] = QtCore.QRect(x, y, width, height)
self.override['primary'] = False
settings.endGroup()
if override_display:
self.set_override_display()
else:
self.reset_current_display()
monitors = json.loads(Settings().value('core/monitors'))
for screen in self.screens:
monitor = monitors.get(screen.number)
if monitor:
screen.display_geometry = QtCore.QRect(monitor['x'], monitor['y'], monitor['width'], monitor['height'])
screen.is_display = True

View File

@ -98,7 +98,7 @@ class DisplayWindow(QtWidgets.QWidget):
"""
This is a window to show the output
"""
def __init__(self, parent=None):
def __init__(self, parent=None, screen=None):
"""
Create the display window
"""
@ -119,10 +119,23 @@ class DisplayWindow(QtWidgets.QWidget):
self.channel = QtWebChannel.QWebChannel(self)
self.channel.registerObject('mediaWatcher', self.media_watcher)
self.webview.page().setWebChannel(self.channel)
if screen and screen.is_display:
self.update_from_screen(screen)
def update_from_screen(self, screen):
"""
Update the number and the geometry from the screen.
:param Screen screen: A `~openlp.core.display.screens.Screen` instance
"""
self.setGeometry(screen.display_geometry)
self.screen_number = screen.number
def set_url(self, url):
"""
Set the URL of the webview
:param str url: The URL to set
"""
if not isinstance(url, QtCore.QUrl):
url = QtCore.QUrl(url)

View File

@ -49,7 +49,7 @@ class GeneralTab(SettingsTab):
"""
self.logo_file = ':/graphics/openlp-splash-screen.png'
self.logo_background_color = '#ffffff'
self.screens = ScreenList()
self.screen_list = ScreenList()
self.icon_path = ':/icon/openlp-logo.svg'
general_translated = translate('OpenLP.GeneralTab', 'General')
super(GeneralTab, self).__init__(parent, 'Core', general_translated)
@ -283,7 +283,7 @@ class GeneralTab(SettingsTab):
settings = Settings()
settings.beginGroup(self.settings_section)
self.monitor_combo_box.clear()
self.monitor_combo_box.addItems(self.screens.get_screen_list())
self.monitor_combo_box.addItems([str(screen) for screen in self.screen_list])
monitor_number = settings.value('monitor')
self.monitor_combo_box.setCurrentIndex(monitor_number)
self.number_edit.setText(settings.value('ccli number'))

View File

@ -137,10 +137,10 @@ class SlideController(QtWidgets.QWidget, LogMixin, RegistryProperties):
if self.displays:
# Delete any existing displays
del self.displays[:]
for screen in self.screens:
display = DisplayWindow(self)
display.resize(screen.current['size'])
# display.media_watcher.progress.connect(self.on_audio_time_remaining)
# for screen in self.screens:
display = DisplayWindow(self, self.screens.current)
self.displays.append(display)
# display.media_watcher.progress.connect(self.on_audio_time_remaining)
def initialise(self):
"""
@ -365,9 +365,9 @@ class SlideController(QtWidgets.QWidget, LogMixin, RegistryProperties):
self.slide_layout.setContentsMargins(0, 0, 0, 0)
self.slide_layout.setObjectName('SlideLayout')
# Set up the preview display
self.preview_display = DisplayWindow(self)
self.slide_layout.insertWidget(0, self.preview_display)
self.preview_display.hide()
# self.preview_display = DisplayWindow(self)
# self.slide_layout.insertWidget(0, self.preview_display)
# self.preview_display.hide()
# Actual preview screen
self.slide_preview = QtWidgets.QLabel(self)
size_policy = QtWidgets.QSizePolicy(QtWidgets.QSizePolicy.Fixed, QtWidgets.QSizePolicy.Fixed)