better ownership handling

[wxWidgets.git] / src / common / combocmn.cpp

diff --git a/src/common/combocmn.cpp b/src/common/combocmn.cpp
index ccabb7277e576b60100b832f8cb225dd240ca91b..ff3563c2dbdb916f6feeb007c230b17a04416740 100644 (file)
--- a/src/common/combocmn.cpp
+++ b/src/common/combocmn.cpp
@@ -160,7 +160,7 @@ wxCONSTRUCTOR_5( wxComboBox, wxWindow*, Parent, wxWindowID, Id, \
 #endif
 
 // NB: Let's not be afraid to use wxGTK's wxPopupTransientWindow as a
 #endif
 
 // NB: Let's not be afraid to use wxGTK's wxPopupTransientWindow as a

-//     'perfect' popup, as it can succesfully host child controls even in
+//     'perfect' popup, as it can successfully host child controls even in

 //     popups that are shown in modal dialogs.
 
 #define USE_TRANSIENT_POPUP           1 // Use wxPopupWindowTransient (preferred, if it works properly on platform)
 //     popups that are shown in modal dialogs.
 
 #define USE_TRANSIENT_POPUP           1 // Use wxPopupWindowTransient (preferred, if it works properly on platform)


@@ -674,6 +674,34 @@ void wxComboPopup::Dismiss()
     m_combo->HidePopup(true);
 }
 
     m_combo->HidePopup(true);
 }
 

+void wxComboPopup::DestroyPopup()
+{
+    // Here we make sure that the popup control's Destroy() gets called.
+    // This is necessary for the wxPersistentWindow to work properly.
+    wxWindow* popupCtrl = GetControl();
+    if ( popupCtrl )
+    {
+        // While all wxComboCtrl examples have m_popupInterface and
+        // popupCtrl as the same class (that will be deleted via the
+        // Destroy() call below), it is technically still possible to
+        // have implementations where they are in fact not same
+        // multiple-inherited class. Here we use C++ RTTI to check for
+        // this rare case.
+      #ifndef wxNO_RTTI
+        // It is probably better to delete m_popupInterface first, so
+        // that it retains access to its popup control window.
+        if ( dynamic_cast<void*>(this) !=
+             dynamic_cast<void*>(popupCtrl) )
+            delete this;
+      #endif
+        popupCtrl->Destroy();
+    }
+    else
+    {
+        delete this;
+    }
+}
+

 // ----------------------------------------------------------------------------
 // input handling
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // input handling
 // ----------------------------------------------------------------------------


@@ -932,7 +960,6 @@ public:
 
 
 BEGIN_EVENT_TABLE(wxComboCtrlBase, wxControl)
 
 
 BEGIN_EVENT_TABLE(wxComboCtrlBase, wxControl)

-    EVT_TEXT(wxID_ANY,wxComboCtrlBase::OnTextCtrlEvent)

     EVT_SIZE(wxComboCtrlBase::OnSizeEvent)
     EVT_SET_FOCUS(wxComboCtrlBase::OnFocusEvent)
     EVT_KILL_FOCUS(wxComboCtrlBase::OnFocusEvent)
     EVT_SIZE(wxComboCtrlBase::OnSizeEvent)
     EVT_SET_FOCUS(wxComboCtrlBase::OnFocusEvent)
     EVT_KILL_FOCUS(wxComboCtrlBase::OnFocusEvent)


@@ -940,7 +967,6 @@ BEGIN_EVENT_TABLE(wxComboCtrlBase, wxControl)
     //EVT_BUTTON(wxID_ANY,wxComboCtrlBase::OnButtonClickEvent)
     EVT_KEY_DOWN(wxComboCtrlBase::OnKeyEvent)
     EVT_CHAR(wxComboCtrlBase::OnCharEvent)
     //EVT_BUTTON(wxID_ANY,wxComboCtrlBase::OnButtonClickEvent)
     EVT_KEY_DOWN(wxComboCtrlBase::OnKeyEvent)
     EVT_CHAR(wxComboCtrlBase::OnCharEvent)

-    EVT_TEXT_ENTER(wxID_ANY,wxComboCtrlBase::OnTextCtrlEvent)

     EVT_SYS_COLOUR_CHANGED(wxComboCtrlBase::OnSysColourChanged)
 END_EVENT_TABLE()
 
     EVT_SYS_COLOUR_CHANGED(wxComboCtrlBase::OnSysColourChanged)
 END_EVENT_TABLE()
 


@@ -988,6 +1014,7 @@ void wxComboCtrlBase::Init()
     m_timeCanAcceptClick = 0;
 
     m_resetFocus = false;
     m_timeCanAcceptClick = 0;
 
     m_resetFocus = false;

