X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2586d4a12176c79b2c34859c95db17cf45b54204..8e77fd8bca165aab9709649d79a7cbc6a172d4e1:/include/wx/generic/dataview.h diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h index 18a6bb0123..fa8ad417c2 100644 --- a/include/wx/generic/dataview.h +++ b/include/wx/generic/dataview.h @@ -2,6 +2,7 @@ // Name: wx/generic/dataview.h // Purpose: wxDataViewCtrl generic implementation header // Author: Robert Roebling +// Modified By: Bo Yang // Id: $Id$ // Copyright: (c) 1998 Robert Roebling // Licence: wxWindows licence @@ -16,267 +17,260 @@ #include "wx/control.h" #include "wx/scrolwin.h" #include "wx/icon.h" +#include "wx/vector.h" -// --------------------------------------------------------- -// classes -// --------------------------------------------------------- - -class WXDLLIMPEXP_ADV wxDataViewCtrl; -class WXDLLIMPEXP_ADV wxDataViewMainWindow; -class WXDLLIMPEXP_ADV wxDataViewHeaderWindow; +class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow; +class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow; // --------------------------------------------------------- -// wxDataViewCell +// wxDataViewColumn // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewCell: public wxDataViewCellBase +class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase { public: - wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); - virtual ~wxDataViewCell(); - - virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0; - virtual wxSize GetSize() = 0; - - virtual bool Activate( wxRect WXUNUSED(cell), - wxDataViewListModel *WXUNUSED(model), - size_t WXUNUSED(col), - size_t WXUNUSED(row) ) - { return false; } - - virtual bool LeftClick( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewListModel *WXUNUSED(model), - size_t WXUNUSED(col), - size_t WXUNUSED(row) ) - { return false; } - virtual bool RightClick( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewListModel *WXUNUSED(model), - size_t WXUNUSED(col), - size_t WXUNUSED(row) ) - { return false; } - virtual bool StartDrag( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewListModel *WXUNUSED(model), - size_t WXUNUSED(col), - size_t WXUNUSED(row) ) - { return false; } - - // Create DC on request - virtual wxDC *GetDC(); + wxDataViewColumn(const wxString& title, + wxDataViewRenderer *renderer, + unsigned int model_column, + int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE) + : wxDataViewColumnBase(renderer, model_column), + m_title(title) + { + Init(width, align, flags); + } -private: - wxDC *m_dc; + wxDataViewColumn(const wxBitmap& bitmap, + wxDataViewRenderer *renderer, + unsigned int model_column, + int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE) + : wxDataViewColumnBase(bitmap, renderer, model_column) + { + Init(width, align, flags); + } -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCell) -}; + // implement wxHeaderColumnBase methods + virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); } + virtual wxString GetTitle() const { return m_title; } -// --------------------------------------------------------- -// wxDataViewCustomCell -// --------------------------------------------------------- + virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); } + virtual int GetWidth() const; -class WXDLLIMPEXP_ADV wxDataViewCustomCell: public wxDataViewCell -{ -public: - wxDataViewCustomCell( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); } + virtual int GetMinWidth() const { return m_minWidth; } -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell) -}; + virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); } + virtual wxAlignment GetAlignment() const { return m_align; } -// --------------------------------------------------------- -// wxDataViewTextCell -// --------------------------------------------------------- + virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); } + virtual int GetFlags() const { return m_flags; } -class WXDLLIMPEXP_ADV wxDataViewTextCell: public wxDataViewCustomCell -{ -public: - wxDataViewTextCell( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + virtual bool IsSortKey() const { return m_sort; } + + virtual void UnsetAsSortKey(); + + virtual void SetSortOrder(bool ascending); - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ); + virtual bool IsSortOrderAscending() const { return m_sortAscending; } + + virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); } - bool Render( wxRect cell, wxDC *dc, int state ); - wxSize GetSize(); private: - wxString m_text; + // common part of all ctors + void Init(int width, wxAlignment align, int flags); -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextCell) + void UpdateDisplay(); + + wxString m_title; + int m_width, + m_minWidth; + wxAlignment m_align; + int m_flags; + bool m_sort, + m_sortAscending; + + friend class wxDataViewHeaderWindowBase; + friend class wxDataViewHeaderWindow; + friend class wxDataViewHeaderWindowMSW; }; // --------------------------------------------------------- -// wxDataViewBitmapCell +// wxDataViewCtrl // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewBitmapCell: public wxDataViewCustomCell +WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList, + class WXDLLIMPEXP_ADV); + +class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase, + public wxScrollHelper { -public: - wxDataViewBitmapCell( const wxString &varianttype = wxT("wxBitmap"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + friend class wxDataViewMainWindow; + friend class wxDataViewHeaderWindowBase; + friend class wxDataViewHeaderWindow; + friend class wxDataViewHeaderWindowMSW; + friend class wxDataViewColumn; - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ); +public: + wxDataViewCtrl() : wxScrollHelper(this) + { + Init(); + } - bool Render( wxRect cell, wxDC *dc, int state ); - wxSize GetSize(); + wxDataViewCtrl( wxWindow *parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxDataViewCtrlNameStr ) + : wxScrollHelper(this) + { + Create(parent, id, pos, size, style, validator, name); + } -private: - wxIcon m_icon; - wxBitmap m_bitmap; + virtual ~wxDataViewCtrl(); -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapCell) -}; + void Init(); -// --------------------------------------------------------- -// wxDataViewToggleCell -// --------------------------------------------------------- + bool Create(wxWindow *parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxDataViewCtrlNameStr); -class WXDLLIMPEXP_ADV wxDataViewToggleCell: public wxDataViewCustomCell -{ -public: - wxDataViewToggleCell( const wxString &varianttype = wxT("bool"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + virtual bool AssociateModel( wxDataViewModel *model ); - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ); + virtual bool AppendColumn( wxDataViewColumn *col ); + virtual bool PrependColumn( wxDataViewColumn *col ); + virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col ); - bool Render( wxRect cell, wxDC *dc, int state ); - bool Activate( wxRect cell, wxDataViewListModel *model, size_t col, size_t row ); - wxSize GetSize(); + virtual void DoSetExpanderColumn(); + virtual void DoSetIndent(); -private: - bool m_toggle; + virtual unsigned int GetColumnCount() const; + virtual wxDataViewColumn* GetColumn( unsigned int pos ) const; + virtual bool DeleteColumn( wxDataViewColumn *column ); + virtual bool ClearColumns(); + virtual int GetColumnPosition( const wxDataViewColumn *column ) const; -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleCell) -}; + virtual wxDataViewColumn *GetSortingColumn() const; -// --------------------------------------------------------- -// wxDataViewProgressCell -// --------------------------------------------------------- + virtual int GetSelectedItemsCount() const; + virtual int GetSelections( wxDataViewItemArray & sel ) const; + virtual void SetSelections( const wxDataViewItemArray & sel ); + virtual void Select( const wxDataViewItem & item ); + virtual void Unselect( const wxDataViewItem & item ); + virtual bool IsSelected( const wxDataViewItem & item ) const; -class WXDLLIMPEXP_ADV wxDataViewProgressCell: public wxDataViewCustomCell -{ -public: - wxDataViewProgressCell( const wxString &label = wxEmptyString, - const wxString &varianttype = wxT("long"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); - virtual ~wxDataViewProgressCell(); + virtual void SelectAll(); + virtual void UnselectAll(); - bool SetValue( const wxVariant &value ); + virtual void EnsureVisible( const wxDataViewItem & item, + const wxDataViewColumn *column = NULL ); + virtual void HitTest( const wxPoint & point, wxDataViewItem & item, + wxDataViewColumn* &column ) const; + virtual wxRect GetItemRect( const wxDataViewItem & item, + const wxDataViewColumn *column = NULL ) const; - virtual bool Render( wxRect cell, wxDC *dc, int state ); - virtual wxSize GetSize(); + virtual bool SetRowHeight( int rowHeight ); -private: - wxString m_label; - int m_value; + virtual void Expand( const wxDataViewItem & item ); + virtual void Collapse( const wxDataViewItem & item ); + virtual bool IsExpanded( const wxDataViewItem & item ) const; -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell) -}; + virtual void SetFocus(); -// --------------------------------------------------------- -// wxDataViewDateCell -// --------------------------------------------------------- + virtual bool SetFont(const wxFont & font); -class WXDLLIMPEXP_ADV wxDataViewDateCell: public wxDataViewCustomCell -{ -public: - wxDataViewDateCell( const wxString &varianttype = wxT("datetime"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE ); +#if wxUSE_DRAG_AND_DROP + virtual bool EnableDragSource( const wxDataFormat &format ); + virtual bool EnableDropTarget( const wxDataFormat &format ); +#endif // wxUSE_DRAG_AND_DROP - bool SetValue( const wxVariant &value ); + virtual wxBorder GetDefaultBorder() const; - virtual bool Render( wxRect cell, wxDC *dc, int state ); - virtual wxSize GetSize(); - virtual bool Activate( wxRect cell, - wxDataViewListModel *model, size_t col, size_t row ); + virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column); -private: - wxDateTime m_date; + // These methods are specific to generic wxDataViewCtrl implementation and + // should not be used in portable code. + wxColour GetAlternateRowColour() const { return m_alternateRowColour; } + void SetAlternateRowColour(const wxColour& colour); protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell) -}; + virtual void EnsureVisible( int row, int column ); -// --------------------------------------------------------- -// wxDataViewColumn -// --------------------------------------------------------- + // Notice that row here may be invalid (i.e. >= GetRowCount()), this is not + // an error and this function simply returns an invalid item in this case. + virtual wxDataViewItem GetItemByRow( unsigned int row ) const; + virtual int GetRowByItem( const wxDataViewItem & item ) const; -class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase -{ -public: - wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column, - int fixed_width = 80, wxDataViewColumnSizing sizing = wxDATAVIEW_COL_WIDTH_FIXED, int flags = 0 ); - virtual ~wxDataViewColumn(); + int GetSortingColumnIndex() const { return m_sortingColumnIdx; } + void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; } - virtual void SetTitle( const wxString &title ); +public: // utility functions not part of the API - virtual int GetWidth(); + // returns the "best" width for the idx-th column + unsigned int GetBestColumnWidth(int idx) const; - virtual void SetFixedWidth( int width ); - virtual int GetFixedWidth(); - -private: - int m_width; - wxDataViewColumnSizing m_sizing; - int m_fixedWidth; + // called by header window after reorder + void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos ); -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn) -}; + // update the display after a change to an individual column + void OnColumnChange(unsigned int idx); -// --------------------------------------------------------- -// wxDataViewCtrl -// --------------------------------------------------------- + // update after a change to the number of columns + void OnColumnsCountChanged(); -class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase, - public wxScrollHelperNative -{ -public: - wxDataViewCtrl() : wxScrollHelperNative(this) - { - Init(); - } + wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; } - wxDataViewCtrl( wxWindow *parent, wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& validator = wxDefaultValidator ) - : wxScrollHelperNative(this) - { - Create(parent, id, pos, size, style, validator ); - } + // return the index of the given column in m_cols + int GetColumnIndex(const wxDataViewColumn *column) const; - virtual ~wxDataViewCtrl(); - - void Init(); + // return the column displayed at the given position in the control + wxDataViewColumn *GetColumnAt(unsigned int pos) const; - bool Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& validator = wxDefaultValidator ); + virtual wxDataViewColumn *GetCurrentColumn() const; - virtual bool AssociateModel( wxDataViewListModel *model ); - virtual bool AppendColumn( wxDataViewColumn *col ); + virtual void OnInternalIdle(); private: - friend class wxDataViewMainWindow; - friend class wxDataViewHeaderWindow; - wxDataViewListModelNotifier *m_notifier; - wxDataViewMainWindow *m_clientArea; - wxDataViewHeaderWindow *m_headerArea; + virtual wxDataViewItem DoGetCurrentItem() const; + virtual void DoSetCurrentItem(const wxDataViewItem& item); + + void InvalidateColBestWidths(); + void InvalidateColBestWidth(int idx); + void UpdateColWidths(); + + wxDataViewColumnList m_cols; + // cached column best widths information, values are for + // respective columns from m_cols and the arrays have same size + struct CachedColWidthInfo + { + CachedColWidthInfo() : width(0), dirty(true) {} + int width; // cached width or 0 if not computed + bool dirty; // column was invalidated, header needs updating + }; + wxVector m_colsBestWidths; + // This indicates that at least one entry in m_colsBestWidths has 'dirty' + // flag set. It's cheaper to check one flag in OnInternalIdle() than to + // iterate over m_colsBestWidths to check if anything needs to be done. + bool m_colsDirty; + + wxDataViewModelNotifier *m_notifier; + wxDataViewMainWindow *m_clientArea; + wxDataViewHeaderWindow *m_headerArea; + + // user defined color to draw row lines, may be invalid + wxColour m_alternateRowColour; + + // the index of the column currently used for sorting or -1 + int m_sortingColumnIdx; private: void OnSize( wxSizeEvent &event ); + virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); // we need to return a special WM_GETDLGCODE value to process just the // arrows but let the other navigation characters through @@ -288,7 +282,7 @@ private: private: DECLARE_DYNAMIC_CLASS(wxDataViewCtrl) - DECLARE_NO_COPY_CLASS(wxDataViewCtrl) + wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl); DECLARE_EVENT_TABLE() };