]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/popupcmn.cpp
Update version to 2.9.4 in version.bkl too and rebake everything.
[wxWidgets.git] / src / common / popupcmn.cpp
index 5e6586bb3ccf48ec1c3504ce1afafc9fcd97acc7..4d94eaa688c34c72a666f192c066f5acff34c975 100644 (file)
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        common/popupcmn.cpp
+// Name:        src/common/popupcmn.cpp
 // Purpose:     implementation of wxPopupTransientWindow
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     06.01.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// License:     wxWindows licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "popupwinbase.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #include "wx/popupwin.h"
 
 #ifndef WX_PRECOMP
-    #include "wx/combobox.h"        // wxComboControl
+    #include "wx/combobox.h"        // wxComboCtrl
     #include "wx/app.h"             // wxPostEvent
     #include "wx/log.h"
-    #include "wx/app.h"
 #endif //WX_PRECOMP
 
+#include "wx/display.h"
+#include "wx/recguard.h"
+
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/renderer.h"
+    #include "wx/scrolbar.h"
 #endif // __WXUNIVERSAL__
 
 #ifdef __WXGTK__
     #include <gtk/gtk.h>
-#endif
-#ifdef __WXX11__
-#include "wx/x11/private.h"
+    #if GTK_CHECK_VERSION(2,0,0)
+        #include "wx/gtk/private/gtk2-compat.h"
+    #else
+        #define gtk_widget_get_window(x) x->window
+    #endif
+#elif defined(__WXMSW__)
+    #include "wx/msw/private.h"
+#elif defined(__WXX11__)
+    #include "wx/x11/private.h"
 #endif
 
 IMPLEMENT_DYNAMIC_CLASS(wxPopupWindow, wxWindow)
@@ -67,34 +72,33 @@ class wxPopupWindowHandler : public wxEvtHandler
 {
 public:
     wxPopupWindowHandler(wxPopupTransientWindow *popup) : m_popup(popup) {}
-    ~wxPopupWindowHandler();
 
 protected:
     // event handlers
     void OnLeftDown(wxMouseEvent& event);
+    void OnCaptureLost(wxMouseCaptureLostEvent& event);
 
 private:
     wxPopupTransientWindow *m_popup;
 
     DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxPopupWindowHandler)
+    wxDECLARE_NO_COPY_CLASS(wxPopupWindowHandler);
 };
 
 class wxPopupFocusHandler : public wxEvtHandler
 {
 public:
     wxPopupFocusHandler(wxPopupTransientWindow *popup) : m_popup(popup) {}
-    ~wxPopupFocusHandler();
 
 protected:
     void OnKillFocus(wxFocusEvent& event);
-    void OnKeyDown(wxKeyEvent& event);
+    void OnChar(wxKeyEvent& event);
 
 private:
     wxPopupTransientWindow *m_popup;
 
     DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxPopupFocusHandler)
+    wxDECLARE_NO_COPY_CLASS(wxPopupFocusHandler);
 };
 
 // ----------------------------------------------------------------------------
@@ -103,15 +107,16 @@ private:
 
 BEGIN_EVENT_TABLE(wxPopupWindowHandler, wxEvtHandler)
     EVT_LEFT_DOWN(wxPopupWindowHandler::OnLeftDown)
+    EVT_MOUSE_CAPTURE_LOST(wxPopupWindowHandler::OnCaptureLost)
 END_EVENT_TABLE()
 
 BEGIN_EVENT_TABLE(wxPopupFocusHandler, wxEvtHandler)
     EVT_KILL_FOCUS(wxPopupFocusHandler::OnKillFocus)
-    EVT_KEY_DOWN(wxPopupFocusHandler::OnKeyDown)
+    EVT_CHAR(wxPopupFocusHandler::OnChar)
 END_EVENT_TABLE()
 
 BEGIN_EVENT_TABLE(wxPopupTransientWindow, wxPopupWindow)
-#ifdef __WXMSW__
+#if defined(__WXMSW__) ||(defined(__WXMAC__) && wxOSX_USE_CARBON)
     EVT_IDLE(wxPopupTransientWindow::OnIdle)
 #endif
 END_EVENT_TABLE()
