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

from __future__ import absolute_import

    27

import wx

    28

    29

from dialogs.BrowseLocationsDialog import BrowseLocationsDialog

    30

    31

    32

class LocationCellControl(wx.PyControl):

    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.PyControl.__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.AddWindow(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.AddWindow(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 __del__(self):

    66

        self.Controller = None

    67

    68

    def SetController(self, controller):

    69

        self.Controller = controller

    70

    71

    def SetVarType(self, vartype):

    72

        self.VarType = vartype

    73

    74

    def GetVarType(self):

    75

        return self.VarType

    76

    77

    def SetValue(self, value):

    78

        self.Default = value

    79

        self.VariableName = None

    80

        self.VarType = None

    81

        self.Location.SetValue(value)

    82

    83

    def GetValue(self):

    84

        return self.Location.GetValue()

    85

    86

    def GetName(self):

    87

        return self.VariableName

    88

    89

    def OnSize(self, event):

    90

        self.Layout()

    91

    92

    def OnBrowseButtonClick(self, event):

    93

        # pop up the location browser dialog

    94

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

    95

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

    96

            infos = dialog.GetValues()

    97

        else:

    98

            infos = None

    99

        dialog.Destroy()

   100

   101

        if infos is not None:

   102

            location = infos["location"]

   103

            # set the location

   104

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

   105

                dialog = wx.SingleChoiceDialog(

   106

                    self,

   107

                    _("Select a variable class:"),

   108

                    _("Variable class"),

   109

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

   110

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

   111

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

   112

                    selected = dialog.GetSelection()

   113

                else:

   114

                    selected = None

   115

                dialog.Destroy()

   116

                if selected is None:

   117

                    self.Location.SetFocus()

   118

                    return

   119

                if selected == 0:

   120

                    location = "%I" + location

   121

                elif selected == 1:

   122

                    location = "%Q" + location

   123

                else:

   124

                    location = "%M" + location

   125

   126

            self.Location.SetValue(location)

   127

            self.VariableName = infos["var_name"]

   128

            self.VarType = infos["IEC_type"]

   129

   130

            # when user selected something, end editing immediately

   131

            # so that changes over multiple colums appear

   132

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

   133

   134

        self.Location.SetFocus()

   135

   136

    def OnLocationChar(self, event):

   137

        keycode = event.GetKeyCode()

   138

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

   139

            self.Parent.Parent.ProcessEvent(event)

   140

        elif keycode == wx.WXK_ESCAPE:

   141

            self.Location.SetValue(self.Default)

   142

            self.Parent.Parent.CloseEditControl()

   143

        else:

   144

            event.Skip()

   145

   146

    def SetInsertionPoint(self, i):

   147

        self.Location.SetInsertionPoint(i)

   148

   149

    def SetFocus(self):

   150

        self.Location.SetFocus()

   151

   152

   153

class LocationCellEditor(wx.grid.PyGridCellEditor):

   154

    '''

   155

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

   156

    '''

   157

    def __init__(self, table, controller):

   158

        wx.grid.PyGridCellEditor.__init__(self)

   159

   160

        self.Table = table

   161

        self.Controller = controller

   162

   163

    def __del__(self):

   164

        self.CellControl = None

   165

        self.Controller = None

   166

   167

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

   168

        self.CellControl = LocationCellControl(parent)

   169

        self.SetControl(self.CellControl)

   170

        if evt_handler:

   171

            self.CellControl.PushEventHandler(evt_handler)

   172

   173

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

   174

        self.CellControl.Enable()

   175

        self.CellControl.SetController(self.Controller)

   176

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

   177

        if isinstance(self.CellControl, LocationCellControl):

   178

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

   179

        self.CellControl.SetFocus()

   180

   181

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

   182

        loc = self.CellControl.GetValue()

   183

        changed = loc != old_loc

   184

        if changed:

   185

            name = self.CellControl.GetName()

   186

            if name is not None:

   187

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

   188

                if message is not None:

   189

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

   190

                    return None

   191

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

   192

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

   193

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

   194

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

   195

            var_type = self.CellControl.GetVarType()

   196

            if var_type is not None:

   197

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

   198

        else:

   199

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

   200

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

   201

        self.CellControl.Disable()

   202

        return changed

   203

   204

    if wx.VERSION >= (3, 0, 0):

   205

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

   206

            return self.EndEditInternal(row, col, grid, oldval)

   207

    else:

   208

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

   209

            old_loc = self.Table.GetValueByName(row, 'Location')

   210

            return self.EndEditInternal(row, col, grid, old_loc)

   211

   212

    def SetSize(self, rect):

   213

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

   214

                                       rect.width, rect.height,

   215

                                       wx.SIZE_ALLOW_MINUS_ONE)

   216

   217

    def Clone(self):

   218

        return LocationCellEditor(self.Table, self.Controller)