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
|
# (C) Copyright 2007-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 application interface. """
# Enthought library imports.
from apptools.preferences.api import IPreferences
from traits.api import Event, Instance, Str, VetoableEvent
from .application_event import ApplicationEvent
# Local imports.
from .i_extension_registry import IExtensionRegistry
from .i_import_manager import IImportManager
from .i_plugin_manager import IPluginManager
from .i_service_registry import IServiceRegistry
class IApplication(
IExtensionRegistry, IImportManager, IPluginManager, IServiceRegistry
):
"""The application interface."""
#: The application's globally unique identifier.
id = Str
#: The name of a directory (created for you) to which the application can
#: read and write non-user accessible data, i.e. configuration information,
#: preferences, etc.
home = Str
#: The name of a directory (created for you upon access) to which the
#: application can read and write user-accessible data, e.g. projects
#: created by the user.
user_data = Str
#: The root preferences node.
preferences = Instance(IPreferences)
#### Events ####
#: Fired when the application is starting. This is the first thing that
#: happens when the 'start' method is called.
starting = VetoableEvent(ApplicationEvent)
#: Fired when all plugins have been started.
started = Event(ApplicationEvent)
#: Fired when the plugin manager is stopping. This is the first thing that
#: happens when the 'stop' method is called.
stopping = VetoableEvent(ApplicationEvent)
#: Fired when all plugins have been stopped.
stopped = Event(ApplicationEvent)
def run(self):
"""Run the application.
The same as::
if application.start():
application.stop()
"""
|
