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

        self.DisableDragRowSize()

    52

    53

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

    54

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

    55

            self.Bind(wx.grid.EVT_GRID_EDITOR_HIDDEN, self.OnEditorHidden)

    56

        else:

    57

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

    58

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

    59

    60

    def SetDefaultValue(self, default_value):

    61

        self.DefaultValue = default_value

    62

    63

    def SetEditable(self, editable=True):

    64

        self.Editable = editable

    65

        self.RefreshButtons()

    66

    67

    def SetButtons(self, buttons):

    68

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

    69

            button = buttons.get(name, None)

    70

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

    71

            if button is not None:

    72

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

    73

    74

    def RefreshButtons(self):

    75

        if self:

    76

            rows = self.Table.GetNumberRows()

    77

            row = self.GetGridCursorRow()

    78

            if self.AddButton is not None:

    79

                self.AddButton.Enable(self.Editable)

    80

            if self.DeleteButton is not None:

    81

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

    82

            if self.UpButton is not None:

    83

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

    84

            if self.DownButton is not None:

    85

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

    86

    87

    def CloseEditControl(self):

    88

        row, col = self.GetGridCursorRow(), self.GetGridCursorCol()

    89

        if row != -1 and col != -1:

    90

            self.SetGridCursor(row, col)

    91

    92

    def AddRow(self):

    93

        self.CloseEditControl()

    94

        new_row = self.GetGridCursorRow() + 1

    95

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

    96

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

    97

            new_row = self._AddRow(new_row)

    98

        else:

    99

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

   100

            self.Table.ResetView(self)

   101

        self.SetGridCursor(new_row, col)

   102

        self.MakeCellVisible(new_row, col)

   103

        self.RefreshButtons()

   104

   105

    def DeleteRow(self):

   106

        self.CloseEditControl()

   107

        row = self.GetGridCursorRow()

   108

        if row >= 0:

   109

            col = self.GetGridCursorCol()

   110

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

   111

                self._DeleteRow(row)

   112

            else:

   113

                self.Table.RemoveRow(row)

   114

                self.Table.ResetView(self)

   115

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

   116

            self.SetGridCursor(new_row, col)

   117

            self.MakeCellVisible(new_row, col)

   118

            self.RefreshButtons()

   119

   120

    def MoveRow(self, row, move):

   121

        self.CloseEditControl()

   122

        col = self.GetGridCursorCol()

   123

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

   124

            new_row = self._MoveRow(row, move)

   125

        else:

   126

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

   127

            if new_row != row:

   128

                self.Table.ResetView(self)

   129

        if new_row != row:

   130

            self.SetGridCursor(new_row, col)

   131

            self.MakeCellVisible(new_row, col)

   132

            self.RefreshButtons()

   133

   134

    def OnAddButton(self, event):

   135

        self.AddRow()

   136

        self.SetFocus()

   137

        event.Skip()

   138

   139

    def OnDeleteButton(self, event):

   140

        self.DeleteRow()

   141

        self.SetFocus()

   142

        event.Skip()

   143

   144

    def OnUpButton(self, event):

   145

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

   146

        self.SetFocus()

   147

        event.Skip()

   148

   149

    def OnDownButton(self, event):

   150

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

   151

        self.SetFocus()

   152

        event.Skip()

   153

   154

    def OnSelectCell(self, event):

   155

        wx.CallAfter(self.RefreshButtons)

   156

        event.Skip()

   157

   158

    def OnEditorHidden(self, event):

   159

        wx.CallAfter(self.SetFocus)

   160

        event.Skip()

   161

   162

    def OnKeyDown(self, event):

   163

        key_handled = False

   164

        keycode = event.GetKeyCode()

   165

        if keycode == wx.WXK_TAB:

   166

            row = self.GetGridCursorRow()

   167

            col = self.GetGridCursorCol()

   168

            if event.ShiftDown():

   169

                if row < 0 or col == 0:

   170

                    self.Navigate(wx.NavigationKeyEvent.IsBackward)

   171

                    key_handled = True

   172

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

   173

                self.Navigate(wx.NavigationKeyEvent.IsForward)

   174

                key_handled = True

   175

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

   176

            self.AddRow()

   177

            key_handled = True

   178

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

   179

            self.DeleteRow()

   180

            key_handled = True

   181

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

   182

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

   183

            key_handled = True

   184

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

   185

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

   186

            key_handled = True

   187

        if not key_handled:

   188

            event.Skip()