add note for wxWidgets user with a skeleton for a very minimal console app

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

diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h
index d9febd92537b4b45a3a7fcd716ede3b5bb178c94..31ed319e1591da2981541fb8e59f73b8aef1c854 100644 (file)
--- a/interface/wx/dataview.h
+++ b/interface/wx/dataview.h
@@ -70,11 +70,6 @@ public:
     wxDataViewEvent(const wxDataViewEvent& event);
     //@}
 
-    /**
-        Used to clone the event.
-    */
-    wxEvent* Clone() const;
-
     /**
         Returns the position of the column in the control or -1
         if no column field was set by the event emitter.
@@ -747,13 +742,13 @@ public:
                                        unsigned int model_column,
                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
                                        int width = -1,
-                                       wxAlignment align = wxALIGN_CENTER,
+                                       wxAlignment align = wxALIGN_NOT,
                                        int flags = wxDATAVIEW_COL_RESIZABLE);
     wxDataViewColumn* AppendDateColumn(const wxBitmap& label,
                                        unsigned int model_column,
                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE,
                                        int width = -1,
-                                       wxAlignment align = wxALIGN_CENTER,
+                                       wxAlignment align = wxALIGN_NOT,
                                        int flags = wxDATAVIEW_COL_RESIZABLE);
     //@}
 
@@ -770,13 +765,13 @@ public:
                                            unsigned int model_column,
                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                                            int width = -1,
-                                           wxAlignment align = wxALIGN_LEFT,
+                                           wxAlignment align = wxALIGN_NOT,
                                            int flags = wxDATAVIEW_COL_RESIZABLE);
     wxDataViewColumn* AppendIconTextColumn(const wxBitmap& label,
                                            unsigned int model_column,
                                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                                            int width = -1,
-                                           wxAlignment align = wxALIGN_LEFT,
+                                           wxAlignment align = wxALIGN_NOT,
                                            int flags = wxDATAVIEW_COL_RESIZABLE);
     //@}
 
@@ -814,13 +809,13 @@ public:
                                        unsigned int model_column,
                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                                        int width = -1,
-                                       wxAlignment align = wxALIGN_LEFT,
+                                       wxAlignment align = wxALIGN_NOT,
                                        int flags = wxDATAVIEW_COL_RESIZABLE);
     wxDataViewColumn* AppendTextColumn(const wxBitmap& label,
                                        unsigned int model_column,
                                        wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
                                        int width = -1,
-                                       wxAlignment align = wxALIGN_LEFT,
+                                       wxAlignment align = wxALIGN_NOT,
                                        int flags = wxDATAVIEW_COL_RESIZABLE);
     //@}
 
@@ -857,11 +852,6 @@ public:
     */
     virtual bool ClearColumns();
 
-    /**
-        Unselects all rows.
-    */
-    void ClearSelection();
-
     /**
         Collapses the item.
     */
@@ -892,6 +882,13 @@ public:
     */
     virtual void Expand(const wxDataViewItem& item);
 
+    /**
+       Expands all ancestors of the @a item. This method also
+       ensures that the item itself as well as all ancestor
+       items have been read from the model by the control.
+    */
+    virtual void ExpandAncestors( const wxDataViewItem & item );
+
     /**
         Returns pointer to the column. @a pos refers to the position in the
         control which may change after reordering columns by the user.
@@ -951,6 +948,11 @@ public:
     virtual void HitTest(const wxPoint& point, wxDataViewItem& item,
                          wxDataViewColumn*& col) const;
 
+    /**
+        Return @true if the item is expanded.
+    */
+    virtual bool IsExpanded(const wxDataViewItem& item) const;
+
     /**
         Return @true if the item is selected.
     */
@@ -1518,7 +1520,7 @@ public:
     */
     wxDataViewBitmapRenderer(const wxString& varianttype = "wxBitmap",
                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
-                             int align = wxDVR_DEFAULT_ALIGNMENT,
+                             int align = wxDVR_DEFAULT_ALIGNMENT);
 };
 
 
