]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/splitter.cpp
Fix broken and missing DataView interface items for Phoenix
[wxWidgets.git] / src / generic / splitter.cpp
index d0ac066eee8714ce418735b1d8dfe81cc8a60fbd..77b246750c3643997b0c2d16a34f3586e0c1b478 100644 (file)
 
 #include <stdlib.h>
 
-wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, wxSplitterEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, wxSplitterEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, wxSplitterEvent )
-wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_UNSPLIT, wxSplitterEvent )
+wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, wxSplitterEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, wxSplitterEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, wxSplitterEvent );
+wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_UNSPLIT, wxSplitterEvent );
 
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
 
@@ -61,15 +61,25 @@ BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow)
     EVT_PAINT(wxSplitterWindow::OnPaint)
     EVT_SIZE(wxSplitterWindow::OnSize)
     EVT_MOUSE_EVENTS(wxSplitterWindow::OnMouseEvent)
+    EVT_MOUSE_CAPTURE_LOST(wxSplitterWindow::OnMouseCaptureLost)
 
 #if defined( __WXMSW__ ) || defined( __WXMAC__)
     EVT_SET_CURSOR(wxSplitterWindow::OnSetCursor)
 #endif // wxMSW
-
-    WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow)
 END_EVENT_TABLE()
 
-WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow, wxWindow)
+static bool IsLive(wxSplitterWindow* wnd)
+{
+    // with wxSP_LIVE_UPDATE style the splitter windows are always resized
+    // following the mouse movement while it drags the sash, without it we only
+    // draw the sash at the new position but only resize the windows when the
+    // dragging is finished
+#if defined( __WXMAC__ ) && defined(TARGET_API_MAC_OSX) && TARGET_API_MAC_OSX == 1
+    return true; // Mac can't paint outside paint event - always need live mode
+#else
+    return wnd->HasFlag(wxSP_LIVE_UPDATE);
+#endif
+}
 
 bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
                                    const wxPoint& pos,
@@ -80,22 +90,10 @@ bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
     // allow TABbing from one window to the other
     style |= wxTAB_TRAVERSAL;
 
-    // we draw our border ourselves to blend the sash with it
-    style &= ~wxBORDER_MASK;
-    style |= wxBORDER_NONE;
-
-#ifdef __WXMAC__
-    // CoreGraphics can't paint sash feedback
-    style |= wxSP_LIVE_UPDATE;
-#endif
-
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
         return false;
 
-    if (size.x >= 0)
-        m_lastSize.x = size.x;
-    if (size.y >= 0)
-        m_lastSize.y = size.y;
+    m_lastSize = GetClientSize();
 
     m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
 
