]> git.saurik.com Git - wxWidgets.git/blob - src/generic/sashwin.cpp
factoring out Background setter
[wxWidgets.git] / src / generic / sashwin.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: sashwin.cpp
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
7 // Modified by:
8 // Created: 01/02/97
9 // RCS-ID: $Id$
10 // Copyright: (c) Julian Smart
11 // Licence: wxWindows licence
12 /////////////////////////////////////////////////////////////////////////////
13
14 // For compilers that support precompilation, includes "wx.h".
15 #include "wx/wxprec.h"
16
17 #ifdef __BORLANDC__
18 #pragma hdrstop
19 #endif
20
21 #if wxUSE_SASH
22
23 #ifndef WX_PRECOMP
24 #include "wx/dialog.h"
25 #include "wx/frame.h"
26 #include "wx/settings.h"
27 #endif
28
29 #include "wx/math.h"
30
31 #include <stdlib.h>
32
33 #include "wx/dcscreen.h"
34 #include "wx/dcclient.h"
35 #include "wx/sashwin.h"
36 #include "wx/laywin.h"
37
38 DEFINE_EVENT_TYPE(wxEVT_SASH_DRAGGED)
39
40 IMPLEMENT_DYNAMIC_CLASS(wxSashWindow, wxWindow)
41 IMPLEMENT_DYNAMIC_CLASS(wxSashEvent, wxCommandEvent)
42
43 BEGIN_EVENT_TABLE(wxSashWindow, wxWindow)
44 EVT_PAINT(wxSashWindow::OnPaint)
45 EVT_SIZE(wxSashWindow::OnSize)
46 EVT_MOUSE_EVENTS(wxSashWindow::OnMouseEvent)
47 #if defined( __WXMSW__ ) || defined( __WXMAC__)
48 EVT_SET_CURSOR(wxSashWindow::OnSetCursor)
49 #endif // wxMSW
50
51 END_EVENT_TABLE()
52
53 bool wxSashWindow::Create(wxWindow *parent, wxWindowID id, const wxPoint& pos,
54 const wxSize& size, long style, const wxString& name)
55 {
56 return wxWindow::Create(parent, id, pos, size, style, name);
57 }
58
59 wxSashWindow::~wxSashWindow()
60 {
61 delete m_sashCursorWE;
62 delete m_sashCursorNS;
63 }
64
65 void wxSashWindow::Init()
66 {
67 m_draggingEdge = wxSASH_NONE;
68 m_dragMode = wxSASH_DRAG_NONE;
69 m_oldX = 0;
70 m_oldY = 0;
71 m_firstX = 0;
72 m_firstY = 0;
73 m_borderSize = 3;
74 m_extraBorderSize = 0;
75 m_minimumPaneSizeX = 0;
76 m_minimumPaneSizeY = 0;
77 m_maximumPaneSizeX = 10000;
78 m_maximumPaneSizeY = 10000;
79 m_sashCursorWE = new wxCursor(wxCURSOR_SIZEWE);
80 m_sashCursorNS = new wxCursor(wxCURSOR_SIZENS);
81 m_mouseCaptured = false;
82 m_currentCursor = NULL;
83
84 // Eventually, we'll respond to colour change messages
85 InitColours();
86 }
87
88 void wxSashWindow::OnPaint(wxPaintEvent& WXUNUSED(event))
89 {
90 wxPaintDC dc(this);
91
92 DrawBorders(dc);
93 DrawSashes(dc);
94 }
95
96 void wxSashWindow::OnMouseEvent(wxMouseEvent& event)
97 {
98 wxCoord x, y;
99 event.GetPosition(&x, &y);
100
101 wxSashEdgePosition sashHit = SashHitTest(x, y);
102
103 if (event.LeftDown())
104 {
105 CaptureMouse();
106 m_mouseCaptured = true;
107
108 if ( sashHit != wxSASH_NONE )
109 {
110 // Required for X to specify that
111 // that we wish to draw on top of all windows
112 // - and we optimise by specifying the area
113 // for creating the overlap window.
114 // Find the first frame or dialog and use this to specify
115 // the area to draw on.
116 wxWindow* parent = this;
117
118 while (parent && !parent->IsKindOf(CLASSINFO(wxDialog)) &&
119 !parent->IsKindOf(CLASSINFO(wxFrame)))
120 parent = parent->GetParent();
121
122 wxScreenDC::StartDrawingOnTop(parent);
123
124 // We don't say we're dragging yet; we leave that
125 // decision for the Dragging() branch, to ensure
126 // the user has dragged a little bit.
127 m_dragMode = wxSASH_DRAG_LEFT_DOWN;
128 m_draggingEdge = sashHit;
129 m_firstX = x;
130 m_firstY = y;
131
132 if ( (sashHit == wxSASH_LEFT) || (sashHit == wxSASH_RIGHT) )
133 {
134 if (m_currentCursor != m_sashCursorWE)
135 {
136 SetCursor(*m_sashCursorWE);
137 }
138 m_currentCursor = m_sashCursorWE;
139 }
140 else
141 {
142 if (m_currentCursor != m_sashCursorNS)
143 {
144 SetCursor(*m_sashCursorNS);
145 }
146 m_currentCursor = m_sashCursorNS;
147 }
148 }
149 }
150 else if ( event.LeftUp() && m_dragMode == wxSASH_DRAG_LEFT_DOWN )
151 {
152 // Wasn't a proper drag
153 if (m_mouseCaptured)
154 ReleaseMouse();
155 m_mouseCaptured = false;
156
157 wxScreenDC::EndDrawingOnTop();
158 m_dragMode = wxSASH_DRAG_NONE;
159 m_draggingEdge = wxSASH_NONE;
160 }
161 else if (event.LeftUp() && m_dragMode == wxSASH_DRAG_DRAGGING)
162 {
163 // We can stop dragging now and see what we've got.
164 m_dragMode = wxSASH_DRAG_NONE;
165 if (m_mouseCaptured)
166 ReleaseMouse();
167 m_mouseCaptured = false;
168
169 // Erase old tracker
170 DrawSashTracker(m_draggingEdge, m_oldX, m_oldY);
171
172 // End drawing on top (frees the window used for drawing
173 // over the screen)
174 wxScreenDC::EndDrawingOnTop();
175
176 int w, h;
177 GetSize(&w, &h);
178 int xp, yp;
179 GetPosition(&xp, &yp);
180
181 wxSashEdgePosition edge = m_draggingEdge;
182 m_draggingEdge = wxSASH_NONE;
183
184 wxRect dragRect;
185 wxSashDragStatus status = wxSASH_STATUS_OK;
186
187 // the new height and width of the window - if -1, it didn't change
188 int newHeight = wxDefaultCoord,
189 newWidth = wxDefaultCoord;
190
191 // NB: x and y may be negative and they're relative to the sash window
192 // upper left corner, while xp and yp are expressed in the parent
193 // window system of coordinates, so adjust them! After this
194 // adjustment, all coordinates are relative to the parent window.
195 y += yp;
196 x += xp;
197
198 switch (edge)
199 {
200 case wxSASH_TOP:
201 if ( y > yp + h )
202 {
203 // top sash shouldn't get below the bottom one
204 status = wxSASH_STATUS_OUT_OF_RANGE;
205 }
206 else
207 {
208 newHeight = h - (y - yp);
209 }
210 break;
211
212 case wxSASH_BOTTOM:
213 if ( y < yp )
214 {
215 // bottom sash shouldn't get above the top one
216 status = wxSASH_STATUS_OUT_OF_RANGE;
217 }
218 else
219 {
220 newHeight = y - yp;
221 }
222 break;
223
224 case wxSASH_LEFT:
225 if ( x > xp + w )
226 {
227 // left sash shouldn't get beyond the right one
228 status = wxSASH_STATUS_OUT_OF_RANGE;
229 }
230 else
231 {
232 newWidth = w - (x - xp);
233 }
234 break;
235
236 case wxSASH_RIGHT:
237 if ( x < xp )
238 {
239 // and the right sash, finally, shouldn't be beyond the
240 // left one
241 status = wxSASH_STATUS_OUT_OF_RANGE;
242 }
243 else
244 {
245 newWidth = x - xp;
246 }
247 break;
248
249 case wxSASH_NONE:
250 // can this happen at all?
251 break;
252 }
253
254 if ( newHeight == wxDefaultCoord )
255 {
256 // didn't change
257 newHeight = h;
258 }
259 else
260 {
261 // make sure it's in m_minimumPaneSizeY..m_maximumPaneSizeY range
262 newHeight = wxMax(newHeight, m_minimumPaneSizeY);
263 newHeight = wxMin(newHeight, m_maximumPaneSizeY);
264 }
265
266 if ( newWidth == wxDefaultCoord )
267 {
268 // didn't change
269 newWidth = w;
270 }
271 else
272 {
273 // make sure it's in m_minimumPaneSizeY..m_maximumPaneSizeY range
274 newWidth = wxMax(newWidth, m_minimumPaneSizeX);
275 newWidth = wxMin(newWidth, m_maximumPaneSizeX);
276 }
277
278 dragRect = wxRect(x, y, newWidth, newHeight);
279
280 wxSashEvent eventSash(GetId(), edge);
281 eventSash.SetEventObject(this);
282 eventSash.SetDragStatus(status);
283 eventSash.SetDragRect(dragRect);
284 GetEventHandler()->ProcessEvent(eventSash);
285 }
286 else if ( event.LeftUp() )
287 {
288 if (m_mouseCaptured)
289 ReleaseMouse();
290 m_mouseCaptured = false;
291 }
292 else if (event.Moving() && !event.Dragging())
293 {
294 // Just change the cursor if required
295 if ( sashHit != wxSASH_NONE )
296 {
297 if ( (sashHit == wxSASH_LEFT) || (sashHit == wxSASH_RIGHT) )
298 {
299 if (m_currentCursor != m_sashCursorWE)
300 {
301 SetCursor(*m_sashCursorWE);
302 }
303 m_currentCursor = m_sashCursorWE;
304 }
305 else
306 {
307 if (m_currentCursor != m_sashCursorNS)
308 {
309 SetCursor(*m_sashCursorNS);
310 }
311 m_currentCursor = m_sashCursorNS;
312 }
313 }
314 else
315 {
316 SetCursor(wxNullCursor);
317 m_currentCursor = NULL;
318 }
319 }
320 else if ( event.Dragging() &&
321 ((m_dragMode == wxSASH_DRAG_DRAGGING) ||
322 (m_dragMode == wxSASH_DRAG_LEFT_DOWN)) )
323 {
324 if ( (m_draggingEdge == wxSASH_LEFT) || (m_draggingEdge == wxSASH_RIGHT) )
325 {
326 if (m_currentCursor != m_sashCursorWE)
327 {
328 SetCursor(*m_sashCursorWE);
329 }
330 m_currentCursor = m_sashCursorWE;
331 }
332 else
333 {
334 if (m_currentCursor != m_sashCursorNS)
335 {
336 SetCursor(*m_sashCursorNS);
337 }
338 m_currentCursor = m_sashCursorNS;
339 }
340
341 if (m_dragMode == wxSASH_DRAG_LEFT_DOWN)
342 {
343 m_dragMode = wxSASH_DRAG_DRAGGING;
344 DrawSashTracker(m_draggingEdge, x, y);
345 }
346 else
347 {
348 if ( m_dragMode == wxSASH_DRAG_DRAGGING )
349 {
350 // Erase old tracker
351 DrawSashTracker(m_draggingEdge, m_oldX, m_oldY);
352
353 // Draw new one
354 DrawSashTracker(m_draggingEdge, x, y);
355 }
356 }
357 m_oldX = x;
358 m_oldY = y;
359 }
360 else if ( event.LeftDClick() )
361 {
362 // Nothing
363 }
364 else
365 {
366 }
367 }
368
369 void wxSashWindow::OnSize(wxSizeEvent& WXUNUSED(event))
370 {
371 SizeWindows();
372 }
373
374 wxSashEdgePosition wxSashWindow::SashHitTest(int x, int y, int WXUNUSED(tolerance))
375 {
376 int cx, cy;
377 GetClientSize(& cx, & cy);
378
379 int i;
380 for (i = 0; i < 4; i++)
381 {
382 wxSashEdge& edge = m_sashes[i];
383 wxSashEdgePosition position = (wxSashEdgePosition) i ;
384
385 if (edge.m_show)
386 {
387 switch (position)
388 {
389 case wxSASH_TOP:
390 {
391 if (y >= 0 && y <= GetEdgeMargin(position))
392 return wxSASH_TOP;
393 break;
394 }
395 case wxSASH_RIGHT:
396 {
397 if ((x >= cx - GetEdgeMargin(position)) && (x <= cx))
398 return wxSASH_RIGHT;
399 break;
400 }
401 case wxSASH_BOTTOM:
402 {
403 if ((y >= cy - GetEdgeMargin(position)) && (y <= cy))
404 return wxSASH_BOTTOM;
405 break;
406 }
407 case wxSASH_LEFT:
408 {
409 if ((x <= GetEdgeMargin(position)) && (x >= 0))
410 return wxSASH_LEFT;
411 break;
412 }
413 case wxSASH_NONE:
414 {
415 break;
416 }
417 }
418 }
419 }
420 return wxSASH_NONE;
421 }
422
423 // Draw 3D effect borders
424 void wxSashWindow::DrawBorders(wxDC& dc)
425 {
426 int w, h;
427 GetClientSize(&w, &h);
428
429 wxPen mediumShadowPen(m_mediumShadowColour, 1, wxSOLID);
430 wxPen darkShadowPen(m_darkShadowColour, 1, wxSOLID);
431 wxPen lightShadowPen(m_lightShadowColour, 1, wxSOLID);
432 wxPen hilightPen(m_hilightColour, 1, wxSOLID);
433
434 if ( GetWindowStyleFlag() & wxSW_3DBORDER )
435 {
436 dc.SetPen(mediumShadowPen);
437 dc.DrawLine(0, 0, w-1, 0);
438 dc.DrawLine(0, 0, 0, h - 1);
439
440 dc.SetPen(darkShadowPen);
441 dc.DrawLine(1, 1, w-2, 1);
442 dc.DrawLine(1, 1, 1, h-2);
443
444 dc.SetPen(hilightPen);
445 dc.DrawLine(0, h-1, w-1, h-1);
446 dc.DrawLine(w-1, 0, w-1, h); // Surely the maximum y pos. should be h - 1.
447 /// Anyway, h is required for MSW.
448
449 dc.SetPen(lightShadowPen);
450 dc.DrawLine(w-2, 1, w-2, h-2); // Right hand side
451 dc.DrawLine(1, h-2, w-1, h-2); // Bottom
452 }
453 else if ( GetWindowStyleFlag() & wxSW_BORDER )
454 {
455 dc.SetBrush(*wxTRANSPARENT_BRUSH);
456 dc.SetPen(*wxBLACK_PEN);
457 dc.DrawRectangle(0, 0, w-1, h-1);
458 }
459
460 dc.SetPen(wxNullPen);
461 dc.SetBrush(wxNullBrush);
462 }
463
464 void wxSashWindow::DrawSashes(wxDC& dc)
465 {
466 int i;
467 for (i = 0; i < 4; i++)
468 if (m_sashes[i].m_show)
469 DrawSash((wxSashEdgePosition) i, dc);
470 }
471
472 // Draw the sash
473 void wxSashWindow::DrawSash(wxSashEdgePosition edge, wxDC& dc)
474 {
475 int w, h;
476 GetClientSize(&w, &h);
477
478 wxPen facePen(m_faceColour, 1, wxSOLID);
479 wxBrush faceBrush(m_faceColour, wxSOLID);
480 wxPen mediumShadowPen(m_mediumShadowColour, 1, wxSOLID);
481 wxPen darkShadowPen(m_darkShadowColour, 1, wxSOLID);
482 wxPen lightShadowPen(m_lightShadowColour, 1, wxSOLID);
483 wxPen hilightPen(m_hilightColour, 1, wxSOLID);
484 wxColour blackClr(0, 0, 0);
485 wxColour whiteClr(255, 255, 255);
486 wxPen blackPen(blackClr, 1, wxSOLID);
487 wxPen whitePen(whiteClr, 1, wxSOLID);
488
489 if ( edge == wxSASH_LEFT || edge == wxSASH_RIGHT )
490 {
491 int sashPosition = (edge == wxSASH_LEFT) ? 0 : ( w - GetEdgeMargin(edge) );
492
493 dc.SetPen(facePen);
494 dc.SetBrush(faceBrush);
495 dc.DrawRectangle(sashPosition, 0, GetEdgeMargin(edge), h);
496
497 if (GetWindowStyleFlag() & wxSW_3DSASH)
498 {
499 if (edge == wxSASH_LEFT)
500 {
501 // Draw a dark grey line on the left to indicate that the
502 // sash is raised
503 dc.SetPen(mediumShadowPen);
504 dc.DrawLine(GetEdgeMargin(edge), 0, GetEdgeMargin(edge), h);
505 }
506 else
507 {
508 // Draw a highlight line on the right to indicate that the
509 // sash is raised
510 dc.SetPen(hilightPen);
511 dc.DrawLine(w - GetEdgeMargin(edge), 0, w - GetEdgeMargin(edge), h);
512 }
513 }
514 }
515 else // top or bottom
516 {
517 int sashPosition = (edge == wxSASH_TOP) ? 0 : ( h - GetEdgeMargin(edge) );
518
519 dc.SetPen(facePen);
520 dc.SetBrush(faceBrush);
521 dc.DrawRectangle(0, sashPosition, w, GetEdgeMargin(edge));
522
523 if (GetWindowStyleFlag() & wxSW_3DSASH)
524 {
525 if (edge == wxSASH_BOTTOM)
526 {
527 // Draw a highlight line on the bottom to indicate that the
528 // sash is raised
529 dc.SetPen(hilightPen);
530 dc.DrawLine(0, h - GetEdgeMargin(edge), w, h - GetEdgeMargin(edge));
531 }
532 else
533 {
534 // Draw a drak grey line on the top to indicate that the
535 // sash is raised
536 dc.SetPen(mediumShadowPen);
537 dc.DrawLine(1, GetEdgeMargin(edge), w-1, GetEdgeMargin(edge));
538 }
539 }
540 }
541
542 dc.SetPen(wxNullPen);
543 dc.SetBrush(wxNullBrush);
544 }
545
546 // Draw the sash tracker (for whilst moving the sash)
547 void wxSashWindow::DrawSashTracker(wxSashEdgePosition edge, int x, int y)
548 {
549 int w, h;
550 GetClientSize(&w, &h);
551
552 wxScreenDC screenDC;
553 int x1, y1;
554 int x2, y2;
555
556 if ( edge == wxSASH_LEFT || edge == wxSASH_RIGHT )
557 {
558 x1 = x; y1 = 2;
559 x2 = x; y2 = h-2;
560
561 if ( (edge == wxSASH_LEFT) && (x1 > w) )
562 {
563 x1 = w; x2 = w;
564 }
565 else if ( (edge == wxSASH_RIGHT) && (x1 < 0) )
566 {
567 x1 = 0; x2 = 0;
568 }
569 }
570 else
571 {
572 x1 = 2; y1 = y;
573 x2 = w-2; y2 = y;
574
575 if ( (edge == wxSASH_TOP) && (y1 > h) )
576 {
577 y1 = h;
578 y2 = h;
579 }
580 else if ( (edge == wxSASH_BOTTOM) && (y1 < 0) )
581 {
582 y1 = 0;
583 y2 = 0;
584 }
585 }
586
587 ClientToScreen(&x1, &y1);
588 ClientToScreen(&x2, &y2);
589
590 wxPen sashTrackerPen(*wxBLACK, 2, wxSOLID);
591
592 screenDC.SetLogicalFunction(wxINVERT);
593 screenDC.SetPen(sashTrackerPen);
594 screenDC.SetBrush(*wxTRANSPARENT_BRUSH);
595
596 screenDC.DrawLine(x1, y1, x2, y2);
597
598 screenDC.SetLogicalFunction(wxCOPY);
599
600 screenDC.SetPen(wxNullPen);
601 screenDC.SetBrush(wxNullBrush);
602 }
603
604 // Position and size subwindows.
605 // Note that the border size applies to each subwindow, not
606 // including the edges next to the sash.
607 void wxSashWindow::SizeWindows()
608 {
609 int cw, ch;
610 GetClientSize(&cw, &ch);
611
612 if (GetChildren().GetCount() == 1)
613 {
614 wxWindow* child = GetChildren().GetFirst()->GetData();
615
616 int x = 0;
617 int y = 0;
618 int width = cw;
619 int height = ch;
620
621 // Top
622 if (m_sashes[0].m_show)
623 {
624 y = m_borderSize;
625 height -= m_borderSize;
626 }
627 y += m_extraBorderSize;
628
629 // Left
630 if (m_sashes[3].m_show)
631 {
632 x = m_borderSize;
633 width -= m_borderSize;
634 }
635 x += m_extraBorderSize;
636
637 // Right
638 if (m_sashes[1].m_show)
639 {
640 width -= m_borderSize;
641 }
642 width -= 2*m_extraBorderSize;
643
644 // Bottom
645 if (m_sashes[2].m_show)
646 {
647 height -= m_borderSize;
648 }
649 height -= 2*m_extraBorderSize;
650
651 child->SetSize(x, y, width, height);
652 }
653 else if (GetChildren().GetCount() > 1)
654 {
655 // Perhaps multiple children are themselves sash windows.
656 // TODO: this doesn't really work because the subwindows sizes/positions
657 // must be set to leave a gap for the parent's sash (hit-test and decorations).
658 // Perhaps we can allow for this within LayoutWindow, testing whether the parent
659 // is a sash window, and if so, allowing some space for the edges.
660 wxLayoutAlgorithm layout;
661 layout.LayoutWindow(this);
662 }
663
664 wxClientDC dc(this);
665 DrawBorders(dc);
666 DrawSashes(dc);
667 }
668
669 // Initialize colours
670 void wxSashWindow::InitColours()
671 {
672 // Shadow colours
673 m_faceColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE);
674 m_mediumShadowColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DSHADOW);
675 m_darkShadowColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DDKSHADOW);
676 m_lightShadowColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT);
677 m_hilightColour = wxSystemSettings::GetColour(wxSYS_COLOUR_3DHILIGHT);
678 }
679
680 void wxSashWindow::SetSashVisible(wxSashEdgePosition edge, bool sash)
681 {
682 m_sashes[edge].m_show = sash;
683 if (sash)
684 m_sashes[edge].m_margin = m_borderSize;
685 else
686 m_sashes[edge].m_margin = 0;
687 }
688
689 #if defined( __WXMSW__ ) || defined( __WXMAC__)
690
691 // this is currently called (and needed) under MSW only...
692 void wxSashWindow::OnSetCursor(wxSetCursorEvent& event)
693 {
694 // if we don't do it, the resizing cursor might be set for child window:
695 // and like this we explicitly say that our cursor should not be used for
696 // children windows which overlap us
697
698 if ( SashHitTest(event.GetX(), event.GetY()) != wxSASH_NONE)
699 {
700 // default processing is ok
701 event.Skip();
702 }
703 //else: do nothing, in particular, don't call Skip()
704 }
705
706 #endif // wxMSW
707
708 #endif // wxUSE_SASH