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
|
#------------------------------------------------------------------------------
# Copyright (c) 2005, Enthought, Inc.
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in enthought/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!
#
# Author: Enthought, Inc.
# Description: <Enthought pyface package component>
#------------------------------------------------------------------------------
""" The interface of a pyface GUI. """
# Standard library imports.
import logging
import os
# Enthought library imports.
from enthought.etsconfig.api import ETSConfig
from enthought.traits.api import Bool, Interface, Unicode
# 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 = Unicode
###########################################################################
# 'object' interface.
###########################################################################
def __init__(self, splash_screen=None):
""" Initialise a new GUI. splash_screen is an optional splash screen
that will be displayed until the event loop is started.
"""
###########################################################################
# 'GUI' class interface.
###########################################################################
def invoke_after(cls, millisecs, callable, *args, **kw):
""" Call a callable after a specific delay in the main GUI thread. """
invoke_after = classmethod(invoke_after)
def invoke_later(cls, callable, *args, **kw):
""" Call a callable in the main GUI thread. """
invoke_later = classmethod(invoke_later)
def set_trait_after(cls, millisecs, obj, trait_name, new):
""" Sets a trait after a specific delay in the main GUI thread. """
set_trait_after = classmethod(set_trait_after)
def set_trait_later(cls, obj, trait_name, new):
""" Sets a trait in the main GUI thread. """
set_trait_later = classmethod(set_trait_later)
def process_events(allow_user_events=True):
""" Process any pending GUI events. If allow_user_events is False then
user generated events are not processed.
"""
process_events = staticmethod(process_events)
def set_busy(busy=True):
"""Specify if the GUI is busy. If `True` is passed, the
cursor is set to a 'busy' cursor. Passing `False` will reset
the cursor to the default.
"""
set_busy = staticmethod(set_busy)
###########################################################################
# 'GUI' interface.
###########################################################################
def start_event_loop(self):
""" Start the GUI event loop. """
def stop_event_loop(self):
""" Stop the GUI event loop. """
class MGUI(object):
""" The mixin class that contains common code for toolkit specific
implementations of the IGUI interface.
Implements: _default_state_location()
"""
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
#### EOF ######################################################################
|
