controls/LibraryPanel.py
author Edouard Tisserant <edouard.tisserant@gmail.com>
Tue, 03 Dec 2024 21:22:45 +0100
changeset 4057 cf42c3dbdd5c
parent 3789 8def429216ca
permissions -rw-r--r--
IDE: Fix PLCOpenEditor (wxPython4 menus) and drop broken PDF doc support.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
     1
#!/usr/bin/env python
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
     2
# -*- coding: utf-8 -*-
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
     3
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
     4
# This file is part of Beremiz, a Integrated Development Environment for
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
     5
# programming IEC 61131-3 automates supporting plcopen standard and CanFestival.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
     6
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
     7
# Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
     8
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
     9
# See COPYING file for copyrights details.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    10
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    11
# This program is free software; you can redistribute it and/or
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    12
# modify it under the terms of the GNU General Public License
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    13
# as published by the Free Software Foundation; either version 2
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    14
# of the License, or (at your option) any later version.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    15
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    16
# This program is distributed in the hope that it will be useful,
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    17
# but WITHOUT ANY WARRANTY; without even the implied warranty of
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    18
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    19
# GNU General Public License for more details.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    20
#
1571
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    21
# You should have received a copy of the GNU General Public License
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    22
# along with this program; if not, write to the Free Software
486f94a8032c fix license notices in source files and license files under GPLv2+
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1528
diff changeset
    23
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    24
3750
f62625418bff automated conversion using 2to3-3.9 tool
GP Orcullo <kinsamanka@gmail.com>
parents: 3303
diff changeset
    25
2456
7373e3048167 python3 support: pylint,W1610 # (reduce-builtin) reduce built-in referenced
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1881
diff changeset
    26
from functools import reduce
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    27
import wx
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    28
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    29
# -------------------------------------------------------------------------------
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    30
#                                 Helpers
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    31
# -------------------------------------------------------------------------------
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    32
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    33
3750
f62625418bff automated conversion using 2to3-3.9 tool
GP Orcullo <kinsamanka@gmail.com>
parents: 3303
diff changeset
    34
[CATEGORY, BLOCK] = list(range(2))
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    35
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    36
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    37
# -------------------------------------------------------------------------------
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    38
#                              Library Panel
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1768
diff changeset
    39
