X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ca39e4095ab3d2acd724d74eb8c09a1ae8704032..f7292ebebae552238c50f8009db572edc44a315e:/src/generic/splitter.cpp?ds=sidebyside diff --git a/src/generic/splitter.cpp b/src/generic/splitter.cpp index 1d29a0b782..2927eacbdb 100644 --- a/src/generic/splitter.cpp +++ b/src/generic/splitter.cpp @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: splitter.cpp +// Name: src/generic/splitter.cpp // Purpose: wxSplitterWindow implementation // Author: Julian Smart // Modified by: // Created: 01/02/97 // RCS-ID: $Id$ -// Copyright: (c) Julian Smart and Markus Holzem -// Licence: wxWindows license +// Copyright: (c) Julian Smart +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifdef __GNUG__ @@ -21,19 +21,22 @@ #endif #ifndef WX_PRECOMP + #include "wx/string.h" + #include "wx/utils.h" + #include "wx/log.h" + + #include "wx/dcscreen.h" + #include "wx/window.h" #include "wx/dialog.h" #include "wx/frame.h" -#endif -#include + #include "wx/settings.h" +#endif -#include "wx/string.h" #include "wx/splitter.h" -#include "wx/dcscreen.h" -#include "wx/settings.h" -#include "wx/log.h" -#include "wx/utils.h" + +#include DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED) DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING) @@ -41,7 +44,7 @@ DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED) DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_UNSPLIT) IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow) -IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxCommandEvent) +IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent) BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow) EVT_PAINT(wxSplitterWindow::OnPaint) @@ -49,14 +52,9 @@ BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow) EVT_IDLE(wxSplitterWindow::OnIdle) EVT_MOUSE_EVENTS(wxSplitterWindow::OnMouseEvent) +#ifdef __WXMSW__ EVT_SET_CURSOR(wxSplitterWindow::OnSetCursor) - - 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) +#endif // wxMSW WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow) END_EVENT_TABLE() @@ -112,12 +110,12 @@ void wxSplitterWindow::Init() m_oldY = 0; m_firstX = 0; m_firstY = 0; - m_sashSize = 7; - m_borderSize = 2; + m_sashSize = 3; + m_borderSize = 0; m_sashPosition = m_requestedSashPosition = 0; m_minimumPaneSize = 0; - m_sashCursorWE = new wxCursor(wxCURSOR_SIZEWE); - m_sashCursorNS = new wxCursor(wxCURSOR_SIZENS); + m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE); + m_sashCursorNS = wxCursor(wxCURSOR_SIZENS); m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxSOLID); m_lightShadowPen = (wxPen *) NULL; m_mediumShadowPen = (wxPen *) NULL; @@ -126,9 +124,6 @@ void wxSplitterWindow::Init() m_facePen = (wxPen *) NULL; m_hilightPen = (wxPen *) NULL; - m_borderSize = 0; - m_sashSize = 3; - InitColours(); m_needUpdating = FALSE; @@ -136,8 +131,6 @@ void wxSplitterWindow::Init() wxSplitterWindow::~wxSplitterWindow() { - delete m_sashCursorWE; - delete m_sashCursorNS; delete m_sashTrackerPen; delete m_lightShadowPen; delete m_darkShadowPen; @@ -147,6 +140,12 @@ wxSplitterWindow::~wxSplitterWindow() delete m_faceBrush; } +void wxSplitterWindow::SetResizeCursor() +{ + SetCursor(m_splitMode == wxSPLIT_VERTICAL ? m_sashCursorWE + : m_sashCursorNS); +} + void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) { wxPaintDC dc(this); @@ -170,16 +169,21 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) y = (int)event.GetY(); // reset the cursor -#ifdef __WXMOTIF__ +#if defined( __WXMOTIF__ ) || defined( __WXGTK__ ) || defined( __WXMAC__ ) SetCursor(* wxSTANDARD_CURSOR); -#endif -#ifdef __WXMSW__ +#elif defined(__WXMSW__) SetCursor(wxCursor()); #endif if (GetWindowStyle() & wxSP_NOSASH) return; + // 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 + bool isLive = (GetWindowStyleFlag() & wxSP_LIVE_UPDATE) != 0; + if (event.LeftDown()) { if ( SashHitTest(x, y) ) @@ -188,22 +192,19 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) m_dragMode = wxSPLIT_DRAG_DRAGGING; - if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0) + if ( !isLive ) { + // remember the initial sash position and draw the initial + // shadow sash + m_sashPositionCurrent = m_sashPosition; + DrawSashTracker(x, y); } m_oldX = x; m_oldY = y; - if ( m_splitMode == wxSPLIT_VERTICAL ) - { - SetCursor(*m_sashCursorWE); - } - else - { - SetCursor(*m_sashCursorNS); - } + SetResizeCursor(); return; } } @@ -213,58 +214,59 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) m_dragMode = wxSPLIT_DRAG_NONE; ReleaseMouse(); + // exit if unsplit after doubleclick + if ( !IsSplit() ) + { + return; + } + // Erase old tracker - if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0) + if ( !isLive ) { DrawSashTracker(m_oldX, m_oldY); } - // Obtain window size. We are only interested in the dimension the sash - // splits up - int window_size = GetWindowSize(); - int new_sash_position = m_splitMode == wxSPLIT_VERTICAL ? x : y; + // 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; - wxSplitterEvent eventSplitter(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, - this); - eventSplitter.m_data.pos = new_sash_position; - if ( GetEventHandler()->ProcessEvent(eventSplitter) ) + int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent; + int posSashNew = OnSashPositionChanging(posSashOld + diff); + if ( posSashNew == -1 ) { - new_sash_position = eventSplitter.GetSashPosition(); - if ( new_sash_position == -1 ) - { - // change not allowed - return; - } + // change not allowed + return; } if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 ) { // Deal with possible unsplit scenarios - if ( new_sash_position == 0 ) + if ( posSashNew == 0 ) { // We remove the first window from the view wxWindow *removedWindow = m_windowOne; m_windowOne = m_windowTwo; m_windowTwo = (wxWindow *) NULL; - SendUnsplitEvent(removedWindow); - DoSetSashPosition(0); + OnUnsplit(removedWindow); + SetSashPositionAndNotify(0); } - else if ( new_sash_position == window_size ) + else if ( posSashNew == GetWindowSize() ) { // We remove the second window from the view wxWindow *removedWindow = m_windowTwo; m_windowTwo = (wxWindow *) NULL; - SendUnsplitEvent(removedWindow); - DoSetSashPosition(0); + OnUnsplit(removedWindow); + SetSashPositionAndNotify(0); } else { - DoSetSashPosition(new_sash_position); + SetSashPositionAndNotify(posSashNew); } } else { - DoSetSashPosition(new_sash_position); + SetSashPositionAndNotify(posSashNew); } SizeWindows(); @@ -274,16 +276,9 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) // Just change the cursor if required if ( SashHitTest(x, y) ) { - if ( m_splitMode == wxSPLIT_VERTICAL ) - { - SetCursor(*m_sashCursorWE); - } - else - { - SetCursor(*m_sashCursorNS); - } + SetResizeCursor(); } -#if defined(__WXGTK__) || defined(__WXMSW__) +#if defined(__WXGTK__) || defined(__WXMSW__) || defined(__WXMAC__) else { // We must set the normal cursor in MSW, because @@ -298,49 +293,40 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) } else if (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING)) { -#ifdef __WXMSW__ +#if defined( __WXMSW__ ) || defined( __WXMAC__ ) // Otherwise, the cursor sometimes reverts to the normal cursor // during dragging. - if ( m_splitMode == wxSPLIT_VERTICAL ) - { - SetCursor(*m_sashCursorWE); - } - else + SetResizeCursor(); +#endif // __WXMSW__ + + int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY; + if ( !diff ) { - SetCursor(*m_sashCursorNS); + // nothing to do, mouse didn't really move far enough + return; } -#endif - - // Obtain window size. We are only interested in the dimension the sash - // splits up - int new_sash_position = 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) ) + int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent; + int posSashNew = OnSashPositionChanging(posSashOld + diff); + if ( posSashNew == -1 ) { - new_sash_position = eventSplitter.GetSashPosition(); - if ( new_sash_position == -1 ) - { - // change not allowed - return; - } + // change not allowed + return; } - if (new_sash_position == m_sashPosition) + if ( posSashNew == m_sashPosition ) return; // Erase old tracker - if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0) + if ( !isLive ) { DrawSashTracker(m_oldX, m_oldY); } if (m_splitMode == wxSPLIT_VERTICAL) - x = new_sash_position; + x = posSashNew; else - y = new_sash_position; + y = posSashNew; // Remember old positions m_oldX = x; @@ -360,24 +346,21 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) #endif // __WXMSW__ // Draw new one - if ((GetWindowStyleFlag() & wxSP_LIVE_UPDATE) == 0) + if ( !isLive ) { + m_sashPositionCurrent = posSashNew; + DrawSashTracker(m_oldX, m_oldY); } else { - DoSetSashPosition(new_sash_position); + SetSashPositionAndNotify(posSashNew); m_needUpdating = TRUE; } } else if ( event.LeftDClick() ) { - wxSplitterEvent eventSplitter(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, - this); - eventSplitter.m_data.pt.x = x; - eventSplitter.m_data.pt.y = y; - - (void)GetEventHandler()->ProcessEvent(eventSplitter); + OnDoubleClickSash(x, y); } } @@ -412,7 +395,7 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event) iconized = FALSE; } #endif - + if ( iconized ) { event.Skip(); @@ -427,12 +410,12 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event) if ( m_splitMode == wxSPLIT_VERTICAL ) { if ( m_sashPosition >= (cw - 5) ) - DoSetSashPosition(wxMax(10, cw - 40)); + SetSashPositionAndNotify(wxMax(10, cw - 40)); } else // m_splitMode == wxSPLIT_HORIZONTAL { if ( m_sashPosition >= (ch - 5) ) - DoSetSashPosition(wxMax(10, ch - 40)); + SetSashPositionAndNotify(wxMax(10, ch - 40)); } } @@ -560,7 +543,7 @@ void wxSplitterWindow::DrawSash(wxDC& dc) dc.DrawLine(m_sashPosition+1, h-m_borderSize-1, m_sashPosition+m_sashSize-1, h-m_borderSize-1); } } - else + else // wxSPLIT_HORIZONTAL { dc.SetPen(*m_facePen); if (HasFlag( wxSP_SASH_AQUA )) @@ -600,12 +583,12 @@ void wxSplitterWindow::DrawSash(wxDC& dc) } } } - else + else // !wxSP_3DSASH { + dc.SetPen(*wxTRANSPARENT_PEN); + dc.SetBrush(*m_faceBrush); if ( m_splitMode == wxSPLIT_VERTICAL ) { - dc.SetPen(*wxBLACK_PEN); - dc.SetBrush(*wxBLACK_BRUSH); int h1 = h-1; int y1 = 0; if ( (GetWindowStyleFlag() & wxSP_BORDER) != wxSP_BORDER && (GetWindowStyleFlag() & wxSP_3DBORDER) != wxSP_3DBORDER ) @@ -616,10 +599,8 @@ void wxSplitterWindow::DrawSash(wxDC& dc) } dc.DrawRectangle(m_sashPosition, y1, m_sashSize, h1); } - else + else // wxSPLIT_HORIZONTAL { - dc.SetPen(*wxBLACK_PEN); - dc.SetBrush(*wxBLACK_BRUSH); int w1 = w-1; int x1 = 0; if ( (GetWindowStyleFlag() & wxSP_BORDER) != wxSP_BORDER && (GetWindowStyleFlag() & wxSP_3DBORDER) != wxSP_3DBORDER ) @@ -630,7 +611,6 @@ void wxSplitterWindow::DrawSash(wxDC& dc) } dc.DrawRectangle(x1, m_sashPosition, w1, m_sashSize); } - } dc.SetPen(wxNullPen); @@ -740,10 +720,27 @@ int wxSplitterWindow::AdjustSashPosition(int sashPos) const return sashPos; } -void wxSplitterWindow::DoSetSashPosition(int sashPos) +bool wxSplitterWindow::DoSetSashPosition(int sashPos) { - m_requestedSashPosition = sashPos; - m_sashPosition = (sashPos == 0) ? 0 : AdjustSashPosition(sashPos); + int newSashPosition = AdjustSashPosition(sashPos); + + if ( newSashPosition == m_sashPosition ) + return FALSE; + + m_sashPosition = newSashPosition; + + return TRUE; +} + +void wxSplitterWindow::SetSashPositionAndNotify(int sashPos) +{ + if ( DoSetSashPosition(sashPos) ) + { + wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this); + event.m_data.pos = m_sashPosition; + + (void)DoSendEvent(event); + } } // Position and size subwindows. @@ -751,15 +748,29 @@ void wxSplitterWindow::DoSetSashPosition(int sashPos) // including the edges next to the sash. void wxSplitterWindow::SizeWindows() { - if ( m_requestedSashPosition != m_sashPosition ) - DoSetSashPosition(m_requestedSashPosition); + // check if we have delayed setting the real sash position + if ( m_requestedSashPosition != INT_MAX ) + { + int newSashPosition = ConvertSashPosition(m_requestedSashPosition); + if ( newSashPosition != m_sashPosition ) + { + DoSetSashPosition(newSashPosition); + } + + if ( newSashPosition <= m_sashPosition + && newSashPosition >= m_sashPosition - GetBorderSize() ) + { + // don't update it any more + m_requestedSashPosition = INT_MAX; + } + } int w, h; GetClientSize(&w, &h); if ( GetWindow1() && !GetWindow2() ) { - GetWindow1()->SetSize(GetBorderSize(), GetBorderSize(), + GetWindow1()->SetSize(GetBorderSize(), GetBorderSize(), w - 2*GetBorderSize(), h - 2*GetBorderSize()); } else if ( GetWindow1() && GetWindow2() ) @@ -798,6 +809,9 @@ void wxSplitterWindow::SizeWindows() // 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!") ); + m_windowOne = window; m_windowTwo = (wxWindow *) NULL; DoSetSashPosition(0); @@ -813,30 +827,43 @@ bool wxSplitterWindow::DoSplit(wxSplitMode mode, if ( IsSplit() ) return FALSE; - int window_size = GetWindowSize(); + wxCHECK_MSG( window1 && window2, FALSE, + _T("can not split with NULL window(s)") ); + + wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, FALSE, + _T("windows in the splitter should have it as parent!") ); m_splitMode = 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; + + DoSetSashPosition(ConvertSashPosition(sashPosition)); + + SizeWindows(); + + return TRUE; +} + +int wxSplitterWindow::ConvertSashPosition(int sashPosition) const +{ if ( sashPosition > 0 ) { - DoSetSashPosition(sashPosition); + return sashPosition; } else if ( sashPosition < 0 ) { // It's negative so adding is subtracting - DoSetSashPosition(window_size + sashPosition); + return GetWindowSize() + sashPosition; } - else + else // sashPosition == 0 { - // default - DoSetSashPosition(window_size/2); + // default, put it in the centre + return GetWindowSize() / 2; } - - SizeWindows(); - - return TRUE; } // Remove the specified (or second) window from the view @@ -865,7 +892,7 @@ bool wxSplitterWindow::Unsplit(wxWindow *toRemove) return FALSE; } - SendUnsplitEvent(win); + OnUnsplit(win); DoSetSashPosition(0); SizeWindows(); @@ -951,31 +978,38 @@ void wxSplitterWindow::InitColours() #endif // __WIN16__ } -void wxSplitterWindow::SendUnsplitEvent(wxWindow *winRemoved) +bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event) { - wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); - event.m_data.win = winRemoved; - - (void)GetEventHandler()->ProcessEvent(event); + return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed(); } // --------------------------------------------------------------------------- -// splitter event handlers +// wxSplitterWindow virtual functions: they now just generate the events // --------------------------------------------------------------------------- -void wxSplitterWindow::OnSashPosChanged(wxSplitterEvent& event) +bool wxSplitterWindow::OnSashPositionChange(int WXUNUSED(newSashPosition)) +{ + // always allow by default + return TRUE; +} + +int wxSplitterWindow::OnSashPositionChanging(int newSashPosition) { // If within UNSPLIT_THRESHOLD from edge, set to edge to cause closure. const int UNSPLIT_THRESHOLD = 4; - int newSashPosition = event.GetSashPosition(); + // first of all, check if OnSashPositionChange() doesn't forbid this change + if ( !OnSashPositionChange(newSashPosition) ) + { + // it does + return -1; + } // Obtain relevant window dimension for bottom / right threshold check int window_size = GetWindowSize(); bool unsplit_scenario = FALSE; - if ( m_permitUnsplitAlways - || m_minimumPaneSize == 0 ) + if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 ) { // Do edge detection if unsplit premitted if ( newSashPosition <= UNSPLIT_THRESHOLD ) @@ -1003,50 +1037,61 @@ void wxSplitterWindow::OnSashPosChanged(wxSplitterEvent& event) if ( newSashPosition < 0 || newSashPosition > window_size ) newSashPosition = window_size / 2; - // for compatibility, call the virtual function - if ( !OnSashPositionChange(newSashPosition) ) + // now let the event handler have it + // + // FIXME: shouldn't we do it before the adjustments above so as to ensure + // that the sash position is always reasonable? + wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, this); + event.m_data.pos = newSashPosition; + + if ( !DoSendEvent(event) ) { + // the event handler vetoed the change newSashPosition = -1; } + else + { + // it could have been changed by it + newSashPosition = event.GetSashPosition(); + } - event.SetSashPosition(newSashPosition); + return 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) +void wxSplitterWindow::OnDoubleClickSash(int x, int y) { - // for compatibility, call the virtual function - OnDoubleClickSash(event.GetX(), event.GetY()); - - if ( GetMinimumPaneSize() == 0 || m_permitUnsplitAlways ) + // new code should handle events instead of using the virtual functions + wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, this); + event.m_data.pt.x = x; + event.m_data.pt.y = y; + if ( DoSendEvent(event) ) { - Unsplit(); + if ( GetMinimumPaneSize() == 0 || m_permitUnsplitAlways ) + { + Unsplit(); + } } + //else: blocked by user } -void wxSplitterWindow::OnUnsplitEvent(wxSplitterEvent& event) +void wxSplitterWindow::OnUnsplit(wxWindow *winRemoved) { - wxWindow *win = event.GetWindowBeingRemoved(); + // do it before calling the event handler which may delete the window + winRemoved->Show(FALSE); - // do it before calling OnUnsplit() which may delete the window - win->Show(FALSE); + wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); + event.m_data.win = winRemoved; - // for compatibility, call the virtual function - OnUnsplit(win); + (void)DoSendEvent(event); } -#if defined(__WXMSW__) - #define WXUNUSED_UNLESS_MSW(identifier) identifier -#else - #define WXUNUSED_UNLESS_MSW(identifier) WXUNUSED(identifier) -#endif - -void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& WXUNUSED_UNLESS_MSW(event)) -{ - // this is currently called (and needed) under MSW only... #ifdef __WXMSW__ +// this is currently called (and needed) under MSW only... +void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& event) +{ // if we don't do it, the resizing cursor might be set for child window: // and like this we explicitly say that our cursor should not be used for // children windows which overlap us @@ -1057,5 +1102,7 @@ void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& WXUNUSED_UNLESS_MSW(event)) event.Skip(); } //else: do nothing, in particular, don't call Skip() -#endif // wxMSW } + +#endif // wxMSW +