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
  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 #ifdef __WXMAC__
  88     // CoreGraphics can't paint sash feedback
  89     style |= wxSP_LIVE_UPDATE;
  90 #endif
  91
  92     if ( !wxWindow::Create(parent, id, pos, size, style, name) )
  93         return false;
  94
  95     if (size.x >= 0)
  96         m_lastSize.x = size.x;
  97     if (size.y >= 0)
  98         m_lastSize.y = size.y;
  99
 100     m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
 101
 102     // FIXME: with this line the background is not erased at all under GTK1,
 103     //        so temporary avoid it there
 104 #if !defined(__WXGTK__) || defined(__WXGTK20__)
 105     // don't erase the splitter background, it's pointless as we overwrite it
 106     // anyhow
 107     SetBackgroundStyle(wxBG_STYLE_CUSTOM);
 108 #endif
 109
 110     return true;
 111 }
 112
 113 void wxSplitterWindow::Init()
 114 {
 115     WX_INIT_CONTROL_CONTAINER();
 116
 117     m_splitMode = wxSPLIT_VERTICAL;
 118     m_permitUnsplitAlways = true;
 119     m_windowOne = NULL;
 120     m_windowTwo = NULL;
 121     m_dragMode = wxSPLIT_DRAG_NONE;
 122     m_oldX = 0;
 123     m_oldY = 0;
 124     m_firstX = 0;
 125     m_firstY = 0;
 126     m_sashPosition = m_requestedSashPosition = 0;
 127     m_sashGravity = 0.0;
 128     m_sashSize = -1; // -1 means use the native sash size
 129     m_lastSize = wxSize(0,0);
 130     m_checkRequestedSashPosition = false;
 131     m_minimumPaneSize = 0;
 132     m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
 133     m_sashCursorNS = wxCursor(wxCURSOR_SIZENS);
 134     m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxPENSTYLE_SOLID);
 135
 136     m_needUpdating = false;
 137     m_isHot = false;
 138 }
 139
 140 wxSplitterWindow::~wxSplitterWindow()
 141 {
 142     delete m_sashTrackerPen;
 143 }
 144
 145 // ----------------------------------------------------------------------------
 146 // entering/leaving sash
 147 // ----------------------------------------------------------------------------
 148
 149 void wxSplitterWindow::RedrawIfHotSensitive(bool isHot)
 150 {
 151     if ( wxRendererNative::Get().GetSplitterParams(this).isHotSensitive )
 152     {
 153         m_isHot = isHot;
 154
 155         wxClientDC dc(this);
 156         DrawSash(dc);
 157     }
 158     //else: we don't change our appearance, don't redraw to avoid flicker
 159 }
 160
 161 void wxSplitterWindow::OnEnterSash()
 162 {
 163     SetResizeCursor();
 164
 165     RedrawIfHotSensitive(true);
 166 }
 167
 168 void wxSplitterWindow::OnLeaveSash()
 169 {
 170     SetCursor(*wxSTANDARD_CURSOR);
 171
 172     RedrawIfHotSensitive(false);
 173 }
 174
 175 void wxSplitterWindow::SetResizeCursor()
 176 {
 177     SetCursor(m_splitMode == wxSPLIT_VERTICAL ? m_sashCursorWE
 178                                               : m_sashCursorNS);
 179 }
 180
 181 // ----------------------------------------------------------------------------
 182 // other event handlers
 183 // ----------------------------------------------------------------------------
 184
 185 void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
 186 {
 187     wxPaintDC dc(this);
 188
 189     DrawSash(dc);
 190 }
 191
 192 void wxSplitterWindow::OnInternalIdle()
 193 {
 194     wxWindow::OnInternalIdle();
 195
 196     // if this is the first idle time after a sash position has potentially
 197     // been set, allow SizeWindows to check for a requested size.
 198     if (!m_checkRequestedSashPosition)
 199     {
 200         m_checkRequestedSashPosition = true;
 201         SizeWindows();
 202         return; // it won't needUpdating in this case
 203     }
 204
 205     if (m_needUpdating)
 206         SizeWindows();
 207 }
 208
 209 void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
 210 {
 211     int x = (int)event.GetX(),
 212         y = (int)event.GetY();
 213
 214     if (GetWindowStyle() & wxSP_NOSASH)
 215         return;
 216
 217     // with wxSP_LIVE_UPDATE style the splitter windows are always resized
 218     // following the mouse movement while it drags the sash, without it we only
 219     // draw the sash at the new position but only resize the windows when the
 220     // dragging is finished
 221 #if defined( __WXMAC__ )
 222     // FIXME : this should be usable also with no live update, but then this
 223     // currently is not visible
 224     bool isLive = true;
 225 #else
 226     bool isLive = HasFlag(wxSP_LIVE_UPDATE);
 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 = NULL;
 298                 OnUnsplit(removedWindow);
 299                 wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
 300                 eventUnsplit.m_data.win = removedWindow;
 301                 (void)DoSendEvent(eventUnsplit);
 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 = NULL;
 309                 OnUnsplit(removedWindow);
 310                 wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
 311                 eventUnsplit.m_data.win = removedWindow;
 312                 (void)DoSendEvent(eventUnsplit);
 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             if (w2 < 0)
 692                 w2 = 0;
 693             h2 = h - 2*border;
 694             if (h2 < 0)
 695                 h2 = 0;
 696             h1 = h2;
 697             x2 = size2;
 698             y2 = border;
 699         }
 700         else // horz splitter
 701         {
 702             w2 = w - 2*border;
 703             if (w2 < 0)
 704                 w2 = 0;
 705             w1 = w2;
 706             h1 = size1;
 707             h2 = h - 2*border - sash - h1;
 708             if (h2 < 0)
 709                 h2 = 0;
 710             x2 = border;
 711             y2 = size2;
 712         }
 713
 714         GetWindow2()->SetSize(x2, y2, w2, h2);
 715         GetWindow1()->SetSize(border, border, w1, h1);
 716     }
 717
 718     wxClientDC dc(this);
 719     DrawSash(dc);
 720
 721     SetNeedUpdating(false);
 722 }
 723
 724 // Set pane for unsplit window
 725 void wxSplitterWindow::Initialize(wxWindow *window)
 726 {
 727     wxASSERT_MSG( (!window || window->GetParent() == this),
 728                   _T("windows in the splitter should have it as parent!") );
 729
 730     if (window && !window->IsShown())
 731         window->Show();
 732
 733     m_windowOne = window;
 734     m_windowTwo = NULL;
 735     DoSetSashPosition(0);
 736 }
 737
 738 // Associates the given window with window 2, drawing the appropriate sash
 739 // and changing the split mode.
 740 // Does nothing and returns false if the window is already split.
 741 bool wxSplitterWindow::DoSplit(wxSplitMode mode,
 742                                wxWindow *window1, wxWindow *window2,
 743                                int sashPosition)
 744 {
 745     if ( IsSplit() )
 746         return false;
 747
 748     wxCHECK_MSG( window1 && window2, false,
 749                  _T("can not split with NULL window(s)") );
 750
 751     wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
 752                   _T("windows in the splitter should have it as parent!") );
 753
 754     if (! window1->IsShown())
 755         window1->Show();
 756     if (! window2->IsShown())
 757         window2->Show();
 758
 759     m_splitMode = mode;
 760     m_windowOne = window1;
 761     m_windowTwo = window2;
 762
 763     // remember the sash position we want to set for later if we can't set it
 764     // right now (e.g. because the window is too small)
 765     m_requestedSashPosition = sashPosition;
 766     m_checkRequestedSashPosition = false;
 767
 768     DoSetSashPosition(ConvertSashPosition(sashPosition));
 769
 770     SizeWindows();
 771
 772     return true;
 773 }
 774
 775 int wxSplitterWindow::ConvertSashPosition(int sashPosition) const
 776 {
 777     if ( sashPosition > 0 )
 778     {
 779         return sashPosition;
 780     }
 781     else if ( sashPosition < 0 )
 782     {
 783         // It's negative so adding is subtracting
 784         return GetWindowSize() + sashPosition;
 785     }
 786     else // sashPosition == 0
 787     {
 788         // default, put it in the centre
 789         return GetWindowSize() / 2;
 790     }
 791 }
 792
 793 // Remove the specified (or second) window from the view
 794 // Doesn't actually delete the window.
 795 bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
 796 {
 797     if ( ! IsSplit() )
 798         return false;
 799
 800     wxWindow *win;
 801     if ( toRemove == NULL || toRemove == m_windowTwo)
 802     {
 803         win = m_windowTwo ;
 804         m_windowTwo = NULL;
 805     }
 806     else if ( toRemove == m_windowOne )
 807     {
 808         win = m_windowOne ;
 809         m_windowOne = m_windowTwo;
 810         m_windowTwo = NULL;
 811     }
 812     else
 813     {
 814         wxFAIL_MSG(wxT("splitter: attempt to remove a non-existent window"));
 815
 816         return false;
 817     }
 818
 819     OnUnsplit(win);
 820     DoSetSashPosition(0);
 821     SizeWindows();
 822
 823     return true;
 824 }
 825
 826 // Replace a window with another one
 827 bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
 828 {
 829     wxCHECK_MSG( winOld, false, wxT("use one of Split() functions instead") );
 830     wxCHECK_MSG( winNew, false, wxT("use Unsplit() functions instead") );
 831
 832     if ( winOld == m_windowTwo )
 833     {
 834         m_windowTwo = winNew;
 835     }
 836     else if ( winOld == m_windowOne )
 837     {
 838         m_windowOne = winNew;
 839     }
 840     else
 841     {
 842         wxFAIL_MSG(wxT("splitter: attempt to replace a non-existent window"));
 843
 844         return false;
 845     }
 846
 847     SizeWindows();
 848
 849     return true;
 850 }
 851
 852 void wxSplitterWindow::SetMinimumPaneSize(int min)
 853 {
 854     m_minimumPaneSize = min;
 855     int pos = m_requestedSashPosition != INT_MAX ? m_requestedSashPosition : m_sashPosition;
 856     SetSashPosition(pos); // re-check limits
 857 }
 858
 859 void wxSplitterWindow::SetSashPosition(int position, bool redraw)
 860 {
 861     // remember the sash position we want to set for later if we can't set it
 862     // right now (e.g. because the window is too small)
 863     m_requestedSashPosition = position;
 864     m_checkRequestedSashPosition = false;
 865
 866     DoSetSashPosition(ConvertSashPosition(position));
 867
 868     if ( redraw )
 869     {
 870         SizeWindows();
 871     }
 872 }
 873
 874 // Make sure the child window sizes are updated. This is useful
 875 // for reducing flicker by updating the sizes before a
 876 // window is shown, if you know the overall size is correct.
 877 void wxSplitterWindow::UpdateSize()
 878 {
 879     m_checkRequestedSashPosition = true;
 880     SizeWindows();
 881     m_checkRequestedSashPosition = false;
 882 }
 883
 884 bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
 885 {
 886     return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed();
 887 }
 888
 889 wxSize wxSplitterWindow::DoGetBestSize() const
 890 {
 891     // get best sizes of subwindows
 892     wxSize size1, size2;
 893     if ( m_windowOne )
 894         size1 = m_windowOne->GetEffectiveMinSize();
 895     if ( m_windowTwo )
 896         size2 = m_windowTwo->GetEffectiveMinSize();
 897
 898     // sum them
 899     //
 900     // pSash points to the size component to which sash size must be added
 901     int *pSash;
 902     wxSize sizeBest;
 903     if ( m_splitMode == wxSPLIT_VERTICAL )
 904     {
 905         sizeBest.y = wxMax(size1.y, size2.y);
 906         sizeBest.x = wxMax(size1.x, m_minimumPaneSize) +
 907                         wxMax(size2.x, m_minimumPaneSize);
 908
 909         pSash = &sizeBest.x;
 910     }
 911     else // wxSPLIT_HORIZONTAL
 912     {
 913         sizeBest.x = wxMax(size1.x, size2.x);
 914         sizeBest.y = wxMax(size1.y, m_minimumPaneSize) +
 915                         wxMax(size2.y, m_minimumPaneSize);
 916
 917         pSash = &sizeBest.y;
 918     }
 919
 920     // account for the border and the sash
 921     int border = 2*GetBorderSize();
 922     *pSash += GetSashSize();
 923     sizeBest.x += border;
 924     sizeBest.y += border;
 925
 926     return sizeBest;
 927 }
 928
 929 // ---------------------------------------------------------------------------
 930 // wxSplitterWindow virtual functions: they now just generate the events
 931 // ---------------------------------------------------------------------------
 932
 933 bool wxSplitterWindow::OnSashPositionChange(int WXUNUSED(newSashPosition))
 934 {
 935     // always allow by default
 936     return true;
 937 }
 938
 939 int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
 940 {
 941     // If within UNSPLIT_THRESHOLD from edge, set to edge to cause closure.
 942     const int UNSPLIT_THRESHOLD = 4;
 943
 944     // first of all, check if OnSashPositionChange() doesn't forbid this change
 945     if ( !OnSashPositionChange(newSashPosition) )
 946     {
 947         // it does
 948         return -1;
 949     }
 950
 951     // Obtain relevant window dimension for bottom / right threshold check
 952     int window_size = GetWindowSize();
 953
 954     bool unsplit_scenario = false;
 955     if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
 956     {
 957         // Do edge detection if unsplit premitted
 958         if ( newSashPosition <= UNSPLIT_THRESHOLD )
 959         {
 960             // threshold top / left check
 961             newSashPosition = 0;
 962             unsplit_scenario = true;
 963         }
 964         if ( newSashPosition >= window_size - UNSPLIT_THRESHOLD )
 965         {
 966             // threshold bottom/right check
 967             newSashPosition = window_size;
 968             unsplit_scenario = true;
 969         }
 970     }
 971
 972     if ( !unsplit_scenario )
 973     {
 974         // If resultant pane would be too small, enlarge it
 975         newSashPosition = AdjustSashPosition(newSashPosition);
 976     }
 977
 978     // If the result is out of bounds it means minimum size is too big,
 979     // so split window in half as best compromise.
 980     if ( newSashPosition < 0 || newSashPosition > window_size )
 981         newSashPosition = window_size / 2;
 982
 983     // now let the event handler have it
 984     //
 985     // FIXME: shouldn't we do it before the adjustments above so as to ensure
 986     //        that the sash position is always reasonable?
 987     wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, this);
 988     event.m_data.pos = newSashPosition;
 989
 990     if ( !DoSendEvent(event) )
 991     {
 992         // the event handler vetoed the change
 993         newSashPosition = -1;
 994     }
 995     else
 996     {
 997         // it could have been changed by it
 998         newSashPosition = event.GetSashPosition();
 999     }