# -------------------------------------------------------------------------------
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    40
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    41
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    42
class LibraryPanel(wx.Panel):
1736
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    43
    """
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    44
    Class that implements a panel displaying a tree containing an hierarchical list
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    45
    of functions and function blocks available in project an a search control for
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    46
    quickly find one functions or function blocks in this list and a text control
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    47
    displaying informations about selected functions or function blocks
7e61baa047f0 clean-up: fix PEP8 E302 expected 2 blank lines, found 1
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1730
diff changeset
    48
    """
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    49
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    50
    def __init__(self, parent, enable_drag=False):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    51
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    52
        Constructor
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    53
        @param parent: Parent wx.Window of LibraryPanel
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    54
        @param enable_drag: Flag indicating that function or function block can
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    55
        be drag'n drop from LibraryPanel (default: False)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    56
        """
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    57
        wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    58
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    59
        # Define LibraryPanel main sizer
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    60
        main_sizer = wx.FlexGridSizer(cols=1, hgap=0, rows=2, vgap=0)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    61
        main_sizer.AddGrowableCol(0)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    62
        main_sizer.AddGrowableRow(1)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    63
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    64
        # Add SearchCtrl to main sizer
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    65
        self.SearchCtrl = wx.SearchCtrl(self)
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    66
        # Add a button with a magnifying glass, essentially to show that this
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    67
        # control is for searching in tree
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    68
        self.SearchCtrl.ShowSearchButton(True)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    69
        self.Bind(wx.EVT_TEXT, self.OnSearchCtrlChanged, self.SearchCtrl)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    70
        self.Bind(wx.EVT_SEARCHCTRL_SEARCH_BTN,
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    71
                  self.OnSearchButtonClick, self.SearchCtrl)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    72
        # Bind keyboard event on SearchCtrl text control to catch UP and DOWN
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    73
        # for search previous and next occurrence
1528
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    74
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    75
        # This protects from fail to start when no children[0] available (possible for wxPython 3.0)
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    76
        if self.SearchCtrl.GetChildren():
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    77
            search_textctrl = self.SearchCtrl.GetChildren()[0]
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    78
            search_textctrl.Bind(wx.EVT_CHAR, self.OnKeyDown)
d551f2925a86 Fixed crash when starts on OS X with wxPython 3.0.x
alexander@macbook-pro-alexander.local
parents: 1501
diff changeset
    79
3303
0ffb41625592 Preliminary support for WxPython 4.1.0. Needs more testing. Grid selection/focus seems broken, and probably many other bugs hidden in dialogs and editors.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2456
diff changeset
    80
        main_sizer.Add(self.SearchCtrl, flag=wx.GROW)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    81
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    82
        # Add Splitter window for tree and block comment to main sizer
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    83
        splitter_window = wx.SplitterWindow(self)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    84
        splitter_window.SetSashGravity(1.0)
3303
0ffb41625592 Preliminary support for WxPython 4.1.0. Needs more testing. Grid selection/focus seems broken, and probably many other bugs hidden in dialogs and editors.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2456
diff changeset
    85
        main_sizer.Add(splitter_window, flag=wx.GROW)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
    86
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    87
        # Add TreeCtrl for functions and function blocks library in splitter
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    88
        # window
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    89
        self.Tree = wx.TreeCtrl(splitter_window,
1768
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    90
                                size=wx.Size(0, 0),
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    91
                                style=(wx.TR_HAS_BUTTONS |
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    92
                                       wx.TR_SINGLE |
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    93
                                       wx.SUNKEN_BORDER |
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    94
                                       wx.TR_HIDE_ROOT |
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
    95
                                       wx.TR_LINES_AT_ROOT))
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    96
        self.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeItemSelected, self.Tree)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
    97
        self.Tree.Bind(wx.EVT_CHAR, self.OnKeyDown)
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    98
        # If drag'n drop is enabled, bind event generated when a drag begins on
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
    99
        # tree to start a drag'n drop
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   100
        if enable_drag:
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   101
            self.Bind(wx.EVT_TREE_BEGIN_DRAG, self.OnTreeBeginDrag, self.Tree)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   102
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   103
        # Add TextCtrl for function and function block informations
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   104
        self.Comment = wx.TextCtrl(splitter_window, size=wx.Size(0, 80),
1768
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   105
                                   style=wx.TE_READONLY | wx.TE_MULTILINE)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   106
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   107
        splitter_window.SplitHorizontally(self.Tree, self.Comment, -80)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   108
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   109
        self.SetSizer(main_sizer)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   110
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   111
        # Reference to the project controller
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   112
        self.Controller = None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   113
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   114
        # Variable storing functions and function blocks library to display
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   115
        self.BlockList = None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   116
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   117
    def SetController(self, controller):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   118
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   119
        Set reference to project controller
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   120
        @param controller: Reference to project controller
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   121
        """
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   122
        self.Controller = controller
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   123
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   124
    def SetBlockList(self, blocklist):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   125
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   126
        Set function and function block library to display in TreeCtrl
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   127
        @param blocklist: Function and function block library
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   128
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   129
        # Save functions and function blocks library
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   130
        self.BlockList = blocklist
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   131
        # Refresh TreeCtrl values
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   132
        self.RefreshTree()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   133
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   134
    def SetFocus(self):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   135
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   136
        Called to give focus to LibraryPanel
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   137
        Override wx.Window SetFocus method
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   138
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   139
        # Give focus to SearchCtrl
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   140
        self.SearchCtrl.SetFocus()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   141
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   142
    def ResetTree(self):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   143
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   144
        Reset LibraryPanel values displayed in controls
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   145
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   146
        # Clear SearchCtrl, TreeCtrl and TextCtrl
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   147
        self.SearchCtrl.SetValue("")
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   148
        self.Tree.DeleteAllItems()
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   149
        self.Comment.SetValue("")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   150
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   151
    def RefreshTree(self):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   152
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   153
        Refresh LibraryPanel values displayed in controls
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   154
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   155
        # Get function and function blocks library
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   156
        blocktypes = self.BlockList
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   157
        if blocktypes is None and self.Controller is not None:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   158
            # Get library from project controller if not defined
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   159
            blocktypes = self.Controller.GetBlockTypes()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   160
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   161
        # Refresh TreeCtrl values if a library is defined
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   162
        if blocktypes is not None:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   163
            # List that will contain tree items to be deleted when TreeCtrl
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   164
            # will be refreshed
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   165
            items_to_delete = []
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   166
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   167
            # Get current selected item for selected it when values refreshed
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   168
            selected_item = self.Tree.GetSelection()
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   169
            selected_pydata = (self.Tree.GetItemData(selected_item)
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   170
                               if (selected_item.IsOk() and
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   171
                                   selected_item != self.Tree.GetRootItem())
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   172
                               else None)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   173
            # Don't save selected item if it is a category
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   174
            selected_infos = ((self.Tree.GetItemText(selected_item),
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   175
                               selected_pydata["inputs"])
1768
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   176
                              if (selected_pydata is not None and
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   177
                                  selected_pydata["type"] == BLOCK)
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   178
                              else (None, None))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   179
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   180
            # Get TreeCtrl root item (hidden)
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   181
            root = self.Tree.GetRootItem()
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   182
            if not root.IsOk():
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   183
                # Create root if not present
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   184
                root = self.Tree.AddRoot("")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   185
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   186
            # Iterate over functions and function blocks library categories and
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   187
            # add a tree item to root item for each of them
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   188
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   189
            # Get first child under root item
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   190
            category_item, root_cookie = self.Tree.GetFirstChild(root)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   191
            for category in blocktypes:
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   192
                # Store category name in a local variable to prevent script
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   193
                # extracting translated strings for gettext to consider "name"
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   194
                # to be translated
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   195
                category_name = category["name"]
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   196
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   197
                # Tree item already exists, set item label
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   198
                if category_item.IsOk():
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   199
                    self.Tree.SetItemText(category_item, _(category_name))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   200
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   201
                # Tree item doesn't exist, add new one to root
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   202
                else:
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   203
                    category_item = self.Tree.AppendItem(root, _(category_name))
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   204
                    # On Windows, needs to get next child of root to have a
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   205
                    # reference to the newly added tree item
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   206
                    if wx.Platform != '__WXMSW__':
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   207
                        category_item, root_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   208
                            self.Tree.GetNextChild(root, root_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   209
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   210
                # Set data associated to tree item (only save that item is a
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   211
                # category)
3303
0ffb41625592 Preliminary support for WxPython 4.1.0. Needs more testing. Grid selection/focus seems broken, and probably many other bugs hidden in dialogs and editors.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2456
diff changeset
   212
                self.Tree.SetItemData(category_item, {"type": CATEGORY})
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   213
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   214
                # Iterate over functions and function blocks defined in library
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   215
                # category add a tree item to category tree item for each of
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   216
                # them
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   217
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   218
                # Get first child under category tree item
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   219
                blocktype_item, category_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   220
                    self.Tree.GetFirstChild(category_item)
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   221
                for blocktype in category["list"]:
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   222
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   223
                    # Tree item already exists, set item label
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   224
                    if blocktype_item.IsOk():
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   225
                        self.Tree.SetItemText(blocktype_item, blocktype["name"])
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   226
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   227
                    # Tree item doesn't exist, add new one to category item
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   228
                    else:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   229
                        blocktype_item = self.Tree.AppendItem(
1878
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1847
diff changeset
   230
                            category_item, blocktype["name"])
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   231
                        # See comment when adding category
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   232
                        if wx.Platform != '__WXMSW__':
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   233
                            blocktype_item, category_cookie = \
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   234
                                self.Tree.GetNextChild(category_item,
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   235
                                                       category_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   236
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   237
                    # Define data to associate to block tree item
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   238
                    comment = blocktype["comment"]
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   239
                    block_data = {
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   240
                        "type":       BLOCK,
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   241
                        "block_type": blocktype["type"],
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   242
                        "inputs":     tuple([type
1847
6198190bc121 explicitly mark unused variables found by pylint with _ or dummy
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1782
diff changeset
   243
                                             for _name, type, _modifier
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   244
                                             in blocktype["inputs"]]),
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   245
                        "extension":  (len(blocktype["inputs"])
1768
691083b5682a clean-up: fix PEP8 E128 continuation line under-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1767
diff changeset
   246
                                       if blocktype["extensible"] else None),
1739
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   247
                        "comment":    _(comment) + blocktype.get("usage", "")
ec153828ded2 clean-up: fix PEP8 E203 whitespace before ':' and whitespace before ','
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1736
diff changeset
   248
                    }
3303
0ffb41625592 Preliminary support for WxPython 4.1.0. Needs more testing. Grid selection/focus seems broken, and probably many other bugs hidden in dialogs and editors.
Edouard Tisserant <edouard.tisserant@gmail.com>
parents: 2456
diff changeset
   249
                    self.Tree.SetItemData(blocktype_item, block_data)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   250
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   251
                    # Select block tree item in tree if it corresponds to
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   252
                    # previously selected one
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   253
                    if selected_infos == (blocktype["name"],
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   254
                                          blocktype["inputs"]):
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   255
                        self.Tree.SelectItem(blocktype_item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   256
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   257
                        # Update TextCtrl value
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   258
                        self.Comment.SetValue(block_data["comment"])
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   259
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   260
                    # Get next block tree item under category tree item
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   261
                    blocktype_item, category_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   262
                        self.Tree.GetNextChild(category_item, category_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   263
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   264
                # Add every remaining tree item under category tree item after
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   265
                # updating all block items to the list of items to delete
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   266
                while blocktype_item.IsOk():
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   267
                    items_to_delete.append(blocktype_item)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   268
                    blocktype_item, category_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   269
                        self.Tree.GetNextChild(category_item, category_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   270
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   271
                # Get next category tree item under root item
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   272
                category_item, root_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   273
                    self.Tree.GetNextChild(root, root_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   274
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   275
            # Add every remaining tree item under root item after updating all
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   276
            # category items to the list of items to delete
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   277
            while category_item.IsOk():
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   278
                items_to_delete.append(category_item)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   279
                category_item, root_cookie = \
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   280
                    self.Tree.GetNextChild(root, root_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   281
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   282
            # Remove all items in list of items to delete from TreeCtrl
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   283
            for item in items_to_delete:
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   284
                self.Tree.Delete(item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   285
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   286
    def GetSelectedBlock(self):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   287
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   288
        Get selected block informations
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   289
        @return: {"type": block_type_name, "inputs": [input_type,...]} or None
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   290
        if no block selected
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   291
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   292
        # Get selected item associated data in tree
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   293
        selected_item = self.Tree.GetSelection()
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   294
        selected_pydata = (self.Tree.GetItemData(selected_item)
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   295
                           if (selected_item.IsOk() and
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   296
                               selected_item != self.Tree.GetRootItem())
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   297
                           else None)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   298
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   299
        # Return value is None if selected tree item is root or a category
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   300
        return ({"type": self.Tree.GetItemText(selected_item),
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   301
                 "inputs": selected_pydata["inputs"]}
1767
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   302
                if (selected_pydata is not None and
c74815729afd clean-up: fix PEP8 E127 continuation line over-indented for visual indent
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1754
diff changeset
   303
                    selected_pydata["type"] == BLOCK)
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   304
                else None)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   305
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   306
    def SelectTreeItem(self, name, inputs):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   307
        """
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   308
        Select Tree item corresponding to block informations given
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   309
        @param name: Block type name
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   310
        @param inputs: List of block inputs type [input_type,...]
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   311
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   312
        # Find tree item corresponding to block informations
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   313
        item = self.FindTreeItem(self.Tree.GetRootItem(), name, inputs)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   314
        if item is not None and item.IsOk():
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   315
            # Select tree item found
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   316
            self.Tree.SelectItem(item)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   317
            self.Tree.EnsureVisible(item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   318
1744
69dfdb26f600 clean-up: fix PEP8 E251 unexpected spaces around keyword / parameter equals
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1742
diff changeset
   319
    def FindTreeItem(self, item, name, inputs=None):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   320
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   321
        Find Tree item corresponding to block informations given
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   322
        Function is recursive
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   323
        @param item: Item to test
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   324
        @param name: Block type name
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   325
        @param inputs: List of block inputs type [input_type,...]
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   326
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   327
        # Return immediately if item isn't valid
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   328
        if not item.IsOk():
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   329
            return None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   330
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   331
        # Get data associated to item to test
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   332
        item_pydata = self.Tree.GetItemData(item)
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   333
        if item_pydata is not None and item_pydata["type"] == BLOCK:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   334
            # Only test item corresponding to block
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   335
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   336
            # Test if block inputs type are the same than those given
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   337
            type_inputs = item_pydata.get("inputs", None)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   338
            type_extension = item_pydata.get("extension", None)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   339
            if inputs is not None and type_inputs is not None:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   340
                same_inputs = reduce(
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   341
                    lambda x, y: x and y,
3750
f62625418bff automated conversion using 2to3-3.9 tool
GP Orcullo <kinsamanka@gmail.com>
parents: 3303
diff changeset
   342
                    [x[0] == x[1] or x[0] == 'ANY' or x[1] == 'ANY' for x in zip(type_inputs,
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   343
                            (inputs[:type_extension]
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   344
                             if type_extension is not None
3750
f62625418bff automated conversion using 2to3-3.9 tool
GP Orcullo <kinsamanka@gmail.com>
parents: 3303
diff changeset
   345
                             else inputs))],
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   346
                    True)
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   347
            else:
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   348
                same_inputs = True
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   349
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   350
            # Return item if  block data corresponds to informations given
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   351
            if self.Tree.GetItemText(item) == name and same_inputs:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   352
                return item
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   353
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   354
        # Test item children if item doesn't correspond
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   355
        child, child_cookie = self.Tree.GetFirstChild(item)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   356
        while child.IsOk():
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   357
            result = self.FindTreeItem(child, name, inputs)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   358
            if result:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   359
                return result
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   360
            child, child_cookie = self.Tree.GetNextChild(item, child_cookie)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   361
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   362
        return None
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   363
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   364
    def SearchInTree(self, value, mode="first"):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   365
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   366
        Search in Tree and select item that name contains string given
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   367
        @param value: String contained in block name to find
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   368
        @param mode: Search mode ('first', 'previous' or 'next')
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   369
        (default: 'first')
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   370
        @return: True if an item was found
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   371
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   372
        # Return immediately if root isn't valid
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   373
        root = self.Tree.GetRootItem()
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   374
        if not root.IsOk():
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   375
            return False
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   376
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   377
        # Set function to navigate in Tree item sibling according to search
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   378
        # mode defined
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   379
        sibling_function = (self.Tree.GetPrevSibling
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   380
                            if mode == "previous"
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   381
                            else self.Tree.GetNextSibling)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   382
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   383
        # Get current selected item (for next and previous mode)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   384
        item = self.Tree.GetSelection()
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   385
        if not item.IsOk() or mode == "first":
1847
6198190bc121 explicitly mark unused variables found by pylint with _ or dummy
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1782
diff changeset
   386
            item, _item_cookie = self.Tree.GetFirstChild(root)
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   387
            selected = None
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   388
        else:
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   389
            selected = item
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   390
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   391
        # Navigate through tree items until one matching found or reach tree
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   392
        # starting or ending
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   393
        while item.IsOk():
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   394
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   395
            # Get item data to get item type
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   396
            item_pydata = self.Tree.GetItemData(item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   397
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   398
            # Item is a block category
1501
d917c209529d fix Traceback if search icon on library panel is clicked, when no
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1235
diff changeset
   399
            if (item == root) or item_pydata["type"] == CATEGORY:
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   400
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   401
                # Get category first or last child according to search mode
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   402
                # defined
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   403
                child = (self.Tree.GetLastChild(item)
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   404
                         if mode == "previous"
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   405
                         else self.Tree.GetFirstChild(item)[0])
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   406
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   407
                # If category has no child, go to sibling category
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   408
                item = (child if child.IsOk() else sibling_function(item))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   409
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   410
            # Item is a block
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   411
            else:
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   412
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   413
                # Extract item block name
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   414
                name = self.Tree.GetItemText(item)
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   415
                # Test if block name contains string given
1068
ef088254ba4b Modify search algorithm in LibraryPanel to search match in whole block name, not only at beginning
Laurent Bessard
parents: 814
diff changeset
   416
                if name.upper().find(value.upper()) != -1 and item != selected:
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   417
                    # Select block and collapse all categories other than block
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   418
                    # category
1235
1a30c70fa025 Fixed bug when searching in LibraryPanel on Windows
Laurent Bessard
parents: 1230
diff changeset
   419
                    child, child_cookie = self.Tree.GetFirstChild(root)
1a30c70fa025 Fixed bug when searching in LibraryPanel on Windows
Laurent Bessard
parents: 1230
diff changeset
   420
                    while child.IsOk():
1a30c70fa025 Fixed bug when searching in LibraryPanel on Windows
Laurent Bessard
parents: 1230
diff changeset
   421
                        self.Tree.CollapseAllChildren(child)
1a30c70fa025 Fixed bug when searching in LibraryPanel on Windows
Laurent Bessard
parents: 1230
diff changeset
   422
                        child, child_cookie = self.Tree.GetNextChild(root, child_cookie)
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   423
                    self.Tree.SelectItem(item)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   424
                    self.Tree.EnsureVisible(item)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   425
                    return True
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   426
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   427
                # Go to next item sibling if block not found
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   428
                next = sibling_function(item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   429
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   430
                # If category has no other child, go to next category sibling
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   431
                item = (next
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   432
                        if next.IsOk()
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   433
                        else sibling_function(self.Tree.GetItemParent(item)))
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   434
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   435
        return False
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   436
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   437
    def OnSearchCtrlChanged(self, event):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   438
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   439
        Called when SearchCtrl text control value changed
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   440
        @param event: TextCtrl change event
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   441
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   442
        # Search for block containing SearchCtrl value in 'first' mode
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   443
        self.SearchInTree(self.SearchCtrl.GetValue())
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   444
        event.Skip()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   445
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   446
    def OnSearchButtonClick(self, event):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   447
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   448
        Called when SearchCtrl search button was clicked
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   449
        @param event: Button clicked event
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   450
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   451
        # Search for block containing SearchCtrl value in 'next' mode
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   452
        self.SearchInTree(self.SearchCtrl.GetValue(), "next")
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   453
        event.Skip()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   454
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   455
    def OnTreeItemSelected(self, event):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   456
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   457
        Called when tree item is selected
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   458
        @param event: wx.TreeEvent
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   459
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   460
        # Update TextCtrl value with block selected usage
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   461
        item_pydata = self.Tree.GetItemData(event.GetItem())
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   462
        self.Comment.SetValue(
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   463
            item_pydata["comment"]
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   464
            if item_pydata is not None and item_pydata["type"] == BLOCK
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   465
            else "")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   466
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   467
        # Call extra function defined when tree item is selected
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   468
        if getattr(self, "_OnTreeItemSelected", None) is not None:
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   469
            self._OnTreeItemSelected(event)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   470
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   471
        event.Skip()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   472
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   473
    def OnTreeBeginDrag(self, event):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   474
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   475
        Called when a drag is started in tree
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   476
        @param event: wx.TreeEvent
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   477
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   478
        selected_item = event.GetItem()
3789
8def429216ca fix wxPyDeprecationWarnings
GP Orcullo <kinsamanka@gmail.com>
parents: 3765
diff changeset
   479
        item_pydata = self.Tree.GetItemData(selected_item)
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   480
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   481
        # Item dragged is a block
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   482
        if item_pydata is not None and item_pydata["type"] == BLOCK:
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   483
            # Start a drag'n drop
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   484
            data = wx.TextDataObject(str(
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   485
                (self.Tree.GetItemText(selected_item),
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   486
                 item_pydata["block_type"],
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   487
                 "",
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   488
                 item_pydata["inputs"])))
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   489
            dragSource = wx.DropSource(self.Tree)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   490
            dragSource.SetData(data)
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   491
            dragSource.DoDragDrop()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   492
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   493
    def OnKeyDown(self, event):
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   494
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   495
        Called when key is pressed in SearchCtrl text control
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   496
        @param event: wx.KeyEvent
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   497
        """
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   498
        # Get event keycode and value in SearchCtrl
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   499
        keycode = event.GetKeyCode()
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   500
        search_value = self.SearchCtrl.GetValue()
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   501
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   502
        # Up key was pressed and SearchCtrl isn't empty, search for block in
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   503
        # 'previous' mode
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   504
        if keycode == wx.WXK_UP and search_value != "":
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   505
            self.SearchInTree(search_value, "previous")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   506
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   507
        # Down key was pressed and SearchCtrl isn't empty, search for block in
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   508
        # 'next' mode
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   509
        elif keycode == wx.WXK_DOWN and search_value != "":
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   510
            self.SearchInTree(search_value, "next")
1730
64d8f52bc8c8 clean-up for PEP8: fix W291 trailing whitespace
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1571
diff changeset
   511
1230
5a4c5724788e Fixed and rewrite LibraryPanel
Laurent Bessard
parents: 1223
diff changeset
   512
        # Handle key normally
814
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   513
        else:
5743cbdff669 Integration of PLCOpenEditor into Beremiz
Laurent Bessard
parents:
diff changeset
   514
            event.Skip()