]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/splitter.cpp
why cvs thinks that I modified these files?
[wxWidgets.git] / src / generic / splitter.cpp
index b3591976b0bb36ade17e8d0626c7036ecca9e749..9e680e1748c4d0a3a1f98e6d858b05805655eaa6 100644 (file)
@@ -6,26 +6,24 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:       wxWindows license
+// Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 #ifdef __GNUG__
-#pragma implementation "splitter.h"
-// #pragma interface
+    #pragma implementation "splitter.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
 #ifndef WX_PRECOMP
-#include "wx/wx.h"
+    #include "wx/wx.h"
 #endif
 
-#include <math.h>
 #include <stdlib.h>
 
 #include "wx/string.h"
 
 #if !USE_SHARED_LIBRARY
 IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
+IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxCommandEvent)
 
 BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow)
     EVT_PAINT(wxSplitterWindow::OnPaint)
     EVT_SIZE(wxSplitterWindow::OnSize)
+    EVT_IDLE(wxSplitterWindow::OnIdle)
     EVT_MOUSE_EVENTS(wxSplitterWindow::OnMouseEvent)
+
+    EVT_SPLITTER_SASH_POS_CHANGED(-1, wxSplitterWindow::OnSashPosChanged)
+    // NB: we borrow OnSashPosChanged for purposes of
+    // EVT_SPLITTER_SASH_POS_CHANGING since default implementation is identical
+    EVT_SPLITTER_SASH_POS_CHANGING(-1, wxSplitterWindow::OnSashPosChanged)
+    EVT_SPLITTER_DCLICK(-1,           wxSplitterWindow::OnDoubleClick)
+    EVT_SPLITTER_UNSPLIT(-1,          wxSplitterWindow::OnUnsplitEvent)
 END_EVENT_TABLE()
 #endif
 
 wxSplitterWindow::wxSplitterWindow()
 {
     m_splitMode = wxSPLIT_VERTICAL;
+    m_permitUnsplitAlways = FALSE;
     m_windowOne = (wxWindow *) NULL;
     m_windowTwo = (wxWindow *) NULL;
     m_dragMode = wxSPLIT_DRAG_NONE;
@@ -65,6 +73,7 @@ wxSplitterWindow::wxSplitterWindow()
     m_facePen = (wxPen *) NULL;
     m_hilightPen = (wxPen *) NULL;
     m_minimumPaneSize = 0;
+    m_needUpdating = FALSE;
 }
 
 wxSplitterWindow::wxSplitterWindow(wxWindow *parent, wxWindowID id,
@@ -75,6 +84,7 @@ wxSplitterWindow::wxSplitterWindow(wxWindow *parent, wxWindowID id,
                 : wxWindow(parent, id, pos, size, style, name)
 {
     m_splitMode = wxSPLIT_VERTICAL;
+    m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
     m_windowOne = (wxWindow *) NULL;
     m_windowTwo = (wxWindow *) NULL;
     m_dragMode = wxSPLIT_DRAG_NONE;
@@ -117,6 +127,8 @@ wxSplitterWindow::wxSplitterWindow(wxWindow *parent, wxWindowID id,
 
     // For debugging purposes, to see the background.
 //    SetBackground(wxBLUE_BRUSH);
+
+    m_needUpdating = FALSE;
 }
 
 wxSplitterWindow::~wxSplitterWindow()
@@ -141,10 +153,25 @@ void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
     DrawSash(dc);
 }
 
+void wxSplitterWindow::OnIdle(wxIdleEvent& WXUNUSED(event))
+{
+    if (m_needUpdating)
+        SizeWindows();
+}
+
 void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
 {
-    long x, y;
-    event.Position(&x, &y);
+    long x = event.GetX();
+    long y = event.GetY();
+
+    // reset the cursor
+#ifdef __WXMOTIF__
+    SetCursor(* wxSTANDARD_CURSOR);
+#endif
+#ifdef __WXMSW__
+    SetCursor(wxCursor());
+#endif
+
 
     if (event.LeftDown())
     {
@@ -153,11 +180,15 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
             CaptureMouse();
 
             m_dragMode = wxSPLIT_DRAG_DRAGGING;
+
+            if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0)
+           {
+               DrawSashTracker(x, y);
+           }
            
-            DrawSashTracker(x, y);
             m_oldX = x;
             m_oldY = y;
-           return;
+            return;
         }
     }
     else if (event.LeftUp() && m_dragMode == wxSPLIT_DRAG_DRAGGING)
@@ -165,68 +196,65 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
         // We can stop dragging now and see what we've got.
         m_dragMode = wxSPLIT_DRAG_NONE;
         ReleaseMouse();
-       
+
         // Erase old tracker
-        DrawSashTracker(m_oldX, m_oldY);
+        if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0)
+       {
+            DrawSashTracker(m_oldX, m_oldY);
+       }
 
