Thuban/UI/controls.py

# Copyright (c) 2001, 2002 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.


"""Common Thuban specific control widgets"""

__version__ = "$Revision$"

from wxPython.wx import wxListCtrl, wxLC_REPORT, wxLIST_AUTOSIZE_USEHEADER, \
     EVT_LIST_ITEM_SELECTED, true, false
from wxPython.grid import wxPyGridTableBase, wxGrid, wxGRID_VALUE_STRING, \
     wxGridTableMessage, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, \
     wxGRIDTABLE_NOTIFY_ROWS_DELETED, wxGRIDTABLE_REQUEST_VIEW_GET_VALUES

# FIXME: the wx_value_type_map should be moved from tableview to a
# separate module
from tableview import wx_value_type_map


class RecordListCtrl(wxListCtrl):

    """List Control showing a single record from a thuban table"""

    def __init__(self, parent, id):
        wxListCtrl.__init__(self, parent, id, style = wxLC_REPORT)

        self.InsertColumn(0, "Field")
        self.SetColumnWidth(0, wxLIST_AUTOSIZE_USEHEADER)
        self.InsertColumn(1, "Value")
        self.SetColumnWidth(1, wxLIST_AUTOSIZE_USEHEADER)

        # vaues maps row numbers to the corresponding python values
        self.values = {}

    def fill_list(self, table, shape):
        """Fill self with the contents shape's record from table"""
        self.DeleteAllItems()
        values = {}

        if shape is not None:
            num_cols = table.field_count()

            names = []
            for i in range(num_cols):
                type, name, length, decc = table.field_info(i)
                names.append(name)
            record = table.read_record(shape)

            for i in range(len(names)):
                name = names[i]
                value = record[name]
                self.InsertStringItem(i, name)
                self.SetStringItem(i, 1, str(value))
                values[i] = value

        self.values = values

class SelectableRecordListCtrl(RecordListCtrl):

    def __init__(self, parent, id):
        RecordListCtrl.__init__(self, parent, id)

        # selected is the index of the selected record or -1 if none is
        # selected
        self.selected = -1
        EVT_LIST_ITEM_SELECTED(self, self.GetId(), self.OnItemSelected)

    def OnItemSelected(self, event):
        """Event handler. Update the selected instvar"""
        self.selected = event.m_itemIndex

    def GetValue(self):
        """Return the currently selected value. None if no value is selected"""
        if self.selected >= 0:
            return self.values[self.selected]
        else:
            return None


class RecordTable(wxPyGridTableBase):

    """Wrapper that makes a Thuban table record look like a table for a
       wxGrid
    """

    def __init__(self, table = None, record = None):
        wxPyGridTableBase.__init__(self)
        self.num_cols = 1
        self.num_rows = 0
        self.table = None
        self.record_index = record
        self.record = None
        self.SetTable(table, record)

    def SetTable(self, table, record_index):
        old_num_rows = self.num_rows
        if record_index is not None:
            self.table = table
            self.record_index = record_index
            self.record = table.read_record(record_index)

            # we have one row for each field in the table
            self.num_rows = table.field_count()

            # extract the field types and names of the row we're showing.
            self.rows = []
            for i in range(self.num_rows):
                type, name, len, decc = table.field_info(i)
                self.rows.append((name, wx_value_type_map[type], len, decc))
            self.notify_get_values()
        else:
            # make the grid empty
            self.num_rows = 0
            self.rows = []

        # notify the views if the number of rows has changed
        if self.num_rows > old_num_rows:
            self.notify_append_rows(self.num_rows - old_num_rows)
        elif self.num_rows < old_num_rows:
            self.notify_delete_rows(0, old_num_rows - self.num_rows)

    def notify_append_rows(self, num):
        """Tell the view that num rows were appended"""
        self.send_view_message(wxGRIDTABLE_NOTIFY_ROWS_APPENDED, num)

    def notify_delete_rows(self, start, num):
        """Tell the view that num rows were deleted starting at start"""
        self.send_view_message(wxGRIDTABLE_NOTIFY_ROWS_DELETED, start, num)

    def notify_get_values(self):
        """Tell the view that the grid's values have to be updated"""
        self.send_view_message(wxGRIDTABLE_REQUEST_VIEW_GET_VALUES)

    def send_view_message(self, msgid, *args):
        """Send the message msgid to the view with arguments args"""
        view = self.GetView()
        if view:
            #print "send_view_message", msgid, args
            msg = apply(wxGridTableMessage, (self, msgid) + args)
            view.ProcessTableMessage(msg)

    #
    # required methods for the wxPyGridTableBase interface
    #

    def GetNumberRows(self):
        return self.num_rows

    def GetNumberCols(self):
        return self.num_cols

    def IsEmptyCell(self, row, col):
        return row >= self.num_rows or col >= self.num_cols

    # Get/Set values in the table.  The Python version of these
    # methods can handle any data-type, (as long as the Editor and
    # Renderer understands the type too,) not just strings as in the
    # C++ version.
    def GetValue(self, row, col):
        if row < self.num_rows:
            return self.record[self.rows[row][0]]
        return ""

    def SetValue(self, row, col, value):
        if row < self.num_rows:
            name = self.rows[row][0]
            self.record[name] = value
            self.table.write_record(self.record_index, {name: value})

    #
    # Some optional methods
    #

    # Called when the grid needs to display labels
    def GetColLabelValue(self, col):
        return "Value"

    def GetRowLabelValue(self, row):
        if row < self.num_rows:
            return self.rows[row][0]
        return ""

    # Called to determine the kind of editor/renderer to use by
    # default, doesn't necessarily have to be the same type used
    # nativly by the editor/renderer if they know how to convert.
    def GetTypeName(self, row, col):
        # for some reason row and col may be negative sometimes, but
        # it's probably a wx bug (filed as #593189 on sourceforge)
        if 0 <= row < self.num_rows:
            return self.rows[row][1]
        return wxGRID_VALUE_STRING

    # Called to determine how the data can be fetched and stored by the
    # editor and renderer.  This allows you to enforce some type-safety
    # in the grid.
    def CanGetValueAs(self, row, col, typeName):
        # perhaps we should allow conversion int->double?
        return self.GetTypeName(row, col) == typeName

    def CanSetValueAs(self, row, col, typeName):
        return self.CanGetValueAs(row, col, typeName)


