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)

    51

    52

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

    53

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

    54

        else:

    55

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

    56

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

    57

    58

    def SetDefaultValue(self, default_value):

    59

        self.DefaultValue = default_value

    60

    61

    def SetEditable(self, editable=True):

    62

        self.Editable = editable

    63

        self.RefreshButtons()

    64

    65

    def SetButtons(self, buttons):

    66

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

    67

            button = buttons.get(name, None)

    68

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

    69

            if button is not None:

    70

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

    71

    72

    def RefreshButtons(self):

    73

        rows = self.Table.GetNumberRows()

    74

        row = self.GetGridCursorRow()

    75

        if self.AddButton is not None:

    76

            self.AddButton.Enable(self.Editable)

    77

        if self.DeleteButton is not None:

    78

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

    79

        if self.UpButton is not None:

    80

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

    81

        if self.DownButton is not None:

    82

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

    83

    84

    def CloseEditControl(self):

    85

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

    86

    87

    def AddRow(self):

    88

        self.CloseEditControl()

    89

        new_row = self.GetGridCursorRow() + 1

    90

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

    91

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

    92

            new_row = self._AddRow(new_row)

    93

        else:

    94

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

    95

            self.Table.ResetView(self)

    96

        self.SetGridCursor(new_row, col)

    97

        self.MakeCellVisible(new_row, col)

    98

        self.RefreshButtons()

    99

   100

    def DeleteRow(self):

   101

        self.CloseEditControl()

   102

        row = self.GetGridCursorRow()

   103

        if row >= 0:

   104

            col = self.GetGridCursorCol()

   105

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

   106

                self._DeleteRow(row)

   107

            else:

   108

                self.Table.RemoveRow(row)

   109

                self.Table.ResetView(self)

   110

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

   111

            self.SetGridCursor(new_row, col)

   112

            self.MakeCellVisible(new_row, col)

   113

            self.RefreshButtons()

   114

   115

    def MoveRow(self, row, move):

   116

        self.CloseEditControl()

   117

        col = self.GetGridCursorCol()

   118

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

   119

            new_row = self._MoveRow(row, move)

   120

        else:

   121

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

   122

            if new_row != row:

   123

                self.Table.ResetView(self)

   124

        if new_row != row:

   125

            self.SetGridCursor(new_row, col)

   126

            self.MakeCellVisible(new_row, col)

   127

            self.RefreshButtons()

   128

   129

    def OnAddButton(self, event):

   130

        self.AddRow()

   131

        self.SetFocus()

   132

        event.Skip()

   133

   134

    def OnDeleteButton(self, event):

   135

        self.DeleteRow()

   136

        self.SetFocus()

   137

        event.Skip()

   138

   139

    def OnUpButton(self, event):

   140

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

   141

        self.SetFocus()

   142

        event.Skip()

   143

   144

    def OnDownButton(self, event):

   145

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

   146

        self.SetFocus()

   147

        event.Skip()

   148

   149

    def OnSelectCell(self, event):

   150

        wx.CallAfter(self.RefreshButtons)

   151

        event.Skip()

   152

   153

    def OnKeyDown(self, event):

   154

        key_handled = False

   155

        keycode = event.GetKeyCode()

   156

        if keycode == wx.WXK_TAB:

   157

            row = self.GetGridCursorRow()

   158

            col = self.GetGridCursorCol()

   159

            if event.ShiftDown():

   160

                if row < 0 or col == 0:

   161

                    self.Navigate(wx.NavigationKeyEvent.IsBackward)

   162

                    key_handled = True

   163

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

   164

                self.Navigate(wx.NavigationKeyEvent.IsForward)

   165

                key_handled = True

   166

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

   167

            self.AddRow()

   168

            key_handled = True

   169

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

   170

            self.DeleteRow()

   171

            key_handled = True

   172

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

   173

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

   174

            key_handled = True

   175

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

   176

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

   177

            key_handled = True

   178

        if not key_handled:

   179

            event.Skip()