OS/2 Statusbar fixes

[wxWidgets.git] / include / wx / generic / grid.h

diff --git a/include/wx/generic/grid.h b/include/wx/generic/grid.h
index 373e205e3544dfe5e26afc88b4688ddc742a2a44..21ad06b098d4d4c724819726bb03e6fe3e1da52f 100644 (file)
--- a/include/wx/generic/grid.h
+++ b/include/wx/generic/grid.h
@@ -298,6 +298,8 @@ public:
     wxGridCellEditor();
 
     bool IsCreated() { return m_control != NULL; }
     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,
 
     // Creates the actual edit control
     virtual void Create(wxWindow* parent,


@@ -326,9 +328,18 @@ public:
     // Reset the value in the control back to its starting value
     virtual void Reset() = 0;
 
     // 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
     virtual void StartingKey(wxKeyEvent& event);
 
     // if the editor is enabled by clicking on the cell, this method will be


@@ -377,6 +388,7 @@ public:
 
     virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr);
 
 
     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);
 
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 


@@ -414,6 +426,7 @@ public:
                         wxWindowID id,
                         wxEvtHandler* evtHandler);
 
                         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);
 
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 


@@ -447,10 +460,13 @@ private:
 class WXDLLEXPORT wxGridCellFloatEditor : public wxGridCellTextEditor
 {
 public:
 class WXDLLEXPORT wxGridCellFloatEditor : public wxGridCellTextEditor
 {
 public:

+    wxGridCellFloatEditor(int width = -1, int precision = -1);
+

     virtual void Create(wxWindow* parent,
                         wxWindowID id,
                         wxEvtHandler* evtHandler);
 
     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);
 
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 


@@ -460,12 +476,16 @@ public:
     virtual wxGridCellEditor *Clone() const
         { return new wxGridCellFloatEditor; }
 
     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
 protected:
     // string representation of m_valueOld

-    wxString GetString() const
-        { return wxString::Format(_T("%f"), m_valueOld); }
+    wxString GetString() const;

 
 private:
 
 private:

+    int m_width,
+        m_precision;

     double m_valueOld;
 };
 
     double m_valueOld;
 };
 


@@ -480,6 +500,7 @@ public:
     virtual void SetSize(const wxRect& rect);
     virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL);
 
     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);
 
     virtual void BeginEdit(int row, int col, wxGrid* grid);
     virtual bool EndEdit(int row, int col, wxGrid* grid);
 


@@ -502,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,
 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,
                            bool allowOthers = FALSE);
 
     virtual void Create(wxWindow* parent,


@@ -543,7 +564,8 @@ public:
     wxGridCellAttr()
     {
         Init();
     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
     }
 
     // VZ: considering the number of members wxGridCellAttr has now, this ctor


@@ -589,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 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; }
 
     bool HasRenderer() const { return m_renderer != NULL; }
     bool HasEditor() const { return m_editor != NULL; }
 


@@ -699,8 +721,8 @@ public:
 
     // You must override these functions in a derived table class
     //
 
     // 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;
     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;


@@ -754,11 +776,6 @@ public:
     // a wxGridCellAttrProvider if necessary.
     virtual bool CanHaveAttributes();
 
     // 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 );
     // by default forwarded to wxGridCellAttrProvider if any. May be
     // overridden to handle attributes directly in the table.
     virtual wxGridCellAttr *GetAttr( int row, int col );


@@ -843,8 +860,8 @@ public:
 
     // these are pure virtual in wxGridTableBase
     //
 
     // 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 );
     wxString GetValue( int row, int col );
     void SetValue( int row, int col, const wxString& s );
     bool IsEmptyCell( int row, int col );


@@ -894,11 +911,11 @@ public:
 
     // default copy ctor is ok
 
 
     // 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 )
     {
 
     wxGridCellCoords& operator=( const wxGridCellCoords& other )
     {


@@ -926,15 +943,15 @@ public:
     }
 
 private:
     }
 
 private:

-    long m_row;
-    long m_col;
+    int m_row;
+    int m_col;

 };
 
 
 // For comparisons...
 //
 };
 
 
 // For comparisons...
 //

-extern wxGridCellCoords wxGridNoCellCoords;
-extern wxRect           wxGridNoCellRect;
+extern WXDLLEXPORT wxGridCellCoords wxGridNoCellCoords;
+extern WXDLLEXPORT wxRect           wxGridNoCellRect;

 
 // An array of cell coords...
 //
 
 // An array of cell coords...
 //


@@ -979,10 +996,10 @@ public:
 
     // ------ display update functions
     //
 
     // ------ 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
 
 
     // ------ event handlers


@@ -1030,8 +1047,8 @@ public:
     // ------ Cell text drawing functions
     //
     void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&,
     // ------ 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
 
     // Split a string containing newline chararcters into an array of
     // strings and return the number of lines


@@ -1049,9 +1066,19 @@ public:
     // flicker
     //
     void     BeginBatch() { m_batchCount++; }
     // flicker
     //
     void     BeginBatch() { m_batchCount++; }

