-#!/usr/bin/env python\r
-\r
-'''\r
-propertyeditor.py\r
-\r
-Property editor panel for Hooke.\r
-\r
-Copyright 2009 by Dr. Rolf Schmidt (Concordia University, Canada)\r
-\r
-This program is released under the GNU General Public License version 2.\r
-'''\r
-\r
-import sys\r
-import os.path\r
-\r
-import wx\r
-import wx.propgrid as wxpg\r
-#import wx.stc\r
-from string import split\r
-\r
-#there are many comments and code fragments in here from the demo app\r
-#they should come in handy to expand the functionality in the future\r
-\r
-class Display:\r
- property_descriptor = []\r
- def __init__(self):\r
- pass\r
-\r
-\r
-class ValueObject:\r
- def __init__(self):\r
- pass\r
-\r
-\r
-class IntProperty2(wxpg.PyProperty):\r
- """\\r
- This is a simple re-implementation of wxIntProperty.\r
- """\r
- def __init__(self, label, name = wxpg.LABEL_AS_NAME, value=0):\r
- wxpg.PyProperty.__init__(self, label, name)\r
- self.SetValue(value)\r
-\r
- def GetClassName(self):\r
- """\\r
- This is not 100% necessary and in future is probably going to be\r
- automated to return class name.\r
- """\r
- return "IntProperty2"\r
-\r
- def GetEditor(self):\r
- return "TextCtrl"\r
-\r
- def GetValueAsString(self, flags):\r
- return str(self.GetValue())\r
-\r
- def PyStringToValue(self, s, flags):\r
- try:\r
- v = int(s)\r
- if self.GetValue() != v:\r
- return v\r
- except TypeError:\r
- if flags & wxpg.PG_REPORT_ERROR:\r
- wx.MessageBox("Cannot convert '%s' into a number."%s, "Error")\r
- return False\r
-\r
- def PyIntToValue(self, v, flags):\r
- if (self.GetValue() != v):\r
- return v\r
-\r
-\r
-class PyFilesProperty(wxpg.PyArrayStringProperty):\r
- def __init__(self, label, name = wxpg.LABEL_AS_NAME, value=[]):\r
- wxpg.PyArrayStringProperty.__init__(self, label, name, value)\r
- self.SetValue(value)\r
-\r
- def OnSetValue(self, v):\r
- self.value = v\r
- self.display = ', '.join(self.value)\r
-\r
- def GetValueAsString(self, argFlags):\r
- return self.display\r
-\r
- def PyStringToValue(self, s, flags):\r
- return [a.strip() for a in s.split(',')]\r
-\r
- def OnEvent(self, propgrid, ctrl, event):\r
- if event.GetEventType() == wx.wxEVT_COMMAND_BUTTON_CLICKED:\r
- # Show dialog to select a string, call DoSetValue and\r
- # return True, if value changed.\r
- return True\r
-\r
- return False\r
-\r
-\r
-class PyObjectPropertyValue:\r
- """\\r
- Value type of our sample PyObjectProperty. We keep a simple dash-delimited\r
- list of string given as argument to constructor.\r
- """\r
- def __init__(self, s=None):\r
- try:\r
- self.ls = [a.strip() for a in s.split('-')]\r
- except:\r
- self.ls = []\r
-\r
- def __repr__(self):\r
- return ' - '.join(self.ls)\r
-\r
-\r
-class PyObjectProperty(wxpg.PyProperty):\r
- """\\r
- Another simple example. This time our value is a PyObject (NOTE: we can't\r
- return an arbitrary python object in DoGetValue. It cannot be a simple\r
- type such as int, bool, double, or string, nor an array or wxObject based.\r
- Dictionary, None, or any user-specified Python object is allowed).\r
- """\r
- def __init__(self, label, name = wxpg.LABEL_AS_NAME, value=None):\r
- wxpg.PyProperty.__init__(self, label, name)\r
- self.SetValue(value)\r
-\r
- def GetClassName(self):\r
- return self.__class__.__name__\r
-\r
- def GetEditor(self):\r
- return "TextCtrl"\r
-\r
- def GetValueAsString(self, flags):\r
- return repr(self.GetValue())\r
-\r
- def PyStringToValue(self, s, flags):\r
- return PyObjectPropertyValue(s)\r
-\r
-\r
-class ShapeProperty(wxpg.PyEnumProperty):\r
- """\\r
- Demonstrates use of OnCustomPaint method.\r
- """\r
- def __init__(self, label, name = wxpg.LABEL_AS_NAME, value=-1):\r
- wxpg.PyEnumProperty.__init__(self, label, name, ['Line','Circle','Rectangle'], [0,1,2], value)\r
-\r
- def OnMeasureImage(self, index):\r
- return wxpg.DEFAULT_IMAGE_SIZE\r
-\r
- def OnCustomPaint(self, dc, rect, paint_data):\r
- """\\r
- paint_data.m_choiceItem is -1 if we are painting the control,\r
- in which case we need to get the drawn item using DoGetValue.\r
- """\r
- item = paint_data.m_choiceItem\r
- if item == -1:\r
- item = self.DoGetValue()\r
-\r
- dc.SetPen(wx.Pen(wx.BLACK))\r
- dc.SetBrush(wx.Brush(wx.BLACK))\r
-\r
- if item == 0:\r
- dc.DrawLine(rect.x,rect.y,rect.x+rect.width,rect.y+rect.height)\r
- elif item == 1:\r
- half_width = rect.width / 2\r
- dc.DrawCircle(rect.x+half_width,rect.y+half_width,half_width-3)\r
- elif item == 2:\r
- dc.DrawRectangle(rect.x, rect.y, rect.width, rect.height)\r
-\r
-\r
-class LargeImagePickerCtrl(wx.Window):\r
- """\\r
- Control created and used by LargeImageEditor.\r
- """\r
- def __init__(self):\r
- pre = wx.PreWindow()\r
- self.PostCreate(pre)\r
-\r
- def Create(self, parent, id_, pos, size, style = 0):\r
- wx.Window.Create(self, parent, id_, pos, size, style | wx.BORDER_SIMPLE)\r
- img_spc = size[1]\r
- self.tc = wx.TextCtrl(self, -1, "", (img_spc,0), (2048,size[1]), wx.BORDER_NONE)\r
- self.SetBackgroundColour(wx.WHITE)\r
- self.SetBackgroundStyle(wx.BG_STYLE_CUSTOM)\r
- self.property = None\r
- self.bmp = None\r
- self.Bind(wx.EVT_PAINT, self.OnPaint)\r
-\r
- def OnPaint(self, event):\r
- dc = wx.BufferedPaintDC(self)\r
-\r
- whiteBrush = wx.Brush(wx.WHITE)\r
- dc.SetBackground(whiteBrush)\r
- dc.Clear()\r
-\r
- bmp = self.bmp\r
- if bmp:\r
- dc.DrawBitmap(bmp, 2, 2)\r
- else:\r
- dc.SetPen(wx.Pen(wx.BLACK))\r
- dc.SetBrush(whiteBrush)\r
- dc.DrawRectangle(2, 2, 64, 64)\r
-\r
- def RefreshThumbnail(self):\r
- """\\r
- We use here very simple image scaling code.\r
- """\r
- if not self.property:\r
- self.bmp = None\r
- return\r
-\r
- path = self.property.DoGetValue()\r
-\r
- if not os.path.isfile(path):\r
- self.bmp = None\r
- return\r
-\r
- image = wx.Image(path)\r
- image.Rescale(64, 64)\r
- self.bmp = wx.BitmapFromImage(image)\r
-\r
- def SetProperty(self, property):\r
- self.property = property\r
- self.tc.SetValue(property.GetDisplayedString())\r
- self.RefreshThumbnail()\r
-\r
- def SetValue(self, s):\r
- self.RefreshThumbnail()\r
- self.tc.SetValue(s)\r
-\r
- def GetLastPosition(self):\r
- return self.tc.GetLastPosition()\r
-\r
-\r
-class LargeImageEditor(wxpg.PyEditor):\r
- """\\r
- Double-height text-editor with image in front.\r
- """\r
- def __init__(self):\r
- wxpg.PyEditor.__init__(self)\r
-\r
- def CreateControls(self, propgrid, property, pos, sz):\r
- try:\r
- h = 64 + 6\r
- x = propgrid.GetSplitterPosition()\r
- x2 = propgrid.GetClientSize().x\r
- bw = propgrid.GetRowHeight()\r
- lipc = LargeImagePickerCtrl()\r
- if sys.platform == 'win32':\r
- lipc.Hide()\r
- lipc.Create(propgrid, wxpg.PG_SUBID1, (x,pos[1]), (x2-x-bw,h))\r
- lipc.SetProperty(property)\r
- # Hmmm.. how to have two-stage creation without subclassing?\r
- #btn = wx.PreButton()\r
- #pre = wx.PreWindow()\r
- #self.PostCreate(pre)\r
- #if sys.platform == 'win32':\r
- # btn.Hide()\r
- #btn.Create(propgrid, wxpg.PG_SUBID2, '...', (x2-bw,pos[1]), (bw,h), wx.WANTS_CHARS)\r
- btn = wx.Button(propgrid, wxpg.PG_SUBID2, '...', (x2-bw,pos[1]), (bw,h), wx.WANTS_CHARS)\r
- return (lipc, btn)\r
- except:\r
- import traceback\r
- print traceback.print_exc()\r
-\r
- def UpdateControl(self, property, ctrl):\r
- ctrl.SetValue(property.GetDisplayedString())\r
-\r
- def DrawValue(self, dc, property, rect):\r
- if not (property.GetFlags() & wxpg.PG_PROP_AUTO_UNSPECIFIED):\r
- dc.DrawText( property.GetDisplayedString(), rect.x+5, rect.y );\r
-\r
- def OnEvent(self, propgrid, ctrl, event):\r
- if not ctrl:\r
- return False\r
-\r
- evtType = event.GetEventType()\r
-\r
- if evtType == wx.wxEVT_COMMAND_TEXT_ENTER:\r
- if propgrid.IsEditorsValueModified():\r
- return True\r
-\r
- elif evtType == wx.wxEVT_COMMAND_TEXT_UPDATED:\r
- if not property.HasFlag(wxpg.PG_PROP_AUTO_UNSPECIFIED) or not ctrl or \\r
- ctrl.GetLastPosition() > 0:\r
-\r
- # We must check this since an 'empty' text event\r
- # may be triggered when creating the property.\r
- PG_FL_IN_SELECT_PROPERTY = 0x00100000\r
- if not (propgrid.GetInternalFlags() & PG_FL_IN_SELECT_PROPERTY):\r
- event.Skip();\r
- event.SetId(propgrid.GetId());\r
-\r
- propgrid.EditorsValueWasModified();\r
-\r
- return False\r
-\r
-\r
- def CopyValueFromControl(self, property, ctrl):\r
- tc = ctrl.tc\r
- res = property.SetValueFromString(tc.GetValue(),0)\r
- # Changing unspecified always causes event (returning\r
- # true here should be enough to trigger it).\r
- if not res and property.IsFlagSet(wxpg.PG_PROP_AUTO_UNSPECIFIED):\r
- res = True\r
-\r
- return res\r
-\r
- def SetValueToUnspecified(self, ctrl):\r
- ctrl.tc.Remove(0,len(ctrl.tc.GetValue()));\r
-\r
- def SetControlStringValue(self, ctrl, txt):\r
- ctrl.SetValue(txt)\r
-\r
- def OnFocus(self, property, ctrl):\r
- ctrl.tc.SetSelection(-1,-1)\r
- ctrl.tc.SetFocus()\r
-\r
-\r
-class PropertyEditor(wx.Panel):\r
-\r
- def __init__(self, parent):\r
- # Use the WANTS_CHARS style so the panel doesn't eat the Return key.\r
- wx.Panel.__init__(self, parent, -1, style=wx.WANTS_CHARS, size=(160, 200))\r
-\r
- sizer = wx.BoxSizer(wx.VERTICAL)\r
-\r
- self.pg = wxpg.PropertyGrid(self, style=wxpg.PG_SPLITTER_AUTO_CENTER|wxpg.PG_AUTO_SORT)\r
-\r
- # Show help as tooltips\r
- self.pg.SetExtraStyle(wxpg.PG_EX_HELP_AS_TOOLTIPS)\r
-\r
- #pg.Bind(wxpg.EVT_PG_CHANGED, self.OnPropGridChange)\r
- #pg.Bind(wxpg.EVT_PG_SELECTED, self.OnPropGridSelect)\r
- #self.pg.Bind(wxpg.EVT_PG_RIGHT_CLICK, self.OnPropGridRightClick)\r
-\r
- # Needed by custom image editor\r
- wx.InitAllImageHandlers()\r
-\r
- #\r
- # Let's create a simple custom editor\r
- #\r
- # NOTE: Editor must be registered *before* adding a property that uses it.\r
- self.pg.RegisterEditor(LargeImageEditor)\r
-\r
- '''\r
- #\r
- # Add properties\r
- #\r
-\r
- pg.Append( wxpg.PropertyCategory("1 - Basic Properties") )\r
- pg.Append( wxpg.StringProperty("String",value="Some Text") )\r
- pg.Append( wxpg.IntProperty("Int",value=100) )\r
- pg.Append( wxpg.FloatProperty("Float",value=100.0) )\r
- pg.Append( wxpg.BoolProperty("Bool",value=True) )\r
- pg.Append( wxpg.BoolProperty("Bool_with_Checkbox",value=True) )\r
- pg.SetPropertyAttribute("Bool_with_Checkbox", "UseCheckbox", True)\r
-\r
- pg.Append( wxpg.PropertyCategory("2 - More Properties") )\r
- pg.Append( wxpg.LongStringProperty("LongString",value="This is a\\nmulti-line string\\nwith\\ttabs\\nmixed\\tin.") )\r
- pg.Append( wxpg.DirProperty("Dir",value="C:\\Windows") )\r
- pg.Append( wxpg.FileProperty("File",value="C:\\Windows\\system.ini") )\r
- pg.Append( wxpg.ArrayStringProperty("ArrayString",value=['A','B','C']) )\r
-\r
- pg.Append( wxpg.EnumProperty("Enum","Enum",\r
- ['wxPython Rules','wxPython Rocks','wxPython Is The Best'],\r
- [10,11,12],0) )\r
- pg.Append( wxpg.EditEnumProperty("EditEnum","EditEnumProperty",['A','B','C'],[0,1,2],"Text Not in List") )\r
-\r
- pg.Append( wxpg.PropertyCategory("3 - Advanced Properties") )\r
- pg.Append( wxpg.DateProperty("Date",value=wx.DateTime_Now()) )\r
- pg.Append( wxpg.FontProperty("Font",value=self.GetFont()) )\r
- pg.Append( wxpg.ColourProperty("Colour",value=self.GetBackgroundColour()) )\r
- pg.Append( wxpg.SystemColourProperty("SystemColour") )\r
- pg.Append( wxpg.ImageFileProperty("ImageFile") )\r
- pg.Append( wxpg.MultiChoiceProperty("MultiChoice",choices=['wxWidgets','QT','GTK+']) )\r
-\r
- pg.Append( wxpg.PropertyCategory("4 - Additional Properties") )\r
- pg.Append( wxpg.PointProperty("Point",value=self.GetPosition()) )\r
- pg.Append( wxpg.SizeProperty("Size",value=self.GetSize()) )\r
- pg.Append( wxpg.FontDataProperty("FontData") )\r
- pg.Append( wxpg.IntProperty("IntWithSpin",value=256) )\r
- pg.SetPropertyEditor("IntWithSpin","SpinCtrl")\r
- pg.Append( wxpg.DirsProperty("Dirs",value=['C:/Lib','C:/Bin']) )\r
- pg.SetPropertyHelpString( "String", "String Property help string!" )\r
- pg.SetPropertyHelpString( "Dirs", "Dirs Property help string!" )\r
-\r
- pg.SetPropertyAttribute( "File", wxpg.PG_FILE_SHOW_FULL_PATH, 0 )\r
- pg.SetPropertyAttribute( "File", wxpg.PG_FILE_INITIAL_PATH, "C:\\Program Files\\Internet Explorer" )\r
- pg.SetPropertyAttribute( "Date", wxpg.PG_DATE_PICKER_STYLE, wx.DP_DROPDOWN|wx.DP_SHOWCENTURY )\r
-\r
- pg.Append( wxpg.PropertyCategory("5 - Custom Properties") )\r
- pg.Append( IntProperty2("IntProperty2", value=1024) )\r
-\r
- pg.Append( ShapeProperty("ShapeProperty", value=0) )\r
- pg.Append( PyObjectProperty("PyObjectProperty") )\r
-\r
- pg.Append( wxpg.ImageFileProperty("ImageFileWithLargeEditor") )\r
- pg.SetPropertyEditor("ImageFileWithLargeEditor", "LargeImageEditor")\r
-\r
-\r
- pg.SetPropertyClientData( "Point", 1234 )\r
- if pg.GetPropertyClientData( "Point" ) != 1234:\r
- raise ValueError("Set/GetPropertyClientData() failed")\r
-\r
- # Test setting unicode string\r
- pg.GetPropertyByName("String").SetValue(u"Some Unicode Text")\r
-\r
- #\r
- # Test some code that *should* fail (but not crash)\r
- #try:\r
- #a_ = pg.GetPropertyValue( "NotARealProperty" )\r
- #pg.EnableProperty( "NotAtAllRealProperty", False )\r
- #pg.SetPropertyHelpString( "AgaintNotARealProperty", "Dummy Help String" )\r
- #except:\r
- #pass\r
- #raise\r
-\r
- '''\r
- sizer.Add(self.pg, 1, wx.EXPAND)\r
- self.SetSizer(sizer)\r
- sizer.SetSizeHints(self)\r
-\r
- self.SelectedTreeItem = None\r
-\r
- def GetPropertyValues(self):\r
- return self.pg.GetPropertyValues()\r
-\r
- def Initialize(self, properties):\r
- pg = self.pg\r
- pg.Clear()\r
-\r
- if properties:\r
- for element in properties:\r
- if element[1]['type'] == 'arraystring':\r
- elements = element[1]['elements']\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- #retrieve individual strings\r
- property_value = split(property_value, ' ')\r
- #remove " delimiters\r
- values = [value.strip('"') for value in property_value]\r
- pg.Append(wxpg.ArrayStringProperty(element[0], value=values))\r
-\r
- if element[1]['type'] == 'boolean':\r
- if 'value' in element[1]:\r
- property_value = element[1].as_bool('value')\r
- else:\r
- property_value = element[1].as_bool('default')\r
- property_control = wxpg.BoolProperty(element[0], value=property_value)\r
- pg.Append(property_control)\r
- pg.SetPropertyAttribute(element[0], 'UseCheckbox', True)\r
-\r
- #if element[0] == 'category':\r
- #pg.Append(wxpg.PropertyCategory(element[1]))\r
-\r
- if element[1]['type'] == 'color':\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- property_value = eval(property_value)\r
- pg.Append(wxpg.ColourProperty(element[0], value=property_value))\r
-\r
- if element[1]['type'] == 'enum':\r
- elements = element[1]['elements']\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- pg.Append(wxpg.EnumProperty(element[0], element[0], elements, [], elements.index(property_value)))\r
-\r
- if element[1]['type'] == 'filename':\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- pg.Append(wxpg.FileProperty(element[0], value=property_value))\r
-\r
- if element[1]['type'] == 'float':\r
- if 'value' in element[1]:\r
- property_value = element[1].as_float('value')\r
- else:\r
- property_value = element[1].as_float('default')\r
- property_control = wxpg.FloatProperty(element[0], value=property_value)\r
- pg.Append(property_control)\r
-\r
- if element[1]['type'] == 'folder':\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- pg.Append(wxpg.DirProperty(element[0], value=property_value))\r
-\r
- if element[1]['type'] == 'integer':\r
- if 'value' in element[1]:\r
- property_value = element[1].as_int('value')\r
- else:\r
- property_value = element[1].as_int('default')\r
- property_control = wxpg.IntProperty(element[0], value=property_value)\r
- if 'maximum' in element[1]:\r
- property_control.SetAttribute('Max', element[1].as_int('maximum'))\r
- if 'minimum' in element[1]:\r
- property_control.SetAttribute('Min', element[1].as_int('minimum'))\r
- property_control.SetAttribute('Wrap', True)\r
- pg.Append(property_control)\r
- pg.SetPropertyEditor(element[0], 'SpinCtrl')\r
-\r
- if element[1]['type'] == 'string':\r
- if 'value' in element[1]:\r
- property_value = element[1]['value']\r
- else:\r
- property_value = element[1]['default']\r
- pg.Append(wxpg.StringProperty(element[0], value=property_value))\r
-\r
- pg.Refresh()\r
-\r
- def OnReserved(self, event):\r
- pass\r
+# Copyright (C) 2010 Massimo Sandal <devicerandom@gmail.com>
+# W. Trevor King <wking@drexel.edu>
+#
+# This file is part of Hooke.
+#
+# Hooke is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# Hooke 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 Lesser General
+# Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with Hooke. If not, see
+# <http://www.gnu.org/licenses/>.
+
+"""Property editor panel for Hooke.
+
+wxPropertyGrid is `included in wxPython >= 2.9.1 <included>`_. Until
+then, we'll avoid it because of the *nix build problems.
+
+This module hacks together a workaround to be used until 2.9.1 is
+widely installed (or at least released ;).
+
+.. _included:
+ http://wxpropgrid.sourceforge.net/cgi-bin/index?page=download
+"""
+
+import wx.grid
+
+from . import Panel
+from ....plugin import argument_to_setting
+from ....util.convert import ANALOGS, to_string, from_string
+
+
+def props_from_argument(argument, curves=None, playlists=None):
+ """Convert a :class:`~hooke.command.Argument` to a list of
+ :class:`Property`\s.
+ """
+ type = argument.type
+ if type in ['driver']: # intentionally not handled (yet)
+ return None
+ count = argument.count
+ if count == -1:
+ count = 3 # HACK: should allow unlimited entries (somehow...)
+ argument._display_count = count # suport HACK in execute_command()
+ kwargs = {
+ #'label':argument.name,
+ 'default':argument.default,
+ 'help':argument.help(),
+ }
+ type = ANALOGS.get(type, type) # type consolidation
+ # type handling
+ if type in ['string', 'bool', 'int', 'float', 'path']:
+ _class = globals()['%sProperty' % type.capitalize()]
+ elif type in ['curve', 'playlist']:
+ if type == 'curve':
+ choices = curves # extracted from the current playlist
+ else:
+ choices = playlists
+ properties = []
+ _class = ChoiceProperty
+ kwargs['choices'] = choices
+ else:
+ raise NotImplementedError(argument.type)
+ if count == 1:
+ labels = [argument.name]
+ else:
+ labels = ['%s %d' % (argument.name, i) for i in range(count)]
+ return [(label, _class(label=label, **kwargs)) for label in labels]
+
+
+def props_from_setting(setting):
+ """Convert a :class:`~hooke.config.Setting` to a list of
+ :class:`Property`\s.
+ """
+ # TODO: move props_from_argument code here and use
+ # argument_to_setting there.
+ raise NotImplementedError()
+
+
+class Property (object):
+ def __init__(self, type, label, default, help=None):
+ self.type = type
+ self.label = label
+ self.default = default
+ self.help = help
+
+ def get_editor(self):
+ """Return a suitable grid editor.
+ """
+ raise NotImplementedError()
+
+ def get_renderer(self):
+ """Return a suitable grid renderer.
+
+ Returns `None` if no special renderer is required.
+ """
+ return None
+
+ def string_for_value(self, value):
+ """Return a string representation of `value` for loading the table.
+ """
+ return to_string(value, 'string')
+
+ def value_for_string(self, string):
+ """Return the value represented by `string`.
+ """
+ return from_string(string, 'string')
+
+
+class StringProperty (Property):
+ def __init__(self, **kwargs):
+ assert 'type' not in kwargs, kwargs
+ if 'default' not in kwargs:
+ kwargs['default'] = 0
+ super(StringProperty, self).__init__(type='string', **kwargs)
+
+ def get_editor(self):
+ return wx.grid.GridCellTextEditor()
+
+ def get_renderer(self):
+ return wx.grid.GridCellStringRenderer()
+
+
+class BoolProperty (Property):
+ """A boolean property.
+
+ Notes
+ -----
+ Unfortunately, changing a boolean property takes two clicks:
+
+ 1) create the editor
+ 2) change the value
+
+ There are `ways around this`_, but it's not pretty.
+
+ .. _ways around this:
+ http://wiki.wxpython.org/Change%20wxGrid%20CheckBox%20with%20one%20click
+ """
+ def __init__(self, **kwargs):
+ assert 'type' not in kwargs, kwargs
+ if 'default' not in kwargs:
+ kwargs['default'] = True
+ super(BoolProperty, self).__init__(type='bool', **kwargs)
+
+ def get_editor(self):
+ return wx.grid.GridCellBoolEditor()
+
+ def get_renderer(self):
+ return wx.grid.GridCellBoolRenderer()
+
+ def string_for_value(self, value):
+ if value == True:
+ return '1'
+ return ''
+
+ def value_for_string(self, string):
+ return string == '1'
+
+
+class IntProperty (Property):
+ def __init__(self, **kwargs):
+ assert 'type' not in kwargs, kwargs
+ if 'default' not in kwargs:
+ kwargs['default'] = 0
+ super(IntProperty, self).__init__(type='int', **kwargs)
+
+ def get_editor(self):
+ return wx.grid.GridCellNumberEditor()
+
+ def get_renderer(self):
+ return wx.grid.GridCellNumberRenderer()
+
+ def value_for_string(self, string):
+ return from_string(string, 'int')
+
+
+class FloatProperty (Property):
+ def __init__(self, **kwargs):
+ assert 'type' not in kwargs, kwargs
+ if 'default' not in kwargs:
+ kwargs['default'] = 0.0
+ super(FloatProperty, self).__init__(type='float', **kwargs)
+
+ def get_editor(self):
+ return wx.grid.GridCellFloatEditor()
+
+ def get_renderer(self):
+ return wx.grid.GridCellFloatRenderer()
+
+ def value_for_string(self, string):
+ return from_string(string, 'float')
+
+
+class ChoiceProperty (Property):
+ def __init__(self, choices, **kwargs):
+ assert 'type' not in kwargs, kwargs
+ if 'default' in kwargs:
+ if kwargs['default'] not in choices:
+ choices.insert(0, kwargs['default'])
+ else:
+ kwargs['default'] = choices[0]
+ super(ChoiceProperty, self).__init__(type='choice', **kwargs)
+ self._choices = choices
+
+ def get_editor(self):
+ choices = [self.string_for_value(c) for c in self._choices]
+ return wx.grid.GridCellChoiceEditor(choices=choices)
+
+ def get_renderer(self):
+ return None
+ #return wx.grid.GridCellChoiceRenderer()
+
+ def string_for_value(self, value):
+ if hasattr(value, 'name'):
+ return value.name
+ return str(value)
+
+ def value_for_string(self, string):
+ for choice in self._choices:
+ if self.string_for_value(choice) == string:
+ return choice
+ raise ValueError(string)
+
+
+class PathProperty (StringProperty):
+ """Simple file or path property.
+
+ Currently there isn't a fancy file-picker popup. Perhaps in the
+ future.
+ """
+ def __init__(self, **kwargs):
+ super(PathProperty, self).__init__(**kwargs)
+ self.type = 'path'
+
+
+class PropertyPanel(Panel, wx.grid.Grid):
+ """UI to view/set config values and command argsuments.
+ """
+ def __init__(self, callbacks=None, **kwargs):
+ super(PropertyPanel, self).__init__(
+ name='property editor', callbacks=callbacks, **kwargs)
+ self._properties = []
+
+ self.CreateGrid(numRows=0, numCols=1)
+ self.SetColLabelValue(0, 'value')
+
+ self._last_tooltip = None
+ self.GetGridWindow().Bind(wx.EVT_MOTION, self._on_motion)
+
+ def _on_motion(self, event):
+ """Enable tooltips.
+ """
+ x,y = self.CalcUnscrolledPosition(event.GetPosition())
+ row,col = self.XYToCell(x, y)
+ if col == -1 or row == -1:
+ msg = ''
+ else:
+ msg = self._properties[row].help or ''
+ if msg != self._last_tooltip:
+ self._last_tooltip = msg
+ event.GetEventObject().SetToolTipString(msg)
+
+ def append_property(self, property):
+ if len([p for p in self._properties if p.label == property.label]) > 0:
+ raise ValueError(property) # property.label collision
+ self._properties.append(property)
+ row = len(self._properties) - 1
+ self.AppendRows(numRows=1)
+ self.SetRowLabelValue(row, property.label)
+ self.SetCellEditor(row=row, col=0, editor=property.get_editor())
+ r = property.get_renderer()
+ if r != None:
+ self.SetCellRenderer(row=row, col=0, renderer=r)
+ self.set_property(property.label, property.default)
+
+ def remove_property(self, label):
+ row,property = self._property_by_label(label)
+ self._properties.pop(row)
+ self.DeleteRows(pos=row)
+
+ def clear(self):
+ while(len(self._properties) > 0):
+ self.remove_property(self._properties[-1].label)
+
+ def set_property(self, label, value):
+ row,property = self._property_by_label(label)
+ self.SetCellValue(row=row, col=0, s=property.string_for_value(value))
+
+ def get_property(self, label):
+ row,property = self._property_by_label(label)
+ string = self.GetCellValue(row=row, col=0)
+ return property.value_for_string(string)
+
+ def get_values(self):
+ return dict([(p.label, self.get_property(p.label))
+ for p in self._properties])
+
+ def _property_by_label(self, label):
+ props = [(i,p) for i,p in enumerate(self._properties)
+ if p.label == label]
+ assert len(props) == 1, props
+ row,property = props[0]
+ return (row, property)