X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fb2957900c9c38ffa03b4ab2ea6cbcc1e23ecc7d..1f80a703f24bc50a5ce92fb1406dd1b38ac4e506:/include/wx/generic/grid.h diff --git a/include/wx/generic/grid.h b/include/wx/generic/grid.h index a572f9d4a0..cf4d7155f2 100644 --- a/include/wx/generic/grid.h +++ b/include/wx/generic/grid.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: grid.h +// Name: wx/generic/grid.h // Purpose: wxGrid and related classes // Author: Michael Bedward (based on code by Julian Smart, Robin Dunn) // Modified by: @@ -9,7 +9,6 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// - #include "wx/defs.h" #if !defined(wxUSE_NEW_GRID) || !(wxUSE_NEW_GRID) @@ -23,16 +22,20 @@ #pragma interface "grid.h" #endif +#include "wx/hash.h" #include "wx/panel.h" #include "wx/scrolwin.h" #include "wx/string.h" #include "wx/scrolbar.h" #include "wx/event.h" -#include "wx/textctrl.h" #include "wx/combobox.h" #include "wx/dynarray.h" #include "wx/timer.h" +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- + // Default parameters for wxGrid // #define WXGRID_DEFAULT_NUMBER_ROWS 10 @@ -45,11 +48,21 @@ #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 +// type names for grid table values +#define wxGRID_VALUE_STRING _T("string") +#define wxGRID_VALUE_BOOL _T("bool") +#define wxGRID_VALUE_NUMBER _T("long") +#define wxGRID_VALUE_FLOAT _T("double") +#define wxGRID_VALUE_CHOICE _T("choice") + +#define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING +#define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER + // ---------------------------------------------------------------------------- // forward declarations // ---------------------------------------------------------------------------- @@ -62,16 +75,66 @@ class WXDLLEXPORT wxGridCornerLabelWindow; class WXDLLEXPORT wxGridRowLabelWindow; class WXDLLEXPORT wxGridTableBase; class WXDLLEXPORT wxGridWindow; +class WXDLLEXPORT wxGridTypeRegistry; +class WXDLLEXPORT wxGridSelection; + +class WXDLLEXPORT wxCheckBox; +class WXDLLEXPORT wxComboBox; +class WXDLLEXPORT wxTextCtrl; +class WXDLLEXPORT wxSpinCtrl; + +// ---------------------------------------------------------------------------- +// macros +// ---------------------------------------------------------------------------- + +#define wxSafeIncRef(p) if ( p ) (p)->IncRef() +#define wxSafeDecRef(p) if ( p ) (p)->DecRef() + +// ---------------------------------------------------------------------------- +// wxGridCellWorker: common base class for wxGridCellRenderer and +// wxGridCellEditor +// +// NB: this is more an implementation convenience than a design issue, so this +// class is not documented and is not public at all +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxGridCellWorker +{ +public: + wxGridCellWorker() { m_nRef = 1; } + + // this class is ref counted: it is created with ref count of 1, so + // calling DecRef() once will delete it. Calling IncRef() allows to lock + // it until the matching DecRef() is called + void IncRef() { m_nRef++; } + void DecRef() { if ( !--m_nRef ) delete this; } + + // interpret renderer parameters: arbitrary string whose interpretatin is + // left to the derived classes + virtual void SetParameters(const wxString& params); + +protected: + // virtual dtor for any base class - private because only DecRef() can + // delete us + virtual ~wxGridCellWorker(); + +private: + size_t m_nRef; + + // suppress the stupid gcc warning about the class having private dtor and + // no friends + friend class wxGridCellWorkerDummyFriend; +}; // ---------------------------------------------------------------------------- // wxGridCellRenderer: this class is responsible for actually drawing the cell // in the grid. You may pass it to the wxGridCellAttr (below) to change the // format of one given cell or to wxGrid::SetDefaultRenderer() to change the // view of all cells. This is an ABC, you will normally use one of the -// predefined derived classes or derive oyur own class from it. +// predefined derived classes or derive your own class from it. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxGridCellRenderer +class WXDLLEXPORT wxGridCellRenderer : public wxGridCellWorker { public: // draw the given cell on the provided DC inside the given rectangle @@ -87,6 +150,15 @@ public: const wxRect& rect, int row, int col, bool isSelected) = 0; + + // get the preferred size of the cell for its contents + virtual wxSize GetBestSize(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + int row, int col) = 0; + + // create a new object which is the copy of this one + virtual wxGridCellRenderer *Clone() const = 0; }; // the default renderer for the cells containing string data @@ -100,8 +172,117 @@ public: const wxRect& rect, int row, int col, bool isSelected); + + // return the string extent + virtual wxSize GetBestSize(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + int row, int col); + + virtual wxGridCellRenderer *Clone() const + { return new wxGridCellStringRenderer; } + +protected: + // set the text colours before drawing + void SetTextColoursAndFont(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + bool isSelected); + + // calc the string extent for given string/font + wxSize DoGetBestSize(wxGridCellAttr& attr, + wxDC& dc, + const wxString& text); +}; + +// the default renderer for the cells containing numeric (long) data +class WXDLLEXPORT wxGridCellNumberRenderer : public wxGridCellStringRenderer +{ +public: + // draw the string right aligned + virtual void Draw(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + const wxRect& rect, + int row, int col, + bool isSelected); + + virtual wxSize GetBestSize(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + int row, int col); + + virtual wxGridCellRenderer *Clone() const + { return new wxGridCellNumberRenderer; } + +protected: + wxString GetString(wxGrid& grid, int row, int col); +}; + +class WXDLLEXPORT wxGridCellFloatRenderer : public wxGridCellStringRenderer +{ +public: + wxGridCellFloatRenderer(int width = -1, int precision = -1); + + // get/change formatting parameters + int GetWidth() const { return m_width; } + void SetWidth(int width) { m_width = width; m_format.clear(); } + int GetPrecision() const { return m_precision; } + void SetPrecision(int precision) { m_precision = precision; m_format.clear(); } + + // draw the string right aligned with given width/precision + virtual void Draw(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + const wxRect& rect, + int row, int col, + bool isSelected); + + virtual wxSize GetBestSize(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + int row, int col); + + // parameters string format is "width[,precision]" + virtual void SetParameters(const wxString& params); + + virtual wxGridCellRenderer *Clone() const; + +protected: + wxString GetString(wxGrid& grid, int row, int col); + +private: + // formatting parameters + int m_width, + m_precision; + + wxString m_format; }; +// renderer for boolean fields +class WXDLLEXPORT wxGridCellBoolRenderer : public wxGridCellRenderer +{ +public: + // draw a check mark or nothing + virtual void Draw(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + const wxRect& rect, + int row, int col, + bool isSelected); + + // return the checkmark size + virtual wxSize GetBestSize(wxGrid& grid, + wxGridCellAttr& attr, + wxDC& dc, + int row, int col); + + virtual wxGridCellRenderer *Clone() const + { return new wxGridCellBoolRenderer; } + +private: + static wxSize ms_sizeCheckMark; +}; // ---------------------------------------------------------------------------- // wxGridCellEditor: This class is responsible for providing and manipulating @@ -111,11 +292,10 @@ public: // even for the entire grid. // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxGridCellEditor +class WXDLLEXPORT wxGridCellEditor : public wxGridCellWorker { public: wxGridCellEditor(); - virtual ~wxGridCellEditor(); bool IsCreated() { return m_control != NULL; } @@ -127,20 +307,21 @@ public: // Size and position the edit control virtual void SetSize(const wxRect& rect); - // Show or hide the edit control - virtual void Show(bool show); + // Show or hide the edit control, use the specified attributes to set + // colours/fonts for it + virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL); + + // Draws the part of the cell not occupied by the control: the base class + // version just fills it with background colour from the attribute + virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); // Fetch the value from the table and prepare the edit control // to begin editing. Set the focus to the edit control. - virtual void BeginEdit(int row, int col, wxGrid* grid, - wxGridCellAttr* attr) = 0; + virtual void BeginEdit(int row, int col, wxGrid* grid) = 0; - // Complete the editing of the current cell. If saveValue is - // true then send the new value back to the table. Returns true - // if the value has changed. If necessary, the control may be - // destroyed. - virtual bool EndEdit(int row, int col, bool saveValue, - wxGrid* grid, wxGridCellAttr* attr) = 0; + // Complete the editing of the current cell. Returns true if the value has + // changed. If necessary, the control may be destroyed. + virtual bool EndEdit(int row, int col, wxGrid* grid) = 0; // Reset the value in the control back to its starting value virtual void Reset() = 0; @@ -150,6 +331,10 @@ public: // that first key if desired. virtual void StartingKey(wxKeyEvent& event); + // if the editor is enabled by clicking on the cell, this method will be + // called + virtual void StartingClick(); + // Some types of controls on some platforms may need some help // with the Return key. virtual void HandleReturn(wxKeyEvent& event); @@ -157,11 +342,29 @@ public: // Final cleanup virtual void Destroy(); + // create a new object which is the copy of this one + virtual wxGridCellEditor *Clone() const = 0; + protected: + // the dtor is private because only DecRef() can delete us + virtual ~wxGridCellEditor(); + + // the control we show on screen wxControl* m_control; -}; + // if we change the colours/font of the control from the default ones, we + // must restore the default later and we save them here between calls to + // Show(TRUE) and Show(FALSE) + wxColour m_colFgOld, + m_colBgOld; + wxFont m_fontOld; + + // suppress the stupid gcc warning about the class having private dtor and + // no friends + friend class wxGridCellEditorDummyFriend; +}; +// the editor for string/text data class WXDLLEXPORT wxGridCellTextEditor : public wxGridCellEditor { public: @@ -170,22 +373,163 @@ public: virtual void Create(wxWindow* parent, wxWindowID id, wxEvtHandler* evtHandler); + virtual void SetSize(const wxRect& rect); - virtual void BeginEdit(int row, int col, wxGrid* grid, - wxGridCellAttr* attr); + virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); - virtual bool EndEdit(int row, int col, bool saveValue, - wxGrid* grid, wxGridCellAttr* attr); + virtual void BeginEdit(int row, int col, wxGrid* grid); + virtual bool EndEdit(int row, int col, wxGrid* grid); virtual void Reset(); virtual void StartingKey(wxKeyEvent& event); virtual void HandleReturn(wxKeyEvent& event); + // parameters string format is "max_width" + virtual void SetParameters(const wxString& params); + + virtual wxGridCellEditor *Clone() const + { return new wxGridCellTextEditor; } + +protected: + wxTextCtrl *Text() const { return (wxTextCtrl *)m_control; } + + // parts of our virtual functions reused by the derived classes + void DoBeginEdit(const wxString& startValue); + void DoReset(const wxString& startValue); private: + size_t m_maxChars; // max number of chars allowed wxString m_startValue; }; +// the editor for numeric (long) data +class WXDLLEXPORT wxGridCellNumberEditor : public wxGridCellTextEditor +{ +public: + // allows to specify the range - if min == max == -1, no range checking is + // done + wxGridCellNumberEditor(int min = -1, int max = -1); + + virtual void Create(wxWindow* parent, + wxWindowID id, + wxEvtHandler* evtHandler); + + virtual void BeginEdit(int row, int col, wxGrid* grid); + virtual bool EndEdit(int row, int col, wxGrid* grid); + + virtual void Reset(); + virtual void StartingKey(wxKeyEvent& event); + + // parameters string format is "min,max" + virtual void SetParameters(const wxString& params); + + virtual wxGridCellEditor *Clone() const + { return new wxGridCellNumberEditor(m_min, m_max); } + +protected: + wxSpinCtrl *Spin() const { return (wxSpinCtrl *)m_control; } + + // if HasRange(), we use wxSpinCtrl - otherwise wxTextCtrl + bool HasRange() const { return m_min != m_max; } + + // string representation of m_valueOld + wxString GetString() const + { return wxString::Format(_T("%ld"), m_valueOld); } + +private: + int m_min, + m_max; + + long m_valueOld; +}; + +// the editor for floating point numbers (double) data +class WXDLLEXPORT wxGridCellFloatEditor : public wxGridCellTextEditor +{ +public: + virtual void Create(wxWindow* parent, + wxWindowID id, + wxEvtHandler* evtHandler); + + virtual void BeginEdit(int row, int col, wxGrid* grid); + virtual bool EndEdit(int row, int col, wxGrid* grid); + + virtual void Reset(); + virtual void StartingKey(wxKeyEvent& event); + + virtual wxGridCellEditor *Clone() const + { return new wxGridCellFloatEditor; } + +protected: + // string representation of m_valueOld + wxString GetString() const + { return wxString::Format(_T("%f"), m_valueOld); } + +private: + double m_valueOld; +}; + +// the editor for boolean data +class WXDLLEXPORT wxGridCellBoolEditor : public wxGridCellEditor +{ +public: + virtual void Create(wxWindow* parent, + wxWindowID id, + wxEvtHandler* evtHandler); + + virtual void SetSize(const wxRect& rect); + virtual void Show(bool show, wxGridCellAttr *attr = (wxGridCellAttr *)NULL); + + virtual void BeginEdit(int row, int col, wxGrid* grid); + virtual bool EndEdit(int row, int col, wxGrid* grid); + + virtual void Reset(); + virtual void StartingClick(); + + virtual wxGridCellEditor *Clone() const + { return new wxGridCellBoolEditor; } + +protected: + wxCheckBox *CBox() const { return (wxCheckBox *)m_control; } + +private: + bool m_startValue; +}; + +// the editor for string data allowing to choose from the list of strings +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, + bool allowOthers = FALSE); + + virtual void Create(wxWindow* parent, + wxWindowID id, + wxEvtHandler* evtHandler); + + virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); + + virtual void BeginEdit(int row, int col, wxGrid* grid); + virtual bool EndEdit(int row, int col, wxGrid* grid); + + virtual void Reset(); + + // parameters string format is "item1[,item2[...,itemN]]" + virtual void SetParameters(const wxString& params); + + virtual wxGridCellEditor *Clone() const; + +protected: + wxComboBox *Combo() const { return (wxComboBox *)m_control; } + +private: + wxString m_startValue; + wxArrayString m_choices; + bool m_allowOthers; +}; + // ---------------------------------------------------------------------------- // wxGridCellAttr: this class can be used to alter the cells appearance in // the grid by changing their colour/font/... from default. An object of this @@ -202,6 +546,8 @@ public: SetAlignment(0, 0); } + // VZ: considering the number of members wxGridCellAttr has now, this ctor + // seems to be pretty useless... may be we should just remove it? wxGridCellAttr(const wxColour& colText, const wxColour& colBack, const wxFont& font, @@ -213,15 +559,14 @@ public: SetAlignment(hAlign, vAlign); } - // default copy ctor ok + // creates a new copy of this object + wxGridCellAttr *Clone() const; // this class is ref counted: it is created with ref count of 1, so // calling DecRef() once will delete it. Calling IncRef() allows to lock // it until the matching DecRef() is called void IncRef() { m_nRef++; } void DecRef() { if ( !--m_nRef ) delete this; } - void SafeIncRef() { if ( this ) IncRef(); } - void SafeDecRef() { if ( this ) DecRef(); } // setters void SetTextColour(const wxColour& colText) { m_colText = colText; } @@ -232,12 +577,13 @@ public: m_hAlign = hAlign; m_vAlign = vAlign; } + void SetReadOnly(bool isReadOnly = TRUE) { m_isReadOnly = isReadOnly; } // takes ownership of the pointer void SetRenderer(wxGridCellRenderer *renderer) - { delete m_renderer; m_renderer = renderer; } + { wxSafeDecRef(m_renderer); m_renderer = renderer; } void SetEditor(wxGridCellEditor* editor) - { delete m_editor; m_editor = editor; } + { wxSafeDecRef(m_editor); m_editor = editor; } // accessors bool HasTextColour() const { return m_colText.Ok(); } @@ -251,21 +597,31 @@ public: const wxColour& GetBackgroundColour() const; const wxFont& GetFont() const; void GetAlignment(int *hAlign, int *vAlign) const; - wxGridCellRenderer *GetRenderer() const; - wxGridCellEditor *GetEditor() const; + wxGridCellRenderer *GetRenderer(wxGrid* grid, int row, int col) const; + wxGridCellEditor *GetEditor(wxGrid* grid, int row, int col) const; + + bool IsReadOnly() const { return m_isReadOnly; } void SetDefAttr(wxGridCellAttr* defAttr) { m_defGridAttr = defAttr; } private: // the common part of all ctors - void Init() { + void Init() + { m_nRef = 1; + + m_isReadOnly = FALSE; + m_renderer = NULL; m_editor = NULL; } // the dtor is private because only DecRef() can delete us - ~wxGridCellAttr() { delete m_renderer; delete m_editor; } + ~wxGridCellAttr() + { + wxSafeDecRef(m_renderer); + wxSafeDecRef(m_editor); + } // the ref count - when it goes to 0, we die size_t m_nRef; @@ -280,6 +636,11 @@ private: wxGridCellEditor* m_editor; wxGridCellAttr* m_defGridAttr; + bool m_isReadOnly; + + // use Clone() instead + DECLARE_NO_COPY_CLASS(wxGridCellAttr); + // suppress the stupid gcc warning about the class having private dtor and // no friends friend class wxGridCellAttrDummyFriend; @@ -312,6 +673,11 @@ public: virtual void SetRowAttr(wxGridCellAttr *attr, int row); virtual void SetColAttr(wxGridCellAttr *attr, int col); + // these functions must be called whenever some rows/cols are deleted + // because the internal data must be updated then + void UpdateAttrRows( size_t pos, int numRows ); + void UpdateAttrCols( size_t pos, int numCols ); + private: void InitData(); @@ -335,9 +701,27 @@ public: // virtual long GetNumberRows() = 0; virtual long GetNumberCols() = 0; - virtual wxString GetValue( int row, int col ) = 0; - virtual void SetValue( int row, int col, const wxString& s ) = 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; + + // Data type determination and value access + virtual wxString GetTypeName( int row, int col ); + virtual bool CanGetValueAs( int row, int col, const wxString& typeName ); + virtual bool CanSetValueAs( int row, int col, const wxString& typeName ); + + virtual long GetValueAsLong( int row, int col ); + virtual double GetValueAsDouble( int row, int col ); + virtual bool GetValueAsBool( int row, int col ); + + virtual void SetValueAsLong( int row, int col, long value ); + virtual void SetValueAsDouble( int row, int col, double value ); + virtual void SetValueAsBool( int row, int col, bool value ); + + // For user defined types + virtual void* GetValueAsCustom( int row, int col, const wxString& typeName ); + virtual void SetValueAsCustom( int row, int col, const wxString& typeName, void* value ); + // Overriding these is optional // @@ -366,8 +750,17 @@ public: // get the currently used attr provider (may be NULL) wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; } + // Does this table allow attributes? Default implementation creates + // 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 this class. + // overridden to handle attributes directly in the table. virtual wxGridCellAttr *GetAttr( int row, int col ); // these functions take ownership of the pointer @@ -485,11 +878,13 @@ private: -////////////////////////////////////////////////////////////////////// -// +// ============================================================================ // Grid view classes -// -////////////////////////////////////////////////////////////////////// +// ============================================================================ + +// ---------------------------------------------------------------------------- +// wxGridCellCoords: location of a cell in the grid +// ---------------------------------------------------------------------------- class WXDLLEXPORT wxGridCellCoords { @@ -515,17 +910,17 @@ public: return *this; } - bool operator==( const wxGridCellCoords& other ) + bool operator==( const wxGridCellCoords& other ) const { return (m_row == other.m_row && m_col == other.m_col); } - bool operator!=( const wxGridCellCoords& other ) + bool operator!=( const wxGridCellCoords& other ) const { return (m_row != other.m_row || m_col != other.m_col); } - bool operator!() + bool operator!() const { return (m_row == -1 && m_col == -1 ); } @@ -545,8 +940,6 @@ extern wxRect wxGridNoCellRect; // WX_DECLARE_EXPORTED_OBJARRAY(wxGridCellCoords, wxGridCellCoordsArray); - - // ---------------------------------------------------------------------------- // wxGrid // ---------------------------------------------------------------------------- @@ -563,13 +956,20 @@ public: wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - long style = 0, + long style = wxWANTS_CHARS, const wxString& name = wxPanelNameStr ); ~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 // @@ -597,7 +997,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 ); @@ -608,10 +1010,15 @@ public: bool DeleteCols( int pos = 0, int numCols = 1, bool updateLabels=TRUE ); void DrawGridCellArea( wxDC& dc ); + void DrawGridSpace( wxDC& dc ); void DrawCellBorder( wxDC& dc, const wxGridCellCoords& ); void DrawAllGridLines( wxDC& dc, const wxRegion & reg ); void DrawCell( wxDC& dc, const wxGridCellCoords& ); - void DrawCellHighlight( wxDC& dc ); + void DrawHighlight(wxDC& dc); + + // this function is called when the current cell highlight must be redrawn + // and may be overridden by the user + virtual void DrawCellHighlight( wxDC& dc, const wxGridCellAttr *attr ); void DrawRowLabels( wxDC& dc ); void DrawRowLabel( wxDC& dc, int row ); @@ -651,14 +1058,15 @@ public: bool IsEditable() { return m_editable; } void EnableEditing( bool edit ); - void EnableCellEditControl( bool enable ); + void EnableCellEditControl( bool enable = TRUE ); + void DisableCellEditControl() { EnableCellEditControl(FALSE); } + bool CanEnableCellControl() const; + bool IsCellEditControlEnabled() const; - bool IsCellEditControlEnabled() - { return m_cellEditCtrlEnabled; } + bool IsCurrentCellReadOnly() const; void ShowCellEditControl(); void HideCellEditControl(); - void SetEditControlValue( const wxString& s = wxEmptyString ); void SaveEditControlValue(); @@ -735,10 +1143,28 @@ public: void SetColLabelValue( int col, const wxString& ); void SetGridLineColour( const wxColour& ); + void EnableDragRowSize( bool enable = TRUE ); + void DisableDragRowSize() { EnableDragRowSize( FALSE ); } + bool CanDragRowSize() { return m_canDragRowSize; } + void EnableDragColSize( bool enable = TRUE ); + void DisableDragColSize() { EnableDragColSize( FALSE ); } + bool CanDragColSize() { return m_canDragColSize; } + void EnableDragGridSize(bool enable = TRUE); + void DisableDragGridSize() { EnableDragGridSize(FALSE); } + bool CanDragGridSize() { return m_canDragGridSize; } + // this sets the specified attribute for all cells in this row/col void SetRowAttr(int row, wxGridCellAttr *attr); void SetColAttr(int col, wxGridCellAttr *attr); + // shortcuts for setting the column parameters + + // set the format for the data in the column: default is string + void SetColFormatBool(int col); + void SetColFormatNumber(int col); + void SetColFormatFloat(int col, int width = -1, int precision = -1); + void SetColFormatCustom(int col, const wxString& typeName); + void EnableGridLines( bool enable = TRUE ); bool GridLinesEnabled() { return m_gridLinesEnabled; } @@ -762,6 +1188,32 @@ public: void SetDefaultColSize( int width, bool resizeExistingCols = FALSE ); void SetColSize( int col, int width ); + + // automatically size the column or row to fit to its contents, if + // setAsMin is TRUE, this optimal width will also be set as minimal width + // for this column + void AutoSizeColumn( int col, bool setAsMin = TRUE ) + { AutoSizeColOrRow(col, setAsMin, TRUE); } + void AutoSizeRow( int row, bool setAsMin = TRUE ) + { AutoSizeColOrRow(row, setAsMin, FALSE); } + + // auto size all columns (very ineffective for big grids!) + void AutoSizeColumns( bool setAsMin = TRUE ) + { (void)SetOrCalcColumnSizes(FALSE, setAsMin); } + + void AutoSizeRows( bool setAsMin = TRUE ) + { (void)SetOrCalcRowSizes(FALSE, setAsMin); } + + // auto size the grid, that is make the columns/rows of the "right" size + // and also set the grid size to just fit its contents + void AutoSize(); + + // column won't be resized to be lesser width - this must be called during + // the grid creation because it won't resize the column if it's already + // narrower than the minimal width + void SetColMinimalWidth( int col, int width ); + void SetRowMinimalHeight( int row, int width ); + void SetDefaultCellBackgroundColour( const wxColour& ); void SetCellBackgroundColour( int row, int col, const wxColour& ); void SetDefaultCellTextColour( const wxColour& ); @@ -778,6 +1230,13 @@ public: wxGridCellRenderer *GetDefaultRenderer() const; wxGridCellRenderer* GetCellRenderer(int row, int col); + // takes ownership of the pointer + void SetDefaultEditor(wxGridCellEditor *editor); + void SetCellEditor(int row, int col, wxGridCellEditor *editor); + wxGridCellEditor *GetDefaultEditor() const; + wxGridCellEditor* GetCellEditor(int row, int col); + + // ------ cell value accessors // @@ -800,7 +1259,11 @@ public: void SetCellValue( const wxGridCellCoords& coords, const wxString& s ) { SetCellValue( coords.GetRow(), coords.GetCol(), s ); } + // returns TRUE if the cell can't be edited + bool IsReadOnly(int row, int col) const; + // make the cell editable/readonly + void SetReadOnly(int row, int col, bool isReadOnly = TRUE); // ------ selections of blocks of cells // @@ -816,34 +1279,15 @@ public: 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 @@ -857,8 +1301,8 @@ public: // wxRect SelectionToDeviceRect() { - return BlockToDeviceRect( m_selectedTopLeft, - m_selectedBottomRight ); + return BlockToDeviceRect( m_selectingTopLeft, + m_selectingBottomRight ); } // Access or update the selection fore/back colours @@ -871,6 +1315,24 @@ public: void SetSelectionForeground(const wxColour& c) { m_selectionForeground = c; } + // Methods for a registry for mapping data types to Renderers/Editors + void RegisterDataType(const wxString& typeName, + wxGridCellRenderer* renderer, + wxGridCellEditor* editor); + 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; + wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const; + 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 + void SetMargins(int extraWidth, int extraHeight) + { + m_extraWidth = extraWidth; + m_extraHeight = extraHeight; + } // ------ For compatibility with previous wxGrid only... // @@ -882,10 +1344,11 @@ public: // wxGrid( wxWindow *parent, - int x = -1, int y = -1, int w = -1, int h = -1, - long style = 0, + 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), style, name ) + : wxScrolledWindow( parent, -1, wxPoint(x,y), wxSize(w,h), + (style|wxWANTS_CHARS), name ) { Create(); } @@ -916,8 +1379,7 @@ public: void SetRowHeight( int row, int height ) { SetRowSize( row, height ); } - int GetRowHeight( int row ) - { return GetRowSize( row ); } + // GetRowHeight() is below int GetViewHeight() // returned num whole rows visible { return 0; } @@ -1033,7 +1495,12 @@ public: wxGRID_CHOICE, wxGRID_COMBOBOX }; + // overridden wxWindow methods + virtual void Fit(); + protected: + virtual wxSize DoGetBestSize() const; + bool m_created; bool m_displayed; @@ -1055,21 +1522,49 @@ protected: wxGridCellCoords m_currentCellCoords; - wxGridCellCoords m_selectedTopLeft; - wxGridCellCoords m_selectedBottomRight; + wxGridCellCoords m_selectingTopLeft; + wxGridCellCoords m_selectingBottomRight; + wxGridSelection *m_selection; wxColour m_selectionBackground; wxColour m_selectionForeground; + // NB: *never* access m_row/col arrays directly because they are created + // on demand, *always* use accessor functions instead! + + // init the m_rowHeights/Bottoms arrays with default values + void InitRowHeights(); + int m_defaultRowHeight; wxArrayInt m_rowHeights; wxArrayInt m_rowBottoms; + // init the m_colWidths/Rights arrays + void InitColWidths(); + int m_defaultColWidth; wxArrayInt m_colWidths; wxArrayInt m_colRights; + + // get the col/row coords + int GetColWidth(int col) const; + int GetColLeft(int col) const; + int GetColRight(int col) const; + + // this function must be public for compatibility... +public: + int GetRowHeight(int row) const; +protected: + + int GetRowTop(int row) const; + int GetRowBottom(int row) const; + int m_rowLabelWidth; int m_colLabelHeight; + // the size of the margin left to the right and bottom of the cell area + int m_extraWidth, + m_extraHeight; + wxColour m_labelBackgroundColour; wxColour m_labelTextColour; wxFont m_labelFont; @@ -1085,6 +1580,21 @@ protected: wxColour m_gridLineColour; bool m_gridLinesEnabled; + // common part of AutoSizeColumn/Row() and GetBestSize() + int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = TRUE); + int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = TRUE); + + // common part of AutoSizeColumn/Row() + void AutoSizeColOrRow(int n, bool setAsMin, bool column /* or row? */); + + // if a column has a minimal width, it will be the value for it in this + // hash table + wxHashTableLong m_colMinWidths, + m_rowMinHeights; + + // get the minimal width of the given column/row + int GetColMinimalWidth(int col) const; + int GetRowMinimalHeight(int col) const; // do we have some place to store attributes in? bool CanHaveAttributes(); @@ -1131,6 +1641,9 @@ protected: bool m_inOnKeyDown; int m_batchCount; + + wxGridTypeRegistry* m_typeRegistry; + enum CursorMode { WXGRID_CURSOR_SELECT_CELL, @@ -1153,6 +1666,9 @@ protected: wxWindow *m_winCapture; // the window which captured the mouse CursorMode m_cursorMode; + bool m_canDragRowSize; + bool m_canDragColSize; + bool m_canDragGridSize; int m_dragLastPos; int m_dragRowOrCol; bool m_isDragging; @@ -1165,8 +1681,8 @@ protected: wxCursor m_rowResizeCursor; wxCursor m_colResizeCursor; - bool m_editable; // applies to whole grid - bool m_cellEditCtrlEnabled; + bool m_editable; // applies to whole grid + bool m_cellEditCtrlEnabled; // is in-place edit currently shown? void Create(); @@ -1176,13 +1692,14 @@ protected: bool Redimension( wxGridTableMessage& ); - bool SendEvent( const wxEventType, - int row, int col, - wxMouseEvent& ); - - bool SendEvent( const wxEventType, - int row, int col ); - + bool SendEvent( const wxEventType, int row, int col, wxMouseEvent& ); + bool SendEvent( const wxEventType, int row, int col ); + bool SendEvent( const wxEventType type) + { + return SendEvent(type, + m_currentCellCoords.GetRow(), + m_currentCellCoords.GetCol()); + } void OnPaint( wxPaintEvent& ); void OnSize( wxSizeEvent& ); @@ -1200,18 +1717,15 @@ protected: bool GetModelValues(); bool SetModelValues(); + friend class wxGridSelection; DECLARE_DYNAMIC_CLASS( wxGrid ) DECLARE_EVENT_TABLE() }; - - - - -// -// ------ Grid event class and event types -// +// ---------------------------------------------------------------------------- +// Grid event class and event types +// ---------------------------------------------------------------------------- class WXDLLEXPORT wxGridEvent : public wxNotifyEvent { @@ -1247,7 +1761,6 @@ protected: DECLARE_DYNAMIC_CLASS(wxGridEvent) }; - class WXDLLEXPORT wxGridSizeEvent : public wxNotifyEvent { public: @@ -1323,54 +1836,57 @@ protected: DECLARE_DYNAMIC_CLASS(wxGridRangeSelectEvent) }; - -const wxEventType EVT_GRID_CELL_LEFT_CLICK = wxEVT_FIRST + 1580; -const wxEventType EVT_GRID_CELL_RIGHT_CLICK = wxEVT_FIRST + 1581; -const wxEventType EVT_GRID_CELL_LEFT_DCLICK = wxEVT_FIRST + 1582; -const wxEventType EVT_GRID_CELL_RIGHT_DCLICK = wxEVT_FIRST + 1583; -const wxEventType EVT_GRID_LABEL_LEFT_CLICK = wxEVT_FIRST + 1584; -const wxEventType EVT_GRID_LABEL_RIGHT_CLICK = wxEVT_FIRST + 1585; -const wxEventType EVT_GRID_LABEL_LEFT_DCLICK = wxEVT_FIRST + 1586; -const wxEventType EVT_GRID_LABEL_RIGHT_DCLICK = wxEVT_FIRST + 1587; -const wxEventType EVT_GRID_ROW_SIZE = wxEVT_FIRST + 1588; -const wxEventType EVT_GRID_COL_SIZE = wxEVT_FIRST + 1589; -const wxEventType EVT_GRID_RANGE_SELECT = wxEVT_FIRST + 1590; -const wxEventType EVT_GRID_CELL_CHANGE = wxEVT_FIRST + 1591; -const wxEventType EVT_GRID_SELECT_CELL = wxEVT_FIRST + 1592; +// TODO move to wx/event.h +const wxEventType wxEVT_GRID_CELL_LEFT_CLICK = wxEVT_FIRST + 1580; +const wxEventType wxEVT_GRID_CELL_RIGHT_CLICK = wxEVT_FIRST + 1581; +const wxEventType wxEVT_GRID_CELL_LEFT_DCLICK = wxEVT_FIRST + 1582; +const wxEventType wxEVT_GRID_CELL_RIGHT_DCLICK = wxEVT_FIRST + 1583; +const wxEventType wxEVT_GRID_LABEL_LEFT_CLICK = wxEVT_FIRST + 1584; +const wxEventType wxEVT_GRID_LABEL_RIGHT_CLICK = wxEVT_FIRST + 1585; +const wxEventType wxEVT_GRID_LABEL_LEFT_DCLICK = wxEVT_FIRST + 1586; +const wxEventType wxEVT_GRID_LABEL_RIGHT_DCLICK = wxEVT_FIRST + 1587; +const wxEventType wxEVT_GRID_ROW_SIZE = wxEVT_FIRST + 1588; +const wxEventType wxEVT_GRID_COL_SIZE = wxEVT_FIRST + 1589; +const wxEventType wxEVT_GRID_RANGE_SELECT = wxEVT_FIRST + 1590; +const wxEventType wxEVT_GRID_CELL_CHANGE = wxEVT_FIRST + 1591; +const wxEventType wxEVT_GRID_SELECT_CELL = wxEVT_FIRST + 1592; +const wxEventType wxEVT_GRID_EDITOR_SHOWN = wxEVT_FIRST + 1593; +const wxEventType wxEVT_GRID_EDITOR_HIDDEN = wxEVT_FIRST + 1594; typedef void (wxEvtHandler::*wxGridEventFunction)(wxGridEvent&); typedef void (wxEvtHandler::*wxGridSizeEventFunction)(wxGridSizeEvent&); typedef void (wxEvtHandler::*wxGridRangeSelectEventFunction)(wxGridRangeSelectEvent&); -#define EVT_GRID_CELL_LEFT_CLICK(fn) { EVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_CELL_RIGHT_CLICK(fn) { EVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_CELL_LEFT_DCLICK(fn) { EVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_CELL_RIGHT_DCLICK(fn) { EVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_LABEL_LEFT_CLICK(fn) { EVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_LABEL_RIGHT_CLICK(fn) { EVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_LABEL_LEFT_DCLICK(fn) { EVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { EVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_ROW_SIZE(fn) { EVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL }, -#define EVT_GRID_COL_SIZE(fn) { EVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL }, -#define EVT_GRID_RANGE_SELECT(fn) { EVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL }, -#define EVT_GRID_CELL_CHANGE(fn) { EVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_SELECT_CELL(fn) { EVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CELL_LEFT_CLICK(fn) { wxEVT_GRID_CELL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CELL_RIGHT_CLICK(fn) { wxEVT_GRID_CELL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CELL_LEFT_DCLICK(fn) { wxEVT_GRID_CELL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CELL_RIGHT_DCLICK(fn) { wxEVT_GRID_CELL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_LABEL_LEFT_CLICK(fn) { wxEVT_GRID_LABEL_LEFT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_LABEL_RIGHT_CLICK(fn) { wxEVT_GRID_LABEL_RIGHT_CLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_LABEL_LEFT_DCLICK(fn) { wxEVT_GRID_LABEL_LEFT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_LABEL_RIGHT_DCLICK(fn) { wxEVT_GRID_LABEL_RIGHT_DCLICK, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_ROW_SIZE(fn) { wxEVT_GRID_ROW_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL }, +#define EVT_GRID_COL_SIZE(fn) { wxEVT_GRID_COL_SIZE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridSizeEventFunction) &fn, NULL }, +#define EVT_GRID_RANGE_SELECT(fn) { wxEVT_GRID_RANGE_SELECT, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridRangeSelectEventFunction) &fn, NULL }, +#define EVT_GRID_CELL_CHANGE(fn) { wxEVT_GRID_CELL_CHANGE, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_SELECT_CELL(fn) { wxEVT_GRID_SELECT_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_EDITOR_SHOWN(fn) { wxEVT_GRID_EDITOR_SHOWN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_EDITOR_HIDDEN(fn) { wxEVT_GRID_EDITOR_HIDDEN, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, #if 0 // TODO: implement these ? others ? -const wxEventType EVT_GRID_CREATE_CELL = wxEVT_FIRST + 1576; -const wxEventType EVT_GRID_CHANGE_LABELS = wxEVT_FIRST + 1577; -const wxEventType EVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578; +const wxEventType wxEVT_GRID_CREATE_CELL = wxEVT_FIRST + 1576; +const wxEventType wxEVT_GRID_CHANGE_LABELS = wxEVT_FIRST + 1577; +const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578; -#define EVT_GRID_CREATE_CELL(fn) { EVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_CHANGE_LABELS(fn) { EVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, -#define EVT_GRID_CHANGE_SEL_LABEL(fn) { EVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CREATE_CELL(fn) { wxEVT_GRID_CREATE_CELL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CHANGE_LABELS(fn) { wxEVT_GRID_CHANGE_LABELS, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, +#define EVT_GRID_CHANGE_SEL_LABEL(fn) { wxEVT_GRID_CHANGE_SEL_LABEL, -1, -1, (wxObjectEventFunction) (wxEventFunction) (wxGridEventFunction) &fn, NULL }, #endif #endif // #ifndef __WXGRID_H__ #endif // ifndef wxUSE_NEW_GRID -