@@ -112,8 +110,6 @@ bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
 
 void wxSplitterWindow::Init()
 {
-    WX_INIT_CONTROL_CONTAINER();
-
     m_splitMode = wxSPLIT_VERTICAL;
     m_permitUnsplitAlways = true;
     m_windowOne = NULL;
@@ -121,13 +117,11 @@ void wxSplitterWindow::Init()
     m_dragMode = wxSPLIT_DRAG_NONE;
     m_oldX = 0;
     m_oldY = 0;
-    m_firstX = 0;
-    m_firstY = 0;
-    m_sashPosition = m_requestedSashPosition = 0;
+    m_sashStart = 0;
+    m_sashPosition = 0;
+    m_requestedSashPosition = INT_MAX;
     m_sashGravity = 0.0;
-    m_sashSize = -1; // -1 means use the native sash size
     m_lastSize = wxSize(0,0);
-    m_checkRequestedSashPosition = false;
     m_minimumPaneSize = 0;
     m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
     m_sashCursorNS = wxCursor(wxCURSOR_SIZENS);
@@ -185,6 +179,12 @@ void wxSplitterWindow::SetResizeCursor()
 void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 {
     wxPaintDC dc(this);
+#ifdef __WXOSX__
+    // as subpanels might have a transparent background we must erase the background
+    // at least on OSX, otherwise traces of the sash will remain
+    // test with: splitter sample->replace right window
+    dc.Clear();
+#endif
 
     DrawSash(dc);
 }
@@ -193,17 +193,21 @@ void wxSplitterWindow::OnInternalIdle()
 {
     wxWindow::OnInternalIdle();
 
-    // if this is the first idle time after a sash position has potentially
-    // been set, allow SizeWindows to check for a requested size.
-    if (!m_checkRequestedSashPosition)
+    // We may need to update the children sizes in two cases: either because
+    // we're in the middle of a live update as indicated by m_needUpdating or
+    // because we have a requested but not yet set sash position as indicated
+    // by m_requestedSashPosition having a valid value.
+    if ( m_needUpdating )
     {
-        m_checkRequestedSashPosition = true;
-        SizeWindows();
-        return; // it won't needUpdating in this case
+        m_needUpdating = false;
+    }
+    else if ( m_requestedSashPosition == INT_MAX )
+    {
+        // We don't need to resize the children.
+        return;
     }
 
-    if (m_needUpdating)
-        SizeWindows();
+    SizeWindows();
 }
 
 void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
@@ -211,20 +215,14 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
     int x = (int)event.GetX(),
         y = (int)event.GetY();
 
-    if (GetWindowStyle() & wxSP_NOSASH)
+    if ( GetWindowStyle() & wxSP_NOSASH )
+    {
+        event.Skip();
         return;
+    }
+
+    bool isLive = IsLive(this);
 
-    // with wxSP_LIVE_UPDATE style the splitter windows are always resized
-    // following the mouse movement while it drags the sash, without it we only
-    // draw the sash at the new position but only resize the windows when the
-    // dragging is finished
-#if defined( __WXMAC__ )
-    // FIXME : this should be usable also with no live update, but then this
-    // currently is not visible
-    bool isLive = true;
-#else
-    bool isLive = HasFlag(wxSP_LIVE_UPDATE);
-#endif
     if (event.LeftDown())
     {
         if ( SashHitTest(x, y) )
@@ -242,13 +240,13 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
                 // shadow sash
                 m_sashPositionCurrent = m_sashPosition;
 
-                DrawSashTracker(x, y);
+                m_oldX = (m_splitMode == wxSPLIT_VERTICAL ? m_sashPositionCurrent : x);
+                m_oldY = (m_splitMode != wxSPLIT_VERTICAL ? m_sashPositionCurrent : y);
+                DrawSashTracker(m_oldX, m_oldY);
             }
 
-            m_oldX = x;
-            m_oldY = y;
-
-            SetResizeCursor();
+            m_ptStart = wxPoint(x,y);
+            m_sashStart = m_sashPosition;
             return;
         }
     }
@@ -276,10 +274,9 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
         // the position of the click doesn't exactly correspond to
         // m_sashPosition, rather it changes it by the distance by which the
         // mouse has moved
-        int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY;
+        int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_ptStart.x : y - m_ptStart.y;
 
