controls/CustomTable.py
author laurent
Wed, 02 May 2012 00:32:15 +0200
changeset 675 0ea836add01f
parent 662 3c4e0d4f7a61
child 684 f10449b18dbe
permissions -rw-r--r--
Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
604
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     1
#This library is free software; you can redistribute it and/or
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     2
#modify it under the terms of the GNU General Public
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     3
#License as published by the Free Software Foundation; either
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     4
#version 2.1 of the License, or (at your option) any later version.
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     5
#
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     6
#This library is distributed in the hope that it will be useful,
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     7
#but WITHOUT ANY WARRANTY; without even the implied warranty of
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     8
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
     9
#General Public License for more details.
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    10
#
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    11
#You should have received a copy of the GNU General Public
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    12
#License along with this library; if not, write to the Free Software
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    13
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    14
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    15
import wx
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    16
import wx.grid
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    17
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    18
class CustomTable(wx.grid.PyGridTableBase):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    19
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    20
    """
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    21
    A custom wx.grid.Grid Table using user supplied data
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    22
    """
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    23
    def __init__(self, parent, data, colnames):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    24
        # The base class must be initialized *first*
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    25
        wx.grid.PyGridTableBase.__init__(self)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    26
        self.data = data
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    27
        self.colnames = colnames
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    28
        self.Highlights = {}
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    29
        self.Parent = parent
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    30
        # XXX
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    31
        # we need to store the row length and collength to
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    32
        # see if the table has changed size
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    33
        self._rows = self.GetNumberRows()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    34
        self._cols = self.GetNumberCols()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    35
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    36
    def GetNumberCols(self):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    37
        return len(self.colnames)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    38
        
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    39
    def GetNumberRows(self):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    40
        return len(self.data)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    41
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    42
    def GetColLabelValue(self, col, translate=True):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    43
        if col < len(self.colnames):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    44
            if translate:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    45
                return _(self.colnames[col])
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    46
            return self.colnames[col]
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    47
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    48
    def GetRowLabelValue(self, row, translate=True):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    49
        return row
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    50
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    51
    def GetValue(self, row, col):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    52
        if row < self.GetNumberRows():
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    53
            return self.data[row].get(self.GetColLabelValue(col, False), "")
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    54
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    55
    def SetValue(self, row, col, value):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    56
        if col < len(self.colnames):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    57
            self.data[row][self.GetColLabelValue(col, False)] = value
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    58
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    59
    def GetValueByName(self, row, colname):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    60
        if row < self.GetNumberRows():
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    61
            return self.data[row].get(colname)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    62
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    63
    def SetValueByName(self, row, colname, value):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    64
        if row < self.GetNumberRows():
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    65
            self.data[row][colname] = value
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    66
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    67
    def ResetView(self, grid):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    68
        """
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    69
        (wx.grid.Grid) -> Reset the grid view.   Call this to
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    70
        update the grid if rows and columns have been added or deleted
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    71
        """
662
3c4e0d4f7a61 Fix bug when grid is reset and a CellEditor is still active
laurent
parents: 606
diff changeset
    72
        grid.CloseEditControl()
604
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    73
        grid.BeginBatch()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    74
        for current, new, delmsg, addmsg in [
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    75
            (self._rows, self.GetNumberRows(), wx.grid.GRIDTABLE_NOTIFY_ROWS_DELETED, wx.grid.GRIDTABLE_NOTIFY_ROWS_APPENDED),
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    76
            (self._cols, self.GetNumberCols(), wx.grid.GRIDTABLE_NOTIFY_COLS_DELETED, wx.grid.GRIDTABLE_NOTIFY_COLS_APPENDED),
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    77
        ]:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    78
            if new < current:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    79
                msg = wx.grid.GridTableMessage(self,delmsg,new,current-new)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    80
                grid.ProcessTableMessage(msg)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    81
            elif new > current:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    82
                msg = wx.grid.GridTableMessage(self,addmsg,new-current)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    83
                grid.ProcessTableMessage(msg)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    84
                self.UpdateValues(grid)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    85
        grid.EndBatch()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    86
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    87
        self._rows = self.GetNumberRows()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    88
        self._cols = self.GetNumberCols()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    89
        # update the column rendering scheme
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    90
        self._updateColAttrs(grid)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    91
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    92
        # update the scrollbars and the displayed part of the grid
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    93
        grid.AdjustScrollbars()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    94
        grid.ForceRefresh()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    95
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    96
    def UpdateValues(self, grid):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    97
        """Update all displayed values"""
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    98
        # This sends an event to the grid table to update all of the values
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
    99
        msg = wx.grid.GridTableMessage(self, wx.grid.GRIDTABLE_REQUEST_VIEW_GET_VALUES)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   100
        grid.ProcessTableMessage(msg)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   101
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   102
    def _updateColAttrs(self, grid):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   103
        """
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   104
        wx.grid.Grid -> update the column attributes to add the
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   105
        appropriate renderer given the column name.
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   106
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   107
        Otherwise default to the default renderer.
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   108
        """
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   109
        for row in range(self.GetNumberRows()):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   110
            row_highlights = self.Highlights.get(row, {})
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   111
            for col in range(self.GetNumberCols()):
