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) 2013: 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 plcopen.structures import TestIdentifier, IEC_KEYWORDS

    28

from graphics.GraphicCommons import FREEDRAWING_MODE

    29

    30

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

    31

#                    Dialog with preview for graphic block

    32

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

    33

    34

"""

    35

Class that implements a generic dialog containing a preview panel for displaying

    36

graphic created by dialog

    37

"""

    38

    39

class BlockPreviewDialog(wx.Dialog):

    40

    41

    def __init__(self, parent, controller, tagname, size, title):

    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 size: wx.Size object containing size of dialog

    48

        @param title: Title of dialog frame

    49

        """

    50

        wx.Dialog.__init__(self, parent, size=size, title=title)

    51

    52

        # Save reference to

    53

        self.Controller = controller

    54

        self.TagName = tagname

    55

    56

        # Label for preview

    57

        self.PreviewLabel = wx.StaticText(self, label=_('Preview:'))

    58

    59

        # Create Preview panel

    60

        self.Preview = wx.Panel(self, style=wx.SIMPLE_BORDER)

    61

        self.Preview.SetBackgroundColour(wx.WHITE)

    62

    63

        # Add function to preview panel so that it answers to graphic elements

    64

        # like Viewer

    65

        setattr(self.Preview, "GetDrawingMode", lambda:FREEDRAWING_MODE)

    66

        setattr(self.Preview, "GetScaling", lambda:None)

    67

        setattr(self.Preview, "GetBlockType", controller.GetBlockType)

    68

        setattr(self.Preview, "IsOfType", controller.IsOfType)

    69

    70

        # Bind paint event on Preview panel

    71

        self.Preview.Bind(wx.EVT_PAINT, self.OnPaint)

    72

    73

        # Add default dialog buttons sizer

    74

        self.ButtonSizer = self.CreateButtonSizer(wx.OK|wx.CANCEL|wx.CENTRE)

    75

        self.Bind(wx.EVT_BUTTON, self.OnOK, 

    76

                  self.ButtonSizer.GetAffirmativeButton())

    77

    78

        self.Block = None            # Graphic element to display in preview

    79

        self.MinBlockSize = None     # Graphic element minimal size

    80

        self.DefaultBlockName = None # Graphic element name when opening dialog

    81

    82

    def __del__(self):

    83

        """

    84

        Destructor

    85

        """

    86

        # Remove reference to project controller

    87

        self.Controller = None

    88

    89

    def SetMinBlockSize(self, size):

    90

        """

    91

        Define minimal graphic element size

    92

        @param size: wx.Size object containing minimal size

    93

        """

    94

        self.MinBlockSize = size

    95

    96

    def SetPreviewFont(self, font):

    97

        """

    98

        Set font of Preview panel

    99

        @param font: wx.Font object containing font style

   100

        """

   101

        self.Preview.SetFont(font)

   102

   103

    def TestBlockName(self, block_name):

   104

        """

   105

        Text displayed graphic element name

   106

        @param block_name: Graphic element name

   107

        """

   108

        # Variable containing error message format

   109

        message_format = None

   110

        # Get graphic element name in upper case

   111

        uppercase_block_name = block_name.upper()

   112

   113

        # Test if graphic element name is a valid identifier

   114

        if not TestIdentifier(block_name):

   115

            message_format = _("\"%s\" is not a valid identifier!")

   116

   117

        # Test that graphic element name isn't a keyword

   118

        elif uppercase_block_name in IEC_KEYWORDS:

   119

            message_format = _("\"%s\" is a keyword. It can't be used!")

   120

   121

        # Test that graphic element name isn't a POU name

   122

        elif uppercase_block_name in self.Controller.GetProjectPouNames():

   123

            message_format = _("\"%s\" pou already exists!")

   124

   125

        # Test that graphic element name isn't already used in POU by a variable

   126

        # or another graphic element

   127

        elif ((self.DefaultBlockName is None or 

   128

               self.DefaultBlockName.upper() != uppercase_block_name) and 

   129

              uppercase_block_name in self.Controller.GetEditedElementVariables(

   130

                                                                self.TagName)):

   131

            message_format = _("\"%s\" element for this pou already exists!")

   132

   133

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

   134

        if message_format is not None:

   135

            self.ShowErrorMessage(message_format % block_name)

   136

            # Test failed

   137

            return False

   138

   139

        # Test succeed

   140

        return True

   141

   142

    def ShowErrorMessage(self, message):

   143

        """

   144

        Show an error message dialog over this dialog

   145

        @param message: Error message to display

   146

        """

   147

        dialog = wx.MessageDialog(self, message, 

   148

                                  _("Error"), 

   149

                                  wx.OK|wx.ICON_ERROR)

   150

        dialog.ShowModal()

   151

        dialog.Destroy()

   152

   153

    def OnOK(self, event):

   154

        """

   155

        Called when dialog OK button is pressed

   156

        Need to be overridden by inherited classes to check that dialog values

   157

        are valid

   158

        @param event: wx.Event from OK button

   159

        """

   160

        # Close dialog

   161

        self.EndModal(wx.ID_OK)

   162

   163

    def RefreshPreview(self):

   164

        """

   165

        Refresh preview panel of graphic element

   166

        May be overridden by inherited classes

   167

        """

   168

        # Init preview panel paint device context

   169

        dc = wx.ClientDC(self.Preview)

   170

        dc.SetFont(self.Preview.GetFont())

   171

        dc.Clear()

   172

   173

        # Return immediately if no graphic element defined

   174

        if self.Block is None:

   175

            return

   176

   177

        # Calculate block size according to graphic element min size due to its

   178

        # parameters and graphic element min size defined

   179

        min_width, min_height = self.Block.GetMinSize()

   180

        width = max(self.MinBlockSize[0], min_width)

   181

        height = max(self.MinBlockSize[1], min_height)

   182

        self.Block.SetSize(width, height)

   183

   184

        # Get Preview panel size

   185

        client_size = self.Preview.GetClientSize()

   186

   187

        # If graphic element is too big to be displayed in preview panel,

   188

        # calculate preview panel scale so that graphic element fit inside

   189

        scale = (max(float(width) / client_size.width, 

   190

                     float(height) / client_size.height) * 1.2

   191

                 if width * 1.2 > client_size.width or 

   192

                    height * 1.2 > client_size.height

   193

                 else 1.0)

   194

        dc.SetUserScale(1.0 / scale, 1.0 / scale)

   195

   196

        # Center graphic element in preview panel

   197

        x = int(client_size.width * scale - width) / 2

   198

        y = int(client_size.height * scale - height) / 2

   199

        self.Block.SetPosition(x, y)

   200

   201

        # Draw graphic element

   202

        self.Block.Draw(dc)

   203

   204

    def OnPaint(self, event):

   205

        """

   206

        Called when Preview panel need to be redraw

   207

        @param event: wx.PaintEvent

   208

        """

   209

        self.RefreshPreview()

   210

        event.Skip()

   211