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
|
#------------------------------------------------------------------------------
# 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 editors for multi-selection enumerations, for the PyQt
user interface toolkit.
"""
#-------------------------------------------------------------------------------
# Imports:
#-------------------------------------------------------------------------------
import logging
from string import capitalize
from pyface.qt import QtCore, QtGui
from traits.api \
import List, Unicode, TraitError
# FIXME: ToolkitEditorFactory is a proxy class defined here just for backward
# compatibility. The class has been moved to the
# traitsui.editors.check_list_editor file.
from traitsui.editors.check_list_editor \
import ToolkitEditorFactory
from editor_factory \
import TextEditor as BaseTextEditor
from editor \
import EditorWithList
logger = logging.getLogger(__name__)
#-------------------------------------------------------------------------------
# 'SimpleEditor' class:
#-------------------------------------------------------------------------------
class SimpleEditor ( EditorWithList ):
""" Simple style of editor for checklists, which displays a combo box.
"""
#---------------------------------------------------------------------------
# Trait definitions:
#---------------------------------------------------------------------------
# Checklist item names
names = List( Unicode )
# Checklist item values
values = List
#---------------------------------------------------------------------------
# Finishes initializing the editor by creating the underlying toolkit
# widget:
#---------------------------------------------------------------------------
def init ( self, parent ):
""" Finishes initializing the editor by creating the underlying toolkit
widget.
"""
self.create_control( parent )
super( SimpleEditor, self ).init( parent )
#---------------------------------------------------------------------------
# Creates the initial editor control:
#---------------------------------------------------------------------------
def create_control ( self, parent ):
""" Creates the initial editor control.
"""
self.control = QtGui.QComboBox()
QtCore.QObject.connect(self.control,
QtCore.SIGNAL('activated(QString)'), self.update_object)
#---------------------------------------------------------------------------
# Handles the list of legal check list values being updated:
#---------------------------------------------------------------------------
def list_updated ( self, values ):
""" Handles updates to the list of legal checklist values.
"""
sv = self.string_value
if (len( values ) > 0) and isinstance( values[0], basestring ):
values = [ ( x, sv( x, capitalize ) ) for x in values ]
self.values = valid_values = [ x[0] for x in values ]
self.names = [ x[1] for x in values ]
# Make sure the current value is still legal:
modified = False
cur_value = parse_value( self.value )
for i in range( len( cur_value ) - 1, -1, -1 ):
if cur_value[i] not in valid_values:
try:
del cur_value[i]
modified = True
except TypeError, e:
logger.warn('Unable to remove non-current value [%s] from '
'values %s', cur_value[i], values)
if modified:
if isinstance( self.value, basestring ):
cur_value = ','.join( cur_value )
self.value = cur_value
self.rebuild_editor()
#---------------------------------------------------------------------------
# Rebuilds the editor after its definition is modified:
#---------------------------------------------------------------------------
def rebuild_editor ( self ):
""" Rebuilds the editor after its definition is modified.
"""
control = self.control
control.clear()
for name in self.names:
control.addItem(name)
self.update_editor()
#----------------------------------------------------------------------------
# Handles the user selecting a new value from the combo box:
#----------------------------------------------------------------------------
def update_object ( self, text ):
""" Handles the user selecting a new value from the combo box.
"""
value = self.values[self.names.index(unicode(text))]
if not isinstance(self.value, basestring):
value = [value]
self.value = value
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes externally to the
editor.
"""
try:
self.control.setCurrentIndex(
self.values.index(parse_value(self.value)[0]))
except:
pass
#-------------------------------------------------------------------------------
# 'CustomEditor' class:
#-------------------------------------------------------------------------------
class CustomEditor ( SimpleEditor ):
""" Custom style of editor for checklists, which displays a set of check
boxes.
"""
#---------------------------------------------------------------------------
# Creates the initial editor control:
#---------------------------------------------------------------------------
def create_control ( self, parent ):
""" Creates the initial editor control.
"""
self.control = QtGui.QWidget()
layout = QtGui.QGridLayout(self.control)
layout.setContentsMargins(0, 0, 0, 0)
self._mapper = QtCore.QSignalMapper()
QtCore.QObject.connect(self._mapper,
QtCore.SIGNAL('mapped(const QString &)'), self.update_object)
#---------------------------------------------------------------------------
# Rebuilds the editor after its definition is modified:
#---------------------------------------------------------------------------
def rebuild_editor ( self ):
""" Rebuilds the editor after its definition is modified.
"""
# Clear any existing content:
self.clear_layout()
cur_value = parse_value( self.value )
# Create a sizer to manage the radio buttons:
labels = self.names
values = self.values
n = len( labels )
cols = self.factory.cols
rows = (n + cols - 1) / cols
incr = [ n / cols ] * cols
rem = n % cols
for i in range( cols ):
incr[i] += (rem > i)
incr[-1] = -(reduce( lambda x, y: x + y, incr[:-1], 0 ) - 1)
# Add the set of all possible choices:
layout = self.control.layout()
index = 0
for i in range( rows ):
for j in range( cols ):
if n > 0:
cb = QtGui.QCheckBox(labels[index])
cb.value = values[index]
if cb.value in cur_value:
cb.setCheckState(QtCore.Qt.Checked)
else:
cb.setCheckState(QtCore.Qt.Unchecked)
QtCore.QObject.connect(cb,
QtCore.SIGNAL('clicked()'),
self._mapper,
QtCore.SLOT('map()'))
self._mapper.setMapping(cb, labels[index])
layout.addWidget(cb, i, j)
index += incr[j]
n -= 1
#---------------------------------------------------------------------------
# Handles the user clicking one of the 'custom' check boxes:
#---------------------------------------------------------------------------
def update_object(self, label):
""" Handles the user clicking one of the custom check boxes.
"""
cb = self._mapper.mapping(label)
cur_value = parse_value(self.value)
if cb.checkState() == QtCore.Qt.Checked:
cur_value.append(cb.value)
elif cb.value in cur_value:
cur_value.remove(cb.value)
if isinstance(self.value, basestring):
cur_value = ','.join(cur_value)
self.value = cur_value
#---------------------------------------------------------------------------
# Updates the editor when the object trait changes external to the editor:
#---------------------------------------------------------------------------
def update_editor ( self ):
""" Updates the editor when the object trait changes externally to the
editor.
"""
new_values = parse_value( self.value )
for cb in self.control.findChildren(QtGui.QCheckBox, None):
if cb.value in new_values:
cb.setCheckState(QtCore.Qt.Checked)
else:
cb.setCheckState(QtCore.Qt.Unchecked)
#-------------------------------------------------------------------------------
# 'TextEditor' class:
#-------------------------------------------------------------------------------
class TextEditor ( BaseTextEditor ):
""" Text style of editor for checklists, which displays a text field.
"""
#---------------------------------------------------------------------------
# Handles the user changing the contents of the edit control:
#---------------------------------------------------------------------------
def update_object ( self, event=None ):
""" Handles the user changing the contents of the edit control.
"""
try:
value = unicode(self.control.text())
value = eval( value )
except:
pass
try:
self.value = value
except TraitError, excp:
pass
#-------------------------------------------------------------------------------
# Parse a value into a list:
#-------------------------------------------------------------------------------
def parse_value ( value ):
""" Parses a value into a list.
"""
if value is None:
return []
if type( value ) is not str:
return value[:]
return [ x.strip() for x in value.split( ',' ) ]
|