Thuban/UI/application.py

# Copyright (C) 2001, 2002, 2003 by Intevation GmbH
# Authors:
# Jan-Oliver Wagner <[email protected]>
# Bernhard Herzog <[email protected]>
#
# This program is free software under the GPL (>=v2)
# Read the file COPYING coming with Thuban for details.

"""
Thuban's application object.
"""

__version__ = "$Revision$"

import sys, os
import os.path

import traceback

from wxPython.wx import *

from Thuban.Lib.connector import Publisher
from Thuban.Lib.fileutil import get_application_dir

from Thuban import _
from Thuban.Model.session import create_empty_session
from Thuban.Model.save import save_session
from Thuban.Model.load import load_session
from Thuban.Model.messages import MAPS_CHANGED

import view
import tree
import mainwindow

from messages import SESSION_REPLACED


class ThubanApplication(wxApp, Publisher):

    """
    Thuban's application class.

    All wxWindows programs have to have an instance of an application
    class derived from wxApp. In Thuban the application class holds
    references to the main window and the session.
    """

    def OnInit(self):
        self.splash = self.splash_screen()
        if self.splash is not None:
            self.splash.Show()
        self.read_startup_files()
        self.top = self.CreateMainWindow()
        self.SetTopWindow(self.top)
        if self.splash is None:
            self.ShowMainWindow()
        self.session = None
        self.create_session()
        return True

    def OnExit(self):
        """Clean up code.

        Extend this in derived classes if needed.
        """
        self.session.Destroy()
        self.session = None
        Publisher.Destroy(self)

    def read_startup_files(self):
        """Read the startup files."""
        # for now the startup file is ~/.thuban/thubanstart.py
        dir = get_application_dir()
        if os.path.isdir(dir):
            sys.path.append(dir)
            try:
                import thubanstart
            except ImportError:
                tb = sys.exc_info()[2]
                try:
                    if tb.tb_next is not None:
                        # The ImportError exception was raised from
                        # inside the thubanstart module.
                        sys.stderr.write(_("Cannot import the thubanstart"
                                         " module\n"))
                        traceback.print_exc(None, sys.stderr)
                    else:
                        # There's no thubanstart module.
                        sys.stderr.write(_("No thubanstart module available\n"))
                finally:
                    # make sure we delete the traceback object,
                    # otherwise there's be circular references involving
                    # the current stack frame
                    del tb
            except:
                sys.stderr.write(_("Cannot import the thubanstart module\n"))
                traceback.print_exc(None, sys.stderr)
        else:
            # There's no .thuban directory
            sys.stderr.write(_("No ~/.thuban directory\n"))

    def splash_screen(self):
        """Create and return a splash screen.

        This method is called by OnInit to determine whether the
        application should have a splashscreen. If the application
        should display a splash screen override this method in a derived
        class and have it create and return the wxSplashScreen instance.
        The implementation of this method in the derived class should
        also arranged for ShowMainWindow to be called.

        The default implementation simply returns None so that no splash
        screen is shown and ShowMainWindow will be called automatically.
        """
        return None

    def ShowMainWindow(self):
        """Show the main window

        Normally this method is automatically called by OnInit to show
        the main window. However, if the splash_screen method has
        returned a splashscreen it is expected that the derived class
        also arranges for ShowMainWindow to be called at the appropriate
        time.
        """
        self.top.Show(True)

    def CreateMainWindow(self):
        """Create and return the main window for the application.

        Override this in subclasses to instantiate the Thuban mainwindow
        with different parameters or to use a different class for the
        main window.
        """
        msg = (_("This is the wxPython-based Graphical User Interface"
               " for exploring geographic data"))
        return mainwindow.MainWindow(NULL, -1, "Thuban", self, None,
                                     initial_message = msg,
                                     size = (600, 400))

    def Session(self):
        """Return the application's session object"""
        return self.session

    def SetSession(self, session):
        """Make session the new session.

        Issue SESSION_REPLACED after self.session has become the new
        session. After the session has been assigned call
        self.subscribe_session() with the new session and
        self.unsubscribe_session with the old one.
        """
        oldsession = self.session
        self.session = session
        self.subscribe_session(self.session)
        self.issue(SESSION_REPLACED)
        self.maps_changed()
        if oldsession is not None:
            self.unsubscribe_session(oldsession)
            oldsession.Destroy()

    def subscribe_session(self, session):
        """Subscribe to some of the sessions channels.

        Extend this method in derived classes if you need additional
        channels.
        """
        session.Subscribe(MAPS_CHANGED, self.maps_changed)

    def unsubscribe_session(self, session):
        """Unsubscribe from the sessions channels.

        Extend this method in derived classes if you subscribed to
        additional channels in subscribe_session().
        """
        session.Unsubscribe(MAPS_CHANGED, self.maps_changed)

    def create_session(self):
        """Create a default session.

        Override this method in derived classes to instantiate the
        session differently or to use a different session class. Don't
        subscribe to channels here yet. Do that in the
        subscribe_session() method.
        """
        self.SetSession(create_empty_session())

    def OpenSession(self, filename):
        """Open the session in the file named filename"""
        # Make sure we deal with an absolute pathname. Otherwise we can
        # get problems when saving because the saving code expects an
        # absolute directory name
        filename = os.path.abspath(filename)
        session = load_session(filename)
        session.SetFilename(filename)
        session.UnsetModified()
        self.SetSession(session)

    def SaveSession(self):
        save_session(self.session, self.session.filename)

    def maps_changed(self, *args):
        if self.session.HasMaps():
            self.top.SetMap(self.session.Maps()[0])
        else:
            self.top.SetMap(None)