+        // Obtain window size. We are only interested in the dimension the sash
+        // splits up
         int w, h;
         GetClientSize(&w, &h);
-        if ( m_splitMode == wxSPLIT_VERTICAL )
+        int window_size = (m_splitMode == wxSPLIT_VERTICAL ? w : h );
+        int new_sash_position =
+            (int) ( m_splitMode == wxSPLIT_VERTICAL ? x : y );
+
+        wxSplitterEvent eventSplitter(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,
+                                      this);
+        eventSplitter.m_data.pos = new_sash_position;
+        if ( GetEventHandler()->ProcessEvent(eventSplitter) )
         {
-            if ( !OnSashPositionChange(x) )
+            new_sash_position = eventSplitter.GetSashPosition();
+            if ( new_sash_position == -1 )
+            {
+                // change not allowed
                 return;
+            }
+        }
 
-            if ( x <= 4 )
+        if ( m_permitUnsplitAlways
+                || m_minimumPaneSize == 0 )
+        {
+            // Deal with possible unsplit scenarios
+            if ( new_sash_position == 0 )
             {
                 // We remove the first window from the view
                 wxWindow *removedWindow = m_windowOne;
                 m_windowOne = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
-
-                OnUnsplit(removedWindow);
+                SendUnsplitEvent(removedWindow);
                 m_sashPosition = 0;
             }
-            else if ( x >= (w - 4) )
+            else if ( new_sash_position == window_size )
             {
                 // We remove the second window from the view
                 wxWindow *removedWindow = m_windowTwo;
                 m_windowTwo = (wxWindow *) NULL;
-                OnUnsplit(removedWindow);
+                SendUnsplitEvent(removedWindow);
                 m_sashPosition = 0;
             }
             else
             {
-                m_sashPosition = x;
+                m_sashPosition = new_sash_position;
             }
         }
-        else  // m_splitMode == wxSPLIT_VERTICAL
+        else
         {
-            if ( !OnSashPositionChange(y) )
-                return;
-
-            if ( y <= 4 )
-            {
-                // We remove the first window from the view
-                wxWindow *removedWindow = m_windowOne;
-                m_windowOne = m_windowTwo;
-                m_windowTwo = (wxWindow *) NULL;
+            m_sashPosition = new_sash_position;
+        }
 
-                OnUnsplit(removedWindow);
-                m_sashPosition = 0;
-            }
-            else if ( y >= (h - 4) )
-            {
-                // We remove the second window from the view
-                wxWindow *removedWindow = m_windowTwo;
-                m_windowTwo = (wxWindow *) NULL;
-                OnUnsplit(removedWindow);
-                m_sashPosition = 0;
-            }
-            else
-            {
-                m_sashPosition = y;
-            }
-        } // m_splitMode == wxSPLIT_VERTICAL
         SizeWindows();
     }  // left up && dragging
     else if (event.Moving() && !event.Dragging())
@@ -243,46 +271,135 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
                     SetCursor(*m_sashCursorNS);
                 }
         }
+#ifdef __WXGTK__
         else
         {
-            SetCursor(*wxSTANDARD_CURSOR);
+            // where else do we unset the cursor?
+            SetCursor(* wxSTANDARD_CURSOR);
         }