-        int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent;
-        int posSashNew = OnSashPositionChanging(posSashOld + diff);
+        int posSashNew = OnSashPositionChanging(m_sashStart + diff);
         if ( posSashNew == -1 )
         {
             // change not allowed
@@ -333,62 +330,53 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
     }
     else if (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING))
     {
-        int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY;
-        if ( !diff )
-        {
-            // nothing to do, mouse didn't really move far enough
-            return;
-        }
+        int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_ptStart.x : y - m_ptStart.y;
 
-        int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent;
-        int posSashNew = OnSashPositionChanging(posSashOld + diff);
+        int posSashNew = OnSashPositionChanging(m_sashStart + diff);
         if ( posSashNew == -1 )
         {
             // change not allowed
             return;
         }
 
-        if ( posSashNew == m_sashPosition )
-            return;
-
-        // Erase old tracker
         if ( !isLive )
         {
-            DrawSashTracker(m_oldX, m_oldY);
-        }
+            if ( posSashNew == m_sashPositionCurrent )
+                return;
 
-        if (m_splitMode == wxSPLIT_VERTICAL)
-            x = posSashNew;
-        else
-            y = posSashNew;
+            m_sashPositionCurrent = posSashNew;
+
+            // Erase old tracker
+            DrawSashTracker(m_oldX, m_oldY);
 
-        // Remember old positions
-        m_oldX = x;
-        m_oldY = y;
+            m_oldX = (m_splitMode == wxSPLIT_VERTICAL ? m_sashPositionCurrent : x);
+            m_oldY = (m_splitMode != wxSPLIT_VERTICAL ? m_sashPositionCurrent : y);
 
 #ifdef __WXMSW__
-        // As we captured the mouse, we may get the mouse events from outside
-        // our window - for example, negative values in x, y. This has a weird
-        // consequence under MSW where we use unsigned values sometimes and
-        // signed ones other times: the coordinates turn as big positive
-        // numbers and so the sash is drawn on the *right* side of the window
-        // instead of the left (or bottom instead of top). Correct this.
-        if ( (short)m_oldX < 0 )
-            m_oldX = 0;
-        if ( (short)m_oldY < 0 )
-            m_oldY = 0;
+            // As we captured the mouse, we may get the mouse events from outside
+            // our window - for example, negative values in x, y. This has a weird
+            // consequence under MSW where we use unsigned values sometimes and
+            // signed ones other times: the coordinates turn as big positive
+            // numbers and so the sash is drawn on the *right* side of the window
+            // instead of the left (or bottom instead of top). Correct this.
+            if ( (short)m_oldX < 0 )
+                m_oldX = 0;
+            if ( (short)m_oldY < 0 )
+                m_oldY = 0;
 #endif // __WXMSW__
 
-        // Draw new one
-        if ( !isLive )
-        {
-            m_sashPositionCurrent = posSashNew;
-
+            // Draw new one
             DrawSashTracker(m_oldX, m_oldY);
         }
         else
         {
+            if ( posSashNew == m_sashPosition )
+                return;
+
             DoSetSashPosition(posSashNew);
+
+            // in live mode, the new position is the actual sash position, clear requested position!
+            m_requestedSashPosition = INT_MAX;
             m_needUpdating = true;
         }
     }
@@ -396,6 +384,26 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
     {
         OnDoubleClickSash(x, y);
     }
+    else
+    {
+        event.Skip();
+    }
+}
+
+void wxSplitterWindow::OnMouseCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
+{
+    if (m_dragMode != wxSPLIT_DRAG_DRAGGING)
+        return;
+
+    m_dragMode = wxSPLIT_DRAG_NONE;
+
+    SetCursor(* wxSTANDARD_CURSOR);
+
+    // Erase old tracker
+    if ( !IsLive(this) )
+    {
+        DrawSashTracker(m_oldX, m_oldY);
+    }
 }
 
 void wxSplitterWindow::OnSize(wxSizeEvent& event)
@@ -427,38 +435,51 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
         return;
     }
 
