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