+#endif // __WXGTK__
     }
     else if (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING)) 
     {
+        // Obtain window size. We are only interested in the dimension the sash
+        // splits up
+        int new_sash_position =
+            (int) ( m_splitMode == wxSPLIT_VERTICAL ? x : y );
+
+        wxSplitterEvent eventSplitter(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,
+                                      this);
+        eventSplitter.m_data.pos = new_sash_position;
+        if ( GetEventHandler()->ProcessEvent(eventSplitter) )
+        {
+            new_sash_position = eventSplitter.GetSashPosition();
+            if ( new_sash_position == -1 )
+            {
+                // change not allowed
+                return;
+            }
+        }
+
         // Erase old tracker
-        DrawSashTracker(m_oldX, m_oldY);
+        if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0)
+       {
+            DrawSashTracker(m_oldX, m_oldY);
+       }
+
+        if (m_splitMode == wxSPLIT_VERTICAL)
+            x = new_sash_position;
+        else
+            y = new_sash_position;
+
+        if (new_sash_position != -1)
+        {
+            // Only modify if permitted
+            m_oldX = x;
+            m_oldY = 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;
+#endif // __WXMSW__
 
         // Draw new one
-        DrawSashTracker(x, y);
-           
-        m_oldX = x;
-        m_oldY = y;
+        if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0)
+       {
+            DrawSashTracker(m_oldX, m_oldY);
+       }
+       else
+       {
+            m_sashPosition = new_sash_position;
+           m_needUpdating = TRUE;
+       }
     }
     else if ( event.LeftDClick() )
     {
-        OnDoubleClickSash(x, y);
+        wxSplitterEvent eventSplitter(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,
+                                      this);
+        eventSplitter.m_data.pt.x = x;
+        eventSplitter.m_data.pt.y = y;
+
+        (void)GetEventHandler()->ProcessEvent(eventSplitter);
     }
 }
 
-void wxSplitterWindow::OnSize(wxSizeEvent& WXUNUSED(event))
+void wxSplitterWindow::OnSize(wxSizeEvent& event)
 {
-    int cw, ch;
-    GetClientSize( &cw, &ch );
-    if ( m_windowTwo )
+    // 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();
+    while ( parent && !parent->IsTopLevel() )
     {
-        if ( m_splitMode == wxSPLIT_VERTICAL )
-        {
-            if ( m_sashPosition >= (cw - 5) )
-                m_sashPosition = wxMax(10, cw - 40);
-        }
-        if ( m_splitMode == wxSPLIT_HORIZONTAL )
+        parent = parent->GetParent();
+    }
+
+    bool iconized = FALSE;
+    wxFrame *frame = wxDynamicCast(parent, wxFrame);
+    if ( frame )
+        iconized = frame->IsIconized();
+    else
+    {
+        wxDialog *dialog = wxDynamicCast(parent, wxDialog);
+        if ( dialog )
+            iconized = dialog->IsIconized();
+        else
+            wxFAIL_MSG(_T("should have a top level frame or dialog parent!"));
+    }
+
+    if ( iconized )
+    {
+        event.Skip();
+    }
+    else
+    {
+        int cw, ch;
+        GetClientSize( &cw, &ch );
+        if ( m_windowTwo )
         {
-            if ( m_sashPosition >= (ch - 5) )
-                m_sashPosition = wxMax(10, ch - 40);
+            if ( m_splitMode == wxSPLIT_VERTICAL )
+            {
+                if ( m_sashPosition >= (cw - 5) )
+                    m_sashPosition = wxMax(10, cw - 40);
+            }
+            if ( m_splitMode == wxSPLIT_HORIZONTAL )
+            {
+                if ( m_sashPosition >= (ch - 5) )
+                    m_sashPosition = wxMax(10, ch - 40);
+            }
         }
+
+        SizeWindows();
     }
-    SizeWindows();
 }
 
 bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
