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

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

    31

#                                 Helpers

    32

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

    33

    34

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

    35

    36

[

    37

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

    38

    POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    39

] = range(10)

    40

    41

    42

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

    43

#                       Project Properties Panel

    44

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

    45

    46

    47

class ProjectPropertiesPanel(wx.Notebook):

    48

    49

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

    50

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

    51

            border = 0

    52

            if idx == 0:

    53

                border |= wx.TOP

    54

            elif idx == len(params) - 1:

    55

                border |= wx.BOTTOM

    56

    57

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

    58

            sizer.AddWindow(st, border=10,

    59

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

    60

    61

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

    62

            setattr(self, name, tc)

    63

            callback = self.GetTextCtrlChangedFunction(tc, name)

    64

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

    65

            tc.Bind(wx.EVT_KILL_FOCUS, callback)

    66

            sizer.AddWindow(tc, border=10,

    67

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

    68

    69

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

    70

        wx.Notebook.__init__(self, parent)

    71

    72

        self.Controller = controller

    73

        self.ParentWindow = window

    74

        self.Values = None

    75

    76

        # Project Panel elements

    77

    78

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

    79

        self.ProjectPanel.SetAutoLayout(1)

    80

        self.ProjectPanel.SetupScrolling()

    81

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

    82

        projectpanel_sizer.AddGrowableCol(1)

    83

        self.ProjectPanel.SetSizer(projectpanel_sizer)

    84

    85

        self.AddSizerParams(self.ProjectPanel, projectpanel_sizer,

    86

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

    87

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

    88

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

    89

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

    90

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

    91

    92

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

    93

    94

        # Author Panel elements

    95

    96

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

    97

        self.AuthorPanel.SetAutoLayout(1)

    98

        self.AuthorPanel.SetupScrolling()

    99

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

   100

        authorpanel_sizer.AddGrowableCol(1)

   101

        self.AuthorPanel.SetSizer(authorpanel_sizer)

   102

   103

        self.AddSizerParams(self.AuthorPanel, authorpanel_sizer,

   104

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

   105

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

   106

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

   107

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

   108

   109

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

   110

   111

        # Graphics Panel elements

   112

   113

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

   114

        self.GraphicsPanel.SetAutoLayout(1)

   115

        self.GraphicsPanel.SetupScrolling()

   116

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

   117

        graphicpanel_sizer.AddGrowableCol(0)

   118

        graphicpanel_sizer.AddGrowableRow(3)

   119

        self.GraphicsPanel.SetSizer(graphicpanel_sizer)

   120

   121

        pageSize_st = wx.StaticText(self.GraphicsPanel,

   122

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

   123

        graphicpanel_sizer.AddWindow(

   124

            pageSize_st, border=10,

   125

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

   126

   127

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

   128

        pageSize_sizer.AddGrowableCol(1)

   129

        graphicpanel_sizer.AddSizer(pageSize_sizer, border=10,

   130

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

   131

   132

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

   133

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

   134

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

   135

            pageSize_sizer.AddWindow(st, border=12,

   136

                                     flag=wx.ALIGN_CENTER_VERTICAL | wx.LEFT)

   137

   138

            sp = wx.SpinCtrl(self.GraphicsPanel,

   139

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

   140

            setattr(self, name, sp)

   141

            callback = self.GetPageSizeChangedFunction(sp, name)

   142

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

   143

            sp.Bind(wx.EVT_KILL_FOCUS, callback)

   144

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

   145

   146

        scaling_st = wx.StaticText(self.GraphicsPanel,

   147

                                   label=_('Grid Resolution:'))

   148

        graphicpanel_sizer.AddWindow(scaling_st, border=10,

   149

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

   150

   151

        scaling_nb = wx.Notebook(self.GraphicsPanel)

   152

        graphicpanel_sizer.AddWindow(scaling_nb, border=10,

   153

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

   154

   155

        self.Scalings = {}

   156

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

   157

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

   158

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

   159

            scalingpanel_sizer.AddGrowableCol(1)

   160

            scaling_panel.SetSizer(scalingpanel_sizer)

   161

   162

            scaling_controls = []

   163

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

   164

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

   165

                if idx == 0:

   166

                    border = wx.TOP

   167

                else:

   168

                    border = wx.BOTTOM

   169

   170

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

   171

                scalingpanel_sizer.AddWindow(

   172

                    st, border=10,

   173

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

   174

   175

                sp = wx.SpinCtrl(scaling_panel,

   176

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

   177

                scaling_controls.append(sp)

   178

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

   179

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

   180

                sp.Bind(wx.EVT_KILL_FOCUS, callback)

   181

                scalingpanel_sizer.AddWindow(sp, border=10,

   182

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

   183

   184

            self.Scalings[language] = scaling_controls

   185

            scaling_nb.AddPage(scaling_panel, translation)

   186

   187

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

   188

   189

        # Miscellaneous Panel elements

   190

   191

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

   192

                                                name='MiscellaneousPanel',

   193

                                                pos=wx.Point(0, 0),

   194

                                                size=wx.Size(0, 0),

   195

                                                style=wx.TAB_TRAVERSAL)

   196

        self.MiscellaneousPanel.SetAutoLayout(1)

   197

        self.MiscellaneousPanel.SetupScrolling()

   198

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

   199

        miscellaneouspanel_sizer.AddGrowableCol(1)

   200

        miscellaneouspanel_sizer.AddGrowableRow(1)

   201

        self.MiscellaneousPanel.SetSizer(miscellaneouspanel_sizer)

   202

   203

        language_label = wx.StaticText(self.MiscellaneousPanel,

   204

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

   205

        miscellaneouspanel_sizer.AddWindow(language_label, border=10,

   206

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

   207

   208

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

   209

                                    style=wx.CB_READONLY)

   210

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

   211

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

   212

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

   213

   214

        description_label = wx.StaticText(

   215

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

   216

        miscellaneouspanel_sizer.AddWindow(description_label, border=10,

   217

                                           flag=wx.BOTTOM | wx.LEFT)

   218

   219

        self.ContentDescription = wx.TextCtrl(

   220

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

   221

            style=wx.TE_MULTILINE | wx.TE_PROCESS_ENTER)

   222

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

   223

                  self.ContentDescription)

   224

        self.ContentDescription.Bind(wx.EVT_KILL_FOCUS,

   225

                                     self.OnContentDescriptionChanged)

   226

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

   227

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

   228

   229

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

   230

   231

        for param in REQUIRED_PARAMS:

   232

            getattr(self, param).Enable(enable_required)

   233

   234

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

   235

   236

        for language in languages:

   237

            self.Language.Append(language)

   238

   239

    def RefreshView(self):

   240

        if self.Controller is not None:

   241

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

   242

   243

    def SetValues(self, values):

   244

        self.Values = values

   245

        for item, value in values.items():

   246

            if item == "language":

   247

                self.Language.SetStringSelection(value)

   248

            elif item == "contentDescription":

   249

                self.ContentDescription.SetValue(value)

   250

            elif item == "pageSize":

   251

                self.PageWidth.SetValue(value[0])

   252

                self.PageHeight.SetValue(value[1])

   253

            elif item == "scaling":

   254

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

   255

                    if language in self.Scalings:

   256

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

   257

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

   258

            else:

   259

                tc = getattr(self, item, None)

   260

                if tc is not None:

   261

                    tc.SetValue(value)

   262

   263

    def GetValues(self):

   264

        values = {}

   265

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

   266

                      "productName", "productVersion",

   267

                      "productRelease", "companyName",

   268

                      "companyURL", "authorName",

   269

                      "organization"]:

   270

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

   271

            if param in REQUIRED_PARAMS or value != "":

   272

                values[param] = value

   273

            else:

   274

                values[param] = None

   275

        language = self.Language.GetStringSelection()

   276

        if language != "":

   277

            values["language"] = language

   278

        else:

   279

            values["language"] = None

   280

        content_description = self.ContentDescription.GetValue()

   281

        if content_description != "":

   282

            values["contentDescription"] = content_description

   283

        else:

   284

            values["contentDescription"] = None

   285

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

   286

        values["scaling"] = {}

   287

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

   288

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

   289

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

   290

        return values

   291

   292

    def GetTextCtrlChangedFunction(self, textctrl, name):

   293

        def TextCtrlChangedFunction(event):

   294

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

   295

                old_value = self.Values.get(name)

   296

                new_value = textctrl.GetValue()

   297

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

   298

                    new_value = None

   299

                if old_value != new_value:

   300

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

   301

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

   302

                                               PROJECTTREE, PAGETITLES)

   303

                    wx.CallAfter(self.RefreshView)

   304

            event.Skip()

   305

        return TextCtrlChangedFunction

   306

   307

    def GetPageSizeChangedFunction(self, spinctrl, name):

   308

        def PageSizeChangedFunction(event):

   309

            if self.Controller is not None:

   310

                if self.Values is not None:

   311

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

   312

                else:

   313

                    old_value = (0, 0)

   314

                if name == 'PageWidth':

   315

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

   316

                else:

   317

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

   318

                if old_value != new_value:

   319

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

   320

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

   321

                                               PAGETITLES, SCALING)

   322

                    wx.CallAfter(self.RefreshView)

   323

            event.Skip()

   324

        return PageSizeChangedFunction

   325

   326

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

   327

        def ScalingChangedFunction(event):

   328

            if self.Controller is not None:

   329

                old_value = (0, 0)

   330

                if self.Values is not None:

   331

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

   332

                    if scaling is not None:

   333

                        old_value = scaling.get(language)

   334

                if name == 'XScale':

   335

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

   336

                else:

   337

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

   338

                if old_value != new_value:

   339

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

   340

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

   341

                                               PAGETITLES, SCALING)

   342

                    wx.CallAfter(self.RefreshView)

   343

            event.Skip()

   344

        return ScalingChangedFunction

   345

   346

    def OnLanguageChanged(self, event):

   347

        if self.Controller is not None:

   348

            if self.Values is not None:

   349

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

   350

            else:

   351

                old_value = None

   352

            new_value = self.Language.GetStringSelection()

   353

            if new_value == "":

   354

                new_value = None

   355

            if old_value != new_value:

   356

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

   357

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

   358

                wx.CallAfter(self.RefreshView)

   359

        event.Skip()

   360

   361

    def OnContentDescriptionChanged(self, event):

   362

        if self.Controller is not None:

   363

            if self.Values is not None:

   364

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

   365

            else:

   366

                old_value = None

   367

            new_value = self.ContentDescription.GetValue()

   368

            if new_value == "":

   369

                new_value = None

   370

            if old_value != new_value:

   371

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

   372

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

   373

                wx.CallAfter(self.RefreshView)

   374

        event.Skip()