Applied patches by Scott Pleiter:

[ 643866 ] small wxGrid API changes

adds GetValue to the gridcelleditors to facilitate
querying values from the editors, also changes several
methods to virtuals to simplify inheritance.

[ 643867 ] wxGrid cell LNF & behaviour patch

Enables the grid to render its cells grey when the grid
control is disabled. Also fixes several problems when
making the gridcelleditors visible. Improves the layout
of multi-line row/column labels. Changes the CellEditor
show from a MOUSE_DOWN to a MOUSE_UP, this
stops the editor starting when creating a selection
beginging in the currently selected cell.

[ 643868 ] wxGrid rendering tweaks, improves look.

Draw the row/column using system colours. Change the
default wxGrid settings to have a more neutral starting
point - grey lines, non-bold label font, black/white
selection etc.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18148 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/generic/grid.h

@@ -357,6 +357,10 @@ public:
     // create a new object which is the copy of this one
     virtual wxGridCellEditor *Clone() const = 0;
 
+    // DJC MAPTEK
+    // added GetValue so we can get the value which is in the control
+    virtual wxString GetValue() const = 0;
+
 protected:
     // the dtor is private because only DecRef() can delete us
     virtual ~wxGridCellEditor();
@@ -405,6 +409,9 @@ public:
     virtual wxGridCellEditor *Clone() const
         { return new wxGridCellTextEditor; }
 
+    // DJC MAPTEK
+    // added GetValue so we can get the value which is in the control
+    virtual wxString GetValue() const;
 protected:
     wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; }
 
@@ -441,6 +448,9 @@ public:
 
     virtual wxGridCellEditor *Clone() const
         { return new wxGridCellNumberEditor(m_min, m_max); }
+    // DJC MAPTEK
+    // added GetValue so we can get the value which is in the control
+    virtual wxString GetValue() const;
 
 protected:
     wxSpinCtrl *Spin() const { return (wxSpinCtrl *)m_control; }
@@ -516,6 +526,9 @@ public:
 
     virtual wxGridCellEditor *Clone() const
         { return new wxGridCellBoolEditor; }
+    // DJC MAPTEK
+    // added GetValue so we can get the value which is in the control
+    virtual wxString GetValue() const;
 
 protected:
     wxCheckBox *CBox() const { return (wxCheckBox *)m_control; }
@@ -552,11 +565,16 @@ public:
     virtual void SetParameters(const wxString& params);
 
     virtual wxGridCellEditor *Clone() const;
+    // DJC MAPTEK
+    // added GetValue so we can get the value which is in the control
+    virtual wxString GetValue() const;
 
 protected:
     wxComboBox *Combo() const { return (wxComboBox *)m_control; }
 
-private:
+// DJC - (MAPTEK) you at least need access to m_choices if you
+//                wish to override this class
+protected:
     wxString        m_startValue;
     wxArrayString   m_choices;
     bool            m_allowOthers;
@@ -1416,12 +1434,13 @@ public:
     void RegisterDataType(const wxString& typeName,
                           wxGridCellRenderer* renderer,
                           wxGridCellEditor* editor);
-    wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
+    // DJC MAPTEK
+    virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
     wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const
         { return GetDefaultEditorForCell(c.GetRow(), c.GetCol()); }
-    wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
+    virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
-    wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
+    virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
-    wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
+    virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
 
     // grid may occupy more space than needed for its rows/columns, this
     // function allows to set how big this extra space is

src/generic/grid.cpp

@@ -753,6 +753,13 @@ void wxGridCellTextEditor::SetParameters(const wxString& params)
     }
 }
 
+// DJC MAPTEK
+// return the value in the text control
+wxString wxGridCellTextEditor::GetValue() const
+{
+  return Text()->GetValue();
+}
+
 // ----------------------------------------------------------------------------
 // wxGridCellNumberEditor
 // ----------------------------------------------------------------------------