+    m_hasTcBgCol = false;

 }
 
 bool wxComboCtrlBase::Create(wxWindow *parent,
 }
 
 bool wxComboCtrlBase::Create(wxWindow *parent,


@@ -1017,10 +1044,11 @@ bool wxComboCtrlBase::Create(wxWindow *parent,
     m_iFlags |= wxCC_IFLAG_CREATED;
 
     // If x and y indicate valid size, wxSizeEvent won't be
     m_iFlags |= wxCC_IFLAG_CREATED;
 
     // If x and y indicate valid size, wxSizeEvent won't be

-    // emitted automatically, so we need to add artifical one.
+    // emitted automatically, so we need to add artificial one.

     if ( size.x > 0 && size.y > 0 )
     {
         wxSizeEvent evt(size,GetId());
     if ( size.x > 0 && size.y > 0 )
     {
         wxSizeEvent evt(size,GetId());

+        evt.SetEventObject(this);

         GetEventHandler()->AddPendingEvent(evt);
     }
 
         GetEventHandler()->AddPendingEvent(evt);
     }
 


@@ -1065,35 +1093,47 @@ wxComboCtrlBase::CreateTextCtrl(int style)
         m_text->Create(this, wxID_ANY, m_valueString,
                        wxDefaultPosition, wxSize(10,-1),
                        style);
         m_text->Create(this, wxID_ANY, m_valueString,
                        wxDefaultPosition, wxSize(10,-1),
                        style);

+
+        // Connecting the events is currently the most reliable way
+        wxWindowID id = m_text->GetId();
+        m_text->Connect(id, wxEVT_COMMAND_TEXT_UPDATED,
+                        wxCommandEventHandler(wxComboCtrlBase::OnTextCtrlEvent),
+                        NULL, this);
+        m_text->Connect(id, wxEVT_COMMAND_TEXT_ENTER,
+                        wxCommandEventHandler(wxComboCtrlBase::OnTextCtrlEvent),
+                        NULL, this);
+

         m_text->SetHint(m_hintText);
     }
 }
 
 void wxComboCtrlBase::OnThemeChange()
 {
         m_text->SetHint(m_hintText);
     }
 }
 
 void wxComboCtrlBase::OnThemeChange()
 {

-    // Leave the default bg on the Mac so the area used by the focus ring will
-    // be the correct colour and themed brush.  Instead we'll use
-    // wxSYS_COLOUR_WINDOW in the EVT_PAINT handler as needed.
-#ifndef __WXMAC__
-  #if defined(__WXMSW__) || defined(__WXGTK__)
+    // Because wxComboCtrl has transparent parts on most platforms, we
+    // don't want to touch the actual background colour. Instead, we just
+    // usually re-obtain m_tcBgCol here.
+
+#if defined(__WXMSW__) || defined(__WXGTK__)

     wxVisualAttributes vattrs = wxComboBox::GetClassDefaultAttributes();
     wxVisualAttributes vattrs = wxComboBox::GetClassDefaultAttributes();

-  #else
+#else

     wxVisualAttributes vattrs;
     vattrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
     vattrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
     wxVisualAttributes vattrs;
     vattrs.colFg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT);
     vattrs.colBg = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);

-  #endif
+#endif
+
+    if ( !m_hasTcBgCol )
+        m_tcBgCol = vattrs.colBg;

 
 

+#ifndef __WXMAC__

     // Only change the colours if application has not specified
     // custom ones.
     if ( !m_hasFgCol )
     {
         SetOwnForegroundColour(vattrs.colFg);
     // Only change the colours if application has not specified
     // custom ones.
     if ( !m_hasFgCol )
     {
         SetOwnForegroundColour(vattrs.colFg);

-        m_hasFgCol = false;

     }
     }

-    if ( !m_hasBgCol )
+    if ( !HasTransparentBackground() )

     {
     {

-        SetOwnBackgroundColour(vattrs.colBg);
-        m_hasBgCol = false;
+        SetOwnBackgroundColour(GetParent()->GetBackgroundColour());

     }
 #endif // !__WXMAC__
 }
     }
 #endif // !__WXMAC__
 }


