Changeset 3219

Timestamp:

06/29/2007 10:45:45 AM (2 years ago)

Author:

ed

Message:

Implemented sorting in dListControl by clicking on the column headers. Added the ListHeaderMouseLeftClick? and ListHeaderMouseRightClick? events to dEvents; these correspond to left and right clicks on the headers of dListControl. Modified the sort routines in dControlItemMixin to take into account the fact that dListControl doesn't have a '_choices' attribute.

Added the AutoConvertToString? property to dListControl. When True (default), adding any non-string item, such as a number, will auto-convert it to a unicode string. When False, trying to insert a non-string item will raise an exception.

Updated init.py to retrieve the event column for list events if available.

Files:

• trunk/dabo/dEvents.py (modified) (2 diffs)
• trunk/dabo/ui/uiwx/__init__.py (modified) (2 diffs)
• trunk/dabo/ui/uiwx/dControlItemMixin.py (modified) (4 diffs)
• trunk/dabo/ui/uiwx/dListControl.py (modified) (16 diffs)

trunk/dabo/dEvents.py

@@ -716 +716 @@
-    This event is not implemented for other grid cell editors, yet.
-    """
+    pass
-
-
@@ -730 +731 @@
-class GridAfterSort(GridEvent):
-    """Occurs after the grid is sorted"""
+    pass
+
+
+class ListHeaderMouseLeftClick(GridEvent, MouseEvent):
+    """Occurs when the left mouse button is clicked in the header region of dListControl."""
+    pass
+
+
+class ListHeaderMouseRightClick(GridEvent, MouseEvent):
+    """Occurs when the right mouse button is clicked in the header region of dListControl."""
-    pass
-

trunk/dabo/ui/uiwx/__init__.py

@@ -347 +347 @@
-        if isinstance(wxEvt, wx.MouseEvent):
-            ed["mouseDown"] = ed["dragging"] = wxEvt.Dragging()
-
+
-    if isinstance(wxEvt, wx.ListEvent):
-        pos = wxEvt.GetPosition()
@@ -353 +353 @@
-        idx, flg = obj.HitTest(pos)
-        ed["listIndex"] = idx
+        try:
+            ed["col"] = wxEvt.GetColumn()
+        except:
+            pass
-
-    if isinstance(wxEvt, wx.MenuEvent):

trunk/dabo/ui/uiwx/dControlItemMixin.py

@@ -93 +93 @@
-        return ms
-
+
+    def sort(self, sortFunction=None):
+        """Sorts the list items. By default, the Python 'cmp' function is 
+        used, but this can be overridden with a custom sortFunction.
+        """
+        if sortFunction is None:
+            sortFunction = self._sortFunction
+        self._choices.sort(sortFunction)
+
-        
-    # Property get/set/del methods follow. Scroll to bottom to see the property
@@ -111 +120 @@
-            self._choices = list(choices)
-            if self._sorted:
-_choices.sort(self._sortFunction
+sort(
-            self.AppendItems(self._choices)
-            if oldVal is not None:
@@ -268 +277 @@
-                if val:
-                    # Force a re-ordering
-_setChoices(self._choices
+sort(
-        else:
-            self._properties["Sorted"] = val
@@ -281 +290 @@
-                self._sortFunction = val
-                # Force a re-ordering
-_setChoices(self._choices
+sort(
-            else:
-                raise TypeError, _("SortFunction must be callable")

trunk/dabo/ui/uiwx/dListControl.py

@@ -30 +30 @@
-        self._hitIndex = None
-        self._valCol = 0
+        self._sortOrder = 0
+        self._sortColumn = -1
+        self._sortOnHeaderClick = True
+        # Do we auto-convert all entries to strings?
+        self._autoConvertToString = True
-
-        try:
@@ -41 +46 @@
-        # Dictionary for tracking images by key value
-        self.__imageList = {}   
+        # Need to set this after the superclass call in order to override the default for
+        # a control with items
+        self.SortFunction = self._listControlSort
-
-
@@ -50 +58 @@
-        self.Bind(wx.EVT_LIST_ITEM_FOCUSED, self.__onFocus)
-        self.Bind(wx.EVT_LIST_KEY_DOWN, self.__onWxKeyDown)
-
-
+
+
+
+
+
+
+
-    def addColumn(self, caption):
-        """ Add a column with the selected caption. """
@@ -170 +183 @@
-            currCol = col
-            for itm in tx:
+                if not isinstance(itm, basestring) and self.AutoConvertToString:
+                    tx = u"%s" % itm
-                new_item = self.append(itm, currCol, row)
-                currCol += 1
@@ -176 +191 @@
-                if insert:
-                    new_item = self.InsertStringItem(row, "")
+                if not isinstance(tx, basestring) and self.AutoConvertToString:
+                    tx = u"%s" % tx
-                self.SetStringItem(row, col, tx)
-            else:
@@ -334 +351 @@
-        
-        
+    def __onWxHeaderClick(self, evt):
+        self.raiseEvent(dEvents.ListHeaderMouseLeftClick, evt)
+        
+        
+    def __onWxHeaderRightClick(self, evt):
+        self.raiseEvent(dEvents.ListHeaderMouseRightClick, evt)
+
+
+    def __onHeaderMouseLeftClick(self, evt):
+        if self.SortOnHeaderClick:
+            if self._sortColumn != evt.col:
+                self._sortColumn = evt.col
+                self._sortOrder = 0
+            else:
+                self._sortOrder += 1
+            self.sort()
+        
+
+    def __onHeaderMouseRightClick(self, evt):
+        pass
+    
+    
+    def _listControlSort(self, x, y):
+        # Default to standard Python comparison
+        return cmp(x, y)
+
+        
+    def sort(self, sortFunction=None):
+        # Sorts the control based on the current sort column.
+        if sortFunction is None:
+            sortFunction = self.SortFunction
+        itemData = self._getItemDataDict()
+        self._fillItemData(self._sortColumn)
+        self.SortItems(sortFunction)
+        self._restoreItemData(itemData)
+    
+    
+    def _getItemDataDict(self):
+        """Return a dict with the items as keys, and the ItemData as values."""
+        ret = {}
+        for row in range(self.RowCount):
+            ret[row] = self.GetItemData(row)
+        return ret
+
+
+    def _fillItemData(self, col):
+        """Sets the Item Data for each row to be the value corresponding to the order
+        for each column.
+        """
+        data = []
+        col = self._sortColumn
+        for row in range(self.RowCount):
+            try:    
+                itm = self.GetItem(row, col)
+                data.append((itm.GetText(), row))
+            except:
+                pass
+        data.sort()
+        if (self._sortOrder % 2):
+            # Odd number of sorts
+            data.reverse()
+        for pos, elem in enumerate(data):
+            self.SetItemData(elem[1], pos)
+    
+    
+    def _restoreItemData(self, dct):
+        """After a sort, returns the original item data values."""
+        for row, val in dct.items():
+            self.SetItemData(row, val)
+        
+    
+    # Property get/set/del methods follow. Scroll to bottom to see the property
+    # definitions themselves.
+    def _getAutoConvertToString(self):
+        return self._autoConvertToString
+
+    def _setAutoConvertToString(self, val):
+        if self._constructed():
+            self._autoConvertToString = val
+        else:
+            self._properties["AutoConvertToString"] = val
+
+
+    def _getChoices(self):
+        dabo.errorLog(_("'Choices' is not a valid property for a dListControl."))
+        return []
+
+        
+    def _getColumnCount(self):
+        return self.GetColumnCount()
+
+    def _setColumnCount(self, val):
+        if self._constructed():
+            cc = self.GetColumnCount()
+            if val < cc:
+                # Remove rightmost columns
+                while val < self.GetColumnCount():
+                    self.removeColumn()
+            elif val > cc:
+                while val > self.GetColumnCount():
+                    self.addColumn(_("Column %s") % self.GetColumnCount())              
+        else:
+            self._properties["ColumnCount"] = val
+        
+        
+    def _getHeaderVisible(self):
+        return not self._hasWindowStyleFlag(wx.LC_NO_HEADER)
+        
+    def _setHeaderVisible(self, val):
+        if bool(val):
+            self._delWindowStyleFlag(wx.LC_NO_HEADER)
+        else:
+            self._addWindowStyleFlag(wx.LC_NO_HEADER)
+
+
+    def _getHitIndex(self):
+        return self._hitIndex
+        
+
+    def _getHorizontalRules(self, val):
+        return self._hasWindowStyleFlag(wx.LC_HRULES)
+        
+
+    def _setHorizontalRules(self, val):
+        if bool(val):
+            self._addWindowStyleFlag(wx.LC_HRULES)
+        else:
+            self._delWindowStyleFlag(wx.LC_HRULES)
+            
+
+    def _getLastSelectedIndex(self):
+        return self._lastSelectedIndex
+        
+
+    def _getMultipleSelect(self):
+        return not self._hasWindowStyleFlag(wx.LC_SINGLE_SEL)
+
+    def _setMultipleSelect(self, val):
+        if bool(val):
+            self._delWindowStyleFlag(wx.LC_SINGLE_SEL)
+        else:
+            self._addWindowStyleFlag(wx.LC_SINGLE_SEL)
+            
+
+    def _getRowCount(self):
+        return self.GetItemCount()
+        
+        
-    def _getSelectedIndices(self):
-        ret = []
@@ -345 +510 @@
-        return ret
-        
-        
-    def _setSelectedIndices(self, selList):
-        if self._constructed():
@@ -356 +520 @@
-            
-
-ColumnCount
-GetColumnCount()
-
-ColumnCount
+SortOnHeaderClick
+_sortOnHeaderClick
+
+SortOnHeaderClick
-        if self._constructed():
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-
-    def _getValue(self):
@@ -425 +537 @@
-        colcnt = self.ColumnCount
-        vc = self.ValueColumn
-        
-        if idx is not None:
-            if 0 <= vc <= colcnt:
@@ -434 +545 @@
-            return item.GetText()
-            
-
-    def _setValue(self, val):
-        if self._constructed():
@@ -457 +567 @@
-        return ret
-        
-
+
-    def _getValCol(self):
-        return self._valCol
+
-    def _setValCol(self, val):
-        self._valCol = val
@@ -466 +577 @@
-    def _getVerticalRules(self, val):
-        return self._hasWindowStyleFlag(wx.LC_VRULES)
-        
-
-    def _setVerticalRules(self, val):
@@ -475 +585 @@
-
-
+    AutoConvertToString = property(_getAutoConvertToString, _setAutoConvertToString, None,
+            _("""When True (default), all non-string values are forced to strings. When False, 
+            attempting to use a non-string value will throw an error.  (bool)"""))
+    
+    Choices = property(_getChoices, None, None,
+            _("""Since dListControl doesn't have the equivalent to 'Choices' as the 
+            other item controls do, this will return an empty list and print a warning 
+            message. (read-only) (list)"""))
+    
-    ColumnCount = property(_getColumnCount, _setColumnCount, None,
-            _("Number of columns in the control  (int)"))
@@ -501 +620 @@
-    SelectedIndices = property(_getSelectedIndices, _setSelectedIndices, None, 
-            _("Returns a list of selected row indices.  (list of int)") )
+    
+    SortOnHeaderClick = property(_getSortOnHeaderClick, _setSortOnHeaderClick, None,
+            _("When True (default), clicking a column header cycles the sorting on that column.  (bool)"))
-    
-    Value = property(_getValue, _setValue, None,
@@ -522 +644 @@
-    DynamicVerticalRules = makeDynamicProperty(VerticalRules)
-    
-
+
+
-class _dListControl_test(dListControl):
-    def afterInit(self):
-Main Column", "Another Column
+Title", "Subtitle", "Release Year
-        self.setColumnWidth(0, 150)
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-    def initProperties(self):
-        self.Width = 275
-        self.Height = 200
-        self.MultipleSelect = True
-        self.HorizontalRules = True
@@ -554 +680 @@
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+