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