]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/generic/grid.h
declare the wx2os2PenStyle helper in the header.
[wxWidgets.git] / include / wx / generic / grid.h
index 5f4a112e780561c94d4563f66572f3d84ca22eef..21ad06b098d4d4c724819726bb03e6fe3e1da52f 100644 (file)
@@ -48,7 +48,7 @@
 #define WXGRID_DEFAULT_COL_WIDTH              80
 #define WXGRID_DEFAULT_COL_LABEL_HEIGHT       32
 #define WXGRID_DEFAULT_ROW_LABEL_WIDTH        82
-#define WXGRID_LABEL_EDGE_ZONE                 5
+#define WXGRID_LABEL_EDGE_ZONE                 2
 #define WXGRID_MIN_ROW_HEIGHT                 15
 #define WXGRID_MIN_COL_WIDTH                  15
 #define WXGRID_DEFAULT_SCROLLBAR_WIDTH        16
@@ -76,6 +76,7 @@ class WXDLLEXPORT wxGridRowLabelWindow;
 class WXDLLEXPORT wxGridTableBase;
 class WXDLLEXPORT wxGridWindow;
 class WXDLLEXPORT wxGridTypeRegistry;
+class WXDLLEXPORT wxGridSelection;
 
 class WXDLLEXPORT wxCheckBox;
 class WXDLLEXPORT wxComboBox;
@@ -297,6 +298,8 @@ public:
     wxGridCellEditor();
 
     bool IsCreated() { return m_control != NULL; }
+    wxControl* GetControl() { return m_control; }
+    void SetControl(wxControl* control) { m_control = control; }
 
     // Creates the actual edit control
     virtual void Create(wxWindow* parent,
@@ -325,9 +328,18 @@ public:
     // Reset the value in the control back to its starting value
     virtual void Reset() = 0;
 
-    // If the editor is enabled by pressing keys on the grid,
-    // this will be called to let the editor do something about
-    // that first key if desired.
+    // return TRUE to allow the given key to start editing: the base class
+    // version only checks that the event has no modifiers. The derived
+    // classes are supposed to do "if ( base::IsAcceptedKey() && ... )" in
+    // their IsAcceptedKey() implementation, although, of course, it is not a
+    // mandatory requirment.
+    //
+    // NB: if the key is F2 (special), editing will always start and this
+    //     method will not be called at all (but StartingKey() will)
+    virtual bool IsAcceptedKey(wxKeyEvent& event);
+
+    // If the editor is enabled by pressing keys on the grid, this will be
+    // called to let the editor do something about that first key if desired
     virtual void StartingKey(wxKeyEvent& event);
 
     // if the editor is enabled by clicking on the cell, this method will be
@@ -376,6 +388,7 @@ public:
 
     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 
+    virtual bool IsAcceptedKey(wxKeyEvent& event);
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 
@@ -413,6 +426,7 @@ public:
                         wxWindowID id,
                         wxEvtHandler* evtHandler);
 
+    virtual bool IsAcceptedKey(wxKeyEvent& event);
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 
@@ -446,10 +460,13 @@ private:
 class WXDLLEXPORT wxGridCellFloatEditor : public wxGridCellTextEditor
 {
 public:
+    wxGridCellFloatEditor(int width = -1, int precision = -1);
+
     virtual void Create(wxWindow* parent,
                         wxWindowID id,
                         wxEvtHandler* evtHandler);
 
+    virtual bool IsAcceptedKey(wxKeyEvent& event);
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 
@@ -459,12 +476,16 @@ public:
     virtual wxGridCellEditor *Clone() const
         { return new wxGridCellFloatEditor; }
 
+    // parameters string format is "width,precision"
+    virtual void SetParameters(const wxString& params);
+
 protected:
     // string representation of m_valueOld
-    wxString GetString() const
-        { return wxString::Format(_T("%f"), m_valueOld); }
+    wxString GetString() const;
 
 private:
+    int m_width,
+        m_precision;
     double m_valueOld;
 };
 
@@ -479,6 +500,7 @@ public:
     virtual void SetSize(const wxRect& rect);
     virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL);
 
