]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/dataview.h
include wx/object.h now that wxConfigBase derives from wxObject
[wxWidgets.git] / include / wx / dataview.h
index 225e52ef6bc8f82b11ca4c2541cc0ca78ea674af..c4953185269b2a08bae8e47ad139b819e69a4c06 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
@@ -47,25 +47,37 @@ class WXDLLIMPEXP_ADV wxDataViewRenderer;
 
 extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
 
+// the default width of new (text) columns:
+#define wxDVC_DEFAULT_WIDTH             80
+
+// 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)
+
+
 // ---------------------------------------------------------
 // wxDataViewModel
 // ---------------------------------------------------------
 
-class WXDLLIMPEXP_ADV wxDataViewModel: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewModel: public wxObjectRefData
 {
 public:
     wxDataViewModel() { }
-    virtual ~wxDataViewModel() { }
 
 protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
+    // the user should not delete this class directly: he should use DecRef() instead!
+    virtual ~wxDataViewModel() { }
 };
 
 // ---------------------------------------------------------
 // wxDataViewListModelNotifier
 // ---------------------------------------------------------
 
-
 class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject
 {
 public:
@@ -80,6 +92,8 @@ public:
     virtual bool ValueChanged( unsigned int col, unsigned int row ) = 0;
     virtual bool RowsReordered( unsigned int *new_order ) = 0;
     virtual bool Cleared() = 0;
+    virtual bool Freed()
+        { m_owner = NULL; return true; }
 
     void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; }
     wxDataViewListModel *GetOwner()             { return m_owner; }
@@ -107,16 +121,24 @@ public:
 
 class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel
 {
+    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();
-    virtual ~wxDataViewListModel();
 
-    virtual unsigned int GetNumberOfRows() = 0;
-    virtual unsigned int GetNumberOfCols() = 0;
+    virtual unsigned int GetRowCount() const = 0;
+    virtual unsigned int GetColumnCount() const = 0;
+
     // return type as reported by wxVariant
-    virtual wxString GetColType( unsigned int col ) = 0;
+    virtual wxString GetColumnType( unsigned int col ) const = 0;
+
     // get value into a wxVariant
-    virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0;
+    virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) const = 0;
+
     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0;
 
@@ -130,20 +152,23 @@ public:
     virtual bool RowsReordered( unsigned int *new_order );
     virtual bool Cleared();
 
+protected:
+    // the user should not delete this class directly: he should use DecRef() instead!
+    virtual ~wxDataViewListModel();
+
     // Used internally
-    virtual void AddViewingColumn( wxDataViewColumn *view_column, unsigned int 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;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
 };
 
+
+
 // ---------------------------------------------------------
 // wxDataViewSortedListModel
 // ---------------------------------------------------------
@@ -151,20 +176,29 @@ protected:
 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);
+WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(unsigned int, 
+                                            wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV);
 
 class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel
 {
+    friend class wxDataViewSortedListModelNotifier;
+
 public:
     wxDataViewSortedListModel( wxDataViewListModel *child );
     virtual ~wxDataViewSortedListModel();
 
-    virtual unsigned int GetNumberOfRows();
-    virtual unsigned int GetNumberOfCols();
+    void SetAscending( bool ascending ) { m_ascending = ascending; }
+    bool IsAscending() const { return m_ascending; }
+
+    virtual unsigned int GetRowCount() const;
+    virtual unsigned int GetColumnCount() const;
+
     // return type as reported by wxVariant
-    virtual wxString GetColType( unsigned int col );
+    virtual wxString GetColumnType( unsigned int col ) const;
+
     // get value into a wxVariant
-    virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row );
+    virtual void GetValue( wxVariant &variant, unsigned int col, unsigned int row ) const;
+
     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row );
 
@@ -191,12 +225,12 @@ public:
     virtual void Resort();
 
 private:
