]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/scrlwing.cpp
ignore clicks on a toolbar but outside any button
[wxWidgets.git] / src / generic / scrlwing.cpp
index 862172c5593fa50f5244af4a0533a133fb9b7820..cf18c3bf8c85016308642174b75157b03126e8e5 100644 (file)
@@ -64,7 +64,7 @@ IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
 // them to wxScrollHelper
 // ----------------------------------------------------------------------------
 
-class wxScrollHelperEvtHandler : public wxEvtHandler
+class WXDLLEXPORT wxScrollHelperEvtHandler : public wxEvtHandler
 {
 public:
     wxScrollHelperEvtHandler(wxScrollHelper *scrollHelper)
@@ -74,8 +74,12 @@ public:
 
     virtual bool ProcessEvent(wxEvent& event);
 
+    void ResetDrawnFlag() { m_hasDrawnWindow = FALSE; }
+
 private:
     wxScrollHelper *m_scrollHelper;
+
+    bool m_hasDrawnWindow;
 };
 
 // ----------------------------------------------------------------------------
@@ -168,16 +172,53 @@ void wxAutoScrollTimer::Notify()
 bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
 {
     wxEventType evType = event.GetEventType();
-    
-    if ( evType == wxEVT_SIZE )  // Don't let wxPanel catch the size events. RR.
+
+    // the explanation of wxEVT_PAINT processing hack: for historic reasons
+    // there are 2 ways to process this event in classes deriving from
+    // wxScrolledWindow. The user code may
+    //
+    //  1. override wxScrolledWindow::OnDraw(dc)
+    //  2. define its own OnPaint() handler
+    //
+    // In addition, in wxUniversal wxWindow defines OnPaint() itself and
+    // always processes the draw event, so we can't just try the window
+    // OnPaint() first and call our HandleOnPaint() if it doesn't process it
+    // (the latter would never be called in wxUniversal).
+    //
+    // So the solution is to have a flag telling us whether the user code drew
+    // anything in the window. We set it to true here but reset it to false in
+    // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
+    // user code defined OnPaint() in the derived class)
+    m_hasDrawnWindow = TRUE;
+
+    // pass it on to the real handler
+    bool processed = wxEvtHandler::ProcessEvent(event);
+
+    // always process the size events ourselves, even if the user code handles
+    // them as well, as we need to AdjustScrollbars()
+    //
+    // NB: it is important to do it after processing the event in the normal
+    //     way as HandleOnSize() may generate a wxEVT_SIZE itself if the
+    //     scrollbar[s] (dis)appear and it should be seen by the user code
+    //     after this one
+    if ( evType == wxEVT_SIZE )
     {
         m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
+
         return TRUE;
     }
-    
-    if ( wxEvtHandler::ProcessEvent(event) )
-        return TRUE;
-        
+
+    if ( processed )
+    {
+        // normally, nothing more to do here - except if it was a paint event
+        // which wasn't really processed, then we'll try to call our
+        // OnDraw() below (from HandleOnPaint)
+        if ( m_hasDrawnWindow )
+        {
+            return TRUE;
+        }
+    }
+
     // reset the skipped flag to FALSE as it might have been set to TRUE in
     // ProcessEvent() above
     event.Skip(FALSE);
@@ -253,27 +294,17 @@ wxScrollHelper::wxScrollHelper(wxWindow *win)
 
     m_timerAutoScroll = (wxTimer *)NULL;
 
+    m_handler = NULL;
+
     if ( win )
         SetWindow(win);
 }
 
-void wxScrollHelper::SetWindow(wxWindow *win)
-{
-    wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
-
-    m_targetWindow = m_win = win;
-
-    // install the event handler which will intercept the events we're
-    // interested in
-    m_win->PushEventHandler(new wxScrollHelperEvtHandler(this));
-}
-
 wxScrollHelper::~wxScrollHelper()
 {
     StopAutoScrolling();
 
-    if ( m_targetWindow )
-        m_targetWindow->PopEventHandler(TRUE /* do delete it */);
+    DeleteEvtHandler();
 }
 
 // ----------------------------------------------------------------------------