+    virtual bool IsAcceptedKey(wxKeyEvent& event);
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 
@@ -501,7 +523,7 @@ class WXDLLEXPORT wxGridCellChoiceEditor : public wxGridCellEditor
 public:
     // if !allowOthers, user can't type a string not in choices array
     wxGridCellChoiceEditor(size_t count = 0,
-                           const wxChar* choices[] = NULL,
+                           const wxString choices[] = NULL,
                            bool allowOthers = FALSE);
 
     virtual void Create(wxWindow* parent,
@@ -542,7 +564,8 @@ public:
     wxGridCellAttr()
     {
         Init();
-        SetAlignment(0, 0);
+        // MB: args used to be 0,0 here but wxALIGN_LEFT is 0
+        SetAlignment(-1, -1);
     }
 
     // VZ: considering the number of members wxGridCellAttr has now, this ctor
@@ -588,7 +611,7 @@ public:
     bool HasTextColour() const { return m_colText.Ok(); }
     bool HasBackgroundColour() const { return m_colBack.Ok(); }
     bool HasFont() const { return m_font.Ok(); }
-    bool HasAlignment() const { return m_hAlign || m_vAlign; }
+    bool HasAlignment() const { return (m_hAlign != -1 || m_vAlign != -1); }
     bool HasRenderer() const { return m_renderer != NULL; }
     bool HasEditor() const { return m_editor != NULL; }
 
@@ -698,8 +721,8 @@ public:
 
     // You must override these functions in a derived table class
     //
-    virtual long GetNumberRows() = 0;
-    virtual long GetNumberCols() = 0;
+    virtual int GetNumberRows() = 0;
+    virtual int GetNumberCols() = 0;
     virtual bool IsEmptyCell( int row, int col ) = 0;
     virtual wxString GetValue( int row, int col ) = 0;
     virtual void SetValue( int row, int col, const wxString& value ) = 0;
@@ -753,11 +776,6 @@ public:
     // a wxGridCellAttrProvider if necessary.
     virtual bool CanHaveAttributes();
 
-
-    // change row/col number in attribute if needed
-    virtual void UpdateAttrRows( size_t pos, int numRows );
-    virtual void UpdateAttrCols( size_t pos, int numCols );
-
     // by default forwarded to wxGridCellAttrProvider if any. May be
     // overridden to handle attributes directly in the table.
     virtual wxGridCellAttr *GetAttr( int row, int col );
@@ -842,8 +860,8 @@ public:
 
     // these are pure virtual in wxGridTableBase
     //
-    long GetNumberRows();
-    long GetNumberCols();
+    int GetNumberRows();
+    int GetNumberCols();
     wxString GetValue( int row, int col );
     void SetValue( int row, int col, const wxString& s );
     bool IsEmptyCell( int row, int col );
@@ -893,11 +911,11 @@ public:
 
     // default copy ctor is ok
 
-    long GetRow() const { return m_row; }
-    void SetRow( long n ) { m_row = n; }
-    long GetCol() const { return m_col; }
-    void SetCol( long n ) { m_col = n; }
-    void Set( long row, long col ) { m_row = row; m_col = col; }
+    int GetRow() const { return m_row; }
+    void SetRow( int n ) { m_row = n; }
+    int GetCol() const { return m_col; }
+    void SetCol( int n ) { m_col = n; }
+    void Set( int row, int col ) { m_row = row; m_col = col; }
 
     wxGridCellCoords& operator=( const wxGridCellCoords& other )
     {
@@ -925,15 +943,15 @@ public:
     }
 
 private:
-    long m_row;
-    long m_col;
+    int m_row;
+    int m_col;
 };
 
 
 // For comparisons...
 //
-extern wxGridCellCoords wxGridNoCellCoords;
-extern wxRect           wxGridNoCellRect;
+extern WXDLLEXPORT wxGridCellCoords wxGridNoCellCoords;
+extern WXDLLEXPORT wxRect           wxGridNoCellRect;
 
 // An array of cell coords...
 //
@@ -960,8 +978,15 @@ public:
 
     ~wxGrid();
 
-    bool CreateGrid( int numRows, int numCols );
+    enum wxGridSelectionModes {wxGridSelectCells,
+                               wxGridSelectRows,
+                               wxGridSelectColumns};
 
+    bool CreateGrid( int numRows, int numCols,
+                     wxGrid::wxGridSelectionModes selmode =
+                     wxGrid::wxGridSelectCells );
+
+    void SetSelectionMode(wxGrid::wxGridSelectionModes selmode);
 
     // ------ grid dimensions
     //
@@ -971,10 +996,10 @@ public:
 
     // ------ display update functions
     //
-    void CalcRowLabelsExposed( wxRegion& reg );
+    void CalcRowLabelsExposed( const wxRegion& reg );
 
-    void CalcColLabelsExposed( wxRegion& reg );
-    void CalcCellsExposed( wxRegion& reg );
+    void CalcColLabelsExposed( const wxRegion& reg );
+    void CalcCellsExposed( const wxRegion& reg );
 
 
     // ------ event handlers
