Changeset 1300

Timestamp:

09/11/05 19:32:36 (3 years ago)

Author:

paul

Message:

Refactored lots of the hook methods for events out of dGrid and
made lots of new dEvents, both for the header as well as for the
grid region. For example:

dEvents.GridHeaderMouseRightClick?
dEvents.GridMouseRightClick?

#1 will happen when the user right-clicks in the header, and
#2 will happen when the user right-clicks anywhere in the grid
region.

Reorganized the code so that it isn't quite so spread around.

The datanav grid was relying on one of the hook methods, so I
had to make an explicit binding instead since autoBindEvents
isn't enabled yet.

Files:

• trunk/dabo/dEvents.py (modified) (1 diff)
• trunk/dabo/lib/datanav/Grid.py (modified) (1 diff)
• trunk/dabo/ui/uiwx/dGrid.py (modified) (14 diffs)

trunk/dabo/dEvents.py

@@ -373 +373 @@
-    pass
-
+class GridContextMenu(GridEvent, MenuEvent):
+    """Occurs when the context menu is requested in the grid region."""
+    pass
+
+class GridHeaderContextMenu(GridEvent, MenuEvent):
+    """Occurs when the context menu is requested in the grid header region."""
+    pass
+
+class GridHeaderMouseLeftClick(GridEvent, MouseEvent):
+    """Occurs when the left mouse button is clicked in the header region."""
+    pass
+
+class GridHeaderMouseLeftDoubleClick(GridEvent, MouseEvent):
+    """Occurs when the left mouse button is double-clicked in the header region."""
+    pass
+
+class GridHeaderMouseLeftDown(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes down in the header region."""
+    pass
+
+class GridHeaderMouseLeftUp(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes up in the header region."""
+    pass
+
+class GridHeaderMouseRightDown(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes down in the header region."""
+    pass
+
+class GridHeaderMouseRightUp(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes up in the header region."""
+    pass
+
+class GridHeaderMouseMove(GridEvent, MouseEvent):
+    """Occurs when the mouse moves in the grid header region."""
+    pass
+
+class GridHeaderPaint(GridEvent):
+    """Occurs when it's time to paint the grid header."""
+    pass
+
+class GridMouseLeftClick(GridEvent, MouseEvent):
+    """Occurs when the left mouse button is clicked in the grid region."""
+    pass
+
+class GridMouseLeftDoubleClick(GridEvent, MouseEvent):
+    """Occurs when the left mouse button is double-clicked in the grid region."""
+    pass
+
+class GridMouseLeftDown(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes down in the grid region."""
+    pass
+
+class GridMouseLeftUp(GridEvent, MouseEvent):
+    """Occurs when the left mouse button goes up in the grid region."""
+    pass
+
+class GridMouseRightClick(GridEvent, MouseEvent):
+    """Occurs when the right mouse button is clicked in the header region."""
+    pass
+
+class GridMouseRightDown(GridEvent, MouseEvent):
+    """Occurs when the right mouse button goes down in the grid region."""
+    pass
+
+class GridMouseRightUp(GridEvent, MouseEvent):
+    """Occurs when the right mouse button goes up in the grid region."""
+    pass
+
+class GridMouseMove(GridEvent, MouseEvent):
+    """Occurs when the mouse moves in the grid region (not the headers)."""
+    pass
+
-class GridRowSize(GridEvent):
-    """Occurs when the grid's rows are resized."""

trunk/dabo/lib/datanav/Grid.py

@@ -11 +11 @@
-dabo.ui.loadUI("wx")
-from dabo.dLocalize import _, n_
-
+
-
-class Grid(dabo.ui.dGrid):
+    def _initProperties(self):
+        super(Grid, self)._initProperties()
+        self.bindEvent(dEvents.GridMouseLeftDoubleClick, self.onGridLeftDClick)
+
-    def _afterInit(self):
-        super(Grid, self)._afterInit()

trunk/dabo/ui/uiwx/dGrid.py

@@ -75 +75 @@
-
-        # I have no idea what the kind arg is for. It is sent by wxGrid to this
- (4 when the 
+
-        # wxWidgets docs (but it does appear in the wxPython method signature 
-        # but still isn't documented there.)
@@ -921 +921 @@
-        self.sortArrowColor = "Silver"
-
-
-
-
-
+_
+_
+_
+_
-        #Call the default behavior
-        super(dGrid, self)._afterInit()
@@ -938 +938 @@
-        self.Bind(wx.grid.EVT_GRID_ROW_SIZE, self.__onWxGridRowSize)
-        self.Bind(wx.grid.EVT_GRID_SELECT_CELL, self.__onWxGridSelectCell)
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        self.bindEvent(dEvents.GridRowSize, self._onGridRowSize)
-        self.bindEvent(dEvents.GridSelectCell, self._onGridSelectCell)
-        self.bindEvent(dEvents.GridColSize, self._onGridColSize)
-        self.bindEvent(dEvents.GridRightClick, self.onGridRightClick)
-        self.bindEvent(dEvents.GridCellEdited, self._onGridCellEdited)
+
+        ## wx.EVT_CONTEXT_MENU doesn't appear to be working for dGrid yet:
+#       self.bindEvent(dEvents.GridContextMenu, self._onContextMenu)
+        self.bindEvent(dEvents.GridMouseRightDown, self._onContextMenu)
-
-
@@ -956 +969 @@
-        self.defaultHdrCursor = header.GetCursor()
-
-
-
-
-
-
+
+
+
+
+
+
-        header.Bind(wx.EVT_PAINT, self.__onWxHeaderPaint)
-
-
-MouseLeftUp, self.onMouseLeftUp
-MouseRightUp, self.onMouseRightUp
-MouseMove, self.on
-Paint, self.onHeaderPaint
-
+
+
+GridHeaderMouseLeftDown, self._onGridHeaderMouseLeftDown
+GridHeaderPaint, self._onHeaderPaint
+GridHeaderMouseMove, self._onGridHeader
+GridHeaderMouseLeftUp, self._onGridHeaderMouseLeftUp
+
-
-    def GetCellValue(self, row, col):
@@ -1207 +1221 @@
-        
-
-    def _onGridCellEdited(self, evt):
-        row, col = evt.EventData["row"], evt.EventData["col"]
-        rowData = self.getDataSet()[row]
-        fld = self.Columns[col].Field
-        newVal = self.GetCellValue(row, col)
-        oldVal = rowData[fld]
-        if newVal != oldVal:
-            # Update the local copy of the data
-            rowData[fld] = self.GetCellValue(row, col)
-            # Call the hook
-            self.onGridCellEdited(row, col, newVal)
-
-    def onGridCellEdited(self, row, col, newVal): 
-        """Called when the user has edited a cell
-        and changed the value. Changes to the cell
-        can be written back to the data source if 
-        desired.
-        """
-        pass
-
-
-    def _onGridColSize(self, evt):
-        "Occurs when the user resizes the width of the column."
-        colNum = evt.EventData["rowOrCol"]
-        col = self.Columns[colNum]
-        colName = "Column_%s" % col.Field
-
-        # Sync our column object up with what the grid is reporting, and because
-        # the user made this change, save to the userSettings:
-        width = col.Width = self.GetColSize(colNum)
-        app = self.Application
-        if app is not None:
-            app.setUserSetting("%s.%s.%s.%s" % (self.Form.Name, 
-                                              self.Name, colName, 
-                                              "Width"), width)
-        self.onGridColSize(evt)
-
-    
-    def onGridColSize(self, evt): pass
-
-
-    def _onGridSelectCell(self, evt):
-        """ Occurs when the grid's cell focus has changed."""
-        oldRow = self.CurrentRow
-        newRow = evt.EventData["row"]
-        
-        if oldRow != newRow:
-            if self.bizobj:
-                self.bizobj.RowNumber = newRow
-        self.Form.refreshControls()
-        self.onGridSelectCell(evt)
-
-    def onGridSelectCell(self, evt): pass
-
-
-    def onColumnChange(self, col, chgType):
-        """Called by the grid columns whenever any of their properties
@@ -1275 +1234 @@
-        
-
-
-
-
-
-
-
-
+
-        w = self.Header
-        dc = wx.ClientDC(w)
@@ -1365 +1318 @@
-            self.incSearchTimer.stop()
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
-    def onEnterKeyAction(self):
-        "Customize in subclasses"
@@ -1565 +1344 @@
-        return False
-        
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
-
-
@@ -1833 +1577 @@
-
-
-    def _onGridRowSize(self, evt):
-        """ Occurs when the user sizes the height of the row. If the
-        property 'SameSizeRows' is True, Dabo overrides the wxPython 
-        default and applies that size change to all rows, not just the row 
-        the user sized.
-        """
-        row = evt.GetRowOrCol()
-        size = self.GetRowSize(row)
-
-        # Persist the new size
-        app = self.Application
-        if app is not None:
-            app.setUserSetting("%s.%s.%s" % (
-                               self.Form.Name, self.Name, "RowSize"), size)
-        
-        if self.SameSizeRows:
-            self.SetDefaultRowSize(size, True)
-            self.ForceRefresh()
-        # Call the user hook
-        self.onGridRowSize(evt)
-        
-    def onGridRowSize(self, evt): pass
-
-    
-    def getColByX(self, x):
-        """ Given the x-coordinate, return the column number.
@@ -1864 +1584 @@
-            col = -1
-        return col
-
-
-    def __onWxGridRowSize(self, evt):
-        self.raiseEvent(dEvents.GridRowSize, evt)
-        evt.Skip()
-
-    def __onWxColSize(self, evt):
-        self.raiseEvent(dEvents.GridColSize, evt)
-        evt.Skip()
-        
-    def __onWxGridSelectCell(self, evt):
-        self.raiseEvent(dEvents.GridSelectCell, evt)
-        evt.Skip()
-
-    def __onWxRightClick(self, evt):
-        self.raiseEvent(dEvents.GridRightClick, evt)
-        evt.Skip()
-
-    def __onWxMouseLeftDoubleClick(self, evt):
-        self.raiseEvent(dEvents.MouseLeftDoubleClick, evt)
-        evt.Skip()
-
-    def __onWxCellChange(self, evt):
-        self.raiseEvent(dEvents.GridCellEdited, evt)
-        evt.Skip()
-
-
@@ -1940 +1635 @@
-
-    
-        
-    def cell(self, row, col):
-        class GridCell(object):
@@ -1956 +1650 @@
-        
-
+    ##----------------------------------------------------------##
+    ##        begin: dEvent callbacks for internal use          ##
+    ##----------------------------------------------------------##
+    def _onGridCellEdited(self, evt):
+        row, col = evt.EventData["row"], evt.EventData["col"]
+        rowData = self.getDataSet()[row]
+        fld = self.Columns[col].Field
+        newVal = self.GetCellValue(row, col)
+        oldVal = rowData[fld]
+        if newVal != oldVal:
+            # Update the local copy of the data
+            rowData[fld] = self.GetCellValue(row, col)
+
+
+    def _onGridColSize(self, evt):
+        "Occurs when the user resizes the width of the column."
+        colNum = evt.EventData["rowOrCol"]
+        col = self.Columns[colNum]
+        colName = "Column_%s" % col.Field
+
+        # Sync our column object up with what the grid is reporting, and because
+        # the user made this change, save to the userSettings:
+        width = col.Width = self.GetColSize(colNum)
+        app = self.Application
+        if app is not None:
+            app.setUserSetting("%s.%s.%s.%s" % (self.Form.Name, 
+                                              self.Name, colName, 
+                                              "Width"), width)
+    
+
+    def _onGridSelectCell(self, evt):
+        """ Occurs when the grid's cell focus has changed."""
+        oldRow = self.CurrentRow
+        newRow = evt.EventData["row"]
+        
+        if oldRow != newRow:
+            if self.bizobj:
+                self.bizobj.RowNumber = newRow
+        self.Form.refreshControls()
+
+
+    def _onGridHeaderMouseMove(self, evt):
+        headerIsDragging = self._headerDragging
+        headerIsSizing = self._headerSizing
+        dragging = evt.EventData["mouseDown"]
+        header = self.Header
+
+        if dragging:
+            x,y = evt.EventData["mousePosition"]
+
+            if not headerIsSizing and (
+                self.getColByX(x) == self.getColByX(x-2) == self.getColByX(x+2)):
+                if not headerIsDragging:
+                    # A header reposition is beginning
+                    self._headerDragging = True
+                    self._headerDragFrom = (x,y)
+
+                else:
+                    # already dragging.
+                    begCol = self.getColByX(self._headerDragFrom[0])
+                    curCol = self.getColByX(x)
+
+                    # The visual indicators (changing the mouse cursor) isn't currently
+                    # working. It would work without the evt.Skip() below, but that is 
+                    # needed for when the column is resized.
+                    uic = dUICursors
+                    if begCol == curCol:
+                        # Give visual indication that a move is initiated
+                        header.SetCursor(uic.getStockCursor(uic.Cursor_Size_WE))
+                    else:
+                        # Give visual indication that this is an acceptable drop target
+                        header.SetCursor(uic.getStockCursor(uic.Cursor_Bullseye))
+            else:
+                # A size action is happening
+                self._headerSizing = True
+
+
+    def _onGridHeaderMouseLeftUp(self, evt):
+        """ Occurs when the left mouse button is released in the grid header.
+
+        Basically, this comes down to two possibilities: the end of a drag
+        operation, or a single-click operation. If we were dragging, then
+        it is possible a column needs to change position. If we were clicking,
+        then it is a sort operation.
+        """
+        x,y = evt.EventData["mousePosition"]
+        if self._headerDragging:
+            # A drag action is ending
+            self._headerDragTo = (x,y)
+
+            begCol = self.getColByX(self._headerDragFrom[0])
+            curCol = self.getColByX(x)
+
+            if begCol != curCol:
+                if curCol > begCol:
+                    curCol += 1
+                self.MoveColumn(begCol, curCol)
+            self.Header.SetCursor(self.defaultHdrCursor)
+        elif self._headerSizing:
+            pass
+        else:
+            # we weren't dragging, and the mouse was just released.
+            # Find out the column we are in based on the x-coord, and
+            # do a processSort() on that column.
+            col = self.getColByX(x)
+            self.processSort(col)
+        self._headerDragging = False
+        self._headerSizing = False
+        ## pkm: commented out the evt.Continue=False because it doesn't appear
+        ##      to be needed, and it prevents the native UI from responding.
+        #evt.Continue = False
+
+
+    def _onGridHeaderMouseRightUp(self, evt):
+        """ Occurs when the right mouse button goes up in the grid header."""
+        self.autoSizeCol( self.getColByX(evt.GetX()))
+
+    
+    def _onContextMenu(self, evt):
+        # Make the popup menu appear in the location that was clicked
+        self.mousePosition = evt.GetPosition()
+
+        # Display the popup menu, if any
+        self.popupMenu()
+
+    def _onGridHeaderMouseLeftDown(self, evt):
+        evt.Continue = False
+
+    def _onGridRowSize(self, evt):
+        """ Occurs when the user sizes the height of the row. If the
+        property 'SameSizeRows' is True, Dabo overrides the wxPython 
+        default and applies that size change to all rows, not just the row 
+        the user sized.
+        """
+        row = evt.GetRowOrCol()
+        size = self.GetRowSize(row)
+
+        # Persist the new size
+        app = self.Application
+        if app is not None:
+            app.setUserSetting("%s.%s.%s" % (
+                               self.Form.Name, self.Name, "RowSize"), size)
+        
+        if self.SameSizeRows:
+            self.SetDefaultRowSize(size, True)
+            self.ForceRefresh()
+
+    
+    def _onKeyDown(self, evt): 
+        """ Occurs when the user presses a key inside the grid. 
+        Default actions depend on the key being pressed:
+                    Enter:  edit the record
+                        Del:  delete the record
+                        F2:  sort the current column
+                AlphaNumeric:  incremental search
+        """
+        if self.Editable and self.Columns[self.CurrentColumn].Editable:
+            # Can't search and edit at the same time
+            return
+
+        keyCode = evt.EventData["keyCode"]
+        try:
+            char = chr(keyCode)
+        except ValueError:       # keycode not in ascii range
+            char = None
+
+        if keyCode == dKeys.keyStrings["enter"]:           # Enter
+            self.onEnterKeyAction()
+            evt.stop()
+        else:
+            if keyCode == dKeys.keyStrings["delete"]:      # Del
+                self.onDeleteKeyAction()
+                evt.stop()
+            elif keyCode == dKeys.keyStrings["escape"]:
+                self.onEscapeAction()
+                evt.stop()
+            elif char and (self.Searchable and self.Columns[self.CurrentColumn].Searchable) \
+                and (char.isalnum() or char.isspace()) and not evt.HasModifiers():
+                self.addToSearchStr(char)
+                # For some reason, without this the key happens twice
+                evt.stop()
+            else:
+                if self.processKeyPress(keyCode):
+                    # Key was handled
+                    evt.stop()
+
+
+    def _onHeaderPaint(self, evt):
+        dabo.ui.callAfter(self._paintHeader)
+    
+    ##----------------------------------------------------------##
+    ##        end: dEvent callbacks for internal use            ##
+    ##----------------------------------------------------------##
+
+
+    ##----------------------------------------------------------##
+    ##      begin: wx callbacks to re-route to dEvents          ##
+    ##----------------------------------------------------------##
+    
+    ## dGrid has to reimplement all of this to augment what dPemMixin does,
+    ## to offer separate events in the grid versus the header region.
+    def __onWxContextMenu(self, evt):
+        self.raiseEvent(dEvents.GridContextMenu, evt)
+        evt.Skip()
+
+    def __onWxGridColSize(self, evt):
+        self.raiseEvent(dEvents.GridColSize, evt)
+        evt.Skip()
+        
+    def __onWxGridCellChange(self, evt):
+        self.raiseEvent(dEvents.GridCellEdited, evt)
+        evt.Skip()
+
+    def __onWxGridRowSize(self, evt):
+        self.raiseEvent(dEvents.GridRowSize, evt)
+        evt.Skip()
+
+    def __onWxGridSelectCell(self, evt):
+        self.raiseEvent(dEvents.GridSelectCell, evt)
+        evt.Skip()
+
+    def __onWxHeaderContextMenu(self, evt):
+        self.raiseEvent(dEvents.GridHeaderContextMenu, evt)
+        evt.Skip()
+
+    def __onWxHeaderMouseLeftDoubleClick(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseLeftDoubleClick, evt)
+        evt.Skip()
+
+    def __onWxHeaderMouseLeftDown(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseLeftDown, evt)
+        #evt.Skip() #- don't skip or all the rows will be selected.
+
+    def __onWxHeaderMouseLeftUp(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseLeftUp, evt)
+        evt.Skip()
+
+    def __onWxHeaderMouseMotion(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseMove, evt)
+        evt.Skip()
+
+    def __onWxHeaderMouseRightDown(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseRightDown, evt)
+        evt.Skip()
+
+    def __onWxHeaderMouseRightUp(self, evt):
+        self.raiseEvent(dEvents.GridHeaderMouseRightUp, evt)
+        evt.Skip()
+
+    def __onWxHeaderPaint(self, evt):
+        self.raiseEvent(dEvents.GridHeaderPaint, evt)
+
+    def __onWxMouseLeftDoubleClick(self, evt):
+        self.raiseEvent(dEvents.GridMouseLeftDoubleClick, evt)
+        evt.Skip()
+
+    def __onWxMouseLeftClick(self, evt):
+        self.raiseEvent(dEvents.GridMouseLeftClick, evt)
+        evt.Skip()
+
+    def __onWxMouseLeftDown(self, evt):
+        self.raiseEvent(dEvents.GridMouseLeftDown, evt)
+        evt.Skip()
+
+    def __onWxMouseLeftUp(self, evt):
+        self.raiseEvent(dEvents.GridMouseLeftUp, evt)
+        evt.Skip()
+
+    def __onWxMouseMotion(self, evt):
+        self.raiseEvent(dEvents.GridMouseMove, evt)
+        evt.Skip()
+
+    def __onWxMouseRightClick(self, evt):
+        self.raiseEvent(dEvents.GridRightClick, evt)
+        evt.Skip()
+
+    def __onWxMouseRightDown(self, evt):
+        self.raiseEvent(dEvents.GridMouseRightDown, evt)
+        evt.Skip()
+
+    def __onWxMouseRightUp(self, evt):
+        self.raiseEvent(dEvents.GridMouseRightUp, evt)
+        evt.Skip()
+
+    ##----------------------------------------------------------##
+    ##       end: wx callbacks to re-route to dEvents           ##
+    ##----------------------------------------------------------##
+
+
-    def _getDefaultGridColAttr(self):
-        """ Return the GridCellAttr that will be used for all columns by default."""
@@ -1964 +1947 @@
-    
-
+
+    ##----------------------------------------------------------##
+    ##              begin: property definitions                 ##
+    ##----------------------------------------------------------##
-    def _getColumns(self):
-        try:
@@ -2273 +2260 @@
-            _("Reference to the internal table class  (dGridDataTable)") )
-
+    ##----------------------------------------------------------##
+    ##               end: property definitions                  ##
+    ##----------------------------------------------------------##
+
-
-class _dGrid_test(dGrid):