@@ -954,6 +961,24 @@ void wxGridCellNumberEditor::SetParameters(const wxString& params)
     }
 }
 
+// DJC MAPTEK
+// return the value in the spin control if it is there (the text control otherwise)
+wxString wxGridCellNumberEditor::GetValue() const
+{
+  wxString s;
+
+  if( HasRange() )
+  {
+    int value = Spin()->GetValue();
+    s.Printf(wxT("%ld"), value);
+  }
+  else
+  {
+    s = Text()->GetValue();
+  }
+  return s;
+}
+
 // ----------------------------------------------------------------------------
 // wxGridCellFloatEditor
 // ----------------------------------------------------------------------------
@@ -1280,6 +1305,13 @@ bool wxGridCellBoolEditor::IsAcceptedKey(wxKeyEvent& event)
 
     return FALSE;
 }
+// DJC MAPTEK
+// return the value as "1" for true and the empty string for false
+wxString wxGridCellBoolEditor::GetValue() const
+{
+  bool bSet = CBox()->GetValue();
+  return bSet ? "1" : wxEmptyString;
+}
 
 #endif // wxUSE_CHECKBOX
 
@@ -1408,6 +1440,12 @@ void wxGridCellChoiceEditor::SetParameters(const wxString& params)
     }
 }
 
+// DJC MAPTEK
+// return the value in the text control
+wxString wxGridCellChoiceEditor::GetValue() const
+{
+  return Combo()->GetValue();
+}
 #endif // wxUSE_COMBOBOX
 
 // ----------------------------------------------------------------------------
@@ -1485,6 +1523,9 @@ void wxGridCellRenderer::Draw(wxGrid& grid,
 {
     dc.SetBackgroundMode( wxSOLID );
 
+// DJC (MAPTEK) grey out fields if the grid is disabled
+    if( grid.IsEnabled() )
+    {
       if ( isSelected )
       {
           dc.SetBrush( wxBrush(grid.GetSelectionBackground(), wxSOLID) );
@@ -1493,6 +1534,11 @@ void wxGridCellRenderer::Draw(wxGrid& grid,
       {
           dc.SetBrush( wxBrush(attr.GetBackgroundColour(), wxSOLID) );
       }
+    }  
+    else
+    {
+      dc.SetBrush(wxBrush(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_BTNFACE), wxSOLID));
+    }
 
     dc.SetPen( *wxTRANSPARENT_PEN );
     dc.DrawRectangle(rect);
@@ -1511,6 +1557,9 @@ void wxGridCellStringRenderer::SetTextColoursAndFont(wxGrid& grid,
 
     // TODO some special colours for attr.IsReadOnly() case?
 
+    // DJC (MAPTEK) different coloured text when the grid is disabled
+    if( grid.IsEnabled() )
+    {
       if ( isSelected )
       {
           dc.SetTextBackground( grid.GetSelectionBackground() );
@@ -1521,6 +1570,12 @@ void wxGridCellStringRenderer::SetTextColoursAndFont(wxGrid& grid,
           dc.SetTextBackground( attr.GetBackgroundColour() );
           dc.SetTextForeground( attr.GetTextColour() );
       }
+    }
+    else
+    {
+      dc.SetTextBackground(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_BTNFACE));
+      dc.SetTextForeground(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_GRAYTEXT));
+    }
 
     dc.SetFont( attr.GetFont() );
 }
@@ -3491,13 +3546,15 @@ void wxGridCornerLabelWindow::OnPaint( wxPaintEvent& WXUNUSED(event) )
     int client_width = 0;
     GetClientSize( &client_width, &client_height );
 
-    dc.SetPen( *wxBLACK_PEN );
+    dc.SetPen( wxPen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW),1, wxSOLID) );
     dc.DrawLine( client_width-1, client_height-1, client_width-1, 0 );
     dc.DrawLine( client_width-1, client_height-1, 0, client_height-1 );