@@ -989,7 +1014,9 @@ public:
     void DoEndDragResizeCol();
 
     wxGridTableBase * GetTable() const { return m_table; }
-    bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE );
+    bool SetTable( wxGridTableBase *table, bool takeOwnership=FALSE,
+                   wxGrid::wxGridSelectionModes selmode =
+                   wxGrid::wxGridSelectCells );
 
     void ClearGrid();
     bool InsertRows( int pos = 0, int numRows = 1, bool updateLabels=TRUE );
@@ -1020,8 +1047,8 @@ public:
     // ------ Cell text drawing functions
     //
     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
-                            int horizontalAlignment = wxLEFT,
-                            int verticalAlignment = wxTOP );
+                            int horizontalAlignment = wxALIGN_LEFT,
+                            int verticalAlignment = wxALIGN_TOP );
 
     // Split a string containing newline chararcters into an array of
     // strings and return the number of lines
@@ -1039,9 +1066,19 @@ public:
     // flicker
     //
     void     BeginBatch() { m_batchCount++; }
-    void     EndBatch() { if ( m_batchCount > 0 ) m_batchCount--; }
+    void     EndBatch();
+
     int      GetBatchCount() { return m_batchCount; }
 
+    // Use this, rather than wxWindow::Refresh(), to force an
+    // immediate repainting of the grid. Has no effect if you are
+    // already inside a BeginBatch / EndBatch block.
+    //
+    // This function is necessary because wxGrid has a minimal OnPaint()
+    // handler to reduce screen flicker.
+    //
+    void     ForceRefresh();
+    
 
     // ------ edit control functions
     //
@@ -1052,6 +1089,7 @@ public:
     void DisableCellEditControl() { EnableCellEditControl(FALSE); }
     bool CanEnableCellControl() const;
     bool IsCellEditControlEnabled() const;
+    bool IsCellEditControlShown() const;
 
     bool IsCurrentCellReadOnly() const;
 
@@ -1095,16 +1133,16 @@ public:
     void SetGridCursor( int row, int col )
         { SetCurrentCell( wxGridCellCoords(row, col) ); }
 
-    bool MoveCursorUp();
-    bool MoveCursorDown();
-    bool MoveCursorLeft();
-    bool MoveCursorRight();
+    bool MoveCursorUp( bool expandSelection );
+    bool MoveCursorDown( bool expandSelection );
+    bool MoveCursorLeft( bool expandSelection );
+    bool MoveCursorRight( bool expandSelection );
     bool MovePageDown();
     bool MovePageUp();
-    bool MoveCursorUpBlock();
-    bool MoveCursorDownBlock();
-    bool MoveCursorLeftBlock();
-    bool MoveCursorRightBlock();
+    bool MoveCursorUpBlock( bool expandSelection );
+    bool MoveCursorDownBlock( bool expandSelection );
+    bool MoveCursorLeftBlock( bool expandSelection );
+    bool MoveCursorRightBlock( bool expandSelection );
 
 
     // ------ label and gridline formatting
@@ -1121,6 +1159,7 @@ public:
     wxString GetRowLabelValue( int row );
     wxString GetColLabelValue( int col );
     wxColour GetGridLineColour() { return m_gridLineColour; }
+    wxColour GetCellHighlightColour() { return m_cellHighlightColour; }
 
     void     SetRowLabelSize( int width );
     void     SetColLabelSize( int height );
@@ -1132,6 +1171,7 @@ public:
     void     SetRowLabelValue( int row, const wxString& );
     void     SetColLabelValue( int col, const wxString& );
     void     SetGridLineColour( const wxColour& );
+    void     SetCellHighlightColour( const wxColour& );
 
     void     EnableDragRowSize( bool enable = TRUE );
     void     DisableDragRowSize() { EnableDragRowSize( FALSE ); }
@@ -1260,43 +1300,27 @@ public:
     void SelectRow( int row, bool addToSelected = FALSE );
     void SelectCol( int col, bool addToSelected = FALSE );
 
-    void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol );
+    void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol,
+                      bool addToSelected = FALSE );
 
     void SelectBlock( const wxGridCellCoords& topLeft,
-                      const wxGridCellCoords& bottomRight )
+                      const wxGridCellCoords& bottomRight,
+                      bool addToSelected = FALSE )
         { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
-                       bottomRight.GetRow(), bottomRight.GetCol() ); }
+                       bottomRight.GetRow(), bottomRight.GetCol(),
+                       addToSelected ); }
 
     void SelectAll();
 
