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

"""

    36

Class that implements a dialog for defining parameters of a connection graphic

    37

element

    38

"""

    39

    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

        # Init common sizers

    55

        self._init_sizers(2, 0, 5, None, 2, 1)

    56

    57

        # Create label for connection type

    58

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

    59

        self.LeftGridSizer.AddWindow(type_label, flag=wx.GROW)

    60

    61

        # Create radio buttons for selecting connection type

    62

        self.TypeRadioButtons = {}

    63

        first = True

    64

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

    65

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

    66

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

    67

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

    68

            radio_button.SetValue(first)

    69

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

    70

            self.LeftGridSizer.AddWindow(radio_button, flag=wx.GROW)

    71

            self.TypeRadioButtons[type] = radio_button

    72

            first = False

    73

    74

        # Create label for connection name

    75

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

    76

        self.LeftGridSizer.AddWindow(name_label, flag=wx.GROW)

    77

    78

        # Create text control for defining connection name

    79

        self.ConnectionName = wx.TextCtrl(self)

    80

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

    81

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

    82

    83

        # Add preview panel and associated label to sizers

    84

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

    85

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

    86

    87

        # Add buttons sizer to sizers

    88

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

    89

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

    90

    91

        # Add button for applying connection name modification to all connection

    92

        # of POU

    93

        if apply_button:

    94

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

    95

            self.ApplyToAllButton.SetToolTipString(

    96

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

    97

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

    98

            self.ButtonSizer.AddWindow(self.ApplyToAllButton, 

    99

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

   100

                    flag=wx.LEFT)

   101

        else:

   102

            self.ConnectionName.ChangeValue(

   103

                controller.GenerateNewName(

   104

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

   105

   106

        # Connector radio button is default control having keyboard focus

   107

        self.TypeRadioButtons[CONNECTOR].SetFocus()

   108

   109

    def GetConnectionType(self):

   110

        """

   111

        Return type selected for connection

   112

        @return: Type selected (CONNECTOR or CONTINUATION)

   113

        """

   114

        return (CONNECTOR

   115

                if self.TypeRadioButtons[CONNECTOR].GetValue()

   116

                else CONTINUATION)

   117

   118

    def SetValues(self, values):

   119

        """

   120

        Set default connection parameters

   121

        @param values: Connection parameters values

   122

        """

   123

        # For each parameters defined, set corresponding control value

   124

        for name, value in values.items():

   125

   126

            # Parameter is connection type

   127

            if name == "type":

   128

                self.TypeRadioButtons[value].SetValue(True)

   129

   130

            # Parameter is connection name

   131

            elif name == "name":

   132

                self.ConnectionName.SetValue(value)

   133

   134

        # Refresh preview panel

   135

        self.RefreshPreview()

   136

   137

    def GetValues(self):

   138

        """

   139

        Return connection parameters defined in dialog

   140

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

   141

        """

   142

        values = {

   143

            "type": self.GetConnectionType(),

   144

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

   145

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

   146

        return values

   147

   148

    def TestConnectionName(self):

   149

        """

   150

        Test that connection name is valid

   151

        @return: True if connection name is valid

   152

        """

   153

        message = None

   154

   155

        # Get connection name typed by user

   156

        connection_name = self.ConnectionName.GetValue()

   157

   158

        # Test that a name have been defined

   159

        if connection_name == "":

   160

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

   161

   162

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

   163

        if message is not None:

   164

            self.ShowErrorMessage(message)

   165

            # Test failed

   166

            return False

   167

   168

        # Return result of element name test

   169

        return self.TestElementName(connection_name)

   170

   171

    def OnOK(self, event):

   172

        """

   173

        Called when dialog OK button is pressed

   174

        Test if connection name is valid

   175

        @param event: wx.Event from OK button

   176

        """

   177

        # Close dialog if connection name is valid

   178

        if self.TestConnectionName():

   179

            self.EndModal(wx.ID_OK)

   180

   181

    def OnApplyToAll(self, event):

   182

        """

   183

        Called when Apply To All 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_YESTOALL)

   190

   191

    def OnTypeChanged(self, event):

   192

        """

   193

        Called when connection type changed

   194

        @param event: wx.RadioButtonEvent

   195

        """

   196

        self.RefreshPreview()

   197

        event.Skip()

   198

   199

    def OnNameChanged(self, event):

   200

        """

   201

        Called when connection name value changed

   202

        @param event: wx.TextEvent

   203

        """

   204

        self.RefreshPreview()

   205

        event.Skip()

   206

   207

    def RefreshPreview(self):

   208

        """

   209

        Refresh preview panel of graphic element

   210

        Override BlockPreviewDialog function

   211

        """

   212

        # Set graphic element displayed, creating a FBD connection element

   213

        self.Element = FBD_Connector(self.Preview, 

   214

                self.GetConnectionType(),

   215

                self.ConnectionName.GetValue())

   216

   217

        # Call BlockPreviewDialog function

   218

        BlockPreviewDialog.RefreshPreview(self)

   219