@@ -468,7 +585,7 @@ void wxSplitterWindow::DrawSashTracker(int x, int y)
     ClientToScreen(&x1, &y1);
     ClientToScreen(&x2, &y2);
 
-    screenDC.SetLogicalFunction(wxXOR);
+    screenDC.SetLogicalFunction(wxINVERT);
     screenDC.SetPen(*m_sashTrackerPen);
     screenDC.SetBrush(*wxTRANSPARENT_BRUSH);
 
@@ -491,6 +608,9 @@ void wxSplitterWindow::SizeWindows()
     if ( m_windowOne && !m_windowTwo )
     {
         m_windowOne->SetSize(m_borderSize, m_borderSize, w - 2*m_borderSize, h - 2*m_borderSize);
+       
+       if (m_windowOne->GetAutoLayout())
+           m_windowOne->Layout();
     }
     else if ( m_windowOne && m_windowTwo )
     {
@@ -508,6 +628,11 @@ void wxSplitterWindow::SizeWindows()
 
             m_windowOne->SetSize(x1, y1, w1, h1);
             m_windowTwo->SetSize(x2, y2, w2, h2);
+       
+           if (m_windowOne->GetAutoLayout())
+               m_windowOne->Layout();
+           if (m_windowTwo->GetAutoLayout())
+               m_windowTwo->Layout();
         }
         else
         {
@@ -515,6 +640,11 @@ void wxSplitterWindow::SizeWindows()
                 w - 2*m_borderSize, m_sashPosition - m_borderSize);
             m_windowTwo->SetSize(m_borderSize, m_sashPosition + m_sashSize,
                 w - 2*m_borderSize, h - 2*m_borderSize - m_sashSize - (m_sashPosition - m_borderSize));
+               
+           if (m_windowOne->GetAutoLayout())
+               m_windowOne->Layout();
+           if (m_windowTwo->GetAutoLayout())
+               m_windowTwo->Layout();
         }
     }
     wxClientDC dc(this);
@@ -587,72 +717,65 @@ bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
     if ( ! IsSplit() )
         return FALSE;
 
+    wxWindow *win = NULL;
     if ( toRemove == NULL || toRemove == m_windowTwo)
     {
-        wxWindow *win = m_windowTwo ;
+        win = m_windowTwo ;
         m_windowTwo = (wxWindow *) NULL;
-        m_sashPosition = 0;
-        OnUnsplit(win);
-        SizeWindows();
     }
     else if ( toRemove == m_windowOne )
     {
-        wxWindow *win = m_windowOne ;
+        win = m_windowOne ;
         m_windowOne = m_windowTwo;
         m_windowTwo = (wxWindow *) NULL;
-        m_sashPosition = 0;
-        OnUnsplit(win);
-        SizeWindows();
     }
     else
+    {
+        wxFAIL_MSG(_T("splitter: attempt to remove a non-existent window"));
+
         return FALSE;
+    }
+
+    SendUnsplitEvent(win);
+    m_sashPosition = 0;
+    SizeWindows();
 
     return TRUE;
 }
 
-void wxSplitterWindow::SetSashPosition(int position, bool redraw)
+// Replace a window with another one
+bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
 {
-    m_sashPosition = position;
+    wxCHECK_MSG( winOld, FALSE, _T("use one of Split() functions instead") );
+    wxCHECK_MSG( winNew, FALSE, _T("use Unsplit() functions instead") );
 
-    if ( redraw )
+    if ( winOld == m_windowTwo )
     {
-        SizeWindows();
+        m_windowTwo = winNew;
     }
-}
+    else if ( winOld == m_windowOne )
+    {
+        m_windowOne = winNew;
+    }
+    else
+    {
+        wxFAIL_MSG(_T("splitter: attempt to replace a non-existent window"));
 
-bool wxSplitterWindow::OnSashPositionChange(int newSashPosition)
-{
-  // is the left/upper pane too small?
-  if ( newSashPosition < m_minimumPaneSize )
-    return NULL;
-
-  // is the right/lower pane too small?
-  int w, h;
-  GetClientSize(&w, &h);
-
-  if ( m_splitMode == wxSPLIT_VERTICAL )
-  {
-    if ( w - newSashPosition < m_minimumPaneSize )
-      return FALSE;
-  }
-  else // m_splitMode = wxSPLIT_HORIZONTAL
-  {
-    if ( h - newSashPosition < m_minimumPaneSize )
-      return FALSE;
-  }
-
-  // it's ok to move sash
-  return TRUE;
+        return FALSE;
+    }
+
+    SizeWindows();
+
+    return TRUE;
 }
 
