X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b5d777c78eef2b5d2a949f2898bc3190dd135e6f..d7330233fd94f17c0f7e0e1008aa2ff9a72f0409:/include/wx/dataview.h diff --git a/include/wx/dataview.h b/include/wx/dataview.h index 5d2b516d77..d255228773 100644 --- a/include/wx/dataview.h +++ b/include/wx/dataview.h @@ -21,101 +21,211 @@ #include "wx/bitmap.h" #include "wx/variant.h" + +#if defined(__WXGTK20__) + // for testing + // #define wxUSE_GENERICDATAVIEWCTRL 1 +#elif defined(__WXMAC__) + #define wxUSE_GENERICDATAVIEWCTRL 1 +#else + #define wxUSE_GENERICDATAVIEWCTRL 1 +#endif + // ---------------------------------------------------------------------------- -// wxDataViewCtrl flags +// wxDataViewCtrl flags // ---------------------------------------------------------------------------- // ---------------------------------------------------------------------------- // wxDataViewCtrl globals // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_CORE wxDataViewCtrl; -class WXDLLIMPEXP_CORE wxDataViewColumn; -class WXDLLIMPEXP_CORE wxDataViewCell; +class WXDLLIMPEXP_ADV wxDataViewModel; +class WXDLLIMPEXP_ADV wxDataViewListModel; +class WXDLLIMPEXP_ADV wxDataViewCtrl; +class WXDLLIMPEXP_ADV wxDataViewColumn; +class WXDLLIMPEXP_ADV wxDataViewRenderer; -extern WXDLLEXPORT_DATA(const wxChar) wxDataViewCtrlNameStr[]; +extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[]; -// --------------------------------------------------------- +// the default width of new (text) columns: +#define wxDVC_DEFAULT_WIDTH 80 + +// the default width of new toggle columns: +#define wxDVC_TOGGLE_DEFAULT_WIDTH 30 + + +// --------------------------------------------------------- // wxDataViewModel -// --------------------------------------------------------- +// --------------------------------------------------------- -class wxDataViewModel: public wxObject +class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData { public: wxDataViewModel() { } - virtual ~wxDataViewModel() { } - + protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel) + // the user should not delete this class directly: he should use DecRef() instead! + virtual ~wxDataViewModel() { } }; -// --------------------------------------------------------- +// --------------------------------------------------------- // wxDataViewListModelNotifier -// --------------------------------------------------------- +// --------------------------------------------------------- -class wxDataViewListModelNotifier +class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject { public: wxDataViewListModelNotifier() { } virtual ~wxDataViewListModelNotifier() { } - + virtual bool RowAppended() = 0; virtual bool RowPrepended() = 0; - virtual bool RowInserted( size_t before ) = 0; - virtual bool RowDeleted( size_t row ) = 0; - virtual bool RowChanged( size_t row ) = 0; - virtual bool ValueChanged( size_t col, size_t row ) = 0; + virtual bool RowInserted( unsigned int before ) = 0; + virtual bool RowDeleted( unsigned int row ) = 0; + virtual bool RowChanged( unsigned int row ) = 0; + virtual bool ValueChanged( unsigned int col, unsigned int row ) = 0; + virtual bool RowsReordered( unsigned int *new_order ) = 0; virtual bool Cleared() = 0; - virtual bool ValueChanged( wxDataViewColumn *view_column, size_t model_column, size_t row ) = 0; + virtual bool Freed() + { m_owner = NULL; return true; } + + void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; } + wxDataViewListModel *GetOwner() { return m_owner; } + +private: + wxDataViewListModel *m_owner; }; -// --------------------------------------------------------- +// --------------------------------------------------------- // wxDataViewListModel -// --------------------------------------------------------- +// --------------------------------------------------------- -class wxDataViewListModel: public wxDataViewModel +class WXDLLIMPEXP_ADV wxDataViewViewingColumn: public wxObject { +public: + wxDataViewViewingColumn( wxDataViewColumn *view_column, unsigned int model_column ) + { + m_viewColumn = view_column; + m_modelColumn = model_column; + } + + wxDataViewColumn *m_viewColumn; + unsigned int m_modelColumn; +}; + +class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel +{ + friend class WXDLLIMPEXP_ADV wxDataViewCtrl; + friend class WXDLLIMPEXP_ADV wxDataViewCtrlBase; + friend class WXDLLIMPEXP_ADV wxDataViewSortedListModel; + friend class WXDLLIMPEXP_ADV wxDataViewColumnBase; + friend class WXDLLIMPEXP_ADV wxGtkDataViewListModelNotifier; + public: wxDataViewListModel(); - virtual ~wxDataViewListModel(); - virtual size_t GetNumberOfRows() = 0; - virtual size_t GetNumberOfCols() = 0; + virtual unsigned int GetNumberOfRows() = 0; + virtual unsigned int GetNumberOfCols() = 0; + // return type as reported by wxVariant - virtual wxString GetColType( size_t col ) = 0; + virtual wxString GetColType( unsigned int col ) = 0; + // get value into a wxVariant - virtual wxVariant GetValue( size_t col, size_t row ) = 0; + virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0; + // set value, call ValueChanged() afterwards! - virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0; + virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0; // delegated notifiers - bool RowAppended(); - bool RowPrepended(); - bool RowInserted( size_t before ); - bool RowDeleted( size_t row ); - bool RowChanged( size_t row ); - bool ValueChanged( size_t col, size_t row ); - bool Cleared(); - - // Used internally - void AddViewingColumn( wxDataViewColumn *view_column, size_t model_column ); - void RemoveViewingColumn( wxDataViewColumn *column ); - - // Used internally - void SetNotifier( wxDataViewListModelNotifier *notifier ); - wxDataViewListModelNotifier* GetNotifier(); - -private: - wxDataViewListModelNotifier *m_notifier; - wxList m_viewingColumns; + virtual bool RowAppended(); + virtual bool RowPrepended(); + virtual bool RowInserted( unsigned int before ); + virtual bool RowDeleted( unsigned int row ); + virtual bool RowChanged( unsigned int row ); + virtual bool ValueChanged( unsigned int col, unsigned int row ); + virtual bool RowsReordered( unsigned int *new_order ); + virtual bool Cleared(); protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel) + // the user should not delete this class directly: he should use DecRef() instead! + virtual ~wxDataViewListModel(); + + // Used internally + void AddViewingColumn( wxDataViewColumn *view_column, unsigned int model_column ); + void RemoveViewingColumn( wxDataViewColumn *column ); + + void AddNotifier( wxDataViewListModelNotifier *notifier ); + void RemoveNotifier( wxDataViewListModelNotifier *notifier ); + + wxList m_notifiers; + wxList m_viewingColumns; }; -// --------------------------------------------------------- -// wxDataViewCellBase -// --------------------------------------------------------- + + +// --------------------------------------------------------- +// wxDataViewSortedListModel +// --------------------------------------------------------- + +typedef int (wxCALLBACK *wxDataViewListModelCompare) + (unsigned int row1, unsigned int row2, unsigned int col, wxDataViewListModel* model ); + +WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(unsigned int, wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV); + +class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel +{ + friend class wxDataViewSortedListModelNotifier; + +public: + wxDataViewSortedListModel( wxDataViewListModel *child ); + virtual ~wxDataViewSortedListModel(); + + void SetAscending( bool ascending ) { m_ascending = ascending; } + bool GetAscending() { return m_ascending; } + + virtual unsigned int GetNumberOfRows(); + virtual unsigned int GetNumberOfCols(); + // return type as reported by wxVariant + virtual wxString GetColType( unsigned int col ); + // get value into a wxVariant + virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ); + // set value, call ValueChanged() afterwards! + virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ); + + // called from user + virtual bool RowAppended(); + virtual bool RowPrepended(); + virtual bool RowInserted( unsigned int before ); + virtual bool RowDeleted( unsigned int row ); + virtual bool RowChanged( unsigned int row ); + virtual bool ValueChanged( unsigned int col, unsigned int row ); + virtual bool RowsReordered( unsigned int *new_order ); + virtual bool Cleared(); + + // called if child's notifiers are called + bool ChildRowAppended(); + bool ChildRowPrepended(); + bool ChildRowInserted( unsigned int before ); + bool ChildRowDeleted( unsigned int row ); + bool ChildRowChanged( unsigned int row ); + bool ChildValueChanged( unsigned int col, unsigned int row ); + bool ChildRowsReordered( unsigned int *new_order ); + bool ChildCleared(); + + virtual void Resort(); + +private: + bool m_ascending; + wxDataViewListModel *m_child; + wxDataViewSortedIndexArray m_array; + wxDataViewListModelNotifier *m_notifierOnChild; + + void InitStatics(); // BAD +}; + +// --------------------------------------------------------- +// wxDataViewRendererBase +// --------------------------------------------------------- enum wxDataViewCellMode { @@ -132,32 +242,33 @@ enum wxDataViewCellRenderState wxDATAVIEW_CELL_FOCUSED = 8 }; -class wxDataViewCellBase: public wxObject +class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject { public: - wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + wxDataViewRendererBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT ); + + virtual bool SetValue( const wxVariant& WXUNUSED(value) ) { return true; } + virtual bool GetValue( wxVariant& WXUNUSED(value) ) { return true; } + virtual bool Validate( wxVariant& WXUNUSED(value) ) { return true; } + + wxString GetVariantType() { return m_variantType; } + wxDataViewCellMode GetMode() { return m_mode; } - virtual bool SetValue( const wxVariant &value ) { return true; } - virtual bool GetValue( wxVariant &value ) { return true; } - virtual bool Validate( wxVariant &value ) { return true; } - - wxString GetVariantType() { return m_variantType; } - void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; } wxDataViewColumn* GetOwner() { return m_owner; } - + protected: wxDataViewCellMode m_mode; wxString m_variantType; wxDataViewColumn *m_owner; protected: - DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase) }; -// --------------------------------------------------------- +// --------------------------------------------------------- // wxDataViewColumnBase -// --------------------------------------------------------- +// --------------------------------------------------------- enum wxDataViewColumnFlags { @@ -166,57 +277,134 @@ enum wxDataViewColumnFlags wxDATAVIEW_COL_HIDDEN = 4 }; -class wxDataViewColumnBase: public wxObject +class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject { public: - wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 ); - ~wxDataViewColumnBase(); + wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer, + unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer, + unsigned int model_column, int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + virtual ~wxDataViewColumnBase(); virtual void SetTitle( const wxString &title ); virtual wxString GetTitle(); + + virtual void SetBitmap( const wxBitmap &bitmap ); + virtual const wxBitmap &GetBitmap(); - wxDataViewCell* GetCell() { return m_cell; } - - size_t GetModelColumn() { return m_model_column; } + virtual void SetAlignment( wxAlignment align ) = 0; - void SetOwner( wxDataViewCtrl *owner ) { m_owner = owner; } + virtual void SetSortable( bool sortable ) = 0; + 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 void SetSortOrder( bool ascending ) = 0; + virtual bool IsSortOrderAscending() const = 0; + + wxDataViewRenderer* GetRenderer() { return m_renderer; } + + unsigned int GetModelColumn() { return m_model_column; } + + virtual void SetOwner( wxDataViewCtrl *owner ) { m_owner = owner; } wxDataViewCtrl *GetOwner() { return m_owner; } + virtual int GetWidth() const = 0; + private: wxDataViewCtrl *m_ctrl; - wxDataViewCell *m_cell; + wxDataViewRenderer *m_renderer; int m_model_column; int m_flags; wxString m_title; + wxBitmap m_bitmap; wxDataViewCtrl *m_owner; protected: DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase) }; -// --------------------------------------------------------- +// --------------------------------------------------------- // wxDataViewCtrlBase -// --------------------------------------------------------- +// --------------------------------------------------------- + +#define wxDV_SINGLE 0x0000 // for convenience +#define wxDV_MULTIPLE 0x0020 // can select multiple items -class wxDataViewCtrlBase: public wxControl +class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl { public: wxDataViewCtrlBase(); - ~wxDataViewCtrlBase(); - + virtual ~wxDataViewCtrlBase(); + virtual bool AssociateModel( wxDataViewListModel *model ); wxDataViewListModel* GetModel(); + + // short cuts + bool AppendTextColumn( const wxString &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendToggleColumn( const wxString &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendProgressColumn( const wxString &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendDateColumn( const wxString &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendBitmapColumn( const wxString &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendTextColumn( const wxBitmap &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendToggleColumn( const wxBitmap &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_TOGGLE_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendProgressColumn( const wxBitmap &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = wxDVC_DEFAULT_WIDTH, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendDateColumn( const wxBitmap &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); + bool AppendBitmapColumn( const wxBitmap &label, unsigned int model_column, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1, + wxAlignment align = wxALIGN_CENTER, + int flags = wxDATAVIEW_COL_RESIZABLE ); - virtual bool AppendTextColumn( const wxString &label, size_t model_column ); - virtual bool AppendToggleColumn( const wxString &label, size_t model_column ); - virtual bool AppendProgressColumn( const wxString &label, size_t model_column ); - virtual bool AppendDateColumn( const wxString &label, size_t model_column ); - virtual bool AppendColumn( wxDataViewColumn *col ); - virtual size_t GetNumberOfColumns(); - virtual bool DeleteColumn( size_t pos ); + virtual bool AppendColumn( wxDataViewColumn *col ); + virtual unsigned int GetNumberOfColumns(); + virtual bool DeleteColumn( unsigned int pos ); virtual bool ClearColumns(); - virtual wxDataViewColumn* GetColumn( size_t pos ); + virtual wxDataViewColumn* GetColumn( unsigned int pos ); + + virtual void SetSelection( int row ) = 0; // -1 for unselect + inline void ClearSelection() { SetSelection( -1 ); } + virtual void Unselect( unsigned int row ) = 0; + virtual void SetSelectionRange( unsigned int from, unsigned int to ) = 0; + virtual void SetSelections( const wxArrayInt& aSelections) = 0; + virtual bool IsSelected( unsigned int row ) const = 0; + virtual int GetSelection() const = 0; + virtual int GetSelections(wxArrayInt& aSelections) const = 0; + private: wxDataViewListModel *m_model; wxList m_cols; @@ -225,10 +413,93 @@ protected: DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase) }; -#if defined(__WXGTK20__) + +// ---------------------------------------------------------------------------- +// wxDataViewEvent - the event class for the wxDataViewCtrl notifications +// ---------------------------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent +{ +public: + wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) + : wxNotifyEvent(commandType, winid), + m_col(-1), + m_row(-1), + m_model(NULL), + m_value(wxNullVariant), + m_editCancelled(false), + m_column(NULL) + { } + + wxDataViewEvent(const wxDataViewEvent& event) + : wxNotifyEvent(event), + m_col(event.m_col), + m_row(event.m_col), + m_model(event.m_model), + m_value(event.m_value), + m_editCancelled(event.m_editCancelled), + m_column(event.m_column) + { } + + int GetColumn() const { return m_col; } + void SetColumn( int col ) { m_col = col; } + int GetRow() const { return m_row; } + void SetRow( int row ) { m_row = row; } + wxDataViewModel* GetModel() const { return m_model; } + void SetModel( wxDataViewModel *model ) { m_model = model; } + const wxVariant &GetValue() const { return m_value; } + void SetValue( const wxVariant &value ) { m_value = value; } + + // for wxEVT_DATAVIEW_COLUMN_HEADER_CLICKED only + void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; } + wxDataViewColumn *GetDataViewColumn() { return m_column; } + + // was label editing canceled? (for wxEVT_COMMAND_DATVIEW_END_LABEL_EDIT only) + bool IsEditCancelled() const { return m_editCancelled; } + void SetEditCanceled(bool editCancelled) { m_editCancelled = editCancelled; } + + virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); } + +protected: + int m_col; + int m_row; + wxDataViewModel *m_model; + wxVariant m_value; + bool m_editCancelled; + wxDataViewColumn *m_column; + +private: + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent) +}; + +BEGIN_DECLARE_EVENT_TYPES() + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ROW_SELECTED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ROW_ACTIVATED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_RIGHT_CLICK, -1) +END_DECLARE_EVENT_TYPES() + +typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&); + +#define wxDataViewEventHandler(func) \ + (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxDataViewEventFunction, &func) + +#define wx__DECLARE_DATAVIEWEVT(evt, id, fn) \ + wx__DECLARE_EVT1(wxEVT_COMMAND_DATAVIEW_ ## evt, id, wxDataViewEventHandler(fn)) + +#define EVT_DATAVIEW_ROW_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ROW_SELECTED, id, fn) +#define EVT_DATAVIEW_ROW_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ROW_ACTIVATED, id, fn) +#define EVT_DATAVIEW_COLUMN_HEADER_CLICK(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_CLICK, id, fn) +#define EVT_DATAVIEW_COLUMN_HEADER_RIGHT_CLICKED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_HEADER_RIGHT_CLICK, id, fn) + + +#if defined(wxUSE_GENERICDATAVIEWCTRL) + #include "wx/generic/dataview.h" +#elif defined(__WXGTK20__) #include "wx/gtk/dataview.h" #elif defined(__WXMAC__) - #include "wx/mac/dataview.h" + // TODO + // #include "wx/mac/dataview.h" #else #include "wx/generic/dataview.h" #endif