Restored the old Classes by Category page to live side-by-side with the full Classes...

[wxWidgets.git] / interface / dataview.h

diff --git a/interface/dataview.h b/interface/dataview.h
index 1dbf777cf12864d79aef4a5c3028b65ec1de3645..e32f513867a027cfb310ca5a9528a6c72b632ca9 100644 (file)
--- a/interface/dataview.h
+++ b/interface/dataview.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dataview.h
-// Purpose:     documentation for wxDataViewIconText class
+// Purpose:     interface of wxDataViewIconText
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -52,6 +52,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewEvent
     @wxheader{dataview.h}
@@ -66,7 +67,7 @@ class wxDataViewEvent : public wxNotifyEvent
 public:
     //@{
     /**
-        
+
     */
     wxDataViewEvent(wxEventType commandType = wxEVT_NULL,
                     int winid = 0);
@@ -106,7 +107,7 @@ public:
     const wxVariant GetValue() const;
 
     /**
-        
+
     */
     void SetColumn(int col);
 
@@ -116,17 +117,18 @@ public:
     void SetDataViewColumn(wxDataViewColumn* col);
 
     /**
-        
+
     */
     void SetModel(wxDataViewModel* model);
 
     /**
-        
+
     */
     void SetValue(const wxVariant& value);
 };
 
 
+
 /**
     @class wxDataViewIconTextRenderer
     @wxheader{dataview.h}
@@ -145,13 +147,14 @@ class wxDataViewIconTextRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewIconTextRenderer(const wxString& varianttype = "wxDataViewIconText",
                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
 };
 
 
+
 /**
     @class wxDataViewIndexListModel
     @wxheader{dataview.h}
@@ -197,7 +200,7 @@ public:
     /**
         Oberride this to indicate that the row has special font attributes.
         This only affects the
-        wxDataViewTextRendererText renderer.
+        wxDataViewTextRendererText() renderer.
         See also wxDataViewItemAttr.
     */
     bool GetAttr(unsigned int row, unsigned int col,
@@ -272,6 +275,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewModel
     @wxheader{dataview.h}
@@ -396,7 +400,7 @@ public:
     /**
         Oberride this to indicate that the item has special font attributes.
         This only affects the
-        wxDataViewTextRendererText renderer.
+        wxDataViewTextRendererText() renderer.
         See also wxDataViewItemAttr.
     */
     bool GetAttr(const wxDataViewItem& item, unsigned int col,
@@ -536,6 +540,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewCustomRenderer
     @wxheader{dataview.h}
@@ -577,9 +582,10 @@ public:
     /**
         Override this to react to double clicks or ENTER.
     */
-    virtual bool Activate(wxRect cell, wxDataViewModel* model,
-                          unsigned int col,
-                          unsigned int row);
+    virtual bool Activate( wxRect cell,
+                           wxDataViewModel* model,
+                           const wxDataViewItem & item,
+                           unsigned int col );
 
     /**
         Override this to create the actual editor control once editing
@@ -617,10 +623,11 @@ public:
     /**
         Overrride this to react to a left click.
     */
-    virtual bool LeftClick(wxPoint cursor, wxRect cell,
-                           wxDataViewModel* model,
-                           unsigned int col,
-                           unsigned int row);
+    virtual bool LeftClick( wxPoint cursor,
+                            wxRect cell,
+                            wxDataViewModel * model,
+                            const wxDataViewItem & item,
+                            unsigned int col );
 
     /**
         Override this to render the cell. Before this is called,
@@ -641,21 +648,23 @@ public:
     /**
         Overrride this to react to a right click.
     */
-    virtual bool RightClick(wxPoint cursor, wxRect cell,
+    virtual bool RightClick(wxPoint cursor,
+                            wxRect cell,
                             wxDataViewModel* model,
-                            unsigned int col,
-                            unsigned int row);
+                            const wxDataViewItem & item,
+                            unsigned int col);
 
     /**
         Overrride this to start a drag operation.
     */
     virtual bool StartDrag(wxPoint cursor, wxRect cell,
                            wxDataViewModel* model,
-                           unsigned int col,
-                           unsigned int row);
+                           const wxDataViewItem & item,
+                           unsigned int col);
 };
 
 
