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

    29

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

    30

#                                 Helpers

    31

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

    32

    33

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

    34

    35

[

    36

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

    37

    POUINSTANCEVARIABLESPANEL, LIBRARYTREE, SCALING, PAGETITLES

    38

] = range(10)

    39

    40

    41

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

    42

#                       Project Properties Panel

    43

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

    44

    45

    46

class ProjectPropertiesPanel(wx.Notebook):

    47

    48

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

    49

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

    50

            border = 0

    51

            if idx == 0:

    52

                border |= wx.TOP

    53

            elif idx == len(params) - 1:

    54

                border |= wx.BOTTOM

    55

    56

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

    57

            sizer.AddWindow(st, border=10,

    58

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

    59

    60

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

    61

            setattr(self, name, tc)

    62

            callback = self.GetTextCtrlChangedFunction(tc, name)

    63

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

    64

            tc.Bind(wx.EVT_KILL_FOCUS, callback)

    65

            sizer.AddWindow(tc, border=10,

    66

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

    67

    68

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

    69

        wx.Notebook.__init__(self, parent)

    70

    71

        self.Controller = controller

    72

        self.ParentWindow = window

    73

        self.Values = None

    74

    75

        # Project Panel elements

    76

    77

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

    78

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

    79

        projectpanel_sizer.AddGrowableCol(1)

    80

        self.ProjectPanel.SetSizer(projectpanel_sizer)

    81

    82

        self.AddSizerParams(self.ProjectPanel, projectpanel_sizer,

    83

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

    84

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

    85

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

    86

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

    87

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

    88

    89

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

    90

    91

        # Author Panel elements

    92

    93

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

    94

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

    95

        authorpanel_sizer.AddGrowableCol(1)

    96

        self.AuthorPanel.SetSizer(authorpanel_sizer)

    97

    98

        self.AddSizerParams(self.AuthorPanel, authorpanel_sizer,

    99

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

   100

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

   101

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

   102

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

   103

   104

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

   105

   106

        # Graphics Panel elements

   107

   108

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

   109

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

   110

        graphicpanel_sizer.AddGrowableCol(0)

   111

        graphicpanel_sizer.AddGrowableRow(3)

   112

        self.GraphicsPanel.SetSizer(graphicpanel_sizer)

   113

   114

        pageSize_st = wx.StaticText(self.GraphicsPanel,

   115

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

   116

        graphicpanel_sizer.AddWindow(

   117

            pageSize_st, border=10,

   118

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

   119

   120

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

   121

        pageSize_sizer.AddGrowableCol(1)

   122

        graphicpanel_sizer.AddSizer(pageSize_sizer, border=10,

   123

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

   124

   125

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

   126

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

   127

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

   128

            pageSize_sizer.AddWindow(st, border=12,

   129

                                     flag=wx.ALIGN_CENTER_VERTICAL | wx.LEFT)

   130

   131

            sp = wx.SpinCtrl(self.GraphicsPanel,

   132

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

   133

            setattr(self, name, sp)

   134

            callback = self.GetPageSizeChangedFunction(sp, name)

   135

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

   136

            sp.Bind(wx.EVT_KILL_FOCUS, callback)

   137

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

   138

   139

        scaling_st = wx.StaticText(self.GraphicsPanel,

   140

                                   label=_('Grid Resolution:'))

   141

        graphicpanel_sizer.AddWindow(scaling_st, border=10,

   142

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

   143

   144

        scaling_nb = wx.Notebook(self.GraphicsPanel)

   145

        graphicpanel_sizer.AddWindow(scaling_nb, border=10,

   146

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

   147

   148

        self.Scalings = {}

   149

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

   150

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

   151

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

   152

            scalingpanel_sizer.AddGrowableCol(1)

   153

            scaling_panel.SetSizer(scalingpanel_sizer)

   154

   155

            scaling_controls = []

   156

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

   157

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

   158

                if idx == 0:

   159

                    border = wx.TOP

   160

                else:

   161

                    border = wx.BOTTOM

   162

   163

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

   164

                scalingpanel_sizer.AddWindow(

   165

                    st, border=10,

   166

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

   167

   168

                sp = wx.SpinCtrl(scaling_panel,

   169

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

   170

                scaling_controls.append(sp)

   171

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

   172

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

   173

                sp.Bind(wx.EVT_KILL_FOCUS, callback)

   174

                scalingpanel_sizer.AddWindow(sp, border=10,

   175

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

   176

   177

            self.Scalings[language] = scaling_controls

   178

            scaling_nb.AddPage(scaling_panel, translation)

   179

   180

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

   181

   182

        # Miscellaneous Panel elements

   183

   184

        self.MiscellaneousPanel = wx.Panel(

   185

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

   186

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

   187

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

   188

        miscellaneouspanel_sizer.AddGrowableCol(1)

   189

        miscellaneouspanel_sizer.AddGrowableRow(1)

   190

        self.MiscellaneousPanel.SetSizer(miscellaneouspanel_sizer)

   191

   192

        language_label = wx.StaticText(self.MiscellaneousPanel,

   193

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

   194

        miscellaneouspanel_sizer.AddWindow(language_label, border=10,

   195

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

   196

   197

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

   198

                                    style=wx.CB_READONLY)

   199

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

   200

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

   201

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

   202

   203

        description_label = wx.StaticText(

   204

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

   205

        miscellaneouspanel_sizer.AddWindow(description_label, border=10,

   206

                                           flag=wx.BOTTOM | wx.LEFT)

   207

   208

        self.ContentDescription = wx.TextCtrl(

   209

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

   210

            style=wx.TE_MULTILINE | wx.TE_PROCESS_ENTER)

   211

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

   212

                  self.ContentDescription)

   213

        self.ContentDescription.Bind(wx.EVT_KILL_FOCUS,

   214

                                     self.OnContentDescriptionChanged)

   215

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

   216

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

   217

   218

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

   219

   220

        for param in REQUIRED_PARAMS:

   221

            getattr(self, param).Enable(enable_required)

   222

   223

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

   224

   225

        for language in languages:

   226

            self.Language.Append(language)

   227

   228

    def RefreshView(self):

   229

        if self.Controller is not None:

   230

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

   231

   232

    def SetValues(self, values):

   233

        self.Values = values

   234

        for item, value in values.items():

   235

            if item == "language":

   236

                self.Language.SetStringSelection(value)

   237

            elif item == "contentDescription":

   238

                self.ContentDescription.SetValue(value)

   239

            elif item == "pageSize":

   240

                self.PageWidth.SetValue(value[0])

   241

                self.PageHeight.SetValue(value[1])

   242

            elif item == "scaling":

   243

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

   244

                    if language in self.Scalings:

   245

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

   246

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

   247

            else:

   248

                tc = getattr(self, item, None)

   249

                if tc is not None:

   250

                    tc.SetValue(value)

   251

   252

    def GetValues(self):

   253

        values = {}

   254

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

   255

                      "productName", "productVersion",

   256

                      "productRelease", "companyName",

   257

                      "companyURL", "authorName",

   258

                      "organization"]:

   259

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

   260

            if param in REQUIRED_PARAMS or value != "":

   261

                values[param] = value

   262

            else:

   263

                values[param] = None

   264

        language = self.Language.GetStringSelection()

   265

        if language != "":

   266

            values["language"] = language

   267

        else:

   268

            values["language"] = None

   269

        content_description = self.ContentDescription.GetValue()

   270

        if content_description != "":

   271

            values["contentDescription"] = content_description

   272

        else:

   273

            values["contentDescription"] = None

   274

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

   275

        values["scaling"] = {}

   276

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

   277

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

   278

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

   279

        return values

   280

   281

    def GetTextCtrlChangedFunction(self, textctrl, name):

   282

        def TextCtrlChangedFunction(event):

   283

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

   284

                old_value = self.Values.get(name)

   285

                new_value = textctrl.GetValue()

   286

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

   287

                    new_value = None

   288

                if old_value != new_value:

   289

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

   290

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

   291

                                               PROJECTTREE, PAGETITLES)

   292

                    wx.CallAfter(self.RefreshView)

   293

            event.Skip()

   294

        return TextCtrlChangedFunction

   295

   296

    def GetPageSizeChangedFunction(self, spinctrl, name):

   297

        def PageSizeChangedFunction(event):

   298

            if self.Controller is not None:

   299

                if self.Values is not None:

   300

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

   301

                else:

   302

                    old_value = (0, 0)

   303

                if name == 'PageWidth':

   304

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

   305

                else:

   306

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

   307

                if old_value != new_value:

   308

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

   309

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

   310

                                               PAGETITLES, SCALING)

   311

                    wx.CallAfter(self.RefreshView)

   312

            event.Skip()

   313

        return PageSizeChangedFunction

   314

   315

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

   316

        def ScalingChangedFunction(event):

   317

            if self.Controller is not None:

   318

                old_value = (0, 0)

   319

                if self.Values is not None:

   320

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

   321

                    if scaling is not None:

   322

                        old_value = scaling.get(language)

   323

                if name == 'XScale':

   324

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

   325

                else:

   326

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

   327

                if old_value != new_value:

   328

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

   329

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

   330

                                               PAGETITLES, SCALING)

   331

                    wx.CallAfter(self.RefreshView)

   332

            event.Skip()

   333

        return ScalingChangedFunction

   334

   335

    def OnLanguageChanged(self, event):

   336

        if self.Controller is not None:

   337

            if self.Values is not None:

   338

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

   339

            else:

   340

                old_value = None

   341

            new_value = self.Language.GetStringSelection()

   342

            if new_value == "":

   343

                new_value = None

   344

            if old_value != new_value:

   345

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

   346

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

   347

                wx.CallAfter(self.RefreshView)

   348

        event.Skip()

   349

   350

    def OnContentDescriptionChanged(self, event):

   351

        if self.Controller is not None:

   352

            if self.Values is not None:

   353

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

   354

            else:

   355

                old_value = None

   356

            new_value = self.ContentDescription.GetValue()

   357

            if new_value == "":

   358

                new_value = None

   359

            if old_value != new_value:

   360

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

   361

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

   362

                wx.CallAfter(self.RefreshView)

   363

        event.Skip()