include wx/object.h now that wxConfigBase derives from wxObject

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

diff --git a/include/wx/dataview.h b/include/wx/dataview.h
index d255228773d82bcf7198645c77487c9d562a4ca1..c4953185269b2a08bae8e47ad139b819e69a4c06 100644 (file)
--- a/include/wx/dataview.h
+++ b/include/wx/dataview.h
@@ -53,6 +53,12 @@ extern WXDLLIMPEXP_DATA_ADV(const wxChar) wxDataViewCtrlNameStr[];
 // the default width of new toggle columns:
 #define wxDVC_TOGGLE_DEFAULT_WIDTH      30
 
 // 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
 
 // ---------------------------------------------------------
 // wxDataViewModel


@@ -124,14 +130,14 @@ class WXDLLIMPEXP_ADV wxDataViewListModel: public wxDataViewModel
 public:
     wxDataViewListModel();
 
 public:
     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
 
     // 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
 
     // 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;
 
     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row ) = 0;


@@ -170,7 +176,8 @@ protected:
 typedef int (wxCALLBACK *wxDataViewListModelCompare)
     (unsigned int row1, unsigned int row2, unsigned int col, wxDataViewListModel* model );
 
 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
 {
 
 class WXDLLIMPEXP_ADV wxDataViewSortedListModel: public wxDataViewListModel
 {


@@ -181,14 +188,17 @@ public:
     virtual ~wxDataViewSortedListModel();
 
     void SetAscending( bool ascending ) { m_ascending = ascending; }
     virtual ~wxDataViewSortedListModel();
 
     void SetAscending( bool ascending ) { m_ascending = ascending; }

-    bool GetAscending() { return m_ascending; }
+    bool IsAscending() const { return m_ascending; }
+
+    virtual unsigned int GetRowCount() const;
+    virtual unsigned int GetColumnCount() const;

 
 

-    virtual unsigned int GetNumberOfRows();
-    virtual unsigned int GetNumberOfCols();

     // return type as reported by wxVariant
     // return type as reported by wxVariant

-    virtual wxString GetColType( unsigned int col );
+    virtual wxString GetColumnType( unsigned int col ) const;
+

     // get value into a wxVariant
     // 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 );
 
     // set value, call ValueChanged() afterwards!
     virtual bool SetValue( wxVariant &variant, unsigned int col, unsigned int row );
 


@@ -245,23 +255,39 @@ enum wxDataViewCellRenderState
 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 {
 public:
 class WXDLLIMPEXP_ADV wxDataViewRendererBase: public wxObject
 {
 public:

-    wxDataViewRendererBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );
+    wxDataViewRendererBase( const wxString &varianttype, 
+                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
+                            int alignment = wxDVR_DEFAULT_ALIGNMENT );

 
 

-    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; }
+    virtual bool Validate( wxVariant& WXUNUSED(value) )
+        { return true; }

 
     void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
     wxDataViewColumn* GetOwner()                { return m_owner; }
 
 
     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:
 protected:

-    wxDataViewCellMode      m_mode;

     wxString                m_variantType;
     wxDataViewColumn       *m_owner;
 
     wxString                m_variantType;
     wxDataViewColumn       *m_owner;
 

+    // internal utility:
+    const wxDataViewCtrl* GetView() const;
+

 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 };
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 };


@@ -290,40 +316,47 @@ public:
                           int flags = wxDATAVIEW_COL_RESIZABLE );
     virtual ~wxDataViewColumnBase();
 
                           int flags = wxDATAVIEW_COL_RESIZABLE );
     virtual ~wxDataViewColumnBase();
 

-    virtual void SetTitle( const wxString &title );
-    virtual wxString GetTitle();
+    // setters:

 
 

-    virtual void SetBitmap( const wxBitmap &bitmap );
-    virtual const wxBitmap &GetBitmap();
-    
+    virtual void SetTitle( const wxString &title ) = 0;

     virtual void SetAlignment( wxAlignment align ) = 0;
     virtual void SetAlignment( wxAlignment align ) = 0;

-    

     virtual void SetSortable( bool sortable ) = 0;
     virtual void SetSortable( bool sortable ) = 0;

-    virtual bool IsSortable() const
-        { return (m_flags & wxDATAVIEW_COL_SORTABLE) != 0; }
-    virtual bool IsResizeable() const
-        { return (m_flags & wxDATAVIEW_COL_RESIZABLE) != 0; }
-    virtual bool IsHidden() const
-        { return (m_flags & wxDATAVIEW_COL_HIDDEN) != 0; }
-
+    virtual void SetResizeable( bool resizeable ) = 0;
+    virtual void SetHidden( bool hidden ) = 0;

     virtual void SetSortOrder( bool ascending ) = 0;
     virtual void SetSortOrder( bool ascending ) = 0;

-    virtual bool IsSortOrderAscending() const = 0;
+    virtual void SetFlags( int flags );
+    virtual void SetOwner( wxDataViewCtrl *owner )  
+        { m_owner = owner; }
+    virtual void SetBitmap( const wxBitmap &bitmap )
+        { m_bitmap=bitmap; }

 
 

-    wxDataViewRenderer* GetRenderer()       { return m_renderer; }
+    virtual void SetMinWidth( int minWidth ) = 0;
+    virtual void SetWidth( int width ) = 0;

 
 

-    unsigned int GetModelColumn()           { return m_model_column; }

 
 

-    virtual void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
-    wxDataViewCtrl *GetOwner()              { return m_owner; }
+    // getters:

 
 

+    virtual wxString GetTitle() const = 0;
+    virtual wxAlignment GetAlignment() const = 0;

     virtual int GetWidth() const = 0;
     virtual int GetWidth() const = 0;

+    virtual int GetMinWidth() const = 0;

 
 

-private:
-    wxDataViewCtrl          *m_ctrl;
+    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;
     wxDataViewRenderer      *m_renderer;
     int                      m_model_column;

-    int                      m_flags;
-    wxString                 m_title;

     wxBitmap                 m_bitmap;
     wxDataViewCtrl          *m_owner;
 
     wxBitmap                 m_bitmap;
     wxDataViewCtrl          *m_owner;
 


@@ -336,7 +369,11 @@ protected:
 // ---------------------------------------------------------
 
 #define wxDV_SINGLE                  0x0000     // for convenience
 // ---------------------------------------------------------
 
 #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
 {
 
 class WXDLLIMPEXP_ADV wxDataViewCtrlBase: public wxControl
 {


@@ -390,7 +427,9 @@ public:
                     int flags = wxDATAVIEW_COL_RESIZABLE );
     
     virtual bool AppendColumn( wxDataViewColumn *col );
                     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 bool DeleteColumn( unsigned int pos );
     virtual bool ClearColumns();
     virtual wxDataViewColumn* GetColumn( unsigned int pos );


@@ -443,16 +482,19 @@ public:
 
     int GetColumn() const { return m_col; }
     void SetColumn( int col ) { m_col = col; }
 
     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; }
     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; }
     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; }
     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; }
+    wxDataViewColumn *GetDataViewColumn() const { return m_column; }

 
     // was label editing canceled? (for wxEVT_COMMAND_DATVIEW_END_LABEL_EDIT only)
     bool IsEditCancelled() const { return m_editCancelled; }
 
     // was label editing canceled? (for wxEVT_COMMAND_DATVIEW_END_LABEL_EDIT only)
     bool IsEditCancelled() const { return m_editCancelled; }