@@ -1132,7 +1172,7 @@ void wxComboCtrlBase::CalculateAreas( int btnWidth )
     // its platform default or bitmap+pushbutton background is used, but not if
     // there is vertical size adjustment or horizontal spacing.
     if ( ( (m_iFlags & wxCC_BUTTON_OUTSIDE_BORDER) ||
     // its platform default or bitmap+pushbutton background is used, but not if
     // there is vertical size adjustment or horizontal spacing.
     if ( ( (m_iFlags & wxCC_BUTTON_OUTSIDE_BORDER) ||

-                (m_bmpNormal.Ok() && m_blankButtonBg) ) &&
+                (m_bmpNormal.IsOk() && m_blankButtonBg) ) &&

          m_btnSpacingX == 0 &&
          m_btnHei <= 0 )
     {
          m_btnSpacingX == 0 &&
          m_btnHei <= 0 )
     {


@@ -1140,7 +1180,7 @@ void wxComboCtrlBase::CalculateAreas( int btnWidth )
         btnBorder = 0;
     }
     else if ( (m_iFlags & wxCC_BUTTON_COVERS_BORDER) &&
         btnBorder = 0;
     }
     else if ( (m_iFlags & wxCC_BUTTON_COVERS_BORDER) &&

-              m_btnSpacingX == 0 && !m_bmpNormal.Ok() )
+              m_btnSpacingX == 0 && !m_bmpNormal.IsOk() )

     {
         m_iFlags &= ~(wxCC_IFLAG_BUTTON_OUTSIDE);
         btnBorder = 0;
     {
         m_iFlags &= ~(wxCC_IFLAG_BUTTON_OUTSIDE);
         btnBorder = 0;


@@ -1197,7 +1237,7 @@ void wxComboCtrlBase::CalculateAreas( int btnWidth )
     //   It is larger
     //   OR
     //   button width is set to default and blank button bg is not drawn
     //   It is larger
     //   OR
     //   button width is set to default and blank button bg is not drawn

-    if ( m_bmpNormal.Ok() )
+    if ( m_bmpNormal.IsOk() )

     {
         int bmpReqWidth = m_bmpNormal.GetWidth();
         int bmpReqHeight = m_bmpNormal.GetHeight();
     {
         int bmpReqWidth = m_bmpNormal.GetWidth();
         int bmpReqHeight = m_bmpNormal.GetHeight();


@@ -1219,7 +1259,7 @@ void wxComboCtrlBase::CalculateAreas( int btnWidth )
         {
             int newY = butHeight+(customBorder*2);
             SetClientSize(wxDefaultCoord,newY);
         {
             int newY = butHeight+(customBorder*2);
             SetClientSize(wxDefaultCoord,newY);

-            if ( m_bmpNormal.Ok() || m_btnArea.width != butWidth || m_btnArea.height != butHeight )
+            if ( m_bmpNormal.IsOk() || m_btnArea.width != butWidth || m_btnArea.height != butHeight )

                 m_iFlags |= wxCC_IFLAG_HAS_NONSTANDARD_BUTTON;
             else
                 m_iFlags &= ~wxCC_IFLAG_HAS_NONSTANDARD_BUTTON;
                 m_iFlags |= wxCC_IFLAG_HAS_NONSTANDARD_BUTTON;
             else
                 m_iFlags &= ~wxCC_IFLAG_HAS_NONSTANDARD_BUTTON;


@@ -1328,16 +1368,16 @@ wxSize wxComboCtrlBase::DoGetBestSize() const
     // TODO: Better method to calculate close-to-native control height.
 
     int fhei;
     // TODO: Better method to calculate close-to-native control height.
 
     int fhei;

-    if ( m_font.Ok() )
+    if ( m_font.IsOk() )

         fhei = (m_font.GetPointSize()*2) + 5;
         fhei = (m_font.GetPointSize()*2) + 5;

-    else if ( wxNORMAL_FONT->Ok() )
+    else if ( wxNORMAL_FONT->IsOk() )

         fhei = (wxNORMAL_FONT->GetPointSize()*2) + 5;
     else
         fhei = sizeText.y + 4;
 
     // Need to force height to accomodate bitmap?
     int btnSizeY = m_btnSize.y;
         fhei = (wxNORMAL_FONT->GetPointSize()*2) + 5;
     else
         fhei = sizeText.y + 4;
 
     // Need to force height to accomodate bitmap?
     int btnSizeY = m_btnSize.y;

-    if ( m_bmpNormal.Ok() && fhei < btnSizeY )
+    if ( m_bmpNormal.IsOk() && fhei < btnSizeY )

         fhei = btnSizeY;
 
     // Control height doesn't depend on border
         fhei = btnSizeY;
 
     // Control height doesn't depend on border


@@ -1478,14 +1518,20 @@ bool wxComboCtrlBase::SetForegroundColour(const wxColour& colour)
 
 bool wxComboCtrlBase::SetBackgroundColour(const wxColour& colour)
 {
 
 bool wxComboCtrlBase::SetBackgroundColour(const wxColour& colour)
 {

-    if ( wxControl::SetBackgroundColour(colour) )
-    {
-        if ( m_text )
-            m_text->SetBackgroundColour(colour);
-        return true;
-    }
-    return false;
+    if ( m_text )
+        m_text->SetBackgroundColour(colour);
+    m_tcBgCol = colour;
+    m_hasTcBgCol = true;
+    return true;

 }
 }

+
+wxColour wxComboCtrlBase::GetBackgroundColour() const
+{
+    if ( m_text )
+        return m_text->GetBackgroundColour();
+    return m_tcBgCol;
+}
+

 // ----------------------------------------------------------------------------
 // painting
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // painting
 // ----------------------------------------------------------------------------


@@ -1569,10 +1615,10 @@ void wxComboCtrlBase::PrepareBackground( wxDC& dc, const wxRect& rect, int flags
         {
             bgCol = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
         }
         {
             bgCol = wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHT);
         }

-        else if ( m_hasBgCol )
+        else if ( m_hasTcBgCol )

         {
             // Honour the custom background colour
         {
             // Honour the custom background colour

-            bgCol = GetBackgroundColour();
+            bgCol = m_tcBgCol;

         }
         else
         {
         }
         else
         {


@@ -1638,25 +1684,28 @@ void wxComboCtrlBase::DrawButton( wxDC& dc, const wxRect& rect, int flags )
     if ( !enabled )
         drawState |= wxCONTROL_DISABLED;
 
     if ( !enabled )
         drawState |= wxCONTROL_DISABLED;
 

-    if ( !m_bmpNormal.Ok() )
+    // Need to clear button background even if m_btn is present
+    // and also when using custom bitmap for the button
+    if ( (flags & Button_PaintBackground) &&
+            (!HasTransparentBackground() ||
+             !(m_iFlags & wxCC_IFLAG_BUTTON_OUTSIDE)) )

     {
     {

-        if ( flags & Button_BitmapOnly )
-            return;
+        wxColour bgCol;

 
 

-        // Need to clear button background even if m_btn is present
-        if ( flags & Button_PaintBackground )
-        {
-            wxColour bgCol;
+        if ( m_iFlags & wxCC_IFLAG_BUTTON_OUTSIDE )
+            bgCol = GetParent()->GetBackgroundColour();
+        else
+            bgCol = GetBackgroundColour();

 
 

-            if ( m_iFlags & wxCC_IFLAG_BUTTON_OUTSIDE )
-                bgCol = GetParent()->GetBackgroundColour();
-            else
-                bgCol = GetBackgroundColour();
+        dc.SetBrush(bgCol);
+        dc.SetPen(bgCol);
+        dc.DrawRectangle(rect);
+    }

 
 

-            dc.SetBrush(bgCol);
-            dc.SetPen(bgCol);
-            dc.DrawRectangle(rect);
-        }
+    if ( !m_bmpNormal.IsOk() )
+    {
+        if ( flags & Button_BitmapOnly )
+            return;

 
         // Draw standard button
         wxRendererNative::Get().DrawComboBoxDropButton(this,
 
         // Draw standard button
         wxRendererNative::Get().DrawComboBoxDropButton(this,


@@ -1681,17 +1730,6 @@ void wxComboCtrlBase::DrawButton( wxDC& dc, const wxRect& rect, int flags )
 
         if ( m_blankButtonBg )
         {
 
         if ( m_blankButtonBg )
         {

-            // If using blank button background, we need to clear its background
-            // with button face colour instead of colour for rest of the control.
-            if ( flags & Button_PaintBackground )
-            {
-                wxColour bgCol = GetParent()->GetBackgroundColour(); //wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE);
-                //wxColour bgCol = wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOW);
-                dc.SetPen(bgCol);
-                dc.SetBrush(bgCol);
-                dc.DrawRectangle(rect);
-            }
-

             if ( !(flags & Button_BitmapOnly) )
             {
                 wxRendererNative::Get().DrawPushButton(this,
             if ( !(flags & Button_BitmapOnly) )
             {
                 wxRendererNative::Get().DrawPushButton(this,


@@ -1700,14 +1738,6 @@ void wxComboCtrlBase::DrawButton( wxDC& dc, const wxRect& rect, int flags )
                                                        drawState);
             }
         }
                                                        drawState);
             }
         }

-        else
-
-        {
-            // Need to clear button background even if m_btn is present
-            // (assume non-button background was cleared just before this call so brushes are good)
-            if ( flags & Button_PaintBackground )
-                dc.DrawRectangle(rect);
-        }

 
         // Draw bitmap centered in drawRect
         dc.DrawBitmap(*pBmp,
 
         // Draw bitmap centered in drawRect
         dc.DrawBitmap(*pBmp,


@@ -1722,6 +1752,7 @@ void wxComboCtrlBase::RecalcAndRefresh()
     if ( IsCreated() )
     {
         wxSizeEvent evt(GetSize(),GetId());
     if ( IsCreated() )
     {
         wxSizeEvent evt(GetSize(),GetId());

+        evt.SetEventObject(this);

         GetEventHandler()->ProcessEvent(evt);
         Refresh();
     }
         GetEventHandler()->ProcessEvent(evt);
         Refresh();
     }


@@ -1733,6 +1764,13 @@ void wxComboCtrlBase::RecalcAndRefresh()
 
 void wxComboCtrlBase::OnTextCtrlEvent(wxCommandEvent& event)
 {
 
 void wxComboCtrlBase::OnTextCtrlEvent(wxCommandEvent& event)
 {

+    // Avoid infinite recursion
+    if ( event.GetEventObject() == this )
+    {
+        event.Skip();
+        return;
+    }
+

     if ( event.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED )
     {
         if ( m_ignoreEvtText > 0 )
     if ( event.GetEventType() == wxEVT_COMMAND_TEXT_UPDATED )
     {
         if ( m_ignoreEvtText > 0 )


@@ -1742,12 +1780,13 @@ void wxComboCtrlBase::OnTextCtrlEvent(wxCommandEvent& event)
         }
     }
 
         }
     }
 

-    // Change event id, object and string before relaying it forward
-    event.SetId(GetId());
-    wxString s = event.GetString();
-    event.SetEventObject(this);
-    event.SetString(s);
-    event.Skip();
+    // For safety, completely re-create a new wxCommandEvent
+    wxCommandEvent evt2(event);
+    evt2.SetId(GetId());
+    evt2.SetEventObject(this);
+    HandleWindowEvent(evt2);
+
+    event.StopPropagation();

 }
 
 // call if cursor is on button area or mouse is captured for the button
 }
 
 // call if cursor is on button area or mouse is captured for the button


@@ -2096,7 +2135,12 @@ void wxComboCtrlBase::DestroyPopup()
 
     wxDELETE(m_popupEvtHandler);
 
 
     wxDELETE(m_popupEvtHandler);
 

-    wxDELETE(m_popupInterface);
+    if ( m_popupInterface )
+    {
+        // NB: DestroyPopup() performs 'delete this'.
+        m_popupInterface->DestroyPopup();
+        m_popupInterface = NULL;
+    }

 
     if ( m_winPopup )
     {
 
     if ( m_winPopup )
     {


@@ -2520,17 +2564,17 @@ void wxComboCtrlBase::SetButtonBitmaps( const wxBitmap& bmpNormal,
     m_bmpNormal = bmpNormal;
     m_blankButtonBg = blankButtonBg;
 
     m_bmpNormal = bmpNormal;
     m_blankButtonBg = blankButtonBg;
 

-    if ( bmpPressed.Ok() )
+    if ( bmpPressed.IsOk() )

         m_bmpPressed = bmpPressed;
     else
         m_bmpPressed = bmpNormal;
 
         m_bmpPressed = bmpPressed;
     else
         m_bmpPressed = bmpNormal;
 

-    if ( bmpHover.Ok() )
+    if ( bmpHover.IsOk() )

         m_bmpHover = bmpHover;
     else
         m_bmpHover = bmpNormal;
 
         m_bmpHover = bmpHover;
     else
         m_bmpHover = bmpNormal;
 

-    if ( bmpDisabled.Ok() )
+    if ( bmpDisabled.IsOk() )

         m_bmpDisabled = bmpDisabled;
     else
         m_bmpDisabled = bmpNormal;
         m_bmpDisabled = bmpDisabled;
     else
         m_bmpDisabled = bmpNormal;


@@ -2652,7 +2696,7 @@ void wxComboCtrlBase::OnSetValue(const wxString& value)
         bool found = true;
         wxString trueValue = value;
 
         bool found = true;
         wxString trueValue = value;
 

-        // Conform to wxComboBox behavior: read-only control can only accept
+        // Conform to wxComboBox behaviour: read-only control can only accept

         // valid list items and empty string
         if ( m_popupInterface && HasFlag(wxCB_READONLY) && value.length() )
         {
         // valid list items and empty string
         if ( m_popupInterface && HasFlag(wxCB_READONLY) && value.length() )
         {