1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This library is free software; you can redistribute it and/or

     5

#modify it under the terms of the GNU General Public

     6

#License as published by the Free Software Foundation; either

     7

#version 2.1 of the License, or (at your option) any later version.

     8

#

     9

#This library is distributed in the hope that it will be useful,

    10

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    11

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    12

#General Public License for more details.

    13

#

    14

#You should have received a copy of the GNU General Public

    15

#License along with this library; if not, write to the Free Software

    16

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    17

    18

import wx

    19

import wx.grid

    20

    21

if wx.Platform == '__WXMSW__':

    22

    ROW_HEIGHT = 20

    23

else:

    24

    ROW_HEIGHT = 28

    25

    26

class CustomTable(wx.grid.PyGridTableBase):

    27

    28

    """

    29

    A custom wx.grid.Grid Table using user supplied data

    30

    """

    31

    def __init__(self, parent, data, colnames):

    32

        # The base class must be initialized *first*

    33

        wx.grid.PyGridTableBase.__init__(self)

    34

        self.data = data

    35

        self.colnames = colnames

    36

        self.Highlights = {}

    37

        self.Parent = parent

    38

        # XXX

    39

        # we need to store the row length and collength to

    40

        # see if the table has changed size

    41

        self._rows = self.GetNumberRows()

    42

        self._cols = self.GetNumberCols()

    43

    44

    def GetNumberCols(self):

    45

        return len(self.colnames)

    46

    47

    def GetNumberRows(self):

    48

        return len(self.data)

    49

    50

    def GetColLabelValue(self, col, translate=True):

    51

        if col < len(self.colnames):

    52

            if translate:

    53

                return _(self.colnames[col])

    54

            return self.colnames[col]

    55

    56

    def GetRowLabelValue(self, row, translate=True):

    57

        return row

    58

    59

    def GetValue(self, row, col):

    60

        if row < self.GetNumberRows():

    61

            return self.data[row].get(self.GetColLabelValue(col, False), "")

    62

    63

    def SetValue(self, row, col, value):

    64

        if col < len(self.colnames):

    65

            self.data[row][self.GetColLabelValue(col, False)] = value

    66

    67

    def GetValueByName(self, row, colname):

    68

        if row < self.GetNumberRows():

    69

            return self.data[row].get(colname)

    70

    71

    def SetValueByName(self, row, colname, value):

    72

        if row < self.GetNumberRows():

    73

            self.data[row][colname] = value

    74

    75

    def ResetView(self, grid):

    76

        """

    77

        (wx.grid.Grid) -> Reset the grid view.   Call this to

    78

        update the grid if rows and columns have been added or deleted

    79

        """

    80

        grid.CloseEditControl()

    81

        grid.BeginBatch()

    82

        for current, new, delmsg, addmsg in [

    83

            (self._rows, self.GetNumberRows(), wx.grid.GRIDTABLE_NOTIFY_ROWS_DELETED, wx.grid.GRIDTABLE_NOTIFY_ROWS_APPENDED),

    84

            (self._cols, self.GetNumberCols(), wx.grid.GRIDTABLE_NOTIFY_COLS_DELETED, wx.grid.GRIDTABLE_NOTIFY_COLS_APPENDED),

    85

        ]:

    86

            if new < current:

    87

                msg = wx.grid.GridTableMessage(self,delmsg,new,current-new)

    88

                grid.ProcessTableMessage(msg)

    89

            elif new > current:

    90

                msg = wx.grid.GridTableMessage(self,addmsg,new-current)

    91

                grid.ProcessTableMessage(msg)

    92

                self.UpdateValues(grid)

    93

        grid.EndBatch()

    94

    95

        self._rows = self.GetNumberRows()

    96

        self._cols = self.GetNumberCols()

    97

        # update the column rendering scheme

    98

        self._updateColAttrs(grid)

    99

   100

        # update the scrollbars and the displayed part of the grid

   101

        grid.AdjustScrollbars()

   102

        grid.ForceRefresh()

   103

   104

    def UpdateValues(self, grid):

   105

        """Update all displayed values"""

   106

        # This sends an event to the grid table to update all of the values

   107

        msg = wx.grid.GridTableMessage(self, wx.grid.GRIDTABLE_REQUEST_VIEW_GET_VALUES)

   108

        grid.ProcessTableMessage(msg)

   109

   110

    def _updateColAttrs(self, grid):

   111

        """

   112

        wx.grid.Grid -> update the column attributes to add the

   113

        appropriate renderer given the column name.

   114

   115

        Otherwise default to the default renderer.

   116

        """

   117

        for row in range(self.GetNumberRows()):

   118

            row_highlights = self.Highlights.get(row, {})

   119

            for col in range(self.GetNumberCols()):

   120

                colname = self.GetColLabelValue(col, False)

   121

   122

                grid.SetReadOnly(row, col, True)

   123

                grid.SetCellEditor(row, col, None)

   124

                grid.SetCellRenderer(row, col, None)

   125

   126

                highlight_colours = row_highlights.get(colname.lower(), [(wx.WHITE, wx.BLACK)])[-1]

   127

                grid.SetCellBackgroundColour(row, col, highlight_colours[0])

   128

                grid.SetCellTextColour(row, col, highlight_colours[1])

   129

            self.ResizeRow(grid, row)

   130

   131

    def ResizeRow(self, grid, row):

   132

        if grid.GetRowSize(row) < ROW_HEIGHT:

   133

            grid.SetRowMinimalHeight(row, ROW_HEIGHT)

   134

            grid.AutoSizeRow(row, False)

   135

   136

    def SetData(self, data):

   137

        self.data = data

   138

   139

    def GetData(self):

   140

        return self.data

   141

   142

    def GetCurrentIndex(self):

   143

        return self.CurrentIndex

   144

   145

    def SetCurrentIndex(self, index):

   146

        self.CurrentIndex = index

   147

   148

    def AppendRow(self, row_content):

   149

        self.data.append(row_content)

   150

   151

    def InsertRow(self, index, row_content):

   152

        self.data.insert(index, row_content)

   153

   154

    def MoveRow(self, row_index, move):

   155

        new_index = max(0, min(row_index + move, len(self.data) - 1))

   156

        if new_index != row_index:

   157

            self.data.insert(new_index, self.data.pop(row_index))

   158

        return new_index

   159

   160

    def RemoveRow(self, row_index):

   161

        self.data.pop(row_index)

   162

   163

    def GetRow(self, row_index):

   164

        return self.data[row_index]

   165

   166

    def Empty(self):

   167

        self.data = []

   168

   169

    def AddHighlight(self, infos, highlight_type):

   170

        row_highlights = self.Highlights.setdefault(infos[0], {})

   171

        col_highlights = row_highlights.setdefault(infos[1], [])

   172

        col_highlights.append(highlight_type)

   173

   174

    def RemoveHighlight(self, infos, highlight_type):

   175

        row_highlights = self.Highlights.get(infos[0])

   176

        if row_highlights is not None:

   177

            col_highlights = row_highlights.get(infos[1])

   178

            if col_highlights is not None and highlight_type in col_highlights:

   179

                col_highlights.remove(highlight_type)

   180

            if len(col_highlights) == 0:

   181

                row_highlights.pop(infos[1])

   182

   183

    def ClearHighlights(self, highlight_type=None):

   184

        if highlight_type is None:

   185

            self.Highlights = {}

   186

        else:

   187

            for row, row_highlights in self.Highlights.iteritems():

   188

                row_items = row_highlights.items()

   189

                for col, col_highlights in row_items:

   190

                    if highlight_type in col_highlights:

   191

                        col_highlights.remove(highlight_type)

   192

                    if len(col_highlights) == 0:

   193

                        row_highlights.pop(col)