X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/99d471a5db7e75fadd2c855ee02e5b2c38529763..3ac1094bead05e30462122d00e4859725d2ea59f:/include/wx/dataview.h?ds=sidebyside diff --git a/include/wx/dataview.h b/include/wx/dataview.h index 52176d2319..ec832adb83 100644 --- a/include/wx/dataview.h +++ b/include/wx/dataview.h @@ -20,13 +20,12 @@ #include "wx/textctrl.h" #include "wx/bitmap.h" #include "wx/variant.h" - +#include "wx/listctrl.h" #if defined(__WXGTK20__) // for testing // #define wxUSE_GENERICDATAVIEWCTRL 1 #elif defined(__WXMAC__) - #define wxUSE_GENERICDATAVIEWCTRL 1 #else #define wxUSE_GENERICDATAVIEWCTRL 1 #endif @@ -39,11 +38,13 @@ // wxDataViewCtrl globals // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewModel; -class WXDLLIMPEXP_ADV wxDataViewListModel; -class WXDLLIMPEXP_ADV wxDataViewCtrl; -class WXDLLIMPEXP_ADV wxDataViewColumn; -class WXDLLIMPEXP_ADV wxDataViewRenderer; +class WXDLLIMPEXP_FWD_ADV wxDataViewItem; +class WXDLLIMPEXP_FWD_ADV wxDataViewModel; +class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl; +class WXDLLIMPEXP_FWD_ADV wxDataViewColumn; +class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer; +class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier; +class wxDataViewEventModelNotifier; extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[]; @@ -61,176 +62,190 @@ extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[]; // --------------------------------------------------------- -// wxDataViewModel +// wxDataViewItem // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData +class WXDLLIMPEXP_ADV wxDataViewItem { public: - wxDataViewModel() { } - -protected: - // the user should not delete this class directly: he should use DecRef() instead! - virtual ~wxDataViewModel() { } + wxDataViewItem( void* id = NULL ) + { m_id = id; } + wxDataViewItem( const wxDataViewItem &item ) + { m_id = item.m_id; } + bool IsOk() const { return m_id != NULL; } + void* GetID() const { return m_id; } + +private: + void* m_id; }; +bool operator == (const wxDataViewItem &left, const wxDataViewItem &right); + // --------------------------------------------------------- -// wxDataViewListModelNotifier +// wxDataViewModelNotifier // --------------------------------------------------------- -class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject +class WXDLLIMPEXP_ADV wxDataViewModelNotifier { public: - wxDataViewListModelNotifier() { } - virtual ~wxDataViewListModelNotifier() { } - - virtual bool RowAppended() = 0; - virtual bool RowPrepended() = 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; + wxDataViewModelNotifier() { } + virtual ~wxDataViewModelNotifier() { m_owner = NULL; } + + virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0; + virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0; + virtual bool ItemChanged( const wxDataViewItem &item ) = 0; + virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ) = 0; virtual bool Cleared() = 0; - virtual bool Freed() - { m_owner = NULL; return true; } + + virtual void Resort() = 0; - void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; } - wxDataViewListModel *GetOwner() { return m_owner; } + void SetOwner( wxDataViewModel *owner ) { m_owner = owner; } + wxDataViewModel *GetOwner() { return m_owner; } private: - wxDataViewListModel *m_owner; + wxDataViewModel *m_owner; }; + // --------------------------------------------------------- -// wxDataViewListModel +// 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; -}; +WX_DECLARE_LIST(wxDataViewModelNotifier, wxDataViewModelNotifiers ); -class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel +class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData { - 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(); + wxDataViewModel(); - virtual unsigned int GetRowCount() const = 0; virtual unsigned int GetColumnCount() const = 0; // return type as reported by wxVariant virtual wxString GetColumnType( unsigned int col ) const = 0; // get value into a wxVariant - virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) const = 0; + virtual void GetValue( wxVariant &variant, + const wxDataViewItem &item, unsigned int col ) const = 0; // set value, call ValueChanged() afterwards! - virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0; + virtual bool SetValue( const wxVariant &variant, + const wxDataViewItem &item, unsigned int col ) = 0; + + // define hierachy + virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0; + virtual bool IsContainer( const wxDataViewItem &item ) const = 0; + virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const = 0; + virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const = 0; // delegated notifiers - 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 ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ); + virtual bool ItemDeleted( const wxDataViewItem &parent, const wxDataViewItem &item ); + virtual bool ItemChanged( const wxDataViewItem &item ); + virtual bool ValueChanged( const wxDataViewItem &item, unsigned int col ); virtual bool Cleared(); + // delegatd action + virtual void Resort(); + + void AddNotifier( wxDataViewModelNotifier *notifier ); + void RemoveNotifier( wxDataViewModelNotifier *notifier ); + + // default compare function + virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2 ); + + void SetSortingColumn( unsigned int col ) { m_sortingColumn = col; } + unsigned int GetSortingColumn() { return m_sortingColumn; } + void SetSortOrderAscending( bool ascending ) { m_ascending = ascending; } + bool GetSortOrderAscending() { return m_ascending; } + + protected: // 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 ); + virtual ~wxDataViewModel() { } - wxList m_notifiers; - wxList m_viewingColumns; + wxDataViewModelNotifiers m_notifiers; + unsigned int m_sortingColumn; + bool m_ascending; }; - - // --------------------------------------------------------- -// wxDataViewSortedListModel +// wxDataViewIndexListModel // --------------------------------------------------------- -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); +// use hash map later +WX_DEFINE_ARRAY_PTR( void*, wxDataViewItemHash ); -class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel +class wxDataViewIndexListModel: public wxDataViewModel { - friend class wxDataViewSortedListModelNotifier; - public: - wxDataViewSortedListModel( wxDataViewListModel *child ); - virtual ~wxDataViewSortedListModel(); - - void SetAscending( bool ascending ) { m_ascending = ascending; } - bool IsAscending() const { return m_ascending; } - - virtual unsigned int GetRowCount() const; - virtual unsigned int GetColumnCount() const; + wxDataViewIndexListModel( unsigned int initial_size = 0 ); + ~wxDataViewIndexListModel(); + + virtual unsigned int GetRowCount() = 0; + + virtual void GetValue( wxVariant &variant, + unsigned int row, unsigned int col ) const = 0; - // return type as reported by wxVariant - virtual wxString GetColumnType( unsigned int col ) const; + virtual bool SetValue( const wxVariant &variant, + unsigned int row, unsigned int col ) = 0; + + void RowPrepended(); + void RowInserted( unsigned int before ); + void RowAppended(); + void RowDeleted( unsigned int row ); + void RowChanged( unsigned int row ); + void RowValueChanged( unsigned int row, unsigned int col ); + + // convert to/from row/wxDataViewItem + + unsigned int GetRow( const wxDataViewItem &item ) const; + wxDataViewItem GetItem( unsigned int row ) const; + + // compare based on index + + virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2 ); + + // implement base methods + + virtual void GetValue( wxVariant &variant, + const wxDataViewItem &item, unsigned int col ) const; + virtual bool SetValue( const wxVariant &variant, + const wxDataViewItem &item, unsigned int col ); + virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const; + virtual bool IsContainer( const wxDataViewItem &item ) const; + virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const; + virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const; + +private: + wxDataViewItemHash m_hash; + unsigned int m_lastIndex; +}; - // get value into a wxVariant - virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) const; +//----------------------------------------------------------------------------- +// wxDataViewEditorCtrlEvtHandler +//----------------------------------------------------------------------------- - // 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(); +class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler +{ +public: + wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner ); + + void AcceptChangesAndFinish(); + void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; } - // 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(); +protected: + void OnChar( wxKeyEvent &event ); + void OnKillFocus( wxFocusEvent &event ); + void OnIdle( wxIdleEvent &event ); - virtual void Resort(); +private: + wxDataViewRenderer *m_owner; + wxControl *m_editorCtrl; + bool m_finished; + bool m_focusOnIdle; private: - bool m_ascending; - wxDataViewListModel *m_child; - wxDataViewSortedIndexArray m_array; - wxDataViewListModelNotifier *m_notifierOnChild; - - void InitStatics(); // BAD + DECLARE_EVENT_TABLE() }; // --------------------------------------------------------- @@ -281,9 +296,28 @@ public: virtual void SetAlignment( int align ) = 0; virtual int GetAlignment() const = 0; + // in-place editing + virtual bool HasEditorCtrl() + { return false; } + virtual wxControl* CreateEditorCtrl(wxWindow * WXUNUSED(parent), + wxRect WXUNUSED(labelRect), + const wxVariant& WXUNUSED(value)) + { return NULL; } + virtual bool GetValueFromEditorCtrl(wxControl * WXUNUSED(editor), + wxVariant& WXUNUSED(value)) + { return false; } + + virtual bool StartEditing( const wxDataViewItem &item, wxRect labelRect ); + virtual void CancelEditing(); + virtual bool FinishEditing(); + + wxControl *GetEditorCtrl() { return m_editorCtrl; } + protected: wxString m_variantType; wxDataViewColumn *m_owner; + wxControl *m_editorCtrl; + wxDataViewItem m_item; // for m_editorCtrl // internal utility: const wxDataViewCtrl* GetView() const; @@ -381,8 +415,8 @@ public: wxDataViewCtrlBase(); virtual ~wxDataViewCtrlBase(); - virtual bool AssociateModel( wxDataViewListModel *model ); - wxDataViewListModel* GetModel(); + virtual bool AssociateModel( wxDataViewModel *model ); + wxDataViewModel* GetModel(); // short cuts bool AppendTextColumn( const wxString &label, unsigned int model_column, @@ -434,25 +468,34 @@ public: virtual bool ClearColumns(); 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; + void SetExpanderColumn( unsigned int col ) + { m_expander_column = col ; DoSetExpanderColumn(); } + unsigned int GetExpanderColumn() const + { return m_expander_column; } + + void SetIndent( int indent ) + { m_indent = indent ; DoSetIndent(); } + int GetIndent() const + { return m_indent; } + + // TODO selection code + virtual wxDataViewItem GetSelection() = 0; + +protected: + virtual void DoSetExpanderColumn() = 0 ; + virtual void DoSetIndent() = 0; private: - wxDataViewListModel *m_model; + wxDataViewModel *m_model; wxList m_cols; - + wxDataViewEventModelNotifier *m_eventNotifier; + unsigned int m_expander_column; + int m_indent ; + protected: DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase) }; - // ---------------------------------------------------------------------------- // wxDataViewEvent - the event class for the wxDataViewCtrl notifications // ---------------------------------------------------------------------------- @@ -462,30 +505,28 @@ class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent public: wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0) : wxNotifyEvent(commandType, winid), + m_item(0), 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_item(event.m_item), 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) { } + wxDataViewItem GetItem() const { return m_item; } + void SetItem( const wxDataViewItem &item ) { m_item = item; } + 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; } @@ -496,18 +537,13 @@ public: void SetDataViewColumn( wxDataViewColumn *col ) { m_column = col; } wxDataViewColumn *GetDataViewColumn() const { 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: + wxDataViewItem m_item; int m_col; - int m_row; wxDataViewModel *m_model; wxVariant m_value; - bool m_editCancelled; wxDataViewColumn *m_column; private: @@ -515,10 +551,17 @@ private: }; 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_ITEM_SELECTED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_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) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_COLUMN_SORTED, -1) + // notifications from the model to the control + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_ADDED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_DELETED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_ITEM_CHANGED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_VALUE_CHANGED, -1) + DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_MODEL_CLEARED, -1) END_DECLARE_EVENT_TYPES() typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&); @@ -529,10 +572,17 @@ typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&); #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_ITEM_SELECTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_SELECTED, id, fn) +#define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_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) +#define EVT_DATAVIEW_COLUMN_SORTED(id, fn) wx__DECLARE_DATAVIEWEVT(COLUMN_SORTED, id, fn) + +#define EVT_DATAVIEW_MODEL_ITEM_ADDED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_ADDED, id, fn) +#define EVT_DATAVIEW_MODEL_ITEM_DELETED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_DELETED, id, fn) +#define EVT_DATAVIEW_MODEL_ITEM_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_ITEM_CHANGED, id, fn) +#define EVT_DATAVIEW_MODEL_VALUE_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_VALUE_CHANGED, id, fn) +#define EVT_DATAVIEW_MODEL_CLEARED(id, fn) wx__DECLARE_DATAVIEWEVT(MODEL_CLEARED, id, fn) #if defined(wxUSE_GENERICDATAVIEWCTRL) @@ -540,8 +590,7 @@ typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&); #elif defined(__WXGTK20__) #include "wx/gtk/dataview.h" #elif defined(__WXMAC__) - // TODO - // #include "wx/mac/dataview.h" + #include "wx/mac/dataview.h" #else #include "wx/generic/dataview.h" #endif