editor.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     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.scrolledpanel import ScrolledPanel
 
from .settings import RideSettings
 
# any more than TREE_THRESHOLD panels when style is "auto" forces
# the UI into showing a hierarchical tree
TREE_THRESHOLD = 5
 
 
 
class PreferenceEditor(wx.Dialog):
    def __init__(self, parent, title, preferences, style="auto"):
        wx.Dialog.__init__(self, parent, wx.ID_ANY, title, size=(850, 660),
                           style=wx.RESIZE_BORDER | wx.DEFAULT_DIALOG_STYLE)
        # set Left to Right direction (while we don't have localization)
        self.SetLayoutDirection(wx.Layout_LeftToRight)
        self.Bind(wx.EVT_CLOSE, self.OnCloseOnClose)
        self._current_panel_current_panel = None
        self._panels_panels = []
        self._settings_settings = preferences.settings
        self._general_settings_general_settings = self._settings_settings['General']
        self.fontfont = self.GetFont()
        self.fontfont.SetFaceName(self._general_settings_general_settings['font face'])
        self.fontfont.SetPointSize(self._general_settings_general_settings['font size'])
        self.SetFont(self.fontfont)
        self.SetBackgroundColour(Colour(self._general_settings_general_settings['background']))
        self.SetOwnBackgroundColour(Colour(self._general_settings_general_settings['secondary background']))
        self.SetForegroundColour(Colour(self._general_settings_general_settings['foreground']))
        self.SetOwnForegroundColour(Colour(self._general_settings_general_settings['secondary foreground']))
        self._closing_closing = False
 
        panels = preferences.preference_panels
        if style not in ("tree","notebook","single","auto"):
            raise Exception("invalid style; must be one of 'tree','notebook','single' or 'auto'")
 
        if style == "tree" or (style == "auto" and len(panels) > TREE_THRESHOLD):
            self._sw_sw = wx.SplitterWindow(self, wx.ID_ANY, style=wx.SP_LIVE_UPDATE|wx.SP_3D)
            self._tree_tree = wx.TreeCtrl(self._sw_sw, wx.ID_ANY,
                                     style=wx.TR_HIDE_ROOT|wx.TR_HAS_BUTTONS)
            # create a single container which will hold all of the
            # preference panels
            self._container_container = PanelContainer(self._sw_sw, wx.ID_ANY)
            self._sw_sw.SplitVertically(self._tree_tree, self._container_container, 210)
            sizer = wx.BoxSizer(wx.VERTICAL)
            sizer.Add(self._sw_sw, 1, wx.EXPAND)
            self._tree_tree.SetFont(self.fontfont)
            self._tree_tree.SetBackgroundColour(Colour(self._general_settings_general_settings['background']))
            self._tree_tree.SetOwnBackgroundColour(Colour(self._general_settings_general_settings['secondary background']))
            self._tree_tree.SetForegroundColour(Colour(self._general_settings_general_settings['foreground']))
            self._tree_tree.SetOwnForegroundColour(Colour(self._general_settings_general_settings['secondary foreground']))
            self._tree_tree.Bind(wx.EVT_TREE_SEL_CHANGED, self.OnTreeSelectionOnTreeSelection)
            self._populate_tree_populate_tree(panels)
            self._tree_tree.SelectItem(self._tree_tree.GetFirstChild(self._tree_tree.GetRootItem())[0])
            self.SetSizer(sizer)
 
        elif style == "notebook" or (style == "auto" and len(panels) > 1):
            # the tabs appear in alphabetical order based on their
            # location. This has the pleasant side effect of "General"
            # coming before "Plugins", but if some plugin adds a
            # location of ("aaa","me first!") it will come before
            # "General". I need some way to order them, though maybe
            # just special-casing "General" to come first might be
            # good enough?
            self._notebook_notebook = wx.Notebook(self)
            for panel_class in sorted(panels, key=lambda p: p.location):
                # for a notebook, each notebook page gets a container,
                # and that container will only show one panel
                container = PanelContainer(self._notebook_notebook)
                panel = container.AddPanel(panel_class)
                container.ShowPanel(panel)
                self._notebook_notebook.AddPage(container, panel.GetTitle())
            sizer = wx.BoxSizer(wx.VERTICAL)
            sizer.Add(self._notebook_notebook, 1, wx.EXPAND)
            self.SetSizer(sizer)
 
        else:
            self._container_container = PanelContainer(self, wx.ID_ANY)
            sizer = wx.BoxSizer(wx.VERTICAL)
            sizer.Add(self._container_container, 1, wx.EXPAND)
            self.SetSizer(sizer)
 
            panel = self._container_container.AddPanel(panels[0])
            self._container_container.ShowPanel(panel)
 
    def OnClose(self, evt):
        self._closing_closing = True
        evt.Skip()
 
    
    def OnTreeSelection(self, event):
        # On Windows, closing the Dialog causes tree selection events to be
        # triggered. This is a workaround to ignore those events, which might
        # try to access dead objects.
        if self._closing_closing:
            return
        instance_or_class = self._tree_tree.GetItemData(event.GetItem())
        if isinstance(instance_or_class, wx.Panel):
            panel = instance_or_class
        else:
            # not an instance, assume it's a class
            panel = self._container_container.AddPanel(instance_or_class, self._settings_settings)
            self._panels_panels.append(panel)
            self._tree_tree.SetItemData(event.GetItem(), panel)
        self._container_container.ShowPanel(panel)
 
    
    def _populate_tree(self, panels):
        self._tree_tree.AddRoot("Root")
        for panel_class in panels:
            location = panel_class.location
            if not isinstance(location, tuple):
                # location should be a tuple, but it's easy to accidentally
                # make it not a tuple (eg: ("Plugins")). This fixes that.
                location = (location,)
            item = self._get_item_get_item(location)
            self._tree_tree.SetItemData(item, panel_class)
        self._tree_tree.ExpandAll()
 
    def _get_item(self, location):
        item = self._tree_tree.GetRootItem()
        for text in location:
            item = self._get_child_item_get_child_item(item, text)
        return item
 
    
    def _get_child_item(self, parent, text):
        if self._tree_tree.ItemHasChildren(parent):
            item, cookie = self._tree_tree.GetFirstChild(parent)
            while item:
                if self._tree_tree.GetItemText(item).strip().lower() == text.strip().lower():
                    return item
                item, cookie = self._tree_tree.GetNextChild(parent, cookie)
        # if we get here we didn't find the item
        item = self._tree_tree.AppendItem(parent, text)
        return item
 
    def _get_children(self, parent):
        if self._tree_tree.ItemHasChildren(parent):
            item, cookie = self._tree_tree.GetFirstChild(parent)
            while item:
                yield item
                item, cookie = self._tree_tree.GetNextChild(parent, cookie)
 
 
 
