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

    27

import wx

    28

    29

from dialogs.BrowseLocationsDialog import BrowseLocationsDialog

    30

    31

    32

class LocationCellControl(wx.Control):

    33

    34

    '''

    35

    Custom cell editor control with a text box and a button that launches

    36

    the BrowseLocationsDialog.

    37

    '''

    38

    def __init__(self, parent):

    39

        wx.Control.__init__(self, parent)

    40

    41

        main_sizer = wx.FlexGridSizer(cols=2, hgap=0, rows=1, vgap=0)

    42

        main_sizer.AddGrowableCol(0)

    43

        main_sizer.AddGrowableRow(0)

    44

    45

        # create location text control

    46

        self.Location = wx.TextCtrl(self, size=wx.Size(0, -1),

    47

                                    style=wx.TE_PROCESS_ENTER)

    48

        self.Location.Bind(wx.EVT_KEY_DOWN, self.OnLocationChar)

    49

        main_sizer.Add(self.Location, flag=wx.GROW)

    50

    51

        # create browse button

    52

        self.BrowseButton = wx.Button(self, label='...', size=wx.Size(30, -1))

    53

        self.BrowseButton.Bind(wx.EVT_BUTTON, self.OnBrowseButtonClick)

    54

        main_sizer.Add(self.BrowseButton, flag=wx.GROW)

    55

    56

        self.Bind(wx.EVT_SIZE, self.OnSize)

    57

    58

        self.SetSizer(main_sizer)

    59

    60

        self.Controller = None

    61

        self.VarType = None

    62

        self.Default = False

    63

        self.VariableName = None

    64

    65

    def SetController(self, controller):

    66

        self.Controller = controller

    67

    68

    def SetVarType(self, vartype):

    69

        self.VarType = vartype

    70

    71

    def GetVarType(self):

    72

        return self.VarType

    73

    74

    def SetValue(self, value):

    75

        self.Default = value

    76

        self.VariableName = None

    77

        self.VarType = None

    78

        self.Location.SetValue(value)

    79

    80

    def GetValue(self):

    81

        return self.Location.GetValue()

    82

    83

    def GetName(self):

    84

        return self.VariableName

    85

    86

    def OnSize(self, event):

    87

        self.Layout()

    88

    89

    def OnBrowseButtonClick(self, event):

    90

        # pop up the location browser dialog

    91

        dialog = BrowseLocationsDialog(self, self.VarType, self.Controller)

    92

        if dialog.ShowModal() == wx.ID_OK:

    93

            infos = dialog.GetValues()

    94

        else:

    95

            infos = None

    96

        dialog.Destroy()

    97

    98

        if infos is not None:

    99

            location = infos["location"]

   100

            # set the location

   101

            if not infos["location"].startswith("%"):

   102

                dialog = wx.SingleChoiceDialog(

   103

                    self,

   104

                    _("Select a variable class:"),

   105

                    _("Variable class"),

   106

                    [_("Input"), _("Output"), _("Memory")],

   107

                    wx.DEFAULT_DIALOG_STYLE | wx.OK | wx.CANCEL)

   108

                if dialog.ShowModal() == wx.ID_OK:

   109

                    selected = dialog.GetSelection()

   110

                else:

   111

                    selected = None

   112

                dialog.Destroy()

   113

                if selected is None:

   114

                    self.Location.SetFocus()

   115

                    return

   116

                if selected == 0:

   117

                    location = "%I" + location

   118

                elif selected == 1:

   119

                    location = "%Q" + location

   120

                else:

   121

                    location = "%M" + location

   122

   123

            self.Location.SetValue(location)

   124

            self.VariableName = infos["var_name"]

   125

            self.VarType = infos["IEC_type"]

   126

   127

            # when user selected something, end editing immediately

   128

            # so that changes over multiple colums appear

   129

            wx.CallAfter(self.Parent.Parent.CloseEditControl)

   130

   131

        self.Location.SetFocus()

   132

   133

    def OnLocationChar(self, event):

   134

        keycode = event.GetKeyCode()

   135

        if keycode in [wx.WXK_RETURN, wx.WXK_TAB]:

   136

            self.Parent.Parent.ProcessEvent(event)

   137

        elif keycode == wx.WXK_ESCAPE:

   138

            self.Location.SetValue(self.Default)

   139

            self.Parent.Parent.CloseEditControl()

   140

        else:

   141

            event.Skip()

   142

   143

    def SetInsertionPoint(self, i):

   144

        self.Location.SetInsertionPoint(i)

   145

   146

    def SetFocus(self):

   147

        self.Location.SetFocus()

   148

   149

   150

class LocationCellEditor(wx.grid.GridCellEditor):

   151

    '''

   152

    Grid cell editor that uses LocationCellControl to display a browse button.

   153

    '''

   154

    def __init__(self, table, controller):

   155

        wx.grid.GridCellEditor.__init__(self)

   156

   157

        self.Table = table

   158

        self.Controller = controller

   159

   160

    def Create(self, parent, id, evt_handler):

   161

        self.CellControl = LocationCellControl(parent)

   162

        self.SetControl(self.CellControl)

   163

        if evt_handler:

   164

            self.CellControl.PushEventHandler(evt_handler)

   165

   166

    def BeginEdit(self, row, col, grid):

   167

        self.CellControl.Enable()

   168

        self.CellControl.SetController(self.Controller)

   169

        self.CellControl.SetValue(self.Table.GetValueByName(row, 'Location'))

   170

        if isinstance(self.CellControl, LocationCellControl):

   171

            self.CellControl.SetVarType(self.Table.GetValueByName(row, 'Type'))

   172

        self.CellControl.SetFocus()

   173

   174

    def EndEdit(self, row, col, grid, old_loc):

   175

        loc = self.CellControl.GetValue()

   176

        changed = loc != old_loc

   177

        if changed:

   178

            name = self.CellControl.GetName()

   179

            if name is not None:

   180

                message = self.Table.Parent.CheckVariableName(name, row)

   181

                if message is not None:

   182

                    wx.CallAfter(self.Table.Parent.ShowErrorMessage, message)

   183

                    return None

   184

                old_name = self.Table.GetValueByName(row, 'Name')

   185

                self.Table.SetValueByName(row, 'Name', name)

   186

                self.Table.Parent.OnVariableNameChange(old_name, name)

   187

            self.Table.SetValueByName(row, 'Location', loc)

   188

            var_type = self.CellControl.GetVarType()

   189

            if var_type is not None:

   190

                self.Table.SetValueByName(row, 'Type', var_type)

   191

        else:

   192

            wx.CallAfter(self.Table.Parent.ShowErrorMessage,

   193

                         _("Selected location is identical to previous one"))

   194

        self.CellControl.Disable()

   195

        return changed

   196

   197

    def ApplyEdit(self, row, col, grid):

   198

        pass

   199

   200

    def SetSize(self, rect):

   201

        self.CellControl.SetSize(rect.x + 1, rect.y,

   202

                                 rect.width, rect.height,

   203

                                 wx.SIZE_ALLOW_MINUS_ONE)

   204

   205

    def Clone(self):

   206

        return LocationCellEditor(self.Table, self.Controller)