Renamed wx.FutureCall to wx.CallLater so it is named more like

[wxWidgets.git] / include / wx / dataview.h

diff --git a/include/wx/dataview.h b/include/wx/dataview.h
index 6d54285c5f76345a4411b294bf17513620d9b5b5..2eb0882ae599a09ce18986388f91be149800d243 100644 (file)
--- a/include/wx/dataview.h
+++ b/include/wx/dataview.h
@@ -43,7 +43,7 @@ class WXDLLIMPEXP_ADV wxDataViewModel;
 class WXDLLIMPEXP_ADV wxDataViewListModel;
 class WXDLLIMPEXP_ADV wxDataViewCtrl;
 class WXDLLIMPEXP_ADV wxDataViewColumn;
-class WXDLLIMPEXP_ADV wxDataViewCell;
+class WXDLLIMPEXP_ADV wxDataViewRenderer;
 
 extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
 
@@ -159,6 +159,9 @@ 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
@@ -191,16 +194,19 @@ public:
     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
@@ -218,10 +224,10 @@ enum wxDataViewCellRenderState
     wxDATAVIEW_CELL_FOCUSED     = 8
 };
 
-class WXDLLIMPEXP_ADV 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; }
@@ -239,7 +245,7 @@ protected:
     wxDataViewColumn       *m_owner;
 
 protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 };
 
 // ---------------------------------------------------------
@@ -256,16 +262,28 @@ enum wxDataViewColumnFlags
 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 {
 public:
-    wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, unsigned int model_column,
+    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;
+
+    wxDataViewRenderer* GetRenderer()       { return m_renderer; }
 
-    unsigned int GetModelColumn()                 { return m_model_column; }
+    unsigned int GetModelColumn()           { return m_model_column; }
 
     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
     wxDataViewCtrl *GetOwner()              { return m_owner; }
@@ -274,10 +292,11 @@ public:
 
 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:
@@ -300,10 +319,18 @@ public:
     virtual bool AssociateModel( wxDataViewListModel *model );
     wxDataViewListModel* GetModel();
 
+    // short cuts
     virtual bool AppendTextColumn( const wxString &label, unsigned int model_column );
     virtual bool AppendToggleColumn( const wxString &label, unsigned int model_column );
     virtual bool AppendProgressColumn( const wxString &label, unsigned int model_column );
     virtual bool AppendDateColumn( const wxString &label, unsigned int model_column );
+    virtual bool AppendBitmapColumn( const wxString &label, unsigned int model_column );
+    virtual bool AppendTextColumn( const wxBitmap &label, unsigned int model_column );
+    virtual bool AppendToggleColumn( const wxBitmap &label, unsigned int model_column );
+    virtual bool AppendProgressColumn( const wxBitmap &label, unsigned int model_column );
+    virtual bool AppendDateColumn( const wxBitmap &label, unsigned int model_column );
+    virtual bool AppendBitmapColumn( const wxBitmap &label, unsigned int model_column );
+    
     virtual bool AppendColumn( wxDataViewColumn *col );
     virtual unsigned int GetNumberOfColumns();
     virtual bool DeleteColumn( unsigned int pos );
@@ -312,6 +339,7 @@ public:
 
     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;
     
@@ -327,6 +355,86 @@ 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_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ROW_SELECTED, -1)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_ROW_ACTIVATED, -1)
+    DECLARE_EVENT_TYPE(wxEVT_COMMAND_DATAVIEW_COLUMN_HEADER_CLICK, -1)
+    DECLARE_EVENT_TYPE(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__)