+
 /**
     @class wxDataViewBitmapRenderer
     @wxheader{dataview.h}
@@ -669,24 +678,25 @@ class wxDataViewBitmapRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewBitmapRenderer(const wxString& varianttype = "wxBitmap",
                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
 };
 
 
+
 /**
     @class wxDataViewItemAttr
     @wxheader{dataview.h}
 
     This class is used to indicate to a wxDataViewCtrl
-    that a certain Item has extra font attributes
+    that a certain Item() has extra font attributes
     for its renderer. For this, it is required to override
     wxDataViewModel::GetAttr.
 
     Attributes are currently only supported by
-    wxDataViewTextRendererText.
+    wxDataViewTextRendererText().
 
     @library{wxadv}
     @category{FIXME}
@@ -717,6 +727,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewItem
     @wxheader{dataview.h}
@@ -745,7 +756,7 @@ class wxDataViewItem
 public:
     //@{
     /**
-        
+
     */
     wxDataViewItem(void* id = NULL);
     wxDataViewItem(const wxDataViewItem& item);
@@ -763,6 +774,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewCtrl
     @wxheader{dataview.h}
@@ -1111,6 +1123,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewModelNotifier
     @wxheader{dataview.h}
@@ -1198,6 +1211,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewRenderer
     @wxheader{dataview.h}
@@ -1315,6 +1329,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewTextRenderer
     @wxheader{dataview.h}
@@ -1329,13 +1344,14 @@ class wxDataViewTextRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewTextRenderer(const wxString& varianttype = "string",
                            wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
 };
 
 
+
 /**
     @class wxDataViewProgressRenderer
     @wxheader{dataview.h}
@@ -1349,7 +1365,7 @@ class wxDataViewProgressRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewProgressRenderer(const wxString& label = wxEmptyString,
                                const wxString& varianttype = "long",
@@ -1357,6 +1373,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewSpinRenderer
     @wxheader{dataview.h}
@@ -1381,6 +1398,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewToggleRenderer
     @wxheader{dataview.h}
@@ -1394,13 +1412,14 @@ class wxDataViewToggleRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewToggleRenderer(const wxString& varianttype = "bool",
                              wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
 };
 
 
+
 /**
     @class wxDataViewTreeCtrl
     @wxheader{dataview.h}
@@ -1437,7 +1456,7 @@ public:
     ~wxDataViewTreeCtrl();
 
     /**
-        
+
     */
     wxDataViewItem AppendContainer(const wxDataViewItem& parent,
                                    const wxString& text,
@@ -1446,7 +1465,7 @@ public:
                                    wxClientData* data = NULL);
 
     /**
-        
+
     */
     wxDataViewItem AppendItem(const wxDataViewItem& parent,
                               const wxString& text,
@@ -1591,6 +1610,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewTreeStore
     @wxheader{dataview.h}
@@ -1735,6 +1755,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewDateRenderer
     @wxheader{dataview.h}
@@ -1748,13 +1769,14 @@ class wxDataViewDateRenderer : public wxDataViewRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewDateRenderer(const wxString& varianttype = "datetime",
                            wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE);
 };
 
 
+
 /**
     @class wxDataViewTextRendererAttr
     @wxheader{dataview.h}
@@ -1773,7 +1795,7 @@ class wxDataViewTextRendererAttr : public wxDataViewTextRenderer
 {
 public:
     /**
-        
+
     */
     wxDataViewTextRendererAttr(const wxString& varianttype = "string",
                                wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,
@@ -1781,6 +1803,7 @@ public:
 };
 
 
+
 /**
     @class wxDataViewColumn
     @wxheader{dataview.h}
@@ -1906,3 +1929,4 @@ public:
     */
     void SetTitle(const wxString& title);
 };
+