Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / dvrenderer.h

diff --git a/include/wx/generic/dvrenderer.h b/include/wx/generic/dvrenderer.h
index d0fd15bab64e2f1bc06ba0f7c80396f2755478e4..3236f41eb333dc8c7f1570a74e11f8fddc04cfd6 100644 (file)
--- a/include/wx/generic/dvrenderer.h
+++ b/include/wx/generic/dvrenderer.h
@@ -3,7 +3,7 @@
 // Purpose:     wxDataViewRenderer for generic wxDataViewCtrl implementation
 // Author:      Robert Roebling, Vadim Zeitlin
 // Created:     2009-11-07 (extracted from wx/generic/dataview.h)
 // Purpose:     wxDataViewRenderer for generic wxDataViewCtrl implementation
 // Author:      Robert Roebling, Vadim Zeitlin
 // Created:     2009-11-07 (extracted from wx/generic/dataview.h)

-// RCS-ID:      $Id: wxhead.h,v 1.11 2009-06-29 10:23:04 zeitlin Exp $
+// RCS-ID:      $Id$

 // Copyright:   (c) 2006 Robert Roebling
 //              (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 // Copyright:   (c) 2006 Robert Roebling
 //              (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence


@@ -41,17 +41,17 @@ public:
 
     // implementation
 
 
     // implementation
 

-    // this is a replacement for dynamic_cast<wxDataViewCustomRenderer> in the
-    // code checking whether the renderer is interested in mouse events, it's
-    // overridden in wxDataViewCustomRenderer to return the object itself but
-    // intentionally returns NULL for all the other renderer classes as the
-    // user should _not_ be able to override Activate/LeftClick() when deriving
-    // from them for consistency with the other ports and while we can't
-    // prevent this from working at compile-time because all renderer are
-    // custom renderers in the generic implementation, we at least make sure
-    // that it doesn't work at run-time because Activate/LeftClick() would
-    // never be called
-    virtual wxDataViewCustomRenderer *WXGetAsCustom() { return NULL; }
+    // This callback is used by generic implementation of wxDVC itself.  It's
+    // different from the corresponding ActivateCell() method which should only
+    // be overridable for the custom renderers while the generic implementation
+    // uses this one for all of them, including the standard ones.
+
+    virtual bool WXActivateCell(const wxRect& WXUNUSED(cell),
+                                wxDataViewModel *WXUNUSED(model),
+                                const wxDataViewItem & WXUNUSED(item),
+                                unsigned int WXUNUSED(col),
+                                const wxMouseEvent* WXUNUSED(mouseEvent))
+        { return false; }

 
 private:
     int                          m_align;
 
 private:
     int                          m_align;