-    void     EndBatch() { if ( m_batchCount > 0 ) m_batchCount--; }
+    void     EndBatch();
+

     int      GetBatchCount() { return m_batchCount; }
 
     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
     //
 
     // ------ edit control functions
     //


@@ -1062,6 +1089,7 @@ public:
     void DisableCellEditControl() { EnableCellEditControl(FALSE); }
     bool CanEnableCellControl() const;
     bool IsCellEditControlEnabled() const;
     void DisableCellEditControl() { EnableCellEditControl(FALSE); }
     bool CanEnableCellControl() const;
     bool IsCellEditControlEnabled() const;

+    bool IsCellEditControlShown() const;

 
     bool IsCurrentCellReadOnly() const;
 
 
     bool IsCurrentCellReadOnly() const;
 


@@ -1131,6 +1159,7 @@ public:
     wxString GetRowLabelValue( int row );
     wxString GetColLabelValue( int col );
     wxColour GetGridLineColour() { return m_gridLineColour; }
     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 );
 
     void     SetRowLabelSize( int width );
     void     SetColLabelSize( int height );


@@ -1142,6 +1171,7 @@ public:
     void     SetRowLabelValue( int row, const wxString& );
     void     SetColLabelValue( int col, const wxString& );
     void     SetGridLineColour( const wxColour& );
     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 ); }
 
     void     EnableDragRowSize( bool enable = TRUE );
     void     DisableDragRowSize() { EnableDragRowSize( FALSE ); }


@@ -1270,12 +1300,15 @@ public:
     void SelectRow( int row, bool addToSelected = FALSE );
     void SelectCol( int col, bool addToSelected = FALSE );
 
     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,
 
     void SelectBlock( const wxGridCellCoords& topLeft,

-                      const wxGridCellCoords& bottomRight )
+                      const wxGridCellCoords& bottomRight,
+                      bool addToSelected = FALSE )

         { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),
         { SelectBlock( topLeft.GetRow(), topLeft.GetCol(),

-                       bottomRight.GetRow(), bottomRight.GetCol() ); }
+                       bottomRight.GetRow(), bottomRight.GetCol(),
+                       addToSelected ); }

 
     void SelectAll();
 
 
     void SelectAll();
 


@@ -1296,15 +1329,6 @@ public:
     wxRect BlockToDeviceRect( const wxGridCellCoords & topLeft,
                               const wxGridCellCoords & bottomRight );
 
     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_selectingTopLeft,
-                                      m_selectingBottomRight );
-        }
-

     // Access or update the selection fore/back colours
     wxColour GetSelectionBackground() const
         { return m_selectionBackground; }
     // Access or update the selection fore/back colours
     wxColour GetSelectionBackground() const
         { return m_selectionBackground; }


@@ -1347,7 +1371,7 @@ public:
             int x, int y, int w = -1, int h = -1,
             long style = wxWANTS_CHARS,
             const wxString& name = wxPanelNameStr )
             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();
                             (style|wxWANTS_CHARS), name )
         {
             Create();


@@ -1367,8 +1391,8 @@ public:
     int GetScrollPosX() { return 0; }
     int GetScrollPosY() { return 0; }
 
     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 ); }
 
     void SetColumnWidth( int col, int width )
         { SetColSize( col, width ); }


@@ -1470,15 +1494,15 @@ public:
     void SetEditable( bool edit = TRUE ) { EnableEditing( edit ); }
     bool GetEditInPlace() { return IsCellEditControlEnabled(); }
 
     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)
 
     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)) { }
     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 **********
     void OnActivate(bool WXUNUSED(active)) {}
 
     // ******** End of compatibility functions **********


@@ -1511,11 +1535,6 @@ protected:
     wxGridTableBase          *m_table;
     bool                      m_ownTable;
 
     wxGridTableBase          *m_table;
     bool                      m_ownTable;
 

-    int m_left;
-    int m_top;
-    int m_right;
-    int m_bottom;
-

     int m_numRows;
     int m_numCols;
 
     int m_numRows;
     int m_numCols;
 


@@ -1579,6 +1598,7 @@ protected:
 
     wxColour   m_gridLineColour;
     bool       m_gridLinesEnabled;
 
     wxColour   m_gridLineColour;
     bool       m_gridLinesEnabled;

+    wxColour   m_cellHighlightColour;

 
     // common part of AutoSizeColumn/Row() and GetBestSize()
     int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE);
 
     // common part of AutoSizeColumn/Row() and GetBestSize()
     int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE);


@@ -1704,6 +1724,7 @@ protected:
     void OnPaint( wxPaintEvent& );
     void OnSize( wxSizeEvent& );
     void OnKeyDown( wxKeyEvent& );
     void OnPaint( wxPaintEvent& );
     void OnSize( wxSizeEvent& );
     void OnKeyDown( wxKeyEvent& );

+    void OnKeyUp( wxKeyEvent& );

     void OnEraseBackground( wxEraseEvent& );
 
 
     void OnEraseBackground( wxEraseEvent& );
 
 


@@ -1711,6 +1732,12 @@ protected:
     void SetCurrentCell( int row, int col )
         { SetCurrentCell( wxGridCellCoords(row, col) ); }
 
     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)
     //
 
     // ------ functions to get/send data (see also public functions)
     //