Thuban/UI/selection.py

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

"""
Selection handling
"""

__version__ = "$Revision$"
# $Source$
# $Id$

from Thuban.Lib.connector import Publisher

from messages import LAYER_SELECTED, SHAPES_SELECTED


class Selection(Publisher):

    """Manage the selection

    The selection consists of a list of shape ids and the layer that
    contains those shapes.

    Messages issued by the selection:

    LAYER_SELECTED -- A different layer has been selected or there was a
                      layer selected and the selection has been cleared.

                      Arguments: The newly selected layer or None if no
                      layer is selected.

    SHAPES_SELECTED -- The set of selected shapes has changed.

                       Arguments: The newly selected layer or None if no
                       layer is selected and a list with ids of the
                       selected shapes. The list is empty if no shapes
                       are selected.
    """

    def __init__(self):
        """Initialize the selection

        Initially nothing is selected so the selected layer is None and
        the list of selected shapes is empty.
        """
        self.layer = None
        self.shapes = []

    def issue_messages(self, issue_layer, issue_shape):
        """Internal: Issue SHAPES_SELECTED and LAYER_SELECTED messages

        If the issue_layer argument is true, ussue a LAYER_SELECTED
        message. If issue_shape is true issue a SHAPES_SELECTED message.
        """
        if issue_layer:
            self.issue(LAYER_SELECTED, self.layer)
        if issue_shape:
            self.issue(SHAPES_SELECTED, self.layer, self.SelectedShapes())

    def ClearSelection(self):
        """Unselect the currently selected shapes if any.

        If there was a layer selected before the call, send a
        LAYER_SELECTED message. If there were selected shapes before the
        call, send a SHAPES_SELECTED message as well.
        """
        issue_layer = self.layer is not None
        issue_shape = len(self.shapes) > 0

        self.layer = None
        self.shapes = []
        self.issue_messages(issue_layer, issue_shape)

    def SelectedLayer(self):
        """Return the selected layer. If no layer is selected return None"""
        return self.layer

    def HasSelectedLayer(self):
        """Return true iff a layer is currently selected"""
        return self.layer is not None

    def SelectedShapes(self):
        """Return the ids of the selected shapes as a list.

        The list is sorted in ascending order. If no shapes are selected
        the list is empty.
        """
        return self.shapes

    def HasSelectedShapes(self):
        """Return true iff at least one shape is selected."""
        return len(self.shapes) > 0

    def SelectLayer(self, layer):
        """Select the given layer.

        If the layer is the currently selected layer, do nothing.
        Ortherwise, issue a LAYER_SELECTED message and if there were
        shapes selected preciously issue a SHAPES_SELECTED message as
        well.
        """
        if self.layer is not layer:
            self.layer = layer
            issue_shape = len(self.shapes) > 0
            self.shapes = []
            self.issue_messages(1, issue_shape)

    def SelectShapes(self, layer, shapes, add = 0):
        """Select the shapes given in the list shapes in the given layer.

        If the optional keyword parameter add is true, add the selected
        shapes to the currently selected shapes if layer is the already
        selected layer if any. If add is false (the default) make the
        shapes in shapes the selected shapes.

        If a different layer is selected afterwards issue a
        LAYER_SELECTED message. If the set of selected shapes has
        changed afterwards issue a SHAPES_SELECTED message.
        """
        # Turn the shapes explicitly into a list. This main purpose
        # is that we get a mutable sequence that we can modify in place.
        shapes = list(shapes)
        shapes.sort()

        if self.layer is not layer:
            # If the layer is differen we can ignore the add parameter
            # and we have to issue both messages.
            self.layer = layer
            self.shapes = shapes
            issue_layer = issue_shape = 1
        else:
            # If the layer is differen we have to merge the ids if add
            # is true, and we won't have to issue the LAYER_SELECTED
            # message.
            issue_layer = 0
            if add:
                # Merge the ids by creating a dict with the ids in
                # self.shapes and in shapes as the keys. The use the sorted
                # keys of the dict as the new shapes list.
                set = {}
                for i in self.shapes:
                    set[i] = 1
                for i in shapes:
                    set[i] = 1
                shapes = set.keys()
                shapes.sort()
            if self.shapes != shapes:
                self.shapes = shapes
                issue_shape = 1
            else:
                issue_shape = 0

        self.issue_messages(issue_layer, issue_shape)

    def AddShapes(self, layer, shapes):
        """Add the shapes on layer to the selection.

        If the layer is the already selected layer, add the shape ids in
        shapes to the already selected shapes.

        If the layer is not the already selected layer, make the layer
        and shapes the selected layer and shapes.
        """
        self.SelectShapes(layer, shapes)
