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