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

    35

class ConnectionDialog(BlockPreviewDialog):

    36

    37

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

    38

        """

    39

        Constructor

    40

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

    41

        @param controller: Reference to project controller

    42

        @param tagname: Tagname of project POU edited

    43

        @param apply_button: Enable button for applying connector modification

    44

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

    45

        """

    46

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

    47

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

    48

    49

        # Create dialog main sizer

    50

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

    51

        main_sizer.AddGrowableCol(0)

    52

        main_sizer.AddGrowableRow(0)

    53

    54

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

    55

        column_sizer = wx.BoxSizer(wx.HORIZONTAL)

    56

        main_sizer.AddSizer(column_sizer, border=20, 

    57

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

    58

    59

        # Create a sizer for left column

    60

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

    61

        left_gridsizer.AddGrowableCol(0)

    62

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

    63

              flag=wx.GROW|wx.RIGHT)

    64

    65

        # Create label for connection type

    66

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

    67

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

    68

    69

        # Create radio buttons for selecting connection type

    70

        self.TypeRadioButtons = {}

    71

        first = True

    72

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

    73

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

    74

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

    76

            radio_button.SetValue(first)

    77

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

    78

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

    79

            self.TypeRadioButtons[type] = radio_button

    80

            first = False

    81

    82

        # Create label for connection name

    83

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

    84

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

    85

    86

        # Create text control for defining connection name

    87

        self.ConnectionName = wx.TextCtrl(self)

    88

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

    89

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

    90

    91

        # Create a sizer for right column

    92

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

    93

        right_gridsizer.AddGrowableCol(0)

    94

        right_gridsizer.AddGrowableRow(1)

    95

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

    96

              flag=wx.GROW|wx.LEFT)

    97

    98

        # Add preview panel and associated label to sizers

    99

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

   100

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

   101

   102

        # Add buttons sizer to sizers

   103

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

   104

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

   105

   106

        # Add button for applying connection name modification to all connection

   107

        # of POU

   108

        if apply_button:

   109

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

   110

            self.ApplyToAllButton.SetToolTipString(

   111

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

   112

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

   115

                    flag=wx.LEFT)

   116

        else:

   117

            self.ConnectionName.ChangeValue(

   118

                controller.GenerateNewName(

   119

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

   120

   121

        self.SetSizer(main_sizer)

   122

   123

        # Connector radio button is default control having keyboard focus

   124

        self.TypeRadioButtons[CONNECTOR].SetFocus()

   125

   126

    def SetValues(self, values):

   127

        """

   128

        Set default connection parameters

   129

        @param values: Connection parameters values

   130

        """

   131

        # For each parameters defined, set corresponding control value

   132

        for name, value in values.items():

   133

   134

            # Parameter is connection type

   135

            if name == "type":

   136

                self.TypeRadioButtons[value].SetValue(True)

   137

   138

            # Parameter is connection name

   139

            elif name == "name":

   140

                self.ConnectionName.SetValue(value)

   141

   142

        # Refresh preview panel

   143

        self.RefreshPreview()

   144

   145

    def GetValues(self):

   146

        """

   147

        Return connection parameters defined in dialog

   148

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

   149

        """

   150

        values = {

   151

            "type": (CONNECTOR 

   152

                     if self.TypeRadioButtons[CONNECTOR].GetValue()

   153

                     else CONTINUATION),

   154

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

   155

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

   156

        return values

   157

   158

    def TestConnectionName(self):

   159

        """

   160

        Test that connection name is valid

   161

        @return: True if connection name is valid

   162

        """

   163

        message = None

   164

   165

        # Get connection name typed by user

   166

        connection_name = self.ConnectionName.GetValue()

   167

   168

        # Test that a name have been defined

   169

        if connection_name == "":

   170

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

   171

   172

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

   173

        if message is not None:

   174

            self.ShowErrorMessage(message)

   175

            # Test failed

   176

            return False

   177

   178

        # Return result of element name test

   179

        return self.TestElementName(connection_name)

   180

   181

    def OnOK(self, event):

   182

        """

   183

        Called when dialog OK button is pressed

   184

        Test if connection name is valid

   185

        @param event: wx.Event from OK button

   186

        """

   187

        # Close dialog if connection name is valid

   188

        if self.TestConnectionName():

   189

            self.EndModal(wx.ID_OK)

   190

   191

    def OnApplyToAll(self, event):

   192

        """

   193

        Called when Apply To All button is pressed

   194

        Test if connection name is valid

   195

        @param event: wx.Event from OK button

   196

        """

   197

        # Close dialog if connection name is valid

   198

        if self.TestConnectionName():

   199

            self.EndModal(wx.ID_YESTOALL)

   200

   201

    def OnTypeChanged(self, event):

   202

        """

   203

        Called when connection type changed

   204

        @param event: wx.RadioButtonEvent

   205

        """

   206

        self.RefreshPreview()

   207

        event.Skip()

   208

   209

    def OnNameChanged(self, event):

   210

        """

   211

        Called when connection name value changed

   212

        @param event: wx.TextEvent

   213

        """

   214

        self.RefreshPreview()

   215

        event.Skip()

   216

   217

    def RefreshPreview(self):

   218

        """

   219

        Refresh preview panel of graphic element

   220

        Override BlockPreviewDialog function

   221

        """

   222

        # Set graphic element displayed, creating a FBD connection element

   223

        self.Element = FBD_Connector(self.Preview, 

   224

                (CONNECTOR

   225

                 if self.TypeRadioButtons[CONNECTOR].GetValue()

   226

                 else CONTINUATION),

   227

                self.ConnectionName.GetValue())

   228

   229

        # Call BlockPreviewDialog function

   230

        BlockPreviewDialog.RefreshPreview(self)

   231