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

    27

from __future__ import absolute_import

    28

import wx

    29

    30

from graphics.GraphicCommons import CONNECTOR, CONTINUATION

    31

from graphics.FBD_Objects import FBD_Connector

    32

from dialogs.BlockPreviewDialog import BlockPreviewDialog

    33

    34

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

    35

#                       Set Connection Parameters Dialog

    36

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

    37

    38

    39

class ConnectionDialog(BlockPreviewDialog):

    40

    """

    41

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

    42

    element

    43

    """

    44

    45

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

    46

        """

    47

        Constructor

    48

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

    49

        @param controller: Reference to project controller

    50

        @param tagname: Tagname of project POU edited

    51

        @param apply_button: Enable button for applying connector modification

    52

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

    53

        """

    54

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

    55

                                    title=_('Connection Properties'))

    56

    57

        # Init common sizers

    58

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

    59

    60

        # Create label for connection type

    61

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

    62

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

    63

    64

        # Create radio buttons for selecting connection type

    65

        self.TypeRadioButtons = {}

    66

        first = True

    67

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

    68

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

    69

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

    70

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

    71

            radio_button.SetValue(first)

    72

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

    73

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

    74

            self.TypeRadioButtons[type] = radio_button

    75

            first = False

    76

    77

        # Create label for connection name

    78

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

    79

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

    80

    81

        # Create text control for defining connection name

    82

        self.ConnectionName = wx.TextCtrl(self)

    83

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

    84

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

    85

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

    86

    87

        # Add preview panel and associated label to sizers

    88

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

    89

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

    90

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

    91

    92

        # Add buttons sizer to sizers

    93

        self.MainSizer.Add(

    94

            self.ButtonSizer, border=20,

    95

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

    96

        self.ColumnSizer.RemoveSizer(self.RightGridSizer)

    97

    98

        # Add button for applying connection name modification to all connection

    99

        # of POU

   100

        if apply_button:

   101

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

   102

            self.ApplyToAllButton.SetToolTip(

   103

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

   104

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

   105

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

   106

        else:

   107

            self.ConnectionName.ChangeValue(

   108

                controller.GenerateNewName(

   109

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

   110

        self.Fit()

   111

   112

        # Connector radio button is default control having keyboard focus

   113

        self.TypeRadioButtons[CONNECTOR].SetFocus()

   114

   115

    def GetConnectionType(self):

   116

        """

   117

        Return type selected for connection

   118

        @return: Type selected (CONNECTOR or CONTINUATION)

   119

        """

   120

        return (CONNECTOR

   121

                if self.TypeRadioButtons[CONNECTOR].GetValue()

   122

                else CONTINUATION)

   123

   124

    def SetValues(self, values):

   125

        """

   126

        Set default connection parameters

   127

        @param values: Connection parameters values

   128

        """

   129

        # For each parameters defined, set corresponding control value

   130

        for name, value in values.items():

   131

   132

            # Parameter is connection type

   133

            if name == "type":

   134

                self.TypeRadioButtons[value].SetValue(True)

   135

   136

            # Parameter is connection name

   137

            elif name == "name":

   138

                self.ConnectionName.SetValue(value)

   139

   140

        # Refresh preview panel

   141

        self.RefreshPreview()

   142

   143

    def GetValues(self):

   144

        """

   145

        Return connection parameters defined in dialog

   146

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

   147

        """

   148

        values = {

   149

            "type": self.GetConnectionType(),

   150

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

   151

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

   152

        return values

   153

   154

    def TestConnectionName(self):

   155

        """

   156

        Test that connection name is valid

   157

        @return: True if connection name is valid

   158

        """

   159

        message = None

   160

   161

        # Get connection name typed by user

   162

        connection_name = self.ConnectionName.GetValue()

   163

   164

        # Test that a name have been defined

   165

        if connection_name == "":

   166

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

   167

   168

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

   169

        if message is not None:

   170

            self.ShowErrorMessage(message)

   171

            # Test failed

   172

            return False

   173

   174

        # Return result of element name test

   175

        return self.TestElementName(connection_name)

   176

   177

    def OnOK(self, event):

   178

        """

   179

        Called when dialog OK button is pressed

   180

        Test if connection name is valid

   181

        @param event: wx.Event from OK button

   182

        """

   183

        # Close dialog if connection name is valid

   184

        if self.TestConnectionName():

   185

            self.EndModal(wx.ID_OK)

   186

   187

    def OnApplyToAll(self, event):

   188

        """

   189

        Called when Apply To All button is pressed

   190

        Test if connection name is valid

   191

        @param event: wx.Event from OK button

   192

        """

   193

        # Close dialog if connection name is valid

   194

        if self.TestConnectionName():

   195

            self.EndModal(wx.ID_YESTOALL)

   196

   197

    def OnTypeChanged(self, event):

   198

        """

   199

        Called when connection type changed

   200

        @param event: wx.RadioButtonEvent

   201

        """

   202

        self.RefreshPreview()

   203

        event.Skip()

   204

   205

    def OnNameChanged(self, event):

   206

        """

   207

        Called when connection name value changed

   208

        @param event: wx.TextEvent

   209

        """

   210

        self.RefreshPreview()

   211

        event.Skip()

   212

   213

    def DrawPreview(self):

   214

        """

   215

        Refresh preview panel of graphic element

   216

        Override BlockPreviewDialog function

   217

        """

   218

        # Set graphic element displayed, creating a FBD connection element

   219

        self.Element = FBD_Connector(self.Preview,

   220

                                     self.GetConnectionType(),

   221

                                     self.ConnectionName.GetValue())

   222

   223

        # Call BlockPreviewDialog function

   224

        BlockPreviewDialog.DrawPreview(self)