1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" A model that provides data for a grid. """
from wx.grid import (
GridTableBase,
GridTableMessage,
GRIDTABLE_NOTIFY_ROWS_APPENDED,
)
from traits.api import Any, Bool, HasTraits, Event, List
from .grid_column import GridColumn
from .grid_row import GridRow
class GridModel(HasTraits):
""" A model that provides data for a grid. """
# fixme : factor this default model into "SimpleGridModel" or similar
# An optional 2-dimensional list/array containing the grid data.
data = Any()
# The rows in the model.
rows = List(GridRow)
# The columns in the model.
columns = List(GridColumn)
# Show row headers?
show_row_headers = Bool(True)
# Show column headers?
show_column_headers = Bool(True)
# Fired when the data in the model has changed.
model_changed = Event()
def __init__(self, **traits):
""" Create a new grid model. """
# Base class constructors.
HasTraits.__init__(self, **traits)
# The wx virtual table hook.
self._grid_table_base = _GridTableBase(self)
if len(self.columns) == 0 and self.data is not None:
print("Building default table column model")
columns = []
# Assume data is rectangular and use the length of the first row.
for i in range(len(self.data[0])):
columns.append(GridColumn(label=str(i)))
self.columns = columns
return
# ------------------------------------------------------------------------
# 'wxGridTableBase' interface.
# ------------------------------------------------------------------------
def GetNumberRows(self):
""" Return the number of rows in the model. """
return len(self.data)
def GetNumberCols(self):
""" Return the number of columns in the model. """
return len(self.columns)
def IsEmptyCell(self, row, col):
""" Is the specified cell empty? """
try:
return not self.data[row][col]
except IndexError:
return True
# Get/Set values in the table. The Python versions 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):
""" Get the value at the specified row and column. """
try:
return self.data[row][col]
except IndexError:
pass
return ""
def SetValue(self, row, col, value):
""" Set the value at the specified row and column. """
try:
self.data[row][col] = value
except IndexError:
# Add a new row.
self.data.append([0] * self.GetNumberCols())
self.data[row][col] = value
# Tell the grid that we've added a row.
#
# N.B wxGridTableMessage(table, whatWeDid, howMany)
message = GridTableMessage(self, GRIDTABLE_NOTIFY_ROWS_APPENDED, 1)
# Trait event notification.
self.model_changed = message
def GetRowLabelValue(self, row):
""" Called when the grid needs to display a row label. """
return str(row)
def GetColLabelValue(self, col):
""" Called when the grid needs to display a column label. """
return self.columns[col].label
def GetTypeName(self, row, col):
""" Called to determine the kind of editor/renderer to use.
This doesn't necessarily have to be the same type used natively by the
editor/renderer if they know how to convert.
"""
return self.columns[col].type
def CanGetValueAs(self, row, col, type_name):
""" Called to determine how the data can be fetched.
This allows you to enforce some type-safety in the grid.
"""
column_typename = self.GetTypeName(row, col)
return type_name == column_typename
def CanSetValueAs(self, row, col, type_name):
""" Called to determine how the data can be stored.
This allows you to enforce some type-safety in the grid.
"""
return self.CanGetValueAs(row, col, type_name)
def DeleteRows(self, pos, num_rows):
""" Called when the view is deleting rows. """
del self.data[pos:pos + num_rows]
# Tell the grid that we've deleted some rows.
#
# N.B Because of a bug in wxPython we have to send a "rows appended"
# --- message with a negative number, instead of the "rows deleted"
# message 8^() TINSTAFS!
message = GridTableMessage(
self, GRIDTABLE_NOTIFY_ROWS_APPENDED, -num_rows
)
# Trait event notification.
self.model_changed = message
return True
class _GridTableBase(GridTableBase):
""" A model that provides data for a grid. """
# ------------------------------------------------------------------------
# 'object' interface.
# ------------------------------------------------------------------------
def __init__(self, model):
""" Creates a new table base. """
# Base class constructor.
GridTableBase.__init__(self)
# The Pyface model that provides the data.
self.model = model
return
# ------------------------------------------------------------------------
# 'wxGridTableBase' interface.
# ------------------------------------------------------------------------
def GetNumberRows(self):
""" Return the number of rows in the model. """
return self.model.GetNumberRows()
def GetNumberCols(self):
""" Return the number of columns in the model. """
return self.model.GetNumberCols()
def IsEmptyCell(self, row, col):
""" Is the specified cell empty? """
return self.model.IsEmptyCell(row, col)
def GetValue(self, row, col):
""" Get the value at the specified row and column. """
return self.model.GetValue(row, col)
def SetValue(self, row, col, value):
""" Set the value at the specified row and column. """
return self.model.SetValue(row, col, value)
def GetRowLabelValue(self, row):
""" Called when the grid needs to display a row label. """
return self.model.GetRowLabelValue(row)
def GetColLabelValue(self, col):
""" Called when the grid needs to display a column label. """
return self.model.GetColLabelValue(col)
def GetTypeName(self, row, col):
""" Called to determine the kind of editor/renderer to use.
This doesn't necessarily have to be the same type used natively by the
editor/renderer if they know how to convert.
"""
return self.model.GetTypeName(row, col)
def CanGetValueAs(self, row, col, type_name):
""" Called to determine how the data can be fetched.
This allows you to enforce some type-safety in the grid.
"""
return self.model.CanGetValueAs(row, col, type_name)
def CanSetValueAs(self, row, col, type_name):
""" Called to determine how the data can be stored.
This allows you to enforce some type-safety in the grid.
"""
return self.model.CanSetValueAs(row, col, type_name)
def DeleteRows(self, pos, num_rows):
""" Called when the view is deleting rows. """
return self.model.DeleteRows(pos, num_rows)
|