-    bool IsSelection()
-        { return ( m_selectedTopLeft != wxGridNoCellCoords &&
-                   m_selectedBottomRight != wxGridNoCellCoords );
-        }
+    bool IsSelection();
 
     void ClearSelection();
 
-    bool IsInSelection( int row, int col )
-        { return ( IsSelection() &&
-                   row >= m_selectedTopLeft.GetRow() &&
-                   col >= m_selectedTopLeft.GetCol() &&
-                   row <= m_selectedBottomRight.GetRow() &&
-                   col <= m_selectedBottomRight.GetCol() );
-        }
+    bool IsInSelection( int row, int col );
 
     bool IsInSelection( const wxGridCellCoords& coords )
         { return IsInSelection( coords.GetRow(), coords.GetCol() ); }
 
-    void GetSelection( int* topRow, int* leftCol, int* bottomRow, int* rightCol )
-        {
-            // these will all be -1 if there is no selected block
-            //
-            *topRow    = m_selectedTopLeft.GetRow();
-            *leftCol   = m_selectedTopLeft.GetCol();
-            *bottomRow = m_selectedBottomRight.GetRow();
-            *rightCol  = m_selectedBottomRight.GetCol();
-        }
-
 
     // This function returns the rectangle that encloses the block of cells
     // limited by TopLeft and BottomRight cell in device coords and clipped
@@ -1305,15 +1329,6 @@ public:
     wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
                               const wxGridCellCoords & bottomRight );
 
-    // This function returns the rectangle that encloses the selected cells
-    // in device coords and clipped to the client size of the grid window.
-    //
-    wxRect SelectionToDeviceRect()
-        {
-            return BlockToDeviceRect( m_selectedTopLeft,
-                                      m_selectedBottomRight );
-        }
-
     // Access or update the selection fore/back colours
     wxColour GetSelectionBackground() const
         { return m_selectionBackground; }
@@ -1356,7 +1371,7 @@ public:
             int x, int y, int w = -1, int h = -1,
             long style = wxWANTS_CHARS,
             const wxString& name = wxPanelNameStr )
-        : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h), 
+        : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h),
                             (style|wxWANTS_CHARS), name )
         {
             Create();
@@ -1376,8 +1391,8 @@ public:
     int GetScrollPosX() { return 0; }
     int GetScrollPosY() { return 0; }
 
-    void SetScrollX( int x ) { }
-    void SetScrollY( int y ) { }
+    void SetScrollX( int WXUNUSED(x) ) { }
+    void SetScrollY( int WXUNUSED(y) ) { }
 
     void SetColumnWidth( int col, int width )
         { SetColSize( col, width ); }
@@ -1479,15 +1494,15 @@ public:
     void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); }
     bool GetEditInPlace() { return IsCellEditControlEnabled(); }
 
-    void SetEditInPlace(bool edit = TRUE) { }
+    void SetEditInPlace(bool WXUNUSED(edit) = TRUE) { }
 
     void SetCellAlignment( int align, int row, int col)
-    { SetCellAlignment(row, col, align, wxCENTER); }
+    { SetCellAlignment(row, col, align, wxALIGN_CENTER); }
     void SetCellAlignment( int WXUNUSED(align) ) {}
     void SetCellBitmap(wxBitmap *WXUNUSED(bitmap), int WXUNUSED(row), int WXUNUSED(col))
     { }
     void SetDividerPen(const wxPen& WXUNUSED(pen)) { }
-    wxPen& GetDividerPen() const { return wxNullPen; }
+    wxPen& GetDividerPen() const;
     void OnActivate(bool WXUNUSED(active)) {}
 
     // ******** End of compatibility functions **********
@@ -1511,7 +1526,6 @@ protected:
     virtual wxSize DoGetBestSize() const;
 
     bool m_created;
-    bool m_displayed;
 
     wxGridWindow             *m_gridWin;
     wxGridRowLabelWindow     *m_rowLabelWin;
@@ -1521,18 +1535,15 @@ protected:
     wxGridTableBase          *m_table;
     bool                      m_ownTable;
 
-    int m_left;
-    int m_top;
-    int m_right;
-    int m_bottom;
-
     int m_numRows;
     int m_numCols;
 
     wxGridCellCoords m_currentCellCoords;
 
-    wxGridCellCoords m_selectedTopLeft;
-    wxGridCellCoords m_selectedBottomRight;
+    wxGridCellCoords m_selectingTopLeft;
+    wxGridCellCoords m_selectingBottomRight;
+    wxGridCellCoords m_selectingKeyboard;
+    wxGridSelection  *m_selection;
     wxColour    m_selectionBackground;
     wxColour    m_selectionForeground;
 
