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

        rows = self.Table.GetNumberRows()

    76

        row = self.GetGridCursorRow()

    77

        if self.AddButton is not None:

    78

            self.AddButton.Enable(self.Editable)

    79

        if self.DeleteButton is not None:

    80

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

    81

        if self.UpButton is not None:

    82

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

    83

        if self.DownButton is not None:

    84

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

    85

    86

    def CloseEditControl(self):

    87

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

    88

    89

    def AddRow(self):

    90

        self.CloseEditControl()

    91

        new_row = self.GetGridCursorRow() + 1

    92

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

    93

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

    94

            new_row = self._AddRow(new_row)

    95

        else:

    96

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

    97

            self.Table.ResetView(self)

    98

        self.SetGridCursor(new_row, col)

    99

        self.MakeCellVisible(new_row, col)

   100

        self.RefreshButtons()

   101

   102

    def DeleteRow(self):

   103

        self.CloseEditControl()

   104

        row = self.GetGridCursorRow()

   105

        if row >= 0:

   106

            col = self.GetGridCursorCol()

   107

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

   108

                self._DeleteRow(row)

   109

            else:

   110

                self.Table.RemoveRow(row)

   111

                self.Table.ResetView(self)

   112

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

   113

            self.SetGridCursor(new_row, col)

   114

            self.MakeCellVisible(new_row, col)

   115

            self.RefreshButtons()

   116

   117

    def MoveRow(self, row, move):

   118

        self.CloseEditControl()

   119

        col = self.GetGridCursorCol()

   120

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

   121

            new_row = self._MoveRow(row, move)

   122

        else:

   123

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

   124

            if new_row != row:

   125

                self.Table.ResetView(self)

   126

        if new_row != row:

   127

            self.SetGridCursor(new_row, col)

   128

            self.MakeCellVisible(new_row, col)

   129

            self.RefreshButtons()

   130

   131

    def OnAddButton(self, event):

   132

        self.AddRow()

   133

        self.SetFocus()

   134

        event.Skip()

   135

   136

    def OnDeleteButton(self, event):

   137

        self.DeleteRow()

   138

        self.SetFocus()

   139

        event.Skip()

   140

   141

    def OnUpButton(self, event):

   142

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

   143

        self.SetFocus()

   144

        event.Skip()

   145

   146

    def OnDownButton(self, event):

   147

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

   148

        self.SetFocus()

   149

        event.Skip()

   150

   151

    def OnSelectCell(self, event):

   152

        wx.CallAfter(self.RefreshButtons)

   153

        event.Skip()

   154

   155

    def OnEditorHidden(self, event):

   156

        wx.CallAfter(self.SetFocus)

   157

        event.Skip()

   158

   159

    def OnKeyDown(self, event):

   160

        key_handled = False

   161

        keycode = event.GetKeyCode()

   162

        if keycode == wx.WXK_TAB:

   163

            row = self.GetGridCursorRow()

   164

            col = self.GetGridCursorCol()

   165

            if event.ShiftDown():

   166

                if row < 0 or col == 0:

   167

                    self.Navigate(wx.NavigationKeyEvent.IsBackward)

   168

                    key_handled = True

   169

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

   170

                self.Navigate(wx.NavigationKeyEvent.IsForward)

   171

                key_handled = True

   172

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

   173

            self.AddRow()

   174

            key_handled = True

   175

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

   176

            self.DeleteRow()

   177

            key_handled = True

   178

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

   179

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

   180

            key_handled = True

   181

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

   182

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

   183

            key_handled = True

   184

        if not key_handled:

   185

            event.Skip()