X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/66e09788abd37f13f2e458d37aa3b0b94033e5db..7d3f6b4ded6aa412cb1cc306fef478955d448c5b:/include/wx/generic/dataview.h?ds=sidebyside diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h index 4207e50ef6..d47b028b04 100644 --- a/include/wx/generic/dataview.h +++ b/include/wx/generic/dataview.h @@ -17,305 +17,94 @@ #include "wx/control.h" #include "wx/scrolwin.h" #include "wx/icon.h" +#include "wx/vector.h" -// --------------------------------------------------------- -// classes -// --------------------------------------------------------- - -class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl; class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow; class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow; // --------------------------------------------------------- -// wxDataViewRenderer -// --------------------------------------------------------- - -class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase -{ -public: - wxDataViewRenderer( const wxString &varianttype, - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - virtual ~wxDataViewRenderer(); - - virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0; - virtual wxSize GetSize() const = 0; - - virtual void SetAlignment( int align ) - { m_align=align; } - virtual int GetAlignment() const - { return m_align; } - - virtual void SetMode( wxDataViewCellMode mode ) - { m_mode=mode; } - virtual wxDataViewCellMode GetMode() const - { return m_mode; } - - virtual bool Activate( wxRect WXUNUSED(cell), - wxDataViewModel *WXUNUSED(model), - const wxDataViewItem & WXUNUSED(item), - unsigned int WXUNUSED(col) ) - { return false; } - - virtual bool LeftClick( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewModel *WXUNUSED(model), - const wxDataViewItem & WXUNUSED(item), - unsigned int WXUNUSED(col) ) - { return false; } - virtual bool RightClick( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewModel *WXUNUSED(model), - const wxDataViewItem & WXUNUSED(item), - unsigned int WXUNUSED(col) ) - { return false; } - virtual bool StartDrag( wxPoint WXUNUSED(cursor), - wxRect WXUNUSED(cell), - wxDataViewModel *WXUNUSED(model), - const wxDataViewItem & WXUNUSED(item), - unsigned int WXUNUSED(col) ) - { return false; } - - // Create DC on request - virtual wxDC *GetDC(); - -private: - wxDC *m_dc; - int m_align; - wxDataViewCellMode m_mode; - -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer) -}; - -// --------------------------------------------------------- -// wxDataViewCustomRenderer -// --------------------------------------------------------- - -class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer -{ -public: - wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer) -}; - - -// --------------------------------------------------------- -// wxDataViewTextRenderer -// --------------------------------------------------------- - -class WXDLLIMPEXP_ADV wxDataViewTextRenderer: public wxDataViewCustomRenderer -{ -public: - wxDataViewTextRenderer( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ) const; - - bool Render( wxRect cell, wxDC *dc, int state ); - wxSize GetSize() const; - - // in-place editing - virtual bool HasEditorCtrl(); - virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value ); - virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value ); - -private: - wxString m_text; - -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer) -}; - -// --------------------------------------------------------- -// wxDataViewBitmapRenderer -// --------------------------------------------------------- - -class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer -{ -public: - wxDataViewBitmapRenderer( const wxString &varianttype = wxT("wxBitmap"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ) const; - - bool Render( wxRect cell, wxDC *dc, int state ); - wxSize GetSize() const; - -private: - wxIcon m_icon; - wxBitmap m_bitmap; - -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer) -}; - -// --------------------------------------------------------- -// wxDataViewToggleRenderer +// wxDataViewColumn // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer +class WXDLLIMPEXP_ADV wxDataViewColumn : public wxDataViewColumnBase { public: - wxDataViewToggleRenderer( const wxString &varianttype = wxT("bool"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant &value ) const; - - bool Render( wxRect cell, wxDC *dc, int state ); - bool Activate( wxRect cell, wxDataViewModel *model, const wxDataViewItem & item, - unsigned int col ); - wxSize GetSize() const; - -private: - bool m_toggle; + 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); + } -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer) -}; + 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); + } -// --------------------------------------------------------- -// wxDataViewProgressRenderer -// --------------------------------------------------------- + // implement wxHeaderColumnBase methods + virtual void SetTitle(const wxString& title) { m_title = title; UpdateDisplay(); } + virtual wxString GetTitle() const { return m_title; } -class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer -{ -public: - wxDataViewProgressRenderer( const wxString &label = wxEmptyString, - const wxString &varianttype = wxT("long"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, - int align = wxDVR_DEFAULT_ALIGNMENT ); - virtual ~wxDataViewProgressRenderer(); + virtual void SetWidth(int width) { m_width = width; UpdateDisplay(); } + virtual int GetWidth() const; - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant& value ) const; + virtual void SetMinWidth(int minWidth) { m_minWidth = minWidth; UpdateDisplay(); } + virtual int GetMinWidth() const { return m_minWidth; } - virtual bool Render( wxRect cell, wxDC *dc, int state ); - virtual wxSize GetSize() const; + virtual void SetAlignment(wxAlignment align) { m_align = align; UpdateDisplay(); } + virtual wxAlignment GetAlignment() const { return m_align; } -private: - wxString m_label; - int m_value; + virtual void SetFlags(int flags) { m_flags = flags; UpdateDisplay(); } + virtual int GetFlags() const { return m_flags; } -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer) -}; + virtual void SetAsSortKey(bool sort = true) { m_sort = sort; UpdateDisplay(); } + virtual bool IsSortKey() const { return m_sort; } -// --------------------------------------------------------- -// wxDataViewDateRenderer -// --------------------------------------------------------- + virtual void SetSortOrder(bool ascending) { m_sortAscending = ascending; UpdateDisplay(); } + virtual bool IsSortOrderAscending() const { return m_sortAscending; } -class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer -{ -public: - wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, - int align = wxDVR_DEFAULT_ALIGNMENT ); + virtual void SetBitmap( const wxBitmap& bitmap ) { wxDataViewColumnBase::SetBitmap(bitmap); UpdateDisplay(); } - bool SetValue( const wxVariant &value ); - bool GetValue( wxVariant& value ) const; - - virtual bool Render( wxRect cell, wxDC *dc, int state ); - virtual wxSize GetSize() const; - virtual bool Activate( wxRect cell, - wxDataViewModel *model, const wxDataViewItem & item, unsigned int col ); private: - wxDateTime m_date; + // common part of all ctors + void Init(int width, wxAlignment align, int flags); -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer) -}; + void UpdateDisplay(); -// --------------------------------------------------------- -// wxDataViewColumn -// --------------------------------------------------------- + wxString m_title; + int m_width, + m_minWidth; + wxAlignment m_align; + int m_flags; + bool m_sort, + m_sortAscending; -class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase -{ friend class wxDataViewHeaderWindowBase; friend class wxDataViewHeaderWindow; friend class wxDataViewHeaderWindowMSW; - -public: - wxDataViewColumn( const wxString &title, wxDataViewRenderer *renderer, - unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, - wxAlignment align = wxALIGN_CENTER, - int flags = wxDATAVIEW_COL_RESIZABLE ); - wxDataViewColumn( const wxBitmap &bitmap, wxDataViewRenderer *renderer, - unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, - wxAlignment align = wxALIGN_CENTER, - int flags = wxDATAVIEW_COL_RESIZABLE ); - virtual ~wxDataViewColumn(); - - // setters: - - virtual void SetTitle( const wxString &title ) - { m_title=title; } - virtual void SetAlignment( wxAlignment align ) - { m_align=align; } - virtual void SetMinWidth( int minWidth ) - { m_minWidth=minWidth; } - virtual void SetWidth( int width ); - virtual void SetSortable( bool sortable ); - virtual void SetResizeable( bool resizeable ); - virtual void SetHidden( bool hidden ); - virtual void SetSortOrder( bool ascending ); - - - // getters: - - virtual wxString GetTitle() const - { return m_title; } - virtual wxAlignment GetAlignment() const - { return m_align; } - virtual int GetWidth() const - { return m_width; } - virtual int GetMinWidth() const - { return m_minWidth; } - virtual bool IsSortable() const - { return (m_flags & wxDATAVIEW_COL_SORTABLE) != 0; } - virtual bool IsResizeable() const - { return (m_flags & wxDATAVIEW_COL_RESIZABLE) != 0; } - virtual bool IsHidden() const - { return (m_flags & wxDATAVIEW_COL_HIDDEN) != 0; } - virtual bool IsSortOrderAscending() const; - - -private: - int m_width; - int m_minWidth; - int m_flags; - wxAlignment m_align; - wxString m_title; - bool m_ascending; - - void Init(int width); - - // like SetWidth() but does not ask the header window of the - // wxDataViewCtrl to reflect the width-change. - void SetInternalWidth(int width); - -protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn) }; // --------------------------------------------------------- // wxDataViewCtrl // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase, - public wxScrollHelperNative +WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList, + class WXDLLIMPEXP_ADV); + +class WXDLLIMPEXP_ADV wxDataViewCtrl : public wxDataViewCtrlBase, + public wxScrollHelper { friend class wxDataViewMainWindow; friend class wxDataViewHeaderWindowBase; @@ -324,19 +113,19 @@ class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase, friend class wxDataViewColumn; public: - wxDataViewCtrl() : wxScrollHelperNative(this) + wxDataViewCtrl() : wxScrollHelper(this) { - m_sortingColumn = 0; Init(); } wxDataViewCtrl( wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& validator = wxDefaultValidator ) - : wxScrollHelperNative(this) + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxDataViewCtrlNameStr ) + : wxScrollHelper(this) { - Create(parent, id, pos, size, style, validator ); + Create(parent, id, pos, size, style, validator, name); } virtual ~wxDataViewCtrl(); @@ -344,17 +133,29 @@ public: void Init(); bool Create(wxWindow *parent, wxWindowID id, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, long style = 0, - const wxValidator& validator = wxDefaultValidator ); + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxDataViewCtrlNameStr); virtual bool AssociateModel( wxDataViewModel *model ); + virtual bool AppendColumn( wxDataViewColumn *col ); + virtual bool PrependColumn( wxDataViewColumn *col ); + virtual bool InsertColumn( unsigned int pos, wxDataViewColumn *col ); virtual void DoSetExpanderColumn(); virtual void DoSetIndent(); - virtual wxDataViewItem GetSelection(); + 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; + + virtual wxDataViewColumn *GetSortingColumn() const; + + virtual wxDataViewItem GetSelection() const; virtual int GetSelections( wxDataViewItemArray & sel ) const; virtual void SetSelections( const wxDataViewItemArray & sel ); virtual void Select( const wxDataViewItem & item ); @@ -365,12 +166,29 @@ public: virtual void UnselectAll(); virtual void EnsureVisible( const wxDataViewItem & item, - wxDataViewColumn *column = NULL ); - virtual void HitTest( const wxPoint & point, wxDataViewItem & item, unsigned int & column ) const; - virtual wxRect GetItemRect( const wxDataViewItem & item, unsigned int column ) const; + 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 void Expand( const wxDataViewItem & item ); + virtual void Collapse( const wxDataViewItem & item ); + virtual bool IsExpanded( const wxDataViewItem & item ) const; + + virtual void SetFocus(); + +#if wxUSE_DRAG_AND_DROP + virtual bool EnableDragSource( const wxDataFormat &format ); + virtual bool EnableDropTarget( const wxDataFormat &format ); +#endif // wxUSE_DRAG_AND_DROP + + virtual wxBorder GetDefaultBorder() const; + + void StartEditor( const wxDataViewItem & item, unsigned int column ); protected: - virtual int GetSelections( wxArrayInt & sel ) const; + virtual int GetSelections( wxArrayInt & sel ) const; virtual void SetSelections( const wxArrayInt & sel ); virtual void Select( int row ); virtual void Unselect( int row ); @@ -378,35 +196,57 @@ protected: virtual void SelectRange( int from, int to ); virtual void UnselectRange( int from, int to ); - virtual void EnsureVisible( int row ); + virtual void EnsureVisible( int row, int column ); virtual wxDataViewItem GetItemByRow( unsigned int row ) const; virtual int GetRowByItem( const wxDataViewItem & item ) const; - unsigned int GetSortingColumn() { return m_sortingColumn; } - void SetSortingColumn( unsigned int column ) { m_sortingColumn = column; } + int GetSortingColumnIndex() const { return m_sortingColumnIdx; } + void SetSortingColumnIndex(int idx) { m_sortingColumnIdx = idx; } public: // utility functions not part of the API // returns the "best" width for the idx-th column - unsigned int GetBestColumnWidth(int WXUNUSED(idx)) const - { - return GetClientSize().GetWidth() / GetColumnCount(); - } + unsigned int GetBestColumnWidth(int idx) const; + + // called by header window after reorder + void ColumnMoved( wxDataViewColumn* col, unsigned int new_pos ); - // updates the header window after a change in a column setting - void OnColumnChange(); + // update the display after a change to an individual column + void OnColumnChange(unsigned int idx); + + // update after a change to the number of columns + void OnColumnsCountChanged(); wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; } + // return the index of the given column in m_cols + int GetColumnIndex(const wxDataViewColumn *column) const; + + // return the column displayed at the given position in the control + wxDataViewColumn *GetColumnAt(unsigned int pos) const; + private: - wxDataViewModelNotifier *m_notifier; - wxDataViewMainWindow *m_clientArea; - wxDataViewHeaderWindow *m_headerArea; - unsigned int m_sortingColumn; + virtual wxDataViewItem DoGetCurrentItem() const; + virtual void DoSetCurrentItem(const wxDataViewItem& item); + + void InvalidateColBestWidths(); + void InvalidateColBestWidth(int idx); + + wxDataViewColumnList m_cols; + // cached column best widths or 0 if not computed, values are for + // respective columns from m_cols and the arrays have same size + wxVector m_colsBestWidths; + wxDataViewModelNotifier *m_notifier; + wxDataViewMainWindow *m_clientArea; + wxDataViewHeaderWindow *m_headerArea; + + // 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 @@ -418,7 +258,7 @@ private: private: DECLARE_DYNAMIC_CLASS(wxDataViewCtrl) - DECLARE_NO_COPY_CLASS(wxDataViewCtrl) + wxDECLARE_NO_COPY_CLASS(wxDataViewCtrl); DECLARE_EVENT_TABLE() };