/////////////////////////////////////////////////////////////////////////////
-// Name: splitter.cpp
+// Name: src/generic/splitter.cpp
// Purpose: wxSplitterWindow implementation
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Copyright: (c) Julian Smart
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
-#ifdef __GNUG__
-#pragma implementation "splitter.h"
-// #pragma interface
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
-#pragma hdrstop
+ #pragma hdrstop
#endif
+#if wxUSE_SPLITTER
+
+#include "wx/splitter.h"
+
#ifndef WX_PRECOMP
-#include "wx/wx.h"
+ #include "wx/string.h"
+ #include "wx/utils.h"
+ #include "wx/log.h"
+
+ #include "wx/dcclient.h"
+ #include "wx/dcscreen.h"
+
+ #include "wx/window.h"
+ #include "wx/dialog.h"
+ #include "wx/frame.h"
+
+ #include "wx/settings.h"
#endif
-#include <math.h>
+#include "wx/renderer.h"
+
#include <stdlib.h>
-#include "wx/string.h"
-#include "wx/splitter.h"
-#include "wx/dcscreen.h"
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED)
+DEFINE_EVENT_TYPE(wxEVT_COMMAND_SPLITTER_UNSPLIT)
-#if !USE_SHARED_LIBRARY
IMPLEMENT_DYNAMIC_CLASS(wxSplitterWindow, wxWindow)
+/*
+ TODO PROPERTIES
+ style wxSP_3D
+ sashpos (long , 0 )
+ minsize (long -1 )
+ object, object_ref
+ orientation
+*/
+
+IMPLEMENT_DYNAMIC_CLASS(wxSplitterEvent, wxNotifyEvent)
+
BEGIN_EVENT_TABLE(wxSplitterWindow, wxWindow)
EVT_PAINT(wxSplitterWindow::OnPaint)
EVT_SIZE(wxSplitterWindow::OnSize)
EVT_MOUSE_EVENTS(wxSplitterWindow::OnMouseEvent)
+
+#if defined( __WXMSW__ ) || defined( __WXMAC__)
+ EVT_SET_CURSOR(wxSplitterWindow::OnSetCursor)
+#endif // wxMSW
+
+ WX_EVENT_TABLE_CONTROL_CONTAINER(wxSplitterWindow)
END_EVENT_TABLE()
-#endif
-wxSplitterWindow::wxSplitterWindow(void)
+WX_DELEGATE_TO_CONTROL_CONTAINER(wxSplitterWindow, wxWindow)
+
+bool wxSplitterWindow::Create(wxWindow *parent, wxWindowID id,
+ const wxPoint& pos,
+ const wxSize& size,
+ long style,
+ const wxString& name)
{
- m_splitMode = wxSPLIT_VERTICAL;
- m_windowOne = NULL;
- m_windowTwo = NULL;
- m_dragMode = wxSPLIT_DRAG_NONE;
- m_oldX = 0;
- m_oldY = 0;
- m_firstX = 0;
- m_firstY = 0;
- m_sashSize = 7;
- m_borderSize = 2;
- m_sashPosition = 0;
- m_sashCursorWE = NULL;
- m_sashCursorNS = NULL;
- m_sashTrackerPen = NULL;
- m_lightShadowPen = NULL;
- m_mediumShadowPen = NULL;
- m_darkShadowPen = NULL;
- m_faceBrush = NULL;
- m_facePen = NULL;
- m_hilightPen = NULL;
- m_minimumPaneSize = 0;
+ // allow TABbing from one window to the other
+ style |= wxTAB_TRAVERSAL;
+
+ // we draw our border ourselves to blend the sash with it
+ style &= ~wxBORDER_MASK;
+ style |= wxBORDER_NONE;
+
+ if ( !wxWindow::Create(parent, id, pos, size, style, name) )
+ return false;
+
+ if (size.x >= 0)
+ m_lastSize.x = size.x;
+ if (size.y >= 0)
+ m_lastSize.y = size.y;
+
+ m_permitUnsplitAlways = (style & wxSP_PERMIT_UNSPLIT) != 0;
+
+ // FIXME: with this line the background is not erased at all under GTK1,
+ // so temporary avoid it there
+#if !defined(__WXGTK__) || defined(__WXGTK20__)
+ // don't erase the splitter background, it's pointless as we overwrite it
+ // anyhow
+ SetBackgroundStyle(wxBG_STYLE_CUSTOM);
+#endif
+
+ return true;
}
-wxSplitterWindow::wxSplitterWindow(wxWindow *parent, wxWindowID id, const wxPoint& pos,
- const wxSize& size, long style, const wxString& name)
- :wxWindow(parent, id, pos, size, style, name)
+void wxSplitterWindow::Init()
{
+ WX_INIT_CONTROL_CONTAINER();
+
m_splitMode = wxSPLIT_VERTICAL;
- m_windowOne = NULL;
- m_windowTwo = NULL;
+ m_permitUnsplitAlways = true;
+ m_windowOne = (wxWindow *) NULL;
+ m_windowTwo = (wxWindow *) NULL;
m_dragMode = wxSPLIT_DRAG_NONE;
m_oldX = 0;
m_oldY = 0;
m_firstX = 0;
m_firstY = 0;
- m_sashSize = 7;
- m_borderSize = 2;
- m_sashPosition = 0;
+ m_sashPosition = m_requestedSashPosition = 0;
+ m_sashGravity = 0.0;
+ m_sashSize = -1; // -1 means use the native sash size
+ m_lastSize = wxSize(0,0);
+ m_checkRequestedSashPosition = false;
m_minimumPaneSize = 0;
- m_sashCursorWE = new wxCursor(wxCURSOR_SIZEWE);
- m_sashCursorNS = new wxCursor(wxCURSOR_SIZENS);
+ m_sashCursorWE = wxCursor(wxCURSOR_SIZEWE);
+ m_sashCursorNS = wxCursor(wxCURSOR_SIZENS);
m_sashTrackerPen = new wxPen(*wxBLACK, 2, wxSOLID);
- m_lightShadowPen = NULL;
- m_mediumShadowPen = NULL;
- m_darkShadowPen = NULL;
- m_faceBrush = NULL;
- m_facePen = NULL;
- m_hilightPen = NULL;
- if ( style & wxSP_3D )
- {
- m_borderSize = 2;
- m_sashSize = 7;
- }
- else if ( style & wxSP_BORDER )
- {
- m_borderSize = 1;
- m_sashSize = 3;
- }
- else
+ m_needUpdating = false;
+ m_isHot = false;
+}
+
+wxSplitterWindow::~wxSplitterWindow()
+{
+ delete m_sashTrackerPen;
+}
+
+// ----------------------------------------------------------------------------
+// entering/leaving sash
+// ----------------------------------------------------------------------------
+
+void wxSplitterWindow::RedrawIfHotSensitive(bool isHot)
+{
+ if ( wxRendererNative::Get().GetSplitterParams(this).isHotSensitive )
{
- m_borderSize = 0;
- m_sashSize = 3;
+ m_isHot = isHot;
+
+ wxClientDC dc(this);
+ DrawSash(dc);
}
+ //else: we don't change our appearance, don't redraw to avoid flicker
+}
- // Eventually, we'll respond to colour change messages
- InitColours();
+void wxSplitterWindow::OnEnterSash()
+{
+ SetResizeCursor();
- SetDoubleClick(TRUE);
+ RedrawIfHotSensitive(true);
+}
+
+void wxSplitterWindow::OnLeaveSash()
+{
+ SetCursor(*wxSTANDARD_CURSOR);
- // For debugging purposes, to see the background.
-// SetBackground(wxBLUE_BRUSH);
+ RedrawIfHotSensitive(false);
}
-wxSplitterWindow::~wxSplitterWindow(void)
+void wxSplitterWindow::SetResizeCursor()
{
- delete m_sashCursorWE;
- delete m_sashCursorNS;
- delete m_sashTrackerPen;
- delete m_lightShadowPen;
- delete m_darkShadowPen;
- delete m_mediumShadowPen;
- delete m_hilightPen;
- delete m_facePen;
- delete m_faceBrush;
+ SetCursor(m_splitMode == wxSPLIT_VERTICAL ? m_sashCursorWE
+ : m_sashCursorNS);
}
+// ----------------------------------------------------------------------------
+// other event handlers
+// ----------------------------------------------------------------------------
+
void wxSplitterWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
{
wxPaintDC dc(this);
- if ( m_borderSize > 0 )
- DrawBorders(dc);
DrawSash(dc);
}
+void wxSplitterWindow::OnInternalIdle()
+{
+ wxWindow::OnInternalIdle();
+
+ // if this is the first idle time after a sash position has potentially
+ // been set, allow SizeWindows to check for a requested size.
+ if (!m_checkRequestedSashPosition)
+ {
+ m_checkRequestedSashPosition = true;
+ SizeWindows();
+ return; // it won't needUpdating in this case
+ }
+
+ if (m_needUpdating)
+ SizeWindows();
+}
+
void wxSplitterWindow::OnMouseEvent(wxMouseEvent& event)
{
- long x, y;
- event.Position(&x, &y);
+ int x = (int)event.GetX(),
+ y = (int)event.GetY();
- if (event.LeftDown())
- {
+ if (GetWindowStyle() & wxSP_NOSASH)
+ return;
+
+ // with wxSP_LIVE_UPDATE style the splitter windows are always resized
+ // following the mouse movement while it drags the sash, without it we only
+ // draw the sash at the new position but only resize the windows when the
+ // dragging is finished
+#if defined( __WXMAC__ )
+ // FIXME : this should be usable also with no live update, but then this
+ // currently is not visible
+ bool isLive = true;
+#else
+ bool isLive = HasFlag(wxSP_LIVE_UPDATE);
+#endif
+ if (event.LeftDown())
+ {
if ( SashHitTest(x, y) )
{
- CaptureMouse();
-
- // Required for X to specify that
- // that we wish to draw on top of all windows
- // - and we optimise by specifying the area
- // for creating the overlap window.
- wxScreenDC::StartDrawingOnTop(this);
-
- // We don't say we're dragging yet; we leave that
- // decision for the Dragging() branch, to ensure
- // the user has dragged a little bit.
- m_dragMode = wxSPLIT_DRAG_LEFT_DOWN;
- m_firstX = x;
- m_firstY = y;
- }
- }
- else if ( event.LeftUp() && m_dragMode == wxSPLIT_DRAG_LEFT_DOWN )
- {
- // Wasn't a proper drag
- ReleaseMouse();
- wxScreenDC::EndDrawingOnTop();
- m_dragMode = wxSPLIT_DRAG_NONE;
+ // Start the drag now
+ m_dragMode = wxSPLIT_DRAG_DRAGGING;
+
+ // Capture mouse and set the cursor
+ CaptureMouse();
+ SetResizeCursor();
- SetCursor(*wxSTANDARD_CURSOR);
+ if ( !isLive )
+ {
+ // remember the initial sash position and draw the initial
+ // shadow sash
+ m_sashPositionCurrent = m_sashPosition;
+
+ DrawSashTracker(x, y);
+ }
+
+ m_oldX = x;
+ m_oldY = y;
+
+ SetResizeCursor();
+ return;
+ }
}
- else if (event.LeftUp() && m_dragMode == wxSPLIT_DRAG_DRAGGING)
- {
+ else if (event.LeftUp() && m_dragMode == wxSPLIT_DRAG_DRAGGING)
+ {
// We can stop dragging now and see what we've got.
m_dragMode = wxSPLIT_DRAG_NONE;
- ReleaseMouse();
- // Erase old tracker
- DrawSashTracker(m_oldX, m_oldY);
- // End drawing on top (frees the window used for drawing
- // over the screen)
- wxScreenDC::EndDrawingOnTop();
+ // Release mouse and unset the cursor
+ ReleaseMouse();
+ SetCursor(* wxSTANDARD_CURSOR);
- int w, h;
- GetClientSize(&w, &h);
- if ( m_splitMode == wxSPLIT_VERTICAL )
+ // exit if unsplit after doubleclick
+ if ( !IsSplit() )
{
- // First check if we should veto this resize because
- // the pane size is too small
- if ( wxMax(x, 0) < m_minimumPaneSize || wxMax((w - x), 0) < m_minimumPaneSize)
- return;
-
- if ( x <= 4 )
- {
- // We remove the first window from the view
- wxWindow *removedWindow = m_windowOne;
- m_windowOne = m_windowTwo;
- m_windowTwo = NULL;
+ return;
+ }
- OnUnsplit(removedWindow);
- m_sashPosition = 0;
- }
- else if ( x >= (w - 4) )
- {
- // We remove the second window from the view
- wxWindow *removedWindow = m_windowTwo;
- m_windowTwo = NULL;
- OnUnsplit(removedWindow);
- m_sashPosition = 0;
- }
- else
- {
- m_sashPosition = x;
- }
+ // Erase old tracker
+ if ( !isLive )
+ {
+ DrawSashTracker(m_oldX, m_oldY);
}
- else
+
+ // the position of the click doesn't exactly correspond to
+ // m_sashPosition, rather it changes it by the distance by which the
+ // mouse has moved
+ int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY;
+
+ int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent;
+ int posSashNew = OnSashPositionChanging(posSashOld + diff);
+ if ( posSashNew == -1 )
{
- // First check if we should veto this resize because
- // the pane size is too small
- if ( wxMax(y, 0) < m_minimumPaneSize || wxMax((h - y), 0) < m_minimumPaneSize)
- return;
+ // change not allowed
+ return;
+ }
- if ( y <= 4 )
+ if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
+ {
+ // Deal with possible unsplit scenarios
+ if ( posSashNew == 0 )
{
// We remove the first window from the view
wxWindow *removedWindow = m_windowOne;
m_windowOne = m_windowTwo;
- m_windowTwo = NULL;
-
+ m_windowTwo = (wxWindow *) NULL;
OnUnsplit(removedWindow);
- m_sashPosition = 0;
+ wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+ eventUnsplit.m_data.win = removedWindow;
+ (void)DoSendEvent(eventUnsplit);
+ SetSashPositionAndNotify(0);
}
- else if ( y >= (h - 4) )
+ else if ( posSashNew == GetWindowSize() )
{
// We remove the second window from the view
wxWindow *removedWindow = m_windowTwo;
- m_windowTwo = NULL;
+ m_windowTwo = (wxWindow *) NULL;
OnUnsplit(removedWindow);
- m_sashPosition = 0;
+ wxSplitterEvent eventUnsplit(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+ eventUnsplit.m_data.win = removedWindow;
+ (void)DoSendEvent(eventUnsplit);
+ SetSashPositionAndNotify(0);
}
else
{
- m_sashPosition = y;
+ SetSashPositionAndNotify(posSashNew);
}
}
- SizeWindows();
- }
- else if (event.Moving() && !event.Dragging())
- {
- // Just change the cursor if required
- if ( SashHitTest(x, y) )
+ else
{
- if ( m_splitMode == wxSPLIT_VERTICAL )
- {
- SetCursor(*m_sashCursorWE);
- }
- else
- {
- SetCursor(*m_sashCursorNS);
- }
+ SetSashPositionAndNotify(posSashNew);
}
+
+ SizeWindows();
+ } // left up && dragging
+ else if ((event.Moving() || event.Leaving() || event.Entering()) && (m_dragMode == wxSPLIT_DRAG_NONE))
+ {
+ if ( event.Leaving() || !SashHitTest(x, y) )
+ OnLeaveSash();
else
+ OnEnterSash();
+ }
+ else if (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING))
+ {
+ int diff = m_splitMode == wxSPLIT_VERTICAL ? x - m_oldX : y - m_oldY;
+ if ( !diff )
{
- SetCursor(*wxSTANDARD_CURSOR);
+ // nothing to do, mouse didn't really move far enough
+ return;
}
- }
- else if ( (event.Dragging() && (m_dragMode == wxSPLIT_DRAG_DRAGGING)) ||
- (event.Dragging() && SashHitTest(x, y, 4)) )
- {
- if ( m_splitMode == wxSPLIT_VERTICAL )
- {
- SetCursor(*m_sashCursorWE);
- }
- else
- {
- SetCursor(*m_sashCursorNS);
- }
-
- // Detect that this is really a drag: we've moved more than 1 pixel either way
- if ((m_dragMode == wxSPLIT_DRAG_LEFT_DOWN) &&
-// (abs((int)x - m_firstX) > 1 || abs((int)y - m_firstY) > 1) )
- (abs((int)x - m_firstX) > 0 || abs((int)y - m_firstY) > 1) )
+
+ int posSashOld = isLive ? m_sashPosition : m_sashPositionCurrent;
+ int posSashNew = OnSashPositionChanging(posSashOld + diff);
+ if ( posSashNew == -1 )
{
- m_dragMode = wxSPLIT_DRAG_DRAGGING;
- DrawSashTracker(x, y);
+ // change not allowed
+ return;
}
- else
+
+ if ( posSashNew == m_sashPosition )
+ return;
+
+ // Erase old tracker
+ if ( !isLive )
{
- if ( m_dragMode == wxSPLIT_DRAG_DRAGGING )
- {
- // Erase old tracker
DrawSashTracker(m_oldX, m_oldY);
-
- // Draw new one
- DrawSashTracker(x, y);
- }
}
+
+ if (m_splitMode == wxSPLIT_VERTICAL)
+ x = posSashNew;
+ else
+ y = posSashNew;
+
+ // Remember old positions
m_oldX = x;
m_oldY = y;
- }
- else if ( event.LeftDClick() )
- {
- OnDoubleClickSash(x, y);
- }
- else
- {
- }
-}
-void wxSplitterWindow::OnSize(wxSizeEvent& WXUNUSED(event))
-{
- int cw, ch;
- GetClientSize( &cw, &ch );
- if ( m_windowTwo )
- {
- if ( m_splitMode == wxSPLIT_VERTICAL )
+#ifdef __WXMSW__
+ // As we captured the mouse, we may get the mouse events from outside
+ // our window - for example, negative values in x, y. This has a weird
+ // consequence under MSW where we use unsigned values sometimes and
+ // signed ones other times: the coordinates turn as big positive
+ // numbers and so the sash is drawn on the *right* side of the window
+ // instead of the left (or bottom instead of top). Correct this.
+ if ( (short)m_oldX < 0 )
+ m_oldX = 0;
+ if ( (short)m_oldY < 0 )
+ m_oldY = 0;
+#endif // __WXMSW__
+
+ // Draw new one
+ if ( !isLive )
{
- if ( m_sashPosition >= (cw - 5) )
- m_sashPosition = wxMax(10, cw - 40);
+ m_sashPositionCurrent = posSashNew;
+
+ DrawSashTracker(m_oldX, m_oldY);
}
- if ( m_splitMode == wxSPLIT_HORIZONTAL )
+ else
{
- if ( m_sashPosition >= (ch - 5) )
- m_sashPosition = wxMax(10, ch - 40);
+ DoSetSashPosition(posSashNew);
+ m_needUpdating = true;
}
}
- SizeWindows();
+ else if ( event.LeftDClick() && m_windowTwo )
+ {
+ OnDoubleClickSash(x, y);
+ }
}
-bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
+void wxSplitterWindow::OnSize(wxSizeEvent& event)
{
- if ( m_windowTwo == NULL || m_sashPosition == 0)
- return FALSE; // No sash
-
- if ( m_splitMode == wxSPLIT_VERTICAL )
+ // only process this message if we're not iconized - otherwise iconizing
+ // and restoring a window containing the splitter has a funny side effect
+ // of changing the splitter position!
+ wxWindow *parent = wxGetTopLevelParent(this);
+ bool iconized;
+
+ wxTopLevelWindow *winTop = wxDynamicCast(parent, wxTopLevelWindow);
+ if ( winTop )
{
- if ( (x >= m_sashPosition - tolerance) && (x <= m_sashPosition + m_sashSize + tolerance) )
- return TRUE;
- else
- return FALSE;
+ iconized = winTop->IsIconized();
}
else
{
- if ( (y >= (m_sashPosition- tolerance)) && (y <= (m_sashPosition + m_sashSize + tolerance)) )
- return TRUE;
- else
- return FALSE;
- }
+ wxFAIL_MSG(wxT("should have a top level parent!"));
- return FALSE;
-}
-
-// Draw 3D effect borders
-void wxSplitterWindow::DrawBorders(wxDC& dc)
-{
- int w, h;
- GetClientSize(&w, &h);
+ iconized = false;
+ }
- if ( GetWindowStyleFlag() & wxSP_3D )
+ if ( iconized )
{
- dc.SetPen(*m_mediumShadowPen);
- dc.DrawLine(0, 0, w-1, 0);
- dc.DrawLine(0, 0, 0, h - 1);
+ m_lastSize = wxSize(0,0);
- dc.SetPen(*m_darkShadowPen);
- dc.DrawLine(1, 1, w-2, 1);
- dc.DrawLine(1, 1, 1, h-2);
+ event.Skip();
- dc.SetPen(*m_hilightPen);
- dc.DrawLine(0, h-1, w-1, h-1);
- dc.DrawLine(w-1, 0, w-1, h); // Surely the maximum y pos. should be h - 1.
- /// Anyway, h is required for MSW.
-
- dc.SetPen(*m_lightShadowPen);
- dc.DrawLine(w-2, 1, w-2, h-2); // Right hand side
- dc.DrawLine(1, h-2, w-1, h-2); // Bottom
- }
- else if ( GetWindowStyleFlag() & wxSP_BORDER )
- {
- dc.SetBrush(*wxTRANSPARENT_BRUSH);
- dc.SetPen(*wxBLACK_PEN);
- dc.DrawRectangle(0, 0, w-1, h-1);
+ return;
}
- dc.SetPen(wxNullPen);
- dc.SetBrush(wxNullBrush);
-}
-
-// Draw the sash
-void wxSplitterWindow::DrawSash(wxDC& dc)
-{
- if ( m_sashPosition == 0 || !m_windowTwo)
- return;
+ if ( m_windowTwo )
+ {
+ int w, h;
+ GetClientSize(&w, &h);
- int w, h;
- GetClientSize(&w, &h);
+ int size = m_splitMode == wxSPLIT_VERTICAL ? w : h;
- if ( GetWindowStyleFlag() & wxSP_3D )
- {
- if ( m_splitMode == wxSPLIT_VERTICAL )
+ int old_size = m_splitMode == wxSPLIT_VERTICAL ? m_lastSize.x : m_lastSize.y;
+ if ( old_size != 0 )
{
- dc.SetPen(*m_facePen);
- dc.SetBrush(*m_faceBrush);
- dc.DrawRectangle(m_sashPosition + 2, 0, m_sashSize - 4, h);
-
- dc.SetBrush(*wxTRANSPARENT_BRUSH);
+ int delta = (int) ( (size - old_size)*m_sashGravity );
+ if ( delta != 0 )
+ {
+ int newPosition = m_sashPosition + delta;
+ if( newPosition < m_minimumPaneSize )
+ newPosition = m_minimumPaneSize;
+ SetSashPositionAndNotify(newPosition);
+ }
+ }
- dc.SetPen(*m_lightShadowPen);
- dc.DrawLine(m_sashPosition, 1, m_sashPosition, h-2);
+ if ( m_sashPosition >= size - 5 )
+ SetSashPositionAndNotify(wxMax(10, size - 40));
+ m_lastSize = wxSize(w,h);
+ }
- dc.SetPen(*m_hilightPen);
- dc.DrawLine(m_sashPosition+1, 0, m_sashPosition+1, h);
+ SizeWindows();
+}
- dc.SetPen(*m_mediumShadowPen);
- dc.DrawLine(m_sashPosition+m_sashSize-2, 1, m_sashPosition+m_sashSize-2, h-1);
+void wxSplitterWindow::SetSashGravity(double gravity)
+{
+ wxCHECK_RET( gravity >= 0. && gravity <= 1.,
+ _T("invalid gravity value") );
- dc.SetPen(*m_darkShadowPen);
- dc.DrawLine(m_sashPosition+m_sashSize-1, 2, m_sashPosition+m_sashSize-1, h-2);
- }
- else
- {
- dc.SetPen(*m_facePen);
- dc.SetBrush(*m_faceBrush);
- dc.DrawRectangle(0, m_sashPosition + 2, w, m_sashSize - 4);
+ m_sashGravity = gravity;
+}
- dc.SetBrush(*wxTRANSPARENT_BRUSH);
+bool wxSplitterWindow::SashHitTest(int x, int y, int tolerance)
+{
+ if ( m_windowTwo == NULL || m_sashPosition == 0)
+ return false; // No sash
- dc.SetPen(*m_lightShadowPen);
- dc.DrawLine(1, m_sashPosition, w-2, m_sashPosition);
+ int z = m_splitMode == wxSPLIT_VERTICAL ? x : y;
+ int hitMin = m_sashPosition - tolerance;
+ int hitMax = m_sashPosition + GetSashSize() + tolerance;
- dc.SetPen(*m_hilightPen);
- dc.DrawLine(0, m_sashPosition+1, w, m_sashPosition+1);
+ return z >= hitMin && z <= hitMax;
+}
- dc.SetPen(*m_mediumShadowPen);
- dc.DrawLine(1, m_sashPosition+m_sashSize-2, w-1, m_sashPosition+m_sashSize-2);
+int wxSplitterWindow::GetSashSize() const
+{
+ return m_sashSize > -1 ? m_sashSize : wxRendererNative::Get().GetSplitterParams(this).widthSash;
+}
- dc.SetPen(*m_darkShadowPen);
- dc.DrawLine(2, m_sashPosition+m_sashSize-1, w-2, m_sashPosition+m_sashSize-1);
- }
- }
- else
- {
- if ( m_splitMode == wxSPLIT_VERTICAL )
- {
- dc.SetPen(*wxBLACK_PEN);
- dc.SetBrush(*wxBLACK_BRUSH);
- int h1 = h-1;
- if ( (GetWindowStyleFlag() & wxSP_BORDER) != wxSP_BORDER )
- h1 += 1; // Not sure why this is necessary...
- dc.DrawRectangle(m_sashPosition, 0, m_sashSize, h1);
- }
- else
- {
- dc.SetPen(*wxBLACK_PEN);
- dc.SetBrush(*wxBLACK_BRUSH);
- int w1 = w-1;
- if ( (GetWindowStyleFlag() & wxSP_BORDER) != wxSP_BORDER )
- w1 ++;
+int wxSplitterWindow::GetBorderSize() const
+{
+ return wxRendererNative::Get().GetSplitterParams(this).border;
+}
- dc.DrawRectangle(0, m_sashPosition, w1, m_sashSize);
- }
+// Draw the sash
+void wxSplitterWindow::DrawSash(wxDC& dc)
+{
+ if (HasFlag(wxSP_3DBORDER))
+ wxRendererNative::Get().DrawSplitterBorder
+ (
+ this,
+ dc,
+ GetClientRect()
+ );
+
+ // don't draw sash if we're not split
+ if ( m_sashPosition == 0 || !m_windowTwo )
+ return;
- }
+ // nor if we're configured to not show it
+ if ( HasFlag(wxSP_NOSASH) )
+ return;
- dc.SetPen(wxNullPen);
- dc.SetBrush(wxNullBrush);
+ wxRendererNative::Get().DrawSplitterSash
+ (
+ this,
+ dc,
+ GetClientSize(),
+ m_sashPosition,
+ m_splitMode == wxSPLIT_VERTICAL ? wxVERTICAL
+ : wxHORIZONTAL,
+ m_isHot ? (int)wxCONTROL_CURRENT : 0
+ );
}
// Draw the sash tracker (for whilst moving the sash)
ClientToScreen(&x1, &y1);
ClientToScreen(&x2, &y2);
- screenDC.SetLogicalFunction(wxXOR);
+ screenDC.SetLogicalFunction(wxINVERT);
screenDC.SetPen(*m_sashTrackerPen);
screenDC.SetBrush(*wxTRANSPARENT_BRUSH);
screenDC.DrawLine(x1, y1, x2, y2);
screenDC.SetLogicalFunction(wxCOPY);
+}
+
+int wxSplitterWindow::GetWindowSize() const
+{
+ wxSize size = GetClientSize();
+
+ return m_splitMode == wxSPLIT_VERTICAL ? size.x : size.y;
+}
+
+int wxSplitterWindow::AdjustSashPosition(int sashPos) const
+{
+ wxWindow *win;
+
+ win = GetWindow1();
+ if ( win )
+ {
+ // the window shouldn't be smaller than its own minimal size nor
+ // smaller than the minimual pane size specified for this splitter
+ int minSize = m_splitMode == wxSPLIT_VERTICAL ? win->GetMinWidth()
+ : win->GetMinHeight();
+
+ if ( minSize == -1 || m_minimumPaneSize > minSize )
+ minSize = m_minimumPaneSize;
+
+ minSize += GetBorderSize();
- screenDC.SetPen(wxNullPen);
- screenDC.SetBrush(wxNullBrush);
+ if ( sashPos < minSize )
+ sashPos = minSize;
+ }
+
+ win = GetWindow2();
+ if ( win )
+ {
+ int minSize = m_splitMode == wxSPLIT_VERTICAL ? win->GetMinWidth()
+ : win->GetMinHeight();
+
+ if ( minSize == -1 || m_minimumPaneSize > minSize )
+ minSize = m_minimumPaneSize;
+
+ int maxSize = GetWindowSize() - minSize - GetBorderSize() - GetSashSize();
+ if ( maxSize > 0 && sashPos > maxSize )
+ sashPos = maxSize;
+ }
+
+ return sashPos;
+}
+
+bool wxSplitterWindow::DoSetSashPosition(int sashPos)
+{
+ int newSashPosition = AdjustSashPosition(sashPos);
+
+ if ( newSashPosition == m_sashPosition )
+ return false;
+
+ m_sashPosition = newSashPosition;
+
+ return true;
+}
+
+void wxSplitterWindow::SetSashPositionAndNotify(int sashPos)
+{
+ // we must reset the request here, otherwise the sash would be stuck at
+ // old position if the user attempted to move the sash after invalid
+ // (e.g. smaller than minsize) sash position was requested using
+ // SetSashPosition():
+ m_requestedSashPosition = INT_MAX;
+
+ // note that we must send the event in any case, i.e. even if the sash
+ // position hasn't changed and DoSetSashPosition() returns false because we
+ // must generate a CHANGED event at the end of resizing
+ DoSetSashPosition(sashPos);
+
+ wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED, this);
+ event.m_data.pos = m_sashPosition;
+
+ (void)DoSendEvent(event);
}
// Position and size subwindows.
// Note that the border size applies to each subwindow, not
// including the edges next to the sash.
-void wxSplitterWindow::SizeWindows(void)
+void wxSplitterWindow::SizeWindows()
{
+ // check if we have delayed setting the real sash position
+ if ( m_checkRequestedSashPosition && m_requestedSashPosition != INT_MAX )
+ {
+ int newSashPosition = ConvertSashPosition(m_requestedSashPosition);
+ if ( newSashPosition != m_sashPosition )
+ {
+ DoSetSashPosition(newSashPosition);
+ }
+
+ if ( newSashPosition <= m_sashPosition
+ && newSashPosition >= m_sashPosition - GetBorderSize() )
+ {
+ // don't update it any more
+ m_requestedSashPosition = INT_MAX;
+ }
+ }
+
int w, h;
GetClientSize(&w, &h);
- if ( m_windowOne && !m_windowTwo )
+ if ( GetWindow1() && !GetWindow2() )
{
- m_windowOne->SetSize(m_borderSize, m_borderSize, w - 2*m_borderSize, h - 2*m_borderSize);
+ GetWindow1()->SetSize(GetBorderSize(), GetBorderSize(),
+ w - 2*GetBorderSize(), h - 2*GetBorderSize());
}
- else if ( m_windowOne && m_windowTwo )
+ else if ( GetWindow1() && GetWindow2() )
{
- if (m_splitMode == wxSPLIT_VERTICAL)
+ const int border = GetBorderSize(),
+ sash = GetSashSize();
+
+ int size1 = GetSashPosition() - border,
+ size2 = GetSashPosition() + sash;
+
+ int x2, y2, w1, h1, w2, h2;
+ if ( GetSplitMode() == wxSPLIT_VERTICAL )
{
- int x1 = m_borderSize;
- int y1 = m_borderSize;
- int w1 = m_sashPosition - m_borderSize;
- int h1 = h - 2*m_borderSize;
-
- int x2 = m_sashPosition + m_sashSize;
- int y2 = m_borderSize;
- int w2 = w - 2*m_borderSize - m_sashSize - w1;
- int h2 = h - 2*m_borderSize;
-
- m_windowOne->SetSize(x1, y1,
- w1, h1);
- m_windowTwo->SetSize(x2, y2,
- w2, h2);
+ w1 = size1;
+ w2 = w - 2*border - sash - w1;
+ if (w2 < 0)
+ w2 = 0;
+ h2 = h - 2*border;
+ if (h2 < 0)
+ h2 = 0;
+ h1 = h2;
+ x2 = size2;
+ y2 = border;
}
- else
+ else // horz splitter
{
- m_windowOne->SetSize(m_borderSize, m_borderSize,
- w - 2*m_borderSize, m_sashPosition - m_borderSize);
- m_windowTwo->SetSize(m_borderSize, m_sashPosition + m_sashSize,
- w - 2*m_borderSize, h - 2*m_borderSize - m_sashSize - (m_sashPosition - m_borderSize));
+ w2 = w - 2*border;
+ if (w2 < 0)
+ w2 = 0;
+ w1 = w2;
+ h1 = size1;
+ h2 = h - 2*border - sash - h1;
+ if (h2 < 0)
+ h2 = 0;
+ x2 = border;
+ y2 = size2;
}
+
+ GetWindow2()->SetSize(x2, y2, w2, h2);
+ GetWindow1()->SetSize(border, border, w1, h1);
}
+
wxClientDC dc(this);
- DrawBorders(dc);
DrawSash(dc);
+
+ SetNeedUpdating(false);
}
// Set pane for unsplit window
void wxSplitterWindow::Initialize(wxWindow *window)
{
+ wxASSERT_MSG( (!window || (window && window->GetParent() == this)),
+ _T("windows in the splitter should have it as parent!") );
+
+ if (window && !window->IsShown())
+ window->Show();
+
m_windowOne = window;
- m_windowTwo = NULL;
- m_sashPosition = 0;
+ m_windowTwo = (wxWindow *) NULL;
+ DoSetSashPosition(0);
}
// Associates the given window with window 2, drawing the appropriate sash
// and changing the split mode.
-// Does nothing and returns FALSE if the window is already split.
-bool wxSplitterWindow::SplitVertically(wxWindow *window1, wxWindow *window2, int sashPosition)
+// Does nothing and returns false if the window is already split.
+bool wxSplitterWindow::DoSplit(wxSplitMode mode,
+ wxWindow *window1, wxWindow *window2,
+ int sashPosition)
{
if ( IsSplit() )
- return FALSE;
+ return false;
- m_splitMode = wxSPLIT_VERTICAL;
- m_windowOne = window1;
- m_windowTwo = window2;
- if ( sashPosition == -1 )
- m_sashPosition = 100;
- else
- m_sashPosition = sashPosition;
+ wxCHECK_MSG( window1 && window2, false,
+ _T("can not split with NULL window(s)") );
- SizeWindows();
+ wxCHECK_MSG( window1->GetParent() == this && window2->GetParent() == this, false,
+ _T("windows in the splitter should have it as parent!") );
- return TRUE;
-}
-
-bool wxSplitterWindow::SplitHorizontally(wxWindow *window1, wxWindow *window2, int sashPosition)
-{
- if ( IsSplit() )
- return FALSE;
+ if (! window1->IsShown())
+ window1->Show();
+ if (! window2->IsShown())
+ window2->Show();
- m_splitMode = wxSPLIT_HORIZONTAL;
+ m_splitMode = mode;
m_windowOne = window1;
m_windowTwo = window2;
- if ( sashPosition == -1 )
- m_sashPosition = 100;
- else
- m_sashPosition = sashPosition;
+
+ // remember the sash position we want to set for later if we can't set it
+ // right now (e.g. because the window is too small)
+ m_requestedSashPosition = sashPosition;
+ m_checkRequestedSashPosition = false;
+
+ DoSetSashPosition(ConvertSashPosition(sashPosition));
SizeWindows();
- return TRUE;
+ return true;
}
+int wxSplitterWindow::ConvertSashPosition(int sashPosition) const
+{
+ if ( sashPosition > 0 )
+ {
+ return sashPosition;
+ }
+ else if ( sashPosition < 0 )
+ {
+ // It's negative so adding is subtracting
+ return GetWindowSize() + sashPosition;
+ }
+ else // sashPosition == 0
+ {
+ // default, put it in the centre
+ return GetWindowSize() / 2;
+ }
+}
// Remove the specified (or second) window from the view
// Doesn't actually delete the window.
bool wxSplitterWindow::Unsplit(wxWindow *toRemove)
{
if ( ! IsSplit() )
- return FALSE;
+ return false;
+ wxWindow *win;
if ( toRemove == NULL || toRemove == m_windowTwo)
{
- wxWindow *win = m_windowTwo ;
- m_windowTwo = NULL;
- m_sashPosition = 0;
- OnUnsplit(win);
- SizeWindows();
+ win = m_windowTwo ;
+ m_windowTwo = (wxWindow *) NULL;
}
else if ( toRemove == m_windowOne )
{
- wxWindow *win = m_windowOne ;
+ win = m_windowOne ;
m_windowOne = m_windowTwo;
- m_windowTwo = NULL;
- m_sashPosition = 0;
- OnUnsplit(win);
- SizeWindows();
+ m_windowTwo = (wxWindow *) NULL;
}
else
- return FALSE;
+ {
+ wxFAIL_MSG(wxT("splitter: attempt to remove a non-existent window"));
+
+ return false;
+ }
+
+ OnUnsplit(win);
+ DoSetSashPosition(0);
+ SizeWindows();
+
+ return true;
+}
+
+// Replace a window with another one
+bool wxSplitterWindow::ReplaceWindow(wxWindow *winOld, wxWindow *winNew)
+{
+ wxCHECK_MSG( winOld, false, wxT("use one of Split() functions instead") );
+ wxCHECK_MSG( winNew, false, wxT("use Unsplit() functions instead") );
+
+ if ( winOld == m_windowTwo )
+ {
+ m_windowTwo = winNew;
+ }
+ else if ( winOld == m_windowOne )
+ {
+ m_windowOne = winNew;
+ }
+ else
+ {
+ wxFAIL_MSG(wxT("splitter: attempt to replace a non-existent window"));
+
+ return false;
+ }
+
+ SizeWindows();
- return TRUE;
+ return true;
+}
+
+void wxSplitterWindow::SetMinimumPaneSize(int min)
+{
+ m_minimumPaneSize = min;
+ int pos = m_requestedSashPosition != INT_MAX ? m_requestedSashPosition : m_sashPosition;
+ SetSashPosition(pos); // re-check limits
}
void wxSplitterWindow::SetSashPosition(int position, bool redraw)
{
- m_sashPosition = position;
+ // remember the sash position we want to set for later if we can't set it
+ // right now (e.g. because the window is too small)
+ m_requestedSashPosition = position;
+ m_checkRequestedSashPosition = false;
+
+ DoSetSashPosition(ConvertSashPosition(position));
if ( redraw )
{
}
}
-// Called when the sash is double-clicked.
-// The default behaviour is to remove the sash if the
-// minimum pane size is zero.
-void wxSplitterWindow::OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y) )
+// Make sure the child window sizes are updated. This is useful
+// for reducing flicker by updating the sizes before a
+// window is shown, if you know the overall size is correct.
+void wxSplitterWindow::UpdateSize()
+{
+ m_checkRequestedSashPosition = true;
+ SizeWindows();
+ m_checkRequestedSashPosition = false;
+}
+
+bool wxSplitterWindow::DoSendEvent(wxSplitterEvent& event)
+{
+ return !GetEventHandler()->ProcessEvent(event) || event.IsAllowed();
+}
+
+wxSize wxSplitterWindow::DoGetBestSize() const
{
- if ( GetMinimumPaneSize() == 0 )
+ // get best sizes of subwindows
+ wxSize size1, size2;
+ if ( m_windowOne )
+ size1 = m_windowOne->GetEffectiveMinSize();
+ if ( m_windowTwo )
+ size2 = m_windowTwo->GetEffectiveMinSize();
+
+ // sum them
+ //
+ // pSash points to the size component to which sash size must be added
+ int *pSash;
+ wxSize sizeBest;
+ if ( m_splitMode == wxSPLIT_VERTICAL )
{
- Unsplit();
+ sizeBest.y = wxMax(size1.y, size2.y);
+ sizeBest.x = wxMax(size1.x, m_minimumPaneSize) +
+ wxMax(size2.x, m_minimumPaneSize);
+
+ pSash = &sizeBest.x;
}
+ else // wxSPLIT_HORIZONTAL
+ {
+ sizeBest.x = wxMax(size1.x, size2.x);
+ sizeBest.y = wxMax(size1.y, m_minimumPaneSize) +
+ wxMax(size2.y, m_minimumPaneSize);
+
+ pSash = &sizeBest.y;
+ }
+
+ // account for the border and the sash
+ int border = 2*GetBorderSize();
+ *pSash += GetSashSize();
+ sizeBest.x += border;
+ sizeBest.y += border;
+
+ return sizeBest;
}
-// Initialize colours
-void wxSplitterWindow::InitColours(void)
+// ---------------------------------------------------------------------------
+// wxSplitterWindow virtual functions: they now just generate the events
+// ---------------------------------------------------------------------------
+
+bool wxSplitterWindow::OnSashPositionChange(int WXUNUSED(newSashPosition))
{
- if ( m_facePen )
- delete m_facePen;
- if ( m_faceBrush )
- delete m_faceBrush;
- if ( m_mediumShadowPen )
- delete m_mediumShadowPen;
- if ( m_darkShadowPen )
- delete m_darkShadowPen;
- if ( m_lightShadowPen )
- delete m_lightShadowPen;
- if ( m_hilightPen )
- delete m_hilightPen;
+ // always allow by default
+ return true;
+}
- // Shadow colours
-#if defined(__WIN95__)
-// COLORREF ref = ::GetSysColor(COLOR_3DFACE); // Normally light grey
- wxColour faceColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
- m_facePen = new wxPen(faceColour, 1, wxSOLID);
- m_faceBrush = new wxBrush(faceColour, wxSOLID);
+int wxSplitterWindow::OnSashPositionChanging(int newSashPosition)
+{
+ // If within UNSPLIT_THRESHOLD from edge, set to edge to cause closure.
+ const int UNSPLIT_THRESHOLD = 4;
-// ref = ::GetSysColor(COLOR_3DSHADOW); // Normally dark grey
- wxColour mediumShadowColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DSHADOW));
- m_mediumShadowPen = new wxPen(mediumShadowColour, 1, wxSOLID);
+ // first of all, check if OnSashPositionChange() doesn't forbid this change
+ if ( !OnSashPositionChange(newSashPosition) )
+ {
+ // it does
+ return -1;
+ }
-// ref = ::GetSysColor(COLOR_3DDKSHADOW); // Normally black
- wxColour darkShadowColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DDKSHADOW));
- m_darkShadowPen = new wxPen(darkShadowColour, 1, wxSOLID);
+ // Obtain relevant window dimension for bottom / right threshold check
+ int window_size = GetWindowSize();
-// ref = ::GetSysColor(COLOR_3DLIGHT); // Normally light grey
- wxColour lightShadowColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DLIGHT));
- m_lightShadowPen = new wxPen(lightShadowColour, 1, wxSOLID);
+ bool unsplit_scenario = false;
+ if ( m_permitUnsplitAlways || m_minimumPaneSize == 0 )
+ {
+ // Do edge detection if unsplit premitted
+ if ( newSashPosition <= UNSPLIT_THRESHOLD )
+ {
+ // threshold top / left check
+ newSashPosition = 0;
+ unsplit_scenario = true;
+ }
+ if ( newSashPosition >= window_size - UNSPLIT_THRESHOLD )
+ {
+ // threshold bottom/right check
+ newSashPosition = window_size;
+ unsplit_scenario = true;
+ }
+ }
-// ref = ::GetSysColor(COLOR_3DHILIGHT); // Normally white
- wxColour hilightColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DHILIGHT));
- m_hilightPen = new wxPen(hilightColour, 1, wxSOLID);
-#else
- m_facePen = new wxPen("LIGHT GREY", 1, wxSOLID);
- m_faceBrush = new wxBrush("LIGHT GREY", wxSOLID);
- m_mediumShadowPen = new wxPen("GREY", 1, wxSOLID);
- m_darkShadowPen = new wxPen("BLACK", 1, wxSOLID);
- m_lightShadowPen = new wxPen("LIGHT GREY", 1, wxSOLID);
- m_hilightPen = new wxPen("WHITE", 1, wxSOLID);
-#endif
+ if ( !unsplit_scenario )
+ {
+ // If resultant pane would be too small, enlarge it
+ newSashPosition = AdjustSashPosition(newSashPosition);
+ }
+
+ // If the result is out of bounds it means minimum size is too big,
+ // so split window in half as best compromise.
+ if ( newSashPosition < 0 || newSashPosition > window_size )
+ newSashPosition = window_size / 2;
+
+ // now let the event handler have it
+ //
+ // FIXME: shouldn't we do it before the adjustments above so as to ensure
+ // that the sash position is always reasonable?
+ wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING, this);
+ event.m_data.pos = newSashPosition;
+
+ if ( !DoSendEvent(event) )
+ {
+ // the event handler vetoed the change
+ newSashPosition = -1;
+ }
+ else
+ {
+ // it could have been changed by it
+ newSashPosition = event.GetSashPosition();
+ }
+
+ return newSashPosition;
}
+// Called when the sash is double-clicked. The default behaviour is to remove
+// the sash if the minimum pane size is zero.
+void wxSplitterWindow::OnDoubleClickSash(int x, int y)
+{
+ wxCHECK_RET(m_windowTwo, wxT("splitter: no window to remove"));
+
+ // new code should handle events instead of using the virtual functions
+ wxSplitterEvent event(wxEVT_COMMAND_SPLITTER_DOUBLECLICKED, this);
+ event.m_data.pt.x = x;
+ event.m_data.pt.y = y;
+ if ( DoSendEvent(event) )
+ {
+ if ( GetMinimumPaneSize() == 0 || m_permitUnsplitAlways )
+ {
+ wxWindow* win = m_windowTwo;
+ if ( Unsplit(win) )
+ {
+ wxSplitterEvent unsplitEvent(wxEVT_COMMAND_SPLITTER_UNSPLIT, this);
+ unsplitEvent.m_data.win = win;
+ (void)DoSendEvent(unsplitEvent);
+ }
+ }
+ }
+ //else: blocked by user
+}
+
+void wxSplitterWindow::OnUnsplit(wxWindow *winRemoved)
+{
+ // call this before calling the event handler which may delete the window
+ winRemoved->Show(false);
+}
+
+#if defined( __WXMSW__ ) || defined( __WXMAC__)
+
+// this is currently called (and needed) under MSW only...
+void wxSplitterWindow::OnSetCursor(wxSetCursorEvent& event)
+{
+ // if we don't do it, the resizing cursor might be set for child window:
+ // and like this we explicitly say that our cursor should not be used for
+ // children windows which overlap us
+
+ if ( SashHitTest(event.GetX(), event.GetY(), 0) )
+ {
+ // default processing is ok
+ event.Skip();
+ }
+ //else: do nothing, in particular, don't call Skip()
+}
+
+#endif // wxMSW || wxMac
+
+#endif // wxUSE_SPLITTER
+
projects / wxWidgets.git / blobdiff