]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dataview.h
renamed IsRefTo() to IsSameAs() (do complain if this is not more clear) and
[wxWidgets.git] / include / wx / dataview.h
index 8da38efc0ae6c0ccebcbdebb0dca578539d9ee1f..227408847f9560daad20fb15b85796af2aa6d2a4 100644 (file)
@@ -24,7 +24,7 @@
 
 #if defined(__WXGTK20__)
     // for testing
-    #define wxUSE_GENERICDATAVIEWCTRL 1
+    // #define wxUSE_GENERICDATAVIEWCTRL 1
 #elif defined(__WXMAC__)
     #define wxUSE_GENERICDATAVIEWCTRL 1
 #else
 // wxDataViewCtrl globals
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_CORE wxDataViewModel;
-class WXDLLIMPEXP_CORE wxDataViewListModel;
-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[];
 
 // ---------------------------------------------------------
 // wxDataViewModel
 // ---------------------------------------------------------
 
-class wxDataViewModel: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewModel: public wxObject
 {
 public:
     wxDataViewModel() { }
@@ -66,7 +66,7 @@ protected:
 // ---------------------------------------------------------
 
 
-class wxDataViewListModelNotifier: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject
 {
 public:
     wxDataViewListModelNotifier() { }
@@ -74,11 +74,11 @@ public:
 
     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 RowsReordered( size_t *new_order ) = 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;
 
     void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; }
@@ -92,50 +92,50 @@ private:
 // wxDataViewListModel
 // ---------------------------------------------------------
 
-class wxDataViewViewingColumn: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewViewingColumn: public wxObject
 {
 public:
-    wxDataViewViewingColumn( wxDataViewColumn *view_column, size_t model_column )
+    wxDataViewViewingColumn( wxDataViewColumn *view_column, unsigned int model_column )
     {
         m_viewColumn = view_column;
         m_modelColumn = model_column;
     }
 
     wxDataViewColumn   *m_viewColumn;
-    size_t              m_modelColumn;
+    unsigned int        m_modelColumn;
 };
 
-class wxDataViewListModel: public wxDataViewModel
+class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel
 {
 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 void GetValue( wxVariant &variant, 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
     virtual bool RowAppended();
     virtual bool RowPrepended();
-    virtual bool RowInserted( size_t before );
-    virtual bool RowDeleted( size_t row );
-    virtual bool RowChanged( size_t row );
-    virtual bool ValueChanged( size_t col, size_t row );
-    virtual bool RowsReordered( size_t *new_order );
+    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();
 
     // Used internally
-    virtual void AddViewingColumn( wxDataViewColumn *view_column, size_t model_column );
-    virtual void RemoveViewingColumn( wxDataViewColumn *column );
+    void AddViewingColumn( wxDataViewColumn *view_column, unsigned int model_column );
+    void RemoveViewingColumn( wxDataViewColumn *column );
 
-    virtual void AddNotifier( wxDataViewListModelNotifier *notifier );
-    virtual void RemoveNotifier( wxDataViewListModelNotifier *notifier );
+    void AddNotifier( wxDataViewListModelNotifier *notifier );
+    void RemoveNotifier( wxDataViewListModelNotifier *notifier );
 
     wxList                      m_notifiers;
     wxList                      m_viewingColumns;
@@ -149,50 +149,64 @@ protected:
 // ---------------------------------------------------------
 
 typedef int (wxCALLBACK *wxDataViewListModelCompare)
-    (size_t row1, size_t row2, size_t col, wxDataViewListModel* model );
+    (unsigned int row1, unsigned int row2, unsigned int col, wxDataViewListModel* model );
 
-WX_DEFINE_SORTED_EXPORTED_ARRAY_SIZE_T(size_t, wxDataViewSortedIndexArray );
+WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(unsigned int, wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV);
 
-class wxDataViewSortedListModel: public wxDataViewListModel
+class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel
 {
 public:
     wxDataViewSortedListModel( wxDataViewListModel *child );
     virtual ~wxDataViewSortedListModel();
 
-    virtual size_t GetNumberOfRows();
-    virtual size_t GetNumberOfCols();
+    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( size_t col );
+    virtual wxString GetColType( unsigned int col );
     // get value into a wxVariant
-    virtual void GetValue( wxVariant &variant, size_t col, size_t row );
+    virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row );
     // set value, call ValueChanged() afterwards!
-    virtual bool SetValue( wxVariant &variant, size_t col, size_t row );
+    virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row );
 
-    // delegated notifiers
+    // called from user
     virtual bool RowAppended();
     virtual bool RowPrepended();
-    virtual bool RowInserted( size_t before );
-    virtual bool RowDeleted( size_t row );
-    virtual bool RowChanged( size_t row );
-    virtual bool ValueChanged( size_t col, size_t row );
-    virtual bool RowsReordered( size_t *new_order );
+    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();
 
-    bool ChildValueChanged( size_t col, size_t row );
+    // 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
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewSortedListModel)
 };
 
 // ---------------------------------------------------------