-
-    dc.SetPen( *wxWHITE_PEN );
     dc.DrawLine( 0, 0, client_width, 0 );
     dc.DrawLine( 0, 0, 0, client_height );
+
+    dc.SetPen( *wxWHITE_PEN );
+    dc.DrawLine( 1, 1, client_width-1, 1 );
+    dc.DrawLine( 1, 1, 1, client_height-1 );
 }
 
 
@@ -3540,11 +3597,13 @@ BEGIN_EVENT_TABLE( wxGridWindow, wxWindow )
     EVT_ERASE_BACKGROUND( wxGridWindow::OnEraseBackground )
 END_EVENT_TABLE()
 
+// DJC (MAPTEK) 19-Jun-2001 use wxCLIP_CHILDREN as well
 wxGridWindow::wxGridWindow( wxGrid *parent,
                             wxGridRowLabelWindow *rowLblWin,
                             wxGridColLabelWindow *colLblWin,
                             wxWindowID id, const wxPoint &pos, const wxSize &size )
-        : wxWindow( parent, id, pos, size, wxWANTS_CHARS, wxT("grid window") )
+        : wxWindow( parent, id, pos, size, wxWANTS_CHARS|wxCLIP_CHILDREN, wxT("grid window") )
+
 {
     m_owner = parent;
     m_rowLabelWin = rowLblWin;
@@ -3841,13 +3900,14 @@ void wxGrid::Init()
     // TODO: something better than this ?
     //
     m_labelFont = this->GetFont();
-    m_labelFont.SetWeight( m_labelFont.GetWeight() + 2 );
+//    m_labelFont = wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT);
+//    m_labelFont.SetWeight( m_labelFont.GetWeight() + 2 );
 
-    m_rowLabelHorizAlign = wxALIGN_LEFT;
+    m_rowLabelHorizAlign = wxALIGN_CENTRE;
     m_rowLabelVertAlign  = wxALIGN_CENTRE;
 
     m_colLabelHorizAlign = wxALIGN_CENTRE;
-    m_colLabelVertAlign  = wxALIGN_TOP;
+    m_colLabelVertAlign  = wxALIGN_CENTRE;
 
     m_defaultColWidth  = WXGRID_DEFAULT_COL_WIDTH;
     m_defaultRowHeight = m_gridWin->GetCharHeight();
@@ -3858,9 +3918,9 @@ void wxGrid::Init()
     m_defaultRowHeight += 4;
 #endif
 
-    m_gridLineColour = wxColour( 128, 128, 255 );
+    m_gridLineColour = wxColour( 192,192,192 );
     m_gridLinesEnabled = TRUE;
-    m_cellHighlightColour = m_gridLineColour;
+    m_cellHighlightColour = *wxBLACK;
     m_cellHighlightPenWidth = 2;
     m_cellHighlightROPenWidth = 1;
 
@@ -3883,8 +3943,10 @@ void wxGrid::Init()
 
     m_selectingTopLeft = wxGridNoCellCoords;
     m_selectingBottomRight = wxGridNoCellCoords;
-    m_selectionBackground = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
+//  m_selectionBackground = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
-    m_selectionForeground = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
+//  m_selectionForeground = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT);
+    m_selectionBackground = *wxBLACK; 
+    m_selectionForeground = *wxWHITE; 
 
     m_editable = TRUE;  // default for whole grid
 
@@ -3990,6 +4052,29 @@ void wxGrid::CalcDimensions()
     int w = m_numCols > 0 ? GetColRight(m_numCols - 1) + m_extraWidth + 1 : 0;
     int h = m_numRows > 0 ? GetRowBottom(m_numRows - 1) + m_extraHeight + 1 : 0;
 
+// DJC (MAPTEK) 19-Jun-2001 account for editor since it could possibly
+// be larger than the cell
+    // take into account editor if shown
+    if( IsCellEditControlShown() )
+    {
+      int w2, h2;
+      int r = m_currentCellCoords.GetRow();
+      int c = m_currentCellCoords.GetCol();
+      int x = GetColLeft(c);
+      int y = GetRowTop(r);
+
+      // how big is the editor
+      wxGridCellAttr* attr = GetCellAttr(r, c);
+      wxGridCellEditor* editor = attr->GetEditor(this, r, c);
+      editor->GetControl()->GetSize(&w2, &h2);
+      w2 += x;
+      h2 += y;
+      if( w2 > w ) w = w2;
+      if( h2 > h ) h = h2;
+      editor->DecRef();
+      attr->DecRef();
+    }
+
     // preserve (more or less) the previous position
     int x, y;
     GetViewStart( &x, &y );
@@ -5193,26 +5278,6 @@ void wxGrid::ProcessGridCellMouseEvent( wxMouseEvent& event )
                 DisableCellEditControl();
                 MakeCellVisible( coords );
 
-                // if this is the second click on this cell then start
-                // the edit control
-                if ( m_waitForSlowClick &&
-                     (coords == m_currentCellCoords) &&
-                     CanEnableCellControl())
-                {
-                    EnableCellEditControl();
-
-                    wxGridCellAttr* attr = GetCellAttr(m_currentCellCoords);
-                    wxGridCellEditor *editor = attr->GetEditor(this,
-                                                               coords.GetRow(),
-                                                               coords.GetCol());
-                    editor->StartingClick();
-                    editor->DecRef();
-                    attr->DecRef();
-
-                    m_waitForSlowClick = FALSE;
-                }
-                else
-                {
                 if ( event.ControlDown() )
                 {
                     if ( m_selection )
@@ -5230,6 +5295,7 @@ void wxGrid::ProcessGridCellMouseEvent( wxMouseEvent& event )
                 }
                 else
                 {
+                    m_waitForSlowClick = m_currentCellCoords == coords && coords != wxGridNoCellCoords;
                     SetCurrentCell( coords );
                     if ( m_selection )
                     {
@@ -5240,8 +5306,6 @@ void wxGrid::ProcessGridCellMouseEvent( wxMouseEvent& event )
                         }
                     }
                 }
-                    m_waitForSlowClick = TRUE;
-                }
             }
         }
     }
