X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c5c1ea964817e562d1c4b0d89b3937fce28c3f10..153530afb595110592776c461e52be99b1559439:/include/wx/generic/grid.h?ds=inline diff --git a/include/wx/generic/grid.h b/include/wx/generic/grid.h index 7fd7dd7b12..c65d2e2f50 100644 --- a/include/wx/generic/grid.h +++ b/include/wx/generic/grid.h @@ -44,11 +44,11 @@ extern WXDLLIMPEXP_DATA_ADV(const char) wxGridNameStr[]; #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_STRING wxT("string") +#define wxGRID_VALUE_BOOL wxT("bool") +#define wxGRID_VALUE_NUMBER wxT("long") +#define wxGRID_VALUE_FLOAT wxT("double") +#define wxGRID_VALUE_CHOICE wxT("choice") #define wxGRID_VALUE_TEXT wxGRID_VALUE_STRING #define wxGRID_VALUE_LONG wxGRID_VALUE_NUMBER @@ -110,16 +110,10 @@ class wxGridDirectionOperations; // class is not documented and is not public at all // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_ADV wxGridCellWorker : public wxClientDataContainer +class WXDLLIMPEXP_ADV wxGridCellWorker : public wxClientDataContainer, public wxRefCounter { 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 == 0 ) delete this; } + wxGridCellWorker() { } // interpret renderer parameters: arbitrary string whose interpretatin is // left to the derived classes @@ -131,8 +125,6 @@ protected: virtual ~wxGridCellWorker(); private: - size_t m_nRef; - // suppress the stupid gcc warning about the class having private dtor and // no friends friend class wxGridCellWorkerDummyFriend; @@ -290,6 +282,87 @@ protected: wxDECLARE_NO_COPY_CLASS(wxGridCellEditor); }; +// ---------------------------------------------------------------------------- +// wxGridHeaderRenderer and company: like wxGridCellRenderer but for headers +// ---------------------------------------------------------------------------- + +// Base class for corner window renderer: it is the simplest of all renderers +// and only has a single function +class WXDLLIMPEXP_ADV wxGridCornerHeaderRenderer +{ +public: + // Draw the border around the corner window. + virtual void DrawBorder(const wxGrid& grid, + wxDC& dc, + wxRect& rect) const = 0; + + // make the dtor of a class with virtual functions virtual to avoid g++ + // warnings, even though this class is not supposed to be used + // polymorphically + virtual ~wxGridCornerHeaderRenderer() { } +}; + + +// Base class for the row/column header cells renderers +class WXDLLIMPEXP_ADV wxGridHeaderLabelsRenderer + : public wxGridCornerHeaderRenderer +{ +public: + // Draw header cell label + virtual void DrawLabel(const wxGrid& grid, + wxDC& dc, + const wxString& value, + const wxRect& rect, + int horizAlign, + int vertAlign, + int textOrientation) const; +}; + +// Currently the row/column/corner renders don't need any methods other than +// those already in wxGridHeaderLabelsRenderer but still define separate classes +// for them for future extensions and also for better type safety (i.e. to +// avoid inadvertently using a column header renderer for the row headers) +class WXDLLIMPEXP_ADV wxGridRowHeaderRenderer + : public wxGridHeaderLabelsRenderer +{ +}; + +class WXDLLIMPEXP_ADV wxGridColumnHeaderRenderer + : public wxGridHeaderLabelsRenderer +{ +}; + +// Also define the default renderers which are used by wxGridCellAttrProvider +// by default +class WXDLLIMPEXP_ADV wxGridRowHeaderRendererDefault + : public wxGridRowHeaderRenderer +{ +public: + virtual void DrawBorder(const wxGrid& grid, + wxDC& dc, + wxRect& rect) const; +}; + +// Column header cells renderers +class WXDLLIMPEXP_ADV wxGridColumnHeaderRendererDefault + : public wxGridColumnHeaderRenderer +{ +public: + virtual void DrawBorder(const wxGrid& grid, + wxDC& dc, + wxRect& rect) const; +}; + +// Header corner renderer +class WXDLLIMPEXP_ADV wxGridCornerHeaderRendererDefault + : public wxGridCornerHeaderRenderer +{ +public: + virtual void DrawBorder(const wxGrid& grid, + wxDC& dc, + wxRect& rect) const; +}; + // ---------------------------------------------------------------------------- // wxGridCellAttr: this class can be used to alter the cells appearance in @@ -297,7 +370,7 @@ protected: // class may be returned by wxGridTable::GetAttr(). // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_ADV wxGridCellAttr : public wxClientDataContainer +class WXDLLIMPEXP_ADV wxGridCellAttr : public wxClientDataContainer, public wxRefCounter { public: enum wxAttrKind @@ -315,8 +388,7 @@ public: { Init(attrDefault); - // MB: args used to be 0,0 here but wxALIGN_LEFT is 0 - SetAlignment(-1, -1); + SetAlignment(wxALIGN_INVALID, wxALIGN_INVALID); } // VZ: considering the number of members wxGridCellAttr has now, this ctor @@ -336,12 +408,6 @@ public: wxGridCellAttr *Clone() const; void MergeWith(wxGridCellAttr *mergefrom); - // 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 == 0 ) delete this; } - // setters void SetTextColour(const wxColour& colText) { m_colText = colText; } void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; } @@ -366,10 +432,13 @@ public: void SetKind(wxAttrKind kind) { m_attrkind = kind; } // accessors - 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 != -1 || m_vAlign != -1); } + bool HasTextColour() const { return m_colText.IsOk(); } + bool HasBackgroundColour() const { return m_colBack.IsOk(); } + bool HasFont() const { return m_font.IsOk(); } + bool HasAlignment() const + { + return m_hAlign != wxALIGN_INVALID || m_vAlign != wxALIGN_INVALID; + } bool HasRenderer() const { return m_renderer != NULL; } bool HasEditor() const { return m_editor != NULL; } bool HasReadWriteMode() const { return m_isReadOnly != Unset; } @@ -380,6 +449,15 @@ public: const wxColour& GetBackgroundColour() const; const wxFont& GetFont() const; void GetAlignment(int *hAlign, int *vAlign) const; + + // unlike GetAlignment() which always overwrites its output arguments with + // the alignment values to use, falling back on default alignment if this + // attribute doesn't have any, this function will preserve the values of + // parameters on entry if the corresponding alignment is not set in this + // attribute meaning that they can be initialized to default alignment (and + // also that they must be initialized, unlike with GetAlignment()) + void GetNonDefaultAlignment(int *hAlign, int *vAlign) const; + void GetSize(int *num_rows, int *num_cols) const; bool GetOverflow() const { return m_overflow != SingleCell; } @@ -419,9 +497,6 @@ private: void Init(wxGridCellAttr *attrDefault = NULL); - // the ref count - when it goes to 0, we die - size_t m_nRef; - wxColour m_colText, m_colBack; wxFont m_font; @@ -481,6 +556,14 @@ public: void UpdateAttrRows( size_t pos, int numRows ); void UpdateAttrCols( size_t pos, int numCols ); + + // get renderers for the given row/column header label and the corner + // window: unlike cell renderers, these objects are not reference counted + // and are never NULL so they are returned by reference + virtual const wxGridColumnHeaderRenderer& GetColumnHeaderRenderer(int col); + virtual const wxGridRowHeaderRenderer& GetRowHeaderRenderer(int row); + virtual const wxGridCornerHeaderRenderer& GetCornerRenderer(); + private: void InitData(); @@ -725,14 +808,13 @@ class WXDLLIMPEXP_ADV wxGridStringTable : public wxGridTableBase public: wxGridStringTable(); wxGridStringTable( int numRows, int numCols ); - virtual ~wxGridStringTable(); // these are pure virtual in wxGridTableBase // - int GetNumberRows(); - int GetNumberCols(); - wxString GetValue( int row, int col ); - void SetValue( int row, int col, const wxString& s ); + virtual int GetNumberRows() { return m_data.size(); } + virtual int GetNumberCols() { return m_numCols; } + virtual wxString GetValue( int row, int col ); + virtual void SetValue( int row, int col, const wxString& s ); // overridden functions from wxGridTableBase // @@ -752,6 +834,12 @@ public: private: wxGridStringArray m_data; + // notice that while we don't need to store the number of our rows as it's + // always equal to the size of m_data array, we do need to store the number + // of our columns as we can't retrieve it from m_data when the number of + // rows is 0 (see #10818) + int m_numCols; + // These only get used if you set your own labels, otherwise the // GetRow/ColLabelValue functions return wxGridTableBase defaults // @@ -935,12 +1023,12 @@ public: void DrawTextRectangle( wxDC& dc, const wxString&, const wxRect&, int horizontalAlignment = wxALIGN_LEFT, int verticalAlignment = wxALIGN_TOP, - int textOrientation = wxHORIZONTAL ); + int textOrientation = wxHORIZONTAL ) const; void DrawTextRectangle( wxDC& dc, const wxArrayString& lines, const wxRect&, int horizontalAlignment = wxALIGN_LEFT, int verticalAlignment = wxALIGN_TOP, - int textOrientation = wxHORIZONTAL ); + int textOrientation = wxHORIZONTAL ) const; // Split a string containing newline characters into an array of @@ -1180,6 +1268,12 @@ public: void SetRowAttr(int row, wxGridCellAttr *attr); void SetColAttr(int col, wxGridCellAttr *attr); + // the grid can cache attributes for the recently used cells (currently it + // only caches one attribute for the most recently used one) and might + // notice that its value in the attribute provider has changed -- if this + // happens, call this function to force it + void RefreshAttr(int row, int col); + // returns the attribute we may modify in place: a new one if this cell // doesn't have any yet or the existing one if it does // @@ -1213,7 +1307,24 @@ public: void GetCellAlignment( int row, int col, int *horiz, int *vert ) const; bool GetDefaultCellOverflow() const; bool GetCellOverflow( int row, int col ) const; - void GetCellSize( int row, int col, int *num_rows, int *num_cols ) const; + + // this function returns 1 in num_rows and num_cols for normal cells, + // positive numbers for a cell spanning multiple columns/rows (as set with + // SetCellSize()) and _negative_ numbers corresponding to the offset of the + // top left cell of the span from this one for the other cells covered by + // this cell + // + // the return value is CellSpan_None, CellSpan_Main or CellSpan_Inside for + // each of these cases respectively + enum CellSpan + { + CellSpan_Inside = -1, + CellSpan_None = 0, + CellSpan_Main + }; + + CellSpan GetCellSize( int row, int col, int *num_rows, int *num_cols ) const; + wxSize GetCellSize(const wxGridCellCoords& coords) { wxSize s; @@ -1490,10 +1601,10 @@ public: } // Allow adjustment of scroll increment. The default is (15, 15). - void SetScrollLineX(int x) { m_scrollLineX = x; } - void SetScrollLineY(int y) { m_scrollLineY = y; } - int GetScrollLineX() const { return m_scrollLineX; } - int GetScrollLineY() const { return m_scrollLineY; } + void SetScrollLineX(int x) { m_xScrollPixelsPerLine = x; } + void SetScrollLineY(int y) { m_yScrollPixelsPerLine = y; } + int GetScrollLineX() const { return m_xScrollPixelsPerLine; } + int GetScrollLineY() const { return m_yScrollPixelsPerLine; } // ------- drag and drop #if wxUSE_DRAG_AND_DROP @@ -1598,9 +1709,9 @@ public: void SetLabelAlignment( int orientation, int align ) { if ( orientation == wxHORIZONTAL ) - SetColLabelAlignment( align, -1 ); + SetColLabelAlignment( align, wxALIGN_INVALID ); else - SetRowLabelAlignment( align, -1 ); + SetRowLabelAlignment( align, wxALIGN_INVALID ); } int GetLabelAlignment( int orientation, int WXUNUSED(align) ) const @@ -1941,9 +2052,6 @@ protected: bool m_editable; // applies to whole grid bool m_cellEditCtrlEnabled; // is in-place edit currently shown? - int m_scrollLineX; // X scroll increment - int m_scrollLineY; // Y scroll increment - void Init(); // common part of all ctors void Create(); void CreateColumnWindow(); @@ -2013,10 +2121,12 @@ protected: friend class wxGridColLabelWindow; friend class wxGridRowLabelWindow; friend class wxGridWindow; + friend class wxGridHeaderRenderer; friend class wxGridHeaderCtrl; private: + // implement wxScrolledWindow method to return m_gridWin size virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); @@ -2156,7 +2266,7 @@ public: // more than once void Create(wxGrid *grid) { - wxASSERT_MSG( !m_grid, _T("shouldn't be called more than once") ); + wxASSERT_MSG( !m_grid, wxT("shouldn't be called more than once") ); Init(grid); } @@ -2512,9 +2622,9 @@ extern const int wxEVT_GRID_CREATE_CELL; extern const int wxEVT_GRID_CHANGE_LABELS; extern const int wxEVT_GRID_CHANGE_SEL_LABEL; -#define EVT_GRID_CREATE_CELL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), -#define EVT_GRID_CHANGE_LABELS(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), -#define EVT_GRID_CHANGE_SEL_LABEL(fn) DECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_SEL_LABEL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), +#define EVT_GRID_CREATE_CELL(fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CREATE_CELL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), +#define EVT_GRID_CHANGE_LABELS(fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_LABELS, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), +#define EVT_GRID_CHANGE_SEL_LABEL(fn) wxDECLARE_EVENT_TABLE_ENTRY( wxEVT_GRID_CHANGE_SEL_LABEL, wxID_ANY, wxID_ANY, (wxObjectEventFunction) (wxEventFunction) wxStaticCastEvent( wxGridEventFunction, &fn ), NULL ), #endif