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

# Copyright (C) 2017: Andrey Skvortsov <andrej.skvortzov@gmail.com>

     9

#

    10

# See COPYING file for copyrights details.

    11

#

    12

# This program is free software; you can redistribute it and/or

    13

# modify it under the terms of the GNU General Public License

    14

# as published by the Free Software Foundation; either version 2

    15

# of the License, or (at your option) any later version.

    16

#

    17

# This program is distributed in the hope that it will be useful,

    18

# but WITHOUT ANY WARRANTY; without even the implied warranty of

    19

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    20

# GNU General Public License for more details.

    21

#

    22

# You should have received a copy of the GNU General Public License

    23

# along with this program; if not, write to the Free Software

    24

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

    25

    26

import wx

    27

    28

from graphics.GraphicCommons import CONNECTOR, CONTINUATION

    29

from graphics.FBD_Objects import FBD_Connector

    30

from BlockPreviewDialog import BlockPreviewDialog

    31

    32

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

    33

#                       Set Connection Parameters Dialog

    34

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

    35

    36

    37

class ConnectionDialog(BlockPreviewDialog):

    38

    """

    39

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

    40

    element

    41

    """

    42

    43

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

    44

        """

    45

        Constructor

    46

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

    47

        @param controller: Reference to project controller

    48

        @param tagname: Tagname of project POU edited

    49

        @param apply_button: Enable button for applying connector modification

    50

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

    51

        """

    52

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

    53

                                    title=_('Connection Properties'))

    54

    55

        # Init common sizers

    56

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

    57

    58

        # Create label for connection type

    59

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

    60

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

    61

    62

        # Create radio buttons for selecting connection type

    63

        self.TypeRadioButtons = {}

    64

        first = True

    65

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

    66

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

    67

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

    68

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

    69

            radio_button.SetValue(first)

    70

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

    71

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

    72

            self.TypeRadioButtons[type] = radio_button

    73

            first = False

    74

    75

        # Create label for connection name

    76

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

    77

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

    78

    79

        # Create text control for defining connection name

    80

        self.ConnectionName = wx.TextCtrl(self)

    81

        self.ConnectionName.SetMinSize(wx.Size(200, -1))

    82

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

    83

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

    84

    85

        # Add preview panel and associated label to sizers

    86

        self.Preview.SetMinSize(wx.Size(-1, 100))

    87

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

    88

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

    89

    90

        # Add buttons sizer to sizers

    91

        self.MainSizer.AddSizer(

    92

            self.ButtonSizer, border=20,

    93

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

    94

        self.ColumnSizer.RemoveSizer(self.RightGridSizer)

    95

    96

        # Add button for applying connection name modification to all connection

    97

        # of POU

    98

        if apply_button:

    99

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

   100

            self.ApplyToAllButton.SetToolTipString(

   101

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

   102

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

   103

            self.ButtonSizer.AddWindow(self.ApplyToAllButton, flag=wx.LEFT)

   104

        else:

   105

            self.ConnectionName.ChangeValue(

   106

                controller.GenerateNewName(

   107

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

   108

        self.Fit()

   109

   110

        # Connector radio button is default control having keyboard focus

   111

        self.TypeRadioButtons[CONNECTOR].SetFocus()

   112

   113

    def GetConnectionType(self):

   114

        """

   115

        Return type selected for connection

   116

        @return: Type selected (CONNECTOR or CONTINUATION)

   117

        """

   118

        return (CONNECTOR

   119

                if self.TypeRadioButtons[CONNECTOR].GetValue()

   120

                else CONTINUATION)

   121

   122

    def SetValues(self, values):

   123

        """

   124

        Set default connection parameters

   125

        @param values: Connection parameters values

   126

        """

   127

        # For each parameters defined, set corresponding control value

   128

        for name, value in values.items():

   129

   130

            # Parameter is connection type

   131

            if name == "type":

   132

                self.TypeRadioButtons[value].SetValue(True)

   133

   134

            # Parameter is connection name

   135

            elif name == "name":

   136

                self.ConnectionName.SetValue(value)

   137

   138

        # Refresh preview panel

   139

        self.RefreshPreview()

   140

   141

    def GetValues(self):

   142

        """

   143

        Return connection parameters defined in dialog

   144

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

   145

        """

   146

        values = {

   147

            "type": self.GetConnectionType(),

   148

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

   149

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

   150

        return values

   151

   152

    def TestConnectionName(self):

   153

        """

   154

        Test that connection name is valid

   155

        @return: True if connection name is valid

   156

        """

   157

        message = None

   158

   159

        # Get connection name typed by user

   160

        connection_name = self.ConnectionName.GetValue()

   161

   162

        # Test that a name have been defined

   163

        if connection_name == "":

   164

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

   165

   166

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

   167

        if message is not None:

   168

            self.ShowErrorMessage(message)

   169

            # Test failed

   170

            return False

   171

   172

        # Return result of element name test

   173

        return self.TestElementName(connection_name)

   174

   175

    def OnOK(self, event):

   176

        """

   177

        Called when dialog OK button is pressed

   178

        Test if connection name is valid

   179

        @param event: wx.Event from OK button

   180

        """

   181

        # Close dialog if connection name is valid

   182

        if self.TestConnectionName():

   183

            self.EndModal(wx.ID_OK)

   184

   185

    def OnApplyToAll(self, event):

   186

        """

   187

        Called when Apply To All button is pressed

   188

        Test if connection name is valid

   189

        @param event: wx.Event from OK button

   190

        """

   191

        # Close dialog if connection name is valid

   192

        if self.TestConnectionName():

   193

            self.EndModal(wx.ID_YESTOALL)

   194

   195

    def OnTypeChanged(self, event):

   196

        """

   197

        Called when connection type changed

   198

        @param event: wx.RadioButtonEvent

   199

        """

   200

        self.RefreshPreview()

   201

        event.Skip()

   202

   203

    def OnNameChanged(self, event):

   204

        """

   205

        Called when connection name value changed

   206

        @param event: wx.TextEvent

   207

        """

   208

        self.RefreshPreview()

   209

        event.Skip()

   210

   211

    def RefreshPreview(self):

   212

        """

   213

        Refresh preview panel of graphic element

   214

        Override BlockPreviewDialog function

   215

        """

   216

        # Set graphic element displayed, creating a FBD connection element

   217

        self.Element = FBD_Connector(self.Preview,

   218

                                     self.GetConnectionType(),

   219

                                     self.ConnectionName.GetValue())

   220

   221

        # Call BlockPreviewDialog function

   222

        BlockPreviewDialog.RefreshPreview(self)