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
|
# (C) Copyright 2007 Riverbank Computing Limited
# (C) Copyright 2005-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!
import weakref
from pyface.qt import QtCore, QtGui
from traits.api import (
Enum,
Event,
Property,
Tuple,
Str,
VetoableEvent,
provides,
)
from pyface.i_window import IWindow, MWindow
from pyface.key_pressed_event import KeyPressedEvent
from .gui import GUI
from .widget import Widget
@provides(IWindow)
class Window(MWindow, Widget):
""" The toolkit specific implementation of a Window. See the IWindow
interface for the API documentation.
"""
# 'IWindow' interface -----------------------------------------------------
position = Property(Tuple)
size = Property(Tuple)
size_state = Enum("normal", "maximized")
title = Str()
# Window Events ----------------------------------------------------------
#: The window has been opened.
opened = Event()
#: The window is about to open.
opening = VetoableEvent()
#: The window has been activated.
activated = Event()
#: The window has been closed.
closed = Event()
#: The window is about to be closed.
closing = VetoableEvent()
#: The window has been deactivated.
deactivated = Event()
# Private interface ------------------------------------------------------
#: Shadow trait for position.
_position = Tuple((-1, -1))
#: Shadow trait for size.
_size = Tuple((-1, -1))
# -------------------------------------------------------------------------
# 'IWindow' interface.
# -------------------------------------------------------------------------
def activate(self):
self.control.activateWindow()
self.control.raise_()
# explicitly fire activated trait as signal doesn't create Qt event
self.activated = self
# -------------------------------------------------------------------------
# Protected 'IWindow' interface.
# -------------------------------------------------------------------------
def _create_control(self, parent):
""" Create a default QMainWindow. """
control = QtGui.QMainWindow(parent)
if self.size != (-1, -1):
control.resize(*self.size)
if self.position != (-1, -1):
control.move(*self.position)
if self.size_state != "normal":
self._size_state_changed(self.size_state)
control.setWindowTitle(self.title)
control.setEnabled(self.enabled)
# XXX starting with visible true is not recommended
control.setVisible(self.visible)
return control
# -------------------------------------------------------------------------
# 'IWidget' interface.
# -------------------------------------------------------------------------
def destroy(self):
if self.control is not None:
# Avoid problems with recursive calls.
# Widget.destroy() sets self.control to None,
# so we need a reference to control
control = self.control
# Widget.destroy() sets self.control to None and deletes it later,
# so we call it before control.close()
# This is not strictly necessary (closing the window in fact
# hides it), but the close may trigger an application shutdown,
# which can take a long time and may also attempt to recursively
# destroy the window again.
super().destroy()
control.close()
control.hide()
# -------------------------------------------------------------------------
# Private interface.
# -------------------------------------------------------------------------
def _get_position(self):
""" Property getter for position. """
return self._position
def _set_position(self, position):
""" Property setter for position. """
if self.control is not None:
self.control.move(*position)
old = self._position
self._position = position
self.trait_property_changed("position", old, position)
def _get_size(self):
""" Property getter for size. """
return self._size
def _set_size(self, size):
""" Property setter for size. """
if self.control is not None:
self.control.resize(*size)
old = self._size
self._size = size
self.trait_property_changed("size", old, size)
def _size_state_changed(self, state):
control = self.control
if control is None:
return # Nothing to do here
if state == "maximized":
control.setWindowState(
control.windowState() | QtCore.Qt.WindowState.WindowMaximized
)
elif state == "normal":
control.setWindowState(
control.windowState() & ~QtCore.Qt.WindowState.WindowMaximized
)
def _title_changed(self, title):
""" Static trait change handler. """
if self.control is not None:
self.control.setWindowTitle(title)
def __event_filter_default(self):
return WindowEventFilter(self)
class WindowEventFilter(QtCore.QObject):
""" An internal class that watches for certain events on behalf of the
Window instance.
"""
def __init__(self, window):
""" Initialise the event filter. """
QtCore.QObject.__init__(self)
# use a weakref to fix finalization issues with circular references
# we don't want to be the last thing holding a reference to the window
self._window = weakref.ref(window)
def eventFilter(self, obj, e):
""" Adds any event listeners required by the window. """
window = self._window()
# Sanity check.
if window is None or obj is not window.control:
return False
typ = e.type()
if typ == QtCore.QEvent.Type.Close:
# Do not destroy the window during its event handler.
GUI.invoke_later(window.close)
if window.control is not None:
e.ignore()
return True
if typ == QtCore.QEvent.Type.WindowActivate:
window.activated = window
elif typ == QtCore.QEvent.Type.WindowDeactivate:
window.deactivated = window
elif typ in {QtCore.QEvent.Type.Show, QtCore.QEvent.Type.Hide}:
window.visible = window.control.isVisible()
elif typ == QtCore.QEvent.Type.Resize:
# Get the new size and set the shadow trait without performing
# notification.
size = e.size()
window._size = (size.width(), size.height())
elif typ == QtCore.QEvent.Type.Move:
# Get the real position and set the trait without performing
# notification. Don't use event.pos(), as this excludes the window
# frame geometry.
pos = window.control.pos()
window._position = (pos.x(), pos.y())
elif typ == QtCore.QEvent.Type.KeyPress:
# Pyface doesn't seem to be Str aware. Only keep the key code
# if it corresponds to a single Latin1 character.
kstr = e.text()
try:
kcode = ord(str(kstr))
except:
kcode = 0
mods = e.modifiers()
window.key_pressed = KeyPressedEvent(
alt_down=(
(mods & QtCore.Qt.KeyboardModifier.AltModifier) == QtCore.Qt.KeyboardModifier.AltModifier
),
control_down=(
(mods & QtCore.Qt.KeyboardModifier.ControlModifier)
== QtCore.Qt.KeyboardModifier.ControlModifier
),
shift_down=(
(mods & QtCore.Qt.KeyboardModifier.ShiftModifier) == QtCore.Qt.KeyboardModifier.ShiftModifier
),
key_code=kcode,
event=e,
)
elif typ == QtCore.QEvent.Type.WindowStateChange:
# set the size_state of the window.
state = obj.windowState()
if state & QtCore.Qt.WindowState.WindowMaximized:
window.size_state = "maximized"
else:
window.size_state = "normal"
return False
|