@@ -5292,12 +5356,27 @@ void wxGrid::ProcessGridCellMouseEvent( wxMouseEvent& event )
 
                 m_selectingTopLeft = wxGridNoCellCoords;
                 m_selectingBottomRight = wxGridNoCellCoords;
-            }
 
                 // Show the edit control, if it has been hidden for
                 // drag-shrinking.
                 ShowCellEditControl();
             }
+            else
+            {
+              if( m_waitForSlowClick && CanEnableCellControl())
+              {
+                EnableCellEditControl();
+
+                wxGridCellAttr* attr = GetCellAttr(coords);
+                wxGridCellEditor *editor = attr->GetEditor(this, coords.GetRow(), coords.GetCol());
+                editor->StartingClick();
+                editor->DecRef();
+                attr->DecRef();
+
+                m_waitForSlowClick = FALSE;
+              }
+            }
+        }
         else if ( m_cursorMode == WXGRID_CURSOR_RESIZE_ROW )
         {
             ChangeCursorMode(WXGRID_CURSOR_SELECT_CELL);
@@ -6111,15 +6190,14 @@ void wxGrid::OnKeyDown( wxKeyEvent& event )
                     if ( (event.KeyCode() == WXK_F2 && !event.HasModifiers())
                          || editor->IsAcceptedKey(event) )
                     {
+                        // DJC MAPTEK - ensure cell is visble
+                        MakeCellVisible(row, col);
                         EnableCellEditControl();
-
+                        // DJC MAPTEK - a problem can arise if the cell is not
-                        // the editor could be not shown for a variety of
+                        // completely visible (even after calling MakeCellVisible
-                        // reasons (i.e. blocked by the app or whatever), so
+                        // the control is not created and calling StartingKey will
-                        // check if it really was created
+                        // crash the app
-                        if ( m_cellEditCtrlEnabled )
+                        if( editor->IsCreated() && m_cellEditCtrlEnabled ) editor->StartingKey(event);
-                        {
-                            editor->StartingKey(event);
-                        }
                     }
                     else
                     {
@@ -6629,7 +6707,9 @@ void wxGrid::DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr )
 
 
         // Now draw the rectangle
-        dc.SetPen(wxPen(m_cellHighlightColour, penWidth, wxSOLID));
+        // use the cellHighlightColour if the cell is inside a selection, this
+        // will ensure the cell is always visible.
+        dc.SetPen(wxPen(IsInSelection(row,col)?m_selectionForeground:m_cellHighlightColour, penWidth, wxSOLID));
         dc.SetBrush(*wxTRANSPARENT_BRUSH);
         dc.DrawRectangle(rect);
     }
