/[thuban]/branches/WIP-pyshapelib-bramz/Thuban/Model/session.py
ViewVC logotype

Diff of /branches/WIP-pyshapelib-bramz/Thuban/Model/session.py

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 56 by bh, Thu Sep 13 13:54:37 2001 UTC revision 241 by bh, Wed Jul 24 17:16:17 2002 UTC
# Line 1  Line 1 
1  # Copyright (c) 2001 by Intevation GmbH  # Copyright (c) 2001, 2002 by Intevation GmbH
2  # Authors:  # Authors:
3  # Bernhard Herzog <[email protected]>  # Bernhard Herzog <[email protected]>
4    # Jan-Oliver Wagner <[email protected]>
5  #  #
6  # This program is free software under the GPL (>=v2)  # This program is free software under the GPL (>=v2)
7  # Read the file COPYING coming with Thuban for details.  # Read the file COPYING coming with Thuban for details.
# Line 9  __version__ = "$Revision$" Line 10  __version__ = "$Revision$"
10    
11  from Thuban.Lib.connector import Publisher  from Thuban.Lib.connector import Publisher
12    
13  from messages import MAPS_CHANGED, LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \  from messages import MAPS_CHANGED, EXTENSIONS_CHANGED, FILENAME_CHANGED, \
14       LAYER_LEGEND_CHANGED, FILENAME_CHANGED       LAYERS_CHANGED, MAP_PROJECTION_CHANGED, \
15         LAYER_LEGEND_CHANGED, LAYER_PROJECTION_CHANGED, LAYER_VISIBILITY_CHANGED,\
16         EXTENSION_CHANGED, EXTENSION_OBJECTS_CHANGED, CHANGED
17    
18  from base import TitledObject, Modifiable  from base import TitledObject, Modifiable
19    
# Line 21  class Session(TitledObject, Modifiable): Line 24  class Session(TitledObject, Modifiable):
24    
25      """A complete session.      """A complete session.
26    
27      A Session consists of arbitrary numbers of maps and tables      A Session consists of arbitrary numbers of maps, tables and extensions
28    
29      Session objects send the following events:      Session objects send the following events:
30    
# Line 31  class Session(TitledObject, Modifiable): Line 34  class Session(TitledObject, Modifiable):
34    
35          MAPS_CHANGED -- Maps were added, removed.          MAPS_CHANGED -- Maps were added, removed.
36    
37            EXTENSIONS_CHANGED -- Extensions were added, removed.
38    
39          LAYERS_CHANGED -- Same as the map's event of the same name.          LAYERS_CHANGED -- Same as the map's event of the same name.
40                            It's simply resent from the session to make                            It's simply resent from the session to make
41                            subscriptions easier.                            subscriptions easier.
42    
43            CHANGED -- Generic changed event. Parameters: the session. The
44                       event is always issued when any other changed event
45                       is issused. This is useful for code that needs to be
46                       notified whenever something in the session has
47                       changed but it's too cumbersome or error-prone to
48                       subscribe to all the individual events.
49      """      """
50    
51        # message channels that have to be forwarded from maps contained in
52        # the session.
53        forwarded_channels = (
54            # map specific channels
55            MAP_PROJECTION_CHANGED,
56            LAYERS_CHANGED,
57    
58            # layer channels forwarded by the map
59            LAYER_PROJECTION_CHANGED,
60            LAYER_LEGEND_CHANGED,
61            LAYER_VISIBILITY_CHANGED,
62    
63            # channels forwarded by an extension
64            EXTENSION_CHANGED,
65            EXTENSION_OBJECTS_CHANGED)
66    
67      def __init__(self, title):      def __init__(self, title):
68          TitledObject.__init__(self, title)          TitledObject.__init__(self, title)
69          Modifiable.__init__(self)          Modifiable.__init__(self)
70          self.filename = None          self.filename = None
71          self.maps = []          self.maps = []
72          self.tables = []          self.tables = []
73            self.extensions = []
74    
75        def changed(self, channel = None, *args):
76            """Like the inherited version but issue a CHANGED message as well.
77    
78            The CHANGED message is only issued if channel given is a
79            different channel than CHANGED.
80            """
81            Modifiable.changed(self, channel, *args)
82            if channel != CHANGED:
83                self.issue(CHANGED, self)
84    
85      def SetFilename(self, filename):      def SetFilename(self, filename):
86          self.filename = filename          self.filename = filename
# Line 55  class Session(TitledObject, Modifiable): Line 94  class Session(TitledObject, Modifiable):
94    
95      def AddMap(self, map):      def AddMap(self, map):
96          self.maps.append(map)          self.maps.append(map)
97          for channel in (LAYERS_CHANGED, MAP_PROJECTION_CHANGED,          for channel in self.forwarded_channels:
                         LAYER_LEGEND_CHANGED):  
