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(

   114

            pageSize_st, border=10,

   115

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

   116

   117

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

   118

        pageSize_sizer.AddGrowableCol(1)

   119

        graphicpanel_sizer.AddSizer(pageSize_sizer, border=10,

   120

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

   121

   122

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

   123

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

   124

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

   125

            pageSize_sizer.AddWindow(st, border=12,

   126

                                     flag=wx.ALIGN_CENTER_VERTICAL | wx.LEFT)

   127

   128

            sp = wx.SpinCtrl(self.GraphicsPanel,

   129

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

   130

            setattr(self, name, sp)

   131

            callback = self.GetPageSizeChangedFunction(sp, name)

   132

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

   133

            sp.Bind(wx.EVT_KILL_FOCUS, callback)

   134

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

   135

   136

        scaling_st = wx.StaticText(self.GraphicsPanel,

   137

                                   label=_('Grid Resolution:'))

   138

        graphicpanel_sizer.AddWindow(scaling_st, border=10,

   139

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

   140

   141

        scaling_nb = wx.Notebook(self.GraphicsPanel)

   142

        graphicpanel_sizer.AddWindow(scaling_nb, border=10,

   143

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

   144

   145

        self.Scalings = {}

   146

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

   147

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

   148

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

   149

            scalingpanel_sizer.AddGrowableCol(1)

   150

            scaling_panel.SetSizer(scalingpanel_sizer)

   151

   152

            scaling_controls = []

   153

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

   154

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

   155

                if idx == 0:

   156

                    border = wx.TOP

   157

                else:

   158

                    border = wx.BOTTOM

   159

   160

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

   161

                scalingpanel_sizer.AddWindow(

   162

                    st, border=10,

   163

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

   164

   165

                sp = wx.SpinCtrl(scaling_panel,

   166

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

   167

                scaling_controls.append(sp)

   168

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

   169

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

   170

                sp.Bind(wx.EVT_KILL_FOCUS, callback)

   171

                scalingpanel_sizer.AddWindow(sp, border=10,

   172

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

   173

   174

            self.Scalings[language] = scaling_controls

   175

            scaling_nb.AddPage(scaling_panel, translation)

   176

   177

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

   178

   179

        # Miscellaneous Panel elements

   180

   181

        self.MiscellaneousPanel = wx.Panel(

   182

            id=-1, parent=self, name='MiscellaneousPanel', pos=wx.Point(0, 0),

   183

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

   184

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

   185

        miscellaneouspanel_sizer.AddGrowableCol(1)

   186

        miscellaneouspanel_sizer.AddGrowableRow(1)

   187

        self.MiscellaneousPanel.SetSizer(miscellaneouspanel_sizer)

   188

   189

        language_label = wx.StaticText(self.MiscellaneousPanel,

   190

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

   191

        miscellaneouspanel_sizer.AddWindow(language_label, border=10,

   192

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

   193

   194

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

   195

                                    style=wx.CB_READONLY)

   196

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

   197

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

   198

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

   199

   200

        description_label = wx.StaticText(

   201

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

   202

        miscellaneouspanel_sizer.AddWindow(description_label, border=10,

   203

                                           flag=wx.BOTTOM | wx.LEFT)

   204

   205

        self.ContentDescription = wx.TextCtrl(

   206

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

   207

            style=wx.TE_MULTILINE | wx.TE_PROCESS_ENTER)

   208

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

   209

                  self.ContentDescription)

   210

        self.ContentDescription.Bind(wx.EVT_KILL_FOCUS,

   211

                                     self.OnContentDescriptionChanged)

   212

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

   213

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

   214

   215

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

   216

   217

        for param in REQUIRED_PARAMS:

   218

            getattr(self, param).Enable(enable_required)

   219

   220

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

   221

   222

        for language in languages:

   223

            self.Language.Append(language)

   224

   225

    def RefreshView(self):

   226

        if self.Controller is not None:

   227

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

   228

   229

    def SetValues(self, values):

   230

        self.Values = values

   231

        for item, value in values.items():

   232

            if item == "language":

   233

                self.Language.SetStringSelection(value)

   234

            elif item == "contentDescription":

   235

                self.ContentDescription.SetValue(value)

   236

            elif item == "pageSize":

   237

                self.PageWidth.SetValue(value[0])

   238

                self.PageHeight.SetValue(value[1])

   239

            elif item == "scaling":

   240

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

   241

                    if language in self.Scalings:

   242

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

   243

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

   244

            else:

   245

                tc = getattr(self, item, None)

   246

                if tc is not None:

   247

                    tc.SetValue(value)

   248

   249

    def GetValues(self):

   250

        values = {}

   251

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

   252

                      "productName", "productVersion",

   253

                      "productRelease", "companyName",

   254

                      "companyURL", "authorName",

   255

                      "organization"]:

   256

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

   257

            if param in REQUIRED_PARAMS or value != "":

   258

                values[param] = value

   259

            else:

   260

                values[param] = None

   261

        language = self.Language.GetStringSelection()

   262

        if language != "":

   263

            values["language"] = language

   264

        else:

   265

            values["language"] = None

   266

        content_description = self.ContentDescription.GetValue()

   267

        if content_description != "":

   268

            values["contentDescription"] = content_description

   269

        else:

   270

            values["contentDescription"] = None

   271

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

   272

        values["scaling"] = {}

   273

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

   274

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

   275

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

   276

        return values

   277

   278

    def GetTextCtrlChangedFunction(self, textctrl, name):

   279

        def TextCtrlChangedFunction(event):

   280

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

   281

                old_value = self.Values.get(name)

   282

                new_value = textctrl.GetValue()

   283

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

   284

                    new_value = None

   285

                if old_value != new_value:

   286

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

   287

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

   288

                                               PROJECTTREE, PAGETITLES)

   289

                    wx.CallAfter(self.RefreshView)

   290

            event.Skip()

   291

        return TextCtrlChangedFunction

   292

   293

    def GetPageSizeChangedFunction(self, spinctrl, name):

   294

        def PageSizeChangedFunction(event):

   295

            if self.Controller is not None:

   296

                if self.Values is not None:

   297

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

   298

                else:

   299

                    old_value = (0, 0)

   300

                if name == 'PageWidth':

   301

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

   302

                else:

   303

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

   304

                if old_value != new_value:

   305

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

   306

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

   307

                                               PAGETITLES, SCALING)

   308

                    wx.CallAfter(self.RefreshView)

   309

            event.Skip()

   310

        return PageSizeChangedFunction

   311

   312

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

   313

        def ScalingChangedFunction(event):

   314

            if self.Controller is not None:

   315

                old_value = (0, 0)

   316

                if self.Values is not None:

   317

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

   318

                    if scaling is not None:

   319

                        old_value = scaling.get(language)

   320

                if name == 'XScale':

   321

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

   322

                else:

   323

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

   324

                if old_value != new_value:

   325

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

   326

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

   327

                                               PAGETITLES, SCALING)

   328

                    wx.CallAfter(self.RefreshView)

   329

            event.Skip()

   330

        return ScalingChangedFunction

   331

   332

    def OnLanguageChanged(self, event):

   333

        if self.Controller is not None:

   334

            if self.Values is not None:

   335

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

   336

            else:

   337

                old_value = None

   338

            new_value = self.Language.GetStringSelection()

   339

            if new_value == "":

   340

                new_value = None

   341

            if old_value != new_value:

   342

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

   343

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

   344

                wx.CallAfter(self.RefreshView)

   345

        event.Skip()

   346

   347

    def OnContentDescriptionChanged(self, event):

   348

        if self.Controller is not None:

   349

            if self.Values is not None:

   350

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

   351

            else:

   352

                old_value = None

   353

            new_value = self.ContentDescription.GetValue()

   354

            if new_value == "":

   355

                new_value = None

   356

            if old_value != new_value:

   357

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

   358

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

   359

                wx.CallAfter(self.RefreshView)

   360

        event.Skip()