1	bh	401	# Copyright (C) 2001, 2002, 2003 by Intevation GmbH
2	bh	6	# Authors:
3			# Jan-Oliver Wagner <[email protected]>
4	bh	189	# Bernhard Herzog <[email protected]>
5	bh	6	#
6			# This program is free software under the GPL (>=v2)
7			# Read the file COPYING coming with Thuban for details.
8
9			"""
10			Thuban's application object.
11			"""
12
13			__version__ = "$Revision$"
14
15	bh	189	import sys, os
16	frank	1133	import os.path
17
18	bh	189	import traceback
19
20	bh	6	from wxPython.wx import *
21
22			from Thuban.Lib.connector import Publisher
23	frank	1150	from Thuban.Lib.fileutil import get_application_dir
24	bh	6
25	jan	374	from Thuban import _
26	bh	6	from Thuban.Model.session import create_empty_session
27			from Thuban.Model.save import save_session
28			from Thuban.Model.load import load_session
29	bh	242	from Thuban.Model.messages import MAPS_CHANGED
30	bh	6
31			import view
32			import tree
33	bh	215	import mainwindow
34	bh	6
35	jonathan	503	from messages import SESSION_REPLACED
36	bh	6
37
38
39			class ThubanApplication(wxApp, Publisher):
40
41			"""
42			Thuban's application class.
43
44			All wxWindows programs have to have an instance of an application
45			class derived from wxApp. In Thuban the application class holds
46	bh	535	references to the main window and the session.
47	bh	6	"""
48
49			def OnInit(self):
50	bh	401	self.splash = self.splash_screen()
51			if self.splash is not None:
52			self.splash.Show()
53	bh	189	self.read_startup_files()
54	bh	401	self.top = self.CreateMainWindow()
55			self.SetTopWindow(self.top)
56			if self.splash is None:
57			self.ShowMainWindow()
58	bh	6	self.session = None
59			self.create_session()
60	jonathan	518	return True
61	bh	6
62	bh	251	def OnExit(self):
63			"""Clean up code.
64
65			Extend this in derived classes if needed.
66			"""
67			self.session.Destroy()
68	bh	765	self.session = None
69	bh	251	Publisher.Destroy(self)
70
71	bh	189	def read_startup_files(self):
72			"""Read the startup files."""
73			# for now the startup file is ~/.thuban/thubanstart.py
74	frank	1150	dir = get_application_dir()
75	bh	189	if os.path.isdir(dir):
76			sys.path.append(dir)
77			try:
78			import thubanstart
79			except ImportError:
80			tb = sys.exc_info()[2]
81			try:
82			if tb.tb_next is not None:
83			# The ImportError exception was raised from
84			# inside the thubanstart module.
85	jan	374	sys.stderr.write(_("Cannot import the thubanstart"
86	bh	671	" module\n"))
87	bh	189	traceback.print_exc(None, sys.stderr)
88			else:
89			# There's no thubanstart module.
90	jan	374	sys.stderr.write(_("No thubanstart module available\n"))
91	bh	189	finally:
92			# make sure we delete the traceback object,
93			# otherwise there's be circular references involving
94			# the current stack frame
95			del tb
96			except:
97	jan	374	sys.stderr.write(_("Cannot import the thubanstart module\n"))
98	bh	189	traceback.print_exc(None, sys.stderr)
99			else:
100			# There's no .thuban directory
101	jan	374	sys.stderr.write(_("No ~/.thuban directory\n"))
102	bh	189
103	bh	401	def splash_screen(self):
104			"""Create and return a splash screen.
105
106			This method is called by OnInit to determine whether the
107			application should have a splashscreen. If the application
108			should display a splash screen override this method in a derived
109			class and have it create and return the wxSplashScreen instance.
110			The implementation of this method in the derived class should
111			also arranged for ShowMainWindow to be called.
112
113			The default implementation simply returns None so that no splash
114			screen is shown and ShowMainWindow will be called automatically.
115			"""
116			return None
117
118			def ShowMainWindow(self):
119			"""Show the main window
120
121			Normally this method is automatically called by OnInit to show
122			the main window. However, if the splash_screen method has
123			returned a splashscreen it is expected that the derived class
124			also arranges for ShowMainWindow to be called at the appropriate
125			time.
126			"""
127	jonathan	518	self.top.Show(True)
128	bh	535
129	bh	235	def CreateMainWindow(self):
130			"""Create and return the main window for the application.
131
132			Override this in subclasses to instantiate the Thuban mainwindow
133			with different parameters or to use a different class for the
134			main window.
135			"""
136	jan	374	msg = (_("This is the wxPython-based Graphical User Interface"
137			" for exploring geographic data"))
138	bh	535	return mainwindow.MainWindow(NULL, -1, "Thuban", self, None,
139	jonathan	934	initial_message = msg,
140			size = (600, 400))
141	bh	235
142	bh	219	def Session(self):
143			"""Return the application's session object"""
144			return self.session
145
146	bh	6	def SetSession(self, session):
147	bh	219	"""Make session the new session.
148
149	jonathan	503	Issue SESSION_REPLACED after self.session has become the new
150	bh	242	session. After the session has been assigned call
151			self.subscribe_session() with the new session and
152			self.unsubscribe_session with the old one.
153	bh	219	"""
154	bh	6	oldsession = self.session
155			self.session = session
156	bh	242	self.subscribe_session(self.session)
157	jonathan	503	self.issue(SESSION_REPLACED)
158	bh	242	self.maps_changed()
159	bh	6	if oldsession is not None:
160	bh	242	self.unsubscribe_session(oldsession)
161	bh	6	oldsession.Destroy()
162
163	bh	242	def subscribe_session(self, session):
164			"""Subscribe to some of the sessions channels.
165
166			Extend this method in derived classes if you need additional
167			channels.
168			"""
169			session.Subscribe(MAPS_CHANGED, self.maps_changed)
170
171			def unsubscribe_session(self, session):
172			"""Unsubscribe from the sessions channels.
173
174			Extend this method in derived classes if you subscribed to
175			additional channels in subscribe_session().
176			"""
177			session.Unsubscribe(MAPS_CHANGED, self.maps_changed)
178
179	bh	6	def create_session(self):
180	bh	242	"""Create a default session.
181
182			Override this method in derived classes to instantiate the
183			session differently or to use a different session class. Don't
184			subscribe to channels here yet. Do that in the
185			subscribe_session() method.
186			"""
187	bh	6	self.SetSession(create_empty_session())
188
189			def OpenSession(self, filename):
190	bh	592	"""Open the session in the file named filename"""
191			# Make sure we deal with an absolute pathname. Otherwise we can
192			# get problems when saving because the saving code expects an
193			# absolute directory name
194			filename = os.path.abspath(filename)
195	bh	6	session = load_session(filename)
196			session.SetFilename(filename)
197			session.UnsetModified()
198			self.SetSession(session)
199
200			def SaveSession(self):
201			save_session(self.session, self.session.filename)
202
203	bh	242	def maps_changed(self, *args):
204	bh	6	if self.session.HasMaps():
205			self.top.SetMap(self.session.Maps()[0])
206			else:
207			self.top.SetMap(None)
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision