# -*- coding: utf-8 -*-
#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
#based on the plcopen standard.
#
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
#
#See COPYING file for copyrights details.
#
#This library is free software; you can redistribute it and/or
#modify it under the terms of the GNU General Public
#License as published by the Free Software Foundation; either
#version 2.1 of the License, or (at your option) any later version.
#
#This library is distributed in the hope that it will be useful,
#but WITHOUT ANY WARRANTY; without even the implied warranty of
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
#General Public License for more details.
#
#You should have received a copy of the GNU General Public
#License along with this library; if not, write to the Free Software
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
import wx
import wx.grid
#-------------------------------------------------------------------------------
# Action Block Dialog
#-------------------------------------------------------------------------------
def GetActionTableColnames():
_ = lambda x: x
return [_("Qualifier"), _("Duration"), _("Type"), _("Value"), _("Indicator")]
def GetTypeList():
_ = lambda x: x
return [_("Action"), _("Variable"), _("Inline")]
class ActionTable(wx.grid.PyGridTableBase):
"""
A custom wx.Grid Table using user supplied data
"""
def __init__(self, parent, data, colnames):
# The base class must be initialized *first*
wx.grid.PyGridTableBase.__init__(self)
self.data = data
self.colnames = colnames
self.Parent = parent
# XXX
# we need to store the row length and collength to
# see if the table has changed size
self._rows = self.GetNumberRows()
self._cols = self.GetNumberCols()
def GetNumberCols(self):
return len(self.colnames)
def GetNumberRows(self):
return len(self.data)
def GetColLabelValue(self, col, translate=True):
if col < len(self.colnames):
colname = self.colnames[col]
if translate:
return _(colname)
return colname
def GetRowLabelValues(self, row, translate=True):
return row
def GetValue(self, row, col):
if row < self.GetNumberRows():
colname = self.GetColLabelValue(col, False)
name = str(self.data[row].get(colname, ""))
if colname == "Type":
return _(name)
return name
def GetValueByName(self, row, colname):
return self.data[row].get(colname)
def SetValue(self, row, col, value):
if col < len(self.colnames):
colname = self.GetColLabelValue(col, False)
if colname == "Type":
value = self.Parent.TranslateType[value]
self.data[row][colname] = value
def ResetView(self, grid):
"""
(wx.Grid) -> Reset the grid view. Call this to
update the grid if rows and columns have been added or deleted
"""
grid.BeginBatch()
for current, new, delmsg, addmsg in [
(self._rows, self.GetNumberRows(), wx.grid.GRIDTABLE_NOTIFY_ROWS_DELETED, wx.grid.GRIDTABLE_NOTIFY_ROWS_APPENDED),
(self._cols, self.GetNumberCols(), wx.grid.GRIDTABLE_NOTIFY_COLS_DELETED, wx.grid.GRIDTABLE_NOTIFY_COLS_APPENDED),
]:
if new < current:
msg = wx.grid.GridTableMessage(self,delmsg,new,current-new)
grid.ProcessTableMessage(msg)
elif new > current:
msg = wx.grid.GridTableMessage(self,addmsg,new-current)
grid.ProcessTableMessage(msg)
self.UpdateValues(grid)
grid.EndBatch()
self._rows = self.GetNumberRows()
self._cols = self.GetNumberCols()
# update the column rendering scheme
self._updateColAttrs(grid)
# update the scrollbars and the displayed part of the grid
grid.AdjustScrollbars()
grid.ForceRefresh()
def UpdateValues(self, grid):
"""Update all displayed values"""
# This sends an event to the grid table to update all of the values
msg = wx.grid.GridTableMessage(self, wx.grid.GRIDTABLE_REQUEST_VIEW_GET_VALUES)
grid.ProcessTableMessage(msg)
def _updateColAttrs(self, grid):
"""
wx.Grid -> update the column attributes to add the
appropriate renderer given the column name.
Otherwise default to the default renderer.
"""
for row in range(self.GetNumberRows()):
for col in range(self.GetNumberCols()):
editor = None
renderer = None
readonly = False
colname = self.GetColLabelValue(col, False)
if colname == "Qualifier":
editor = wx.grid.GridCellChoiceEditor()
editor.SetParameters(self.Parent.QualifierList)
if colname == "Duration":
editor = wx.grid.GridCellTextEditor()
renderer = wx.grid.GridCellStringRenderer()
if self.Parent.DurationList[self.data[row]["Qualifier"]]:
readonly = False
else:
readonly = True
self.data[row]["Duration"] = ""
elif colname == "Type":
editor = wx.grid.GridCellChoiceEditor()
editor.SetParameters(self.Parent.TypeList)
elif colname == "Value":
type = self.data[row]["Type"]
if type == "Action":
editor = wx.grid.GridCellChoiceEditor()
editor.SetParameters(self.Parent.ActionList)
elif type == "Variable":
editor = wx.grid.GridCellChoiceEditor()
editor.SetParameters(self.Parent.VariableList)
elif type == "Inline":
editor = wx.grid.GridCellTextEditor()
renderer = wx.grid.GridCellStringRenderer()
elif colname == "Indicator":
editor = wx.grid.GridCellChoiceEditor()
editor.SetParameters(self.Parent.VariableList)
grid.SetCellEditor(row, col, editor)
grid.SetCellRenderer(row, col, renderer)
grid.SetReadOnly(row, col, readonly)
grid.SetCellBackgroundColour(row, col, wx.WHITE)
def SetData(self, data):
self.data = data
def GetData(self):
return self.data
def GetCurrentIndex(self):
return self.CurrentIndex
def SetCurrentIndex(self, index):
self.CurrentIndex = index
def AppendRow(self, row_content):
self.data.append(row_content)
def RemoveRow(self, row_index):
self.data.pop(row_index)
def MoveRow(self, row_index, move, grid):
new_index = max(0, min(row_index + move, len(self.data) - 1))
if new_index != row_index:
self.data.insert(new_index, self.data.pop(row_index))
grid.SetGridCursor(new_index, grid.GetGridCursorCol())
def Empty(self):
self.data = []
self.editors = []
[ID_ACTIONBLOCKDIALOG, ID_ACTIONBLOCKDIALOGVARIABLESGRID,
ID_ACTIONBLOCKDIALOGSTATICTEXT1, ID_ACTIONBLOCKDIALOGADDBUTTON,
ID_ACTIONBLOCKDIALOGDELETEBUTTON, ID_ACTIONBLOCKDIALOGUPBUTTON,
ID_ACTIONBLOCKDIALOGDOWNBUTTON,
] = [wx.NewId() for _init_ctrls in range(7)]
class ActionBlockDialog(wx.Dialog):
if wx.VERSION < (2, 6, 0):
def Bind(self, event, function, id = None):
if id is not None:
event(self, id, function)
else:
event(self, function)
def _init_coll_flexGridSizer1_Items(self, parent):
parent.AddSizer(self.TopSizer, 0, border=20, flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)
parent.AddSizer(self.GridButtonSizer, 0, border=20, flag=wx.ALIGN_RIGHT|wx.LEFT|wx.RIGHT)
parent.AddSizer(self.ButtonSizer, 0, border=20, flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)
def _init_coll_flexGridSizer1_Growables(self, parent):
parent.AddGrowableCol(0)
parent.AddGrowableRow(0)
def _init_coll_TopSizer_Items(self, parent):
parent.AddWindow(self.staticText1, 0, border=0, flag=wx.GROW)
parent.AddWindow(self.ActionsGrid, 0, border=0, flag=wx.GROW)
def _init_coll_TopSizer_Growables(self, parent):
parent.AddGrowableCol(0)
parent.AddGrowableRow(1)
def _init_coll_GridButtonSizer_Items(self, parent):
parent.AddWindow(self.AddButton, 0, border=10, flag=wx.GROW|wx.LEFT)
parent.AddWindow(self.DeleteButton, 0, border=10, flag=wx.GROW|wx.LEFT)
parent.AddWindow(self.UpButton, 0, border=10, flag=wx.GROW|wx.LEFT)
parent.AddWindow(self.DownButton, 0, border=10, flag=wx.GROW|wx.LEFT)
def _init_sizers(self):
self.flexGridSizer1 = wx.FlexGridSizer(cols=1, hgap=0, rows=3, vgap=10)
self.TopSizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=5)
self.GridButtonSizer = wx.BoxSizer(wx.HORIZONTAL)
self._init_coll_flexGridSizer1_Items(self.flexGridSizer1)
self._init_coll_flexGridSizer1_Growables(self.flexGridSizer1)
self._init_coll_TopSizer_Items(self.TopSizer)
self._init_coll_TopSizer_Growables(self.TopSizer)
self._init_coll_GridButtonSizer_Items(self.GridButtonSizer)
self.SetSizer(self.flexGridSizer1)
def _init_ctrls(self, prnt):
wx.Dialog.__init__(self, id=ID_ACTIONBLOCKDIALOG,
name='ActionBlockDialog', parent=prnt, pos=wx.Point(376, 223),
size=wx.Size(500, 300), style=wx.DEFAULT_DIALOG_STYLE|wx.RESIZE_BORDER,
title=_('Edit action block properties'))
self.SetClientSize(wx.Size(500, 300))
self.staticText1 = wx.StaticText(id=ID_ACTIONBLOCKDIALOGSTATICTEXT1,
label=_('Actions:'), name='staticText1', parent=self,
pos=wx.Point(0, 0), size=wx.Size(0, 17), style=0)
self.ActionsGrid = wx.grid.Grid(id=ID_ACTIONBLOCKDIALOGVARIABLESGRID,
name='ActionsGrid', parent=self, pos=wx.Point(0, 0),
size=wx.Size(0, 0), style=wx.VSCROLL)
self.ActionsGrid.SetFont(wx.Font(12, 77, wx.NORMAL, wx.NORMAL, False,
'Sans'))
self.ActionsGrid.SetLabelFont(wx.Font(10, 77, wx.NORMAL, wx.NORMAL,
False, 'Sans'))
self.ActionsGrid.DisableDragGridSize()
self.ActionsGrid.EnableScrolling(False, True)
self.ActionsGrid.Bind(wx.grid.EVT_GRID_CELL_CHANGE, self.OnActionsGridCellChange)
self.AddButton = wx.Button(id=ID_ACTIONBLOCKDIALOGADDBUTTON, label=_('Add'),
name='AddButton', parent=self, pos=wx.Point(0, 0),
size=wx.DefaultSize, style=0)
self.Bind(wx.EVT_BUTTON, self.OnAddButton, id=ID_ACTIONBLOCKDIALOGADDBUTTON)
self.DeleteButton = wx.Button(id=ID_ACTIONBLOCKDIALOGDELETEBUTTON, label=_('Delete'),
name='DeleteButton', parent=self, pos=wx.Point(0, 0),
size=wx.DefaultSize, style=0)
self.Bind(wx.EVT_BUTTON, self.OnDeleteButton, id=ID_ACTIONBLOCKDIALOGDELETEBUTTON)
self.UpButton = wx.Button(id=ID_ACTIONBLOCKDIALOGUPBUTTON, label='^',
name='UpButton', parent=self, pos=wx.Point(0, 0),
size=wx.Size(32, 32), style=0)
self.Bind(wx.EVT_BUTTON, self.OnUpButton, id=ID_ACTIONBLOCKDIALOGUPBUTTON)
self.DownButton = wx.Button(id=ID_ACTIONBLOCKDIALOGDOWNBUTTON, label='v',
name='DownButton', parent=self, pos=wx.Point(0, 0),
size=wx.Size(32, 32), style=0)
self.Bind(wx.EVT_BUTTON, self.OnDownButton, id=ID_ACTIONBLOCKDIALOGDOWNBUTTON)
self.ButtonSizer = self.CreateButtonSizer(wx.OK|wx.CANCEL|wx.CENTRE)
if wx.VERSION >= (2, 5, 0):
self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetAffirmativeButton().GetId())
else:
self.Bind(wx.EVT_BUTTON, self.OnOK, id=self.ButtonSizer.GetChildren()[0].GetSizer().GetChildren()[0].GetWindow().GetId())
self._init_sizers()
def __init__(self, parent):
self._init_ctrls(parent)
self.DefaultValue = {"Qualifier" : "N", "Duration" : "", "Type" : "Action", "Value" : "", "Indicator" : ""}
self.Table = ActionTable(self, [], GetActionTableColnames())
typelist = GetTypeList()
self.TypeList = ",".join(map(_,typelist))
self.TranslateType = dict([(_(value), value) for value in typelist])
self.ColSizes = [60, 90, 80, 110, 80]
self.ColAlignements = [wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT, wx.ALIGN_LEFT]
self.ActionsGrid.SetTable(self.Table)
self.ActionsGrid.SetRowLabelSize(0)
for col in range(self.Table.GetNumberCols()):
attr = wx.grid.GridCellAttr()
attr.SetAlignment(self.ColAlignements[col], wx.ALIGN_CENTRE)
self.ActionsGrid.SetColAttr(col, attr)
self.ActionsGrid.SetColMinimalWidth(col, self.ColSizes[col])
self.ActionsGrid.AutoSizeColumn(col, False)
self.Table.ResetView(self.ActionsGrid)
def OnOK(self, event):
self.ActionsGrid.SetGridCursor(0, 0)
self.EndModal(wx.ID_OK)
def OnAddButton(self, event):
self.Table.AppendRow(self.DefaultValue.copy())
self.Table.ResetView(self.ActionsGrid)
event.Skip()
def OnDeleteButton(self, event):
row = self.ActionsGrid.GetGridCursorRow()
self.Table.RemoveRow(row)
self.Table.ResetView(self.ActionsGrid)
event.Skip()
def OnUpButton(self, event):
row = self.ActionsGrid.GetGridCursorRow()
self.Table.MoveRow(row, -1, self.ActionsGrid)
self.Table.ResetView(self.ActionsGrid)
event.Skip()
def OnDownButton(self, event):
row = self.ActionsGrid.GetGridCursorRow()
self.Table.MoveRow(row, 1, self.ActionsGrid)
self.Table.ResetView(self.ActionsGrid)
event.Skip()
def OnActionsGridCellChange(self, event):
self.Table.ResetView(self.ActionsGrid)
event.Skip()
def SetQualifierList(self, list):
self.QualifierList = "," + ",".join(list)
self.DurationList = list
def SetVariableList(self, list):
self.VariableList = "," + ",".join([variable["Name"] for variable in list])
def SetActionList(self, list):
self.ActionList = "," + ",".join(list)
def SetValues(self, actions):
for action in actions:
row = {"Qualifier" : action["qualifier"], "Value" : action["value"]}
if action["type"] == "reference":
if action["value"] in self.ActionList:
row["Type"] = "Action"
elif action["value"] in self.VariableList:
row["Type"] = "Variable"
else:
row["Type"] = "Inline"
else:
row["Type"] = "Inline"
if "duration" in action:
row["Duration"] = action["duration"]
else:
row["Duration"] = ""
if "indicator" in action:
row["Indicator"] = action["indicator"]
else:
row["Indicator"] = ""
self.Table.AppendRow(row)
self.Table.ResetView(self.ActionsGrid)
def GetValues(self):
values = []
for data in self.Table.GetData():
action = {"qualifier" : data["Qualifier"], "value" : data["Value"]}
if data["Type"] in ["Action", "Variable"]:
action["type"] = "reference"
else:
action["type"] = "inline"
if data["Duration"] != "":
action["duration"] = data["Duration"]
if data["Indicator"] != "":
action["indicator"] = data["Indicator"]
values.append(action)
return values