@@ -1537,7 +1539,7 @@ enum wxDataViewColumnFlags
     @class wxDataViewColumn
 
     This class represents a column in a wxDataViewCtrl.
-    One wxDataViewColumn is bound to one column in the data model, to which the
+    One wxDataViewColumn is bound to one column in the data model to which the
     wxDataViewCtrl has been associated.
 
     An instance of wxDataViewRenderer is used by this class to render its data.
@@ -1545,7 +1547,7 @@ enum wxDataViewColumnFlags
     @library{wxadv}
     @category{dvc}
 */
-class wxDataViewColumn : public wxObject
+class wxDataViewColumn : public wxHeaderColumn
 {
 public:
     //@{
@@ -1556,26 +1558,16 @@ public:
                      wxDataViewRenderer* renderer,
                      unsigned int model_column,
                      int width = wxDVC_DEFAULT_WIDTH,
-                     wxAlignment align = wxALIGN_CENTRE,
+                     wxAlignment align = wxALIGN_CENTER,
                      int flags = wxDATAVIEW_COL_RESIZABLE);
     wxDataViewColumn(const wxBitmap& bitmap,
                      wxDataViewRenderer* renderer,
                      unsigned int model_column,
                      int width = wxDVC_DEFAULT_WIDTH,
-                     wxAlignment align = wxALIGN_CENTRE,
+                     wxAlignment align = wxALIGN_CENTER,
                      int flags = wxDATAVIEW_COL_RESIZABLE);
     //@}
 
-    /**
-        Destructor.
-    */
-    virtual ~wxDataViewColumn();
-
-    /**
-        Returns the bitmap in the header of the column, if any.
-    */
-    const wxBitmap& GetBitmap() const;
-
     /**
         Returns the index of the column of the model, which this
         wxDataViewColumn is displaying.
@@ -1593,68 +1585,6 @@ public:
         @see wxDataViewRenderer.
     */
     wxDataViewRenderer* GetRenderer() const;
-
-    /**
-        Returns @true if the column is reorderable.
-    */
-    bool GetReorderable();
-
-    /**
-        Returns @true if the column is sortable.
-
-        @see SetSortable()
-    */
-    bool GetSortable();
-
-    /**
-        Returns the width of the column.
-    */
-    virtual int GetWidth() const;
-
-    /**
-        Returns @true, if the sort order is ascending.
-
-        @see SetSortOrder()
-    */
-    virtual bool IsSortOrderAscending() const;
-
-    /**
-        Set the alignment of the column header.
-    */
-    virtual void SetAlignment(wxAlignment align);
-
-    /**
-        Set the bitmap of the column header.
-    */
-    virtual void SetBitmap(const wxBitmap& bitmap);
-
-    /**
-        Indicate wether the column can be reordered by the user using the mouse.
-        This is typically implemented visually by dragging the header button around.
-    */
-    virtual void SetReorderable(bool reorderable);
-
-    /**
-        Indicate the sort order if the implementation of the wxDataViewCtrl supports
-        it, most commonly by showing a little arrow.
-    */
-    virtual void SetSortOrder(bool ascending);
-
-    /**
-        Indicate that the column is sortable.
-        This does not show any sorting indicate yet, but it does make the column
-        header clickable. Call SetSortOrder() afterwards to actually make the sort
-        indicator appear.
-
-        If @a sortable is @false, the column header is no longer clickable and
-        the sort indicator (little arrow) will disappear.
-    */
-    virtual void SetSortable(bool sortable);
-
-    /**
-        Set the title of the column header to @a title.
-    */
-    virtual void SetTitle(const wxString& title);
 };
 
 
@@ -1776,7 +1706,7 @@ public:
     /**
         Returns the store.
     */
-    wxDataViewTreeStore* GetStore() const;
+    wxDataViewTreeStore* GetStore();
     const wxDataViewTreeStore* GetStore() const;
     //@}