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

    27

from graphics.GraphicCommons import CONNECTOR, CONTINUATION

    28

from graphics.FBD_Objects import FBD_Connector

    29

from BlockPreviewDialog import BlockPreviewDialog

    30

    31

#-------------------------------------------------------------------------------

    32

#                       Set Connection Parameters Dialog

    33

#-------------------------------------------------------------------------------

    34

    40

class ConnectionDialog(BlockPreviewDialog):

    41

    42

    def __init__(self, parent, controller, tagname, apply_button=False):

    43

        """

    44

        Constructor

    45

        @param parent: Parent wx.Window of dialog for modal

    46

        @param controller: Reference to project controller

    47

        @param tagname: Tagname of project POU edited

    48

        @param apply_button: Enable button for applying connector modification

    49

        to all connector having the same name in POU (default: False)

    50

        """

    51

        BlockPreviewDialog.__init__(self, parent, controller, tagname, 

    52

              size=wx.Size(350, 220), title=_('Connection Properties'))

    53

    54

        # Create dialog main sizer

    55

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

    56

        main_sizer.AddGrowableCol(0)

    57

        main_sizer.AddGrowableRow(0)

    58

    59

        # Create a sizer for dividing FBD connection parameters in two columns

    60

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    61

        main_sizer.AddSizer(column_sizer, border=20, 

    62

              flag=wx.GROW|wx.TOP|wx.LEFT|wx.RIGHT)

    63

    64

        # Create a sizer for left column

    65

        left_gridsizer = wx.FlexGridSizer(cols=1, hgap=0, rows=5, vgap=5)

    66

        left_gridsizer.AddGrowableCol(0)

    67

        column_sizer.AddSizer(left_gridsizer, 1, border=5, 

    68

              flag=wx.GROW|wx.RIGHT)

    69

    70

        # Create label for connection type

    71

        type_label = wx.StaticText(self, label=_('Type:'))

    72

        left_gridsizer.AddWindow(type_label, flag=wx.GROW)

    73

    74

        # Create radio buttons for selecting connection type

    75

        self.TypeRadioButtons = {}

    76

        first = True

    77

        for type, label in [(CONNECTOR, _('Connector')),

    78

                            (CONTINUATION, _('Continuation'))]:

    79

            radio_button = wx.RadioButton(self, label=label, 

    80

                  style=(wx.RB_GROUP if first else 0))

    81

            radio_button.SetValue(first)

    82

            self.Bind(wx.EVT_RADIOBUTTON, self.OnTypeChanged, radio_button)

    83

            left_gridsizer.AddWindow(radio_button, flag=wx.GROW)

    84

            self.TypeRadioButtons[type] = radio_button

    85

            first = False

    86

    87

        # Create label for connection name

    88

        name_label = wx.StaticText(self, label=_('Name:'))

    89

        left_gridsizer.AddWindow(name_label, flag=wx.GROW)

    90

    91

        # Create text control for defining connection name

    92

        self.ConnectionName = wx.TextCtrl(self)

    93

        self.Bind(wx.EVT_TEXT, self.OnNameChanged, self.ConnectionName)

    94

        left_gridsizer.AddWindow(self.ConnectionName, flag=wx.GROW)

    95

    96

        # Create a sizer for right column

    97

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

    98

        right_gridsizer.AddGrowableCol(0)

    99

        right_gridsizer.AddGrowableRow(1)

   100

        column_sizer.AddSizer(right_gridsizer, 1, border=5, 

   101

              flag=wx.GROW|wx.LEFT)

   102

   103

        # Add preview panel and associated label to sizers

   104

        right_gridsizer.AddWindow(self.PreviewLabel, flag=wx.GROW)

   105

        right_gridsizer.AddWindow(self.Preview, flag=wx.GROW)

   106

   107

        # Add buttons sizer to sizers

   108

        main_sizer.AddSizer(self.ButtonSizer, border=20, 

   109

              flag=wx.ALIGN_RIGHT|wx.BOTTOM|wx.LEFT|wx.RIGHT)

   110

   111

        # Add button for applying connection name modification to all connection

   112

        # of POU

   113

        if apply_button:

   114

            self.ApplyToAllButton = wx.Button(self, label=_("Propagate Name"))

   115

            self.ApplyToAllButton.SetToolTipString(

   116

                _("Apply name modification to all continuations with the same name"))

   117

            self.Bind(wx.EVT_BUTTON, self.OnApplyToAll, self.ApplyToAllButton)

   118

            self.ButtonSizer.AddWindow(self.ApplyToAllButton, 

   119

                    border=(3 if wx.Platform == '__WXMSW__' else 10),

   120

                    flag=wx.LEFT)

   121

        else:

   122

            self.ConnectionName.ChangeValue(

   123

                controller.GenerateNewName(

   124

                        tagname, None, "Connection%d", 0))

   125

   126

        self.SetSizer(main_sizer)

   127

   128

        # Connector radio button is default control having keyboard focus

   129

        self.TypeRadioButtons[CONNECTOR].SetFocus()

   130

   140

    def SetValues(self, values):

   141

        """

   142

        Set default connection parameters

   143

        @param values: Connection parameters values

   144

        """

   145

        # For each parameters defined, set corresponding control value

   146

        for name, value in values.items():

   147

   148

            # Parameter is connection type

   149

            if name == "type":

   150

                self.TypeRadioButtons[value].SetValue(True)

   151

   152

            # Parameter is connection name

   153

            elif name == "name":

   154

                self.ConnectionName.SetValue(value)

   155

   156

        # Refresh preview panel

   157

        self.RefreshPreview()

   158

   159

    def GetValues(self):

   160

        """

   161

        Return connection parameters defined in dialog

   162

        @return: {parameter_name: parameter_value,...}

   163

        """

   164

        values = {

   166

            "name": self.ConnectionName.GetValue()}

   167

        values["width"], values["height"] = self.Element.GetSize()

   168

        return values

   169

   170

    def TestConnectionName(self):

   171

        """

   172

        Test that connection name is valid

   173

        @return: True if connection name is valid

   174

        """

   175

        message = None

   176

   177

        # Get connection name typed by user

   178

        connection_name = self.ConnectionName.GetValue()

   179

   180

        # Test that a name have been defined

   181

        if connection_name == "":

   182

            message = _("Form isn't complete. Name must be filled!")

   183

   184

        # If an error have been identify, show error message dialog

   185

        if message is not None:

   186

            self.ShowErrorMessage(message)

   187

            # Test failed

   188

            return False

   189

   190

        # Return result of element name test

   191

        return self.TestElementName(connection_name)

   192

   193

    def OnOK(self, event):

   194

        """

   195

        Called when dialog OK button is pressed

   196

        Test if connection name is valid

   197

        @param event: wx.Event from OK button

   198

        """

   199

        # Close dialog if connection name is valid

   200

        if self.TestConnectionName():

   201

            self.EndModal(wx.ID_OK)

   202

   203

    def OnApplyToAll(self, event):

   204

        """

   205

        Called when Apply To All button is pressed

   206

        Test if connection name is valid

   207

        @param event: wx.Event from OK button

   208

        """

   209

        # Close dialog if connection name is valid

   210

        if self.TestConnectionName():

   211

            self.EndModal(wx.ID_YESTOALL)

   212

   213

    def OnTypeChanged(self, event):

   214

        """

   215

        Called when connection type changed

   216

        @param event: wx.RadioButtonEvent

   217

        """

   218

        self.RefreshPreview()

   219

        event.Skip()

   220

   221

    def OnNameChanged(self, event):

   222

        """

   223

        Called when connection name value changed

   224

        @param event: wx.TextEvent

   225

        """

   226

        self.RefreshPreview()

   227

        event.Skip()

   228

   229

    def RefreshPreview(self):

   230

        """

   231

        Refresh preview panel of graphic element

   232

        Override BlockPreviewDialog function

   233

        """

   234

        # Set graphic element displayed, creating a FBD connection element

   235

        self.Element = FBD_Connector(self.Preview, 

   237

                self.ConnectionName.GetValue())

   238

   239

        # Call BlockPreviewDialog function

   240

        BlockPreviewDialog.RefreshPreview(self)

   241