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

    26

from __future__ import absolute_import

    27

import wx

    28

import wx.grid

    29

    30

if wx.Platform == '__WXMSW__':

    31

    ROW_HEIGHT = 20

    32

else:

    33

    ROW_HEIGHT = 28

    34

    35

    36

class CustomTable(wx.grid.PyGridTableBase):

    37

    38

    """

    39

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

    40

    """

    41

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

    42

        # The base class must be initialized *first*

    43

        wx.grid.PyGridTableBase.__init__(self)

    44

        self.data = data

    45

        self.colnames = colnames

    46

        self.Highlights = {}

    47

        self.Parent = parent

    48

        # XXX

    49

        # we need to store the row length and collength to

    50

        # see if the table has changed size

    51

        self._rows = self.GetNumberRows()

    52

        self._cols = self.GetNumberCols()

    53

    54

    def GetNumberCols(self):

    55

        return len(self.colnames)

    56

    57

    def GetNumberRows(self):

    58

        return len(self.data)

    59

    60

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

    61

        if col < len(self.colnames):

    62

            if translate:

    63

                return _(self.colnames[col])

    64

            return self.colnames[col]

    65

    66

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

    67

        return row

    68

    69

    def GetValue(self, row, col):

    70

        if row < self.GetNumberRows():

    71

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

    72

    73

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

    74

        if col < len(self.colnames):

    75

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

    76

    77

    def GetValueByName(self, row, colname):

    78

        if row < self.GetNumberRows():

    79

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

    80

    81

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

    82

        if row < self.GetNumberRows():

    83

            self.data[row][colname] = value

    84

    85

    def ResetView(self, grid):

    86

        """

    87

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

    88

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

    89

        """

    90

        grid.CloseEditControl()

    91

        grid.BeginBatch()

    92

        for current, new, delmsg, addmsg in [

    93

                (

    94

                    self._rows,

    95

                    self.GetNumberRows(),

    96

                    wx.grid.GRIDTABLE_NOTIFY_ROWS_DELETED,

    97

                    wx.grid.GRIDTABLE_NOTIFY_ROWS_APPENDED

    98

                ),

    99

                (

   100

                    self._cols,

   101

                    self.GetNumberCols(),

   102

                    wx.grid.GRIDTABLE_NOTIFY_COLS_DELETED,

   103

                    wx.grid.GRIDTABLE_NOTIFY_COLS_APPENDED

   104

                ),

   105

        ]:

   106

            if new < current:

   107

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

   108

                grid.ProcessTableMessage(msg)

   109

            elif new > current:

   110

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

   111

                grid.ProcessTableMessage(msg)

   112

                self.UpdateValues(grid)

   113

        grid.EndBatch()

   114

   115

        self._rows = self.GetNumberRows()

   116

        self._cols = self.GetNumberCols()

   117

        # update the column rendering scheme

   118

        self._updateColAttrs(grid)

   119

   120

        # update the scrollbars and the displayed part of the grid

   121

        grid.AdjustScrollbars()

   122

        grid.ForceRefresh()

   123

   124

    def UpdateValues(self, grid):

   125

        """Update all displayed values"""

   126

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

   127

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

   128

        grid.ProcessTableMessage(msg)

   129

   130

    def _updateColAttrs(self, grid):

   131

        """

   132

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

   133

        appropriate renderer given the column name.

   134

   135

        Otherwise default to the default renderer.

   136

        """

   137

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

   138

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

   139

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

   140

                colname = self.GetColLabelValue(col, False)

   141

   142

                grid.SetReadOnly(row, col, True)

   143

                grid.SetCellEditor(row, col, None)

   144

                grid.SetCellRenderer(row, col, None)

   145

   146

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

   147

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

   148

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

   149

            self.ResizeRow(grid, row)

   150

   151

    def ResizeRow(self, grid, row):

   152

        if grid.GetRowSize(row) < ROW_HEIGHT:

   153

            grid.SetRowMinimalHeight(row, ROW_HEIGHT)

   154

            grid.AutoSizeRow(row, False)

   155

   156

    def SetData(self, data):

   157

        self.data = data

   158

   159

    def GetData(self):

   160

        return self.data

   161

   162

    def GetCurrentIndex(self):

   163

        return self.CurrentIndex

   164

   165

    def SetCurrentIndex(self, index):

   166

        self.CurrentIndex = index

   167

   168

    def AppendRow(self, row_content):

   169

        self.data.append(row_content)

   170

   171

    def InsertRow(self, index, row_content):

   172

        self.data.insert(index, row_content)

   173

   174

    def MoveRow(self, row_index, move):

   175

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

   176

        if new_index != row_index:

   177

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

   178

        return new_index

   179

   180

    def RemoveRow(self, row_index):

   181

        self.data.pop(row_index)

   182

   183

    def GetRow(self, row_index):

   184

        return self.data[row_index]

   185

   186

    def Empty(self):

   187

        self.data = []

   188

   189

    def AddHighlight(self, infos, highlight_type):

   190

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

   191

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

   192

        col_highlights.append(highlight_type)

   193

   194

    def RemoveHighlight(self, infos, highlight_type):

   195

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

   196

        if row_highlights is not None:

   197

            col_highlights = row_highlights.get(infos[1])

   198

            if col_highlights is not None and highlight_type in col_highlights:

   199

                col_highlights.remove(highlight_type)

   200

            if len(col_highlights) == 0:

   201

                row_highlights.pop(infos[1])

   202

   203

    def ClearHighlights(self, highlight_type=None):

   204

        if highlight_type is None:

   205

            self.Highlights = {}

   206

        else:

   207

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

   208

                row_items = row_highlights.items()

   209

                for col, col_highlights in row_items:

   210

                    if highlight_type in col_highlights:

   211

                        col_highlights.remove(highlight_type)

   212

                    if len(col_highlights) == 0:

   213

                        row_highlights.pop(col)