Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/dvrenderers.h b/include/wx/dvrenderers.h
old mode 100755 (executable)
new mode 100644 (file)
index ca89147..99f1e8a
--- a/include/wx/dvrenderers.h
+++ b/include/wx/dvrenderers.h
@@ -54,6 +54,21 @@ public:
     void SetIcon( const wxIcon &icon )   { m_icon = icon; }
     const wxIcon &GetIcon() const        { return m_icon; }
 
     void SetIcon( const wxIcon &icon )   { m_icon = icon; }
     const wxIcon &GetIcon() const        { return m_icon; }
 

+    bool IsSameAs(const wxDataViewIconText& other) const
+    {
+        return m_text == other.m_text && m_icon.IsSameAs(other.m_icon);
+    }
+
+    bool operator==(const wxDataViewIconText& other) const
+    {
+        return IsSameAs(other);
+    }
+
+    bool operator!=(const wxDataViewIconText& other) const
+    {
+        return !IsSameAs(other);
+    }
+

 private:
     wxString    m_text;
     wxIcon      m_icon;
 private:
     wxString    m_text;
     wxIcon      m_icon;


@@ -61,19 +76,6 @@ private:
     DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
 };
 
     DECLARE_DYNAMIC_CLASS(wxDataViewIconText)
 };
 

-inline
-bool operator==(const wxDataViewIconText& left, const wxDataViewIconText& right)
-{
-    return left.GetText() == right.GetText() &&
-             left.GetIcon().IsSameAs(right.GetIcon());
-}
-
-inline
-bool operator!=(const wxDataViewIconText& left, const wxDataViewIconText& right)
-{
-    return !(left == right);
-}
-

 DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText, WXDLLIMPEXP_ADV)
 
 // ----------------------------------------------------------------------------
 DECLARE_VARIANT_OBJECT_EXPORTED(wxDataViewIconText, WXDLLIMPEXP_ADV)
 
 // ----------------------------------------------------------------------------


@@ -171,8 +173,9 @@ protected:
     wxWeakRef<wxWindow>     m_editorCtrl;
     wxDataViewItem          m_item; // for m_editorCtrl
 
     wxWeakRef<wxWindow>     m_editorCtrl;
     wxDataViewItem          m_item; // for m_editorCtrl
 

-    // internal utility:
-    const wxDataViewCtrl* GetView() const;
+    // internal utility, may be used anywhere the window associated with the
+    // renderer is required
+    wxDataViewCtrl* GetView() const;

 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)
 
 protected:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRendererBase)


@@ -225,23 +228,32 @@ public:
     // Return the size of the item appropriate to its current value.
     virtual wxSize GetSize() const = 0;
 
     // Return the size of the item appropriate to its current value.
     virtual wxSize GetSize() const = 0;
 

-    // Define virtual function which are called when the item is activated
-    // (double-clicked or Enter is pressed on it), clicked or the user starts
-    // to drag it: by default they all simply return false indicating that the
-    // events are not handled
-
-    virtual bool Activate(const wxRect& WXUNUSED(cell),
-                          wxDataViewModel *WXUNUSED(model),
-                          const wxDataViewItem & WXUNUSED(item),
-                          unsigned int WXUNUSED(col))
-        { return false; }
-
-    virtual bool LeftClick(const wxPoint& WXUNUSED(cursor),
-                           const wxRect& WXUNUSED(cell),
-                           wxDataViewModel *WXUNUSED(model),
-                           const wxDataViewItem & WXUNUSED(item),
-                           unsigned int WXUNUSED(col) )
-        { return false; }
+    // Define virtual function which are called when a key is pressed on the
+    // item, clicked or the user starts to drag it: by default they all simply
+    // return false indicating that the events are not handled
+
+    virtual bool ActivateCell(const wxRect& cell,
+                              wxDataViewModel *model,
+                              const wxDataViewItem & item,
+                              unsigned int col,
+                              const wxMouseEvent* mouseEvent);
+
+    // Deprecated, use (and override) ActivateCell() instead
+    wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
+        virtual bool Activate(wxRect WXUNUSED(cell),
+                              wxDataViewModel *WXUNUSED(model),
+                              const wxDataViewItem & WXUNUSED(item),
+                              unsigned int WXUNUSED(col)),
+                          return false; )
+
+    // Deprecated, use (and override) ActivateCell() instead
+    wxDEPRECATED_BUT_USED_INTERNALLY_INLINE(
+        virtual bool LeftClick(wxPoint WXUNUSED(cursor),
+                               wxRect WXUNUSED(cell),
+                               wxDataViewModel *WXUNUSED(model),
+                               const wxDataViewItem & WXUNUSED(item),
+                               unsigned int WXUNUSED(col)),
+                          return false; )

 
     virtual bool StartDrag(const wxPoint& WXUNUSED(cursor),
                            const wxRect& WXUNUSED(cell),
 
     virtual bool StartDrag(const wxPoint& WXUNUSED(cursor),
                            const wxRect& WXUNUSED(cell),


@@ -278,6 +290,9 @@ public:
     // platform-specific classes.
     virtual wxDC *GetDC() = 0;
 
     // platform-specific classes.
     virtual wxDC *GetDC() = 0;
 

+    // To draw background use the background colour in wxDataViewItemAttr
+    virtual void RenderBackground(wxDC* dc, const wxRect& rect);
+

     // Prepare DC to use attributes and call Render().
     void WXCallRender(wxRect rect, wxDC *dc, int state);
 
     // Prepare DC to use attributes and call Render().
     void WXCallRender(wxRect rect, wxDC *dc, int state);
 


@@ -383,6 +398,37 @@ public:
 
 #endif // generic or Carbon versions
 
 
 #endif // generic or Carbon versions
 

+#if defined(wxHAS_GENERIC_DATAVIEWCTRL) || defined(__WXGTK__)
+
+// ----------------------------------------------------------------------------
+// wxDataViewDateRenderer
+// ----------------------------------------------------------------------------
+
+#if wxUSE_DATEPICKCTRL
+class WXDLLIMPEXP_ADV wxDataViewDateRenderer: public wxDataViewCustomRenderer
+{
+public:
+    wxDataViewDateRenderer(const wxString &varianttype = wxT("datetime"),
+                           wxDataViewCellMode mode = wxDATAVIEW_CELL_EDITABLE,
+                           int align = wxDVR_DEFAULT_ALIGNMENT);
+
+    virtual bool HasEditorCtrl() const { return true; }
+    virtual wxWindow *CreateEditorCtrl(wxWindow *parent, wxRect labelRect, const wxVariant &value);
+    virtual bool GetValueFromEditorCtrl(wxWindow* editor, wxVariant &value);
+    virtual bool SetValue(const wxVariant &value);
+    virtual bool GetValue(wxVariant& value) const;
+    virtual bool Render( wxRect cell, wxDC *dc, int state );
+    virtual wxSize GetSize() const;
+
+private:
+    wxDateTime    m_date;
+};
+#else // !wxUSE_DATEPICKCTRL
+typedef wxDataViewTextRenderer wxDataViewDateRenderer;
+#endif
+
+#endif // generic or GTK+ versions
+

 // this class is obsolete, its functionality was merged in
 // wxDataViewTextRenderer itself now, don't use it any more
 #define wxDataViewTextRendererAttr wxDataViewTextRenderer
 // this class is obsolete, its functionality was merged in
 // wxDataViewTextRenderer itself now, don't use it any more
 #define wxDataViewTextRendererAttr wxDataViewTextRenderer