projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
All wxScrolledWindows shoudl have wxHSCROLL|wxVSCROLL now.
[wxWidgets.git] / src / generic / scrlwing.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: generic/scrolwin.cpp
3 // Purpose: wxGenericScrolledWindow implementation
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin on 31.08.00: wxScrollHelper allows to implement.
6 // Ron Lee on 10.4.02: virtual size / auto scrollbars et al.
7 // Created: 01/02/97
8 // RCS-ID: $Id$
9 // Copyright: (c) wxWidgets team
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 // ============================================================================
14 // declarations
15 // ============================================================================
16
17 // ----------------------------------------------------------------------------
18 // headers
19 // ----------------------------------------------------------------------------
20
21 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
22 #pragma implementation "genscrolwin.h"
23 #endif
24
25 #ifdef __VMS
26 #define XtDisplay XTDISPLAY
27 #endif
28
29 // For compilers that support precompilation, includes "wx.h".
30 #include "wx/wxprec.h"
31
32 #ifdef __BORLANDC__
33 #pragma hdrstop
34 #endif
35
36 #if !defined(__WXGTK__) || defined(__WXUNIVERSAL__)
37
38 #include "wx/utils.h"
39 #include "wx/dcclient.h"
40
41 #include "wx/scrolwin.h"
42 #include "wx/panel.h"
43 #if wxUSE_TIMER
44 #include "wx/timer.h"
45 #endif
46 #include "wx/sizer.h"
47 #include "wx/recguard.h"
48
49 #ifdef __WXMSW__
50 #include <windows.h> // for DLGC_WANTARROWS
51 #endif
52
53 #ifdef __WXMOTIF__
54 // For wxRETAINED implementation
55 #ifdef __VMS__ //VMS's Xm.h is not (yet) compatible with C++
56 //This code switches off the compiler warnings
57 # pragma message disable nosimpint
58 #endif
59 #include <Xm/Xm.h>
60 #ifdef __VMS__
61 # pragma message enable nosimpint
62 #endif
63 #endif
64
65 IMPLEMENT_CLASS(wxScrolledWindow, wxGenericScrolledWindow)
66
67 /*
68 TODO PROPERTIES
69 style wxHSCROLL | wxVSCROLL
70 */
71
72 // ----------------------------------------------------------------------------
73 // wxScrollHelperEvtHandler: intercept the events from the window and forward
74 // them to wxScrollHelper
75 // ----------------------------------------------------------------------------
76
77 class WXDLLEXPORT wxScrollHelperEvtHandler : public wxEvtHandler
78 {
79 public:
80 wxScrollHelperEvtHandler(wxScrollHelper *scrollHelper)
81 {
82 m_scrollHelper = scrollHelper;
83 }
84
85 virtual bool ProcessEvent(wxEvent& event);
86
87 void ResetDrawnFlag() { m_hasDrawnWindow = false; }
88
89 private:
90 wxScrollHelper *m_scrollHelper;
91
92 bool m_hasDrawnWindow;
93
94 DECLARE_NO_COPY_CLASS(wxScrollHelperEvtHandler)
95 };
96
97 #if wxUSE_TIMER
98 // ----------------------------------------------------------------------------
99 // wxAutoScrollTimer: the timer used to generate a stream of scroll events when
100 // a captured mouse is held outside the window
101 // ----------------------------------------------------------------------------
102
103 class wxAutoScrollTimer : public wxTimer
104 {
105 public:
106 wxAutoScrollTimer(wxWindow *winToScroll, wxScrollHelper *scroll,
107 wxEventType eventTypeToSend,
108 int pos, int orient);
109
110 virtual void Notify();
111
112 private:
113 wxWindow *m_win;
114 wxScrollHelper *m_scrollHelper;
115 wxEventType m_eventType;
116 int m_pos,
117 m_orient;
118
119 DECLARE_NO_COPY_CLASS(wxAutoScrollTimer)
120 };
121
122 // ============================================================================
123 // implementation
124 // ============================================================================
125
126 // ----------------------------------------------------------------------------
127 // wxAutoScrollTimer
128 // ----------------------------------------------------------------------------
129
130 wxAutoScrollTimer::wxAutoScrollTimer(wxWindow *winToScroll,
131 wxScrollHelper *scroll,
132 wxEventType eventTypeToSend,
133 int pos, int orient)
134 {
135 m_win = winToScroll;
136 m_scrollHelper = scroll;
137 m_eventType = eventTypeToSend;
138 m_pos = pos;
139 m_orient = orient;
140 }
141
142 void wxAutoScrollTimer::Notify()
143 {
144 // only do all this as long as the window is capturing the mouse
145 if ( wxWindow::GetCapture() != m_win )
146 {
147 Stop();
148 }
149 else // we still capture the mouse, continue generating events
150 {
151 // first scroll the window if we are allowed to do it
152 wxScrollWinEvent event1(m_eventType, m_pos, m_orient);
153 event1.SetEventObject(m_win);
154 if ( m_scrollHelper->SendAutoScrollEvents(event1) &&
155 m_win->GetEventHandler()->ProcessEvent(event1) )
156 {
157 // and then send a pseudo mouse-move event to refresh the selection
158 wxMouseEvent event2(wxEVT_MOTION);
159 wxGetMousePosition(&event2.m_x, &event2.m_y);
160
161 // the mouse event coordinates should be client, not screen as
162 // returned by wxGetMousePosition
163 wxWindow *parentTop = m_win;
164 while ( parentTop->GetParent() )
165 parentTop = parentTop->GetParent();
166 wxPoint ptOrig = parentTop->GetPosition();
167 event2.m_x -= ptOrig.x;
168 event2.m_y -= ptOrig.y;
169
170 event2.SetEventObject(m_win);
171
172 // FIXME: we don't fill in the other members - ok?
173
174 m_win->GetEventHandler()->ProcessEvent(event2);
175 }
176 else // can't scroll further, stop
177 {
178 Stop();
179 }
180 }
181 }
182 #endif
183
184 // ----------------------------------------------------------------------------
185 // wxScrollHelperEvtHandler
186 // ----------------------------------------------------------------------------
187
188 bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
189 {
190 wxEventType evType = event.GetEventType();
191
192 // the explanation of wxEVT_PAINT processing hack: for historic reasons
193 // there are 2 ways to process this event in classes deriving from
194 // wxScrolledWindow. The user code may
195 //
196 // 1. override wxScrolledWindow::OnDraw(dc)
197 // 2. define its own OnPaint() handler
198 //
199 // In addition, in wxUniversal wxWindow defines OnPaint() itself and
200 // always processes the draw event, so we can't just try the window
201 // OnPaint() first and call our HandleOnPaint() if it doesn't process it
202 // (the latter would never be called in wxUniversal).
203 //
204 // So the solution is to have a flag telling us whether the user code drew
205 // anything in the window. We set it to true here but reset it to false in
206 // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
207 // user code defined OnPaint() in the derived class)
208 m_hasDrawnWindow = true;
209
210 // pass it on to the real handler
211 bool processed = wxEvtHandler::ProcessEvent(event);
212
213 // always process the size events ourselves, even if the user code handles
214 // them as well, as we need to AdjustScrollbars()
215 //
216 // NB: it is important to do it after processing the event in the normal
217 // way as HandleOnSize() may generate a wxEVT_SIZE itself if the
218 // scrollbar[s] (dis)appear and it should be seen by the user code
219 // after this one
220 if ( evType == wxEVT_SIZE )
221 {
222 m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
223
224 return true;
225 }
226
227 if ( processed )
228 {
229 // normally, nothing more to do here - except if it was a paint event
230 // which wasn't really processed, then we'll try to call our
231 // OnDraw() below (from HandleOnPaint)
232 if ( m_hasDrawnWindow )
233 {
234 return true;
235 }
236 }
237
238 // reset the skipped flag to false as it might have been set to true in
239 // ProcessEvent() above
240 event.Skip(false);
241
242 if ( evType == wxEVT_PAINT )
243 {
244 m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
245 return true;
246 }
247
248 if ( evType == wxEVT_SCROLLWIN_TOP ||
249 evType == wxEVT_SCROLLWIN_BOTTOM ||
250 evType == wxEVT_SCROLLWIN_LINEUP ||
251 evType == wxEVT_SCROLLWIN_LINEDOWN ||
252 evType == wxEVT_SCROLLWIN_PAGEUP ||
253 evType == wxEVT_SCROLLWIN_PAGEDOWN ||
254 evType == wxEVT_SCROLLWIN_THUMBTRACK ||
255 evType == wxEVT_SCROLLWIN_THUMBRELEASE )
256 {
257 m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
258 return !event.GetSkipped();
259 }
260
261 if ( evType == wxEVT_ENTER_WINDOW )
262 {
263 m_scrollHelper->HandleOnMouseEnter((wxMouseEvent &)event);
264 }
265 else if ( evType == wxEVT_LEAVE_WINDOW )
266 {
267 m_scrollHelper->HandleOnMouseLeave((wxMouseEvent &)event);
268 }
269 #if wxUSE_MOUSEWHEEL
270 else if ( evType == wxEVT_MOUSEWHEEL )
271 {
272 m_scrollHelper->HandleOnMouseWheel((wxMouseEvent &)event);
273 }
274 #endif // wxUSE_MOUSEWHEEL
275 else if ( evType == wxEVT_CHAR )
276 {
277 m_scrollHelper->HandleOnChar((wxKeyEvent &)event);
278 return !event.GetSkipped();
279 }
280
281 return false;
282 }
283
284 // ----------------------------------------------------------------------------
285 // wxScrollHelper construction
286 // ----------------------------------------------------------------------------
287
288 wxScrollHelper::wxScrollHelper(wxWindow *win)
289 {
290 m_xScrollPixelsPerLine =
291 m_yScrollPixelsPerLine =
292 m_xScrollPosition =
293 m_yScrollPosition =
294 m_xScrollLines =
295 m_yScrollLines =
296 m_xScrollLinesPerPage =
297 m_yScrollLinesPerPage = 0;
298
299 m_xScrollingEnabled =
300 m_yScrollingEnabled = true;
301
302 m_scaleX =
303 m_scaleY = 1.0;
304 #if wxUSE_MOUSEWHEEL
305 m_wheelRotation = 0;
306 #endif
307
308 m_win =
309 m_targetWindow = (wxWindow *)NULL;
310
311 m_timerAutoScroll = (wxTimer *)NULL;
312
313 m_handler = NULL;
314
315 if ( win )
316 SetWindow(win);
317 }
318
319 wxScrollHelper::~wxScrollHelper()
320 {
321 StopAutoScrolling();
322
323 DeleteEvtHandler();
324 }
325
326 // ----------------------------------------------------------------------------
327 // setting scrolling parameters
328 // ----------------------------------------------------------------------------
329
330 void wxScrollHelper::SetScrollbars(int pixelsPerUnitX,
331 int pixelsPerUnitY,
332 int noUnitsX,
333 int noUnitsY,
334 int xPos,
335 int yPos,
336 bool noRefresh)
337 {
338 int xpos, ypos;
339
340 CalcUnscrolledPosition(xPos, yPos, &xpos, &ypos);
341 bool do_refresh =
342 (
343 (noUnitsX != 0 && m_xScrollLines == 0) ||
344 (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX * noUnitsX) ||
345
346 (noUnitsY != 0 && m_yScrollLines == 0) ||
347 (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY * noUnitsY) ||
348 (xPos != m_xScrollPosition) ||
349 (yPos != m_yScrollPosition)
350 );
351
352 m_xScrollPixelsPerLine = pixelsPerUnitX;
353 m_yScrollPixelsPerLine = pixelsPerUnitY;
354 m_xScrollPosition = xPos;
355 m_yScrollPosition = yPos;
356
357 int w = noUnitsX * pixelsPerUnitX;
358 int h = noUnitsY * pixelsPerUnitY;
359
360 // For better backward compatibility we set persisting limits
361 // here not just the size. It makes SetScrollbars 'sticky'
362 // emulating the old non-autoscroll behaviour.
363
364 m_targetWindow->SetVirtualSizeHints( w, h );
365
366 // The above should arguably be deprecated, this however we still need.
367
368 m_targetWindow->SetVirtualSize( w, h );
369
370 if (do_refresh && !noRefresh)
371 m_targetWindow->Refresh(true, GetScrollRect());
372
373 #ifndef __WXUNIVERSAL__
374 // If the target is not the same as the window with the scrollbars,
375 // then we need to update the scrollbars here, since they won't have
376 // been updated by SetVirtualSize().
377 if ( m_targetWindow != m_win )
378 #endif // !__WXUNIVERSAL__
379 {
380 AdjustScrollbars();
381 }
382 #ifndef __WXUNIVERSAL__
383 else
384 {
385 // otherwise this has been done by AdjustScrollbars, above
386 }
387 #endif // !__WXUNIVERSAL__
388 }
389
390 // ----------------------------------------------------------------------------
391 // [target] window handling
392 // ----------------------------------------------------------------------------
393
394 void wxScrollHelper::DeleteEvtHandler()
395 {
396 // search for m_handler in the handler list
397 if ( m_win && m_handler )
398 {
399 if ( m_win->RemoveEventHandler(m_handler) )
400 {
401 delete m_handler;
402 }
403 //else: something is very wrong, so better [maybe] leak memory than
404 // risk a crash because of double deletion
405
406 m_handler = NULL;
407 }
408 }
409
410 void wxScrollHelper::SetWindow(wxWindow *win)
411 {
412 wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
413
414 m_win = win;
415
416 // by default, the associated window is also the target window
417 DoSetTargetWindow(win);
418 }
419
420 void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
421 {
422 m_targetWindow = target;
423
424 // install the event handler which will intercept the events we're
425 // interested in (but only do it for our real window, not the target window
426 // which we scroll - we don't need to hijack its events)
427 if ( m_targetWindow == m_win )
428 {
429 // if we already have a handler, delete it first
430 DeleteEvtHandler();
431
432 m_handler = new wxScrollHelperEvtHandler(this);
433 m_targetWindow->PushEventHandler(m_handler);
434 }
435 }
436
437 void wxScrollHelper::SetTargetWindow(wxWindow *target)
438 {
439 wxCHECK_RET( target, wxT("target window must not be NULL") );
440
441 if ( target == m_targetWindow )
442 return;
443
444 DoSetTargetWindow(target);
445 }
446
447 wxWindow *wxScrollHelper::GetTargetWindow() const
448 {
449 return m_targetWindow;
450 }
451
452 // ----------------------------------------------------------------------------
453 // scrolling implementation itself
454 // ----------------------------------------------------------------------------
455
456 void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
457 {
458 int nScrollInc = CalcScrollInc(event);
459 if ( nScrollInc == 0 )
460 {
461 // can't scroll further
462 event.Skip();
463
464 return;
465 }
466
467 int orient = event.GetOrientation();
468 if (orient == wxHORIZONTAL)
469 {
470 m_xScrollPosition += nScrollInc;
471 m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
472 }
473 else
474 {
475 m_yScrollPosition += nScrollInc;
476 m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
477 }
478
479 bool needsRefresh = false;
480 int dx = 0,
481 dy = 0;
482 if (orient == wxHORIZONTAL)
483 {
484 if ( m_xScrollingEnabled )
485 {
486 dx = -m_xScrollPixelsPerLine * nScrollInc;
487 }
488 else
489 {
490 needsRefresh = true;
491 }
492 }
493 else
494 {
495 if ( m_yScrollingEnabled )
496 {
497 dy = -m_yScrollPixelsPerLine * nScrollInc;
498 }
499 else
500 {
501 needsRefresh = true;
502 }
503 }
504
505 if ( needsRefresh )
506 {
507 m_targetWindow->Refresh(true, GetScrollRect());
508 }
509 else
510 {
511 m_targetWindow->ScrollWindow(dx, dy, GetScrollRect());
512 }
513 }
514
515 int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
516 {
517 int pos = event.GetPosition();
518 int orient = event.GetOrientation();
519
520 int nScrollInc = 0;
521 if (event.GetEventType() == wxEVT_SCROLLWIN_TOP)
522 {
523 if (orient == wxHORIZONTAL)
524 nScrollInc = - m_xScrollPosition;
525 else
526 nScrollInc = - m_yScrollPosition;
527 } else
528 if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
529 {
530 if (orient == wxHORIZONTAL)
531 nScrollInc = m_xScrollLines - m_xScrollPosition;
532 else
533 nScrollInc = m_yScrollLines - m_yScrollPosition;
534 } else
535 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
536 {
537 nScrollInc = -1;
538 } else
539 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN)
540 {
541 nScrollInc = 1;
542 } else
543 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEUP)
544 {
545 if (orient == wxHORIZONTAL)
546 nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
547 else
548 nScrollInc = -GetScrollPageSize(wxVERTICAL);
549 } else
550 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN)
551 {
552 if (orient == wxHORIZONTAL)
553 nScrollInc = GetScrollPageSize(wxHORIZONTAL);
554 else
555 nScrollInc = GetScrollPageSize(wxVERTICAL);
556 } else
557 if ((event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK) ||
558 (event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE))
559 {
560 if (orient == wxHORIZONTAL)
561 nScrollInc = pos - m_xScrollPosition;
562 else
563 nScrollInc = pos - m_yScrollPosition;
564 }
565
566 if (orient == wxHORIZONTAL)
567 {
568 if (m_xScrollPixelsPerLine > 0)
569 {
570 int w, h;
571 GetTargetSize(&w, &h);
572
573 int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
574 int noPositions = (int) ( ((nMaxWidth - w)/(double)m_xScrollPixelsPerLine) + 0.5 );
575 if (noPositions < 0)
576 noPositions = 0;
577
578 if ( (m_xScrollPosition + nScrollInc) < 0 )
579 nScrollInc = -m_xScrollPosition; // As -ve as we can go
580 else if ( (m_xScrollPosition + nScrollInc) > noPositions )
581 nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go
582 }
583 else
584 m_targetWindow->Refresh(true, GetScrollRect());
585 }
586 else
587 {
588 if ( m_yScrollPixelsPerLine > 0 )
589 {
590 if ( m_yScrollPosition + nScrollInc < 0 )
591 {
592 // As -ve as we can go
593 nScrollInc = -m_yScrollPosition;
594 }
595 else // check for the other bound
596 {
597 const int posMax = m_yScrollLines - m_yScrollLinesPerPage;
598 if ( m_yScrollPosition + nScrollInc > posMax )
599 {
600 // As +ve as we can go
601 nScrollInc = posMax - m_yScrollPosition;
602 }
603 }
604 }
605 else
606 {
607 // VZ: why do we do this? (FIXME)
608 m_targetWindow->Refresh(true, GetScrollRect());
609 }
610 }
611
612 return nScrollInc;
613 }
614
615 // Adjust the scrollbars - new version.
616 void wxScrollHelper::AdjustScrollbars()
617 {
618 static wxRecursionGuardFlag s_flagReentrancy;
619 wxRecursionGuard guard(s_flagReentrancy);
620 if ( guard.IsInside() )
621 {
622 // don't reenter AdjustScrollbars() while another call to
623 // AdjustScrollbars() is in progress because this may lead to calling
624 // ScrollWindow() twice and this can really happen under MSW if
625 // SetScrollbar() call below adds or removes the scrollbar which
626 // changes the window size and hence results in another
627 // AdjustScrollbars() call
628 return;
629 }
630
631 int w = 0, h = 0;
632 int oldw, oldh;
633
634 int oldXScroll = m_xScrollPosition;
635 int oldYScroll = m_yScrollPosition;
636
637 // VZ: at least under Windows this loop is useless because when scrollbars
638 // [dis]appear we get a WM_SIZE resulting in another call to
639 // AdjustScrollbars() anyhow. As it doesn't seem to do any harm I leave
640 // it here for now but it would be better to ensure that all ports
641 // generate EVT_SIZE when scrollbars [dis]appear, emulating it if
642 // necessary, and remove it later
643 do
644 {
645 GetTargetSize(&w, 0);
646
647 if (m_xScrollPixelsPerLine == 0)
648 {
649 m_xScrollLines = 0;
650 m_xScrollPosition = 0;
651 m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, false);
652 }
653 else
654 {
655 m_xScrollLines = m_targetWindow->GetVirtualSize().GetWidth() / m_xScrollPixelsPerLine;
656
657 // Calculate page size i.e. number of scroll units you get on the
658 // current client window
659 int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
660 if (noPagePositions < 1) noPagePositions = 1;
661 if ( noPagePositions > m_xScrollLines )
662 noPagePositions = m_xScrollLines;
663
664 // Correct position if greater than extent of canvas minus
665 // the visible portion of it or if below zero
666 m_xScrollPosition = wxMin( m_xScrollLines - noPagePositions, m_xScrollPosition);
667 m_xScrollPosition = wxMax( 0, m_xScrollPosition );
668
669 m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
670 // The amount by which we scroll when paging
671 SetScrollPageSize(wxHORIZONTAL, noPagePositions);
672 }
673
674 GetTargetSize(0, &h);
675
676 // scroll lines per page: if 0, no scrolling is needed
677 int linesPerPage;
678
679 if ( m_yScrollPixelsPerLine == 0 )
680 {
681 // scrolling is disabled
682 m_yScrollLines = 0;
683 m_yScrollPosition = 0;
684 linesPerPage = 0;
685 }
686 else // might need scrolling
687 {
688 int hVirt = m_targetWindow->GetVirtualSize().GetHeight();
689 m_yScrollLines = hVirt / m_yScrollPixelsPerLine;
690
691 // Calculate page size i.e. number of scroll units you get on the
692 // current client window
693 linesPerPage = h / m_yScrollPixelsPerLine;
694 if ( linesPerPage >= m_yScrollLines )
695 {
696 // we're big enough to not need scrolling
697 linesPerPage =
698 m_yScrollLines =
699 m_yScrollPosition = 0;
700 }
701 else // we do need a scrollbar
702 {
703 if ( linesPerPage < 1 )
704 linesPerPage = 1;
705
706 // Correct position if greater than extent of canvas minus
707 // the visible portion of it or if below zero
708 const int posMax = m_yScrollLines - linesPerPage;
709 if ( m_yScrollPosition > posMax )
710 m_yScrollPosition = posMax;
711 else if ( m_yScrollPosition < 0 )
712 m_yScrollPosition = 0;
713 }
714 }
715
716 m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition,
717 linesPerPage, m_yScrollLines);
718
719 // The amount by which we scroll when paging
720 SetScrollPageSize(wxVERTICAL, linesPerPage);
721
722
723 // If a scrollbar (dis)appeared as a result of this, adjust them again.
724 oldw = w;
725 oldh = h;
726
727 GetTargetSize( &w, &h );
728 } while ( w != oldw || h != oldh );
729
730 #ifdef __WXMOTIF__
731 // Sorry, some Motif-specific code to implement a backing pixmap
732 // for the wxRETAINED style. Implementing a backing store can't
733 // be entirely generic because it relies on the wxWindowDC implementation
734 // to duplicate X drawing calls for the backing pixmap.
735
736 if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
737 {
738 Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
739
740 int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
741 int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
742 if (m_targetWindow->GetBackingPixmap() &&
743 !((m_targetWindow->GetPixmapWidth() == totalPixelWidth) &&
744 (m_targetWindow->GetPixmapHeight() == totalPixelHeight)))
745 {
746 XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
747 m_targetWindow->SetBackingPixmap((WXPixmap) 0);
748 }
749
750 if (!m_targetWindow->GetBackingPixmap() &&
751 (m_xScrollLines != 0) && (m_yScrollLines != 0))
752 {
753 int depth = wxDisplayDepth();
754 m_targetWindow->SetPixmapWidth(totalPixelWidth);
755 m_targetWindow->SetPixmapHeight(totalPixelHeight);
756 m_targetWindow->SetBackingPixmap((WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
757 m_targetWindow->GetPixmapWidth(), m_targetWindow->GetPixmapHeight(), depth));
758 }
759
760 }
761 #endif // Motif
762
763 if (oldXScroll != m_xScrollPosition)
764 {
765 if (m_xScrollingEnabled)
766 m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
767 GetScrollRect() );
768 else
769 m_targetWindow->Refresh(true, GetScrollRect());
770 }
771
772 if (oldYScroll != m_yScrollPosition)
773 {
774 if (m_yScrollingEnabled)
775 m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
776 GetScrollRect() );
777 else
778 m_targetWindow->Refresh(true, GetScrollRect());
779 }
780 }
781
782 void wxScrollHelper::DoPrepareDC(wxDC& dc)
783 {
784 wxPoint pt = dc.GetDeviceOrigin();
785 dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
786 pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
787 dc.SetUserScale( m_scaleX, m_scaleY );
788 }
789
790 void wxScrollHelper::SetScrollRate( int xstep, int ystep )
791 {
792 int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
793 int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
794
795 m_xScrollPixelsPerLine = xstep;
796 m_yScrollPixelsPerLine = ystep;
797
798 int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
799 int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
800
801 m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
802 m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
803 m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
804
805 AdjustScrollbars();
806 }
807
808 void wxScrollHelper::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
809 {
810 if ( x_unit )
811 *x_unit = m_xScrollPixelsPerLine;
812 if ( y_unit )
813 *y_unit = m_yScrollPixelsPerLine;
814 }
815
816 int wxScrollHelper::GetScrollPageSize(int orient) const
817 {
818 if ( orient == wxHORIZONTAL )
819 return m_xScrollLinesPerPage;
820 else
821 return m_yScrollLinesPerPage;
822 }
823
824 void wxScrollHelper::SetScrollPageSize(int orient, int pageSize)
825 {
826 if ( orient == wxHORIZONTAL )
827 m_xScrollLinesPerPage = pageSize;
828 else
829 m_yScrollLinesPerPage = pageSize;
830 }
831
832 /*
833 * Scroll to given position (scroll position, not pixel position)
834 */
835 void wxScrollHelper::Scroll( int x_pos, int y_pos )
836 {
837 if (!m_targetWindow)
838 return;
839
840 if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
841 ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
842
843 int w, h;
844 GetTargetSize(&w, &h);
845
846 if ((x_pos != -1) && (m_xScrollPixelsPerLine))
847 {
848 int old_x = m_xScrollPosition;
849 m_xScrollPosition = x_pos;
850
851 // Calculate page size i.e. number of scroll units you get on the
852 // current client window
853 int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
854 if (noPagePositions < 1) noPagePositions = 1;
855
856 // Correct position if greater than extent of canvas minus
857 // the visible portion of it or if below zero
858 m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition );
859 m_xScrollPosition = wxMax( 0, m_xScrollPosition );
860
861 if (old_x != m_xScrollPosition) {
862 m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
863 m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
864 GetScrollRect() );
865 }
866 }
867 if ((y_pos != -1) && (m_yScrollPixelsPerLine))
868 {
869 int old_y = m_yScrollPosition;
870 m_yScrollPosition = y_pos;
871
872 // Calculate page size i.e. number of scroll units you get on the
873 // current client window
874 int noPagePositions = (int) ( (h/(double)m_yScrollPixelsPerLine) + 0.5 );
875 if (noPagePositions < 1) noPagePositions = 1;
876
877 // Correct position if greater than extent of canvas minus
878 // the visible portion of it or if below zero
879 m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
880 m_yScrollPosition = wxMax( 0, m_yScrollPosition );
881
882 if (old_y != m_yScrollPosition) {
883 m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
884 m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
885 GetScrollRect() );
886 }
887 }
888 }
889
890 void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)
891 {
892 m_xScrollingEnabled = x_scroll;
893 m_yScrollingEnabled = y_scroll;
894 }
895
896 // Where the current view starts from
897 void wxScrollHelper::GetViewStart (int *x, int *y) const
898 {
899 if ( x )
900 *x = m_xScrollPosition;
901 if ( y )
902 *y = m_yScrollPosition;
903 }
904
905 void wxScrollHelper::DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const
906 {
907 if ( xx )
908 *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
909 if ( yy )
910 *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
911 }
912
913 void wxScrollHelper::DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
914 {
915 if ( xx )
916 *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
917 if ( yy )
918 *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
919 }
920
921 // ----------------------------------------------------------------------------
922 // event handlers
923 // ----------------------------------------------------------------------------
924
925 // Default OnSize resets scrollbars, if any
926 void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
927 {
928 if( m_win->GetAutoLayout() || m_targetWindow->GetAutoLayout() )
929 {
930 if ( m_targetWindow != m_win )
931 m_targetWindow->FitInside();
932
933 m_win->FitInside();
934
935 // FIXME: Something is really weird here... This should be
936 // called by FitInside above (and apparently is), yet the
937 // scrollsub sample will get the scrollbar wrong if resized
938 // quickly. This masks the bug, but is surely not the right
939 // answer at all.
940 AdjustScrollbars();
941 }
942 else
943 AdjustScrollbars();
944 }
945
946 // This calls OnDraw, having adjusted the origin according to the current
947 // scroll position
948 void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
949 {
950 // don't use m_targetWindow here, this is always called for ourselves
951 wxPaintDC dc(m_win);
952 DoPrepareDC(dc);
953
954 OnDraw(dc);
955 }
956
957 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
958 // compatibility here - if we used OnKeyDown(), the programs which process
959 // arrows themselves in their OnChar() would never get the message and like
960 // this they always have the priority
961 void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
962 {
963 int stx, sty, // view origin
964 szx, szy, // view size (total)
965 clix, cliy; // view size (on screen)
966
967 GetViewStart(&stx, &sty);
968 GetTargetSize(&clix, &cliy);
969 m_targetWindow->GetVirtualSize(&szx, &szy);
970
971 if( m_xScrollPixelsPerLine )
972 {
973 clix /= m_xScrollPixelsPerLine;
974 szx /= m_xScrollPixelsPerLine;
975 }
976 else
977 {
978 clix = 0;
979 szx = -1;
980 }
981 if( m_yScrollPixelsPerLine )
982 {
983 cliy /= m_yScrollPixelsPerLine;
984 szy /= m_yScrollPixelsPerLine;
985 }
986 else
987 {
988 cliy = 0;
989 szy = -1;
990 }
991
992 int xScrollOld = m_xScrollPosition,
993 yScrollOld = m_yScrollPosition;
994
995 int dsty;
996 switch ( event.GetKeyCode() )
997 {
998 case WXK_PAGEUP:
999 case WXK_PRIOR:
1000 dsty = sty - (5 * cliy / 6);
1001 Scroll(-1, (dsty == -1) ? 0 : dsty);
1002 break;
1003
1004 case WXK_PAGEDOWN:
1005 case WXK_NEXT:
1006 Scroll(-1, sty + (5 * cliy / 6));
1007 break;
1008
1009 case WXK_HOME:
1010 Scroll(0, event.ControlDown() ? 0 : -1);
1011 break;
1012
1013 case WXK_END:
1014 Scroll(szx - clix, event.ControlDown() ? szy - cliy : -1);
1015 break;
1016
1017 case WXK_UP:
1018 Scroll(-1, sty - 1);
1019 break;
1020
1021 case WXK_DOWN:
1022 Scroll(-1, sty + 1);
1023 break;
1024
1025 case WXK_LEFT:
1026 Scroll(stx - 1, -1);
1027 break;
1028
1029 case WXK_RIGHT:
1030 Scroll(stx + 1, -1);
1031 break;
1032
1033 default:
1034 // not for us
1035 event.Skip();
1036 }
1037
1038 if ( m_xScrollPosition != xScrollOld )
1039 {
1040 wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_xScrollPosition,
1041 wxHORIZONTAL);
1042 event.SetEventObject(m_win);
1043 m_win->GetEventHandler()->ProcessEvent(event);
1044 }
1045
1046 if ( m_yScrollPosition != yScrollOld )
1047 {
1048 wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_yScrollPosition,
1049 wxVERTICAL);
1050 event.SetEventObject(m_win);
1051 m_win->GetEventHandler()->ProcessEvent(event);
1052 }
1053 }
1054
1055 // ----------------------------------------------------------------------------
1056 // autoscroll stuff: these functions deal with sending fake scroll events when
1057 // a captured mouse is being held outside the window
1058 // ----------------------------------------------------------------------------
1059
1060 bool wxScrollHelper::SendAutoScrollEvents(wxScrollWinEvent& event) const
1061 {
1062 // only send the event if the window is scrollable in this direction
1063 wxWindow *win = (wxWindow *)event.GetEventObject();
1064 return win->HasScrollbar(event.GetOrientation());
1065 }
1066
1067 void wxScrollHelper::StopAutoScrolling()
1068 {
1069 #if wxUSE_TIMER
1070 if ( m_timerAutoScroll )
1071 {
1072 delete m_timerAutoScroll;
1073 m_timerAutoScroll = (wxTimer *)NULL;
1074 }
1075 #endif
1076 }
1077
1078 void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
1079 {
1080 StopAutoScrolling();
1081
1082 event.Skip();
1083 }
1084
1085 void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
1086 {
1087 // don't prevent the usual processing of the event from taking place
1088 event.Skip();
1089
1090 // when a captured mouse leave a scrolled window we start generate
1091 // scrolling events to allow, for example, extending selection beyond the
1092 // visible area in some controls
1093 if ( wxWindow::GetCapture() == m_targetWindow )
1094 {
1095 // where is the mouse leaving?
1096 int pos, orient;
1097 wxPoint pt = event.GetPosition();
1098 if ( pt.x < 0 )
1099 {
1100 orient = wxHORIZONTAL;
1101 pos = 0;
1102 }
1103 else if ( pt.y < 0 )
1104 {
1105 orient = wxVERTICAL;
1106 pos = 0;
1107 }
1108 else // we're lower or to the right of the window
1109 {
1110 wxSize size = m_targetWindow->GetClientSize();
1111 if ( pt.x > size.x )
1112 {
1113 orient = wxHORIZONTAL;
1114 pos = m_xScrollLines;
1115 }
1116 else if ( pt.y > size.y )
1117 {
1118 orient = wxVERTICAL;
1119 pos = m_yScrollLines;
1120 }
1121 else // this should be impossible
1122 {
1123 // but seems to happen sometimes under wxMSW - maybe it's a bug
1124 // there but for now just ignore it
1125
1126 //wxFAIL_MSG( _T("can't understand where has mouse gone") );
1127
1128 return;
1129 }
1130 }
1131
1132 // only start the auto scroll timer if the window can be scrolled in
1133 // this direction
1134 if ( !m_targetWindow->HasScrollbar(orient) )
1135 return;
1136
1137 #if wxUSE_TIMER
1138 delete m_timerAutoScroll;
1139 m_timerAutoScroll = new wxAutoScrollTimer
1140 (
1141 m_targetWindow, this,
1142 pos == 0 ? wxEVT_SCROLLWIN_LINEUP
1143 : wxEVT_SCROLLWIN_LINEDOWN,
1144 pos,
1145 orient
1146 );
1147 m_timerAutoScroll->Start(50); // FIXME: make configurable
1148 #else
1149 wxUnusedVar(pos);
1150 #endif
1151 }
1152 }
1153
1154 #if wxUSE_MOUSEWHEEL
1155
1156 void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
1157 {
1158 m_wheelRotation += event.GetWheelRotation();
1159 int lines = m_wheelRotation / event.GetWheelDelta();
1160 m_wheelRotation -= lines * event.GetWheelDelta();
1161
1162 if (lines != 0)
1163 {
1164
1165 wxScrollWinEvent newEvent;
1166
1167 newEvent.SetPosition(0);
1168 newEvent.SetOrientation(wxVERTICAL);
1169 newEvent.m_eventObject = m_win;
1170
1171 if (event.IsPageScroll())
1172 {
1173 if (lines > 0)
1174 newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEUP;
1175 else
1176 newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEDOWN;
1177
1178 m_win->GetEventHandler()->ProcessEvent(newEvent);
1179 }
1180 else
1181 {
1182 lines *= event.GetLinesPerAction();
1183 if (lines > 0)
1184 newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
1185 else
1186 newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
1187
1188 int times = abs(lines);
1189 for (; times > 0; times--)
1190 m_win->GetEventHandler()->ProcessEvent(newEvent);
1191 }
1192 }
1193 }
1194
1195 #endif // wxUSE_MOUSEWHEEL
1196
1197 // ----------------------------------------------------------------------------
1198 // wxGenericScrolledWindow implementation
1199 // ----------------------------------------------------------------------------
1200
1201 IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
1202
1203 BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
1204 EVT_PAINT(wxGenericScrolledWindow::OnPaint)
1205 END_EVENT_TABLE()
1206
1207 bool wxGenericScrolledWindow::Create(wxWindow *parent,
1208 wxWindowID id,
1209 const wxPoint& pos,
1210 const wxSize& size,
1211 long style,
1212 const wxString& name)
1213 {
1214 m_targetWindow = this;
1215
1216 bool ok = wxPanel::Create(parent, id, pos, size, style|wxHSCROLL|wxVSCROLL, name);
1217
1218 return ok;
1219 }
1220
1221 wxGenericScrolledWindow::~wxGenericScrolledWindow()
1222 {
1223 }
1224
1225 bool wxGenericScrolledWindow::Layout()
1226 {
1227 if (GetSizer() && m_targetWindow == this)
1228 {
1229 // If we're the scroll target, take into account the
1230 // virtual size and scrolled position of the window.
1231
1232 int x, y, w, h;
1233 CalcScrolledPosition(0,0, &x,&y);
1234 GetVirtualSize(&w, &h);
1235 GetSizer()->SetDimension(x, y, w, h);
1236 return true;
1237 }
1238
1239 // fall back to default for LayoutConstraints
1240 return wxPanel::Layout();
1241 }
1242
1243 void wxGenericScrolledWindow::DoSetVirtualSize(int x, int y)
1244 {
1245 wxPanel::DoSetVirtualSize( x, y );
1246 AdjustScrollbars();
1247
1248 if (GetAutoLayout())
1249 Layout();
1250 }
1251
1252 void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
1253 {
1254 // the user code didn't really draw the window if we got here, so set this
1255 // flag to try to call OnDraw() later
1256 m_handler->ResetDrawnFlag();
1257
1258 event.Skip();
1259 }
1260
1261 #ifdef __WXMSW__
1262 WXLRESULT
1263 wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
1264 WXWPARAM wParam,
1265 WXLPARAM lParam)
1266 {
1267 WXLRESULT rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);
1268
1269 #ifndef __WXWINCE__
1270 // we need to process arrows ourselves for scrolling
1271 if ( nMsg == WM_GETDLGCODE )
1272 {
1273 rc |= DLGC_WANTARROWS;
1274 }
1275 #endif
1276
1277 return rc;
1278 }
1279
1280 #endif // __WXMSW__
1281
1282 #endif // !wxGTK
1283
1284 // vi:sts=4:sw=4:et
wxWidgets (Impactor)