/////////////////////////////////////////////////////////////////////////////
-// Name: splitter.cpp
+// Name: src/generic/splitter.cpp
// Purpose: wxSplitterWindow implementation
// Author: Julian Smart
// Modified by:
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)
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()
m_borderSize = 2;
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;
wxSplitterWindow::~wxSplitterWindow()
{
- delete m_sashCursorWE;
- delete m_sashCursorNS;
delete m_sashTrackerPen;
delete m_lightShadowPen;
delete m_darkShadowPen;
delete m_faceBrush;
}
+void wxSplitterWindow::SetResizeCursor()
+{
+ SetCursor(m_splitMode == wxSPLIT_VERTICAL ? m_sashCursorWE
+ : m_sashCursorNS);
+}
+
void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
{
wxPaintDC dc(this);
// reset the cursor
#ifdef __WXMOTIF__
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) )
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;
}
}
ReleaseMouse();
// 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();
// 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__)
else
#ifdef __WXMSW__
// Otherwise, the cursor sometimes reverts to the normal cursor
// during dragging.
- if ( m_splitMode == wxSPLIT_VERTICAL )
- {
- SetCursor(*m_sashCursorWE);
- }
- else
- {
- SetCursor(*m_sashCursorNS);
- }
-#endif
+ SetResizeCursor();
+#endif // __WXMSW__
- // Obtain window size. We are only interested in the dimension the sash
- // splits up
- int new_sash_position = m_splitMode == wxSPLIT_VERTICAL ? x : y;
+ int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY;
- 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;
#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);
}
}
iconized = FALSE;
}
#endif
-
+
if ( iconized )
{
event.Skip();
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));
}
}
return sashPos;
}
-void wxSplitterWindow::DoSetSashPosition(int sashPos)
+bool wxSplitterWindow::DoSetSashPosition(int sashPos)
+{
+ int newSashPosition = AdjustSashPosition(sashPos);
+
+ if ( newSashPosition == m_sashPosition )
+ return FALSE;
+
+ m_sashPosition = newSashPosition;
+
+ return TRUE;
+}
+
+void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
{
- m_requestedSashPosition = sashPos;
- m_sashPosition = (sashPos == 0) ? 0 : AdjustSashPosition(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.
// 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 )
+ {
+ // 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() )
// Set pane for unsplit window
void wxSplitterWindow::Initialize(wxWindow *window)
{
+ wxASSERT_MSG( window->GetParent() == this,
+ _T("windows in the splitter should have it as parent!") );
+
m_windowOne = window;
m_windowTwo = (wxWindow *) NULL;
DoSetSashPosition(0);
if ( IsSplit() )
return FALSE;
- int window_size = GetWindowSize();
+ wxASSERT_MSG( window1->GetParent() == this && window2->GetParent() == this,
+ _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
return FALSE;
}
- SendUnsplitEvent(win);
+ OnUnsplit(win);
DoSetSashPosition(0);
SizeWindows();
#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 )
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
event.Skip();
}
//else: do nothing, in particular, don't call Skip()
-#endif // wxMSW
}
+
+#endif // wxMSW
+
projects / wxWidgets.git / blobdiff