Thuban/UI/tree.py

#! /usr/bin/python
# Copyright (c) 2001, 2002 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.

__version__ = "$Revision$"

from types import StringType, UnicodeType

from wxPython.wx import *

from Thuban import _
from Thuban.UI.common import *

from Thuban.Model.color import Color

from Thuban.Model.messages import CHANGED
from Thuban.Model.layer import Layer
from Thuban.Model.map import Map

from dialogs import NonModalDialog
from messages import SESSION_REPLACED, SELECTED_LAYER

BMP_SIZE = 15

class SessionTreeCtrl(wxTreeCtrl):

    """Widget to display a tree view of the session.

    The tree view is created recursively from the session object. The
    tree view calls the session's TreeInfo method which should return a
    pair (<title>, <item>) where <title> ist the title of the session
    item in the tree view and <items> is a list of objects to use as the
    children of the session in the tree view.

    The items list can contain three types of items:

       1. a string. The string is used as the title for a leaf item in
          the tree view.

       2. an object with a TreeInfo method. This method is called and
          should return a pair just like the session's TreeInfo method.

       3. a pair (<title>, <item>) which is treated like the return
          value of TreeInfo.
    """

    def __init__(self, parent, ID, app):

        # Use the WANTS_CHARS style so the panel doesn't eat the Return key.
        wxTreeCtrl.__init__(self, parent, ID)

        self.app = app
        # boolean to indicate that we manipulate the selection ourselves
        # so that we can ignore the selection events generated
        self.changing_selection = 0

        # Dictionary mapping layer id's to tree items
        self.layer_to_item = {}

        self.app.Subscribe(SESSION_REPLACED, self.session_changed)
        self.app.interactor.Subscribe(SELECTED_LAYER, self.layer_selected)

        # the session currently displayed in the tree
        self.session = None

        self.image_list = wxImageList(BMP_SIZE, BMP_SIZE)
        self.AssignImageList(self.image_list)

        # pretend the session has changed to build the initial tree
        self.session_changed()

        EVT_TREE_SEL_CHANGED(self, self.GetId(), self.OnSelChanged)

    def unsubscribe_all(self):
        if self.session is not None:
            self.session.Unsubscribe(CHANGED, self.update_tree)
            self.session = None
        self.app.Unsubscribe(SESSION_REPLACED, self.session_changed)
        self.app.interactor.Unsubscribe(SELECTED_LAYER, self.layer_selected)

    def update_tree(self, *args):
        """Clear and rebuild the tree"""
        self.DeleteAllItems()
        self.layer_to_item.clear()

        session = self.app.session
        info = session.TreeInfo()
        root = self.AddRoot(info[0])
        self.add_items(root, info[1])
        self.Expand(root)
        # select the selected layer
        selected_layer = self.app.interactor.selected_layer
        if selected_layer is not None:
            # One would expect that the selected_layer's id is in
            # layer_to_item at this point as we've just rebuilt that
            # mapping completely. However, when a new session is loaded
            # for instance, it can happen that the tree view is updated
            # before the interactor in which case selected_layer may be
            # a layer of the old session.
            item = self.layer_to_item.get(id(selected_layer))
            if item is not None:
                self.SelectItem(item)

    def add_items(self, parent, items):

        if items is None: return

        for item in items:
            if hasattr(item, "TreeInfo"):
                # Supports the TreeInfo protocol
                info = item.TreeInfo()
                treeitem = self.AppendItem(parent, info[0])
                self.SetPyData(treeitem, item)
                self.add_items(treeitem, info[1])
                self.Expand(treeitem)
                if isinstance(item, Layer):
                    self.layer_to_item[id(item)] = treeitem
            elif isinstance(item, StringType) or \
                 isinstance(item, UnicodeType):
                # it's a string
                self.AppendItem(parent, item)
            else:
                # assume its a sequence (title, items)
                if isinstance(item[1], Color):

                    treeitem = self.AppendItem(parent, "(%s)" % item[0])

                    bmp = wxEmptyBitmap(BMP_SIZE, BMP_SIZE)
                    brush = wxBrush(Color2wxColour(item[1]), wxSOLID)
                    dc = wxMemoryDC()
                    dc.SelectObject(bmp)
                    dc.SetBrush(brush)
                    dc.Clear()
                    dc.DrawRoundedRectangle(0, 0, 
                                            bmp.GetWidth(), bmp.GetHeight(),
                                            4)
                    dc.SelectObject(wxNullBitmap)

                    i = self.image_list.Add(bmp)
                    self.SetItemImage(treeitem, i)
                else:
                    treeitem = self.AppendItem(parent, item[0])
                    self.add_items(treeitem, item[1])
                self.Expand(treeitem)

    def session_changed(self, *args):
        new_session = self.app.session
        # if the session has changed subscribe/unsubscribe
        if self.session is not new_session:
            if self.session is not None:
                self.session.Unsubscribe(CHANGED, self.update_tree)
            if new_session is not None:
                new_session.Subscribe(CHANGED, self.update_tree)
            self.session = new_session
        self.update_tree()

    def normalize_selection(self):
        """Select the layer or map containing currently selected item"""
        item = self.GetSelection()
        while item.IsOk():
            object = self.GetPyData(item)
            if isinstance(object, Layer) or isinstance(object, Map):
                break
            item = self.GetItemParent(item)
        else:
            # No layer or map was found in the chain of parents, so
            # there's nothing we can do.
            return

        self.changing_selection = 1
        try:
            self.SelectItem(item)
        finally:
            self.changing_selection = 0

    def SelectedLayer(self):
        """Return the layer object currently selected in the tree.
        Return None if no layer is selected"""
        layer = self.GetPyData(self.GetSelection())
        if isinstance(layer, Layer):
            return layer
        return None

    def OnSelChanged(self, event):
        if self.changing_selection:
            # we're changing the selection ourselves (probably through
            # self.normalize_selection(). ignore the event.
            return
        self.normalize_selection()
        # SelectedLayer returns None if no layer is selected. Since
        # passing None to interactor.SelectLayer deselects the layer we
        # can simply pass the result of SelectedLayer on in all cases
        self.app.interactor.SelectLayer(self.SelectedLayer())

    def layer_selected(self, layer):
        item = self.layer_to_item.get(id(layer))
        if item is not None and item != self.GetSelection():
            self.SelectItem(item)


