deprecated GetCheckBoxSize(wxWindow *) in favour of GetCheckBoxSize() const (the window parameter was unused and not documented)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59246 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/renderer.h

@@ -228,8 +228,12 @@ public:
                               const wxRect& rect,
                               int flags = 0) = 0;
 
+#if WXWIN_COMPATIBILITY_2_8
     // Returns the default size of a check box.
-    virtual wxSize GetCheckBoxSize(wxWindow *win) = 0;
+    wxDEPRECATED_INLINE( virtual wxSize GetCheckBoxSize(wxWindow *WXUNUSED(win)),
+                         return GetCheckBoxSize(); );
+#endif
+    virtual wxSize GetCheckBoxSize() const = 0;
 
     // draw blank button
     //
@@ -404,8 +408,12 @@ public:
                               int flags = 0)
         { m_rendererNative.DrawCheckBox( win, dc, rect, flags ); }
 
-    virtual wxSize GetCheckBoxSize(wxWindow *win)
+#if WXWIN_COMPATIBILITY_2_8
-        { return m_rendererNative.GetCheckBoxSize(win); }
+    wxDEPRECATED_INLINE( virtual wxSize GetCheckBoxSize(wxWindow *WXUNUSED(win)),
+                         return m_rendererNative.GetCheckBoxSize(); );
+#endif
+    virtual wxSize GetCheckBoxSize() const
+        { return m_rendererNative.GetCheckBoxSize(); }
 
     virtual void DrawPushButton(wxWindow *win,
                                 wxDC& dc,

interface/wx/renderer.h

@@ -132,9 +132,8 @@ enum wxHeaderSortIconType
     @class wxDelegateRendererNative
 
     wxDelegateRendererNative allows reuse of renderers code by forwarding all the
-    wxRendererNative methods to the given object and
+    wxRendererNative methods to the given object and thus allowing you to only
-    thus allowing you to only modify some of its methods -- without having to
+    modify some of its methods -- without having to reimplement all of them.
-    reimplement all of them.
 
     Note that the "normal", inheritance-based approach, doesn't work with the
     renderers as it is impossible to derive from a class unknown at compile-time
@@ -146,11 +145,11 @@ enum wxHeaderSortIconType
     by using this class.
 
     Except for the constructor, it has exactly the same methods as
-    wxRendererNative and their implementation is
+    wxRendererNative and their implementation is trivial: they are simply forwarded
-    trivial: they are simply forwarded to the real renderer. Note that the "real"
+    to the real renderer. Note that the "real" renderer may, in turn, be a
-    renderer may, in turn, be a wxDelegateRendererNative as well and that there may
+    wxDelegateRendererNative as well and that there may be arbitrarily many levels
-    be arbitrarily many levels like this -- but at the end of the chain there must
+    like this -- but at the end of the chain there must be a real renderer which
-    be a real renderer which does the drawing.
+    does the drawing.
 
     @library{wxcore}
     @category{gdi}
@@ -211,7 +210,7 @@ public:
     virtual void DrawCheckBox(wxWindow *win, wxDC& dc,
                               const wxRect& rect, int flags = 0 );
 
-    virtual wxSize GetCheckBoxSize(wxWindow *win);
+    virtual wxSize GetCheckBoxSize() const;
 
     virtual void DrawPushButton(wxWindow *win, wxDC& dc,
                                 const wxRect& rect, int flags = 0 );
@@ -449,7 +448,7 @@ public:
     /**
         Returns the size of a check box.
     */
-    virtual wxSize GetCheckBoxSize(wxWindow* win) = 0;
+    virtual wxSize GetCheckBoxSize() const = 0;
 
     /**
         Returns the height of a header button, either a fixed platform height if

src/generic/renderg.cpp

@@ -98,7 +98,7 @@ public:
                               const wxRect& rect,
                               int flags = 0);
 
-    virtual wxSize GetCheckBoxSize(wxWindow *win);
+    virtual wxSize GetCheckBoxSize() const;
 
     virtual void DrawPushButton(wxWindow *win,
                                 wxDC& dc,
@@ -625,7 +625,7 @@ wxRendererGeneric::DrawCheckBox(wxWindow *WXUNUSED(win),
     }
 }
 
-wxSize wxRendererGeneric::GetCheckBoxSize(wxWindow *WXUNUSED(win))
+wxSize wxRendererGeneric::GetCheckBoxSize() const
 {
     return wxSize(16, 16);
 }

src/gtk/renderer.cpp

@@ -121,7 +121,7 @@ public:
 
     virtual void DrawFocusRect(wxWindow* win, wxDC& dc, const wxRect& rect, int flags = 0);
 
-    virtual wxSize GetCheckBoxSize(wxWindow *win);
+    virtual wxSize GetCheckBoxSize() const;
 
     virtual wxSplitterRenderParams GetSplitterParams(const wxWindow *win);
 };
@@ -428,7 +428,7 @@ wxRendererGTK::DrawComboBoxDropButton(wxWindow *win,
 }
 
 wxSize
-wxRendererGTK::GetCheckBoxSize(wxWindow *WXUNUSED(win))
+wxRendererGTK::GetCheckBoxSize() const
 {
     gint indicator_size, indicator_spacing;
     gtk_widget_style_get(wxGTKPrivate::GetCheckButtonWidget(),

src/msw/renderer.cpp

@@ -213,7 +213,7 @@ public:
                                 const wxRect& rect,
                                 int flags=0);
 
-    virtual wxSize GetCheckBoxSize(wxWindow *win);
+    virtual wxSize GetCheckBoxSize() const;
 
     virtual int GetHeaderButtonHeight(wxWindow *win);
 
@@ -388,7 +388,7 @@ void wxRendererMSW::DrawFocusRect(wxWindow * WXUNUSED(win),
     ::DrawFocusRect(GraphicsHDC(&dc), &rc);
 }
 
-wxSize wxRendererMSW::GetCheckBoxSize(wxWindow * WXUNUSED(win))
+wxSize wxRendererMSW::GetCheckBoxSize() const
 {
     return wxSize(::GetSystemMetrics(SM_CXMENUCHECK),
                   ::GetSystemMetrics(SM_CYMENUCHECK));

src/osx/carbon/renderer.cpp

@@ -75,7 +75,7 @@ public:
                               const wxRect& rect,
                               int flags = 0);
 
-    virtual wxSize GetCheckBoxSize(wxWindow* win);
+    virtual wxSize GetCheckBoxSize() const;
 
     virtual void DrawComboBoxDropButton(wxWindow *win,
                                         wxDC& dc,
@@ -381,7 +381,7 @@ wxRendererMac::DrawCheckBox(wxWindow *win,
                        kind, kThemeAdornmentNone);
 }
 
-wxSize wxRendererMac::GetCheckBoxSize(wxWindow* WXUNUSED(win))
+wxSize wxRendererMac::GetCheckBoxSize() const
 {
     wxSize size;
     SInt32 width, height;