@@ -137,13 +142,31 @@ bool wxPopupWindowBase::Create(wxWindow* WXUNUSED(parent), int WXUNUSED(flags))
 void wxPopupWindowBase::Position(const wxPoint& ptOrigin,
                                  const wxSize& size)
 {
-    wxSize sizeScreen = wxGetDisplaySize(),
-           sizeSelf = GetSize();
+    // determine the position and size of the screen we clamp the popup to
+    wxPoint posScreen;
+    wxSize sizeScreen;
+
+    const int displayNum = wxDisplay::GetFromPoint(ptOrigin);
+    if ( displayNum != wxNOT_FOUND )
+    {
+        const wxRect rectScreen = wxDisplay(displayNum).GetGeometry();
+        posScreen = rectScreen.GetPosition();
+        sizeScreen = rectScreen.GetSize();
+    }
+    else // outside of any display?
+    {
+        // just use the primary one then
+        posScreen = wxPoint(0, 0);
+        sizeScreen = wxGetDisplaySize();
+    }
+
+
+    const wxSize sizeSelf = GetSize();
 
     // is there enough space to put the popup below the window (where we put it
     // by default)?
     wxCoord y = ptOrigin.y + size.y;
-    if ( y + sizeSelf.y > sizeScreen.y )
+    if ( y + sizeSelf.y > posScreen.y + sizeScreen.y )
     {
         // check if there is enough space above
         if ( ptOrigin.y > sizeSelf.y )
@@ -155,8 +178,19 @@ void wxPopupWindowBase::Position(const wxPoint& ptOrigin,
     }
 
     // now check left/right too
-    wxCoord x = ptOrigin.x + size.x;
-    if ( x + sizeSelf.x > sizeScreen.x )
+    wxCoord x = ptOrigin.x;
+
+    if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+    {
+        // shift the window to the left instead of the right.
+        x -= size.x;
+        x -= sizeSelf.x;        // also shift it by window width.
+    }
+    else
+        x += size.x;
+
+
+    if ( x + sizeSelf.x > posScreen.x + sizeScreen.x )
     {
         // check if there is enough space to the left
         if ( ptOrigin.x > sizeSelf.x )
@@ -177,7 +211,7 @@ void wxPopupWindowBase::Position(const wxPoint& ptOrigin,
 void wxPopupTransientWindow::Init()
 {
     m_child =
-    m_focus = (wxWindow *)NULL;
+    m_focus = NULL;
 
     m_handlerFocus = NULL;
     m_handlerPopup = NULL;
@@ -192,49 +226,41 @@ wxPopupTransientWindow::wxPopupTransientWindow(wxWindow *parent, int style)
 
 wxPopupTransientWindow::~wxPopupTransientWindow()
 {
-    PopHandlers();
+    if (m_handlerPopup && m_handlerPopup->GetNextHandler())
+        PopHandlers();
+
+    wxASSERT(!m_handlerFocus || !m_handlerFocus->GetNextHandler());
+    wxASSERT(!m_handlerPopup || !m_handlerPopup->GetNextHandler());
+
+    delete m_handlerFocus;
+    delete m_handlerPopup;
 }
 
 void wxPopupTransientWindow::PopHandlers()
 {
     if ( m_child )
     {
-        if ( m_handlerPopup && !m_child->RemoveEventHandler(m_handlerPopup) )
+        if ( !m_child->RemoveEventHandler(m_handlerPopup) )
         {
             // something is very wrong and someone else probably deleted our
             // handler - so don't risk deleting it second time
             m_handlerPopup = NULL;
         }
         if (m_child->HasCapture())
-        {       
+        {
             m_child->ReleaseMouse();
         }
         m_child = NULL;
     }
 
-#ifdef __WXMSW__
     if ( m_focus )
     {
-        if ( m_handlerFocus && !m_focus->RemoveEventHandler(m_handlerFocus) )
+        if ( !m_focus->RemoveEventHandler(m_handlerFocus) )
         {
             // see above
             m_handlerFocus = NULL;
         }
     }
-#else
-    if ( m_handlerFocus && !RemoveEventHandler(m_handlerFocus) )
-    {
-        // see above
-        m_handlerFocus = NULL;
-    }
-#endif
-
-    // delete the handlers, they'll be created as necessary in Popup()
-    delete m_handlerPopup;
-    m_handlerPopup = NULL;
-    delete m_handlerFocus;
-    m_handlerFocus = NULL;
-
     m_focus = NULL;
 }
 
@@ -252,46 +278,44 @@ void wxPopupTransientWindow::Popup(wxWindow *winFocus)
 
     Show();
 
-    // There is is a problem if these are still valid
-    wxASSERT_MSG(!m_handlerPopup, wxT("Popup handler not deleted"));
-    wxASSERT_MSG(!m_handlerFocus, wxT("Focus handler not deleted"));
+    // There is a problem if these are still in use
+    wxASSERT(!m_handlerFocus || !m_handlerFocus->GetNextHandler());
+    wxASSERT(!m_handlerPopup || !m_handlerPopup->GetNextHandler());
 
-    delete m_handlerPopup;
-    m_handlerPopup = new wxPopupWindowHandler(this);
+    if (!m_handlerPopup)
+        m_handlerPopup = new wxPopupWindowHandler(this);
 
     m_child->PushEventHandler(m_handlerPopup);
 
-    m_focus = winFocus ? winFocus : this;
-    m_focus->SetFocus();
+#if defined(__WXMSW__)
+    // Focusing on child of popup window does not work on MSW unless WS_POPUP
+    // style is set. We do not even want to try to set the focus, as it may
+    // provoke errors on some Windows versions (Vista and later).
+    if ( ::GetWindowLong(GetHwnd(), GWL_STYLE) & WS_POPUP )
+#endif
+    {
+        m_focus = winFocus ? winFocus : this;
+        m_focus->SetFocus();
+    }
 
-#ifdef __WXMSW__
+#if defined( __WXMSW__ ) || (defined( __WXMAC__) && wxOSX_USE_CARBON)
     // MSW doesn't allow to set focus to the popup window, but we need to
     // subclass the window which has the focus, and not winFocus passed in or
     // otherwise everything else breaks down
     m_focus = FindFocus();
+#elif defined(__WXGTK__)
+    // GTK+ catches the activate events from the popup
+    // window, not the focus events from the child window
+    m_focus = this;
+#endif
+
     if ( m_focus )
     {
-        delete m_handlerFocus;
-        m_handlerFocus = new wxPopupFocusHandler(this);
+        if (!m_handlerFocus)
+            m_handlerFocus = new wxPopupFocusHandler(this);
 
         m_focus->PushEventHandler(m_handlerFocus);
     }
-#else
-    // GTK+ catches the activate events from the popup
-    // window, not the focus events from the child window
-    delete m_handlerFocus;
-    m_handlerFocus = new wxPopupFocusHandler(this);
-    PushEventHandler(m_handlerFocus);
-#endif // __WXMSW__
-
-    // catch destroy events, if you close a program with a popup shown in MSW
-    // you get a segfault if m_child or m_focus are deleted before this is
-    m_child->Connect(wxEVT_DESTROY,
-                     wxWindowDestroyEventHandler(wxPopupTransientWindow::OnDestroy),
-                     NULL, this);
-    m_focus->Connect(wxEVT_DESTROY,
-                     wxWindowDestroyEventHandler(wxPopupTransientWindow::OnDestroy),
-                     NULL, this);
 }
 
 bool wxPopupTransientWindow::Show( bool show )
@@ -312,13 +336,13 @@ bool wxPopupTransientWindow::Show( bool show )
     }
 #endif
 
-#ifdef __WXMSW__
+#if defined( __WXMSW__ ) || defined( __WXMAC__)
     if (!show && m_child && m_child->HasCapture())
-    {       
+    {
         m_child->ReleaseMouse();
     }
 #endif
-    
+
     bool ret = wxPopupWindow::Show( show );
 
 #ifdef __WXGTK__
@@ -326,14 +350,14 @@ bool wxPopupTransientWindow::Show( bool show )
     {
         gtk_grab_add( m_widget );
 
-        gdk_pointer_grab( m_widget->window, TRUE,
+        gdk_pointer_grab( gtk_widget_get_window(m_widget), true,
                           (GdkEventMask)
                             (GDK_BUTTON_PRESS_MASK |
                              GDK_BUTTON_RELEASE_MASK |
                              GDK_POINTER_MOTION_HINT_MASK |
                              GDK_POINTER_MOTION_MASK),
-                          (GdkWindow *) NULL,
-                          (GdkCursor *) NULL,
+                          NULL,
+                          NULL,
                           (guint32)GDK_CURRENT_TIME );
     }
 #endif
@@ -354,7 +378,7 @@ bool wxPopupTransientWindow::Show( bool show )
     }
 #endif
 
-#ifdef __WXMSW__
+#if defined( __WXMSW__ ) || defined( __WXMAC__)
     if (show && m_child)
     {
         // Assume that the mouse is outside the popup to begin with
@@ -365,6 +389,20 @@ bool wxPopupTransientWindow::Show( bool show )
     return ret;
 }
 
+bool wxPopupTransientWindow::Destroy()
+{
+    // The popup window can be deleted at any moment, even while some events
+    // are still being processed for it, so delay its real destruction until
+    // the next idle time when we're sure that it's safe to really destroy it.
+
+    wxCHECK_MSG( !wxPendingDelete.Member(this), false,
+                 wxS("Shouldn't destroy the popup twice.") );
+
+    wxPendingDelete.Append(this);
+
+    return true;
+}
+
 void wxPopupTransientWindow::Dismiss()
 {
     Hide();
@@ -388,15 +426,7 @@ bool wxPopupTransientWindow::ProcessLeftDown(wxMouseEvent& WXUNUSED(event))
     return false;
 }
 
-void wxPopupTransientWindow::OnDestroy(wxWindowDestroyEvent& event)
-{
-    if (event.GetEventObject() == m_child)
-        m_child = NULL;
-    if (event.GetEventObject() == m_focus)
-        m_focus = NULL;
-}
-
-#ifdef __WXMSW__
+#if defined(__WXMSW__) ||(defined(__WXMAC__) && wxOSX_USE_CARBON)
 void wxPopupTransientWindow::OnIdle(wxIdleEvent& event)
 {
     event.Skip();
@@ -406,7 +436,7 @@ void wxPopupTransientWindow::OnIdle(wxIdleEvent& event)
         wxPoint pos = ScreenToClient(wxGetMousePosition());
         wxRect rect(GetSize());
 
-        if ( rect.Inside(pos) )
+        if ( rect.Contains(pos) )
         {
             if ( m_child->HasCapture() )
             {
@@ -419,10 +449,10 @@ void wxPopupTransientWindow::OnIdle(wxIdleEvent& event)
             {
                 m_child->CaptureMouse();
             }
-        }                
+        }
     }
 }
-#endif
+#endif // wxOSX/Carbon
 
 
 #if wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
@@ -435,13 +465,13 @@ BEGIN_EVENT_TABLE(wxPopupComboWindow, wxPopupTransientWindow)
     EVT_KEY_DOWN(wxPopupComboWindow::OnKeyDown)
 END_EVENT_TABLE()
 
-wxPopupComboWindow::wxPopupComboWindow(wxComboControl *parent)
+wxPopupComboWindow::wxPopupComboWindow(wxComboCtrl *parent)
                   : wxPopupTransientWindow(parent)
 {
     m_combo = parent;
 }
 
-bool wxPopupComboWindow::Create(wxComboControl *parent)
+bool wxPopupComboWindow::Create(wxComboCtrl *parent)
 {
     m_combo = parent;
 
@@ -469,12 +499,12 @@ void wxPopupComboWindow::PositionNearCombo()
 
 void wxPopupComboWindow::OnDismiss()
 {
-    m_combo->OnDismiss();
+    m_combo->OnPopupDismiss(true);
 }
 
 void wxPopupComboWindow::OnKeyDown(wxKeyEvent& event)
 {
-    m_combo->ProcessEvent(event);
+    m_combo->ProcessWindowEvent(event);
 }
 
 #endif // wxUSE_COMBOBOX && defined(__WXUNIVERSAL__)
@@ -482,11 +512,6 @@ void wxPopupComboWindow::OnKeyDown(wxKeyEvent& event)
 // ----------------------------------------------------------------------------
 // wxPopupWindowHandler
 // ----------------------------------------------------------------------------
-wxPopupWindowHandler::~wxPopupWindowHandler()
-{
-    if (m_popup && (m_popup->m_handlerPopup == this))
-        m_popup->m_handlerPopup = NULL;
-}
 
 void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
 {
@@ -499,8 +524,11 @@ void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
 
     wxPoint pos = event.GetPosition();
 
-    // scrollbar on which the click occured
+    // in non-Univ ports the system manages scrollbars for us
+#if defined(__WXUNIVERSAL__) && wxUSE_SCROLLBAR
+    // scrollbar on which the click occurred
     wxWindow *sbar = NULL;
+#endif // __WXUNIVERSAL__ && wxUSE_SCROLLBAR
 
     wxWindow *win = (wxWindow *)event.GetEventObject();
 
@@ -520,20 +548,20 @@ void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
                 // dismissing a tooltip shouldn't waste a click, i.e. you
                 // should be able to dismiss it and press the button with the
                 // same click, so repost this event to the window beneath us
-                wxWindow *win = wxFindWindowAtPoint(event2.GetPosition());
-                if ( win )
+                wxWindow *winUnder = wxFindWindowAtPoint(event2.GetPosition());
+                if ( winUnder )
                 {
                     // translate the event coords to the ones of the window
                     // which is going to get the event
-                    win->ScreenToClient(&event2.m_x, &event2.m_y);
+                    winUnder->ScreenToClient(&event2.m_x, &event2.m_y);
 
-                    event2.SetEventObject(win);
-                    wxPostEvent(win, event2);
+                    event2.SetEventObject(winUnder);
+                    wxPostEvent(winUnder->GetEventHandler(), event2);
                 }
             }
             break;
 
-#ifdef __WXUNIVERSAL__
+#if defined(__WXUNIVERSAL__) && wxUSE_SCROLLBAR
         case wxHT_WINDOW_HORZ_SCROLLBAR:
             sbar = win->GetScrollbar(wxHORIZONTAL);
             break;
@@ -541,11 +569,11 @@ void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
         case wxHT_WINDOW_VERT_SCROLLBAR:
             sbar = win->GetScrollbar(wxVERTICAL);
             break;
-#endif
+#endif // __WXUNIVERSAL__ && wxUSE_SCROLLBAR
 
         default:
             // forgot to update the switch after adding a new hit test code?
-            wxFAIL_MSG( _T("unexpected HitTest() return value") );
+            wxFAIL_MSG( wxT("unexpected HitTest() return value") );
             // fall through
 
         case wxHT_WINDOW_CORNER:
@@ -558,6 +586,7 @@ void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
             break;
     }
 
+#if defined(__WXUNIVERSAL__) && wxUSE_SCROLLBAR
     if ( sbar )
     {
         // translate the event coordinates to the scrollbar ones
@@ -570,16 +599,21 @@ void wxPopupWindowHandler::OnLeftDown(wxMouseEvent& event)
 
         (void)sbar->GetEventHandler()->ProcessEvent(event2);
     }
+#endif // __WXUNIVERSAL__ && wxUSE_SCROLLBAR
+}
+
+void
+wxPopupWindowHandler::OnCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
+{
+    m_popup->DismissAndNotify();
+
+    // There is no need to skip the event here, normally we've already dealt
+    // with the focus loss.
 }
 
 // ----------------------------------------------------------------------------
 // wxPopupFocusHandler
 // ----------------------------------------------------------------------------
-wxPopupFocusHandler::~wxPopupFocusHandler()
-{
-    if (m_popup && (m_popup->m_handlerFocus == this))
-        m_popup->m_handlerFocus = NULL;
-}
 
 void wxPopupFocusHandler::OnKillFocus(wxFocusEvent& event)
 {
@@ -596,10 +630,20 @@ void wxPopupFocusHandler::OnKillFocus(wxFocusEvent& event)
     m_popup->DismissAndNotify();
 }
 
-void wxPopupFocusHandler::OnKeyDown(wxKeyEvent& event)
+void wxPopupFocusHandler::OnChar(wxKeyEvent& event)
 {
+    // we can be associated with the popup itself in which case we should avoid
+    // infinite recursion
+    static int s_inside;
+    wxRecursionGuard guard(s_inside);
+    if ( guard.IsInside() )
+    {
+        event.Skip();
+        return;
+    }
+
     // let the window have it first, it might process the keys
-    if ( !m_popup->ProcessEvent(event) )
+    if ( !m_popup->GetEventHandler()->ProcessEvent(event) )
     {
         // by default, dismiss the popup
         m_popup->DismissAndNotify();
@@ -607,4 +651,3 @@ void wxPopupFocusHandler::OnKeyDown(wxKeyEvent& event)
 }
 
 #endif // wxUSE_POPUPWIN
-