X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e441e1f4e8671915ee9bb32049edb4f1d700126e..cdb7bf66716a4f5c5d0e8b203e52826defdf5906:/src/generic/splitter.cpp diff --git a/src/generic/splitter.cpp b/src/generic/splitter.cpp index 3f1c33e327..257939be07 100644 --- a/src/generic/splitter.cpp +++ b/src/generic/splitter.cpp @@ -9,24 +9,23 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma implementation "splitter.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" -#if wxUSE_SPLITTER - #ifdef __BORLANDC__ #pragma hdrstop #endif +#if wxUSE_SPLITTER + +#include "wx/splitter.h" + #ifndef WX_PRECOMP #include "wx/string.h" #include "wx/utils.h" #include "wx/log.h" + #include "wx/dcclient.h" #include "wx/dcscreen.h" #include "wx/window.h" @@ -38,24 +37,22 @@ #include "wx/renderer.h" -#include "wx/splitter.h" - #include -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED) -DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_UNSPLIT) +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) /* - TODO PROPERTIES - style wxSP_3D - sashpos (long , 0 ) - minsize (long -1 ) - object, object_ref - orientation + TODO PROPERTIES + style wxSP_3D + sashpos (long , 0 ) + minsize (long -1 ) + object, object_ref + orientation */ IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent) @@ -72,7 +69,7 @@ BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow) WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow) END_EVENT_TABLE() -WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow); +WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow, wxWindow) bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos, @@ -87,34 +84,56 @@ bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id, 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; + return false; + + if (size.x >= 0) + m_lastSize.x = size.x; + if (size.y >= 0) + m_lastSize.y = size.y; m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0; - return TRUE; + // FIXME: with this line the background is not erased at all under GTK1, + // so temporary avoid it there +#if !defined(__WXGTK__) || defined(__WXGTK20__) + // don't erase the splitter background, it's pointless as we overwrite it + // anyhow + SetBackgroundStyle(wxBG_STYLE_CUSTOM); +#endif + + return true; } void wxSplitterWindow::Init() { - m_container.SetContainerWindow(this); + WX_INIT_CONTROL_CONTAINER(); m_splitMode = wxSPLIT_VERTICAL; - m_permitUnsplitAlways = TRUE; - m_windowOne = (wxWindow *) NULL; - m_windowTwo = (wxWindow *) NULL; + m_permitUnsplitAlways = true; + m_windowOne = NULL; + m_windowTwo = NULL; m_dragMode = wxSPLIT_DRAG_NONE; m_oldX = 0; m_oldY = 0; m_firstX = 0; m_firstY = 0; m_sashPosition = m_requestedSashPosition = 0; + 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); - m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxSOLID); + m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxPENSTYLE_SOLID); - m_needUpdating = FALSE; + m_needUpdating = false; m_isHot = false; } @@ -173,7 +192,16 @@ void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event)) 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(); } @@ -183,22 +211,30 @@ 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; + } // 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 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) ) { // Start the drag now m_dragMode = wxSPLIT_DRAG_DRAGGING; - + // Capture mouse and set the cursor CaptureMouse(); SetResizeCursor(); @@ -223,7 +259,7 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) { // We can stop dragging now and see what we've got. m_dragMode = wxSPLIT_DRAG_NONE; - + // Release mouse and unset the cursor ReleaseMouse(); SetCursor(* wxSTANDARD_CURSOR); @@ -261,22 +297,22 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) // We remove the first window from the view wxWindow *removedWindow = m_windowOne; m_windowOne = m_windowTwo; - m_windowTwo = (wxWindow *) NULL; + m_windowTwo = NULL; OnUnsplit(removedWindow); - wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); - event.m_data.win = removedWindow; - (void)DoSendEvent(event); + wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); + eventUnsplit.m_data.win = removedWindow; + (void)DoSendEvent(eventUnsplit); SetSashPositionAndNotify(0); } else if ( posSashNew == GetWindowSize() ) { // We remove the second window from the view wxWindow *removedWindow = m_windowTwo; - m_windowTwo = (wxWindow *) NULL; + m_windowTwo = NULL; OnUnsplit(removedWindow); - wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); - event.m_data.win = removedWindow; - (void)DoSendEvent(event); + wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this); + eventUnsplit.m_data.win = removedWindow; + (void)DoSendEvent(eventUnsplit); SetSashPositionAndNotify(0); } else @@ -355,14 +391,18 @@ void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event) } else { - SetSashPositionAndNotify(posSashNew); - m_needUpdating = TRUE; + DoSetSashPosition(posSashNew); + m_needUpdating = true; } } else if ( event.LeftDClick() && m_windowTwo ) { OnDoubleClickSash(x, y); } + else + { + event.Skip(); + } } void wxSplitterWindow::OnSize(wxSizeEvent& event) @@ -370,13 +410,8 @@ 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(); - while ( parent && !parent->IsTopLevel() ) - { - parent = parent->GetParent(); - } - - bool iconized = FALSE; + wxWindow *parent = wxGetTopLevelParent(this); + bool iconized; wxTopLevelWindow *winTop = wxDynamicCast(parent, wxTopLevelWindow); if ( winTop ) @@ -387,11 +422,13 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event) { wxFAIL_MSG(wxT("should have a top level parent!")); - iconized = FALSE; + iconized = false; } if ( iconized ) { + m_lastSize = wxSize(0,0); + event.Skip(); return; @@ -403,27 +440,51 @@ void wxSplitterWindow::OnSize(wxSizeEvent& event) GetClientSize(&w, &h); int size = m_splitMode == wxSPLIT_VERTICAL ? w : h; + + int old_size = m_splitMode == wxSPLIT_VERTICAL ? m_lastSize.x : m_lastSize.y; + if ( old_size != 0 ) + { + int delta = (int) ( (size - old_size)*m_sashGravity ); + if ( delta != 0 ) + { + int 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); } SizeWindows(); } +void wxSplitterWindow::SetSashGravity(double gravity) +{ + wxCHECK_RET( gravity >= 0. && gravity <= 1., + _T("invalid gravity value") ); + + m_sashGravity = gravity; +} + 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 && - z <= m_sashPosition + GetSashSize() + tolerance; + return z >= hitMin && z <= hitMax; } int wxSplitterWindow::GetSashSize() const { - return wxRendererNative::Get().GetSplitterParams(this).widthSash; + return m_sashSize > -1 ? m_sashSize : wxRendererNative::Get().GetSplitterParams(this).widthSash; } int wxSplitterWindow::GetBorderSize() const @@ -458,7 +519,7 @@ void wxSplitterWindow::DrawSash(wxDC& dc) m_sashPosition, m_splitMode == wxSPLIT_VERTICAL ? wxVERTICAL : wxHORIZONTAL, - m_isHot ? wxCONTROL_CURRENT : 0 + m_isHot ? (int)wxCONTROL_CURRENT : 0 ); } @@ -524,8 +585,6 @@ int wxSplitterWindow::GetWindowSize() const int wxSplitterWindow::AdjustSashPosition(int sashPos) const { - int window_size = GetWindowSize(); - wxWindow *win; win = GetWindow1(); @@ -554,8 +613,8 @@ int wxSplitterWindow::AdjustSashPosition(int sashPos) const if ( minSize == -1 || m_minimumPaneSize > minSize ) minSize = m_minimumPaneSize; - int maxSize = window_size - minSize - GetBorderSize(); - if ( sashPos > maxSize ) + int maxSize = GetWindowSize() - minSize - GetBorderSize() - GetSashSize(); + if ( maxSize > 0 && sashPos > maxSize ) sashPos = maxSize; } @@ -567,22 +626,30 @@ 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) { - if ( DoSetSashPosition(sashPos) ) - { - wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this); - event.m_data.pos = m_sashPosition; + // we must reset the request here, otherwise the sash would be stuck at + // old position if the user attempted to move the sash after invalid + // (e.g. smaller than minsize) sash position was requested using + // SetSashPosition(): + m_requestedSashPosition = INT_MAX; - (void)DoSendEvent(event); - } + // note that we must send the event in any case, i.e. even if the sash + // position hasn't changed and DoSetSashPosition() returns false because we + // must generate a CHANGED event at the end of resizing + DoSetSashPosition(sashPos); + + wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this); + event.m_data.pos = m_sashPosition; + + (void)DoSendEvent(event); } // Position and size subwindows. @@ -591,7 +658,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 ) @@ -628,58 +695,74 @@ void wxSplitterWindow::SizeWindows() { w1 = size1; w2 = w - 2*border - sash - w1; - h1 = + if (w2 < 0) + w2 = 0; h2 = h - 2*border; + if (h2 < 0) + h2 = 0; + h1 = h2; x2 = size2; y2 = border; } else // horz splitter { - w1 = w2 = w - 2*border; + if (w2 < 0) + w2 = 0; + w1 = w2; h1 = size1; h2 = h - 2*border - sash - h1; + if (h2 < 0) + h2 = 0; x2 = border; y2 = size2; } - GetWindow1()->SetSize(border, border, w1, h1); GetWindow2()->SetSize(x2, y2, w2, h2); + GetWindow1()->SetSize(border, border, w1, h1); } wxClientDC dc(this); DrawSash(dc); - SetNeedUpdating(FALSE); + SetNeedUpdating(false); } // Set pane for unsplit window void wxSplitterWindow::Initialize(wxWindow *window) { - wxASSERT_MSG( window && window->GetParent() == this, + wxASSERT_MSG( (!window || window->GetParent() == this), _T("windows in the splitter should have it as parent!") ); + if (window && !window->IsShown()) + window->Show(); + m_windowOne = window; - m_windowTwo = (wxWindow *) NULL; + m_windowTwo = NULL; DoSetSashPosition(0); } // 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!") ); + if (! window1->IsShown()) + window1->Show(); + if (! window2->IsShown()) + window2->Show(); + m_splitMode = mode; m_windowOne = window1; m_windowTwo = window2; @@ -687,12 +770,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,39 +802,39 @@ int wxSplitterWindow::ConvertSashPosition(int sashPosition) const bool wxSplitterWindow::Unsplit(wxWindow *toRemove) { if ( ! IsSplit() ) - return FALSE; + return false; - wxWindow *win = NULL; + wxWindow *win; if ( toRemove == NULL || toRemove == m_windowTwo) { win = m_windowTwo ; - m_windowTwo = (wxWindow *) NULL; + m_windowTwo = NULL; } else if ( toRemove == m_windowOne ) { win = m_windowOne ; m_windowOne = m_windowTwo; - m_windowTwo = (wxWindow *) NULL; + m_windowTwo = NULL; } else { 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( winNew, FALSE, wxT("use Unsplit() functions instead") ); + wxCHECK_MSG( winOld, false, wxT("use one of Split() functions instead") ); + wxCHECK_MSG( winNew, false, wxT("use Unsplit() functions instead") ); if ( winOld == m_windowTwo ) { @@ -764,23 +848,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 ) { @@ -788,11 +878,61 @@ void wxSplitterWindow::SetSashPosition(int position, bool redraw) } } +// Make sure the child window sizes are updated. This is useful +// for reducing flicker by updating the sizes before a +// 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) { return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed(); } +wxSize wxSplitterWindow::DoGetBestSize() const +{ + // get best sizes of subwindows + wxSize size1, size2; + if ( m_windowOne ) + size1 = m_windowOne->GetEffectiveMinSize(); + if ( m_windowTwo ) + size2 = m_windowTwo->GetEffectiveMinSize(); + + // sum them + // + // pSash points to the size component to which sash size must be added + int *pSash; + wxSize sizeBest; + if ( m_splitMode == wxSPLIT_VERTICAL ) + { + sizeBest.y = wxMax(size1.y, size2.y); + sizeBest.x = wxMax(size1.x, m_minimumPaneSize) + + wxMax(size2.x, m_minimumPaneSize); + + pSash = &sizeBest.x; + } + else // wxSPLIT_HORIZONTAL + { + sizeBest.x = wxMax(size1.x, size2.x); + sizeBest.y = wxMax(size1.y, m_minimumPaneSize) + + wxMax(size2.y, m_minimumPaneSize); + + pSash = &sizeBest.y; + } + + // account for the border and the sash + int border = 2*GetBorderSize(); + *pSash += GetSashSize(); + sizeBest.x += border; + sizeBest.y += border; + + return sizeBest; +} + // --------------------------------------------------------------------------- // wxSplitterWindow virtual functions: they now just generate the events // --------------------------------------------------------------------------- @@ -800,7 +940,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 +958,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 +966,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 +1037,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 +1049,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();