beremiz

Extracted FolderTree control from FileManagementPanel to be able to use it anywhere else

2013-02-27, Laurent Bessard
7f9a9c47a317
Parents bf896711921c
Children c1f901403a34
Extracted FolderTree control from FileManagementPanel to be able to use it anywhere else
3 files changed, 261 insertions(+), 220 deletions(-)
  • +258 -0
    controls/FolderTree.py
  • +1 -0
    controls/__init__.py
  • +2 -220
    editors/FileManagementPanel.py
    • --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/controls/FolderTree.py Wed Feb 27 22:35:46 2013 +0100
    @@ -0,0 +1,258 @@
    +#!/usr/bin/env python
    +# -*- coding: utf-8 -*-
    +
    +#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor
    +#based on the plcopen standard.
    +#
    +#Copyright (C) 2013: Edouard TISSERANT and Laurent BESSARD
    +#
    +#See COPYING file for copyrights details.
    +#
    +#This library is free software; you can redistribute it and/or
    +#modify it under the terms of the GNU General Public
    +#License as published by the Free Software Foundation; either
    +#version 2.1 of the License, or (at your option) any later version.
    +#
    +#This library is distributed in the hope that it will be useful,
    +#but WITHOUT ANY WARRANTY; without even the implied warranty of
    +#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    +#General Public License for more details.
    +#
    +#You should have received a copy of the GNU General Public
    +#License along with this library; if not, write to the Free Software
    +#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    +
    +import os
    +
    +import wx
    +
    +from util.BitmapLibrary import GetBitmap
    +
    +DRIVE, FOLDER, FILE = range(3)
    +
    +def sort_folder(x, y):
    + if x[1] == y[1]:
    + return cmp(x[0], y[0])
    + elif x[1] != FILE:
    + return -1
    + else:
    + return 1
    +
    +def splitpath(path):
    + head, tail = os.path.split(path)
    + if head == "":
    + return [tail]
    + elif tail == "":
    + return splitpath(head)
    + return splitpath(head) + [tail]
    +
    +class FolderTree(wx.Panel):
    +
    + def __init__(self, parent, folder, filter=None, editable=True):
    + wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)
    +
    + main_sizer = wx.BoxSizer(wx.VERTICAL)
    +
    + self.Tree = wx.TreeCtrl(self,
    + style=wx.TR_HAS_BUTTONS|
    + wx.TR_SINGLE|
    + wx.SUNKEN_BORDER|
    + wx.TR_HIDE_ROOT|
    + wx.TR_LINES_AT_ROOT|
    + wx.TR_EDIT_LABELS)
    + if wx.Platform == '__WXMSW__':
    + self.Bind(wx.EVT_TREE_ITEM_ACTIVATED, self.OnTreeItemExpanded, self.Tree)
    + self.Tree.Bind(wx.EVT_LEFT_DOWN, self.OnTreeLeftDown)
    + else:
    + self.Bind(wx.EVT_TREE_ITEM_EXPANDED, self.OnTreeItemExpanded, self.Tree)
    + self.Bind(wx.EVT_TREE_ITEM_COLLAPSED, self.OnTreeItemCollapsed, self.Tree)
    + self.Bind(wx.EVT_TREE_BEGIN_LABEL_EDIT, self.OnTreeBeginLabelEdit, self.Tree)
    + self.Bind(wx.EVT_TREE_END_LABEL_EDIT, self.OnTreeEndLabelEdit, self.Tree)
    + main_sizer.AddWindow(self.Tree, 1, flag=wx.GROW)
    +
    + if filter is not None:
    + self.Filter = wx.ComboBox(self, style=wx.CB_READONLY)
    + self.Bind(wx.EVT_COMBOBOX, self.OnFilterChanged, self.Filter)
    + main_sizer.AddWindow(self.Filter, flag=wx.GROW)
    + else:
    + self.Filter = None
    +
    + self.SetSizer(main_sizer)
    +
    + self.Folder = folder
    + self.Editable = editable
    +
    + self.TreeImageList = wx.ImageList(16, 16)
    + self.TreeImageDict = {}
    + for item_type, bitmap in [(DRIVE, "tree_drive"),
    + (FOLDER, "tree_folder"),
    + (FILE, "tree_file")]:
    + self.TreeImageDict[item_type] = self.TreeImageList.Add(GetBitmap(bitmap))
    + self.Tree.SetImageList(self.TreeImageList)
    +
    + self.Filters = {}
    + if self.Filter is not None:
    + filter_parts = filter.split("|")
    + for idx in xrange(0, len(filter_parts), 2):
    + if filter_parts[idx + 1] == "*.*":
    + self.Filters[filter_parts[idx]] = ""
    + else:
    + self.Filters[filter_parts[idx]] = filter_parts[idx + 1].replace("*", "")
    + self.Filter.Append(filter_parts[idx])
    + if idx == 0:
    + self.Filter.SetStringSelection(filter_parts[idx])
    +
    + self.CurrentFilter = self.Filters[self.Filter.GetStringSelection()]
    + else:
    + self.CurrentFilter = ""
    +
    + def _GetFolderChildren(self, folderpath, recursive=True):
    + items = []
    + if wx.Platform == '__WXMSW__' and folderpath == "/":
    + for c in xrange(ord('a'), ord('z')):
    + drive = os.path.join("%s:\\" % chr(c))
    + if os.path.exists(drive):
    + items.append((drive, DRIVE, self._GetFolderChildren(drive, False)))
    + else:
    + try:
    + files = os.listdir(folderpath)
    + except:
    + return []
    + for filename in files:
    + if not filename.startswith("."):
    + filepath = os.path.join(folderpath, filename)
    + if os.path.isdir(filepath):
    + if recursive:
    + children = len(self._GetFolderChildren(filepath, False))
    + else:
    + children = 0
    + items.append((filename, FOLDER, children))
    + elif (self.CurrentFilter == "" or
    + os.path.splitext(filename)[1] == self.CurrentFilter):
    + items.append((filename, FILE, None))
    + if recursive:
    + items.sort(sort_folder)
    + return items
    +
    + def SetFilter(self, filter):
    + self.CurrentFilter = filter
    +
    + def GetTreeCtrl(self):
    + return self.Tree
    +
    + def RefreshTree(self):
    + root = self.Tree.GetRootItem()
    + if not root.IsOk():
    + root = self.Tree.AddRoot("")
    + self.GenerateTreeBranch(root, self.Folder)
    +
    + def GenerateTreeBranch(self, root, folderpath):
    + item, item_cookie = self.Tree.GetFirstChild(root)
    + for idx, (filename, item_type, children) in enumerate(self._GetFolderChildren(folderpath)):
    + if not item.IsOk():
    + item = self.Tree.AppendItem(root, filename, self.TreeImageDict[item_type])
    + if wx.Platform != '__WXMSW__':
    + item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    + elif self.Tree.GetItemText(item) != filename:
    + item = self.Tree.InsertItemBefore(root, idx, filename, self.TreeImageDict[item_type])
    + filepath = os.path.join(folderpath, filename)
    + if item_type != FILE:
    + if self.Tree.IsExpanded(item):
    + self.GenerateTreeBranch(item, filepath)
    + elif children > 0:
    + self.Tree.SetItemHasChildren(item)
    + item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    + to_delete = []
    + while item.IsOk():
    + to_delete.append(item)
    + item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    + for item in to_delete:
    + self.Tree.Delete(item)
    +
    + def ExpandItem(self, item):
    + self.GenerateTreeBranch(item, self.GetPath(item))
    + self.Tree.Expand(item)
    +
    + def OnTreeItemActivated(self, event):
    + self.ExpandItem(event.GetItem())
    + event.Skip()
    +
    + def OnTreeLeftDown(self, event):
    + item, flags = self.Tree.HitTest(event.GetPosition())
    + if flags & wx.TREE_HITTEST_ONITEMBUTTON and not self.Tree.IsExpanded(item):
    + self.ExpandItem(item)
    + else:
    + event.Skip()
    +
    + def OnTreeItemExpanded(self, event):
    + item = event.GetItem()
    + self.GenerateTreeBranch(item, self.GetPath(item))
    + event.Skip()
    +
    + def OnTreeItemCollapsed(self, event):
    + item = event.GetItem()
    + self.Tree.DeleteChildren(item)
    + self.Tree.SetItemHasChildren(item)
    + event.Skip()
    +
    + def OnTreeBeginLabelEdit(self, event):
    + item = event.GetItem()
    + if self.Editable and not self.Tree.ItemHasChildren(item):
    + event.Skip()
    + else:
    + event.Veto()
    +
    + def OnTreeEndLabelEdit(self, event):
    + old_filepath = self.GetPath(event.GetItem())
    + new_filepath = os.path.join(os.path.split(old_filepath)[0], event.GetLabel())
    + if new_filepath != old_filepath:
    + if not os.path.exists(new_filepath):
    + os.rename(old_filepath, new_filepath)
    + event.Skip()
    + else:
    + message = wx.MessageDialog(self,
    + _("File '%s' already exists!") % event.GetLabel(),
    + _("Error"), wx.OK|wx.ICON_ERROR)
    + message.ShowModal()
    + message.Destroy()
    + event.Veto()
    +
    + def OnFilterChanged(self, event):
    + self.CurrentFilter = self.Filters[self.Filter.GetStringSelection()]
    + self.RefreshTree()
    + event.Skip()
    +
    + def _SelectItem(self, root, parts):
    + if len(parts) == 0:
    + self.Tree.SelectItem(root)
    + else:
    + item, item_cookie = self.Tree.GetFirstChild(root)
    + while item.IsOk():
    + if self.Tree.GetItemText(item) == parts[0]:
    + if (self.Tree.ItemHasChildren(item) and
    + not self.Tree.IsExpanded(item)):
    + self.Tree.Expand(item)
    + wx.CallAfter(self._SelectItem, item, parts[1:])
    + else:
    + self._SelectItem(item, parts[1:])
    + return
    + item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    +
    + def SetPath(self, path):
    + if path.startswith(self.Folder):
    + root = self.Tree.GetRootItem()
    + if root.IsOk():
    + relative_path = path.replace(os.path.join(self.Folder, ""), "")
    + self._SelectItem(root, splitpath(relative_path))
    +
    + def GetPath(self, item=None):
    + if item is None:
    + item = self.Tree.GetSelection()
    + if item.IsOk():
    + filepath = self.Tree.GetItemText(item)
    + parent = self.Tree.GetItemParent(item)
    + while parent.IsOk() and parent != self.Tree.GetRootItem():
    + filepath = os.path.join(self.Tree.GetItemText(parent), filepath)
    + parent = self.Tree.GetItemParent(parent)
    + return os.path.join(self.Folder, filepath)
    + return self.Folder
    --- a/controls/__init__.py Wed Feb 27 11:33:41 2013 +0100
    +++ b/controls/__init__.py Wed Feb 27 22:35:46 2013 +0100
    @@ -37,3 +37,4 @@
    from VariablePanel import VariablePanel
    from SearchResultPanel import SearchResultPanel
    from TextCtrlAutoComplete import TextCtrlAutoComplete
    +from FolderTree import FolderTree
    --- a/editors/FileManagementPanel.py Wed Feb 27 11:33:41 2013 +0100
    +++ b/editors/FileManagementPanel.py Wed Feb 27 22:35:46 2013 +0100
    @@ -26,232 +26,14 @@
    import shutil
    import wx
    +import wx.lib.buttons
    from EditorPanel import EditorPanel
    from util.BitmapLibrary import GetBitmap
    -
    -DRIVE, FOLDER, FILE = range(3)
    +from controls import FolderTree
    FILTER = _("All files (*.*)|*.*|CSV files (*.csv)|*.csv")
    -def sort_folder(x, y):
    - if x[1] == y[1]:
    - return cmp(x[0], y[0])
    - elif x[1] != FILE:
    - return -1
    - else:
    - return 1
    -
    -def splitpath(path):
    - head, tail = os.path.split(path)
    - if head == "":
    - return [tail]
    - elif tail == "":
    - return splitpath(head)
    - return splitpath(head) + [tail]
    -
    -class FolderTree(wx.Panel):
    -
    - def __init__(self, parent, folder, filter, editable=True):
    - wx.Panel.__init__(self, parent, style=wx.TAB_TRAVERSAL)
    -
    - main_sizer = wx.BoxSizer(wx.VERTICAL)
    -
    - self.Tree = wx.TreeCtrl(self,
    - style=wx.TR_HAS_BUTTONS|
    - wx.TR_SINGLE|
    - wx.SUNKEN_BORDER|
    - wx.TR_HIDE_ROOT|
    - wx.TR_LINES_AT_ROOT|
    - wx.TR_EDIT_LABELS)
    - if wx.Platform == '__WXMSW__':
    - self.Bind(wx.EVT_TREE_ITEM_ACTIVATED, self.OnTreeItemExpanded, self.Tree)
    - self.Tree.Bind(wx.EVT_LEFT_DOWN, self.OnTreeLeftDown)
    - else:
    - self.Bind(wx.EVT_TREE_ITEM_EXPANDED, self.OnTreeItemExpanded, self.Tree)
    - self.Bind(wx.EVT_TREE_ITEM_COLLAPSED, self.OnTreeItemCollapsed, self.Tree)
    - self.Bind(wx.EVT_TREE_BEGIN_LABEL_EDIT, self.OnTreeBeginLabelEdit, self.Tree)
    - self.Bind(wx.EVT_TREE_END_LABEL_EDIT, self.OnTreeEndLabelEdit, self.Tree)
    - main_sizer.AddWindow(self.Tree, 1, flag=wx.GROW)
    -
    - self.Filter = wx.ComboBox(self, style=wx.CB_READONLY)
    - self.Bind(wx.EVT_COMBOBOX, self.OnFilterChanged, self.Filter)
    - main_sizer.AddWindow(self.Filter, flag=wx.GROW)
    -
    - self.SetSizer(main_sizer)
    -
    - self.Folder = folder
    - self.Editable = editable
    -
    - self.TreeImageList = wx.ImageList(16, 16)
    - self.TreeImageDict = {}
    - for item_type, bitmap in [(DRIVE, "tree_drive"),
    - (FOLDER, "tree_folder"),
    - (FILE, "tree_file")]:
    - self.TreeImageDict[item_type] = self.TreeImageList.Add(GetBitmap(bitmap))
    - self.Tree.SetImageList(self.TreeImageList)
    -
    - self.Filters = {}
    - filter_parts = filter.split("|")
    - for idx in xrange(0, len(filter_parts), 2):
    - if filter_parts[idx + 1] == "*.*":
    - self.Filters[filter_parts[idx]] = ""
    - else:
    - self.Filters[filter_parts[idx]] = filter_parts[idx + 1].replace("*", "")
    - self.Filter.Append(filter_parts[idx])
    - if idx == 0:
    - self.Filter.SetStringSelection(filter_parts[idx])
    -
    - self.CurrentFilter = self.Filters[self.Filter.GetStringSelection()]
    -
    - def _GetFolderChildren(self, folderpath, recursive=True):
    - items = []
    - if wx.Platform == '__WXMSW__' and folderpath == "/":
    - for c in xrange(ord('a'), ord('z')):
    - drive = os.path.join("%s:\\" % chr(c))
    - if os.path.exists(drive):
    - items.append((drive, DRIVE, self._GetFolderChildren(drive, False)))
    - else:
    - try:
    - files = os.listdir(folderpath)
    - except:
    - return []
    - for filename in files:
    - if not filename.startswith("."):
    - filepath = os.path.join(folderpath, filename)
    - if os.path.isdir(filepath):
    - if recursive:
    - children = len(self._GetFolderChildren(filepath, False))
    - else:
    - children = 0
    - items.append((filename, FOLDER, children))
    - elif (self.CurrentFilter == "" or
    - os.path.splitext(filename)[1] == self.CurrentFilter):
    - items.append((filename, FILE, None))
    - if recursive:
    - items.sort(sort_folder)
    - return items
    -
    - def GetTreeCtrl(self):
    - return self.Tree
    -
    - def RefreshTree(self):
    - root = self.Tree.GetRootItem()
    - if not root.IsOk():
    - root = self.Tree.AddRoot("")
    - self.GenerateTreeBranch(root, self.Folder)
    -
    - def GenerateTreeBranch(self, root, folderpath):
    - item, item_cookie = self.Tree.GetFirstChild(root)
    - for idx, (filename, item_type, children) in enumerate(self._GetFolderChildren(folderpath)):
    - if not item.IsOk():
    - item = self.Tree.AppendItem(root, filename, self.TreeImageDict[item_type])
    - if wx.Platform != '__WXMSW__':
    - item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    - elif self.Tree.GetItemText(item) != filename:
    - item = self.Tree.InsertItemBefore(root, idx, filename, self.TreeImageDict[item_type])
    - filepath = os.path.join(folderpath, filename)
    - if item_type != FILE:
    - if self.Tree.IsExpanded(item):
    - self.GenerateTreeBranch(item, filepath)
    - elif children > 0:
    - self.Tree.SetItemHasChildren(item)
    - item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    - to_delete = []
    - while item.IsOk():
    - to_delete.append(item)
    - item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    - for item in to_delete:
    - self.Tree.Delete(item)
    -
    - def ExpandItem(self, item):
    - self.GenerateTreeBranch(item, self.GetPath(item))
    - self.Tree.Expand(item)
    -
    - def OnTreeItemActivated(self, event):
    - self.ExpandItem(event.GetItem())
    - event.Skip()
    -
    - def OnTreeLeftDown(self, event):
    - item, flags = self.Tree.HitTest(event.GetPosition())
    - if flags & wx.TREE_HITTEST_ONITEMBUTTON and not self.Tree.IsExpanded(item):
    - self.ExpandItem(item)
    - else:
    - event.Skip()
    -
    - def OnTreeItemExpanded(self, event):
    - item = event.GetItem()
    - self.GenerateTreeBranch(item, self.GetPath(item))
    - event.Skip()
    -
    - def OnTreeItemCollapsed(self, event):
    - item = event.GetItem()
    - self.Tree.DeleteChildren(item)
    - self.Tree.SetItemHasChildren(item)
    - event.Skip()
    -
    - def OnTreeBeginLabelEdit(self, event):
    - item = event.GetItem()
    - if self.Editable and not self.Tree.ItemHasChildren(item):
    - event.Skip()
    - else:
    - event.Veto()
    -
    - def OnTreeEndLabelEdit(self, event):
    - old_filepath = self.GetPath(event.GetItem())
    - new_filepath = os.path.join(os.path.split(old_filepath)[0], event.GetLabel())
    - if new_filepath != old_filepath:
    - if not os.path.exists(new_filepath):
    - os.rename(old_filepath, new_filepath)
    - event.Skip()
    - else:
    - message = wx.MessageDialog(self,
    - _("File '%s' already exists!") % event.GetLabel(),
    - _("Error"), wx.OK|wx.ICON_ERROR)
    - message.ShowModal()
    - message.Destroy()
    - event.Veto()
    -
    - def OnFilterChanged(self, event):
    - self.CurrentFilter = self.Filters[self.Filter.GetStringSelection()]
    - self.RefreshTree()
    - event.Skip()
    -
    - def _SelectItem(self, root, parts):
    - if len(parts) == 0:
    - self.Tree.SelectItem(root)
    - else:
    - item, item_cookie = self.Tree.GetFirstChild(root)
    - while item.IsOk():
    - if self.Tree.GetItemText(item) == parts[0]:
    - if (self.Tree.ItemHasChildren(item) and
    - not self.Tree.IsExpanded(item)):
    - self.Tree.Expand(item)
    - wx.CallAfter(self._SelectItem, item, parts[1:])
    - else:
    - self._SelectItem(item, parts[1:])
    - return
    - item, item_cookie = self.Tree.GetNextChild(root, item_cookie)
    -
    - def SetPath(self, path):
    - if path.startswith(self.Folder):
    - root = self.Tree.GetRootItem()
    - if root.IsOk():
    - relative_path = path.replace(os.path.join(self.Folder, ""), "")
    - self._SelectItem(root, splitpath(relative_path))
    -
    - def GetPath(self, item=None):
    - if item is None:
    - item = self.Tree.GetSelection()
    - if item.IsOk():
    - filepath = self.Tree.GetItemText(item)
    - parent = self.Tree.GetItemParent(item)
    - while parent.IsOk() and parent != self.Tree.GetRootItem():
    - filepath = os.path.join(self.Tree.GetItemText(parent), filepath)
    - parent = self.Tree.GetItemParent(parent)
    - return os.path.join(self.Folder, filepath)
    - return self.Folder
    -
    class FileManagementPanel(EditorPanel):
    def _init_Editor(self, parent):