-// Called when the sash is double-clicked.
-// The default behaviour is to remove the sash if the
-// minimum pane size is zero.
-void wxSplitterWindow::OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y) )
+void wxSplitterWindow::SetSashPosition(int position, bool redraw)
 {
-    if ( GetMinimumPaneSize() == 0 )
+    m_sashPosition = position;
+
+    if ( redraw )
     {
-        Unsplit();
+        SizeWindows();
     }
 }
 
@@ -693,3 +816,92 @@ void wxSplitterWindow::InitColours()
 #endif // Win32/!Win32
 }
 
+void wxSplitterWindow::SendUnsplitEvent(wxWindow *winRemoved)
+{
+    wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+    event.m_data.win = winRemoved;
+
+    (void)GetEventHandler()->ProcessEvent(event);
+}
+
+// ---------------------------------------------------------------------------
+// splitter event handlers
+// ---------------------------------------------------------------------------
+
+void wxSplitterWindow::OnSashPosChanged(wxSplitterEvent& event)
+{
+    // If within UNSPLIT_THRESHOLD from edge, set to edge to cause closure.
+    const int UNSPLIT_THRESHOLD = 4;
+
+    int newSashPosition = event.GetSashPosition();
+
+    // Obtain relevant window dimension for bottom / right threshold check
+    int w, h;
+    GetClientSize(&w, &h);
+    int window_size = (m_splitMode == wxSPLIT_VERTICAL) ? w : h ;
+
+    bool unsplit_scenario = FALSE;
+    if ( m_permitUnsplitAlways
+            || m_minimumPaneSize == 0 )
+    {
+        // Do edge detection if unsplit premitted
+        if ( newSashPosition <= UNSPLIT_THRESHOLD )
+        {
+            // threshold top / left check
+            newSashPosition = 0;
+            unsplit_scenario = TRUE;
+        }
+        if ( newSashPosition >= window_size - UNSPLIT_THRESHOLD )
+        {
+            // threshold bottom/right check
+            newSashPosition = window_size;
+            unsplit_scenario = TRUE;
+        }
+    }
+
+    if ( !unsplit_scenario )
+    {
+        // If resultant pane would be too small, enlarge it
+        if ( newSashPosition < m_minimumPaneSize )
+            newSashPosition = m_minimumPaneSize;
+        if ( newSashPosition > window_size - m_minimumPaneSize )
+            newSashPosition = window_size - m_minimumPaneSize;
+    }
+
+    // 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;
+
+    // for compatibility, call the virtual function
+    if ( !OnSashPositionChange(newSashPosition) )
+    {
+        newSashPosition = -1;
+    }
+
+    event.SetSashPosition(newSashPosition);
+}
+
+// Called when the sash is double-clicked. The default behaviour is to remove
+// the sash if the minimum pane size is zero.
+void wxSplitterWindow::OnDoubleClick(wxSplitterEvent& event)
+{
+    // for compatibility, call the virtual function
+    OnDoubleClickSash(event.GetX(), event.GetY());
+
+    if ( GetMinimumPaneSize() == 0
+        || m_permitUnsplitAlways)
+    {
+        Unsplit();
+    }
+}
+
+void wxSplitterWindow::OnUnsplitEvent(wxSplitterEvent& event)
+{
+    wxWindow *win = event.GetWindowBeingRemoved();
+
+    // for compatibility, call the virtual function
+    OnUnsplit(win);
+
+    win->Show(FALSE);
+}