controls/EditorPanel.py
author Laurent Bessard
Mon, 25 Jun 2012 20:03:53 +0200
changeset 714 131ea7f237b9
parent 687 629680fb0582
child 718 0183a66eddf9
permissions -rw-r--r--
Replacing buttons with text by buttons with icons
Adding support for bitmap library to have a common API for icon request handling
Simplify wx controls and sizers creation in dialogs and custom controls and panels
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     1
#!/usr/bin/env python
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     2
# -*- coding: utf-8 -*-
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     3
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     4
#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     5
#based on the plcopen standard. 
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     6
#
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     7
#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     8
#
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
     9
#See COPYING file for copyrights details.
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    10
#
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    11
#This library is free software; you can redistribute it and/or
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    12
#modify it under the terms of the GNU General Public
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    13
#License as published by the Free Software Foundation; either
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    14
#version 2.1 of the License, or (at your option) any later version.
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    15
#
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    16
#This library is distributed in the hope that it will be useful,
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    17
#but WITHOUT ANY WARRANTY; without even the implied warranty of
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    18
#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    19
#General Public License for more details.
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    20
#
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    21
#You should have received a copy of the GNU General Public
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    22
#License along with this library; if not, write to the Free Software
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    23
#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    24
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    25
import wx
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    26
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    27
from VariablePanel import VariablePanel
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    28
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    29
class EditorPanel(wx.SplitterWindow):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    30
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    31
    VARIABLE_PANEL_TYPE = None
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    32
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    33
    def _init_Editor(self, prnt):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    34
        self.Editor = None
635
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
    35
    
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
    36
    def _init_MenuItems(self):
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
    37
        self.MenuItems = []
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
    38
    
714
131ea7f237b9 Replacing buttons with text by buttons with icons
Laurent Bessard
parents: 687
diff changeset
    39
    def _init_ctrls(self, parent):
131ea7f237b9 Replacing buttons with text by buttons with icons
Laurent Bessard
parents: 687
diff changeset
    40
        wx.SplitterWindow.__init__(self, parent,
131ea7f237b9 Replacing buttons with text by buttons with icons
Laurent Bessard
parents: 687
diff changeset
    41
              style=wx.SUNKEN_BORDER|wx.SP_3D)
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    42
        self.SetNeedUpdating(True)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    43
        self.SetMinimumPaneSize(1)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    44
        
635
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
    45
        self._init_MenuItems()
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    46
        
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    47
        if self.VARIABLE_PANEL_TYPE is not None:
600
7db729686416 Making variable panel not editable when showing variables of debugging block
laurent
parents: 586
diff changeset
    48
            self.VariableEditor = VariablePanel(self, self, self.Controler, self.VARIABLE_PANEL_TYPE, self.Debug)
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    49
            self.VariableEditor.SetTagName(self.TagName)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    50
        else:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    51
            self.VariableEditor = None
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    52
            
655
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    53
        self._init_Editor(self)
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    54
            
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    55
        if self.Editor is not None and self.VariableEditor is not None:
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    56
            self.SplitHorizontally(self.VariableEditor, self.Editor, 200)
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    57
        elif self.VariableEditor is not None:
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    58
            self.Initialize(self.VariableEditor)
435e2d8ee580 Fixing issues regarding control navigation in EditorPanel and CustomGrid
laurent
parents: 635
diff changeset
    59
        elif self.Editor is not None:
687
629680fb0582 refactoring
laurent
parents: 681
diff changeset
    60
            self.Initialize(self.Editor)
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    61
        
600
7db729686416 Making variable panel not editable when showing variables of debugging block
laurent
parents: 586
diff changeset
    62
    def __init__(self, parent, tagname, window, controler, debug=False):
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    63
        self.ParentWindow = window
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    64
        self.Controler = controler
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    65
        self.TagName = tagname
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    66
        self.Icon = None
