Escape underscores

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

diff --git a/include/wx/dataview.h b/include/wx/dataview.h
index 47c7b9ad1062cd38b499626c9a49c5ddff1e8c51..f9ef2529fd892a83d7b944f75082c3bc1a734b9b 100644 (file)
--- a/include/wx/dataview.h
+++ b/include/wx/dataview.h
@@ -21,58 +21,91 @@
 #include "wx/bitmap.h"
 #include "wx/variant.h"
 
 #include "wx/bitmap.h"
 #include "wx/variant.h"
 

+
+#if defined(__WXGTK20__)
+    // for testing
+    #define wxUSE_GENERICDATAVIEWCTRL 1
+#elif defined(__WXMAC__)
+    #define wxUSE_GENERICDATAVIEWCTRL 1
+#else
+    #define wxUSE_GENERICDATAVIEWCTRL 1
+#endif
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxDataViewCtrl flags 
+// wxDataViewCtrl flags

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxDataViewCtrl globals
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxDataViewCtrl globals
 // ----------------------------------------------------------------------------
 

-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 wxDataViewCell;

 
 

-extern WXDLLEXPORT_DATA(const wxChar) wxDataViewCtrlNameStr[];
+extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];

 
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewModel
 // wxDataViewModel

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 

-class wxDataViewModel: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewModel: public wxObject

 {
 public:
     wxDataViewModel() { }
     virtual ~wxDataViewModel() { }
 {
 public:
     wxDataViewModel() { }
     virtual ~wxDataViewModel() { }

-    
+

 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
 };
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewListModelNotifier
 // wxDataViewListModelNotifier

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 

-class wxDataViewListModelNotifier
+
+class WXDLLIMPEXP_ADV wxDataViewListModelNotifier: public wxObject

 {
 public:
     wxDataViewListModelNotifier() { }
     virtual ~wxDataViewListModelNotifier() { }
 {
 public:
     wxDataViewListModelNotifier() { }
     virtual ~wxDataViewListModelNotifier() { }

-    
+

     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 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 row, size_t col ) = 0;
+    virtual bool ValueChanged( size_t col, size_t row ) = 0;
+    virtual bool RowsReordered( size_t *new_order ) = 0;

     virtual bool Cleared() = 0;
     virtual bool Cleared() = 0;

+
+    void SetOwner( wxDataViewListModel *owner ) { m_owner = owner; }
+    wxDataViewListModel *GetOwner()             { return m_owner; }
+
+private:
+    wxDataViewListModel *m_owner;

 };
 
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewListModel
 // wxDataViewListModel

-// --------------------------------------------------------- 
+// ---------------------------------------------------------
+
+class WXDLLIMPEXP_ADV wxDataViewViewingColumn: public wxObject
+{
+public:
+    wxDataViewViewingColumn( wxDataViewColumn *view_column, size_t model_column )
+    {
+        m_viewColumn = view_column;
+        m_modelColumn = model_column;
+    }
+
+    wxDataViewColumn   *m_viewColumn;
+    size_t              m_modelColumn;
+};

 
 

-class wxDataViewListModel: public wxDataViewModel
+class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel

 {
 public:
     wxDataViewListModel();
 {
 public:
     wxDataViewListModel();


@@ -83,32 +116,84 @@ public:
     // return type as reported by wxVariant
     virtual wxString GetColType( size_t col ) = 0;
     // get value into a wxVariant
     // return type as reported by wxVariant
     virtual wxString GetColType( size_t col ) = 0;
     // get value into a wxVariant

-    virtual wxVariant GetValue( size_t col, size_t row ) = 0;
+    virtual void GetValue( wxVariant &variant, size_t col, size_t row ) = 0;

     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0;
 
     // delegated notifiers
     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0;
 
     // delegated notifiers

-    bool RowAppended();
-    bool RowPrepended();
-    bool RowInserted( size_t before );
-    bool RowDeleted( size_t row );
-    bool RowChanged( size_t row );
-    bool ValueChanged( size_t col, size_t row );
-    bool Cleared();
-    
-    void SetNotifier( wxDataViewListModelNotifier *notifier );
-    wxDataViewListModelNotifier* GetNotifier();
-    
-private:
-    wxDataViewListModelNotifier *m_notifier;
+    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 Cleared();
+
+    // Used internally
+    virtual void AddViewingColumn( wxDataViewColumn *view_column, size_t model_column );
+    virtual void RemoveViewingColumn( wxDataViewColumn *column );
+
+    virtual void AddNotifier( wxDataViewListModelNotifier *notifier );
+    virtual void RemoveNotifier( wxDataViewListModelNotifier *notifier );
+
+    wxList                      m_notifiers;
+    wxList                      m_viewingColumns;

 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
 };
 
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------
+// wxDataViewSortedListModel
+// ---------------------------------------------------------
+
+typedef int (wxCALLBACK *wxDataViewListModelCompare)
+    (size_t row1, size_t row2, size_t col, wxDataViewListModel* model );
+
+WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_SIZE_T(size_t, wxDataViewSortedIndexArray, WXDLLIMPEXP_ADV);
+
+class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel
+{
+public:
+    wxDataViewSortedListModel( wxDataViewListModel *child );
+    virtual ~wxDataViewSortedListModel();
+
+    virtual size_t GetNumberOfRows();
+    virtual size_t GetNumberOfCols();
+    // return type as reported by wxVariant
+    virtual wxString GetColType( size_t col );
+    // get value into a wxVariant
+    virtual void GetValue( wxVariant &variant, size_t col, size_t row );
+    // set value, call ValueChanged() afterwards!
+    virtual bool SetValue( wxVariant &variant, size_t col, size_t row );
+
+    // 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 Cleared();
+
+    bool ChildValueChanged( size_t col, size_t row );
+
+    virtual void Resort();
+
+private:
+    wxDataViewListModel             *m_child;
+    wxDataViewSortedIndexArray       m_array;
+    wxDataViewListModelNotifier     *m_notifierOnChild;
+
+protected:
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewSortedListModel)
+};
+
+// ---------------------------------------------------------

 // wxDataViewCellBase
 // wxDataViewCellBase

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 enum wxDataViewCellMode
 {
 
 enum wxDataViewCellMode
 {


@@ -125,22 +210,21 @@ enum wxDataViewCellRenderState
     wxDATAVIEW_CELL_FOCUSED     = 8
 };
 
     wxDATAVIEW_CELL_FOCUSED     = 8
 };
 

-class wxDataViewCellBase: public wxObject
+class WXDLLIMPEXP_ADV wxDataViewCellBase: public wxObject

 {
 public:
     wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 
 {
 public:
     wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
 

-    virtual bool SetValue( const wxVariant &value ) { return true; }
-    virtual bool GetValue( wxVariant &value )       { return true; }
-    virtual bool Validate( wxVariant &value )       { return true; }
-    virtual bool BeginEdit()    { return true; }
-    virtual bool EndEdit()      { return true; }
-    
-    wxString GetVariantType()   { return m_variantType; }
-    
+    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; }
+
+    wxString GetVariantType()       { return m_variantType; }
+    wxDataViewCellMode GetMode()    { return m_mode; }
+

     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
     wxDataViewColumn* GetOwner()                { return m_owner; }
     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
     wxDataViewColumn* GetOwner()                { return m_owner; }

-    
+

 protected:
     wxDataViewCellMode      m_mode;
     wxString                m_variantType;
 protected:
     wxDataViewCellMode      m_mode;
     wxString                m_variantType;


@@ -150,9 +234,9 @@ protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewColumnBase
 // wxDataViewColumnBase

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 
 enum wxDataViewColumnFlags
 {
 
 enum wxDataViewColumnFlags
 {


@@ -161,22 +245,35 @@ enum wxDataViewColumnFlags
     wxDATAVIEW_COL_HIDDEN     = 4
 };
 
     wxDATAVIEW_COL_HIDDEN     = 4
 };
 

-class wxDataViewColumnBase: public wxObject
+enum wxDataViewColumnSizing
+{
+    wxDATAVIEW_COL_WIDTH_FIXED,
+    wxDATAVIEW_COL_WIDTH_AUTO,
+    wxDATAVIEW_COL_WIDTH_GROW
+};
+
+class WXDLLIMPEXP_ADV wxDataViewColumnBase: public wxObject

 {
 public:
 {
 public:

-    wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
+    wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column,
+        int fixed_width = 80, wxDataViewColumnSizing sizing = wxDATAVIEW_COL_WIDTH_FIXED, int flags = 0 );

     ~wxDataViewColumnBase();
 
     virtual void SetTitle( const wxString &title );
     virtual wxString GetTitle();
     ~wxDataViewColumnBase();
 
     virtual void SetTitle( const wxString &title );
     virtual wxString GetTitle();

-    
+

     wxDataViewCell* GetCell()               { return m_cell; }
     wxDataViewCell* GetCell()               { return m_cell; }

-    
+

     size_t GetModelColumn()                 { return m_model_column; }
     size_t GetModelColumn()                 { return m_model_column; }

-    
+

     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
     wxDataViewCtrl *GetOwner()              { return m_owner; }
 
     void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
     wxDataViewCtrl *GetOwner()              { return m_owner; }
 

+    virtual int GetWidth() = 0;
+
+    virtual void SetFixedWidth( int width ) = 0;
+    virtual int GetFixedWidth() = 0;
+

 private:
     wxDataViewCtrl          *m_ctrl;
     wxDataViewCell          *m_cell;
 private:
     wxDataViewCtrl          *m_ctrl;
     wxDataViewCell          *m_cell;


@@ -189,28 +286,32 @@ protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
 };
 

-// --------------------------------------------------------- 
+// ---------------------------------------------------------

 // wxDataViewCtrlBase
 // wxDataViewCtrlBase

-// --------------------------------------------------------- 
+// ---------------------------------------------------------
+
+#define wxDV_SINGLE                  0x0000     // for convenience
+#define wxDV_MULTIPLE                0x0020     // can select multiple items

 
 

-class wxDataViewCtrlBase: public wxControl
+class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl

 {
 public:
     wxDataViewCtrlBase();
     ~wxDataViewCtrlBase();
 {
 public:
     wxDataViewCtrlBase();
     ~wxDataViewCtrlBase();

-    
+

     virtual bool AssociateModel( wxDataViewListModel *model );
     wxDataViewListModel* GetModel();
     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 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 AppendColumn( wxDataViewColumn *col );    
+    virtual bool AppendDateColumn( const wxString &label, size_t model_column );
+    virtual bool AppendColumn( wxDataViewColumn *col );

     virtual size_t GetNumberOfColumns();
     virtual bool DeleteColumn( size_t pos );
     virtual bool ClearColumns();
     virtual wxDataViewColumn* GetColumn( size_t pos );
     virtual size_t GetNumberOfColumns();
     virtual bool DeleteColumn( size_t pos );
     virtual bool ClearColumns();
     virtual wxDataViewColumn* GetColumn( size_t pos );

-    
+

 private:
     wxDataViewListModel    *m_model;
     wxList                  m_cols;
 private:
     wxDataViewListModel    *m_model;
     wxList                  m_cols;


@@ -219,10 +320,13 @@ protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
 };
 

-#if defined(__WXGTK20__)
+#if defined(wxUSE_GENERICDATAVIEWCTRL)
+    #include "wx/generic/dataview.h"
+#elif defined(__WXGTK20__)

     #include "wx/gtk/dataview.h"
 #elif defined(__WXMAC__)
     #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
 #else
     #include "wx/generic/dataview.h"
 #endif