class RecordGridCtrl(wxGrid):

    """Grid view for a RecordTable"""

    def __init__(self, parent, table = None, record = None):
        wxGrid.__init__(self, parent, -1)

        self.table = RecordTable(table, record)

        # The second parameter means that the grid is to take ownership
        # of the table and will destroy it when done. Otherwise you
        # would need to keep a reference to it and call it's Destroy
        # method later.
        self.SetTable(self.table, true)

        #self.SetMargins(0,0)
        self.AutoSizeColumn(0, true)

        #self.SetSelectionMode(wxGrid.wxGridSelectRows)

        #EVT_GRID_RANGE_SELECT(self, self.OnRangeSelect)
        #EVT_GRID_SELECT_CELL(self, self.OnSelectCell)

    def SetTableRecord(self, table, record):
        self.table.SetTable(table, record)
1	# Copyright (c) 2001, 2002 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	"""Common Thuban specific control widgets"""
10
11	__version__ = "$Revision$"
12
13	from wxPython.wx import wxListCtrl, wxLC_REPORT, wxLIST_AUTOSIZE_USEHEADER, \
14	EVT_LIST_ITEM_SELECTED, true, false
15	from wxPython.grid import wxPyGridTableBase, wxGrid, wxGRID_VALUE_STRING, \
16	wxGridTableMessage, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, \
17	wxGRIDTABLE_NOTIFY_ROWS_DELETED, wxGRIDTABLE_REQUEST_VIEW_GET_VALUES
18
19	# FIXME: the wx_value_type_map should be moved from tableview to a
20	# separate module
21	from tableview import wx_value_type_map
22
23
24
25	class RecordListCtrl(wxListCtrl):
26
27	"""List Control showing a single record from a thuban table"""
28
29	def __init__(self, parent, id):
30	wxListCtrl.__init__(self, parent, id, style = wxLC_REPORT)
31
32	self.InsertColumn(0, "Field")
33	self.SetColumnWidth(0, wxLIST_AUTOSIZE_USEHEADER)
34	self.InsertColumn(1, "Value")
35	self.SetColumnWidth(1, wxLIST_AUTOSIZE_USEHEADER)
36
37	# vaues maps row numbers to the corresponding python values
38	self.values = {}
39
40	def fill_list(self, table, shape):
41	"""Fill self with the contents shape's record from table"""
42	self.DeleteAllItems()
43	values = {}
44
45	if shape is not None:
46	num_cols = table.field_count()
47
48	names = []
49	for i in range(num_cols):
50	type, name, length, decc = table.field_info(i)
51	names.append(name)
52	record = table.read_record(shape)
53
54	for i in range(len(names)):
55	name = names[i]
56	value = record[name]
57	self.InsertStringItem(i, name)
58	self.SetStringItem(i, 1, str(value))
59	values[i] = value
60
61	self.values = values
62
63	class SelectableRecordListCtrl(RecordListCtrl):
64
65	def __init__(self, parent, id):
66	RecordListCtrl.__init__(self, parent, id)
67
68	# selected is the index of the selected record or -1 if none is
69	# selected
70	self.selected = -1
71	EVT_LIST_ITEM_SELECTED(self, self.GetId(), self.OnItemSelected)
72
73	def OnItemSelected(self, event):
74	"""Event handler. Update the selected instvar"""
75	self.selected = event.m_itemIndex
76
77	def GetValue(self):
78	"""Return the currently selected value. None if no value is selected"""
79	if self.selected >= 0:
80	return self.values[self.selected]
81	else:
82	return None
83
84
85	class RecordTable(wxPyGridTableBase):
86
87	"""Wrapper that makes a Thuban table record look like a table for a
88	wxGrid
89	"""
90
91	def __init__(self, table = None, record = None):
92	wxPyGridTableBase.__init__(self)
93	self.num_cols = 1
94	self.num_rows = 0
95	self.table = None
96	self.record_index = record
97	self.record = None
98	self.SetTable(table, record)
99
100	def SetTable(self, table, record_index):
101	old_num_rows = self.num_rows
102	if record_index is not None:
103	self.table = table
104	self.record_index = record_index
105	self.record = table.read_record(record_index)
106
107	# we have one row for each field in the table
108	self.num_rows = table.field_count()
109
110	# extract the field types and names of the row we're showing.
111	self.rows = []
112	for i in range(self.num_rows):
113	type, name, len, decc = table.field_info(i)
114	self.rows.append((name, wx_value_type_map[type], len, decc))
115	self.notify_get_values()
116	else:
117	# make the grid empty
118	self.num_rows = 0
119	self.rows = []
120
121	# notify the views if the number of rows has changed
122	if self.num_rows > old_num_rows:
123	self.notify_append_rows(self.num_rows - old_num_rows)
124	elif self.num_rows < old_num_rows:
125	self.notify_delete_rows(0, old_num_rows - self.num_rows)
126
127	def notify_append_rows(self, num):
128	"""Tell the view that num rows were appended"""
129	self.send_view_message(wxGRIDTABLE_NOTIFY_ROWS_APPENDED, num)
130
131	def notify_delete_rows(self, start, num):
132	"""Tell the view that num rows were deleted starting at start"""
133	self.send_view_message(wxGRIDTABLE_NOTIFY_ROWS_DELETED, start, num)
134
135	def notify_get_values(self):
136	"""Tell the view that the grid's values have to be updated"""
137	self.send_view_message(wxGRIDTABLE_REQUEST_VIEW_GET_VALUES)
138
139	def send_view_message(self, msgid, *args):
140	"""Send the message msgid to the view with arguments args"""
141	view = self.GetView()
142	if view:
143	#print "send_view_message", msgid, args
144	msg = apply(wxGridTableMessage, (self, msgid) + args)
145	view.ProcessTableMessage(msg)
146
147	#
148	# required methods for the wxPyGridTableBase interface
149	#
150
151	def GetNumberRows(self):
152	return self.num_rows
153
154	def GetNumberCols(self):
155	return self.num_cols
156
157	def IsEmptyCell(self, row, col):
158	return row >= self.num_rows or col >= self.num_cols
159
160	# Get/Set values in the table. The Python version of these
161	# methods can handle any data-type, (as long as the Editor and
162	# Renderer understands the type too,) not just strings as in the
163	# C++ version.
164	def GetValue(self, row, col):
165	if row < self.num_rows:
166	return self.record[self.rows[row][0]]
167	return ""
168
169	def SetValue(self, row, col, value):
170	if row < self.num_rows:
171	name = self.rows[row][0]
172	self.record[name] = value
173	self.table.write_record(self.record_index, {name: value})
174
175	#
176	# Some optional methods
177	#
178
179	# Called when the grid needs to display labels
180	def GetColLabelValue(self, col):
181	return "Value"
182
183	def GetRowLabelValue(self, row):
184	if row < self.num_rows:
185	return self.rows[row][0]
186	return ""
187
188	# Called to determine the kind of editor/renderer to use by
189	# default, doesn't necessarily have to be the same type used
190	# nativly by the editor/renderer if they know how to convert.
191	def GetTypeName(self, row, col):
192	# for some reason row and col may be negative sometimes, but
193	# it's probably a wx bug (filed as #593189 on sourceforge)
194	if 0 <= row < self.num_rows:
195	return self.rows[row][1]
196	return wxGRID_VALUE_STRING
197
198	# Called to determine how the data can be fetched and stored by the
199	# editor and renderer. This allows you to enforce some type-safety
200	# in the grid.
201	def CanGetValueAs(self, row, col, typeName):
202	# perhaps we should allow conversion int->double?
203	return self.GetTypeName(row, col) == typeName
204
205	def CanSetValueAs(self, row, col, typeName):
206	return self.CanGetValueAs(row, col, typeName)
207
208
209
210	class RecordGridCtrl(wxGrid):
211
212	"""Grid view for a RecordTable"""
213
214	def __init__(self, parent, table = None, record = None):
215	wxGrid.__init__(self, parent, -1)
216
217	self.table = RecordTable(table, record)
218
219	# The second parameter means that the grid is to take ownership
220	# of the table and will destroy it when done. Otherwise you
221	# would need to keep a reference to it and call it's Destroy
222	# method later.
223	self.SetTable(self.table, true)
224
225	#self.SetMargins(0,0)
226	self.AutoSizeColumn(0, true)
227
228	#self.SetSelectionMode(wxGrid.wxGridSelectRows)
229
230	#EVT_GRID_RANGE_SELECT(self, self.OnRangeSelect)
231	#EVT_GRID_SELECT_CELL(self, self.OnSelectCell)
232
233	def SetTableRecord(self, table, record):
234	self.table.SetTable(table, record)
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision