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

import wx

    27

    28

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

    29

#                                 Helpers

    30

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

    31

    32

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

    33

    34

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

    35

 POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    36

] = range(10)

    37

    38

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

    39

#                       Project Properties Panel

    40

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

    41

    42

    43

class ProjectPropertiesPanel(wx.Notebook):

    44

    45

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

    46

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

    47

            border = 0

    48

            if idx == 0:

    49

                border |= wx.TOP

    50

            elif idx == len(params) - 1:

    51

                border |= wx.BOTTOM

    52

    53

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

    54

            sizer.AddWindow(st, border=10,

    55

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

    56

    57

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

    58

            setattr(self, name, tc)

    59

            callback = self.GetTextCtrlChangedFunction(tc, name)

    60

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

    61

            tc.Bind(wx.EVT_KILL_FOCUS, callback)

    62

            sizer.AddWindow(tc, border=10,

    63

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

    64

    65

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

    66

        wx.Notebook.__init__(self, parent)

    67

    68

        self.Controller = controller

    69

        self.ParentWindow = window

    70

        self.Values = None

    71

    72

        # Project Panel elements

    73

    74

        self.ProjectPanel = wx.Panel(self, style=wx.TAB_TRAVERSAL)

    75

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

    76

        projectpanel_sizer.AddGrowableCol(1)

    77

        self.ProjectPanel.SetSizer(projectpanel_sizer)

    78

    79

        self.AddSizerParams(self.ProjectPanel, projectpanel_sizer,

    80

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

    81

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

    82

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

    83

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

    84

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

    85

    86

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

    87

    88

        # Author Panel elements

    89

    90

        self.AuthorPanel = wx.Panel(self, style=wx.TAB_TRAVERSAL)

    91

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

    92

        authorpanel_sizer.AddGrowableCol(1)

    93

        self.AuthorPanel.SetSizer(authorpanel_sizer)

    94

    95

        self.AddSizerParams(self.AuthorPanel, authorpanel_sizer,

    96

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

    97

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

    98

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

    99

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

   100

   101

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

   102

   103

        # Graphics Panel elements

   104

   105

        self.GraphicsPanel = wx.Panel(self, style=wx.TAB_TRAVERSAL)

   106

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

   107

        graphicpanel_sizer.AddGrowableCol(0)

   108

        graphicpanel_sizer.AddGrowableRow(3)

   109

        self.GraphicsPanel.SetSizer(graphicpanel_sizer)

   110

   111

        pageSize_st = wx.StaticText(self.GraphicsPanel,

   112

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

   113

        graphicpanel_sizer.AddWindow(pageSize_st, border=10,

   114

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

   115

   116

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

   117

        pageSize_sizer.AddGrowableCol(1)

   118

        graphicpanel_sizer.AddSizer(pageSize_sizer, border=10,

   119

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

   120

   121

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

   122

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

   123

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

   124

            pageSize_sizer.AddWindow(st, border=12,

   125

                  flag=wx.ALIGN_CENTER_VERTICAL|wx.LEFT)

   126

   127

            sp = wx.SpinCtrl(self.GraphicsPanel,

   128

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

   129

            setattr(self, name, sp)

   130

            callback = self.GetPageSizeChangedFunction(sp, name)

   131

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

   132

            sp.Bind(wx.EVT_KILL_FOCUS, callback)

   133

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

   134

   135

        scaling_st = wx.StaticText(self.GraphicsPanel,

   136

              label=_('Grid Resolution:'))

   137

        graphicpanel_sizer.AddWindow(scaling_st, border=10,

   138

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

   139

   140

        scaling_nb = wx.Notebook(self.GraphicsPanel)

   141

        graphicpanel_sizer.AddWindow(scaling_nb, border=10,

   142

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

   143

   144

        self.Scalings = {}

   146

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

   147

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

   148

            scalingpanel_sizer.AddGrowableCol(1)

   149

            scaling_panel.SetSizer(scalingpanel_sizer)

   150

   151

            scaling_controls = []

   152

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

   153

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

   154

                if idx == 0:

   155

                    border = wx.TOP

   156

                else:

   157

                    border = wx.BOTTOM

   158

   159

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

   160

                scalingpanel_sizer.AddWindow(st, border=10,

   161

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

   162

   163

                sp = wx.SpinCtrl(scaling_panel,

   164

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

   165

                scaling_controls.append(sp)

   166

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

   167

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

   168

                sp.Bind(wx.EVT_KILL_FOCUS, callback)

   169

                scalingpanel_sizer.AddWindow(sp, border=10,

   170

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

   171

   172

            self.Scalings[language] = scaling_controls

   173

            scaling_nb.AddPage(scaling_panel, translation)

   174

   175

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

   176

   177

        # Miscellaneous Panel elements

   178

   179

        self.MiscellaneousPanel = wx.Panel(id=-1, parent=self,

   180

              name='MiscellaneousPanel', pos=wx.Point(0, 0),

   181

              size=wx.Size(0, 0), style=wx.TAB_TRAVERSAL)

   182

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

   183

        miscellaneouspanel_sizer.AddGrowableCol(1)

   184

        miscellaneouspanel_sizer.AddGrowableRow(1)

   185

        self.MiscellaneousPanel.SetSizer(miscellaneouspanel_sizer)

   186

   187

        language_label = wx.StaticText(self.MiscellaneousPanel,

   188

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

   189

        miscellaneouspanel_sizer.AddWindow(language_label, border=10,

   190

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

   191

   192

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

   193

              style=wx.CB_READONLY)

   194

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

   195

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

   196

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

   197

   198

        description_label = wx.StaticText(self.MiscellaneousPanel,

   199

              label=_('Content Description (optional):'))

   200

        miscellaneouspanel_sizer.AddWindow(description_label, border=10,

   201

              flag=wx.BOTTOM|wx.LEFT)

   202

   203

        self.ContentDescription = wx.TextCtrl(self.MiscellaneousPanel,

   205

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

   206

              self.ContentDescription)

   207

        self.ContentDescription.Bind(wx.EVT_KILL_FOCUS,

   208

              self.OnContentDescriptionChanged)

   209

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

   210

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

   211

   212

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

   213

   214

        for param in REQUIRED_PARAMS:

   215

            getattr(self, param).Enable(enable_required)

   216

   217

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

   218

   219

        for language in languages:

   220

            self.Language.Append(language)

   221

   222

    def RefreshView(self):

   223

        if self.Controller is not None:

   224

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

   225

   226

    def SetValues(self, values):

   227

        self.Values = values

   228

        for item, value in values.items():

   229

            if item == "language":

   230

                self.Language.SetStringSelection(value)

   231

            elif item == "contentDescription":

   232

                self.ContentDescription.SetValue(value)

   233

            elif item == "pageSize":

   234

                self.PageWidth.SetValue(value[0])

   235

                self.PageHeight.SetValue(value[1])

   236

            elif item == "scaling":

   237

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

   238

                    if language in self.Scalings:

   239

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

   240

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

   241

            else:

   242

                tc = getattr(self, item, None)

   243

                if tc is not None:

   244

                    tc.SetValue(value)

   245

   246

    def GetValues(self):

   247

        values = {}

   248

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

   249

                      "productName", "productVersion",

   250

                      "productRelease", "companyName",

   251

                      "companyURL", "authorName",

   252

                      "organization"]:

   253

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

   254

            if param in REQUIRED_PARAMS or value != "":

   255

                values[param] = value

   256

            else:

   257

                values[param] = None

   258

        language = self.Language.GetStringSelection()

   259

        if language != "":

   260

            values["language"] = language

   261

        else:

   262

            values["language"] = None

   263

        content_description = self.ContentDescription.GetValue()

   264

        if content_description != "":

   265

            values["contentDescription"] = content_description

   266

        else:

   267

            values["contentDescription"] = None

   268

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

   269

        values["scaling"] = {}

   270

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

   271

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

   272

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

   273

        return values

   274

   275

    def GetTextCtrlChangedFunction(self, textctrl, name):

   276

        def TextCtrlChangedFunction(event):

   277

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

   278

                old_value = self.Values.get(name)

   279

                new_value = textctrl.GetValue()

   280

                if name not in REQUIRED_PARAMS and new_value == "":

   281

                    new_value = None

   282

                if old_value != new_value:

   283

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

   284

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

   285

                            PROJECTTREE, PAGETITLES)

   286

                    wx.CallAfter(self.RefreshView)

   287

            event.Skip()

   288

        return TextCtrlChangedFunction

   289

   290

    def GetPageSizeChangedFunction(self, spinctrl, name):

   291

        def PageSizeChangedFunction(event):

   292

            if self.Controller is not None:

   293

                if self.Values is not None:

   294

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

   295

                else:

   296

                    old_value = (0, 0)

   297

                if name == 'PageWidth':

   298

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

   299

                else:

   300

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

   301

                if old_value != new_value:

   302

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

   303

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

   304

                          PAGETITLES, SCALING)

   305

                    wx.CallAfter(self.RefreshView)

   306

            event.Skip()

   307

        return PageSizeChangedFunction

   308

   309

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

   310

        def ScalingChangedFunction(event):

   311

            if self.Controller is not None:

   312

                old_value = (0, 0)

   313

                if self.Values is not None:

   314

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

   315

                    if scaling is not None:

   316

                        old_value = scaling.get(language)

   317

                if name == 'XScale':

   318

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

   319

                else:

   320

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

   321

                if old_value != new_value:

   322

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

   323

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

   324

                          PAGETITLES, SCALING)

   325

                    wx.CallAfter(self.RefreshView)

   326

            event.Skip()

   327

        return ScalingChangedFunction

   328

   329

    def OnLanguageChanged(self, event):

   330

        if self.Controller is not None:

   331

            if self.Values is not None:

   332

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

   333

            else:

   334

                old_value = None

   335

            new_value = self.Language.GetStringSelection()

   336

            if new_value == "":

   337

                new_value = None

   338

            if old_value != new_value:

   339

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

   340

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

   341

                wx.CallAfter(self.RefreshView)

   342

        event.Skip()

   343

   344

    def OnContentDescriptionChanged(self, event):

   345

        if self.Controller is not None:

   346

            if self.Values is not None:

   347

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

   348

            else:

   349

                old_value = None

   350

            new_value = self.ContentDescription.GetValue()

   351

            if new_value == "":

   352

                new_value = None

   353

            if old_value != new_value:

   354

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

   355

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

   356

                wx.CallAfter(self.RefreshView)

   357

        event.Skip()