600
7db729686416 Making variable panel not editable when showing variables of debugging block
laurent
parents: 586
diff changeset
    67
        self.Debug = debug
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    68
        
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    69
        self._init_ctrls(parent)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    70
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    71
    def SetTagName(self, tagname):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    72
        self.TagName = tagname
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    73
        if self.VARIABLE_PANEL_TYPE is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    74
            self.VariableEditor.SetTagName(tagname)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    75
        
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    76
    def GetTagName(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    77
        return self.TagName
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    78
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    79
    def GetTitle(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    80
        return "-".join(self.TagName.split("::")[1:])
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    81
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    82
    def GetIcon(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    83
        return self.Icon
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    84
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    85
    def SetIcon(self, icon):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    86
        self.Icon = icon
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    87
    
675
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    88
    def GetState(self):
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    89
        return None
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    90
    
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    91
    def SetState(self, state):
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    92
        pass
0ea836add01f Adding support for saving and restoring zoom and position of editors through closing and opening tab of the same POU or POU instance
laurent
parents: 655
diff changeset
    93
    
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    94
    def IsViewing(self, tagname):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    95
        return self.TagName == tagname
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    96
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    97
    def IsDebugging(self):
613
c487c54c1cfe Fixing bug conflict on tab selection between POU editor and Debug window of an instance of this same POU on Windows
laurent
parents: 600
diff changeset
    98
        return self.Debug
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
    99
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   100
    def SetMode(self, mode):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   101
        pass
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   102
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   103
    def ResetBuffer(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   104
        pass
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   105
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   106
    def GetBufferState(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   107
        if self.Controler is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   108
            return self.Controler.GetBufferState()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   109
        return False, False
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   110
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   111
    def Undo(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   112
        if self.Controler is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   113
            self.Controler.LoadPrevious()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   114
            self.RefreshView()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   115
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   116
    def Redo(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   117
        if self.Controler is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   118
            self.Controler.LoadNext()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   119
            self.RefreshView()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   120
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   121
    def HasNoModel(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   122
        return False
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   123
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   124
    def RefreshView(self, variablepanel=True):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   125
        if variablepanel:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   126
            self.RefreshVariablePanel()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   127
    
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   128
    def RefreshVariablePanel(self):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   129
        if self.VariableEditor is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   130
            self.VariableEditor.RefreshView()
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   131
    
681
c141dad94ff4 beremiz 'plugins' refactoring to 'confnode'
Edouard Tisserant
parents: 675
diff changeset
   132
    def GetConfNodeMenuItems(self):
635
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
   133
        return self.MenuItems
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
   134
    
681
c141dad94ff4 beremiz 'plugins' refactoring to 'confnode'
Edouard Tisserant
parents: 675
diff changeset
   135
    def RefreshConfNodeMenu(self, confnode_menu):
635
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
   136
        pass
dbcb8e2d2730 Fix bug while using 'Close project' menu and a few POUs are opened
laurent
parents: 617
diff changeset
   137
    
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   138
    def _Refresh(self, *args):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   139
        self.ParentWindow._Refresh(*args)
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   140
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   141
    def RefreshScaling(self, refresh=True):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   142
        pass
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   143
617
1a80e0598045 Fixing bug in highlighting in variable panel
laurent
parents: 613
diff changeset
   144
    def AddHighlight(self, infos, start, end, highlight_type):
1a80e0598045 Fixing bug in highlighting in variable panel
laurent
parents: 613
diff changeset
   145
        if self.VariableEditor is not None and infos[0] in ["var_local", "var_input", "var_output", "var_inout"]:
1a80e0598045 Fixing bug in highlighting in variable panel
laurent
parents: 613
diff changeset
   146
            self.VariableEditor.AddVariableHighlight(infos[1:], highlight_type)
1a80e0598045 Fixing bug in highlighting in variable panel
laurent
parents: 613
diff changeset
   147
586
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   148
    def ClearHighlights(self, highlight_type=None):
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   149
        if self.VariableEditor is not None:
9aa96a36cf33 Moving variable panel from bottom notebook panel to POU editor panel
laurent
parents:
diff changeset
   150
            self.VariableEditor.ClearHighlights(highlight_type)