@@ -353,13 +384,60 @@ void wxScrollHelper::SetScrollbars(int pixelsPerUnitX,
 }
 
 // ----------------------------------------------------------------------------
-// target window handling
+// [target] window handling
 // ----------------------------------------------------------------------------
 
-void wxScrollHelper::SetTargetWindow( wxWindow *target )
+void wxScrollHelper::DeleteEvtHandler()
+{
+    // search for m_handler in the handler list
+    if ( m_win && m_handler )
+    {
+        if ( m_win->RemoveEventHandler(m_handler) )
+        {
+            delete m_handler;
+        }
+        //else: something is very wrong, so better [maybe] leak memory than
+        //      risk a crash because of double deletion
+
+        m_handler = NULL;
+    }
+}
+
+void wxScrollHelper::SetWindow(wxWindow *win)
+{
+    wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
+
+    m_win = win;
+
+    // by default, the associated window is also the target window
+    DoSetTargetWindow(win);
+}
+
+void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
 {
-    wxASSERT_MSG( target, wxT("target window must not be NULL") );
     m_targetWindow = target;
+
+    // install the event handler which will intercept the events we're
+    // interested in (but only do it for our real window, not the target window
+    // which we scroll - we don't need to hijack its events)
+    if ( m_targetWindow == m_win )
+    {
+        // if we already have a handler, delete it first
+        DeleteEvtHandler();
+
+        m_handler = new wxScrollHelperEvtHandler(this);
+        m_targetWindow->PushEventHandler(m_handler);
+    }
+}
+
+void wxScrollHelper::SetTargetWindow(wxWindow *target)
+{
+    wxCHECK_RET( target, wxT("target window must not be NULL") );
+
+    if ( target == m_targetWindow )
+        return;
+
+    DoSetTargetWindow(target);
 }
 
 wxWindow *wxScrollHelper::GetTargetWindow() const
@@ -386,12 +464,12 @@ void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
     if (orient == wxHORIZONTAL)
     {
         m_xScrollPosition += nScrollInc;
-        m_targetWindow->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
+        m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
     }
     else
     {
         m_yScrollPosition += nScrollInc;
-        m_targetWindow->SetScrollPos(wxVERTICAL, m_yScrollPosition);
+        m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
     }
 
     bool needsRefresh = FALSE;
@@ -556,14 +634,14 @@ void wxScrollHelper::AdjustScrollbars()
         m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition);
         m_xScrollPosition = wxMax( 0, m_xScrollPosition );
 
-        m_targetWindow->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
+        m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
         // The amount by which we scroll when paging
         SetScrollPageSize(wxHORIZONTAL, noPagePositions);
     }
     else
     {
         m_xScrollPosition = 0;
-        m_targetWindow->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
+        m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
     }
 
     if (m_yScrollLines > 0)
@@ -580,14 +658,14 @@ void wxScrollHelper::AdjustScrollbars()
         m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
         m_yScrollPosition = wxMax( 0, m_yScrollPosition );
 
-        m_targetWindow->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
+        m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition, noPagePositions, m_yScrollLines);
         // The amount by which we scroll when paging
         SetScrollPageSize(wxVERTICAL, noPagePositions);
     }
     else
     {
         m_yScrollPosition = 0;
-        m_targetWindow->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
+        m_win->SetScrollbar (wxVERTICAL, 0, 0, 0, FALSE);
     }
 
     if (oldXScroll != m_xScrollPosition)
@@ -679,7 +757,7 @@ void wxScrollHelper::Scroll( int x_pos, int y_pos )
         m_xScrollPosition = wxMax( 0, m_xScrollPosition );
 
         if (old_x != m_xScrollPosition) {
-            m_targetWindow->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
+            m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
             m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
                                           GetRect() );
         }
