X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bcd846ea7191d33d86e28ee1927b461c54d2fb8f..6619edf0ea94b6623f1c7e7875d5ca8abac23382:/include/wx/dataview.h diff --git a/include/wx/dataview.h b/include/wx/dataview.h index 6e31a8d8d1..bb0077fefc 100644 --- a/include/wx/dataview.h +++ b/include/wx/dataview.h @@ -16,21 +16,552 @@ #if wxUSE_DATAVIEWCTRL -// ---------------------------------------------------------------------------- -// wxDataViewCtrl flags -// ---------------------------------------------------------------------------- - #include "wx/control.h" #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__) +#else + #define wxUSE_GENERICDATAVIEWCTRL 1 +#endif -extern WXDLLEXPORT_DATA(const wxChar*) wxDataViewCtrlNameStr; +// ---------------------------------------------------------------------------- +// wxDataViewCtrl flags +// ---------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- +// wxDataViewCtrl globals +// ---------------------------------------------------------------------------- +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[]; +// the default width of new (text) columns: +#define wxDVC_DEFAULT_WIDTH 80 -#if defined(__WXGTK20__) +// the default width of new toggle columns: +#define wxDVC_TOGGLE_DEFAULT_WIDTH 30 + +// the default minimal width of the columns: +#define wxDVC_DEFAULT_MINWIDTH 30 + +// the default alignment of wxDataViewRenderers: +#define wxDVR_DEFAULT_ALIGNMENT (wxALIGN_LEFT|wxALIGN_TOP) + + +// --------------------------------------------------------- +// wxDataViewItem +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewItem +{ +public: + 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); + +// --------------------------------------------------------- +// wxDataViewModel +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData +{ +public: + wxDataViewModel(); + + 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, + const wxDataViewItem &item, unsigned int col ) const = 0; + + // set value, call ValueChanged() afterwards! + virtual bool SetValue( const wxVariant &variant, + const wxDataViewItem &item, unsigned int col ) = 0; + + // define hierachy + virtual bool HasChildren( 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 ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ); + virtual bool ItemDeleted( 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 ~wxDataViewModel() { } + + wxList m_notifiers; + unsigned int m_sortingColumn; + bool m_ascending; +}; + +// --------------------------------------------------------- +// wxDataViewVirtualListModel +// --------------------------------------------------------- + +class wxDataViewIndexListModel: public wxDataViewModel +{ +public: + wxDataViewIndexListModel(); + ~wxDataViewIndexListModel(); + + virtual unsigned int GetRowCount() = 0; + + virtual void GetValue( wxVariant &variant, + unsigned int row, unsigned int col ) const = 0; + + virtual bool SetValue( const wxVariant &variant, + unsigned int row, unsigned int col ) = 0; + + void ItemPrepended(); + void ItemInserted( unsigned int before ); + void ItemAppended(); + void ItemChanged( unsigned int row ); + void ValueChanged( unsigned int row, unsigned int col ); + + wxDataViewItem GetItem( unsigned int row ); + + virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2 ); + +}; + +// --------------------------------------------------------- +// wxDataViewModelNotifier +// --------------------------------------------------------- + +class WXDLLIMPEXP_ADV wxDataViewModelNotifier: public wxObject +{ +public: + wxDataViewModelNotifier() { } + virtual ~wxDataViewModelNotifier() { m_owner = NULL; } + + virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item ) = 0; + virtual bool ItemDeleted( 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 void Resort() { }; + + void SetOwner( wxDataViewModel *owner ) { m_owner = owner; } + wxDataViewModel *GetOwner() { return m_owner; } + +private: + wxDataViewModel *m_owner; +}; + + +//----------------------------------------------------------------------------- +// wxDataViewEditorCtrlEvtHandler +//----------------------------------------------------------------------------- + +class wxDataViewEditorCtrlEvtHandler: public wxEvtHandler +{ +public: + wxDataViewEditorCtrlEvtHandler( wxControl *editor, wxDataViewRenderer *owner ); + + void AcceptChangesAndFinish(); + void SetFocusOnIdle( bool focus = true ) { m_focusOnIdle = focus; } + +protected: + void OnChar( wxKeyEvent &event ); + void OnKillFocus( wxFocusEvent &event ); + void OnIdle( wxIdleEvent &event ); + +private: + wxDataViewRenderer *m_owner; + wxControl *m_editorCtrl; + bool m_finished; + bool m_focusOnIdle; + +private: + DECLARE_EVENT_TABLE() +}; + +// --------------------------------------------------------- +// wxDataViewRendererBase +// --------------------------------------------------------- + +enum wxDataViewCellMode +{ + wxDATAVIEW_CELL_INERT, + wxDATAVIEW_CELL_ACTIVATABLE, + wxDATAVIEW_CELL_EDITABLE +}; + +enum wxDataViewCellRenderState +{ + wxDATAVIEW_CELL_SELECTED = 1, + wxDATAVIEW_CELL_PRELIT = 2, + wxDATAVIEW_CELL_INSENSITIVE = 4, + wxDATAVIEW_CELL_FOCUSED = 8 +}; + +class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject +{ +public: + wxDataViewRendererBase( const wxString &varianttype, + wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, + int alignment = wxDVR_DEFAULT_ALIGNMENT ); + + virtual bool Validate( wxVariant& WXUNUSED(value) ) + { return true; } + + void SetOwner( wxDataViewColumn *owner ) { m_owner = owner; } + wxDataViewColumn* GetOwner() { return m_owner; } + + // renderer properties: + + virtual bool SetValue( const wxVariant& WXUNUSED(value) ) = 0; + virtual bool GetValue( wxVariant& WXUNUSED(value) ) const = 0; + + wxString GetVariantType() const { return m_variantType; } + + virtual void SetMode( wxDataViewCellMode mode ) = 0; + virtual wxDataViewCellMode GetMode() const = 0; + + // NOTE: Set/GetAlignment do not take/return a wxAlignment enum but + // rather an "int"; that's because for rendering cells it's allowed + // to combine alignment flags (e.g. wxALIGN_LEFT|wxALIGN_BOTTOM) + 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; + +protected: + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase) +}; + +// --------------------------------------------------------- +// wxDataViewColumnBase +// --------------------------------------------------------- + +enum wxDataViewColumnFlags +{ + wxDATAVIEW_COL_RESIZABLE = 1, + wxDATAVIEW_COL_SORTABLE = 2, + wxDATAVIEW_COL_HIDDEN = 4 +}; + +class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject +{ +public: + 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(); + + // setters: + + virtual void SetTitle( const wxString &title ) = 0; + virtual void SetAlignment( wxAlignment align ) = 0; + virtual void SetSortable( bool sortable ) = 0; + virtual void SetResizeable( bool resizeable ) = 0; + virtual void SetHidden( bool hidden ) = 0; + virtual void SetSortOrder( bool ascending ) = 0; + virtual void SetFlags( int flags ); + virtual void SetOwner( wxDataViewCtrl *owner ) + { m_owner = owner; } + virtual void SetBitmap( const wxBitmap &bitmap ) + { m_bitmap=bitmap; } + + virtual void SetMinWidth( int minWidth ) = 0; + virtual void SetWidth( int width ) = 0; + + + // getters: + + virtual wxString GetTitle() const = 0; + virtual wxAlignment GetAlignment() const = 0; + virtual int GetWidth() const = 0; + virtual int GetMinWidth() const = 0; + + virtual int GetFlags() const; + + virtual bool IsSortable() const = 0; + virtual bool IsResizeable() const = 0; + virtual bool IsHidden() const = 0; + virtual bool IsSortOrderAscending() const = 0; + + const wxBitmap &GetBitmap() const { return m_bitmap; } + unsigned int GetModelColumn() const { return m_model_column; } + + wxDataViewCtrl *GetOwner() { return m_owner; } + wxDataViewRenderer* GetRenderer() { return m_renderer; } + +protected: + wxDataViewRenderer *m_renderer; + int m_model_column; + wxBitmap m_bitmap; + wxDataViewCtrl *m_owner; + +protected: + DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase) +}; + +// --------------------------------------------------------- +// wxDataViewCtrlBase +// --------------------------------------------------------- + +#define wxDV_SINGLE 0x0000 // for convenience +#define wxDV_MULTIPLE 0x0001 // can select multiple items + +#define wxDV_NO_HEADER 0x0002 // column titles not visible +#define wxDV_HORIZ_RULES 0x0004 // light horizontal rules between rows +#define wxDV_VERT_RULES 0x0008 // light vertical rules between columns + +class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl +{ +public: + wxDataViewCtrlBase(); + virtual ~wxDataViewCtrlBase(); + + virtual bool AssociateModel( wxDataViewModel *model ); + wxDataViewModel* 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 AppendColumn( wxDataViewColumn *col ); + + virtual unsigned int GetColumnCount() const; + + virtual bool DeleteColumn( unsigned int pos ); + virtual bool ClearColumns(); + virtual wxDataViewColumn* GetColumn( unsigned int pos ); + + 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: + 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 +// ---------------------------------------------------------------------------- + +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_model(NULL), + m_value(wxNullVariant), + m_column(NULL) + { } + + wxDataViewEvent(const wxDataViewEvent& event) + : wxNotifyEvent(event), + m_item(event.m_item), + m_col(event.m_col), + m_model(event.m_model), + m_value(event.m_value), + 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; } + + 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() const { return m_column; } + + virtual wxEvent *Clone() const { return new wxDataViewEvent(*this); } + +protected: + wxDataViewItem m_item; + int m_col; + wxDataViewModel *m_model; + wxVariant m_value; + wxDataViewColumn *m_column; + +private: + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxDataViewEvent) +}; + +BEGIN_DECLARE_EVENT_TYPES() + 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&); + +#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_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_APPENDED, 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) + #include "wx/generic/dataview.h" +#elif defined(__WXGTK20__) #include "wx/gtk/dataview.h" #elif defined(__WXMAC__) #include "wx/mac/dataview.h"