-// wxDataViewCellBase
+// wxDataViewRendererBase
 // ---------------------------------------------------------
 
 enum wxDataViewCellMode
@@ -210,10 +224,10 @@ 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; }
@@ -231,7 +245,7 @@ protected:
     wxDataViewColumn       *m_owner;
 
 protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 };
 
 // ---------------------------------------------------------
@@ -245,28 +259,44 @@ 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 = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
+    wxDataViewColumnBase( const wxBitmap &bitmap, wxDataViewRenderer *renderer, unsigned int model_column,
+        int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
+    virtual ~wxDataViewColumnBase();
 
     virtual void SetTitle( const wxString &title );
     virtual wxString GetTitle();
 
-    wxDataViewCell* GetCell()               { return m_cell; }
+    virtual void SetBitmap( const wxBitmap &bitmap );
+    virtual const wxBitmap &GetBitmap();
+    
+    virtual void SetAlignment( wxAlignment align ) = 0;
+    
+    virtual void SetSortable( bool sortable ) = 0;
+    virtual bool GetSortable() = 0;
+    virtual void SetSortOrder( bool ascending ) = 0;
+    virtual bool IsSortOrderAscending() = 0;
 
-    size_t GetModelColumn()                 { return m_model_column; }
+    wxDataViewRenderer* GetRenderer()       { return m_renderer; }
+
+    unsigned int GetModelColumn()           { return m_model_column; }
 
     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
     wxDataViewCtrl *GetOwner()              { return m_owner; }
 
+    virtual int GetWidth() = 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:
@@ -277,24 +307,55 @@ protected:
 // wxDataViewCtrlBase
 // ---------------------------------------------------------
 
-class wxDataViewCtrlBase: public wxControl
+#define wxDV_SINGLE                  0x0000     // for convenience
+#define wxDV_MULTIPLE                0x0020     // can select multiple items
+
+class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 {
 public:
     wxDataViewCtrlBase();
-    ~wxDataViewCtrlBase();
+    virtual ~wxDataViewCtrlBase();
 
     virtual bool AssociateModel( wxDataViewListModel *model );
     wxDataViewListModel* GetModel();
 
-    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 );
+    // short cuts
+    bool AppendTextColumn( const wxString &label, unsigned int model_column, 
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1 );
+    bool AppendToggleColumn( const wxString &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = 30 );
+    bool AppendProgressColumn( const wxString &label, unsigned int model_column, 
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = 80 );
+    bool AppendDateColumn( const wxString &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1 );
+    bool AppendBitmapColumn( const wxString &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1 );
+    bool AppendTextColumn( const wxBitmap &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1 );
+    bool AppendToggleColumn( const wxBitmap &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = 30 );
+    bool AppendProgressColumn( const wxBitmap &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = 80 );
+    bool AppendDateColumn( const wxBitmap &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE, int width = -1 );
+    bool AppendBitmapColumn( const wxBitmap &label, unsigned int model_column,
+                    wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT, int width = -1 );
+    
     virtual bool AppendColumn( wxDataViewColumn *col );
-    virtual size_t GetNumberOfColumns();
-    virtual bool DeleteColumn( size_t pos );
+    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;
@@ -304,12 +365,93 @@ 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_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