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
|
#------------------------------------------------------------------------------
# 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
#------------------------------------------------------------------------------
"""Creates a PyQt user interface for a specified UI object.
"""
from pyface.qt import QtCore, QtGui
from traitsui.menu \
import ApplyButton, RevertButton, OKButton, CancelButton, HelpButton
from ui_base \
import BaseDialog
from ui_panel \
import panel
#-------------------------------------------------------------------------------
# Create the different modal PyQt user interfaces.
#-------------------------------------------------------------------------------
def ui_modal(ui, parent):
"""Creates a modal PyQt user interface for a specified UI object.
"""
_ui_dialog(ui, parent, BaseDialog.MODAL)
def ui_nonmodal(ui, parent):
"""Creates a non-modal PyQt user interface for a specified UI object.
"""
_ui_dialog(ui, parent, BaseDialog.NONMODAL)
def _ui_dialog(ui, parent, style):
"""Creates a PyQt dialog box for a specified UI object.
Changes are not immediately applied to the underlying object. The user
must click **Apply** or **OK** to apply changes. The user can revert
changes by clicking **Revert** or **Cancel**.
"""
if ui.owner is None:
ui.owner = _ModalDialog()
BaseDialog.display_ui(ui, parent, style)
class _ModalDialog(BaseDialog):
"""Modal dialog box for Traits-based user interfaces.
"""
def init(self, ui, parent, style):
"""Initialise the object.
"""
self.ui = ui
self.control = ui.control
view = ui.view
revert = apply = False
if self.control is not None:
if hasattr(self, 'revert'):
revert = self.revert.isEnabled()
if hasattr(self, 'apply'):
apply = self.apply.isEnabled()
ui.reset()
else:
self.create_dialog(parent, style)
# Create the 'context' copies we will need while editing:
context = ui.context
ui._context = context
ui.context = self._copy_context(context)
ui._revert = self._copy_context(context)
self.set_icon(view.icon)
# Convert the buttons to actions.
buttons = [self.coerce_button(button) for button in view.buttons]
nr_buttons = len(buttons)
if (nr_buttons != 1) or (not self.is_button(buttons[0], '')):
bbox = QtGui.QDialogButtonBox()
# Create the necessary special function buttons.
if nr_buttons == 0:
if view.apply:
self.check_button(buttons, ApplyButton)
if view.revert:
self.check_button(buttons, RevertButton)
if view.ok:
self.check_button(buttons, OKButton)
if view.cancel:
self.check_button(buttons, CancelButton)
if view.help:
self.check_button(buttons, HelpButton)
for raw_button, button in zip(view.buttons, buttons):
default = raw_button == view.default_button
if self.is_button(button, 'Apply'):
self.apply = self.add_button(button, bbox,
QtGui.QDialogButtonBox.ApplyRole, self._on_apply,
enabled=apply, default=default)
ui.on_trait_change(self._on_applyable, 'modified',
dispatch='ui')
elif self.is_button(button, 'Revert'):
self.revert = self.add_button(button, bbox,
QtGui.QDialogButtonBox.ResetRole, self._on_revert,
enabled=revert, default=default)
elif self.is_button(button, 'OK'):
self.ok = self.add_button(button, bbox,
QtGui.QDialogButtonBox.AcceptRole,
self.control.accept, default=default)
ui.on_trait_change(self._on_error, 'errors', dispatch='ui')
elif self.is_button(button, 'Cancel'):
self.add_button(button, bbox,
QtGui.QDialogButtonBox.RejectRole,
self.control.reject, default=default)
elif self.is_button(button, 'Help'):
self.add_button(button, bbox,
QtGui.QDialogButtonBox.HelpRole, self._on_help,
default=default)
elif not self.is_button(button, ''):
self.add_button(button, bbox,
QtGui.QDialogButtonBox.ActionRole, default=default)
else:
bbox = None
self.add_contents(panel(ui), bbox)
def close(self, rc):
"""Close the dialog and set the given return code.
"""
super(_ModalDialog, self).close(rc)
self.apply = self.revert = self.help = None
def _copy_context(self, context):
"""Creates a copy of a *context* dictionary.
"""
result = {}
for name, value in context.items():
if value is not None:
result[name] = value.clone_traits()
else:
result[name] = None
return result
def _apply_context(self, from_context, to_context):
"""Applies the traits in the *from_context* to the *to_context*.
"""
for name, value in from_context.items():
if value is not None:
to_context[name].copy_traits(value)
else:
to_context[name] = None
if to_context is self.ui._context:
on_apply = self.ui.view.on_apply
if on_apply is not None:
on_apply()
def _on_finished(self, result):
"""Handles the user finishing with the dialog.
"""
accept = bool(result)
if accept:
self._apply_context(self.ui.context, self.ui._context)
else:
self._apply_context(self.ui._revert, self.ui._context)
self.close(accept)
def _on_apply(self):
"""Handles a request to apply changes.
"""
ui = self.ui
self._apply_context(ui.context, ui._context)
self.revert.setEnabled(True)
ui.handler.apply(ui.info)
ui.modified = False
def _on_applyable(self, state):
"""Handles a change to the "modified" state of the user interface .
"""
self.apply.setEnabled( state )
def _on_revert(self):
"""Handles a request to revert changes.
"""
ui = self.ui
self._apply_context(ui._revert, ui.context)
self._apply_context(ui._revert, ui._context)
self.revert.setEnabled(False)
ui.handler.revert(ui.info)
ui.modified = False
|