@@ -6857,15 +6937,17 @@ void wxGrid::DrawRowLabel( wxDC& dc, int row )
     int rowTop = GetRowTop(row),
         rowBottom = GetRowBottom(row) - 1;
 
-    dc.SetPen( *wxBLACK_PEN );
+    dc.SetPen( wxPen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW),1, wxSOLID) );
     dc.DrawLine( m_rowLabelWidth-1, rowTop,
                  m_rowLabelWidth-1, rowBottom );
 
-    dc.DrawLine( 0, rowBottom, m_rowLabelWidth-1, rowBottom );
+    dc.DrawLine( 0, rowTop, 0, rowBottom );
+
+    dc.DrawLine( 0, rowBottom, m_rowLabelWidth, rowBottom );
 
     dc.SetPen( *wxWHITE_PEN );
-    dc.DrawLine( 0, rowTop, 0, rowBottom );
+    dc.DrawLine( 1, rowTop, 1, rowBottom );
-    dc.DrawLine( 0, rowTop, m_rowLabelWidth-1, rowTop );
+    dc.DrawLine( 1, rowTop, m_rowLabelWidth-1, rowTop );
 
     dc.SetBackgroundMode( wxTRANSPARENT );
     dc.SetTextForeground( GetLabelTextColour() );
@@ -6905,16 +6987,18 @@ void wxGrid::DrawColLabel( wxDC& dc, int col )
     int colLeft = GetColLeft(col),
         colRight = GetColRight(col) - 1;
 
-    dc.SetPen( *wxBLACK_PEN );
+    dc.SetPen( wxPen(wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW),1, wxSOLID) );
     dc.DrawLine( colRight, 0,
                  colRight, m_colLabelHeight-1 );
 
+    dc.DrawLine( colLeft, 0, colRight, 0 );
+
     dc.DrawLine( colLeft, m_colLabelHeight-1,
-                 colRight, m_colLabelHeight-1 );
+                 colRight+1, m_colLabelHeight-1 );
 
     dc.SetPen( *wxWHITE_PEN );
-    dc.DrawLine( colLeft, 0, colLeft, m_colLabelHeight-1 );
+    dc.DrawLine( colLeft, 1, colLeft, m_colLabelHeight-1 );
-    dc.DrawLine( colLeft, 0, colRight, 0 );
+    dc.DrawLine( colLeft, 1, colRight, 1 );
 
     dc.SetBackgroundMode( wxTRANSPARENT );
     dc.SetTextForeground( GetLabelTextColour() );
