// Name: wx/dataview.h
// Purpose: wxDataViewCtrl base classes
// Author: Robert Roebling
-// Modified by:
+// Modified by: Bo Yang
// Created: 08.01.06
// RCS-ID: $Id$
// Copyright: (c) Robert Roebling
#include "wx/bitmap.h"
#include "wx/variant.h"
#include "wx/listctrl.h"
+#include "wx/dynarray.h"
+#include "wx/icon.h"
#if defined(__WXGTK20__)
// for testing
class WXDLLIMPEXP_FWD_ADV wxDataViewColumn;
class WXDLLIMPEXP_FWD_ADV wxDataViewRenderer;
class WXDLLIMPEXP_FWD_ADV wxDataViewModelNotifier;
-class wxDataViewEventModelNotifier;
extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
class WXDLLIMPEXP_ADV wxDataViewItem
{
public:
- wxDataViewItem( wxUint32 id = 0 )
- { m_id = id; m_reserved1 = 0; m_reserved2 = NULL; }
+ wxDataViewItem( void* id = NULL )
+ { m_id = id; }
wxDataViewItem( const wxDataViewItem &item )
- { m_id = item.m_id; m_reserved1 = item.m_reserved1; m_reserved2 = item.m_reserved2; }
- bool IsOk() const { return m_id != 0; }
- wxUint32 GetID() const { return m_id; }
+ { m_id = item.m_id; }
+ bool IsOk() const { return m_id != NULL; }
+ void* GetID() const { return m_id; }
+ operator const void* () const { return m_id; }
+private:
+ void* m_id;
+};
+
+bool operator == (const wxDataViewItem &left, const wxDataViewItem &right);
+
+WX_DEFINE_ARRAY(wxDataViewItem, wxDataViewItemArray);
+
+// ---------------------------------------------------------
+// wxDataViewModelNotifier
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewModelNotifier
+{
public:
- wxUint32 m_reserved1;
- void* m_reserved2;
+ 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 void Resort() = 0;
+
+ void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
+ wxDataViewModel *GetOwner() { return m_owner; }
+
private:
- wxUint32 m_id;
+ wxDataViewModel *m_owner;
};
-bool operator == ( const wxDataViewItem& left, const wxDataViewItem& right );
// ---------------------------------------------------------
// wxDataViewModel
// ---------------------------------------------------------
-typedef int (wxCALLBACK *wxDataViewModelCompare)
- (const wxDataViewItem& item1, const wxDataViewItem& item2, unsigned int col, unsigned int option );
+WX_DECLARE_LIST(wxDataViewModelNotifier, wxDataViewModelNotifiers );
class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
{
const wxDataViewItem &item, unsigned int col ) = 0;
// define hierachy
- virtual bool HasChildren( const wxDataViewItem &item ) const = 0;
- virtual int GetChildCount( const wxDataViewItem &item ) const = 0;
- virtual wxDataViewItem GetParent( const wxDataViewItem &child ) const = 0;
- virtual wxDataViewItem GetFirstChild( const wxDataViewItem &parent ) const = 0;
- virtual wxDataViewItem GetNextSibling( const wxDataViewItem &item ) const = 0;
- virtual wxDataViewItem GetNthChild( const wxDataViewItem &parent, unsigned int n ) const = 0;
+ virtual wxDataViewItem GetParent( const wxDataViewItem &item ) const = 0;
+ virtual bool IsContainer( const wxDataViewItem &item ) const = 0;
+ virtual unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const = 0;
// delegated notifiers
virtual bool ItemAdded( const wxDataViewItem &parent, const wxDataViewItem &item );
- virtual bool ItemDeleted( 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 );
- void SetCompareFunction( wxDataViewModelCompare func ) { m_cmpFunc = func; }
- wxDataViewModelCompare GetCompareFunction() { return m_cmpFunc; }
-
+ // default compare function
+ virtual int Compare( const wxDataViewItem &item1, const wxDataViewItem &item2,
+ unsigned int column, bool ascending );
+ virtual bool HasDefaultCompare() const { return false; }
+
protected:
// the user should not delete this class directly: he should use DecRef() instead!
virtual ~wxDataViewModel() { }
- wxList m_notifiers;
- wxDataViewModelCompare m_cmpFunc;
+ wxDataViewModelNotifiers m_notifiers;
};
// ---------------------------------------------------------
-// wxDataViewModelNotifier
+// wxDataViewIndexListModel
// ---------------------------------------------------------
-class WXDLLIMPEXP_ADV wxDataViewModelNotifier: public wxObject
+class wxDataViewIndexListModel: public wxDataViewModel
{
public:
- wxDataViewModelNotifier() { }
- virtual ~wxDataViewModelNotifier() { m_owner = NULL; }
+ 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;
- 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 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,
+ unsigned int column, bool ascending );
+ virtual bool HasDefaultCompare() const { return true; }
- void SetOwner( wxDataViewModel *owner ) { m_owner = owner; }
- wxDataViewModel *GetOwner() { return m_owner; }
+ // 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 unsigned int GetChildren( const wxDataViewItem &item, wxDataViewItemArray &children ) const;
+
private:
- wxDataViewModel *m_owner;
+ wxDataViewItemArray m_hash;
+ unsigned int m_lastIndex;
};
-
//-----------------------------------------------------------------------------
// wxDataViewEditorCtrlEvtHandler
//-----------------------------------------------------------------------------
DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
};
+//-----------------------------------------------------------------------------
+// wxDataViewIconText
+//-----------------------------------------------------------------------------
+
+class wxDataViewIconText: public wxObject
+{
+public:
+ wxDataViewIconText( const wxString &text = wxEmptyString, const wxIcon& icon = wxNullIcon )
+ { m_icon = icon; m_text = text; }
+ wxDataViewIconText( const wxDataViewIconText &other )
+ { m_icon = other.m_icon; m_text = other.m_text; }
+
+ void SetText( const wxString &text ) { m_text = text; }
+ wxString GetText() const { return m_text; }
+ void SetIcon( const wxIcon &icon ) { m_icon = icon; }
+ const wxIcon &GetIcon() const { return m_icon; }
+
+private:
+ wxString m_text;
+ wxIcon m_icon;
+
+private:
+ DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
+};
+
+bool operator == (const wxDataViewIconText &one, const wxDataViewIconText &two);
+
+DECLARE_VARIANT_OBJECT(wxDataViewIconText)
+
// ---------------------------------------------------------
// wxDataViewColumnBase
// ---------------------------------------------------------
virtual bool IsSortOrderAscending() const = 0;
const wxBitmap &GetBitmap() const { return m_bitmap; }
- unsigned int GetModelColumn() const { return m_model_column; }
+ unsigned int GetModelColumn() const { return static_cast<unsigned int>(m_model_column); }
wxDataViewCtrl *GetOwner() { return m_owner; }
wxDataViewRenderer* GetRenderer() { return m_renderer; }
wxDataViewModel* GetModel();
// short cuts
- bool AppendTextColumn( const wxString &label, unsigned int model_column,
+ wxDataViewColumn *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 );
+ wxDataViewColumn *AppendIconTextColumn( 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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *AppendIconTextColumn( const wxBitmap &label, unsigned int model_column,
+ wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1,
+ wxAlignment align = wxALIGN_CENTER,
+ int flags = wxDATAVIEW_COL_RESIZABLE );
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+ wxDataViewColumn *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,
+
+ wxDataViewColumn *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 );
+ virtual unsigned int GetColumnCount() const = 0;
+ virtual wxDataViewColumn* GetColumn( unsigned int pos ) const = 0;
+ virtual int GetColumnPosition( const wxDataViewColumn *column ) const = 0;
+
+ virtual bool DeleteColumn( wxDataViewColumn *column ) = 0;
+ virtual bool ClearColumns() = 0;
+
+ void SetExpanderColumn( wxDataViewColumn *col )
+ { m_expander_column = col ; DoSetExpanderColumn(); }
+ wxDataViewColumn *GetExpanderColumn() const
+ { return m_expander_column; }
+
+ virtual wxDataViewColumn *GetSortingColumn() const = 0;
+
+ void SetIndent( int indent )
+ { m_indent = indent ; DoSetIndent(); }
+ int GetIndent() const
+ { return m_indent; }
+
+ virtual wxDataViewItem GetSelection() const = 0;
+ virtual int GetSelections( wxDataViewItemArray & sel ) const = 0;
+ virtual void SetSelections( const wxDataViewItemArray & sel ) = 0;
+ virtual void Select( const wxDataViewItem & item ) = 0;
+ virtual void Unselect( const wxDataViewItem & item ) = 0;
+ virtual bool IsSelected( const wxDataViewItem & item ) const = 0;
+
+ virtual void SelectAll() = 0;
+ virtual void UnselectAll() = 0;
+
+ virtual void Expand( const wxDataViewItem & item ) = 0;
+ virtual void Collapse( const wxDataViewItem & item ) = 0;
+
+ virtual void EnsureVisible( const wxDataViewItem & item,
+ const wxDataViewColumn *column = NULL ) = 0;
+ virtual void HitTest( const wxPoint & point, wxDataViewItem &item, wxDataViewColumn* &column ) const = 0;
+ virtual wxRect GetItemRect( const wxDataViewItem & item, const wxDataViewColumn *column = NULL ) const = 0;
- // TODO selection code
+protected:
+ virtual void DoSetExpanderColumn() = 0 ;
+ virtual void DoSetIndent() = 0;
private:
wxDataViewModel *m_model;
- wxList m_cols;
- wxDataViewEventModelNotifier *m_eventNotifier;
-
+ wxDataViewColumn *m_expander_column;
+ int m_indent ;
+
protected:
DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
};
};
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_SELECTION_CHANGED, -1)
+
DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_ACTIVATED, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSED, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDED, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_COLLAPSING, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EXPANDING, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_STARTED, -1)
+ DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_ADV, wxEVT_COMMAND_DATAVIEW_ITEM_EDITING_DONE, -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)
#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_SELECTION_CHANGED(id, fn) wx__DECLARE_DATAVIEWEVT(SELECTION_CHANGED, id, fn)
+
#define EVT_DATAVIEW_ITEM_ACTIVATED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_ACTIVATED, id, fn)
+#define EVT_DATAVIEW_ITEM_COLLAPSING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSING, id, fn)
+#define EVT_DATAVIEW_ITEM_COLLAPSED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_COLLAPSED, id, fn)
+#define EVT_DATAVIEW_ITEM_EXPANDING(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDING, id, fn)
+#define EVT_DATAVIEW_ITEM_EXPANDED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EXPANDED, id, fn)
+#define EVT_DATAVIEW_ITEM_EDITING_STARTED(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_STARTED, id, fn)
+#define EVT_DATAVIEW_ITEM_EDITING_DONE(id, fn) wx__DECLARE_DATAVIEWEVT(ITEM_EDITING_DONE, 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_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)
projects / wxWidgets.git / blobdiff