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
|
# (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!
""" The interface of a pyface GUI. """
import logging
import os
from traits.etsconfig.api import ETSConfig
from traits.api import Bool, HasTraits, Interface, Str
# Logging.
logger = logging.getLogger(__name__)
class IGUI(Interface):
""" The interface of a pyface GUI. """
# 'GUI' interface -----------------------------------------------------#
#: Is the GUI busy (i.e. should the busy cursor, often an hourglass, be
#: displayed)?
busy = Bool(False)
#: Has the GUI's event loop been started?
started = Bool(False)
#: A directory on the local file system that we can read and write to at
#: will. This is used to persist layout information etc. Note that
#: individual toolkits will have their own directory.
state_location = Str()
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __init__(self, splash_screen=None):
""" Initialise a new GUI.
Parameters
----------
splash_screen : ISplashScreen or None
An optional splash screen that will be displayed until the event
loop is started.
"""
# ------------------------------------------------------------------------
# 'GUI' class interface.
# ------------------------------------------------------------------------
@staticmethod
def allow_interrupt():
""" Override SIGINT to prevent swallowing KeyboardInterrupt
Override the SIGINT handler to ensure the process can be
interrupted. This prevents GUI toolkits from swallowing
KeyboardInterrupt exceptions.
Warning: do not call this method if you intend your application to be
run interactively.
"""
@classmethod
def invoke_after(cls, millisecs, callable, *args, **kw):
""" Call a callable after a specific delay in the main GUI thread.
Parameters
----------
millisecs : float
Delay in milliseconds
callable : Callable
Callable to be called after the delay
args, kwargs :
Arguments and keyword arguments to be used when calling.
"""
@classmethod
def invoke_later(cls, callable, *args, **kw):
""" Call a callable in the main GUI thread.
Parameters
----------
callable : Callable
Callable to be called after the delay
args, kwargs :
Arguments and keyword arguments to be used when calling.
"""
@classmethod
def set_trait_after(cls, millisecs, obj, trait_name, new):
""" Sets a trait after a specific delay in the main GUI thread.
Parameters
----------
millisecs : float
Delay in milliseconds
obj : traits.has_traits.HasTraits
Object on which the trait is to be set
trait_name : str
The name of the trait to set
new : Any
The value to set.
"""
@classmethod
def set_trait_later(cls, obj, trait_name, new):
""" Sets a trait in the main GUI thread.
Parameters
----------
obj : traits.has_traits.HasTraits
Object on which the trait is to be set
trait_name : str
The name of the trait to set
new : Any
The value to set.
"""
@staticmethod
def process_events(allow_user_events=True):
""" Process any pending GUI events.
Parameters
----------
allow_user_events : bool
If allow_user_events is ``False`` then user generated events are not
processed.
"""
@staticmethod
def set_busy(busy=True):
"""Specify if the GUI is busy.
Parameters
----------
busy : bool
If ``True`` is passed, the cursor is set to a 'busy' cursor.
Passing ``False`` will reset the cursor to the default.
"""
# ------------------------------------------------------------------------
# 'GUI' interface.
# ------------------------------------------------------------------------
def start_event_loop(self):
""" Start the GUI event loop. """
def stop_event_loop(self):
""" Stop the GUI event loop. """
class MGUI(HasTraits):
""" The mixin class that contains common code for toolkit specific
implementations of the IGUI interface.
Implements: _default_state_location()
"""
@staticmethod
def allow_interrupt():
""" Override SIGINT to prevent swallowing KeyboardInterrupt
Override the SIGINT handler to ensure the process can be
interrupted. This prevents GUI toolkits from swallowing
KeyboardInterrupt exceptions.
Warning: do not call this method if you intend your application to be
run interactively.
"""
import signal
signal.signal(signal.SIGINT, signal.SIG_DFL)
def _default_state_location(self):
""" Return the default state location. """
state_location = os.path.join(
ETSConfig.application_home, "pyface", ETSConfig.toolkit
)
if not os.path.exists(state_location):
os.makedirs(state_location)
logger.debug("GUI state location is <%s>", state_location)
return state_location
|
