2

# -*- coding: utf-8 -*-

     3

     6

#

     8

#

    10

#

    15

#

    20

#

    24

    25

import wx

    26

    27

from graphics.SFC_Objects import SFC_Step

    28

from BlockPreviewDialog import BlockPreviewDialog

    29

    30

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

    31

#                         Set SFC Step Parameters Dialog

    32

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

    33

    34

"""

    35

Class that implements a dialog for defining parameters of a SFC step graphic

    36

element

    37

"""

    38

    39

class SFCStepDialog(BlockPreviewDialog):

    40

    41

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

    42

        """

    43

        Constructor

    44

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

    45

        @param controller: Reference to project controller

    46

        @param tagname: Tagname of project POU edited

    47

        @param initial: True if step is initial (default: False)

    48

        """

    49

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

    50

              size=wx.Size(400, 280), title=_('Edit Step'))

    51

    52

        # Init common sizers

    53

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

    54

    55

        # Create label for SFC step name

    56

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

    57

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

    58

    59

        # Create text control for defining SFC step name

    60

        self.StepName = wx.TextCtrl(self)

    61

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

    62

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

    63

    64

        # Create label for SFC step connectors

    65

        connectors_label = wx.StaticText(self, label=_('Connectors:'))

    66

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

    67

    68

        # Create check boxes for defining connectors available on SFC step

    69

        self.ConnectorsCheckBox = {}

    70

        for name, label in [("input", _("Input")),

    71

                            ("output", _("Output")),

    72

                            ("action", _("Action"))]:

    73

            check_box = wx.CheckBox(self, label=label)

    74

            self.Bind(wx.EVT_CHECKBOX, self.OnConnectorsChanged, check_box)

    75

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

    76

            self.ConnectorsCheckBox[name] = check_box

    77

    78

        # Add preview panel and associated label to sizers

    79

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

    80

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

    81

    82

        # Add buttons sizer to sizers

    83

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

    84

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

    85

    86

        # Save flag that indicates that step is initial

    87

        self.Initial = initial

    88

    89

        # Set default name for step

    90

        self.StepName.ChangeValue(controller.GenerateNewName(

    91

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

    92

    93

        # Step name text control is default control having keyboard focus

    94

        self.StepName.SetFocus()

    95

    96

    def SetValues(self, values):

    97

        """

    98

        Set default block parameters

    99

        @param values: Block parameters values

   100

        """

   101

        # For each parameters defined, set corresponding control value

   102

        for name, value in values.items():

   103

   104

            # Parameter is step name

   105

            if name == "name":

   106

                self.StepName.ChangeValue(value)

   107

   108

            # Set value of other controls

   109

            else:

   110

                control = self.ConnectorsCheckBox.get(name, None)

   111

                if control is not None:

   112

                    control.SetValue(value)

   113

   114

        # Refresh preview panel

   115

        self.RefreshPreview()

   116

   117

    def GetValues(self):

   118

        """

   119

        Return step parameters defined in dialog

   120

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

   121

        """

   122

        values = {"name": self.StepName.GetValue()}

   123

        values.update({

   124

            name: control.IsChecked()

   125

            for name, control in self.ConnectorsCheckBox.iteritems()})

   126

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

   127

        return values

   128

   129

    def OnOK(self, event):

   130

        """

   131

        Called when dialog OK button is pressed

   132

        Test if step name defined is valid

   133

        @param event: wx.Event from OK button

   134

        """

   135

        message = None

   136

   137

        # Get step name typed by user

   138

        step_name = self.StepName.GetValue()

   139

   140

        # Test that a name have been defined

   141

        if step_name == "":

   142

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

   143

   144

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

   145

        if message is not None:

   146

            self.ShowErrorMessage(message)

   147

   148

        # Test step name validity

   149

        elif self.TestElementName(step_name):

   150

            # Call BlockPreviewDialog function

   151

            BlockPreviewDialog.OnOK(self, event)

   152

   153

    def OnConnectorsChanged(self, event):

   154

        """

   155

        Called when a step connector value changed

   156

        @param event: wx.CheckBoxEvent

   157

        """

   158

        self.RefreshPreview()

   159

        event.Skip()

   160

   161

    def OnNameChanged(self, event):

   162

        """

   163

        Called when step name value changed

   164

        @param event: wx.TextEvent

   165

        """

   166

        self.RefreshPreview()

   167

        event.Skip()

   168

   169

    def RefreshPreview(self):

   170

        """

   171

        Refresh preview panel of graphic element

   172

        Override BlockPreviewDialog function

   173

        """

   174

        # Set graphic element displayed, creating a SFC step element

   175

        self.Element = SFC_Step(self.Preview, 

   176

                                self.StepName.GetValue(), 

   177

                                self.Initial)

   178

   179

        # Update connectors of SFC step element according to check boxes value

   180

        for name, control in self.ConnectorsCheckBox.iteritems():

   181

            if control.IsChecked():

   182

                getattr(self.Element, "Add" + name.capitalize())()

   183

            else:

   184

                getattr(self.Element, "Remove" + name.capitalize())()

   185

   186

        # Call BlockPreviewDialog function

   187

        BlockPreviewDialog.RefreshPreview(self)