Delay checking for the requested sash position until the first

OnInternalIdle after it is set.

TRUE/FALSE --> true/false

Fixed a bug that allowed the sash cursor to be shown the the pointer
is not quite on the sash yet.


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

include/wx/generic/splitter.h

@@ -108,7 +108,7 @@ public:
 
     // Associates the given window with window 2, drawing the appropriate sash
     // and changing the split mode.
-    // Does nothing and returns FALSE if the window is already split.
+    // Does nothing and returns false if the window is already split.
     // A sashPosition of 0 means choose a default sash position,
     // negative sashPosition specifies the size of right/lower pane as it's
     // absolute value rather than the size of left/upper pane.
@@ -145,7 +145,7 @@ public:
     int GetBorderSize() const;
 
     // Set the sash position
-    void SetSashPosition(int position, bool redraw = TRUE);
+    void SetSashPosition(int position, bool redraw = true);
 
     // Gets the sash position
     int GetSashPosition() const { return m_sashPosition; }
@@ -162,7 +162,7 @@ public:
     virtual int OnSashPositionChanging(int newSashPosition);
 
     // Called when the sash position is about to be changed, return
-    // FALSE from here to prevent the change from taking place.
+    // false from here to prevent the change from taking place.
     // Repositions sash to minimum position if pane would be too small.
     // newSashPosition here is always positive or zero.
     virtual bool OnSashPositionChange(int newSashPosition);
@@ -213,7 +213,7 @@ protected:
     void OnSetCursor(wxSetCursorEvent& event);
 #endif // wxMSW
 
-    // send the given event, return FALSE if the event was processed and vetoed
+    // send the given event, return false if the event was processed and vetoed
     // by the user code
     inline bool DoSendEvent(wxSplitterEvent& event);
 
@@ -239,7 +239,7 @@ protected:
 
     // set the real sash position, sashPos here must be positive
     //
-    // returns TRUE if the sash position has been changed, FALSE otherwise
+    // returns true if the sash position has been changed, false otherwise
     bool DoSetSashPosition(int sashPos);
 
     // set the sash position and send an event about it having been changed
@@ -272,10 +272,11 @@ protected:
     wxCursor    m_sashCursorNS;
     wxPen      *m_sashTrackerPen;
 
-    // when in live mode, set this to TRUE to resize children in idle
+    // when in live mode, set this to true to resize children in idle
     bool        m_needUpdating:1;
     bool        m_permitUnsplitAlways:1;
     bool        m_isHot:1;
+    bool        m_checkRequestedSashPosition:1;
 
 private:
     WX_DECLARE_CONTROL_CONTAINER();

src/generic/splitter.cpp

@@ -88,11 +88,11 @@ bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
     style |= wxBORDER_NONE;
 
     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
-        return FALSE;
+        return false;
 
     m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
 
-    return TRUE;
+    return true;
 }
 
 void wxSplitterWindow::Init()
@@ -100,7 +100,7 @@ void wxSplitterWindow::Init()
     m_container.SetContainerWindow(this);
 
     m_splitMode = wxSPLIT_VERTICAL;
-    m_permitUnsplitAlways = TRUE;
+    m_permitUnsplitAlways = true;
     m_windowOne = (wxWindow *) NULL;
     m_windowTwo = (wxWindow *) NULL;
     m_dragMode = wxSPLIT_DRAG_NONE;
@@ -109,12 +109,13 @@ void wxSplitterWindow::Init()
     m_firstX = 0;
     m_firstY = 0;
     m_sashPosition = m_requestedSashPosition = 0;
+    m_checkRequestedSashPosition = false;
     m_minimumPaneSize = 0;
     m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
     m_sashCursorNS = wxCursor(wxCURSOR_SIZENS);
     m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxSOLID);
 
-    m_needUpdating = FALSE;
+    m_needUpdating = false;
     m_isHot = false;
 }
 
@@ -174,6 +175,15 @@ 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)
+    {
+        m_checkRequestedSashPosition = true;
+        SizeWindows();
+        return; // it won't needUpdating in this case
+    }
+    
     if (m_needUpdating)
         SizeWindows();
 }
@@ -356,7 +366,7 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
         else
         {
             SetSashPositionAndNotify(posSashNew);
-            m_needUpdating = TRUE;
+            m_needUpdating = true;
         }
     }
     else if ( event.LeftDClick() && m_windowTwo )
@@ -370,12 +380,7 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
     // only process this message if we're not iconized - otherwise iconizing
     // and restoring a window containing the splitter has a funny side effect
     // of changing the splitter position!
-    wxWindow *parent = GetParent();
+    wxWindow *parent = wxGetTopLevelParent(this);
-    while ( parent && !parent->IsTopLevel() )
-    {
-        parent = parent->GetParent();
-    }
-
     bool iconized;
 
     wxTopLevelWindow *winTop = wxDynamicCast(parent, wxTopLevelWindow);
@@ -387,7 +392,7 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
     {
         wxFAIL_MSG(wxT("should have a top level parent!"));
 
-        iconized = FALSE;
+        iconized = false;
     }
 
     if ( iconized )
@@ -413,12 +418,13 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event)
 bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
 {
     if ( m_windowTwo == NULL || m_sashPosition == 0)
-        return FALSE; // No sash
+        return false; // No sash
 
     int z = m_splitMode == wxSPLIT_VERTICAL ? x : y;
+    int hitMin = m_sashPosition - tolerance;
+    int hitMax = m_sashPosition + GetSashSize() + tolerance;
     
-    return z >= m_sashPosition - tolerance &&
+    return z >=  hitMin && z <= hitMax;
-            z <= m_sashPosition + GetSashSize() + tolerance;
 }
 
 int wxSplitterWindow::GetSashSize() const
