1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxSashWindow implementation. A sash window has an optional
4 // sash on each edge, allowing it to be dragged. An event
5 // is generated when the sash is released.
6 // Author: Julian Smart
10 // Copyright: (c) Julian Smart
11 // Licence: wxWindows license
12 /////////////////////////////////////////////////////////////////////////////
15 #pragma implementation "sashwin.h"
18 // For compilers that support precompilation, includes "wx.h".
19 #include "wx/wxprec.h"
34 #include "wx/string.h"
35 #include "wx/dcscreen.h"
36 #include "wx/sashwin.h"
37 #include "wx/laywin.h"
39 IMPLEMENT_DYNAMIC_CLASS(wxSashWindow
, wxWindow
)
40 IMPLEMENT_DYNAMIC_CLASS(wxSashEvent
, wxCommandEvent
)
42 BEGIN_EVENT_TABLE(wxSashWindow
, wxWindow
)
43 EVT_PAINT(wxSashWindow::OnPaint
)
44 EVT_SIZE(wxSashWindow::OnSize
)
45 EVT_MOUSE_EVENTS(wxSashWindow::OnMouseEvent
)
48 wxSashWindow::wxSashWindow()
50 m_draggingEdge
= wxSASH_NONE
;
51 m_dragMode
= wxSASH_DRAG_NONE
;
57 m_extraBorderSize
= 0;
58 m_sashCursorWE
= NULL
;
59 m_sashCursorNS
= NULL
;
61 m_minimumPaneSizeX
= 0;
62 m_minimumPaneSizeY
= 0;
63 m_maximumPaneSizeX
= 10000;
64 m_maximumPaneSizeY
= 10000;
67 wxSashWindow::wxSashWindow(wxWindow
*parent
, wxWindowID id
, const wxPoint
& pos
,
68 const wxSize
& size
, long style
, const wxString
& name
)
69 :wxWindow(parent
, id
, pos
, size
, style
, name
)
71 m_draggingEdge
= wxSASH_NONE
;
72 m_dragMode
= wxSASH_DRAG_NONE
;
78 m_extraBorderSize
= 0;
79 m_minimumPaneSizeX
= 0;
80 m_minimumPaneSizeY
= 0;
81 m_maximumPaneSizeX
= 10000;
82 m_maximumPaneSizeY
= 10000;
83 m_sashCursorWE
= new wxCursor(wxCURSOR_SIZEWE
);
84 m_sashCursorNS
= new wxCursor(wxCURSOR_SIZENS
);
86 // Eventually, we'll respond to colour change messages
90 wxSashWindow::~wxSashWindow()
92 delete m_sashCursorWE
;
93 delete m_sashCursorNS
;
96 void wxSashWindow::OnPaint(wxPaintEvent
& WXUNUSED(event
))
100 // if ( m_borderSize > 0 )
106 void wxSashWindow::OnMouseEvent(wxMouseEvent
& event
)
109 event
.GetPosition(&x
, &y
);
111 wxSashEdgePosition sashHit
= SashHitTest(x
, y
);
115 SetCursor(* wxSTANDARD_CURSOR
);
118 SetCursor(wxCursor());
121 if (event
.LeftDown())
125 if ( sashHit
!= wxSASH_NONE
)
127 // Required for X to specify that
128 // that we wish to draw on top of all windows
129 // - and we optimise by specifying the area
130 // for creating the overlap window.
131 // Find the first frame or dialog and use this to specify
132 // the area to draw on.
133 wxWindow
* parent
= this;
135 while (parent
&& !parent
->IsKindOf(CLASSINFO(wxDialog
)) &&
136 !parent
->IsKindOf(CLASSINFO(wxFrame
)))
137 parent
= parent
->GetParent();
139 wxScreenDC::StartDrawingOnTop(parent
);
141 // We don't say we're dragging yet; we leave that
142 // decision for the Dragging() branch, to ensure
143 // the user has dragged a little bit.
144 m_dragMode
= wxSASH_DRAG_LEFT_DOWN
;
145 m_draggingEdge
= sashHit
;
149 if ( (sashHit
== wxSASH_LEFT
) || (sashHit
== wxSASH_RIGHT
) )
151 SetCursor(*m_sashCursorWE
);
155 SetCursor(*m_sashCursorNS
);
159 else if ( event
.LeftUp() && m_dragMode
== wxSASH_DRAG_LEFT_DOWN
)
161 // Wasn't a proper drag
163 wxScreenDC::EndDrawingOnTop();
164 m_dragMode
= wxSASH_DRAG_NONE
;
165 m_draggingEdge
= wxSASH_NONE
;
167 else if (event
.LeftUp() && m_dragMode
== wxSASH_DRAG_DRAGGING
)
169 // We can stop dragging now and see what we've got.
170 m_dragMode
= wxSASH_DRAG_NONE
;
173 DrawSashTracker(m_draggingEdge
, m_oldX
, m_oldY
);
175 // End drawing on top (frees the window used for drawing
177 wxScreenDC::EndDrawingOnTop();
182 GetPosition(&xp
, &yp
);
184 wxSashEdgePosition edge
= m_draggingEdge
;
185 m_draggingEdge
= wxSASH_NONE
;
188 wxSashDragStatus status
= wxSASH_STATUS_OK
;
190 // the new height and width of the window - if -1, it didn't change
194 // NB: x and y may be negative and they're relative to the sash window
195 // upper left corner, while xp and yp are expressed in the parent
196 // window system of coordinates, so adjust them! After this
197 // adjustment, all coordinates are relative to the parent window.
206 // top sash shouldn't get below the bottom one
207 status
= wxSASH_STATUS_OUT_OF_RANGE
;
211 newHeight
= h
- (y
- yp
);
218 // bottom sash shouldn't get above the top one
219 status
= wxSASH_STATUS_OUT_OF_RANGE
;
230 // left sash shouldn't get beyond the right one
231 status
= wxSASH_STATUS_OUT_OF_RANGE
;
235 newWidth
= w
- (x
- xp
);
242 // and the right sash, finally, shouldn't be beyond the
244 status
= wxSASH_STATUS_OUT_OF_RANGE
;
253 // can this happen at all?
257 if ( newHeight
== -1 )
264 // make sure it's in m_minimumPaneSizeY..m_maximumPaneSizeY range
265 newHeight
= wxMax(newHeight
, m_minimumPaneSizeY
);
266 newHeight
= wxMin(newHeight
, m_maximumPaneSizeY
);
269 if ( newWidth
== -1 )
276 // make sure it's in m_minimumPaneSizeY..m_maximumPaneSizeY range
277 newWidth
= wxMax(newWidth
, m_minimumPaneSizeX
);
278 newWidth
= wxMin(newWidth
, m_maximumPaneSizeX
);
281 dragRect
= wxRect(x
, y
, newWidth
, newHeight
);
283 wxSashEvent
event(GetId(), edge
);
284 event
.SetEventObject(this);
285 event
.SetDragStatus(status
);
286 event
.SetDragRect(dragRect
);
287 GetEventHandler()->ProcessEvent(event
);
289 else if ( event
.LeftUp() )
293 else if (event
.Moving() && !event
.Dragging())
295 // Just change the cursor if required
296 if ( sashHit
!= wxSASH_NONE
)
298 if ( (sashHit
== wxSASH_LEFT
) || (sashHit
== wxSASH_RIGHT
) )
300 SetCursor(*m_sashCursorWE
);
304 SetCursor(*m_sashCursorNS
);
309 SetCursor(* wxSTANDARD_CURSOR
);
312 else if ( event
.Dragging() &&
313 ((m_dragMode
== wxSASH_DRAG_DRAGGING
) ||
314 (m_dragMode
== wxSASH_DRAG_LEFT_DOWN
)) )
316 if ( (m_draggingEdge
== wxSASH_LEFT
) || (m_draggingEdge
== wxSASH_RIGHT
) )
318 SetCursor(*m_sashCursorWE
);
322 SetCursor(*m_sashCursorNS
);
325 if (m_dragMode
== wxSASH_DRAG_LEFT_DOWN
)
327 m_dragMode
= wxSASH_DRAG_DRAGGING
;
328 DrawSashTracker(m_draggingEdge
, x
, y
);
332 if ( m_dragMode
== wxSASH_DRAG_DRAGGING
)
335 DrawSashTracker(m_draggingEdge
, m_oldX
, m_oldY
);
338 DrawSashTracker(m_draggingEdge
, x
, y
);
344 else if ( event
.LeftDClick() )
353 void wxSashWindow::OnSize(wxSizeEvent
& WXUNUSED(event
))
358 wxSashEdgePosition
wxSashWindow::SashHitTest(int x
, int y
, int WXUNUSED(tolerance
))
361 GetClientSize(& cx
, & cy
);
364 for (i
= 0; i
< 4; i
++)
366 wxSashEdge
& edge
= m_sashes
[i
];
367 wxSashEdgePosition position
= (wxSashEdgePosition
) i
;
375 if (y
>= 0 && y
<= GetEdgeMargin(position
))
381 if ((x
>= cx
- GetEdgeMargin(position
)) && (x
<= cx
))
387 if ((y
>= cy
- GetEdgeMargin(position
)) && (y
<= cy
))
388 return wxSASH_BOTTOM
;
393 if ((x
<= GetEdgeMargin(position
)) && (x
>= 0))
407 // Draw 3D effect borders
408 void wxSashWindow::DrawBorders(wxDC
& dc
)
411 GetClientSize(&w
, &h
);
413 wxPen
mediumShadowPen(m_mediumShadowColour
, 1, wxSOLID
);
414 wxPen
darkShadowPen(m_darkShadowColour
, 1, wxSOLID
);
415 wxPen
lightShadowPen(m_lightShadowColour
, 1, wxSOLID
);
416 wxPen
hilightPen(m_hilightColour
, 1, wxSOLID
);
418 if ( GetWindowStyleFlag() & wxSW_3D
)
420 dc
.SetPen(mediumShadowPen
);
421 dc
.DrawLine(0, 0, w
-1, 0);
422 dc
.DrawLine(0, 0, 0, h
- 1);
424 dc
.SetPen(darkShadowPen
);
425 dc
.DrawLine(1, 1, w
-2, 1);
426 dc
.DrawLine(1, 1, 1, h
-2);
428 dc
.SetPen(hilightPen
);
429 dc
.DrawLine(0, h
-1, w
-1, h
-1);
430 dc
.DrawLine(w
-1, 0, w
-1, h
); // Surely the maximum y pos. should be h - 1.
431 /// Anyway, h is required for MSW.
433 dc
.SetPen(lightShadowPen
);
434 dc
.DrawLine(w
-2, 1, w
-2, h
-2); // Right hand side
435 dc
.DrawLine(1, h
-2, w
-1, h
-2); // Bottom
437 else if ( GetWindowStyleFlag() & wxSW_BORDER
)
439 dc
.SetBrush(*wxTRANSPARENT_BRUSH
);
440 dc
.SetPen(*wxBLACK_PEN
);
441 dc
.DrawRectangle(0, 0, w
-1, h
-1);
444 dc
.SetPen(wxNullPen
);
445 dc
.SetBrush(wxNullBrush
);
448 void wxSashWindow::DrawSashes(wxDC
& dc
)
451 for (i
= 0; i
< 4; i
++)
452 if (m_sashes
[i
].m_show
)
453 DrawSash((wxSashEdgePosition
) i
, dc
);
457 void wxSashWindow::DrawSash(wxSashEdgePosition edge
, wxDC
& dc
)
460 GetClientSize(&w
, &h
);
462 wxPen
facePen(m_faceColour
, 1, wxSOLID
);
463 wxBrush
faceBrush(m_faceColour
, wxSOLID
);
464 wxPen
mediumShadowPen(m_mediumShadowColour
, 1, wxSOLID
);
465 wxPen
darkShadowPen(m_darkShadowColour
, 1, wxSOLID
);
466 wxPen
lightShadowPen(m_lightShadowColour
, 1, wxSOLID
);
467 wxPen
hilightPen(m_hilightColour
, 1, wxSOLID
);
468 wxPen
blackPen(wxColour(0, 0, 0), 1, wxSOLID
);
469 wxPen
whitePen(wxColour(255, 255, 255), 1, wxSOLID
);
471 if ( edge
== wxSASH_LEFT
|| edge
== wxSASH_RIGHT
)
473 int sashPosition
= 0;
474 if (edge
== wxSASH_LEFT
)
477 sashPosition
= w
- GetEdgeMargin(edge
);
480 dc
.SetBrush(faceBrush
);
481 dc
.DrawRectangle(sashPosition
, 0, GetEdgeMargin(edge
), h
);
483 if (GetWindowStyleFlag() & wxSW_3D
)
485 if (edge
== wxSASH_LEFT
)
487 // Draw a dark grey line on the left to indicate that the
489 dc
.SetPen(mediumShadowPen
);
490 dc
.DrawLine(GetEdgeMargin(edge
), 0, GetEdgeMargin(edge
), h
);
494 // Draw a light grey line on the right to indicate that the
496 dc
.SetPen(lightShadowPen
);
497 dc
.DrawLine(w
- GetEdgeMargin(edge
), 0, w
- GetEdgeMargin(edge
), h
);
501 else // top or bottom
503 int sashPosition
= 0;
504 if (edge
== wxSASH_TOP
)
507 sashPosition
= h
- GetEdgeMargin(edge
);
510 dc
.SetBrush(faceBrush
);
511 dc
.DrawRectangle(0, sashPosition
, w
, GetEdgeMargin(edge
));
513 if (GetWindowStyleFlag() & wxSW_3D
)
515 if (edge
== wxSASH_BOTTOM
)
517 // Draw a light grey line on the bottom to indicate that the
519 dc
.SetPen(lightShadowPen
);
520 dc
.DrawLine(0, h
- GetEdgeMargin(edge
), w
, h
- GetEdgeMargin(edge
));
524 // Draw a drak grey line on the top to indicate that the
526 dc
.SetPen(mediumShadowPen
);
527 dc
.DrawLine(1, GetEdgeMargin(edge
), w
-1, GetEdgeMargin(edge
));
532 dc
.SetPen(wxNullPen
);
533 dc
.SetBrush(wxNullBrush
);
536 // Draw the sash tracker (for whilst moving the sash)
537 void wxSashWindow::DrawSashTracker(wxSashEdgePosition edge
, int x
, int y
)
540 GetClientSize(&w
, &h
);
546 if ( edge
== wxSASH_LEFT
|| edge
== wxSASH_RIGHT
)
551 if ( (edge
== wxSASH_LEFT
) && (x1
> w
) )
555 else if ( (edge
== wxSASH_RIGHT
) && (x1
< 0) )
565 if ( (edge
== wxSASH_TOP
) && (y1
> h
) )
570 else if ( (edge
== wxSASH_BOTTOM
) && (y1
< 0) )
577 ClientToScreen(&x1
, &y1
);
578 ClientToScreen(&x2
, &y2
);
580 wxPen
sashTrackerPen(*wxBLACK
, 2, wxSOLID
);
582 screenDC
.SetLogicalFunction(wxINVERT
);
583 screenDC
.SetPen(sashTrackerPen
);
584 screenDC
.SetBrush(*wxTRANSPARENT_BRUSH
);
586 screenDC
.DrawLine(x1
, y1
, x2
, y2
);
588 screenDC
.SetLogicalFunction(wxCOPY
);
590 screenDC
.SetPen(wxNullPen
);
591 screenDC
.SetBrush(wxNullBrush
);
594 // Position and size subwindows.
595 // Note that the border size applies to each subwindow, not
596 // including the edges next to the sash.
597 void wxSashWindow::SizeWindows()
600 GetClientSize(&cw
, &ch
);
602 if (GetChildren().Number() == 1)
604 wxWindow
* child
= (wxWindow
*) (GetChildren().First()->Data());
612 if (m_sashes
[0].m_show
)
615 height
-= m_borderSize
;
617 y
+= m_extraBorderSize
;
620 if (m_sashes
[3].m_show
)
623 width
-= m_borderSize
;
625 x
+= m_extraBorderSize
;
628 if (m_sashes
[1].m_show
)
630 width
-= m_borderSize
;
632 width
-= 2*m_extraBorderSize
;
635 if (m_sashes
[2].m_show
)
637 height
-= m_borderSize
;
639 height
-= 2*m_extraBorderSize
;
641 child
->SetSize(x
, y
, width
, height
);
643 else if (GetChildren().Number() > 1)
645 // Perhaps multiple children are themselves sash windows.
646 // TODO: this doesn't really work because the subwindows sizes/positions
647 // must be set to leave a gap for the parent's sash (hit-test and decorations).
648 // Perhaps we can allow for this within LayoutWindow, testing whether the parent
649 // is a sash window, and if so, allowing some space for the edges.
650 wxLayoutAlgorithm layout
;
651 layout
.LayoutWindow(this);
659 // Initialize colours
660 void wxSashWindow::InitColours()
663 #if defined(__WIN95__)
664 m_faceColour
= wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE
);
665 m_mediumShadowColour
= wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DSHADOW
);
666 m_darkShadowColour
= wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DDKSHADOW
);
667 m_lightShadowColour
= wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DLIGHT
);
668 m_hilightColour
= wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DHILIGHT
);
670 m_faceColour
= *(wxTheColourDatabase
->FindColour("LIGHT GREY"));
671 m_mediumShadowColour
= *(wxTheColourDatabase
->FindColour("GREY"));
672 m_darkShadowColour
= *(wxTheColourDatabase
->FindColour("BLACK"));
673 m_lightShadowColour
= *(wxTheColourDatabase
->FindColour("LIGHT GREY"));
674 m_hilightColour
= *(wxTheColourDatabase
->FindColour("WHITE"));
678 void wxSashWindow::SetSashVisible(wxSashEdgePosition edge
, bool sash
)
680 m_sashes
[edge
].m_show
= sash
;
682 m_sashes
[edge
].m_margin
= m_borderSize
;
684 m_sashes
[edge
].m_margin
= 0;