1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
|
# (C) Copyright 2008-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
# ------------------------------------------------------------------------------
# Copyright (c) 2007, Riverbank Computing Limited
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD license.
# However, when used with the GPL version of PyQt the additional terms
# described in the PyQt GPL exception also apply
#
# Author: Riverbank Computing Limited
# ------------------------------------------------------------------------------
""" Defines the various color editors for the PyQt user interface toolkit.
"""
from pyface.qt import QtCore, QtGui, is_pyside
from traitsui.editors.color_editor import (
ToolkitEditorFactory as BaseToolkitEditorFactory,
)
from .editor_factory import (
SimpleEditor as BaseSimpleEditor,
TextEditor as BaseTextEditor,
ReadonlyEditor as BaseReadonlyEditor,
)
from .editor import Editor
# Standard color samples:
color_samples = []
# ---------------------------------------------------------------------------
# The PyQt ToolkitEditorFactory class.
# ---------------------------------------------------------------------------
## We need to add qt-specific methods to the editor factory (since all editors
## will be accessing these functions. Making these functions global functions
## in this file does not work quite well, since we want custom editors to
## override these methods easily.
class ToolkitEditorFactory(BaseToolkitEditorFactory):
"""PyQt editor factory for color editors."""
def to_qt_color(self, editor):
"""Gets the PyQt color equivalent of the object trait."""
if self.mapped:
return getattr(editor.object, editor.name + "_")
return getattr(editor.object, editor.name)
def from_qt_color(self, color):
"""Gets the application equivalent of a PyQt value."""
return color
def str_color(self, color):
"""Returns the text representation of a specified color value."""
if isinstance(color, QtGui.QColor):
alpha = color.alpha()
if alpha == 255:
return "(%d,%d,%d)" % (
color.red(),
color.green(),
color.blue(),
)
return "(%d,%d,%d,%d)" % (
color.red(),
color.green(),
color.blue(),
alpha,
)
return color
class SimpleColorEditor(BaseSimpleEditor):
"""Simple style of color editor, which displays a text field whose
background color is the color value. Selecting the text field displays
a dialog box for selecting a new color value.
"""
def popup_editor(self):
"""Invokes the pop-up editor for an object trait."""
color = self.factory.to_qt_color(self)
options = QtGui.QColorDialog.ColorDialogOption.ShowAlphaChannel
if not self.factory.use_native_dialog:
options |= QtGui.QColorDialog.ColorDialogOption.DontUseNativeDialog
color = QtGui.QColorDialog.getColor(
color, self.control, "Select Color", options
)
if color.isValid():
self.value = self.factory.from_qt_color(color)
self.update_editor()
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
super().update_editor()
set_color(self)
def string_value(self, color):
"""Returns the text representation of a specified color value."""
return self.factory.str_color(color)
class CustomColorEditor(Editor):
"""Custom style of color editor, which displays a color editor panel."""
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.control, self._simple_field = color_editor_for(self, parent)
def dispose(self):
"""Disposes of the contents of an editor."""
if getattr(self, "_simple_field", None) is not None:
self._simple_field.dispose()
self._simple_field = None
super().dispose()
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
self._simple_field.update_editor()
def update_object_from_swatch(self, color_text):
"""Updates the object trait when a color swatch is clicked."""
color = QtGui.QColor(*[int(part) for part in color_text.split(",")])
self.value = self.factory.from_qt_color(color)
self.update_editor()
def string_value(self, color):
"""Returns the text representation of a specified color value."""
return self.factory.str_color(color)
class TextColorEditor(BaseTextEditor):
"""Text style of color editor, which displays a text field whose
background color is the color value.
"""
def update_object(self):
"""Handles the user changing the contents of the edit control."""
self.value = str(self.control.text())
set_color(self)
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
super().update_editor()
set_color(self)
def string_value(self, color):
"""Returns the text representation of a specified color value."""
return self.factory.str_color(color)
class ReadonlyColorEditor(BaseReadonlyEditor):
"""Read-only style of color editor, which displays a read-only text field
whose background color is the color value.
"""
def init(self, parent):
"""Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.control = QtGui.QLineEdit()
self.control.setReadOnly(True)
def update_editor(self):
"""Updates the editor when the object trait changes externally to the
editor.
"""
super().update_editor()
set_color(self)
def string_value(self, color):
"""Returns the text representation of a specified color value."""
return self.factory.str_color(color)
# -------------------------------------------------------------------------
# Sets the color of the specified editor's color control:
# -------------------------------------------------------------------------
def set_color(editor):
"""Sets the color of the specified color control."""
color = editor.factory.to_qt_color(editor)
pal = QtGui.QPalette(editor.control.palette())
pal.setColor(QtGui.QPalette.ColorRole.Base, color)
if color.red() > 192 or color.blue() > 192 or color.green() > 192:
pal.setColor(QtGui.QPalette.ColorRole.Text, QtCore.Qt.GlobalColor.black)
else:
pal.setColor(QtGui.QPalette.ColorRole.Text, QtCore.Qt.GlobalColor.white)
editor.control.setPalette(pal)
# ----------------------------------------------------------------------------
# Creates a custom color editor panel for a specified editor:
# ----------------------------------------------------------------------------
class FixedButton(QtGui.QPushButton):
"""Override to work around a bug in Qt 4.7 on Macs.
https://bugreports.qt-project.org/browse/QTBUG-15936
"""
def hitButton(self, pos):
return QtGui.QAbstractButton.hitButton(self, pos)
def color_editor_for(editor, parent):
"""Creates a custom color editor panel for a specified editor."""
# Create the colour samples if it hasn't already been done.
if len(color_samples) == 0:
color_choices = (0, 128, 192, 255)
for r in color_choices:
for g in color_choices:
for b in (0, 128, 255):
color_samples.append(QtGui.QColor(r, g, b))
root = QtGui.QWidget()
panel = QtGui.QHBoxLayout(root)
panel.setContentsMargins(0, 0, 0, 0)
swatch_editor = editor.factory.simple_editor(
editor.ui, editor.object, editor.name, editor.description, None
)
swatch_editor.prepare(parent)
panel.addWidget(swatch_editor.control)
# Add all of the color choice buttons:
grid = QtGui.QGridLayout()
grid.setSpacing(0)
mapper = QtCore.QSignalMapper(panel)
rows = 4
cols = len(color_samples) // rows
i = 0
sheet_template = """
QPushButton {
min-height: 18px;
max-height: 18px;
min-width: 18px;
max-width: 18px;
background-color: rgb(%s);
}
"""
for r in range(rows):
for c in range(cols):
control = FixedButton()
color = color_samples[r * cols + c]
color_text = "%d,%d,%d,%d" % color.getRgb()
control.setStyleSheet(sheet_template % color_text)
control.setAttribute(QtCore.Qt.WidgetAttribute.WA_LayoutUsesWidgetRect, True)
control.clicked.connect(mapper.map)
mapper.setMapping(control, color_text)
grid.addWidget(control, r, c)
editor.set_tooltip(control)
i += 1
if is_pyside and QtCore.__version_info__ >= (5, 15):
mapper.mappedString.connect(editor.update_object_from_swatch)
else:
mapper.mapped[str].connect(editor.update_object_from_swatch)
panel.addLayout(grid)
return root, swatch_editor
# Define the SimpleEditor, CustomEditor, etc. classes which are used by the
# editor factory for the color editor.
SimpleEditor = SimpleColorEditor
CustomEditor = CustomColorEditor
TextEditor = TextColorEditor
ReadonlyEditor = ReadonlyColorEditor
|