@@ -567,11 +573,11 @@ bool wxSplitterWindow::DoSetSashPosition(int sashPos)
     int newSashPosition = AdjustSashPosition(sashPos);
 
     if ( newSashPosition == m_sashPosition )
-        return FALSE;
+        return false;
 
     m_sashPosition = newSashPosition;
 
-    return TRUE;
+    return true;
 }
 
 void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
@@ -591,7 +597,7 @@ void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
 void wxSplitterWindow::SizeWindows()
 {
     // check if we have delayed setting the real sash position
-    if ( m_requestedSashPosition != INT_MAX )
+    if ( m_checkRequestedSashPosition && m_requestedSashPosition != INT_MAX )
     {
         int newSashPosition = ConvertSashPosition(m_requestedSashPosition);
         if ( newSashPosition != m_sashPosition )
@@ -650,7 +656,7 @@ void wxSplitterWindow::SizeWindows()
     wxClientDC dc(this);
     DrawSash(dc);
 
-    SetNeedUpdating(FALSE);
+    SetNeedUpdating(false);
 }
 
 // Set pane for unsplit window
@@ -666,18 +672,18 @@ void wxSplitterWindow::Initialize(wxWindow *window)
 
 // Associates the given window with window 2, drawing the appropriate sash
 // and changing the split mode.
-// Does nothing and returns FALSE if the window is already split.
+// Does nothing and returns false if the window is already split.
 bool wxSplitterWindow::DoSplit(wxSplitMode mode,
                                wxWindow *window1, wxWindow *window2,
                                int sashPosition)
 {
     if ( IsSplit() )
-        return FALSE;
+        return false;
 
-    wxCHECK_MSG( window1 && window2, FALSE,
+    wxCHECK_MSG( window1 && window2, false,
                  _T("can not split with NULL window(s)") );
 
-    wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, FALSE,
+    wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
                   _T("windows in the splitter should have it as parent!") );
 
     m_splitMode = mode;
@@ -687,12 +693,13 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode,
     // 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();
 
-    return TRUE;
+    return true;
 }
 
 int wxSplitterWindow::ConvertSashPosition(int sashPosition) const
@@ -718,7 +725,7 @@ int wxSplitterWindow::ConvertSashPosition(int sashPosition) const
 bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
 {
     if ( ! IsSplit() )
-        return FALSE;
+        return false;
 
     wxWindow *win;
     if ( toRemove == NULL || toRemove == m_windowTwo)
@@ -736,21 +743,21 @@ bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
     {
         wxFAIL_MSG(wxT("splitter: attempt to remove a non-existent window"));
 
-        return FALSE;
+        return false;
     }
 
     OnUnsplit(win);
     DoSetSashPosition(0);
     SizeWindows();
 
-    return TRUE;
+    return true;
 }
 
 // Replace a window with another one
 bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
 {
-    wxCHECK_MSG( winOld, FALSE, wxT("use one of Split() functions instead") );
+    wxCHECK_MSG( winOld, false, wxT("use one of Split() functions instead") );
-    wxCHECK_MSG( winNew, FALSE, wxT("use Unsplit() functions instead") );
+    wxCHECK_MSG( winNew, false, wxT("use Unsplit() functions instead") );
 
     if ( winOld == m_windowTwo )
     {
@@ -764,23 +771,29 @@ bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
     {
         wxFAIL_MSG(wxT("splitter: attempt to replace a non-existent window"));
 
-        return FALSE;
+        return false;
     }
 
     SizeWindows();
 
-    return TRUE;
+    return true;
 }
 
 void wxSplitterWindow::SetMinimumPaneSize(int min)
 {
     m_minimumPaneSize = min;
-    SetSashPosition(m_sashPosition); // re-check limits
+    int pos = m_requestedSashPosition != INT_MAX ? m_requestedSashPosition : m_sashPosition;
+    SetSashPosition(pos); // re-check limits
 }
 
 void wxSplitterWindow::SetSashPosition(int position, bool redraw)
 {
-    DoSetSashPosition(position);
+    // 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));
 
     if ( redraw )
     {
@@ -800,7 +813,7 @@ bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
 bool wxSplitterWindow::OnSashPositionChange(int WXUNUSED(newSashPosition))
 {
     // always allow by default
-    return TRUE;
+    return true;
 }
 
 int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
@@ -818,7 +831,7 @@ int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
     // Obtain relevant window dimension for bottom / right threshold check
     int window_size = GetWindowSize();
 
-    bool unsplit_scenario = FALSE;
+    bool unsplit_scenario = false;
     if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
     {
         // Do edge detection if unsplit premitted
@@ -826,13 +839,13 @@ int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
         {
             // threshold top / left check
             newSashPosition = 0;
-            unsplit_scenario = TRUE;
+            unsplit_scenario = true;
         }
         if ( newSashPosition >= window_size - UNSPLIT_THRESHOLD )
         {
             // threshold bottom/right check
             newSashPosition = window_size;
-            unsplit_scenario = TRUE;
+            unsplit_scenario = true;
         }
     }
 
@@ -897,7 +910,7 @@ void wxSplitterWindow::OnDoubleClickSash(int x, int y)
 void wxSplitterWindow::OnUnsplit(wxWindow *winRemoved)
 {
     // call this before calling the event handler which may delete the window
-    winRemoved->Show(FALSE);
+    winRemoved->Show(false);
 }
 
 #if defined( __WXMSW__ ) || defined( __WXMAC__)
@@ -909,7 +922,7 @@ void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& event)
     // and like this we explicitly say that our cursor should not be used for
     // children windows which overlap us
 
-    if ( SashHitTest(event.GetX(), event.GetY()) )
+    if ( SashHitTest(event.GetX(), event.GetY(), 0) )
     {
         // default processing is ok
         event.Skip();