1

#!/usr/bin/env python

     2

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

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

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

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

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

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

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

    15

#

    16

#This library 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 GNU

    19

#General Public License for more details.

    20

#

    21

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

    22

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

    23

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

    24

    25

import wx

    26

import wx.grid

    27

    28

class CustomGrid(wx.grid.Grid):

    29

    30

    if wx.VERSION < (2, 6, 0):

    31

        def Bind(self, event, function, id = None):

    32

            if id is not None:

    33

                event(self, id, function)

    34

            else:

    35

                event(self, function)

    36

    37

    def __init__(self, *args, **kwargs):

    38

        wx.grid.Grid.__init__(self, *args, **kwargs)

    39

    40

        self.Editable = True

    41

    42

        self.AddButton = None

    43

        self.DeleteButton = None

    44

        self.UpButton = None

    45

        self.DownButton = None

    46

    47

        self.SetFont(wx.Font(12, 77, wx.NORMAL, wx.NORMAL, False, 'Sans'))

    48

        self.SetLabelFont(wx.Font(10, 77, wx.NORMAL, wx.NORMAL, False, 'Sans'))

    49

        self.SetSelectionBackground(wx.WHITE)

    50

        self.SetSelectionForeground(wx.BLACK)

    52

    53

        if wx.VERSION >= (2, 6, 0):

    54

            self.Bind(wx.grid.EVT_GRID_SELECT_CELL, self.OnSelectCell)

    55

        else:

    56

            wx.grid.EVT_GRID_SELECT_CELL(self, self.OnSelectCell)

    57

        self.Bind(wx.EVT_KEY_DOWN, self.OnKeyDown)

    58

    59

    def SetDefaultValue(self, default_value):

    60

        self.DefaultValue = default_value

    61

    62

    def SetEditable(self, editable=True):

    63

        self.Editable = editable

    64

        self.RefreshButtons()

    65

    66

    def SetButtons(self, buttons):

    67

        for name in ["Add", "Delete", "Up", "Down"]:

    68

            button = buttons.get(name, None)

    69

            setattr(self, "%sButton" % name, button)

    70

            if button is not None:

    71

                button.Bind(wx.EVT_BUTTON, getattr(self, "On%sButton" % name))

    72

    73

    def RefreshButtons(self):

    74

        rows = self.Table.GetNumberRows()

    75

        row = self.GetGridCursorRow()

    76

        if self.AddButton is not None:

    77

            self.AddButton.Enable(self.Editable)

    78

        if self.DeleteButton is not None:

    79

            self.DeleteButton.Enable(self.Editable and rows > 0)

    80

        if self.UpButton is not None:

    81

            self.UpButton.Enable(self.Editable and row > 0)

    82

        if self.DownButton is not None:

    83

            self.DownButton.Enable(self.Editable and 0 <= row < rows - 1)

    84

    85

    def CloseEditControl(self):

    86

        self.SetGridCursor(self.GetGridCursorRow(), self.GetGridCursorCol())

    87

    88

    def AddRow(self):

    89

        self.CloseEditControl()

    90

        new_row = self.GetGridCursorRow() + 1

    91

        col = max(self.GetGridCursorCol(), 0)

    92

        if getattr(self, "_AddRow", None) is not None:

    93

            new_row = self._AddRow(new_row)

    94

        else:

    95

            self.Table.InsertRow(new_row, self.DefaultValue.copy())

    96

            self.Table.ResetView(self)

    97

        self.SetGridCursor(new_row, col)

    98

        self.MakeCellVisible(new_row, col)

    99

        self.RefreshButtons()

   100

   101

    def DeleteRow(self):

   102

        self.CloseEditControl()

   103

        row = self.GetGridCursorRow()

   104

        if row >= 0:

   105

            col = self.GetGridCursorCol()

   106

            if getattr(self, "_DeleteRow", None) is not None:

   107

                self._DeleteRow(row)

   108

            else:

   109

                self.Table.RemoveRow(row)

   110

                self.Table.ResetView(self)

   111

            new_row = min(row, self.Table.GetNumberRows() - 1)

   112

            self.SetGridCursor(new_row, col)

   113

            self.MakeCellVisible(new_row, col)

   114

            self.RefreshButtons()

   115

   116

    def MoveRow(self, row, move):

   117

        self.CloseEditControl()

   118

        col = self.GetGridCursorCol()

   119

        if getattr(self, "_MoveRow", None) is not None:

   120

            new_row = self._MoveRow(row, move)

   121

        else:

   122

            new_row = self.Table.MoveRow(row, move)

   123

            if new_row != row:

   124

                self.Table.ResetView(self)

   125

        if new_row != row:

   126

            self.SetGridCursor(new_row, col)

   127

            self.MakeCellVisible(new_row, col)

   128

            self.RefreshButtons()

   129

   130

    def OnAddButton(self, event):

   131

        self.AddRow()

   132

        self.SetFocus()

   133

        event.Skip()

   134

   135

    def OnDeleteButton(self, event):

   136

        self.DeleteRow()

   137

        self.SetFocus()

   138

        event.Skip()

   139

   140

    def OnUpButton(self, event):

   141

        self.MoveRow(self.GetGridCursorRow(), -1)

   142

        self.SetFocus()

   143

        event.Skip()

   144

   145

    def OnDownButton(self, event):

   146

        self.MoveRow(self.GetGridCursorRow(), 1)

   147

        self.SetFocus()

   148

        event.Skip()

   149

   150

    def OnSelectCell(self, event):

   151

        wx.CallAfter(self.RefreshButtons)

   152

        event.Skip()

   153

   154

    def OnKeyDown(self, event):

   155

        key_handled = False

   156

        keycode = event.GetKeyCode()

   157

        if keycode == wx.WXK_TAB:

   158

            row = self.GetGridCursorRow()

   159

            col = self.GetGridCursorCol()

   160

            if event.ShiftDown():

   161

                if row < 0 or col == 0:

   162

                    self.Navigate(wx.NavigationKeyEvent.IsBackward)

   163

                    key_handled = True

   164

            elif row < 0 or col == self.Table.GetNumberCols() - 1:

   165

                self.Navigate(wx.NavigationKeyEvent.IsForward)

   166

                key_handled = True

   167

        elif keycode in (wx.WXK_ADD, wx.WXK_NUMPAD_ADD) and self.Editable:

   168

            self.AddRow()

   169

            key_handled = True

   170

        elif keycode in (wx.WXK_DELETE, wx.WXK_NUMPAD_DELETE) and self.Editable:

   171

            self.DeleteRow()

   172

            key_handled = True

   173

        elif keycode == wx.WXK_UP and event.ShiftDown() and self.Editable:

   174

            self.MoveRow(self.GetGridCursorRow(), -1)

   175

            key_handled = True

   176

        elif keycode == wx.WXK_DOWN and event.ShiftDown() and self.Editable:

   177

            self.MoveRow(self.GetGridCursorRow(), 1)

   178

            key_handled = True

   179

        if not key_handled:

   180

            event.Skip()