@@ -1587,6 +1598,7 @@ protected:
 
     wxColour   m_gridLineColour;
     bool       m_gridLinesEnabled;
+    wxColour   m_cellHighlightColour;
 
     // common part of AutoSizeColumn/Row() and GetBestSize()
     int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE);
@@ -1712,6 +1724,7 @@ protected:
     void OnPaint( wxPaintEvent& );
     void OnSize( wxSizeEvent& );
     void OnKeyDown( wxKeyEvent& );
+    void OnKeyUp( wxKeyEvent& );
     void OnEraseBackground( wxEraseEvent& );
 
 
@@ -1719,12 +1732,19 @@ protected:
     void SetCurrentCell( int row, int col )
         { SetCurrentCell( wxGridCellCoords(row, col) ); }
 
+    void HighlightBlock( int topRow, int leftCol, int bottomRow, int rightCol );
+
+    void HighlightBlock( const wxGridCellCoords& topLeft,
+                      const wxGridCellCoords& bottomRight )
+        { HighlightBlock( topLeft.GetRow(), topLeft.GetCol(),
+                       bottomRight.GetRow(), bottomRight.GetCol() ); }
 
     // ------ functions to get/send data (see also public functions)
     //
     bool GetModelValues();
     bool SetModelValues();
 
+        friend class wxGridSelection;
 
     DECLARE_DYNAMIC_CLASS( wxGrid )
     DECLARE_EVENT_TABLE()
@@ -1739,17 +1759,18 @@ class WXDLLEXPORT wxGridEvent : public wxNotifyEvent
 public:
     wxGridEvent()
         : wxNotifyEvent(), m_row(-1), m_col(-1), m_x(-1), m_y(-1),
-        m_control(0), m_meta(0), m_shift(0), m_alt(0)
+        m_selecting(0), m_control(0), m_meta(0), m_shift(0), m_alt(0)
         {
         }
 
     wxGridEvent(int id, wxEventType type, wxObject* obj,
-                int row=-1, int col=-1, int x=-1, int y=-1,
+                int row=-1, int col=-1, int x=-1, int y=-1, bool sel = TRUE,
                 bool control=FALSE, bool shift=FALSE, bool alt=FALSE, bool meta=FALSE);
 
     virtual int GetRow() { return m_row; }
     virtual int GetCol() { return m_col; }
     wxPoint     GetPosition() { return wxPoint( m_x, m_y ); }
+    bool        Selecting() { return m_selecting; }
     bool        ControlDown() { return m_control; }
     bool        MetaDown() { return m_meta; }
     bool        ShiftDown() { return m_shift; }
@@ -1760,6 +1781,7 @@ protected:
     int         m_col;
     int         m_x;
     int         m_y;
+    bool        m_selecting;
     bool        m_control;
     bool        m_meta;
     bool        m_shift;
@@ -1809,6 +1831,7 @@ public:
         {
             m_topLeft     = wxGridNoCellCoords;
             m_bottomRight = wxGridNoCellCoords;
+            m_selecting   = FALSE;
             m_control     = FALSE;
             m_meta        = FALSE;
             m_shift       = FALSE;
@@ -1818,6 +1841,7 @@ public:
     wxGridRangeSelectEvent(int id, wxEventType type, wxObject* obj,
                            const wxGridCellCoords& topLeft,
                            const wxGridCellCoords& bottomRight,
+                           bool sel = TRUE,
                            bool control=FALSE, bool shift=FALSE,
                            bool alt=FALSE, bool meta=FALSE);
 
@@ -1827,6 +1851,7 @@ public:
     int         GetBottomRow() { return m_bottomRight.GetRow(); }
     int         GetLeftCol()   { return m_topLeft.GetCol(); }
     int         GetRightCol()  { return m_bottomRight.GetCol(); }
+    bool        Selecting() { return m_selecting; }
     bool        ControlDown()  { return m_control; }
     bool        MetaDown()     { return m_meta; }
     bool        ShiftDown()    { return m_shift; }
@@ -1835,6 +1860,7 @@ public:
 protected:
     wxGridCellCoords  m_topLeft;
     wxGridCellCoords  m_bottomRight;
+    bool              m_selecting;
     bool              m_control;
     bool              m_meta;
     bool              m_shift;
@@ -1897,4 +1923,3 @@ const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578;
 #endif  // #ifndef __WXGRID_H__
 
 #endif  // ifndef wxUSE_NEW_GRID
-