-    if ( m_windowTwo )
-    {
-        int w, h;
-        GetClientSize(&w, &h);
+    const wxSize curSize = event.GetSize();
 
-        int size = m_splitMode == wxSPLIT_VERTICAL ? w : h;
+    // Update the sash position if needed.
+    //
+    // Notice that we shouldn't do this if the sash position requested by user
+    // couldn't be set yet as it would never be taken into account at all if we
+    // modified it before this happens.
+    if ( m_windowTwo && m_requestedSashPosition == INT_MAX )
+    {
+        int size = m_splitMode == wxSPLIT_VERTICAL ? curSize.x : curSize.y;
 
         int old_size = m_splitMode == wxSPLIT_VERTICAL ? m_lastSize.x : m_lastSize.y;
-        if ( old_size != 0 )
+
+        // Don't do anything if the size didn't really change.
+        if ( size != old_size )
         {
+            int newPosition = -1;
+
+            // Apply gravity if we use it.
             int delta = (int) ( (size - old_size)*m_sashGravity );
             if ( delta != 0 )
             {
-                int newPosition = m_sashPosition + delta;
+                newPosition = m_sashPosition + delta;
                 if( newPosition < m_minimumPaneSize )
                     newPosition = m_minimumPaneSize;
-                SetSashPositionAndNotify(newPosition);
             }
-        }
 
-        if ( m_sashPosition >= size - 5 )
-            SetSashPositionAndNotify(wxMax(10, size - 40));
-        m_lastSize = wxSize(w,h);
+            // Also check if the second window became too small.
+            newPosition = AdjustSashPosition(newPosition == -1
+                                                 ? m_sashPosition
+                                                 : newPosition);
+            if ( newPosition != m_sashPosition )
+                SetSashPositionAndNotify(newPosition);
+        }
     }
 
+    m_lastSize = curSize;
+
     SizeWindows();
 }
 
 void wxSplitterWindow::SetSashGravity(double gravity)
 {
     wxCHECK_RET( gravity >= 0. && gravity <= 1.,
-                    _T("invalid gravity value") );
+                    wxT("invalid gravity value") );
 
     m_sashGravity = gravity;
 }
@@ -475,9 +496,20 @@ bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
     return z >=  hitMin && z <= hitMax;
 }
 
+void wxSplitterWindow::SetSashInvisible(bool invisible)
+{
+    if ( IsSashInvisible() != invisible )
+        ToggleWindowStyle(wxSP_NOSASH);
+}
+
 int wxSplitterWindow::GetSashSize() const
 {
-    return m_sashSize > -1 ? m_sashSize : wxRendererNative::Get().GetSplitterParams(this).widthSash;
+    return IsSashInvisible() ? 0 : GetDefaultSashSize();
+}
+
+int wxSplitterWindow::GetDefaultSashSize() const
+{
+    return wxRendererNative::Get().GetSplitterParams(this).widthSash;
 }
 
 int wxSplitterWindow::GetBorderSize() const
@@ -501,7 +533,7 @@ void wxSplitterWindow::DrawSash(wxDC& dc)
         return;
 
     // nor if we're configured to not show it
-    if ( HasFlag(wxSP_NOSASH) )
+    if ( IsSashInvisible() )
         return;
 
     wxRendererNative::Get().DrawSplitterSash
@@ -528,33 +560,15 @@ void wxSplitterWindow::DrawSashTracker(int x, int y)
 
     if ( m_splitMode == wxSPLIT_VERTICAL )
     {
-        x1 = x; y1 = 2;
-        x2 = x; y2 = h-2;
-
-        if ( x1 > w )
-        {
-            x1 = w; x2 = w;
-        }
-        else if ( x1 < 0 )
-        {
-            x1 = 0; x2 = 0;
-        }
+        x1 = x2 = wxClip(x, 0, w) + m_sashTrackerPen->GetWidth()/2;
+        y1 = 2;
+        y2 = h-2;
     }
     else
     {
-        x1 = 2; y1 = y;
-        x2 = w-2; y2 = y;
-
-        if ( y1 > h )
-        {
-            y1 = h;
-            y2 = h;
-        }
-        else if ( y1 < 0 )
-        {
-            y1 = 0;
-            y2 = 0;
-        }
+        y1 = y2 = wxClip(y, 0, h) + m_sashTrackerPen->GetWidth()/2;
+        x1 = 2;
+        x2 = w-2;
     }
 
     ClientToScreen(&x1, &y1);
@@ -607,7 +621,7 @@ int wxSplitterWindow::AdjustSashPosition(int sashPos) const
             minSize = m_minimumPaneSize;
 
         int maxSize = GetWindowSize() - minSize - GetBorderSize() - GetSashSize();