1000
1001     return newSashPosition;
1002 }
1003
1004 // Called when the sash is double-clicked. The default behaviour is to remove
1005 // the sash if the minimum pane size is zero.
1006 void wxSplitterWindow::OnDoubleClickSash(int x, int y)
1007 {
1008     wxCHECK_RET(m_windowTwo, wxT("splitter: no window to remove"));
1009
1010     // new code should handle events instead of using the virtual functions
1011     wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, this);
1012     event.m_data.pt.x = x;
1013     event.m_data.pt.y = y;
1014     if ( DoSendEvent(event) )
1015     {
1016         if ( GetMinimumPaneSize() == 0 || m_permitUnsplitAlways )
1017         {
1018             wxWindow* win = m_windowTwo;
1019             if ( Unsplit(win) )
1020             {
1021                 wxSplitterEvent unsplitEvent(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
1022                 unsplitEvent.m_data.win = win;
1023                 (void)DoSendEvent(unsplitEvent);
1024             }
1025         }
1026     }
1027     //else: blocked by user
1028 }
1029
1030 void wxSplitterWindow::OnUnsplit(wxWindow *winRemoved)
1031 {
1032     // call this before calling the event handler which may delete the window
1033     winRemoved->Show(false);
1034 }
1035
1036 #if defined( __WXMSW__ ) || defined( __WXMAC__)
1037
1038 // this is currently called (and needed) under MSW only...
1039 void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& event)
1040 {
1041     // if we don't do it, the resizing cursor might be set for child window:
1042     // and like this we explicitly say that our cursor should not be used for
1043     // children windows which overlap us
1044
1045     if ( SashHitTest(event.GetX(), event.GetY(), 0) )
1046     {
1047         // default processing is ok
1048         event.Skip();
1049     }
1050     //else: do nothing, in particular, don't call Skip()
1051 }
1052
1053 #endif // wxMSW || wxMac
1054
1055 #endif // wxUSE_SPLITTER
1056