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) 2012: 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

from __future__ import absolute_import

    27

import wx

    28

from wx.lib.scrolledpanel import ScrolledPanel

    29

    30

from xmlclass.xmlclass import URI_model

    31

    32

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

    33

#                                 Helpers

    34

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

    35

    36

REQUIRED_PARAMS = ["projectName", "productName", "productVersion", "companyName"]

    37

    38

[

    39

    TITLE, EDITORTOOLBAR, FILEMENU, EDITMENU, DISPLAYMENU, PROJECTTREE,

    40

    POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    41

] = range(10)

    42

    43

    44

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

    45

#                       Project Properties Panel

    46

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

    47

    48

    49

class ProjectPropertiesPanel(wx.Notebook):

    50

    51

    def AddSizerParams(self, parent, sizer, params):

    52

        for idx, (name, label) in enumerate(params):

    53

            border = 0

    54

            if idx == 0:

    55

                border |= wx.TOP

    56

            elif idx == len(params) - 1:

    57

                border |= wx.BOTTOM

    58

    59

            st = wx.StaticText(parent, label=label)

    60

            sizer.AddWindow(st, border=10,

    61

                            flag=wx.ALIGN_CENTER_VERTICAL | border | wx.LEFT)

    62

    63

            tc = wx.TextCtrl(parent, style=wx.TE_PROCESS_ENTER)

    64

            setattr(self, name, tc)

    65

            callback = self.GetTextCtrlChangedFunction(tc, name)

    66

            self.Bind(wx.EVT_TEXT_ENTER, callback, tc)

    67

            tc.Bind(wx.EVT_KILL_FOCUS, callback)

    68

            sizer.AddWindow(tc, border=10,

    69

                            flag=wx.GROW | border | wx.RIGHT)

    70

    71

    def __init__(self, parent, controller=None, window=None, enable_required=True):

    72

        wx.Notebook.__init__(self, parent)

    73

    74

        self.Controller = controller

    75

        self.ParentWindow = window

    76

        self.Values = None

    77

    78

        # Project Panel elements

    79

    80

        self.ProjectPanel = ScrolledPanel(self, -1, style=wx.TAB_TRAVERSAL)

    81

        self.ProjectPanel.SetAutoLayout(1)

    82

        self.ProjectPanel.SetupScrolling()

    83

        projectpanel_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=5, vgap=15)

    84

        projectpanel_sizer.AddGrowableCol(1)

    85

        self.ProjectPanel.SetSizer(projectpanel_sizer)

    86

    87

        self.AddSizerParams(self.ProjectPanel, projectpanel_sizer,

    88

                            [("projectName",    _('Project Name (required):')),

    89

                             ("projectVersion", _('Project Version (optional):')),

    90

                             ("productName",    _('Product Name (required):')),

    91

                             ("productVersion", _('Product Version (required):')),

    92

                             ("productRelease", _('Product Release (optional):'))])

    93

    94

        self.AddPage(self.ProjectPanel, _("Project"))

    95

    96

        # Author Panel elements

    97

    98

        self.AuthorPanel = ScrolledPanel(self, -1, style=wx.TAB_TRAVERSAL)

    99

        self.AuthorPanel.SetAutoLayout(1)

   100

        self.AuthorPanel.SetupScrolling()

   101

        authorpanel_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=4, vgap=15)

   102

        authorpanel_sizer.AddGrowableCol(1)

   103

        self.AuthorPanel.SetSizer(authorpanel_sizer)

   104

   105

        self.AddSizerParams(self.AuthorPanel, authorpanel_sizer,

   106

                            [("companyName",  _('Company Name (required):')),

   107

                             ("companyURL",   _('Company URL (optional):')),

   108

                             ("authorName",   _('Author Name (optional):')),

   109

                             ("organization", _('Organization (optional):'))])

   110

   111

        self.AddPage(self.AuthorPanel, _("Author"))

   112

   113

        # Graphics Panel elements

   114

   115

        self.GraphicsPanel = ScrolledPanel(self, -1, style=wx.TAB_TRAVERSAL)

   116

        self.GraphicsPanel.SetAutoLayout(1)

   117

        self.GraphicsPanel.SetupScrolling()

   118

        graphicpanel_sizer = wx.FlexGridSizer(cols=1, hgap=5, rows=4, vgap=5)

   119

        graphicpanel_sizer.AddGrowableCol(0)

   120

        graphicpanel_sizer.AddGrowableRow(3)

   121

        self.GraphicsPanel.SetSizer(graphicpanel_sizer)

   122

   123

        pageSize_st = wx.StaticText(self.GraphicsPanel,

   124

                                    label=_('Page Size (optional):'))

   125

        graphicpanel_sizer.AddWindow(

   126

            pageSize_st, border=10,

   127

            flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP | wx.LEFT | wx.RIGHT)

   128

   129

        pageSize_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=2, vgap=5)

   130

        pageSize_sizer.AddGrowableCol(1)

   131

        graphicpanel_sizer.AddSizer(pageSize_sizer, border=10,

   132

                                    flag=wx.GROW | wx.LEFT | wx.RIGHT)

   133

   134

        for name, label in [('PageWidth', _('Width:')),

   135

                            ('PageHeight', _('Height:'))]:

   136

            st = wx.StaticText(self.GraphicsPanel, label=label)

   137

            pageSize_sizer.AddWindow(st, border=12,

   138

                                     flag=wx.ALIGN_CENTER_VERTICAL | wx.LEFT)

   139

   140

            sp = wx.SpinCtrl(self.GraphicsPanel,

   141

                             min=0, max=2**16, style=wx.TE_PROCESS_ENTER)

   142

            setattr(self, name, sp)

   143

            callback = self.GetPageSizeChangedFunction(sp, name)

   144

            self.Bind(wx.EVT_TEXT_ENTER, callback, sp)

   145

            sp.Bind(wx.EVT_KILL_FOCUS, callback)

   146

            pageSize_sizer.AddWindow(sp, flag=wx.GROW)

   147

   148

        scaling_st = wx.StaticText(self.GraphicsPanel,

   149

                                   label=_('Grid Resolution:'))

   150

        graphicpanel_sizer.AddWindow(scaling_st, border=10,

   151

                                     flag=wx.GROW | wx.LEFT | wx.RIGHT)

   152

   153

        scaling_nb = wx.Notebook(self.GraphicsPanel)

   154

        graphicpanel_sizer.AddWindow(scaling_nb, border=10,

   155

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

   156

   157

        self.Scalings = {}

   158

        for language, translation in [("FBD", _("FBD")), ("LD", _("LD")), ("SFC", _("SFC"))]:

   159

            scaling_panel = wx.Panel(scaling_nb, style=wx.TAB_TRAVERSAL)

   160

            scalingpanel_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=2, vgap=5)

   161

            scalingpanel_sizer.AddGrowableCol(1)

   162

            scaling_panel.SetSizer(scalingpanel_sizer)

   163

   164

            scaling_controls = []

   165

            for idx, (name, label) in enumerate([('XScale', _('Horizontal:')),

   166

                                                 ('YScale', _('Vertical:'))]):

   167

                if idx == 0:

   168

                    border = wx.TOP

   169

                else:

   170

                    border = wx.BOTTOM

   171

   172

                st = wx.StaticText(scaling_panel, label=label)

   173

                scalingpanel_sizer.AddWindow(

   174

                    st, border=10,

   175

                    flag=wx.ALIGN_CENTER_VERTICAL | border | wx.LEFT)

   176

   177

                sp = wx.SpinCtrl(scaling_panel,

   178

                                 min=0, max=2**16, style=wx.TE_PROCESS_ENTER)

   179

                scaling_controls.append(sp)

   180

                callback = self.GetScalingChangedFunction(sp, language, name)

   181

                self.Bind(wx.EVT_TEXT_ENTER, callback, sp)

   182

                sp.Bind(wx.EVT_KILL_FOCUS, callback)

   183

                scalingpanel_sizer.AddWindow(sp, border=10,

   184

                                             flag=wx.GROW | border | wx.RIGHT)

   185

   186

            self.Scalings[language] = scaling_controls

   187

            scaling_nb.AddPage(scaling_panel, translation)

   188

   189

        self.AddPage(self.GraphicsPanel, _("Graphics"))

   190

   191

        # Miscellaneous Panel elements

   192

   193

        self.MiscellaneousPanel = ScrolledPanel(id=-1, parent=self,

   194

                                                name='MiscellaneousPanel',

   195

                                                pos=wx.Point(0, 0),

   196

                                                size=wx.Size(0, 0),

   197

                                                style=wx.TAB_TRAVERSAL)

   198

        self.MiscellaneousPanel.SetAutoLayout(1)

   199

        self.MiscellaneousPanel.SetupScrolling()

   200

        miscellaneouspanel_sizer = wx.FlexGridSizer(cols=2, hgap=5, rows=2, vgap=15)

   201

        miscellaneouspanel_sizer.AddGrowableCol(1)

   202

        miscellaneouspanel_sizer.AddGrowableRow(1)

   203

        self.MiscellaneousPanel.SetSizer(miscellaneouspanel_sizer)

   204

   205

        language_label = wx.StaticText(self.MiscellaneousPanel,

   206

                                       label=_('Language (optional):'))

   207

        miscellaneouspanel_sizer.AddWindow(language_label, border=10,

   208

                                           flag=wx.ALIGN_CENTER_VERTICAL | wx.TOP | wx.LEFT)

   209

   210

        self.Language = wx.ComboBox(self.MiscellaneousPanel,

   211

                                    style=wx.CB_READONLY)

   212

        self.Bind(wx.EVT_COMBOBOX, self.OnLanguageChanged, self.Language)

   213

        miscellaneouspanel_sizer.AddWindow(self.Language, border=10,

   214

                                           flag=wx.GROW | wx.TOP | wx.RIGHT)

   215

   216

        description_label = wx.StaticText(

   217

            self.MiscellaneousPanel, label=_('Content Description (optional):'))

   218

        miscellaneouspanel_sizer.AddWindow(description_label, border=10,

   219

                                           flag=wx.BOTTOM | wx.LEFT)

   220

   221

        self.ContentDescription = wx.TextCtrl(

   222

            self.MiscellaneousPanel, size=wx.Size(240, 150),

   223

            style=wx.TE_MULTILINE | wx.TE_PROCESS_ENTER)

   224

        self.Bind(wx.EVT_TEXT_ENTER, self.OnContentDescriptionChanged,

   225

                  self.ContentDescription)

   226

        self.ContentDescription.Bind(wx.EVT_KILL_FOCUS,

   227

                                     self.OnContentDescriptionChanged)

   228

        miscellaneouspanel_sizer.AddWindow(self.ContentDescription, border=10,

   229

                                           flag=wx.GROW | wx.BOTTOM | wx.RIGHT)

   230

   231

        self.AddPage(self.MiscellaneousPanel, _("Miscellaneous"))

   232

   233

        for param in REQUIRED_PARAMS:

   234

            getattr(self, param).Enable(enable_required)

   235

   236

        languages = ["", "en-US", "fr-FR", "zh-CN", "ru-RU"]

   237

   238

        for language in languages:

   239

            self.Language.Append(language)

   240

   241

    def RefreshView(self):

   242

        if self.Controller is not None:

   243

            self.SetValues(self.Controller.GetProjectProperties())

   244

   245

    def SetValues(self, values):

   246

        self.Values = values

   247

        for item, value in values.items():

   248

            if item == "language":

   249

                self.Language.SetStringSelection(value)

   250

            elif item == "contentDescription":

   251

                self.ContentDescription.SetValue(value)

   252

            elif item == "pageSize":

   253

                self.PageWidth.SetValue(value[0])

   254

                self.PageHeight.SetValue(value[1])

   255

            elif item == "scaling":

   256

                for language, (x, y) in value.items():

   257

                    if language in self.Scalings:

   258

                        self.Scalings[language][0].SetValue(x)

   259

                        self.Scalings[language][1].SetValue(y)

   260

            else:

   261

                tc = getattr(self, item, None)

   262

                if tc is not None:

   263

                    tc.SetValue(value)

   264

   265

    def GetValues(self):

   266

        values = {}

   267

        for param in ["projectName", "projectVersion",

   268

                      "productName", "productVersion",

   269

                      "productRelease", "companyName",

   270

                      "companyURL", "authorName",

   271

                      "organization"]:

   272

            value = getattr(self, param).GetValue()

   273

            if param in REQUIRED_PARAMS or value != "":

   274

                values[param] = value

   275

            else:

   276

                values[param] = None

   277

        language = self.Language.GetStringSelection()

   278

        if language != "":

   279

            values["language"] = language

   280

        else:

   281

            values["language"] = None

   282

        content_description = self.ContentDescription.GetValue()

   283

        if content_description != "":

   284

            values["contentDescription"] = content_description

   285

        else:

   286

            values["contentDescription"] = None

   287

        values["pageSize"] = (self.PageWidth.GetValue(), self.PageHeight.GetValue())

   288

        values["scaling"] = {}

   289

        for language in ["FBD", "LD", "SFC"]:

   290

            values["scaling"][language] = (self.Scalings[language][0].GetValue(),

   291

                                           self.Scalings[language][1].GetValue())

   292

        return values

   293

   294

    def GetTextCtrlChangedFunction(self, textctrl, name):

   295

        def TextCtrlChangedFunction(event):

   296

            if self.Controller is not None and self.Values is not None:

   297

                old_value = self.Values.get(name)

   298

                new_value = textctrl.GetValue()

   299

                if name in REQUIRED_PARAMS and new_value == "":

   300

                    new_value = None

   301

                if name == 'companyURL':

   302

                    if not URI_model.match(new_value):

   303

                        new_value = None

   304

                        dialog = wx.MessageDialog(self, _('Invalid URL!\n'

   305

                                                          'Please enter correct URL address.'),

   306

                                                  _("Error"), wx.OK | wx.ICON_ERROR)

   307

                        dialog.ShowModal()

   308

                        dialog.Destroy()

   309

                if old_value != new_value:

   310

                    self.Controller.SetProjectProperties(properties={name: new_value})

   311

                    self.ParentWindow._Refresh(TITLE, FILEMENU, EDITMENU,

   312

                                               PROJECTTREE, PAGETITLES)

   313

                    wx.CallAfter(self.RefreshView)

   314

            event.Skip()

   315

        return TextCtrlChangedFunction

   316

   317

    def GetPageSizeChangedFunction(self, spinctrl, name):

   318

        def PageSizeChangedFunction(event):

   319

            if self.Controller is not None:

   320

                if self.Values is not None:

   321

                    old_value = self.Values.get("pageSize")

   322

                else:

   323

                    old_value = (0, 0)

   324

                if name == 'PageWidth':

   325

                    new_value = (spinctrl.GetValue(), old_value[1])

   326

                else:

   327

                    new_value = (old_value[0], spinctrl.GetValue())

   328

                if old_value != new_value:

   329

                    self.Controller.SetProjectProperties(properties={"pageSize": new_value})

   330

                    self.ParentWindow._Refresh(TITLE, FILEMENU, EDITMENU,

   331

                                               PAGETITLES, SCALING)

   332

                    wx.CallAfter(self.RefreshView)

   333

            event.Skip()

   334

        return PageSizeChangedFunction

   335

   336

    def GetScalingChangedFunction(self, spinctrl, language, name):

   337

        def ScalingChangedFunction(event):

   338

            if self.Controller is not None:

   339

                old_value = (0, 0)

   340

                if self.Values is not None:

   341

                    scaling = self.Values.get("scaling")

   342

                    if scaling is not None:

   343

                        old_value = scaling.get(language)

   344

                if name == 'XScale':

   345

                    new_value = (spinctrl.GetValue(), old_value[1])

   346

                else:

   347

                    new_value = (old_value[0], spinctrl.GetValue())

   348

                if old_value != new_value:

   349

                    self.Controller.SetProjectProperties(properties={"scaling": {language: new_value}})

   350

                    self.ParentWindow._Refresh(TITLE, FILEMENU, EDITMENU,

   351

                                               PAGETITLES, SCALING)

   352

                    wx.CallAfter(self.RefreshView)

   353

            event.Skip()

   354

        return ScalingChangedFunction

   355

   356

    def OnLanguageChanged(self, event):

   357

        if self.Controller is not None:

   358

            if self.Values is not None:

   359

                old_value = self.Values.get("language")

   360

            else:

   361

                old_value = None

   362

            new_value = self.Language.GetStringSelection()

   363

            if new_value == "":

   364

                new_value = None

   365

            if old_value != new_value:

   366

                self.Controller.SetProjectProperties(properties={"language": new_value})

   367

                self.ParentWindow._Refresh(TITLE, FILEMENU, EDITMENU, PAGETITLES)

   368

                wx.CallAfter(self.RefreshView)

   369

        event.Skip()

   370

   371

    def OnContentDescriptionChanged(self, event):

   372

        if self.Controller is not None:

   373

            if self.Values is not None:

   374

                old_value = self.Values.get("contentDescription")

   375

            else:

   376

                old_value = None

   377

            new_value = self.ContentDescription.GetValue()

   378

            if new_value == "":

   379

                new_value = None

   380

            if old_value != new_value:

   381

                self.Controller.SetProjectProperties(properties={"contentDescription": new_value})

   382

                self.ParentWindow._Refresh(TITLE, FILEMENU, EDITMENU, PAGETITLES)

   383

                wx.CallAfter(self.RefreshView)

   384

        event.Skip()