606
d65122c61eaf Moving definition of grids fonts and colours into CustomGrid
laurent
parents: 604
diff changeset
   112
                colname = self.GetColLabelValue(col, False)
d65122c61eaf Moving definition of grids fonts and colours into CustomGrid
laurent
parents: 604
diff changeset
   113
                
604
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   114
                grid.SetReadOnly(row, col, True)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   115
                grid.SetCellEditor(row, col, None)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   116
                grid.SetCellRenderer(row, col, None)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   117
                
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   118
                highlight_colours = row_highlights.get(colname.lower(), [(wx.WHITE, wx.BLACK)])[-1]
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   119
                grid.SetCellBackgroundColour(row, col, highlight_colours[0])
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   120
                grid.SetCellTextColour(row, col, highlight_colours[1])
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   121
            self.ResizeRow(grid, row)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   122
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   123
    def ResizeRow(self, grid, row):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   124
        if wx.Platform == '__WXMSW__':
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   125
            grid.SetRowMinimalHeight(row, 20)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   126
        else:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   127
            grid.SetRowMinimalHeight(row, 28)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   128
        grid.AutoSizeRow(row, False)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   129
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   130
    def SetData(self, data):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   131
        self.data = data
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   132
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   133
    def GetData(self):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   134
        return self.data
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   135
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   136
    def GetCurrentIndex(self):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   137
        return self.CurrentIndex
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   138
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   139
    def SetCurrentIndex(self, index):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   140
        self.CurrentIndex = index
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   141
    
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   142
    def AppendRow(self, row_content):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   143
        self.data.append(row_content)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   144
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   145
    def InsertRow(self, index, row_content):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   146
        self.data.insert(index, row_content)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   147
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   148
    def MoveRow(self, row_index, move):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   149
        new_index = max(0, min(row_index + move, len(self.data) - 1))
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   150
        if new_index != row_index:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   151
            self.data.insert(new_index, self.data.pop(row_index))
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   152
        return new_index
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   153
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   154
    def RemoveRow(self, row_index):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   155
        self.data.pop(row_index)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   156
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   157
    def GetRow(self, row_index):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   158
        return self.data[row_index]
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   159
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   160
    def Empty(self):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   161
        self.data = []
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   162
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   163
    def AddHighlight(self, infos, highlight_type):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   164
        row_highlights = self.Highlights.setdefault(infos[0], {})
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   165
        col_highlights = row_highlights.setdefault(infos[1], [])
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   166
        col_highlights.append(highlight_type)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   167
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   168
    def ClearHighlights(self, highlight_type=None):
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   169
        if highlight_type is None:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   170
            self.Highlights = {}
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   171
        else:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   172
            for row, row_highlights in self.Highlights.iteritems():
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   173
                row_items = row_highlights.items()
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   174
                for col, col_highlights in row_items:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   175
                    if highlight_type in col_highlights:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   176
                        col_highlights.remove(highlight_type)
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   177
                    if len(col_highlights) == 0:
5b42b4401e6b Adding support for unifying grid table control elements
laurent
parents:
diff changeset
   178
                        row_highlights.pop(col)