-        if ( maxSize > 0 && sashPos > maxSize )
+        if ( maxSize > 0 && sashPos > maxSize && maxSize >= m_minimumPaneSize)
             sashPos = maxSize;
     }
 
@@ -651,7 +665,7 @@ void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
 void wxSplitterWindow::SizeWindows()
 {
     // check if we have delayed setting the real sash position
-    if ( m_checkRequestedSashPosition && m_requestedSashPosition != INT_MAX )
+    if ( m_requestedSashPosition != INT_MAX )
     {
         int newSashPosition = ConvertSashPosition(m_requestedSashPosition);
         if ( newSashPosition != m_sashPosition )
@@ -717,15 +731,13 @@ void wxSplitterWindow::SizeWindows()
 
     wxClientDC dc(this);
     DrawSash(dc);
-
-    SetNeedUpdating(false);
 }
 
 // Set pane for unsplit window
 void wxSplitterWindow::Initialize(wxWindow *window)
 {
     wxASSERT_MSG( (!window || window->GetParent() == this),
-                  _T("windows in the splitter should have it as parent!") );
+                  wxT("windows in the splitter should have it as parent!") );
 
     if (window && !window->IsShown())
         window->Show();
@@ -746,10 +758,10 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode,
         return false;
 
     wxCHECK_MSG( window1 && window2, false,
-                 _T("can not split with NULL window(s)") );
+                 wxT("cannot split with NULL window(s)") );
 
     wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
-                  _T("windows in the splitter should have it as parent!") );
+                  wxT("windows in the splitter should have it as parent!") );
 
     if (! window1->IsShown())
         window1->Show();
@@ -760,15 +772,8 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode,
     m_windowOne = window1;
     m_windowTwo = window2;
 
-    // remember the sash position we want to set for later if we can't set it
-    // right now (e.g. because the window is too small)
-    m_requestedSashPosition = sashPosition;
-    m_checkRequestedSashPosition = false;
-
-    DoSetSashPosition(ConvertSashPosition(sashPosition));
-
-    SizeWindows();
 
+    SetSashPosition(sashPosition, true);
     return true;
 }
 
@@ -861,7 +866,6 @@ void wxSplitterWindow::SetSashPosition(int position, bool redraw)
     // remember the sash position we want to set for later if we can't set it
     // right now (e.g. because the window is too small)
     m_requestedSashPosition = position;
-    m_checkRequestedSashPosition = false;
 
     DoSetSashPosition(ConvertSashPosition(position));
 
@@ -876,9 +880,7 @@ void wxSplitterWindow::SetSashPosition(int position, bool redraw)
 // window is shown, if you know the overall size is correct.
 void wxSplitterWindow::UpdateSize()
 {
-    m_checkRequestedSashPosition = true;
     SizeWindows();
-    m_checkRequestedSashPosition = false;
 }
 
 bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
@@ -917,9 +919,12 @@ wxSize wxSplitterWindow::DoGetBestSize() const
         pSash = &sizeBest.y;
     }
 
-    // account for the border and the sash
+    // account for the sash if the window is actually split
+    if ( m_windowOne && m_windowTwo )
+        *pSash += GetSashSize();
+
+    // account for the border too
     int border = 2*GetBorderSize();
-    *pSash += GetSashSize();
     sizeBest.x += border;
     sizeBest.y += border;
 
@@ -973,12 +978,12 @@ int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
     {
         // If resultant pane would be too small, enlarge it
         newSashPosition = AdjustSashPosition(newSashPosition);
-    }
 
-    // If the result is out of bounds it means minimum size is too big,
-    // so split window in half as best compromise.
-    if ( newSashPosition < 0 || newSashPosition > window_size )
-        newSashPosition = window_size / 2;
+        // If the result is out of bounds it means minimum size is too big,
+        // so split window in half as best compromise.
+        if ( newSashPosition < 0 || newSashPosition > window_size )
+            newSashPosition = window_size / 2;
+    }
 
     // now let the event handler have it
     //