mirror of https://gitlab.com/openlp/openlp.git
colorbutton
This commit is contained in:
Tim Bentley
parent
c2a2d8545e
commit
6767ba504c
|
|
@ -312,7 +312,6 @@ def create_separated_list(string_list):
|
|||
return translate('OpenLP.core.lib', '%s, %s', 'Locale list separator: start') % (string_list[0], merged)
|
||||
|
||||
|
||||
from .colorbutton import ColorButton
|
||||
from .exceptions import ValidationError
|
||||
from .filedialog import FileDialog
|
||||
from .screen import ScreenList
|
||||
|
|
|
|||
|
|
@ -1,82 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
||||
|
||||
###############################################################################
|
||||
# OpenLP - Open Source Lyrics Projection #
|
||||
# --------------------------------------------------------------------------- #
|
||||
# Copyright (c) 2008-2016 OpenLP Developers #
|
||||
# --------------------------------------------------------------------------- #
|
||||
# This program is free software; you can redistribute it and/or modify it #
|
||||
# under the terms of the GNU General Public License as published by the Free #
|
||||
# Software Foundation; version 2 of the License. #
|
||||
# #
|
||||
# This program is distributed in the hope that it will be useful, but WITHOUT #
|
||||
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
|
||||
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
|
||||
# more details. #
|
||||
# #
|
||||
# You should have received a copy of the GNU General Public License along #
|
||||
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
||||
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
||||
###############################################################################
|
||||
|
||||
"""
|
||||
Provide a custom widget based on QPushButton for the selection of colors
|
||||
"""
|
||||
from PyQt5 import QtCore, QtGui, QtWidgets
|
||||
|
||||
from openlp.core.common import translate
|
||||
|
||||
|
||||
class ColorButton(QtWidgets.QPushButton):
|
||||
"""
|
||||
Subclasses QPushbutton to create a "Color Chooser" button
|
||||
"""
|
||||
|
||||
colorChanged = QtCore.pyqtSignal(str)
|
||||
|
||||
def __init__(self, parent=None):
|
||||
"""
|
||||
Initialise the ColorButton
|
||||
"""
|
||||
super(ColorButton, self).__init__()
|
||||
self.parent = parent
|
||||
self.change_color('#ffffff')
|
||||
self.setToolTip(translate('OpenLP.ColorButton', 'Click to select a color.'))
|
||||
self.clicked.connect(self.on_clicked)
|
||||
|
||||
def change_color(self, color):
|
||||
"""
|
||||
Sets the _color variable and the background color.
|
||||
|
||||
:param color: String representation of a hexidecimal color
|
||||
"""
|
||||
self._color = color
|
||||
self.setStyleSheet('background-color: %s' % color)
|
||||
|
||||
@property
|
||||
def color(self):
|
||||
"""
|
||||
Property method to return the color variable
|
||||
|
||||
:return: String representation of a hexidecimal color
|
||||
"""
|
||||
return self._color
|
||||
|
||||
@color.setter
|
||||
def color(self, color):
|
||||
"""
|
||||
Property setter to change the instance color
|
||||
|
||||
:param color: String representation of a hexidecimal color
|
||||
"""
|
||||
self.change_color(color)
|
||||
|
||||
def on_clicked(self):
|
||||
"""
|
||||
Handle the PushButton clicked signal, showing the ColorDialog and validating the input
|
||||
"""
|
||||
new_color = QtWidgets.QColorDialog.getColor(QtGui.QColor(self._color), self.parent)
|
||||
if new_color.isValid() and self._color != new_color.name():
|
||||
self.change_color(new_color.name())
|
||||
self.colorChanged.emit(new_color.name())
|
||||
|
|
@ -27,7 +27,8 @@ import logging
|
|||
from PyQt5 import QtCore, QtGui, QtWidgets
|
||||
|
||||
from openlp.core.common import Registry, Settings, UiStrings, translate, get_images_filter
|
||||
from openlp.core.lib import SettingsTab, ScreenList, ColorButton, build_icon
|
||||
from openlp.core.lib import SettingsTab, ScreenList, build_icon
|
||||
from openlp.core.ui.lib.colorbutton import ColorButton
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
|
|
|
|||
|
|
@ -19,3 +19,5 @@
|
|||
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
||||
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
||||
###############################################################################
|
||||
|
||||
from openlp.core.ui.lib.colorbutton import ColorButton
|
||||
|
|
@ -26,9 +26,10 @@ import platform
|
|||
from PyQt5 import QtCore, QtWidgets
|
||||
|
||||
from openlp.core.common import Registry, Settings, UiStrings, translate
|
||||
from openlp.core.lib import ColorButton, SettingsTab
|
||||
from openlp.core.lib import SettingsTab
|
||||
from openlp.core.lib.ui import create_button
|
||||
from openlp.core.ui.media import get_media_players, set_media_players
|
||||
from openlp.core.ui.lib.colorbutton import ColorButton
|
||||
|
||||
|
||||
class MediaQCheckBox(QtWidgets.QCheckBox):
|
||||
|
|
|
|||
|
|
@ -31,6 +31,7 @@ from openlp.core.common import Registry, RegistryProperties, UiStrings, translat
|
|||
from openlp.core.lib.theme import BackgroundType, BackgroundGradientType
|
||||
from openlp.core.lib.ui import critical_error_message_box
|
||||
from openlp.core.ui import ThemeLayoutForm
|
||||
from openlp.core.ui.lib.colorbutton import ColorButton
|
||||
from .themewizard import Ui_ThemeWizard
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
|
|
|||
|
|
@ -25,9 +25,10 @@ The Create/Edit theme wizard
|
|||
from PyQt5 import QtCore, QtGui, QtWidgets
|
||||
|
||||
from openlp.core.common import UiStrings, translate, is_macosx
|
||||
from openlp.core.lib import build_icon, ColorButton
|
||||
from openlp.core.lib import build_icon
|
||||
from openlp.core.lib.theme import HorizontalType, BackgroundType, BackgroundGradientType
|
||||
from openlp.core.lib.ui import add_welcome_page, create_valign_selection_widgets
|
||||
from openlp.core.ui.lib.colorbutton import ColorButton
|
||||
|
||||
|
||||
class Ui_ThemeWizard(object):
|
||||
|
|
|
|||
|
|
@ -1,199 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# vim: autoindent shiftwidth=4 expandtab textwidth=120 tabstop=4 softtabstop=4
|
||||
|
||||
###############################################################################
|
||||
# OpenLP - Open Source Lyrics Projection #
|
||||
# --------------------------------------------------------------------------- #
|
||||
# Copyright (c) 2008-2016 OpenLP Developers #
|
||||
# --------------------------------------------------------------------------- #
|
||||
# This program is free software; you can redistribute it and/or modify it #
|
||||
# under the terms of the GNU General Public License as published by the Free #
|
||||
# Software Foundation; version 2 of the License. #
|
||||
# #
|
||||
# This program is distributed in the hope that it will be useful, but WITHOUT #
|
||||
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
|
||||
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
|
||||
# more details. #
|
||||
# #
|
||||
# You should have received a copy of the GNU General Public License along #
|
||||
# with this program; if not, write to the Free Software Foundation, Inc., 59 #
|
||||
# Temple Place, Suite 330, Boston, MA 02111-1307 USA #
|
||||
###############################################################################
|
||||
"""
|
||||
This module contains tests for the openlp.core.lib.filedialog module
|
||||
"""
|
||||
from unittest import TestCase
|
||||
|
||||
from openlp.core.lib.colorbutton import ColorButton
|
||||
from tests.functional import MagicMock, call, patch
|
||||
|
||||
|
||||
class TestColorDialog(TestCase):
|
||||
"""
|
||||
Test the :class:`~openlp.core.lib.colorbutton.ColorButton` class
|
||||
"""
|
||||
def setUp(self):
|
||||
self.change_color_patcher = patch('openlp.core.lib.colorbutton.ColorButton.change_color')
|
||||
self.clicked_patcher = patch('openlp.core.lib.colorbutton.ColorButton.clicked')
|
||||
self.color_changed_patcher = patch('openlp.core.lib.colorbutton.ColorButton.colorChanged')
|
||||
self.qt_gui_patcher = patch('openlp.core.lib.colorbutton.QtWidgets')
|
||||
self.translate_patcher = patch('openlp.core.lib.colorbutton.translate', **{'return_value': 'Tool Tip Text'})
|
||||
self.addCleanup(self.change_color_patcher.stop)
|
||||
self.addCleanup(self.clicked_patcher.stop)
|
||||
self.addCleanup(self.color_changed_patcher.stop)
|
||||
self.addCleanup(self.qt_gui_patcher.stop)
|
||||
self.addCleanup(self.translate_patcher.stop)
|
||||
self.mocked_change_color = self.change_color_patcher.start()
|
||||
self.mocked_clicked = self.clicked_patcher.start()
|
||||
self.mocked_color_changed = self.color_changed_patcher.start()
|
||||
self.mocked_qt_widgets = self.qt_gui_patcher.start()
|
||||
self.mocked_translate = self.translate_patcher.start()
|
||||
|
||||
def constructor_test(self):
|
||||
"""
|
||||
Test that constructing a ColorButton object works correctly
|
||||
"""
|
||||
|
||||
# GIVEN: The ColorButton class, a mocked change_color, setToolTip methods and clicked signal
|
||||
with patch('openlp.core.lib.colorbutton.ColorButton.setToolTip') as mocked_set_tool_tip:
|
||||
|
||||
# WHEN: The ColorButton object is instantiated
|
||||
widget = ColorButton()
|
||||
|
||||
# THEN: The widget __init__ method should have the correct properties and methods called
|
||||
self.assertEqual(widget.parent, None,
|
||||
'The parent should be the same as the one that the class was instianted with')
|
||||
self.mocked_change_color.assert_called_once_with('#ffffff')
|
||||
mocked_set_tool_tip.assert_called_once_with('Tool Tip Text')
|
||||
self.mocked_clicked.connect.assert_called_once_with(widget.on_clicked)
|
||||
|
||||
def change_color_test(self):
|
||||
"""
|
||||
Test that change_color sets the new color and the stylesheet
|
||||
"""
|
||||
self.change_color_patcher.stop()
|
||||
|
||||
# GIVEN: An instance of the ColorButton object, and a mocked out setStyleSheet
|
||||
with patch('openlp.core.lib.colorbutton.ColorButton.setStyleSheet') as mocked_set_style_sheet:
|
||||
widget = ColorButton()
|
||||
|
||||
# WHEN: Changing the color
|
||||
widget.change_color('#000000')
|
||||
|
||||
# THEN: The _color attribute should be set to #000000 and setStyleSheet should have been called twice
|
||||
self.assertEqual(widget._color, '#000000', '_color should have been set to #000000')
|
||||
mocked_set_style_sheet.assert_has_calls(
|
||||
[call('background-color: #ffffff'), call('background-color: #000000')])
|
||||
|
||||
self.mocked_change_color = self.change_color_patcher.start()
|
||||
|
||||
def color_test(self):
|
||||
"""
|
||||
Test that the color property method returns the set color
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, with a set _color attribute
|
||||
widget = ColorButton()
|
||||
widget._color = '#000000'
|
||||
|
||||
# WHEN: Accesing the color property
|
||||
value = widget.color
|
||||
|
||||
# THEN: The value set in _color should be returned
|
||||
self.assertEqual(value, '#000000', 'The value returned should be equal to the one we set')
|
||||
|
||||
def color_test(self):
|
||||
"""
|
||||
Test that the color property method returns the set color
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, with a set _color attribute
|
||||
widget = ColorButton()
|
||||
widget._color = '#000000'
|
||||
|
||||
# WHEN: Accesing the color property
|
||||
value = widget.color
|
||||
|
||||
# THEN: The value set in _color should be returned
|
||||
self.assertEqual(value, '#000000', 'The value returned should be equal to the one we set')
|
||||
|
||||
def color_setter_test(self):
|
||||
"""
|
||||
Test that the color property setter method sets the color
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, with a mocked __init__
|
||||
with patch('openlp.core.lib.colorbutton.ColorButton.__init__', **{'return_value': None}):
|
||||
widget = ColorButton()
|
||||
|
||||
# WHEN: Setting the color property
|
||||
widget.color = '#000000'
|
||||
|
||||
# THEN: Then change_color should have been called with the value we set
|
||||
self.mocked_change_color.assert_called_once_with('#000000')
|
||||
|
||||
def on_clicked_invalid_color_test(self):
|
||||
"""
|
||||
Test the on_click method when an invalid color has been supplied
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, and a set _color attribute
|
||||
widget = ColorButton()
|
||||
self.mocked_change_color.reset_mock()
|
||||
self.mocked_color_changed.reset_mock()
|
||||
widget._color = '#000000'
|
||||
|
||||
# WHEN: The on_clicked method is called, and the color is invalid
|
||||
self.mocked_qt_widgets.QColorDialog.getColor.return_value = MagicMock(**{'isValid.return_value': False})
|
||||
widget.on_clicked()
|
||||
|
||||
# THEN: change_color should not have been called and the colorChanged signal should not have been emitted
|
||||
self.assertEqual(
|
||||
self.mocked_change_color.call_count, 0, 'change_color should not have been called with an invalid color')
|
||||
self.assertEqual(
|
||||
self.mocked_color_changed.emit.call_count, 0,
|
||||
'colorChange signal should not have been emitted with an invalid color')
|
||||
|
||||
def on_clicked_same_color_test(self):
|
||||
"""
|
||||
Test the on_click method when a new color has not been chosen
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, and a set _color attribute
|
||||
widget = ColorButton()
|
||||
self.mocked_change_color.reset_mock()
|
||||
self.mocked_color_changed.reset_mock()
|
||||
widget._color = '#000000'
|
||||
|
||||
# WHEN: The on_clicked method is called, and the color is valid, but the same as the existing color
|
||||
self.mocked_qt_widgets.QColorDialog.getColor.return_value = MagicMock(
|
||||
**{'isValid.return_value': True, 'name.return_value': '#000000'})
|
||||
widget.on_clicked()
|
||||
|
||||
# THEN: change_color should not have been called and the colorChanged signal should not have been emitted
|
||||
self.assertEqual(
|
||||
self.mocked_change_color.call_count, 0,
|
||||
'change_color should not have been called when the color has not changed')
|
||||
self.assertEqual(
|
||||
self.mocked_color_changed.emit.call_count, 0,
|
||||
'colorChange signal should not have been emitted when the color has not changed')
|
||||
|
||||
def on_clicked_new_color_test(self):
|
||||
"""
|
||||
Test the on_click method when a new color has been chosen and is valid
|
||||
"""
|
||||
|
||||
# GIVEN: An instance of ColorButton, and a set _color attribute
|
||||
widget = ColorButton()
|
||||
self.mocked_change_color.reset_mock()
|
||||
self.mocked_color_changed.reset_mock()
|
||||
widget._color = '#000000'
|
||||
|
||||
# WHEN: The on_clicked method is called, and the color is valid, and different to the existing color
|
||||
self.mocked_qt_widgets.QColorDialog.getColor.return_value = MagicMock(
|
||||
**{'isValid.return_value': True, 'name.return_value': '#ffffff'})
|
||||
widget.on_clicked()
|
||||
|
||||
# THEN: change_color should have been called and the colorChanged signal should have been emitted
|
||||
self.mocked_change_color.assert_called_once_with('#ffffff')
|
||||
self.mocked_color_changed.emit.assert_called_once_with('#ffffff')
|
||||
Loading…
Reference in New Issue