]> git.saurik.com Git - wxWidgets.git/blob - src/generic/splitter.cpp
no 10.4 support anymore
[wxWidgets.git] / src / generic / splitter.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/splitter.cpp
3 // Purpose: wxSplitterWindow implementation
4 // Author: Julian Smart
5 // Modified by:
6 // Created: 01/02/97
7 // RCS-ID: $Id$
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 // For compilers that support precompilation, includes "wx.h".
13 #include "wx/wxprec.h"
14
15 #ifdef __BORLANDC__
16 #pragma hdrstop
17 #endif
18
19 #if wxUSE_SPLITTER
20
21 #include "wx/splitter.h"
22
23 #ifndef WX_PRECOMP
24 #include "wx/string.h"
25 #include "wx/utils.h"
26 #include "wx/log.h"
27
28 #include "wx/dcclient.h"
29 #include "wx/dcscreen.h"
30
31 #include "wx/window.h"
32 #include "wx/dialog.h"
33 #include "wx/frame.h"
34
35 #include "wx/settings.h"
36 #endif
37
38 #include "wx/renderer.h"
39
40 #include <stdlib.h>
41
42 wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, wxSplitterEvent );
43 wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, wxSplitterEvent );
44 wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, wxSplitterEvent );
45 wxDEFINE_EVENT( wxEVT_COMMAND_SPLITTER_UNSPLIT, wxSplitterEvent );
46
47 IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
48
49 /*
50 TODO PROPERTIES
51 style wxSP_3D
52 sashpos (long , 0 )
53 minsize (long -1 )
54 object, object_ref
55 orientation
56 */
57
58 IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent)
59
60 BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow)
61 EVT_PAINT(wxSplitterWindow::OnPaint)
62 EVT_SIZE(wxSplitterWindow::OnSize)
63 EVT_MOUSE_EVENTS(wxSplitterWindow::OnMouseEvent)
64 EVT_MOUSE_CAPTURE_LOST(wxSplitterWindow::OnMouseCaptureLost)
65
66 #if defined( __WXMSW__ ) || defined( __WXMAC__)
67 EVT_SET_CURSOR(wxSplitterWindow::OnSetCursor)
68 #endif // wxMSW
69 END_EVENT_TABLE()
70
71 static bool IsLive(wxSplitterWindow* wnd)
72 {
73 // with wxSP_LIVE_UPDATE style the splitter windows are always resized
74 // following the mouse movement while it drags the sash, without it we only
75 // draw the sash at the new position but only resize the windows when the
76 // dragging is finished
77 #if defined( __WXMAC__ ) && defined(TARGET_API_MAC_OSX) && TARGET_API_MAC_OSX == 1
78 return true; // Mac can't paint outside paint event - always need live mode
79 #else
80 return wnd->HasFlag(wxSP_LIVE_UPDATE);
81 #endif
82 }
83
84 bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
85 const wxPoint& pos,
86 const wxSize& size,
87 long style,
88 const wxString& name)
89 {
90 // allow TABbing from one window to the other
91 style |= wxTAB_TRAVERSAL;
92
93 if ( !wxWindow::Create(parent, id, pos, size, style, name) )
94 return false;
95
96 m_lastSize = GetClientSize();
97
98 m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
99
100 // FIXME: with this line the background is not erased at all under GTK1,
101 // so temporary avoid it there
102 #if !defined(__WXGTK__) || defined(__WXGTK20__)
103 // don't erase the splitter background, it's pointless as we overwrite it
104 // anyhow
105 SetBackgroundStyle(wxBG_STYLE_CUSTOM);
106 #endif
107
108 return true;
109 }
110
111 void wxSplitterWindow::Init()
112 {
113 m_splitMode = wxSPLIT_VERTICAL;
114 m_permitUnsplitAlways = true;
115 m_windowOne = NULL;
116 m_windowTwo = NULL;
117 m_dragMode = wxSPLIT_DRAG_NONE;
118 m_oldX = 0;
119 m_oldY = 0;
120 m_sashStart = 0;
121 m_sashPosition = 0;
122 m_requestedSashPosition = INT_MAX;
123 m_sashGravity = 0.0;
124 m_lastSize = wxSize(0,0);
125 m_minimumPaneSize = 0;
126 m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
127 m_sashCursorNS = wxCursor(wxCURSOR_SIZENS);
128 m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxPENSTYLE_SOLID);
129
130 m_needUpdating = false;
131 m_isHot = false;
132 }
133
134 wxSplitterWindow::~wxSplitterWindow()
135 {
136 delete m_sashTrackerPen;
137 }
138
139 // ----------------------------------------------------------------------------
140 // entering/leaving sash
141 // ----------------------------------------------------------------------------
142
143 void wxSplitterWindow::RedrawIfHotSensitive(bool isHot)
144 {
145 if ( wxRendererNative::Get().GetSplitterParams(this).isHotSensitive )
146 {
147 m_isHot = isHot;
148
149 wxClientDC dc(this);
150 DrawSash(dc);
151 }
152 //else: we don't change our appearance, don't redraw to avoid flicker
153 }
154
155 void wxSplitterWindow::OnEnterSash()
156 {
157 SetResizeCursor();
158
159 RedrawIfHotSensitive(true);
160 }
161
162 void wxSplitterWindow::OnLeaveSash()
163 {
164 SetCursor(*wxSTANDARD_CURSOR);
165
166 RedrawIfHotSensitive(false);
167 }
168
169 void wxSplitterWindow::SetResizeCursor()
170 {
171 SetCursor(m_splitMode == wxSPLIT_VERTICAL ? m_sashCursorWE
172 : m_sashCursorNS);
173 }
174
175 // ----------------------------------------------------------------------------
176 // other event handlers
177 // ----------------------------------------------------------------------------
178
179 void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
180 {
181 wxPaintDC dc(this);
182 #ifdef __WXOSX__
183 // as subpanels might have a transparent background we must erase the background
184 // at least on OSX, otherwise traces of the sash will remain
185 // test with: splitter sample->replace right window
186 dc.Clear();
187 #endif
188
189 DrawSash(dc);
190 }
191
192 void wxSplitterWindow::OnInternalIdle()
193 {
194 wxWindow::OnInternalIdle();
195
196 // We may need to update the children sizes in two cases: either because
197 // we're in the middle of a live update as indicated by m_needUpdating or
198 // because we have a requested but not yet set sash position as indicated
199 // by m_requestedSashPosition having a valid value.
200 if ( m_needUpdating )
201 {
202 m_needUpdating = false;
203 }
204 else if ( m_requestedSashPosition == INT_MAX )
205 {
206 // We don't need to resize the children.
207 return;
208 }
209
210 SizeWindows();
211 }
212
213 void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
214 {
215 int x = (int)event.GetX(),
216 y = (int)event.GetY();
217
218 if ( GetWindowStyle() & wxSP_NOSASH )
219 {
220 event.Skip();
221 return;
222 }
223
224 bool isLive = IsLive(this);
225
226 if (event.LeftDown())
227 {
228 if ( SashHitTest(x, y) )
229 {
230 // Start the drag now
231 m_dragMode = wxSPLIT_DRAG_DRAGGING;
232
233 // Capture mouse and set the cursor
234 CaptureMouse();
235 SetResizeCursor();
236
237 if ( !isLive )
238 {
239 // remember the initial sash position and draw the initial
240 // shadow sash
241 m_sashPositionCurrent = m_sashPosition;
242
243 m_oldX = (m_splitMode == wxSPLIT_VERTICAL ? m_sashPositionCurrent : x);
244 m_oldY = (m_splitMode != wxSPLIT_VERTICAL ? m_sashPositionCurrent : y);
245 DrawSashTracker(m_oldX, m_oldY);
246 }
247
248 m_ptStart = wxPoint(x,y);
249 m_sashStart = m_sashPosition;
250 return;
251 }
252 }
253 else if (event.LeftUp() && m_dragMode == wxSPLIT_DRAG_DRAGGING)
254 {
255 // We can stop dragging now and see what we've got.
256 m_dragMode = wxSPLIT_DRAG_NONE;
257
258 // Release mouse and unset the cursor
259 ReleaseMouse();
260 SetCursor(* wxSTANDARD_CURSOR);
261
262 // exit if unsplit after doubleclick
263 if ( !IsSplit() )
264 {
265 return;
266 }
267
268 // Erase old tracker
269 if ( !isLive )
270 {
271 DrawSashTracker(m_oldX, m_oldY);
272 }
273
274 // the position of the click doesn't exactly correspond to
275 // m_sashPosition, rather it changes it by the distance by which the
276 // mouse has moved
277 int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_ptStart.x : y - m_ptStart.y;
278
279 int posSashNew = OnSashPositionChanging(m_sashStart + diff);
280 if ( posSashNew == -1 )
281 {
282 // change not allowed
283 return;
284 }
285
286 if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
287 {
288 // Deal with possible unsplit scenarios
289 if ( posSashNew == 0 )
290 {
291 // We remove the first window from the view
292 wxWindow *removedWindow = m_windowOne;
293 m_windowOne = m_windowTwo;
294 m_windowTwo = NULL;
295 OnUnsplit(removedWindow);
296 wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
297 eventUnsplit.m_data.win = removedWindow;
298 (void)DoSendEvent(eventUnsplit);
299 SetSashPositionAndNotify(0);
300 }
301 else if ( posSashNew == GetWindowSize() )
302 {
303 // We remove the second window from the view
304 wxWindow *removedWindow = m_windowTwo;
305 m_windowTwo = NULL;
306 OnUnsplit(removedWindow);
307 wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
308 eventUnsplit.m_data.win = removedWindow;
309 (void)DoSendEvent(eventUnsplit);
310 SetSashPositionAndNotify(0);
311 }
312 else
313 {
314 SetSashPositionAndNotify(posSashNew);
315 }
316 }
317 else
318 {
319 SetSashPositionAndNotify(posSashNew);
320 }
321
322 SizeWindows();
323 } // left up && dragging
324 else if ((event.Moving() || event.Leaving() || event.Entering()) && (m_dragMode == wxSPLIT_DRAG_NONE))
325 {
326 if ( event.Leaving() || !SashHitTest(x, y) )
327 OnLeaveSash();
328 else
329 OnEnterSash();
330 }
331 else if (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING))
332 {
333 int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_ptStart.x : y - m_ptStart.y;
334
335 int posSashNew = OnSashPositionChanging(m_sashStart + diff);
336 if ( posSashNew == -1 )
337 {
338 // change not allowed
339 return;
340 }
341
342 if ( !isLive )
343 {
344 if ( posSashNew == m_sashPositionCurrent )
345 return;
346
347 m_sashPositionCurrent = posSashNew;
348
349 // Erase old tracker
350 DrawSashTracker(m_oldX, m_oldY);
351
352 m_oldX = (m_splitMode == wxSPLIT_VERTICAL ? m_sashPositionCurrent : x);
353 m_oldY = (m_splitMode != wxSPLIT_VERTICAL ? m_sashPositionCurrent : y);
354
355 #ifdef __WXMSW__
356 // As we captured the mouse, we may get the mouse events from outside
357 // our window - for example, negative values in x, y. This has a weird
358 // consequence under MSW where we use unsigned values sometimes and
359 // signed ones other times: the coordinates turn as big positive
360 // numbers and so the sash is drawn on the *right* side of the window
361 // instead of the left (or bottom instead of top). Correct this.
362 if ( (short)m_oldX < 0 )
363 m_oldX = 0;
364 if ( (short)m_oldY < 0 )
365 m_oldY = 0;
366 #endif // __WXMSW__
367
368 // Draw new one
369 DrawSashTracker(m_oldX, m_oldY);
370 }
371 else
372 {
373 if ( posSashNew == m_sashPosition )
374 return;
375
376 DoSetSashPosition(posSashNew);
377
378 // in live mode, the new position is the actual sash position, clear requested position!
379 m_requestedSashPosition = INT_MAX;
380 m_needUpdating = true;
381 }
382 }
383 else if ( event.LeftDClick() && m_windowTwo )
384 {
385 OnDoubleClickSash(x, y);
386 }
387 else
388 {
389 event.Skip();
390 }
391 }
392
393 void wxSplitterWindow::OnMouseCaptureLost(wxMouseCaptureLostEvent& WXUNUSED(event))
394 {
395 if (m_dragMode != wxSPLIT_DRAG_DRAGGING)
396 return;
397
398 m_dragMode = wxSPLIT_DRAG_NONE;
399
400 SetCursor(* wxSTANDARD_CURSOR);
401
402 // Erase old tracker
403 if ( !IsLive(this) )
404 {
405 DrawSashTracker(m_oldX, m_oldY);
406 }
407 }
408
409 void wxSplitterWindow::OnSize(wxSizeEvent& event)
410 {
411 // only process this message if we're not iconized - otherwise iconizing
412 // and restoring a window containing the splitter has a funny side effect
413 // of changing the splitter position!
414 wxWindow *parent = wxGetTopLevelParent(this);
415 bool iconized;
416
417 wxTopLevelWindow *winTop = wxDynamicCast(parent, wxTopLevelWindow);
418 if ( winTop )
419 {
420 iconized = winTop->IsIconized();
421 }
422 else
423 {
424 wxFAIL_MSG(wxT("should have a top level parent!"));
425
426 iconized = false;
427 }
428
429 if ( iconized )
430 {
431 m_lastSize = wxSize(0,0);
432
433 event.Skip();
434
435 return;
436 }
437
438 const wxSize curSize = event.GetSize();
439
440 // Update the sash position if needed.
441 //
442 // Notice that we shouldn't do this if the sash position requested by user
443 // couldn't be set yet as it would never be taken into account at all if we
444 // modified it before this happens.
445 if ( m_windowTwo && m_requestedSashPosition == INT_MAX )
446 {
447 int size = m_splitMode == wxSPLIT_VERTICAL ? curSize.x : curSize.y;
448
449 int old_size = m_splitMode == wxSPLIT_VERTICAL ? m_lastSize.x : m_lastSize.y;
450
451 // Don't do anything if the size didn't really change.
452 if ( size != old_size )
453 {
454 int newPosition = -1;
455
456 // Apply gravity if we use it.
457 int delta = (int) ( (size - old_size)*m_sashGravity );
458 if ( delta != 0 )
459 {
460 newPosition = m_sashPosition + delta;
461 if( newPosition < m_minimumPaneSize )
462 newPosition = m_minimumPaneSize;
463 }
464
465 // Also check if the second window became too small.
466 newPosition = AdjustSashPosition(newPosition == -1
467 ? m_sashPosition
468 : newPosition);
469 if ( newPosition != m_sashPosition )
470 SetSashPositionAndNotify(newPosition);
471 }
472 }
473
474 m_lastSize = curSize;
475
476 SizeWindows();
477 }
478
479 void wxSplitterWindow::SetSashGravity(double gravity)
480 {
481 wxCHECK_RET( gravity >= 0. && gravity <= 1.,
482 wxT("invalid gravity value") );
483
484 m_sashGravity = gravity;
485 }
486
487 bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
488 {
489 if ( m_windowTwo == NULL || m_sashPosition == 0)
490 return false; // No sash
491
492 int z = m_splitMode == wxSPLIT_VERTICAL ? x : y;
493 int hitMin = m_sashPosition - tolerance;
494 int hitMax = m_sashPosition + GetSashSize() + tolerance;
495
496 return z >= hitMin && z <= hitMax;
497 }
498
499 int wxSplitterWindow::GetSashSize() const
500 {
501 return wxRendererNative::Get().GetSplitterParams(this).widthSash;
502 }
503
504 int wxSplitterWindow::GetBorderSize() const
505 {
506 return wxRendererNative::Get().GetSplitterParams(this).border;
507 }
508
509 // Draw the sash
510 void wxSplitterWindow::DrawSash(wxDC& dc)
511 {
512 if (HasFlag(wxSP_3DBORDER))
513 wxRendererNative::Get().DrawSplitterBorder
514 (
515 this,
516 dc,
517 GetClientRect()
518 );
519
520 // don't draw sash if we're not split
521 if ( m_sashPosition == 0 || !m_windowTwo )
522 return;
523
524 // nor if we're configured to not show it
525 if ( HasFlag(wxSP_NOSASH) )
526 return;
527
528 wxRendererNative::Get().DrawSplitterSash
529 (
530 this,
531 dc,
532 GetClientSize(),
533 m_sashPosition,
534 m_splitMode == wxSPLIT_VERTICAL ? wxVERTICAL
535 : wxHORIZONTAL,
536 m_isHot ? (int)wxCONTROL_CURRENT : 0
537 );
538 }
539
540 // Draw the sash tracker (for whilst moving the sash)
541 void wxSplitterWindow::DrawSashTracker(int x, int y)
542 {
543 int w, h;
544 GetClientSize(&w, &h);
545
546 wxScreenDC screenDC;
547 int x1, y1;
548 int x2, y2;
549
550 if ( m_splitMode == wxSPLIT_VERTICAL )
551 {
552 x1 = x2 = wxClip(x, 0, w) + m_sashTrackerPen->GetWidth()/2;
553 y1 = 2;
554 y2 = h-2;
555 }
556 else
557 {
558 y1 = y2 = wxClip(y, 0, h) + m_sashTrackerPen->GetWidth()/2;
559 x1 = 2;
560 x2 = w-2;
561 }
562
563 ClientToScreen(&x1, &y1);
564 ClientToScreen(&x2, &y2);
565
566 screenDC.SetLogicalFunction(wxINVERT);
567 screenDC.SetPen(*m_sashTrackerPen);
568 screenDC.SetBrush(*wxTRANSPARENT_BRUSH);
569
570 screenDC.DrawLine(x1, y1, x2, y2);
571
572 screenDC.SetLogicalFunction(wxCOPY);
573 }
574
575 int wxSplitterWindow::GetWindowSize() const
576 {
577 wxSize size = GetClientSize();
578
579 return m_splitMode == wxSPLIT_VERTICAL ? size.x : size.y;
580 }
581
582 int wxSplitterWindow::AdjustSashPosition(int sashPos) const
583 {
584 wxWindow *win;
585
586 win = GetWindow1();
587 if ( win )
588 {
589 // the window shouldn't be smaller than its own minimal size nor
590 // smaller than the minimual pane size specified for this splitter
591 int minSize = m_splitMode == wxSPLIT_VERTICAL ? win->GetMinWidth()
592 : win->GetMinHeight();
593
594 if ( minSize == -1 || m_minimumPaneSize > minSize )
595 minSize = m_minimumPaneSize;
596
597 minSize += GetBorderSize();
598
599 if ( sashPos < minSize )
600 sashPos = minSize;
601 }
602
603 win = GetWindow2();
604 if ( win )
605 {
606 int minSize = m_splitMode == wxSPLIT_VERTICAL ? win->GetMinWidth()
607 : win->GetMinHeight();
608
609 if ( minSize == -1 || m_minimumPaneSize > minSize )
610 minSize = m_minimumPaneSize;
611
612 int maxSize = GetWindowSize() - minSize - GetBorderSize() - GetSashSize();
613 if ( maxSize > 0 && sashPos > maxSize && maxSize >= m_minimumPaneSize)
614 sashPos = maxSize;
615 }
616
617 return sashPos;
618 }
619
620 bool wxSplitterWindow::DoSetSashPosition(int sashPos)
621 {
622 int newSashPosition = AdjustSashPosition(sashPos);
623
624 if ( newSashPosition == m_sashPosition )
625 return false;
626
627 m_sashPosition = newSashPosition;
628
629 return true;
630 }
631
632 void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
633 {
634 // we must reset the request here, otherwise the sash would be stuck at
635 // old position if the user attempted to move the sash after invalid
636 // (e.g. smaller than minsize) sash position was requested using
637 // SetSashPosition():
638 m_requestedSashPosition = INT_MAX;
639
640 // note that we must send the event in any case, i.e. even if the sash
641 // position hasn't changed and DoSetSashPosition() returns false because we
642 // must generate a CHANGED event at the end of resizing
643 DoSetSashPosition(sashPos);
644
645 wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this);
646 event.m_data.pos = m_sashPosition;
647
648 (void)DoSendEvent(event);
649 }
650
651 // Position and size subwindows.
652 // Note that the border size applies to each subwindow, not
653 // including the edges next to the sash.
654 void wxSplitterWindow::SizeWindows()
655 {
656 // check if we have delayed setting the real sash position
657 if ( m_requestedSashPosition != INT_MAX )
658 {
659 int newSashPosition = ConvertSashPosition(m_requestedSashPosition);
660 if ( newSashPosition != m_sashPosition )
661 {
662 DoSetSashPosition(newSashPosition);
663 }
664
665 if ( newSashPosition <= m_sashPosition
666 && newSashPosition >= m_sashPosition - GetBorderSize() )
667 {
668 // don't update it any more
669 m_requestedSashPosition = INT_MAX;
670 }
671 }
672
673 int w, h;
674 GetClientSize(&w, &h);
675
676 if ( GetWindow1() && !GetWindow2() )
677 {
678 GetWindow1()->SetSize(GetBorderSize(), GetBorderSize(),
679 w - 2*GetBorderSize(), h - 2*GetBorderSize());
680 }
681 else if ( GetWindow1() && GetWindow2() )
682 {
683 const int border = GetBorderSize(),
684 sash = GetSashSize();
685
686 int size1 = GetSashPosition() - border,
687 size2 = GetSashPosition() + sash;
688
689 int x2, y2, w1, h1, w2, h2;
690 if ( GetSplitMode() == wxSPLIT_VERTICAL )
691 {
692 w1 = size1;
693 w2 = w - 2*border - sash - w1;
694 if (w2 < 0)
695 w2 = 0;
696 h2 = h - 2*border;
697 if (h2 < 0)
698 h2 = 0;
699 h1 = h2;
700 x2 = size2;
701 y2 = border;
702 }
703 else // horz splitter
704 {
705 w2 = w - 2*border;
706 if (w2 < 0)
707 w2 = 0;
708 w1 = w2;
709 h1 = size1;
710 h2 = h - 2*border - sash - h1;
711 if (h2 < 0)
712 h2 = 0;
713 x2 = border;
714 y2 = size2;
715 }
716
717 GetWindow2()->SetSize(x2, y2, w2, h2);
718 GetWindow1()->SetSize(border, border, w1, h1);
719 }
720
721 wxClientDC dc(this);
722 DrawSash(dc);
723 }
724
725 // Set pane for unsplit window
726 void wxSplitterWindow::Initialize(wxWindow *window)
727 {
728 wxASSERT_MSG( (!window || window->GetParent() == this),
729 wxT("windows in the splitter should have it as parent!") );
730
731 if (window && !window->IsShown())
732 window->Show();
733
734 m_windowOne = window;
735 m_windowTwo = NULL;
736 DoSetSashPosition(0);
737 }
738
739 // Associates the given window with window 2, drawing the appropriate sash
740 // and changing the split mode.
741 // Does nothing and returns false if the window is already split.
742 bool wxSplitterWindow::DoSplit(wxSplitMode mode,
743 wxWindow *window1, wxWindow *window2,
744 int sashPosition)
745 {
746 if ( IsSplit() )
747 return false;
748
749 wxCHECK_MSG( window1 && window2, false,
750 wxT("cannot split with NULL window(s)") );
751
752 wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
753 wxT("windows in the splitter should have it as parent!") );
754
755 if (! window1->IsShown())
756 window1->Show();
757 if (! window2->IsShown())
758 window2->Show();
759
760 m_splitMode = mode;
761 m_windowOne = window1;
762 m_windowTwo = window2;
763
764
765 SetSashPosition(sashPosition, true);
766 return true;
767 }
768
769 int wxSplitterWindow::ConvertSashPosition(int sashPosition) const
770 {
771 if ( sashPosition > 0 )
772 {
773 return sashPosition;
774 }
775 else if ( sashPosition < 0 )
776 {
777 // It's negative so adding is subtracting
778 return GetWindowSize() + sashPosition;
779 }
780 else // sashPosition == 0
781 {
782 // default, put it in the centre
783 return GetWindowSize() / 2;
784 }
785 }
786
787 // Remove the specified (or second) window from the view
788 // Doesn't actually delete the window.
789 bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
790 {
791 if ( ! IsSplit() )
792 return false;
793
794 wxWindow *win;
795 if ( toRemove == NULL || toRemove == m_windowTwo)
796 {
797 win = m_windowTwo ;
798 m_windowTwo = NULL;
799 }
800 else if ( toRemove == m_windowOne )
801 {
802 win = m_windowOne ;
803 m_windowOne = m_windowTwo;
804 m_windowTwo = NULL;
805 }
806 else
807 {
808 wxFAIL_MSG(wxT("splitter: attempt to remove a non-existent window"));
809
810 return false;
811 }
812
813 OnUnsplit(win);
814 DoSetSashPosition(0);
815 SizeWindows();
816
817 return true;
818 }
819
820 // Replace a window with another one
821 bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
822 {
823 wxCHECK_MSG( winOld, false, wxT("use one of Split() functions instead") );
824 wxCHECK_MSG( winNew, false, wxT("use Unsplit() functions instead") );
825
826 if ( winOld == m_windowTwo )
827 {
828 m_windowTwo = winNew;
829 }
830 else if ( winOld == m_windowOne )
831 {
832 m_windowOne = winNew;
833 }
834 else
835 {
836 wxFAIL_MSG(wxT("splitter: attempt to replace a non-existent window"));
837
838 return false;
839 }
840
841 SizeWindows();
842
843 return true;
844 }
845
846 void wxSplitterWindow::SetMinimumPaneSize(int min)
847 {
848 m_minimumPaneSize = min;
849 int pos = m_requestedSashPosition != INT_MAX ? m_requestedSashPosition : m_sashPosition;
850 SetSashPosition(pos); // re-check limits
851 }
852
853 void wxSplitterWindow::SetSashPosition(int position, bool redraw)
854 {
855 // remember the sash position we want to set for later if we can't set it
856 // right now (e.g. because the window is too small)
857 m_requestedSashPosition = position;
858
859 DoSetSashPosition(ConvertSashPosition(position));
860
861 if ( redraw )
862 {
863 SizeWindows();
864 }
865 }
866
867 // Make sure the child window sizes are updated. This is useful
868 // for reducing flicker by updating the sizes before a
869 // window is shown, if you know the overall size is correct.
870 void wxSplitterWindow::UpdateSize()
871 {
872 SizeWindows();
873 }
874
875 bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
876 {
877 return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed();
878 }
879
880 wxSize wxSplitterWindow::DoGetBestSize() const
881 {
882 // get best sizes of subwindows
883 wxSize size1, size2;
884 if ( m_windowOne )
885 size1 = m_windowOne->GetEffectiveMinSize();
886 if ( m_windowTwo )
887 size2 = m_windowTwo->GetEffectiveMinSize();
888
889 // sum them
890 //
891 // pSash points to the size component to which sash size must be added
892 int *pSash;
893 wxSize sizeBest;
894 if ( m_splitMode == wxSPLIT_VERTICAL )
895 {
896 sizeBest.y = wxMax(size1.y, size2.y);
897 sizeBest.x = wxMax(size1.x, m_minimumPaneSize) +
898 wxMax(size2.x, m_minimumPaneSize);
899
900 pSash = &sizeBest.x;
901 }
902 else // wxSPLIT_HORIZONTAL
903 {
904 sizeBest.x = wxMax(size1.x, size2.x);
905 sizeBest.y = wxMax(size1.y, m_minimumPaneSize) +
906 wxMax(size2.y, m_minimumPaneSize);
907
908 pSash = &sizeBest.y;
909 }
910
911 // account for the sash if the window is actually split
912 if ( m_windowOne && m_windowTwo )
913 *pSash += GetSashSize();
914
915 // account for the border too
916 int border = 2*GetBorderSize();
917 sizeBest.x += border;
918 sizeBest.y += border;
919
920 return sizeBest;
921 }
922
923 // ---------------------------------------------------------------------------
924 // wxSplitterWindow virtual functions: they now just generate the events
925 // ---------------------------------------------------------------------------
926
927 bool wxSplitterWindow::OnSashPositionChange(int WXUNUSED(newSashPosition))
928 {
929 // always allow by default
930 return true;
931 }
932
933 int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
934 {
935 // If within UNSPLIT_THRESHOLD from edge, set to edge to cause closure.
936 const int UNSPLIT_THRESHOLD = 4;
937
938 // first of all, check if OnSashPositionChange() doesn't forbid this change
939 if ( !OnSashPositionChange(newSashPosition) )
940 {
941 // it does
942 return -1;
943 }
944
945 // Obtain relevant window dimension for bottom / right threshold check
946 int window_size = GetWindowSize();
947
948 bool unsplit_scenario = false;
949 if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
950 {
951 // Do edge detection if unsplit premitted
952 if ( newSashPosition <= UNSPLIT_THRESHOLD )
953 {
954 // threshold top / left check
955 newSashPosition = 0;
956 unsplit_scenario = true;
957 }
958 if ( newSashPosition >= window_size - UNSPLIT_THRESHOLD )
959 {
960 // threshold bottom/right check
961 newSashPosition = window_size;
962 unsplit_scenario = true;
963 }
964 }
965
966 if ( !unsplit_scenario )
967 {
968 // If resultant pane would be too small, enlarge it
969 newSashPosition = AdjustSashPosition(newSashPosition);
970
971 // If the result is out of bounds it means minimum size is too big,
972 // so split window in half as best compromise.
973 if ( newSashPosition < 0 || newSashPosition > window_size )
974 newSashPosition = window_size / 2;
975 }
976
977 // now let the event handler have it
978 //
979 // FIXME: shouldn't we do it before the adjustments above so as to ensure
980 // that the sash position is always reasonable?
981 wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, this);
982 event.m_data.pos = newSashPosition;
983
984 if ( !DoSendEvent(event) )
985 {
986 // the event handler vetoed the change
987 newSashPosition = -1;
988 }
989 else
990 {
991 // it could have been changed by it
992 newSashPosition = event.GetSashPosition();
993 }
994
995 return newSashPosition;
996 }
997
998 // Called when the sash is double-clicked. The default behaviour is to remove
999 // the sash if the minimum pane size is zero.
1000 void wxSplitterWindow::OnDoubleClickSash(int x, int y)
1001 {
1002 wxCHECK_RET(m_windowTwo, wxT("splitter: no window to remove"));
1003
1004 // new code should handle events instead of using the virtual functions
1005 wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, this);
1006 event.m_data.pt.x = x;
1007 event.m_data.pt.y = y;
1008 if ( DoSendEvent(event) )
1009 {
1010 if ( GetMinimumPaneSize() == 0 || m_permitUnsplitAlways )
1011 {
1012 wxWindow* win = m_windowTwo;
1013 if ( Unsplit(win) )
1014 {
1015 wxSplitterEvent unsplitEvent(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
1016 unsplitEvent.m_data.win = win;
1017 (void)DoSendEvent(unsplitEvent);
1018 }
1019 }
1020 }
1021 //else: blocked by user
1022 }
1023
1024 void wxSplitterWindow::OnUnsplit(wxWindow *winRemoved)
1025 {
1026 // call this before calling the event handler which may delete the window
1027 winRemoved->Show(false);
1028 }
1029
1030 #if defined( __WXMSW__ ) || defined( __WXMAC__)
1031
1032 // this is currently called (and needed) under MSW only...
1033 void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& event)
1034 {
1035 // if we don't do it, the resizing cursor might be set for child window:
1036 // and like this we explicitly say that our cursor should not be used for
1037 // children windows which overlap us
1038
1039 if ( SashHitTest(event.GetX(), event.GetY(), 0) )
1040 {
1041 // default processing is ok
1042 event.Skip();
1043 }
1044 //else: do nothing, in particular, don't call Skip()
1045 }
1046
1047 #endif // wxMSW || wxMac
1048
1049 #endif // wxUSE_SPLITTER
1050