class PanelContainer(wx.Panel):
    def __init__(self, *args, **kwargs):
        super(PanelContainer, self).__init__(*args, **kwargs)
 
        self._current_panel_current_panel = None
        self._settings_settings = RideSettings()
        self.settingssettings = self._settings_settings['General']
        self.titletitle = wx.StaticText(self, label="Your message here")
        self.panels_containerpanels_container = ScrolledPanel(self, wx.ID_ANY, style=wx.TAB_TRAVERSAL)
        self.panels_containerpanels_container.SetupScrolling()
        sizer = wx.BoxSizer(wx.VERTICAL)
        sizer.Add(self.titletitle, 0, wx.TOP|wx.LEFT|wx.EXPAND, 4)
        sizer.Add(wx.StaticLine(self), 0, wx.EXPAND|wx.TOP|wx.BOTTOM, 4)
        sizer.Add(self.panels_containerpanels_container,1, wx.EXPAND)
        self.SetSizer(sizer)
        self.panels_containerpanels_container.SetSizer(wx.BoxSizer(wx.VERTICAL))
 
        font = self.titletitle.GetFont()
        font.SetFaceName(self.settingssettings['font face'])
        font.SetPointSize(self.settingssettings['font size'])
        font.MakeLarger()
        self.titletitle.SetFont(font)
        self.titletitle.SetForegroundColour(self.settingssettings['foreground'])
        self.titletitle.SetBackgroundColour(self.settingssettings['background'])
        self.SetForegroundColour(self.settingssettings['foreground'])
        self.SetBackgroundColour(self.settingssettings['background'])
 
    
    def AddPanel(self, panel_class, settings):
        panel = panel_class(parent=self.panels_containerpanels_container, settings=settings)
        self.panels_containerpanels_container.GetSizer().Add(panel, 1, wx.EXPAND)
        return panel
 
    
    def ShowPanel(self, panel):
        if self._current_panel_current_panel is not None:
            self._current_panel_current_panel.Hide()
        self._current_panel_current_panel = panel
        self.SetForegroundColour(self.settingssettings['foreground'])
        self.SetBackgroundColour(self.settingssettings['background'])
        panel.SetForegroundColour(self.settingssettings['foreground'])
        panel.SetBackgroundColour(self.settingssettings['background'])
        panel.Show()
        sizer = self.panels_containerpanels_container.GetSizer()
        item = sizer.GetItem(panel)
        title = getattr(panel, "title", panel.location[-1])
        self.SetTitleSetTitle(title)
        font = self.titletitle.GetFont()
        font.SetFaceName(self.settingssettings['font face'])
        font.SetPointSize(self.settingssettings['font size'])
        self.SetFont(font)
        font.MakeLarger()
        self.titletitle.SetFont(font)
        self.titletitle.SetForegroundColour(self.settingssettings['foreground'])
        self.titletitle.SetBackgroundColour(self.settingssettings['background'])
        if item is None:
            sizer.Add(panel, 1, wx.EXPAND)
        sizer.Layout()
 
    
    def SetTitle(self, title):
        self.titletitle.SetLabel(title)