Clarify wxButton::AdjustForBitmapSize() semantics in wxMSW.

This method should only be called if we do have an image, assert (instead of
silently returning) if it's called when we don't.

Also explain in a comment why do we need to call CacheBestSize() only when we
have an image in DoGetBestSize().

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

diff --git a/include/wx/msw/button.h b/include/wx/msw/button.h
index 1f5ad27c9b72329db5da84eb9c1e1e44d989314f..ee1d197e9dadd5a2d58b89f7fa554c16489c4635 100644 (file)
--- a/include/wx/msw/button.h
+++ b/include/wx/msw/button.h
@@ -88,8 +88,10 @@ protected:
     virtual void DoSetBitmapMargins(wxCoord x, wxCoord y);
     virtual void DoSetBitmapPosition(wxDirection dir);
 
-    // Increases the passed in size if necessary to account for the
-    // button image, if any
+    // Increases the passed in size to account for the button image.
+    //
+    // Should only be called if we do have a button, i.e. if m_imageData is
+    // non-NULL.
     void AdjustForBitmapSize(wxSize& size) const;
 
     class wxButtonImageData *m_imageData;

diff --git a/src/msw/button.cpp b/src/msw/button.cpp
index 240e2e981327807505acdd3a142dd1fa794f1acb..cabac36506e4f5eced5343d87d9c8e82fdba61b6 100644 (file)
--- a/src/msw/button.cpp
+++ b/src/msw/button.cpp
@@ -531,8 +531,7 @@ void wxButton::SetLabel(const wxString& label)
 
 void wxButton::AdjustForBitmapSize(wxSize &size) const
 {
-    if ( !m_imageData )
-        return;
+    wxCHECK_RET( m_imageData, wxT("shouldn't be called if no image") );
 
     // account for the bitmap size
     const wxSize sizeBmp = m_imageData->GetBitmap(State_Normal).GetSize();
@@ -614,6 +613,8 @@ wxSize wxButton::DoGetBestSize() const
     {
         AdjustForBitmapSize(size);
 
+        // The best size has changed so even if it had been already cached by
+        // ComputeBestSize() call above we still need to update it.
         CacheBestSize(size);
     }