class SessionTreeView(NonModalDialog):

    """Non modal dialog showing the session as a tree"""

    def __init__(self, parent, app, name):
        NonModalDialog.__init__(self, parent, app.interactor, name,
                                _("Session"))
        self.tree = SessionTreeCtrl(self, -1, app)

    def OnClose(self, event):
        NonModalDialog.OnClose(self, event)

        # if there were a way to get notified when the tree control
        # itself is destroyed we could use that to unsubscribe instead
        # of doing it here. (EVT_WINDOW_DESTROY doesn't seem to sent at
        # all)
        self.tree.unsubscribe_all()

1	bh	6	#! /usr/bin/python
2	bh	151	# Copyright (c) 2001, 2002 by Intevation GmbH
3	bh	6	# Authors:
4			# Jan-Oliver Wagner <[email protected]>
5			# Bernhard Herzog <[email protected]>
6			#
7			# This program is free software under the GPL (>=v2)
8			# Read the file COPYING coming with Thuban for details.
9
10			__version__ = "$Revision$"
11
12	jonathan	383	from types import StringType, UnicodeType
13	bh	217
14	bh	6	from wxPython.wx import *
15
16	jan	374	from Thuban import _
17	jonathan	443	from Thuban.UI.common import *
18	jan	374
19	jonathan	383	from Thuban.Model.color import Color
20
21	bh	233	from Thuban.Model.messages import CHANGED
22			from Thuban.Model.layer import Layer
23	bh	6	from Thuban.Model.map import Map
24
25	bh	36	from dialogs import NonModalDialog
26	jonathan	504	from messages import SESSION_REPLACED, SELECTED_LAYER
27	bh	6
28	jonathan	383	BMP_SIZE = 15
29	bh	6
30	bh	41	class SessionTreeCtrl(wxTreeCtrl):
31	bh	36
32	bh	217	"""Widget to display a tree view of the session.
33
34			The tree view is created recursively from the session object. The
35			tree view calls the session's TreeInfo method which should return a
36			pair (<title>, <item>) where <title> ist the title of the session
37			item in the tree view and <items> is a list of objects to use as the
38			children of the session in the tree view.
39
40			The items list can contain three types of items:
41
42			1. a string. The string is used as the title for a leaf item in
43			the tree view.
44
45			2. an object with a TreeInfo method. This method is called and
46			should return a pair just like the session's TreeInfo method.
47
48			3. a pair (<title>, <item>) which is treated like the return
49			value of TreeInfo.
50			"""
51
52	bh	36	def __init__(self, parent, ID, app):
53	jonathan	383
54	bh	6	# Use the WANTS_CHARS style so the panel doesn't eat the Return key.
55	bh	36	wxTreeCtrl.__init__(self, parent, ID)
56
57	bh	6	self.app = app
58	bh	14	# boolean to indicate that we manipulate the selection ourselves
59			# so that we can ignore the selection events generated
60			self.changing_selection = 0
61
62	bh	41	# Dictionary mapping layer id's to tree items
63			self.layer_to_item = {}
64
65	jonathan	504	self.app.Subscribe(SESSION_REPLACED, self.session_changed)
66	bh	6	self.app.interactor.Subscribe(SELECTED_LAYER, self.layer_selected)
67	bh	151
68			# the session currently displayed in the tree
69			self.session = None
70
71	jonathan	383	self.image_list = wxImageList(BMP_SIZE, BMP_SIZE)
72			self.AssignImageList(self.image_list)
73
74	bh	6	# pretend the session has changed to build the initial tree
75			self.session_changed()
76
77	bh	36	EVT_TREE_SEL_CHANGED(self, self.GetId(), self.OnSelChanged)
78	bh	6
79	bh	151	def unsubscribe_all(self):
80			if self.session is not None:
81	bh	233	self.session.Unsubscribe(CHANGED, self.update_tree)
82	bh	161	self.session = None
83	jonathan	504	self.app.Unsubscribe(SESSION_REPLACED, self.session_changed)
84	bh	151	self.app.interactor.Unsubscribe(SELECTED_LAYER, self.layer_selected)
85
86	bh	6	def update_tree(self, *args):
87			"""Clear and rebuild the tree"""
88	bh	36	self.DeleteAllItems()
89	bh	41	self.layer_to_item.clear()
90	jan	104
91	bh	217	session = self.app.session
92			info = session.TreeInfo()
93			root = self.AddRoot(info[0])
94			self.add_items(root, info[1])
95	bh	36	self.Expand(root)
96	bh	217	# select the selected layer
97			selected_layer = self.app.interactor.selected_layer
98			if selected_layer is not None:
99	bh	218	# One would expect that the selected_layer's id is in
100			# layer_to_item at this point as we've just rebuilt that
101			# mapping completely. However, when a new session is loaded
102			# for instance, it can happen that the tree view is updated
103			# before the interactor in which case selected_layer may be
104			# a layer of the old session.
105			item = self.layer_to_item.get(id(selected_layer))
106			if item is not None:
107			self.SelectItem(item)
108	bh	6
109	bh	217	def add_items(self, parent, items):
110	jonathan	383
111			if items is None: return
112
113	bh	217	for item in items:
114			if hasattr(item, "TreeInfo"):
115			# Supports the TreeInfo protocol
116			info = item.TreeInfo()
117			treeitem = self.AppendItem(parent, info[0])
118			self.SetPyData(treeitem, item)
119			self.add_items(treeitem, info[1])
120			self.Expand(treeitem)
121			if isinstance(item, Layer):
122			self.layer_to_item[id(item)] = treeitem
123	jonathan	383	elif isinstance(item, StringType) or \
124			isinstance(item, UnicodeType):
125	bh	217	# it's a string
126			self.AppendItem(parent, item)
127			else:
128			# assume its a sequence (title, items)
129	jonathan	383	if isinstance(item[1], Color):
130
131	jonathan	417	treeitem = self.AppendItem(parent, "(%s)" % item[0])
132
133	jonathan	383	bmp = wxEmptyBitmap(BMP_SIZE, BMP_SIZE)
134	jonathan	443	brush = wxBrush(Color2wxColour(item[1]), wxSOLID)
135	jonathan	383	dc = wxMemoryDC()
136			dc.SelectObject(bmp)
137			dc.SetBrush(brush)
138			dc.Clear()
139			dc.DrawRoundedRectangle(0, 0,
140			bmp.GetWidth(), bmp.GetHeight(),
141			4)
142			dc.SelectObject(wxNullBitmap)
143
144			i = self.image_list.Add(bmp)
145			self.SetItemImage(treeitem, i)
146			else:
147			treeitem = self.AppendItem(parent, item[0])
148			self.add_items(treeitem, item[1])
149	bh	217	self.Expand(treeitem)
150	jan	198
151	bh	6	def session_changed(self, *args):
152	bh	151	new_session = self.app.session
153			# if the session has changed subscribe/unsubscribe
154			if self.session is not new_session:
155			if self.session is not None:
156	bh	233	self.session.Unsubscribe(CHANGED, self.update_tree)
157	bh	151	if new_session is not None:
158	bh	233	new_session.Subscribe(CHANGED, self.update_tree)
159	bh	151	self.session = new_session
160	bh	6	self.update_tree()
161
162			def normalize_selection(self):
163			"""Select the layer or map containing currently selected item"""
164	bh	36	item = self.GetSelection()
165	bh	6	while item.IsOk():
166	bh	36	object = self.GetPyData(item)
167	bh	6	if isinstance(object, Layer) or isinstance(object, Map):
168			break
169	bh	36	item = self.GetItemParent(item)
170	bh	353	else:
171			# No layer or map was found in the chain of parents, so
172			# there's nothing we can do.
173			return
174	bh	6
175	bh	14	self.changing_selection = 1
176			try:
177	bh	36	self.SelectItem(item)
178	bh	14	finally:
179			self.changing_selection = 0
180	bh	6
181			def SelectedLayer(self):
182			"""Return the layer object currently selected in the tree.
183			Return None if no layer is selected"""
184	bh	36	layer = self.GetPyData(self.GetSelection())
185	bh	6	if isinstance(layer, Layer):
186			return layer
187			return None
188
189			def OnSelChanged(self, event):
190	bh	14	if self.changing_selection:
191			# we're changing the selection ourselves (probably through
192			# self.normalize_selection(). ignore the event.
193			return
194	bh	6	self.normalize_selection()
195	bh	61	# SelectedLayer returns None if no layer is selected. Since
196			# passing None to interactor.SelectLayer deselects the layer we
197			# can simply pass the result of SelectedLayer on in all cases
198			self.app.interactor.SelectLayer(self.SelectedLayer())
199	bh	6
200			def layer_selected(self, layer):
201	bh	41	item = self.layer_to_item.get(id(layer))
202			if item is not None and item != self.GetSelection():
203			self.SelectItem(item)
204	bh	36
205
206			class SessionTreeView(NonModalDialog):
207
208			"""Non modal dialog showing the session as a tree"""
209
210			def __init__(self, parent, app, name):
211	jan	374	NonModalDialog.__init__(self, parent, app.interactor, name,
212			_("Session"))
213	bh	41	self.tree = SessionTreeCtrl(self, -1, app)
214	bh	36
215	jonathan	504	def OnClose(self, event):
216			NonModalDialog.OnClose(self, event)
217
218	bh	151	# if there were a way to get notified when the tree control
219			# itself is destroyed we could use that to unsubscribe instead
220			# of doing it here. (EVT_WINDOW_DESTROY doesn't seem to sent at
221			# all)
222			self.tree.unsubscribe_all()
223	jonathan	488
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision