1

#!/usr/bin/env python

     2

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

     3

     4

# This file is part of Beremiz, a Integrated Development Environment for

     5

# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.

     6

#

     7

# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

# See COPYING file for copyrights details.

    10

#

    11

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

    12

# modify it under the terms of the GNU General Public License

    13

# as published by the Free Software Foundation; either version 2

    14

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

    15

#

    16

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

    17

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

    18

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    19

# GNU General Public License for more details.

    20

#

    21

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

    22

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

    23

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    24

    25

import wx

    26

import wx.grid

    27

    28

if wx.Platform == '__WXMSW__':

    29

    ROW_HEIGHT = 20

    30

else:

    31

    ROW_HEIGHT = 28

    32

    33

    34

class CustomTable(wx.grid.PyGridTableBase):

    35

    36

    """

    37

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

    38

    """

    39

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

    40

        # The base class must be initialized *first*

    41

        wx.grid.PyGridTableBase.__init__(self)

    42

        self.data = data

    43

        self.colnames = colnames

    44

        self.Highlights = {}

    45

        self.Parent = parent

    46

        # XXX

    47

        # we need to store the row length and collength to

    48

        # see if the table has changed size

    49

        self._rows = self.GetNumberRows()

    50

        self._cols = self.GetNumberCols()

    51

    52

    def GetNumberCols(self):

    53

        return len(self.colnames)

    54

    55

    def GetNumberRows(self):

    56

        return len(self.data)

    57

    58

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

    59

        if col < len(self.colnames):

    60

            if translate:

    61

                return _(self.colnames[col])

    62

            return self.colnames[col]

    63

    64

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

    65

        return row

    66

    67

    def GetValue(self, row, col):

    68

        if row < self.GetNumberRows():

    69

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

    70

    71

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

    72

        if col < len(self.colnames):

    73

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

    74

    75

    def GetValueByName(self, row, colname):

    76

        if row < self.GetNumberRows():

    77

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

    78

    79

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

    80

        if row < self.GetNumberRows():

    81

            self.data[row][colname] = value

    82

    83

    def ResetView(self, grid):

    84

        """

    85

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

    86

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

    87

        """

    88

        grid.CloseEditControl()

    89

        grid.BeginBatch()

    90

        for current, new, delmsg, addmsg in [

    91

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

    92

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

    93

        ]:

    94

            if new < current:

    95

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

    96

                grid.ProcessTableMessage(msg)

    97

            elif new > current:

    98

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

    99

                grid.ProcessTableMessage(msg)

   100

                self.UpdateValues(grid)

   101

        grid.EndBatch()

   102

   103

        self._rows = self.GetNumberRows()

   104

        self._cols = self.GetNumberCols()

   105

        # update the column rendering scheme

   106

        self._updateColAttrs(grid)

   107

   108

        # update the scrollbars and the displayed part of the grid

   109

        grid.AdjustScrollbars()

   110

        grid.ForceRefresh()

   111

   112

    def UpdateValues(self, grid):

   113

        """Update all displayed values"""

   114

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

   115

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

   116

        grid.ProcessTableMessage(msg)

   117

   118

    def _updateColAttrs(self, grid):

   119

        """

   120

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

   121

        appropriate renderer given the column name.

   122

   123

        Otherwise default to the default renderer.

   124

        """

   125

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

   126

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

   127

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

   128

                colname = self.GetColLabelValue(col, False)

   129

   130

                grid.SetReadOnly(row, col, True)

   131

                grid.SetCellEditor(row, col, None)

   132

                grid.SetCellRenderer(row, col, None)

   133

   134

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

   135

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

   136

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

   137

            self.ResizeRow(grid, row)

   138

   139

    def ResizeRow(self, grid, row):

   140

        if grid.GetRowSize(row) < ROW_HEIGHT:

   141

            grid.SetRowMinimalHeight(row, ROW_HEIGHT)

   142

            grid.AutoSizeRow(row, False)

   143

   144

    def SetData(self, data):

   145

        self.data = data

   146

   147

    def GetData(self):

   148

        return self.data

   149

   150

    def GetCurrentIndex(self):

   151

        return self.CurrentIndex

   152

   153

    def SetCurrentIndex(self, index):

   154

        self.CurrentIndex = index

   155

   156

    def AppendRow(self, row_content):

   157

        self.data.append(row_content)

   158

   159

    def InsertRow(self, index, row_content):

   160

        self.data.insert(index, row_content)

   161

   162

    def MoveRow(self, row_index, move):

   163

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

   164

        if new_index != row_index:

   165

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

   166

        return new_index

   167

   168

    def RemoveRow(self, row_index):

   169

        self.data.pop(row_index)

   170

   171

    def GetRow(self, row_index):

   172

        return self.data[row_index]

   173

   174

    def Empty(self):

   175

        self.data = []

   176

   177

    def AddHighlight(self, infos, highlight_type):

   178

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

   179

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

   180

        col_highlights.append(highlight_type)

   181

   182

    def RemoveHighlight(self, infos, highlight_type):

   183

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

   184

        if row_highlights is not None:

   185

            col_highlights = row_highlights.get(infos[1])

   186

            if col_highlights is not None and highlight_type in col_highlights:

   187

                col_highlights.remove(highlight_type)

   188

            if len(col_highlights) == 0:

   189

                row_highlights.pop(infos[1])

   190

   191

    def ClearHighlights(self, highlight_type=None):

   192

        if highlight_type is None:

   193

            self.Highlights = {}

   194

        else:

   196

                row_items = row_highlights.items()

   197

                for col, col_highlights in row_items:

   198

                    if highlight_type in col_highlights:

   199

                        col_highlights.remove(highlight_type)

   200

                    if len(col_highlights) == 0:

   201

                        row_highlights.pop(col)