+    bool                             m_ascending;
     wxDataViewListModel             *m_child;
     wxDataViewSortedIndexArray       m_array;
     wxDataViewListModelNotifier     *m_notifierOnChild;
-
-protected:
-    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewSortedListModel)
+    
+    void InitStatics(); // BAD
 };
 
 // ---------------------------------------------------------
@@ -221,23 +255,39 @@ enum wxDataViewCellRenderState
 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 {
 public:
-    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; }
-    virtual bool Validate( wxVariant& WXUNUSED(value) )       { return true; }
+    wxDataViewRendererBase( const wxString &varianttype, 
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int alignment = wxDVR_DEFAULT_ALIGNMENT );
 
-    wxString GetVariantType()       { return m_variantType; }
-    wxDataViewCellMode GetMode()    { return m_mode; }
+    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;
+
 protected:
-    wxDataViewCellMode      m_mode;
     wxString                m_variantType;
     wxDataViewColumn       *m_owner;
 
+    // internal utility:
+    const wxDataViewCtrl* GetView() const;
+
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 };
@@ -256,28 +306,58 @@ enum wxDataViewColumnFlags
 class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject
 {
 public:
-    wxDataViewColumnBase( const wxString &title, wxDataViewRenderer *renderer, unsigned int model_column,
-        int width = 80, int flags = wxDATAVIEW_COL_RESIZABLE );
+    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();
 
-    virtual void SetTitle( const wxString &title );
-    virtual wxString GetTitle();
+    // setters:
 
-    wxDataViewRenderer* GetRenderer()       { return m_renderer; }
+    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; }
 
-    unsigned int GetModelColumn()           { return m_model_column; }
+    virtual void SetMinWidth( int minWidth ) = 0;
+    virtual void SetWidth( int width ) = 0;
 
-    void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
-    wxDataViewCtrl *GetOwner()              { return m_owner; }
 
-    virtual int GetWidth() = 0;
+    // getters:
 
-private:
-    wxDataViewCtrl          *m_ctrl;
+    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;
-    int                      m_flags;
-    wxString                 m_title;
+    wxBitmap                 m_bitmap;
     wxDataViewCtrl          *m_owner;
 
 protected:
@@ -289,7 +369,11 @@ protected:
 // ---------------------------------------------------------
 
 #define wxDV_SINGLE                  0x0000     // for convenience
-#define wxDV_MULTIPLE                0x0020     // can select multiple items
+#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
 {
@@ -300,18 +384,59 @@ public:
     virtual bool AssociateModel( wxDataViewListModel *model );
     wxDataViewListModel* GetModel();
 
-    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 );
+    // 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 GetNumberOfColumns();
+
+    virtual unsigned int GetColumnCount() const;
+
     virtual bool DeleteColumn( unsigned int pos );
     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;
     
@@ -332,7 +457,7 @@ protected:
 // wxDataViewEvent - the event class for the wxDataViewCtrl notifications
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxDataViewEvent : public wxNotifyEvent
+class WXDLLIMPEXP_ADV wxDataViewEvent : public wxNotifyEvent
 {
 public:
     wxDataViewEvent(wxEventType commandType = wxEVT_NULL, int winid = 0)
@@ -341,7 +466,8 @@ public:
         m_row(-1),
         m_model(NULL),
         m_value(wxNullVariant),
-        m_editCancelled(false)
+        m_editCancelled(false),
+        m_column(NULL)
         { }
 
     wxDataViewEvent(const wxDataViewEvent& event)
@@ -350,18 +476,26 @@ public:
         m_row(event.m_col),
         m_model(event.m_model),
         m_value(event.m_value),
-        m_editCancelled(event.m_editCancelled)
+        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() 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; }
@@ -374,13 +508,17 @@ protected:
     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_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&);
@@ -392,6 +530,9 @@ typedef void (wxEvtHandler::*wxDataViewEventFunction)(wxDataViewEvent&);
     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)