98              map.Subscribe(channel, self.forward, channel)              map.Subscribe(channel, self.forward, channel)
99          self.changed(MAPS_CHANGED)          self.changed(MAPS_CHANGED)
100    
101        def RemoveMap(self, map):
102            for channel in self.forwarded_channels:
103                map.Unsubscribe(channel, self.forward, channel)
104            self.maps.remove(map)
105            self.changed(MAPS_CHANGED)
106            map.Destroy()
107    
108        def Extensions(self):
109            return self.extensions
110    
111        def HasExtensions(self):
112            return len(self.extensions) > 0
113    
114        def AddExtension(self, extension):
115            self.extensions.append(extension)
116            for channel in self.forwarded_channels:
117                extension.Subscribe(channel, self.forward, channel)
118            self.changed(EXTENSIONS_CHANGED)
119    
120      def Destroy(self):      def Destroy(self):
121          for map in self.maps:          for map in self.maps:
122              map.Destroy()              map.Destroy()
# Line 68  class Session(TitledObject, Modifiable): Line 125  class Session(TitledObject, Modifiable):
125          Publisher.Destroy(self)          Publisher.Destroy(self)
126    
127      def forward(self, *args):      def forward(self, *args):
128          """Reissue events"""          """Reissue events.
129    
130            If the channel the event is forwarded to is a changed-channel
131            that is not the CHANGED channel issue CHANGED as well. An
132            channel is considered to be a changed-channel if it's name ends
133            with 'CHANGED'.
134            """
135          if len(args) > 1:          if len(args) > 1:
136              args = (args[-1],) + args[:-1]              args = (args[-1],) + args[:-1]
137          apply(self.issue, args)          apply(self.issue, args)
138            channel = args[0]
139            # It's a bit of a kludge to rely on the channel name for this.
140            if channel.endswith("CHANGED") and channel != CHANGED:
141                self.issue(CHANGED, self)
142    
143      def WasModified(self):      def WasModified(self):
144          """Return true if the session or one of the maps was modified"""          """Return true if the session or one of the maps was modified"""
# Line 89  class Session(TitledObject, Modifiable): Line 156  class Session(TitledObject, Modifiable):
156          for map in self.maps:          for map in self.maps:
157              map.UnsetModified()              map.UnsetModified()
158    
159        def TreeInfo(self):
160            items = []
161            if self.filename is None:
162                items.append("Filename:")
163            else:
164                items.append("Filename: %s" % self.filename)
165    
166            if self.WasModified():
167                items.append("Modified")
168            else:
169                items.append("Unmodified")
170    
171            items.extend(self.maps)
172            items.extend(self.extensions)
173    
174            return ("Session: %s" % self.title, items)
175    
176    
177  def create_empty_session():  def create_empty_session():
178      """Return an empty session useful as a starting point"""      """Return an empty session useful as a starting point"""
179        import os
180      session = Session('unnamed session')      session = Session('unnamed session')
181      session.SetFilename('unnamed.session')      session.SetFilename(None)
182      session.AddMap(Map('unnamed map'))      session.AddMap(Map('unnamed map'))
183      session.UnsetModified()      session.UnsetModified()
184      return session      return session
Legend:
Removed from v.56  
changed lines
  Added in v.241
[email protected]
 ViewVC Help
Powered by ViewVC 1.1.26