X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9d14de69f4d94666e630a11457258b90fff2d0b3..3b49331b7441e091fc5997b830801d76a1243f28:/include/wx/generic/dataview.h diff --git a/include/wx/generic/dataview.h b/include/wx/generic/dataview.h index c7802da9e7..efa5a11c74 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 @@ -15,185 +16,362 @@ #include "wx/list.h" #include "wx/control.h" #include "wx/scrolwin.h" +#include "wx/icon.h" -// --------------------------------------------------------- +// --------------------------------------------------------- // classes -// --------------------------------------------------------- +// --------------------------------------------------------- -class WXDLLIMPEXP_CORE wxDataViewCtrl; +class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl; +class WXDLLIMPEXP_FWD_ADV wxDataViewMainWindow; +class WXDLLIMPEXP_FWD_ADV wxDataViewHeaderWindow; -// --------------------------------------------------------- -// wxDataViewCell -// --------------------------------------------------------- +// --------------------------------------------------------- +// wxDataViewRenderer +// --------------------------------------------------------- -class wxDataViewCell: public wxDataViewCellBase +class WXDLLIMPEXP_ADV wxDataViewRenderer: public wxDataViewRendererBase { public: - wxDataViewCell( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + 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(wxDataViewCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer) }; - -// --------------------------------------------------------- -// wxDataViewTextCell -// --------------------------------------------------------- -class wxDataViewTextCell: public wxDataViewCell +// --------------------------------------------------------- +// wxDataViewCustomRenderer +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewCustomRenderer: public wxDataViewRenderer { public: - wxDataViewTextCell( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + wxDataViewCustomRenderer( const wxString &varianttype = wxT("string"), + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, + int align = wxDVR_DEFAULT_ALIGNMENT ); + + void RenderText( const wxString &text, int xoffset, wxRect cell, wxDC *dc, int state ); + +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 ); - + 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(wxDataViewTextCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer) }; - -// --------------------------------------------------------- -// wxDataViewToggleCell -// --------------------------------------------------------- -class wxDataViewToggleCell: public wxDataViewCell +// --------------------------------------------------------- +// wxDataViewBitmapRenderer +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer: public wxDataViewCustomRenderer { public: - wxDataViewToggleCell( const wxString &varianttype = wxT("bool"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + 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 ); - + 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(wxDataViewToggleCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer) }; - -// --------------------------------------------------------- -// wxDataViewCustomCell -// --------------------------------------------------------- -class wxDataViewCustomCell: public wxDataViewCell +// --------------------------------------------------------- +// wxDataViewToggleRenderer +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewToggleRenderer: public wxDataViewCustomRenderer { public: - wxDataViewCustomCell( const wxString &varianttype = wxT("string"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); - ~wxDataViewCustomCell(); - bool Init(); - - virtual bool Render( wxRect cell, wxDC *dc, int state ) = 0; - virtual wxSize GetSize() = 0; - - virtual bool Activate( wxRect cell, - wxDataViewListModel *model, size_t col, size_t row ) - { return false; } - - virtual bool LeftClick( wxPoint cursor, wxRect cell, - wxDataViewListModel *model, size_t col, size_t row ) - { return false; } - virtual bool RightClick( wxPoint cursor, wxRect cell, - wxDataViewListModel *model, size_t col, size_t row ) - { return false; } - virtual bool StartDrag( wxPoint cursor, wxRect cell, - wxDataViewListModel *model, size_t col, size_t row ) - { return false; } - - // Create DC on request - virtual wxDC *GetDC(); - + 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: - wxDC *m_dc; - + bool m_toggle; + protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer) }; - -// --------------------------------------------------------- -// wxDataViewProgressCell -// --------------------------------------------------------- -class wxDataViewProgressCell: public wxDataViewCustomCell +// --------------------------------------------------------- +// wxDataViewProgressRenderer +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewProgressRenderer: public wxDataViewCustomRenderer { public: - wxDataViewProgressCell( const wxString &label = wxEmptyString, - const wxString &varianttype = wxT("long"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); - ~wxDataViewProgressCell(); - + wxDataViewProgressRenderer( const wxString &label = wxEmptyString, + const wxString &varianttype = wxT("long"), + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, + int align = wxDVR_DEFAULT_ALIGNMENT ); + virtual ~wxDataViewProgressRenderer(); + bool SetValue( const wxVariant &value ); - + bool GetValue( wxVariant& value ) const; + virtual bool Render( wxRect cell, wxDC *dc, int state ); - virtual wxSize GetSize(); - + virtual wxSize GetSize() const; + private: wxString m_label; int m_value; - + protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer) }; // --------------------------------------------------------- -// wxDataViewDateCell +// wxDataViewIconTextRenderer // --------------------------------------------------------- -class wxDataViewDateCell: public wxDataViewCustomCell +class wxDataViewIconTextRenderer: public wxDataViewCustomRenderer { public: - wxDataViewDateCell( const wxString &varianttype = wxT("datetime"), - wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE ); + wxDataViewIconTextRenderer( const wxString &varianttype = wxT("wxDataViewIconText"), + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, + int align = wxDVR_DEFAULT_ALIGNMENT ); + virtual ~wxDataViewIconTextRenderer(); bool SetValue( const wxVariant &value ); + bool GetValue( wxVariant &value ) 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 wxSize GetSize() const; + + virtual bool HasEditorCtrl() { return true; } + virtual wxControl* CreateEditorCtrl( wxWindow *parent, wxRect labelRect, const wxVariant &value ); + virtual bool GetValueFromEditorCtrl( wxControl* editor, wxVariant &value ); private: - wxDateTime m_date; + wxDataViewIconText m_value; protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateCell) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer) }; - -// --------------------------------------------------------- + +// --------------------------------------------------------- +// wxDataViewDateRenderer +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer +{ +public: + wxDataViewDateRenderer( const wxString &varianttype = wxT("datetime"), + wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, + int align = wxDVR_DEFAULT_ALIGNMENT ); + + 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; + +protected: + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer) +}; + +// --------------------------------------------------------- // wxDataViewColumn -// --------------------------------------------------------- +// --------------------------------------------------------- -class WXDLLIMPEXP_CORE wxDataViewColumn: public wxDataViewColumnBase +class WXDLLIMPEXP_ADV wxDataViewColumn: public wxDataViewColumnBase { + friend class wxDataViewHeaderWindowBase; + friend class wxDataViewHeaderWindow; + friend class wxDataViewHeaderWindowMSW; + public: - wxDataViewColumn( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 ); + 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(); - virtual void SetTitle( const wxString &title ); - + // 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 -// --------------------------------------------------------- +// --------------------------------------------------------- + +WX_DECLARE_LIST_WITH_DECL(wxDataViewColumn, wxDataViewColumnList, + class WXDLLIMPEXP_ADV); -class WXDLLIMPEXP_CORE wxDataViewCtrl: public wxDataViewCtrlBase, +class WXDLLIMPEXP_ADV wxDataViewCtrl: public wxDataViewCtrlBase, public wxScrollHelperNative { + friend class wxDataViewMainWindow; + friend class wxDataViewHeaderWindowBase; + friend class wxDataViewHeaderWindow; + friend class wxDataViewHeaderWindowMSW; + friend class wxDataViewColumn; + public: wxDataViewCtrl() : wxScrollHelperNative(this) { + //No sorting column at start, I think + m_sortingColumn = NULL; 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 ) + : wxScrollHelperNative(this) { + m_sortingColumn = NULL; Create(parent, id, pos, size, style, validator ); } @@ -206,16 +384,78 @@ public: const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator = wxDefaultValidator ); - virtual bool AssociateModel( wxDataViewListModel *model ); + virtual bool AssociateModel( wxDataViewModel *model ); virtual bool AppendColumn( wxDataViewColumn *col ); + virtual bool PrependColumn( wxDataViewColumn *col ); + + virtual void DoSetExpanderColumn(); + virtual void DoSetIndent(); + + 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 ); + virtual void Unselect( const wxDataViewItem & item ); + virtual bool IsSelected( const wxDataViewItem & item ) const; + + virtual void SelectAll(); + virtual void UnselectAll(); + + 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 void Expand( const wxDataViewItem & item ); + virtual void Collapse( const wxDataViewItem & item ); + +protected: + virtual int GetSelections( wxArrayInt & sel ) const; + virtual void SetSelections( const wxArrayInt & sel ); + virtual void Select( int row ); + virtual void Unselect( int row ); + virtual bool IsSelected( int row ) const; + virtual void SelectRange( int from, int to ); + virtual void UnselectRange( int from, int to ); + + virtual void EnsureVisible( int row, int column ); + + virtual wxDataViewItem GetItemByRow( unsigned int row ) const; + virtual int GetRowByItem( const wxDataViewItem & item ) const; + + wxDataViewColumn* GetSortingColumn() { return m_sortingColumn; } + void SetSortingColumn( wxDataViewColumn* column ) { m_sortingColumn = column; } + +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(); + } + + // updates the header window after a change in a column setting + void OnColumnChange(); + + wxWindow *GetMainWindow() { return (wxWindow*) m_clientArea; } + private: - wxDataViewListModelNotifier *m_notifier; - wxWindow *m_clientArea; - wxWindow *m_headerArea; - + wxDataViewColumnList m_cols; + wxDataViewModelNotifier *m_notifier; + wxDataViewMainWindow *m_clientArea; + wxDataViewHeaderWindow *m_headerArea; + wxDataViewColumn* m_sortingColumn; + private: - virtual void ScrollWindow( int dx, int dy, const wxRect *rect ); + void OnSize( wxSizeEvent &event ); // we need to return a special WM_GETDLGCODE value to process just the // arrows but let the other navigation characters through @@ -224,10 +464,11 @@ private: #endif // __WXMSW__ WX_FORWARD_TO_SCROLL_HELPER() - + private: DECLARE_DYNAMIC_CLASS(wxDataViewCtrl) DECLARE_NO_COPY_CLASS(wxDataViewCtrl) + DECLARE_EVENT_TABLE() };