@@ -6963,31 +7047,17 @@ void wxGrid::DrawTextRectangle( wxDC& dc,
 {
     long textWidth, textHeight;
     long lineWidth, lineHeight;
+    int nLines;
 
     dc.SetClippingRegion( rect );
-    if ( lines.GetCount() )
-    {
-        GetTextBoxSize( dc, lines, &textWidth, &textHeight );
-        dc.GetTextExtent( lines[0], &lineWidth, &lineHeight );
 
+    nLines = lines.GetCount();
+    if( nLines > 0 )
+    {
+      int l;
       float x, y;
-        switch ( horizAlign )
+      GetTextBoxSize(dc, lines, &textWidth, &textHeight);
-        {
+      switch( vertAlign )
-            case wxALIGN_RIGHT:
-                x = rect.x + (rect.width - textWidth - 1);
-                break;
-
-            case wxALIGN_CENTRE:
-                x = rect.x + ((rect.width - textWidth)/2);
-                break;
-
-            case wxALIGN_LEFT:
-            default:
-                x = rect.x + 1;
-                break;
-        }
-
-        switch ( vertAlign )
       {
         case wxALIGN_BOTTOM:
           y = rect.y + (rect.height - textHeight - 1);
@@ -7003,13 +7073,31 @@ void wxGrid::DrawTextRectangle( wxDC& dc,
           break;
       }
 
-        for ( size_t i = 0;  i < lines.GetCount();  i++ )
+      // Align each line of a multi-line label
+      for( l = 0; l < nLines; l++ )
       {
-            dc.DrawText( lines[i], (int)x, (int)y );
+        dc.GetTextExtent(lines[l], &lineWidth, &lineHeight);
+
+        switch( horizAlign )
+        {
+          case wxALIGN_RIGHT:
+            x = rect.x + (rect.width - lineWidth - 1);
+            break;
+
+          case wxALIGN_CENTRE:
+            x = rect.x + ((rect.width - lineWidth)/2);
+            break;
+
+          case wxALIGN_LEFT:
+          default:
+            x = rect.x + 1;
+            break;
+        }
+
+        dc.DrawText( lines[l], (int)x, (int)y );
         y += lineHeight;
       }
     }
-
     dc.DestroyClippingRegion();
 }
 
@@ -7267,7 +7355,6 @@ void wxGrid::ShowCellEditControl()
                 GetEventHandler()->ProcessEvent(evt);
             }
 
-            editor->Show( TRUE, attr );
 
             // resize editor to overflow into righthand cells if allowed
             int maxWidth = rect.width;
@@ -7301,7 +7388,13 @@ void wxGrid::ShowCellEditControl()
                 if (rect.GetRight() > client_right)
                     rect.SetRight(client_right-1);
             }
+
+// DJC (MAPTEK) 19-Feb-2001 do set size prior to showing the control
             editor->SetSize( rect );
+            editor->Show( TRUE, attr );
+// DJC (MAPTEK) 19-Jun-2001 recalc dimensions in case we need to
+// expand the scrolled window to account for editor
+            CalcDimensions();
 
             editor->BeginEdit(row, col, this);
 
@@ -7624,17 +7717,11 @@ void wxGrid::MakeCellVisible( int row, int col )
         }
         else if ( right > cw )
         {
-            int w = r.GetWidth();
+            // DJC MAPTEK
-            xpos = r.GetLeft();
+            // position the view so that the cell is on the right
-            for ( i = col-1;  i >= 0;  i-- )
+            int x0, y0;
-            {
+            CalcUnscrolledPosition(0, 0, &x0, &y0);
-                int colWidth = GetColWidth(i);
+            xpos = x0 + (right - cw);
-                if ( w + colWidth > cw )
-                    break;
-
-                w += colWidth;
-                xpos -= colWidth;
-            }
 
             // see comment for ypos above
             xpos += GRID_SCROLL_LINE_X;
@@ -9085,6 +9172,17 @@ void wxGrid::SetColSize( int col, int width )
         InitColWidths();
     }
 
+    // DJC MAPTEK if < 0 calc new width from label
+    if( width < 0 )
+    {
+      long w, h;
+      wxArrayString lines;
+      wxClientDC dc(m_colLabelWin);
+      dc.SetFont(GetLabelFont());
+      StringToLines(GetColLabelValue(col), lines);
+      GetTextBoxSize(dc, lines, &w, &h);
+      width = w + 6;
+    }
     int w = wxMax( 0, width );
     int diff = w - m_colWidths[col];
     m_colWidths[col] = w;