@@ -700,7 +778,7 @@ void wxScrollHelper::Scroll( int x_pos, int y_pos )
         m_yScrollPosition = wxMax( 0, m_yScrollPosition );
 
         if (old_y != m_yScrollPosition) {
-            m_targetWindow->SetScrollPos( wxVERTICAL, m_yScrollPosition );
+            m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
             m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
                                           GetRect() );
         }
@@ -759,8 +837,8 @@ void wxScrollHelper::CalcUnscrolledPosition(int x, int y, int *xx, int *yy) cons
 void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
 {
 #if wxUSE_CONSTRAINTS
-    if ( m_targetWindow->GetAutoLayout() )
-        m_targetWindow->Layout();
+    if ( m_win->GetAutoLayout() )
+        m_win->Layout();
 #endif
 
     AdjustScrollbars();
@@ -770,7 +848,8 @@ void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
 // scroll position
 void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
 {
-    wxPaintDC dc(m_targetWindow);
+    // don't use m_targetWindow here, this is always called for ourselves
+    wxPaintDC dc(m_win);
     DoPrepareDC(dc);
 
     OnDraw(dc);
@@ -979,9 +1058,24 @@ void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
     {
         lines *= event.GetLinesPerAction();
 
-        int vsx, vsy;
-        GetViewStart(&vsx, &vsy);
-        Scroll(-1, vsy - lines);
+        wxScrollWinEvent newEvent;
+
+        newEvent.SetPosition(0);
+        newEvent.SetOrientation(wxVERTICAL);
+        newEvent.m_eventObject = m_win;
+        if (lines > 0)
+            newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
+        else
+            newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
+
+        int times = abs(lines);
+        for (; times > 0; times --)
+            m_win->GetEventHandler()->ProcessEvent(newEvent);
+
+        /* Old Way */
+        // int vsx, vsy;
+        // GetViewStart(&vsx, &vsy);
+        // Scroll(-1, vsy - lines);
     }
 }
 
@@ -993,6 +1087,10 @@ void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
 
 IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
 
+BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
+    EVT_PAINT(wxGenericScrolledWindow::OnPaint)
+END_EVENT_TABLE()
+
 bool wxGenericScrolledWindow::Create(wxWindow *parent,
                               wxWindowID id,
                               const wxPoint& pos,
@@ -1004,11 +1102,6 @@ bool wxGenericScrolledWindow::Create(wxWindow *parent,
 
     bool ok = wxPanel::Create(parent, id, pos, size, style, name);
 
-#ifdef __WXMSW__
-    // we need to process arrows ourselves for scrolling
-    m_lDlgCode |= DLGC_WANTARROWS;
-#endif // __WXMSW__
-
     return ok;
 }
 
@@ -1016,7 +1109,36 @@ wxGenericScrolledWindow::~wxGenericScrolledWindow()
 {
 }
 
+void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
+{
+    // the user code didn't really draw the window if we got here, so set this
+    // flag to try to call OnDraw() later
+    m_handler->ResetDrawnFlag();
+
+    event.Skip();
+}
+
+#ifdef __WXMSW__
+long
+wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
+                                       WXWPARAM wParam,
+                                       WXLPARAM lParam)
+{
+    long rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);
+
+    // we need to process arrows ourselves for scrolling
+    if ( nMsg == WM_GETDLGCODE )
+    {
+        rc |= DLGC_WANTARROWS;
+    }
+
+    return rc;
+}
+
+#endif // __WXMSW__
+
 #if WXWIN_COMPATIBILITY
+
 void wxGenericScrolledWindow::GetScrollUnitsPerPage (int *x_page, int *y_page) const
 {
       *x_page = GetScrollPageSize(wxHORIZONTAL);
@@ -1030,6 +1152,7 @@ void wxGenericScrolledWindow::CalcUnscrolledPosition(int x, int y, float *xx, fl
     if ( yy )
         *yy = (float)(y + m_yScrollPosition * m_yScrollPixelsPerLine);
 }
+
 #endif // WXWIN_COMPATIBILITY
 
 #endif // !wxGTK