fileexplorerplugin.py

Go to the documentation of this file.

#  Copyright 2020-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
import wx
from wx import Colour
from wx.lib.agw import customtreectrl
from wx.lib.agw.aui import GetManager
 
from ..controller.project import Project
from ..pluginapi import Plugin
from ..pluginapi.plugin import ActionInfo
 
 
 
class FileExplorerPlugin(Plugin):
    datafile = property(lambda self: self.get_selected_datafileget_selected_datafile())
    defaults = {"opened": True,
                "docked": True
                }
 
    def __init__(self, application, controller=None):
        Plugin.__init__(self, application, default_settings=self.defaultsdefaults)
        self.settingssettings = application.settings._config_obj['Plugins']['File Explorer']
        self._parent_parent = wx.App.Get().GetTopWindow()
        self._filemgr_filemgr = self.filemgrfilemgr
        self._filemgr_filemgr.SetThemeEnabled(True)
        self._mgr_mgr = GetManager(self._filemgr_filemgr)
        self._controller_controller = controller
 
    def register_frame(self, parent=None):
        if parent:
            self._parent_parent = parent
 
            if self._mgr_mgr.GetPane("file_manager") in self._mgr_mgr._panes:
                register = self._mgr_mgr.InsertPane
            else:
                register = self._mgr_mgr.AddPane
 
            register(self._filemgr_filemgr, wx.lib.agw.aui.AuiPaneInfo().Name("file_manager").
                     Caption("Files").LeftDockable(True).CloseButton(True))
 
            self._mgr_mgr.Update()
 
    def enable(self):
        self.register_actionregister_action(ActionInfo('View','View File Explorer', self.OnShowFileExplorerOnShowFileExplorer,
                                        shortcut='F11',
                                        doc='Show File Explorer panel',
                                        position=1))
        # self.save_setting('opened', True)
        if self.opened:
            self.OnShowFileExplorerOnShowFileExplorer(None)
 
    def close_tree(self):
        self._mgr_mgr.DetachPane(self._filemgr_filemgr)
        self._filemgr_filemgr.Hide()
        self._mgr_mgr.Update()
        self.save_settingsave_setting('opened', False)
 
    def disable(self):
        self.close_treeclose_tree()
        # self.save_setting('opened', False)
        self.unsubscribe_allunsubscribe_all()
        self.unregister_actionsunregister_actions()
 
    def is_focused(self):
        return self._filemgr_filemgr.HasFocus()
 
    def OnShowFileExplorer(self, event):
        if not self._parent_parent:
            self._parent_parent = wx.App.Get().GetWindow()  # self.frame
        if not self._filemgr_filemgr:  # This is not needed because file explorer is always created
            self._filemgr_filemgr = FileExplorer(self._parent_parent, self._controller_controller)
 
        self._pane_pane = self._mgr_mgr.GetPane(self._filemgr_filemgr)
        HTML_BACKGROUND = self.settingssettings.get('background help', (240, 242, 80))
        HTML_FOREGROUND = self.settingssettings.get('foreground text', (7, 0, 70))
        HTML_FONT_FACE = self.settingssettings.get('font face', '')
        HTML_FONT_SIZE = self.settingssettings.get('font size', 11)
        self._filetreectrl_filetreectrl = self._filemgr_filemgr.GetTreeCtrl()
        self._filemgr_filemgr.Show(True)
        self._filemgr_filemgr.SetMinSize(wx.Size(200, 225))
        self._mgr_mgr.DetachPane(self._filemgr_filemgr)
        self._mgr_mgr.AddPane(self.filemgrfilemgr,
                          wx.lib.agw.aui.AuiPaneInfo().Name("file_manager").
                          Caption("Files").LeftDockable(True).
                          CloseButton(True))
        self._filemgr_filemgr.SetBackgroundStyle(wx.BG_STYLE_SYSTEM)
        self._filemgr_filemgr.SetBackgroundColour(HTML_BACKGROUND)
        self._filemgr_filemgr.SetForegroundColour(HTML_FOREGROUND)
        self.fontfont = self._filemgr_filemgr.GetFont()
        self.fontfont.SetFaceName(HTML_FONT_FACE)
        self.fontfont.SetPointSize(HTML_FONT_SIZE)
        self._filemgr_filemgr.SetFont(self.fontfont)
        self._filemgr_filemgr.Refresh()
        self._filetreectrl_filetreectrl.SetBackgroundColour(HTML_BACKGROUND)
        self._filetreectrl_filetreectrl.SetForegroundColour(HTML_FOREGROUND)
        self._filetreectrl_filetreectrl.SetFont(self.fontfont)
        self._filetreectrl_filetreectrl.Refresh()
        self._filemgr_filemgr.Raise()
        self._mgr_mgr.Update()
        self.save_settingsave_setting('opened', True)
        self._update_tree_update_tree()
 
    def _update_tree(self):
        if not self._filemgr_filemgr:
            return
        self._filemgr_filemgr.update_tree()
 
 
class FileExplorer(wx.GenericDirCtrl):
 
    def __init__(self, parent, controller=None):
        wx.GenericDirCtrl.__init__(self, parent, id=-1, size=(200, 225), style=wx.DIRCTRL_3D_INTERNAL)
        self._controller_controller = controller
        self.SetThemeEnabled(True)
        self.Refresh()
 
    def update_tree(self):
        if isinstance(self._controller_controller, Project):
            if self._controller_controller.data and len(self._controller_controller.data.directory) > 1:
                self.SelectPath(self._controller_controller.data.source)
                try:
                    self.ExpandPath(self._controller_controller.data.source)
                except Exception:
                    pass
                self.Refresh()
                self.Update()