X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/816be743e86d10387376fa87ddb2fc684eb1efd3..1f80a703f24bc50a5ce92fb1406dd1b38ac4e506:/include/wx/generic/grid.h diff --git a/include/wx/generic/grid.h b/include/wx/generic/grid.h index 3c10ae8507..cf4d7155f2 100644 --- a/include/wx/generic/grid.h +++ b/include/wx/generic/grid.h @@ -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 @@ -58,6 +58,7 @@ #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 @@ -75,20 +76,65 @@ 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 @@ -105,8 +151,14 @@ public: int row, int col, bool isSelected) = 0; - // virtual dtor for any base class - virtual ~wxGridCellRenderer(); + // 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 @@ -121,12 +173,26 @@ public: 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 @@ -140,18 +206,29 @@ public: 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, int precision); + wxGridCellFloatRenderer(int width = -1, int precision = -1); // get/change formatting parameters int GetWidth() const { return m_width; } - void SetWidth(int width) { m_width = width; } + void SetWidth(int width) { m_width = width; m_format.clear(); } int GetPrecision() const { return m_precision; } - void SetPrecision(int precision) { m_precision = 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, @@ -161,6 +238,19 @@ public: 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, @@ -180,6 +270,18 @@ public: 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; }; // ---------------------------------------------------------------------------- @@ -190,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; } @@ -218,11 +319,9 @@ public: // to begin editing. Set the focus to the edit control. 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) = 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; @@ -243,7 +342,13 @@ 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; @@ -253,6 +358,10 @@ protected: 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 @@ -269,12 +378,18 @@ public: virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr *attr); virtual void BeginEdit(int row, int col, wxGrid* grid); - virtual bool EndEdit(int row, int col, bool saveValue, 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; } @@ -283,6 +398,7 @@ protected: void DoReset(const wxString& startValue); private: + size_t m_maxChars; // max number of chars allowed wxString m_startValue; }; @@ -299,11 +415,17 @@ public: wxEvtHandler* evtHandler); virtual void BeginEdit(int row, int col, wxGrid* grid); - virtual bool EndEdit(int row, int col, bool saveValue, 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; } @@ -330,11 +452,14 @@ public: wxEvtHandler* evtHandler); virtual void BeginEdit(int row, int col, wxGrid* grid); - virtual bool EndEdit(int row, int col, bool saveValue, 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 @@ -356,11 +481,14 @@ public: 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, bool saveValue, 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; } @@ -368,6 +496,40 @@ 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 @@ -397,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; } @@ -420,9 +581,9 @@ public: // 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(); } @@ -436,8 +597,8 @@ public: const wxColour& GetBackgroundColour() const; const wxFont& GetFont() const; void GetAlignment(int *hAlign, int *vAlign) const; - wxGridCellRenderer *GetRenderer(wxGridCellRenderer* def) const; - wxGridCellEditor *GetEditor(wxGridCellEditor* def) 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; } @@ -456,7 +617,11 @@ private: } // 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; @@ -473,6 +638,9 @@ private: 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; @@ -788,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 // @@ -822,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 ); @@ -833,6 +1010,7 @@ 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& ); @@ -889,7 +1067,6 @@ public: void ShowCellEditControl(); void HideCellEditControl(); - void SetEditControlValue( const wxString& s = wxEmptyString ); void SaveEditControlValue(); @@ -965,18 +1142,29 @@ public: void SetRowLabelValue( int row, const wxString& ); 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; } @@ -1001,10 +1189,30 @@ public: 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& ); @@ -1071,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 @@ -1112,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 @@ -1137,7 +1326,13 @@ public: 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... // @@ -1150,9 +1345,10 @@ public: wxGrid( wxWindow *parent, int x, int y, int w = -1, int h = -1, - long style = 0, + 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(); } @@ -1299,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; @@ -1321,8 +1522,9 @@ 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; @@ -1359,6 +1561,10 @@ protected: 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; @@ -1374,12 +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 - wxHashTable m_colMinWidths; + wxHashTableLong m_colMinWidths, + m_rowMinHeights; - // get the minimal width of the given column - int GetColMinimalWidth(int col) const; + // 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(); @@ -1453,6 +1668,7 @@ protected: bool m_canDragRowSize; bool m_canDragColSize; + bool m_canDragGridSize; int m_dragLastPos; int m_dragRowOrCol; bool m_isDragging; @@ -1501,13 +1717,12 @@ protected: bool GetModelValues(); bool SetModelValues(); + friend class wxGridSelection; DECLARE_DYNAMIC_CLASS( wxGrid ) DECLARE_EVENT_TABLE() }; - - // ---------------------------------------------------------------------------- // Grid event class and event types // ---------------------------------------------------------------------------- @@ -1675,4 +1890,3 @@ const wxEventType wxEVT_GRID_CHANGE_SEL_LABEL = wxEVT_FIRST + 1578; #endif // #ifndef __WXGRID_H__ #endif // ifndef wxUSE_NEW_GRID -