1	bh	535	# Copyright (c) 2001, 2003 by Intevation GmbH
2			# Authors:
3			# Bernhard Herzog <[email protected]>
4			#
5			# This program is free software under the GPL (>=v2)
6			# Read the file COPYING coming with Thuban for details.
7
8			"""
9			Selection handling
10			"""
11
12			__version__ = "$Revision$"
13			# $Source$
14			# $Id$
15
16			from Thuban.Lib.connector import Publisher
17
18			from messages import LAYER_SELECTED, SHAPES_SELECTED
19
20
21			class Selection(Publisher):
22
23			"""Manage the selection
24
25			The selection consists of a list of shape ids and the layer that
26			contains those shapes.
27
28			Messages issued by the selection:
29
30			LAYER_SELECTED -- A different layer has been selected or there was a
31			layer selected and the selection has been cleared.
32
33			Arguments: The newly selected layer or None if no
34			layer is selected.
35
36			SHAPES_SELECTED -- The set of selected shapes has changed.
37
38			Arguments: The newly selected layer or None if no
39			layer is selected and a list with ids of the
40			selected shapes. The list is empty if no shapes
41			are selected.
42			"""
43
44			def __init__(self):
45			"""Initialize the selection
46
47			Initially nothing is selected so the selected layer is None and
48			the list of selected shapes is empty.
49			"""
50			self.layer = None
51			self.shapes = []
52
53			def issue_messages(self, issue_layer, issue_shape):
54			"""Internal: Issue SHAPES_SELECTED and LAYER_SELECTED messages
55
56			If the issue_layer argument is true, ussue a LAYER_SELECTED
57			message. If issue_shape is true issue a SHAPES_SELECTED message.
58			"""
59			if issue_layer:
60			self.issue(LAYER_SELECTED, self.layer)
61			if issue_shape:
62			self.issue(SHAPES_SELECTED, self.layer, self.SelectedShapes())
63
64			def ClearSelection(self):
65			"""Unselect the currently selected shapes if any.
66
67			If there was a layer selected before the call, send a
68			LAYER_SELECTED message. If there were selected shapes before the
69			call, send a SHAPES_SELECTED message as well.
70			"""
71			issue_layer = self.layer is not None
72			issue_shape = len(self.shapes) > 0
73
74			self.layer = None
75			self.shapes = []
76			self.issue_messages(issue_layer, issue_shape)
77
78			def SelectedLayer(self):
79			"""Return the selected layer. If no layer is selected return None"""
80			return self.layer
81
82			def HasSelectedLayer(self):
83			"""Return true iff a layer is currently selected"""
84			return self.layer is not None
85
86			def SelectedShapes(self):
87			"""Return the ids of the selected shapes as a list.
88
89			The list is sorted in ascending order. If no shapes are selected
90			the list is empty.
91			"""
92			return self.shapes
93
94	jonathan	830	def HasSelectedShapes(self):
95			"""Return true iff at least one shape is selected."""
96			return len(self.shapes) > 0
97
98	bh	535	def SelectLayer(self, layer):
99			"""Select the given layer.
100
101			If the layer is the currently selected layer, do nothing.
102			Ortherwise, issue a LAYER_SELECTED message and if there were
103			shapes selected preciously issue a SHAPES_SELECTED message as
104			well.
105			"""
106			if self.layer is not layer:
107			self.layer = layer
108			issue_shape = len(self.shapes) > 0
109			self.shapes = []
110			self.issue_messages(1, issue_shape)
111
112			def SelectShapes(self, layer, shapes, add = 0):
113			"""Select the shapes given in the list shapes in the given layer.
114
115			If the optional keyword parameter add is true, add the selected
116			shapes to the currently selected shapes if layer is the already
117			selected layer if any. If add is false (the default) make the
118			shapes in shapes the selected shapes.
119
120			If a different layer is selected afterwards issue a
121			LAYER_SELECTED message. If the set of selected shapes has
122			changed afterwards issue a SHAPES_SELECTED message.
123			"""
124			# Turn the shapes explicitly into a list. This main purpose
125			# is that we get a mutable sequence that we can modify in place.
126			shapes = list(shapes)
127			shapes.sort()
128
129			if self.layer is not layer:
130			# If the layer is differen we can ignore the add parameter
131			# and we have to issue both messages.
132			self.layer = layer
133			self.shapes = shapes
134			issue_layer = issue_shape = 1
135			else:
136			# If the layer is differen we have to merge the ids if add
137			# is true, and we won't have to issue the LAYER_SELECTED
138			# message.
139			issue_layer = 0
140			if add:
141			# Merge the ids by creating a dict with the ids in
142			# self.shapes and in shapes as the keys. The use the sorted
143			# keys of the dict as the new shapes list.
144			set = {}
145			for i in self.shapes:
146			set[i] = 1
147			for i in shapes:
148			set[i] = 1
149			shapes = set.keys()
150			shapes.sort()
151			if self.shapes != shapes:
152			self.shapes = shapes
153			issue_shape = 1
154			else:
155			issue_shape = 0
156
157			self.issue_messages(issue_layer, issue_shape)
158
159			def AddShapes(self, layer, shapes):
160			"""Add the shapes on layer to the selection.
161
162			If the layer is the already selected layer, add the shape ids in
163			shapes to the already selected shapes.
164
165			If the layer is not the already selected layer, make the layer
166			and shapes the selected layer and shapes.
167			"""
168			self.SelectShapes(layer, shapes)
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision