preferences_dialogs.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 textwrap
 
import wx
from wx import Colour
 
from ..context import IS_LINUX
from ..widgets import HelpLabel, Label, TextField
 
 
 
class PreferencesPanel(wx.Panel):
    location = ("Preferences",)
    title = "Preferences"
 
    def __init__(self, parent=None, *args, **kwargs):
        self.tree_itemtree_item = None
        wx.Panel.__init__(self, parent, *args, **kwargs)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
 
    def GetTitle(self):
        return getattr(self, "title", self.locationlocation[-1])
 
    
    def Separator(self, parent, title):
        container = wx.Panel(parent, wx.ID_ANY)
        label = wx.StaticText(container, wx.ID_ANY, label=title)
        """
        label.SetBackgroundColour(Colour(200, 222, 40))
        label.SetOwnBackgroundColour(Colour(200, 222, 40))
        label.SetForegroundColour(Colour(7, 0, 70))
        label.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        sep = wx.StaticLine(container, wx.ID_ANY)
        """
        sep.SetBackgroundColour(Colour(200, 222, 40))
        sep.SetOwnBackgroundColour(Colour(200, 222, 40))
        sep.SetForegroundColour(Colour(7, 0, 70))
        sep.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        sizer = wx.BoxSizer(wx.VERTICAL)
        sizer.Add(label, 0, wx.EXPAND|wx.TOP, 8)
        sizer.Add(sep, 0, wx.EXPAND|wx.TOP|wx.BOTTOM, 2)
        container.SetSizerAndFit(sizer)
        return container
 
 
 
class PreferencesComboBox(wx.ComboBox):
    def __init__(self, parent, id, settings, key, choices):
        self.settingssettings = settings
        self.keykey = key
        super(PreferencesComboBox, self).__init__(parent, id, self._get_value_get_value(),
                                                  size=self._get_size_get_size(choices),
                                                  choices=choices, style=wx.CB_READONLY)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        self.Bind(wx.EVT_COMBOBOX, self.OnSelectOnSelect)
 
    def _get_value(self):
        return self.settingssettings[self.keykey]
 
    
    def _get_size(self, choices=[]):
        if IS_LINUX and choices:
            return wx.Size(max(max(len(str(s)) for s in choices) * 9, 144), 20)
        return wx.DefaultSize
 
    def OnSelect(self, event):
        self._set_value_set_value(str(event.GetEventObject().GetValue()))
        self.settingssettings.save()
 
    def _set_value(self, value):
        self.settingssettings[self.keykey] = value
 
 
 
class IntegerPreferenceComboBox(PreferencesComboBox):
 
    def _get_value(self):
        return str(self.settingssettings[self.keykey])
 
    def _set_value(self, value):
        self.settingssettings[self.keykey] = int(value)
 
 
 
class PreferencesSpinControl(wx.SpinCtrl):
 
    def __init__(self, parent, id, settings, key, choices):
        self.settingssettings = settings
        self.keykey = key
        super(PreferencesSpinControl, self).__init__(parent, id,
            size=self._get_size_get_size(choices[-1]))
        self.SetRange(*choices)
        self.SetValue(self._get_value_get_value())
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        self.Bind(wx.EVT_SPINCTRL, self.OnChangeOnChange)
        self.Bind(wx.EVT_TEXT, self.OnChangeOnChange)
 
    def _get_value(self):
        return self.settingssettings[self.keykey]
 
    
    def _get_size(self, max_value):
        if IS_LINUX and max_value:
            return wx.Size(max(len(str(max_value)) * 9, 144), 20)
        return wx.DefaultSize
 
    def OnChange(self, event):
        self._set_value_set_value(event.GetEventObject().GetValue())
        self.settingssettings.save()
 
    def _set_value(self, value):
        self.settingssettings[self.keykey] = value
 
 
 
class PreferencesColorPicker(wx.ColourPickerCtrl):
    def __init__(self, parent, id, settings, key):
        self.settingssettings = settings
        self.keykey = key
        # print(f"DEBUG: Preferences ColourPicker value type {type(settings[key])}")
        value = Colour(settings[key])
        super(PreferencesColorPicker, self).__init__(parent, id, colour=value)
        """
        self.SetBackgroundColour(Colour(200, 222, 40))
        self.SetOwnBackgroundColour(Colour(200, 222, 40))
        self.SetForegroundColour(Colour(7, 0, 70))
        self.SetOwnForegroundColour(Colour(7, 0, 70))
        """
        self.Bind(wx.EVT_COLOURPICKER_CHANGED, self.OnPickColorOnPickColor)
 
    
    def OnPickColor(self, event):
        color = event.GetColour()
        rgb = color.GetAsString(flags=wx.C2S_HTML_SYNTAX)
        self.settingssettings[self.keykey] = rgb
        self.settingssettings.save()
 
    def SetColour(self, colour):
        super(PreferencesColorPicker, self).SetColour(colour)
        self.settingssettings[self.keykey] = colour
        self.settingssettings.save()
 
 
class _ChoiceEditor():
    
    _editor_class = None
 
    def __init__(self, settings, setting_name, label, choices, help=''):
        self._settings_settings = settings
        self._setting_name_setting_name = setting_name
        self._label_label = label
        self._choices_choices = choices
        self._help_help = help
 
    def chooser(self, parent):
        return self._editor_class_editor_class(parent, wx.NewId(), self._settings_settings,
                                  key=self._setting_name_setting_name, choices=self._choices_choices)
 
    def label(self, parent):
        return wx.StaticText(parent, wx.NewId(), self._label_label)
 
    def help(self, parent):
        return HelpLabel(parent, '\n'.join(textwrap.wrap(self._help_help, 60)))
 
 
class StringChoiceEditor(_ChoiceEditor):
    
    _editor_class = PreferencesComboBox
 
 
class IntegerChoiceEditor(_ChoiceEditor):
    
    _editor_class = IntegerPreferenceComboBox
 
 
class SpinChoiceEditor(_ChoiceEditor):
    
    _editor_class = PreferencesSpinControl
 
 
def boolean_editor(parent, settings, name, label, help=''):
    editor = _create_checkbox_editor(parent, settings, name, help)
    """
    editor.SetBackgroundColour(Colour(200, 222, 40))
    editor.SetOwnBackgroundColour(Colour(200, 222, 40))
    editor.SetForegroundColour(Colour(7, 0, 70))
    editor.SetOwnForegroundColour(Colour(7, 0, 70))
    """
    label = Label(parent, label=label)
    return label, editor
 
 
def _create_checkbox_editor(parent, settings, name, help):
    initial_value = settings.get(name, "")
    editor = wx.CheckBox(parent)
    editor.SetValue(initial_value)
    editor.Bind(wx.EVT_CHECKBOX, lambda evt: settings.set(name, editor.GetValue()))
    editor.SetToolTip(help)
    return editor
 
 
def comma_separated_value_editor(parent, settings, name, label, help=''):
    initial_value = ', '.join(settings.get(name, ""))
    editor = TextField(parent, initial_value)
    """
    editor.SetBackgroundColour(Colour(200, 222, 40))
    editor.SetOwnBackgroundColour(Colour(200, 222, 40))
    editor.SetForegroundColour(Colour(7, 0, 70))
    editor.SetOwnForegroundColour(Colour(7, 0, 70))
    """
    editor.SetToolTip(help)
 
    def set_value(evt):
        new_value = [token.strip() for token in editor.GetValue().split(',')
                     if token.strip()]
        settings.set(name, new_value)
        evt.Skip()
    editor.Bind(wx.EVT_KILL_FOCUS, lambda evt: set_value(evt))
 
    return Label(parent, label=label), editor