projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
removed WXWIN_COMPATIBILITY and WXWIN_COMPATIBILITY_2
[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) wxWindows 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 #ifdef __WXMAC__
387 m_targetWindow->Update() ;
388 #endif
389 }
390 #endif // !__WXUNIVERSAL__
391 }
392
393 // ----------------------------------------------------------------------------
394 // [target] window handling
395 // ----------------------------------------------------------------------------
396
397 void wxScrollHelper::DeleteEvtHandler()
398 {
399 // search for m_handler in the handler list
400 if ( m_win && m_handler )
401 {
402 if ( m_win->RemoveEventHandler(m_handler) )
403 {
404 delete m_handler;
405 }
406 //else: something is very wrong, so better [maybe] leak memory than
407 // risk a crash because of double deletion
408
409 m_handler = NULL;
410 }
411 }
412
413 void wxScrollHelper::SetWindow(wxWindow *win)
414 {
415 wxCHECK_RET( win, _T("wxScrollHelper needs a window to scroll") );
416
417 m_win = win;
418
419 // by default, the associated window is also the target window
420 DoSetTargetWindow(win);
421 }
422
423 void wxScrollHelper::DoSetTargetWindow(wxWindow *target)
424 {
425 m_targetWindow = target;
426
427 // install the event handler which will intercept the events we're
428 // interested in (but only do it for our real window, not the target window
429 // which we scroll - we don't need to hijack its events)
430 if ( m_targetWindow == m_win )
431 {
432 // if we already have a handler, delete it first
433 DeleteEvtHandler();
434
435 m_handler = new wxScrollHelperEvtHandler(this);
436 m_targetWindow->PushEventHandler(m_handler);
437 }
438 }
439
440 void wxScrollHelper::SetTargetWindow(wxWindow *target)
441 {
442 wxCHECK_RET( target, wxT("target window must not be NULL") );
443
444 if ( target == m_targetWindow )
445 return;
446
447 DoSetTargetWindow(target);
448 }
449
450 wxWindow *wxScrollHelper::GetTargetWindow() const
451 {
452 return m_targetWindow;
453 }
454
455 // ----------------------------------------------------------------------------
456 // scrolling implementation itself
457 // ----------------------------------------------------------------------------
458
459 void wxScrollHelper::HandleOnScroll(wxScrollWinEvent& event)
460 {
461 int nScrollInc = CalcScrollInc(event);
462 if ( nScrollInc == 0 )
463 {
464 // can't scroll further
465 event.Skip();
466
467 return;
468 }
469
470 int orient = event.GetOrientation();
471 if (orient == wxHORIZONTAL)
472 {
473 m_xScrollPosition += nScrollInc;
474 m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
475 }
476 else
477 {
478 m_yScrollPosition += nScrollInc;
479 m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
480 }
481
482 bool needsRefresh = FALSE;
483 int dx = 0,
484 dy = 0;
485 if (orient == wxHORIZONTAL)
486 {
487 if ( m_xScrollingEnabled )
488 {
489 dx = -m_xScrollPixelsPerLine * nScrollInc;
490 }
491 else
492 {
493 needsRefresh = TRUE;
494 }
495 }
496 else
497 {
498 if ( m_yScrollingEnabled )
499 {
500 dy = -m_yScrollPixelsPerLine * nScrollInc;
501 }
502 else
503 {
504 needsRefresh = TRUE;
505 }
506 }
507
508 if ( needsRefresh )
509 {
510 m_targetWindow->Refresh(TRUE, GetScrollRect());
511 }
512 else
513 {
514 m_targetWindow->ScrollWindow(dx, dy, GetScrollRect());
515 }
516
517 #ifdef __WXMAC__
518 m_targetWindow->Update() ;
519 #endif
520 }
521
522 int wxScrollHelper::CalcScrollInc(wxScrollWinEvent& event)
523 {
524 int pos = event.GetPosition();
525 int orient = event.GetOrientation();
526
527 int nScrollInc = 0;
528 if (event.GetEventType() == wxEVT_SCROLLWIN_TOP)
529 {
530 if (orient == wxHORIZONTAL)
531 nScrollInc = - m_xScrollPosition;
532 else
533 nScrollInc = - m_yScrollPosition;
534 } else
535 if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
536 {
537 if (orient == wxHORIZONTAL)
538 nScrollInc = m_xScrollLines - m_xScrollPosition;
539 else
540 nScrollInc = m_yScrollLines - m_yScrollPosition;
541 } else
542 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
543 {
544 nScrollInc = -1;
545 } else
546 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN)
547 {
548 nScrollInc = 1;
549 } else
550 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEUP)
551 {
552 if (orient == wxHORIZONTAL)
553 nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
554 else
555 nScrollInc = -GetScrollPageSize(wxVERTICAL);
556 } else
557 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN)
558 {
559 if (orient == wxHORIZONTAL)
560 nScrollInc = GetScrollPageSize(wxHORIZONTAL);
561 else
562 nScrollInc = GetScrollPageSize(wxVERTICAL);
563 } else
564 if ((event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK) ||
565 (event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE))
566 {
567 if (orient == wxHORIZONTAL)
568 nScrollInc = pos - m_xScrollPosition;
569 else
570 nScrollInc = pos - m_yScrollPosition;
571 }
572
573 if (orient == wxHORIZONTAL)
574 {
575 if (m_xScrollPixelsPerLine > 0)
576 {
577 int w, h;
578 GetTargetSize(&w, &h);
579
580 int nMaxWidth = m_xScrollLines*m_xScrollPixelsPerLine;
581 int noPositions = (int) ( ((nMaxWidth - w)/(double)m_xScrollPixelsPerLine) + 0.5 );
582 if (noPositions < 0)
583 noPositions = 0;
584
585 if ( (m_xScrollPosition + nScrollInc) < 0 )
586 nScrollInc = -m_xScrollPosition; // As -ve as we can go
587 else if ( (m_xScrollPosition + nScrollInc) > noPositions )
588 nScrollInc = noPositions - m_xScrollPosition; // As +ve as we can go
589 }
590 else
591 m_targetWindow->Refresh(TRUE, GetScrollRect());
592 }
593 else
594 {
595 if ( m_yScrollPixelsPerLine > 0 )
596 {
597 if ( m_yScrollPosition + nScrollInc < 0 )
598 {
599 // As -ve as we can go
600 nScrollInc = -m_yScrollPosition;
601 }
602 else // check for the other bound
603 {
604 const int posMax = m_yScrollLines - m_yScrollLinesPerPage;
605 if ( m_yScrollPosition + nScrollInc > posMax )
606 {
607 // As +ve as we can go
608 nScrollInc = posMax - m_yScrollPosition;
609 }
610 }
611 }
612 else
613 {
614 // VZ: why do we do this? (FIXME)
615 m_targetWindow->Refresh(TRUE, GetScrollRect());
616 }
617 }
618
619 return nScrollInc;
620 }
621
622 // Adjust the scrollbars - new version.
623 void wxScrollHelper::AdjustScrollbars()
624 {
625 static wxRecursionGuardFlag s_flagReentrancy;
626 wxRecursionGuard guard(s_flagReentrancy);
627 if ( guard.IsInside() )
628 {
629 // don't reenter AdjustScrollbars() while another call to
630 // AdjustScrollbars() is in progress because this may lead to calling
631 // ScrollWindow() twice and this can really happen under MSW if
632 // SetScrollbar() call below adds or removes the scrollbar which
633 // changes the window size and hence results in another
634 // AdjustScrollbars() call
635 return;
636 }
637
638 #ifdef __WXMAC__
639 m_targetWindow->Update();
640 #endif
641
642 int w = 0, h = 0;
643 int oldw, oldh;
644
645 int oldXScroll = m_xScrollPosition;
646 int oldYScroll = m_yScrollPosition;
647
648 // VZ: at least under Windows this loop is useless because when scrollbars
649 // [dis]appear we get a WM_SIZE resulting in another call to
650 // AdjustScrollbars() anyhow. As it doesn't seem to do any harm I leave
651 // it here for now but it would be better to ensure that all ports
652 // generate EVT_SIZE when scrollbars [dis]appear, emulating it if
653 // necessary, and remove it later
654 do
655 {
656 GetTargetSize(&w, 0);
657
658 if (m_xScrollPixelsPerLine == 0)
659 {
660 m_xScrollLines = 0;
661 m_xScrollPosition = 0;
662 m_win->SetScrollbar (wxHORIZONTAL, 0, 0, 0, FALSE);
663 }
664 else
665 {
666 m_xScrollLines = m_targetWindow->GetVirtualSize().GetWidth() / m_xScrollPixelsPerLine;
667
668 // Calculate page size i.e. number of scroll units you get on the
669 // current client window
670 int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
671 if (noPagePositions < 1) noPagePositions = 1;
672 if ( noPagePositions > m_xScrollLines )
673 noPagePositions = m_xScrollLines;
674
675 // Correct position if greater than extent of canvas minus
676 // the visible portion of it or if below zero
677 m_xScrollPosition = wxMin( m_xScrollLines - noPagePositions, m_xScrollPosition);
678 m_xScrollPosition = wxMax( 0, m_xScrollPosition );
679
680 m_win->SetScrollbar(wxHORIZONTAL, m_xScrollPosition, noPagePositions, m_xScrollLines);
681 // The amount by which we scroll when paging
682 SetScrollPageSize(wxHORIZONTAL, noPagePositions);
683 }
684
685 GetTargetSize(0, &h);
686
687 // scroll lines per page: if 0, no scrolling is needed
688 int linesPerPage;
689
690 if ( m_yScrollPixelsPerLine == 0 )
691 {
692 // scrolling is disabled
693 m_yScrollLines = 0;
694 m_yScrollPosition = 0;
695 linesPerPage = 0;
696 }
697 else // might need scrolling
698 {
699 int hVirt = m_targetWindow->GetVirtualSize().GetHeight();
700 m_yScrollLines = hVirt / m_yScrollPixelsPerLine;
701
702 // Calculate page size i.e. number of scroll units you get on the
703 // current client window
704 linesPerPage = h / m_yScrollPixelsPerLine;
705 if ( linesPerPage >= m_yScrollLines )
706 {
707 // we're big enough to not need scrolling
708 linesPerPage =
709 m_yScrollLines =
710 m_yScrollPosition = 0;
711 }
712 else // we do need a scrollbar
713 {
714 if ( linesPerPage < 1 )
715 linesPerPage = 1;
716
717 // Correct position if greater than extent of canvas minus
718 // the visible portion of it or if below zero
719 const int posMax = m_yScrollLines - linesPerPage;
720 if ( m_yScrollPosition > posMax )
721 m_yScrollPosition = posMax;
722 else if ( m_yScrollPosition < 0 )
723 m_yScrollPosition = 0;
724 }
725 }
726
727 m_win->SetScrollbar(wxVERTICAL, m_yScrollPosition,
728 linesPerPage, m_yScrollLines);
729
730 // The amount by which we scroll when paging
731 SetScrollPageSize(wxVERTICAL, linesPerPage);
732
733
734 // If a scrollbar (dis)appeared as a result of this, adjust them again.
735 oldw = w;
736 oldh = h;
737
738 GetTargetSize( &w, &h );
739 } while ( w != oldw || h != oldh );
740
741 #ifdef __WXMOTIF__
742 // Sorry, some Motif-specific code to implement a backing pixmap
743 // for the wxRETAINED style. Implementing a backing store can't
744 // be entirely generic because it relies on the wxWindowDC implementation
745 // to duplicate X drawing calls for the backing pixmap.
746
747 if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
748 {
749 Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
750
751 int totalPixelWidth = m_xScrollLines * m_xScrollPixelsPerLine;
752 int totalPixelHeight = m_yScrollLines * m_yScrollPixelsPerLine;
753 if (m_targetWindow->GetBackingPixmap() &&
754 !((m_targetWindow->GetPixmapWidth() == totalPixelWidth) &&
755 (m_targetWindow->GetPixmapHeight() == totalPixelHeight)))
756 {
757 XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
758 m_targetWindow->SetBackingPixmap((WXPixmap) 0);
759 }
760
761 if (!m_targetWindow->GetBackingPixmap() &&
762 (m_xScrollLines != 0) && (m_yScrollLines != 0))
763 {
764 int depth = wxDisplayDepth();
765 m_targetWindow->SetPixmapWidth(totalPixelWidth);
766 m_targetWindow->SetPixmapHeight(totalPixelHeight);
767 m_targetWindow->SetBackingPixmap((WXPixmap) XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
768 m_targetWindow->GetPixmapWidth(), m_targetWindow->GetPixmapHeight(), depth));
769 }
770
771 }
772 #endif // Motif
773
774 if (oldXScroll != m_xScrollPosition)
775 {
776 if (m_xScrollingEnabled)
777 m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
778 GetScrollRect() );
779 else
780 m_targetWindow->Refresh(TRUE, GetScrollRect());
781 }
782
783 if (oldYScroll != m_yScrollPosition)
784 {
785 if (m_yScrollingEnabled)
786 m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
787 GetScrollRect() );
788 else
789 m_targetWindow->Refresh(TRUE, GetScrollRect());
790 }
791
792 #ifdef __WXMAC__
793 m_targetWindow->Update();
794 #endif
795 }
796
797 void wxScrollHelper::DoPrepareDC(wxDC& dc)
798 {
799 wxPoint pt = dc.GetDeviceOrigin();
800 dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
801 pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
802 dc.SetUserScale( m_scaleX, m_scaleY );
803 }
804
805 void wxScrollHelper::SetScrollRate( int xstep, int ystep )
806 {
807 int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
808 int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
809
810 m_xScrollPixelsPerLine = xstep;
811 m_yScrollPixelsPerLine = ystep;
812
813 int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
814 int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
815
816 m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
817 m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
818 m_targetWindow->ScrollWindow( old_x - new_x, old_y - new_y );
819
820 AdjustScrollbars();
821 }
822
823 void wxScrollHelper::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
824 {
825 if ( x_unit )
826 *x_unit = m_xScrollPixelsPerLine;
827 if ( y_unit )
828 *y_unit = m_yScrollPixelsPerLine;
829 }
830
831 int wxScrollHelper::GetScrollPageSize(int orient) const
832 {
833 if ( orient == wxHORIZONTAL )
834 return m_xScrollLinesPerPage;
835 else
836 return m_yScrollLinesPerPage;
837 }
838
839 void wxScrollHelper::SetScrollPageSize(int orient, int pageSize)
840 {
841 if ( orient == wxHORIZONTAL )
842 m_xScrollLinesPerPage = pageSize;
843 else
844 m_yScrollLinesPerPage = pageSize;
845 }
846
847 /*
848 * Scroll to given position (scroll position, not pixel position)
849 */
850 void wxScrollHelper::Scroll( int x_pos, int y_pos )
851 {
852 if (!m_targetWindow)
853 return;
854
855 if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
856 ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
857
858 #ifdef __WXMAC__
859 m_targetWindow->Update();
860 #endif
861
862 int w, h;
863 GetTargetSize(&w, &h);
864
865 if ((x_pos != -1) && (m_xScrollPixelsPerLine))
866 {
867 int old_x = m_xScrollPosition;
868 m_xScrollPosition = x_pos;
869
870 // Calculate page size i.e. number of scroll units you get on the
871 // current client window
872 int noPagePositions = (int) ( (w/(double)m_xScrollPixelsPerLine) + 0.5 );
873 if (noPagePositions < 1) noPagePositions = 1;
874
875 // Correct position if greater than extent of canvas minus
876 // the visible portion of it or if below zero
877 m_xScrollPosition = wxMin( m_xScrollLines-noPagePositions, m_xScrollPosition );
878 m_xScrollPosition = wxMax( 0, m_xScrollPosition );
879
880 if (old_x != m_xScrollPosition) {
881 m_win->SetScrollPos( wxHORIZONTAL, m_xScrollPosition );
882 m_targetWindow->ScrollWindow( (old_x-m_xScrollPosition)*m_xScrollPixelsPerLine, 0,
883 GetScrollRect() );
884 }
885 }
886 if ((y_pos != -1) && (m_yScrollPixelsPerLine))
887 {
888 int old_y = m_yScrollPosition;
889 m_yScrollPosition = y_pos;
890
891 // Calculate page size i.e. number of scroll units you get on the
892 // current client window
893 int noPagePositions = (int) ( (h/(double)m_yScrollPixelsPerLine) + 0.5 );
894 if (noPagePositions < 1) noPagePositions = 1;
895
896 // Correct position if greater than extent of canvas minus
897 // the visible portion of it or if below zero
898 m_yScrollPosition = wxMin( m_yScrollLines-noPagePositions, m_yScrollPosition );
899 m_yScrollPosition = wxMax( 0, m_yScrollPosition );
900
901 if (old_y != m_yScrollPosition) {
902 m_win->SetScrollPos( wxVERTICAL, m_yScrollPosition );
903 m_targetWindow->ScrollWindow( 0, (old_y-m_yScrollPosition)*m_yScrollPixelsPerLine,
904 GetScrollRect() );
905 }
906 }
907
908 #ifdef __WXMAC__
909 m_targetWindow->Update();
910 #endif
911
912 }
913
914 void wxScrollHelper::EnableScrolling (bool x_scroll, bool y_scroll)
915 {
916 m_xScrollingEnabled = x_scroll;
917 m_yScrollingEnabled = y_scroll;
918 }
919
920 // Where the current view starts from
921 void wxScrollHelper::GetViewStart (int *x, int *y) const
922 {
923 if ( x )
924 *x = m_xScrollPosition;
925 if ( y )
926 *y = m_yScrollPosition;
927 }
928
929 void wxScrollHelper::DoCalcScrolledPosition(int x, int y, int *xx, int *yy) const
930 {
931 if ( xx )
932 *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
933 if ( yy )
934 *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
935 }
936
937 void wxScrollHelper::DoCalcUnscrolledPosition(int x, int y, int *xx, int *yy) const
938 {
939 if ( xx )
940 *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
941 if ( yy )
942 *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
943 }
944
945 // ----------------------------------------------------------------------------
946 // event handlers
947 // ----------------------------------------------------------------------------
948
949 // Default OnSize resets scrollbars, if any
950 void wxScrollHelper::HandleOnSize(wxSizeEvent& WXUNUSED(event))
951 {
952 if( m_win->GetAutoLayout() || m_targetWindow->GetAutoLayout() )
953 {
954 if ( m_targetWindow != m_win )
955 m_targetWindow->FitInside();
956
957 m_win->FitInside();
958
959 // FIXME: Something is really weird here... This should be
960 // called by FitInside above (and apparently is), yet the
961 // scrollsub sample will get the scrollbar wrong if resized
962 // quickly. This masks the bug, but is surely not the right
963 // answer at all.
964 AdjustScrollbars();
965 }
966 else
967 AdjustScrollbars();
968 }
969
970 // This calls OnDraw, having adjusted the origin according to the current
971 // scroll position
972 void wxScrollHelper::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
973 {
974 // don't use m_targetWindow here, this is always called for ourselves
975 wxPaintDC dc(m_win);
976 DoPrepareDC(dc);
977
978 OnDraw(dc);
979 }
980
981 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
982 // compatibility here - if we used OnKeyDown(), the programs which process
983 // arrows themselves in their OnChar() would never get the message and like
984 // this they always have the priority
985 void wxScrollHelper::HandleOnChar(wxKeyEvent& event)
986 {
987 int stx, sty, // view origin
988 szx, szy, // view size (total)
989 clix, cliy; // view size (on screen)
990
991 GetViewStart(&stx, &sty);
992 GetTargetSize(&clix, &cliy);
993 m_targetWindow->GetVirtualSize(&szx, &szy);
994
995 if( m_xScrollPixelsPerLine )
996 {
997 clix /= m_xScrollPixelsPerLine;
998 szx /= m_xScrollPixelsPerLine;
999 }
1000 else
1001 {
1002 clix = 0;
1003 szx = -1;
1004 }
1005 if( m_yScrollPixelsPerLine )
1006 {
1007 cliy /= m_yScrollPixelsPerLine;
1008 szy /= m_yScrollPixelsPerLine;
1009 }
1010 else
1011 {
1012 cliy = 0;
1013 szy = -1;
1014 }
1015
1016 int xScrollOld = m_xScrollPosition,
1017 yScrollOld = m_yScrollPosition;
1018
1019 int dsty;
1020 switch ( event.GetKeyCode() )
1021 {
1022 case WXK_PAGEUP:
1023 case WXK_PRIOR:
1024 dsty = sty - (5 * cliy / 6);
1025 Scroll(-1, (dsty == -1) ? 0 : dsty);
1026 break;
1027
1028 case WXK_PAGEDOWN:
1029 case WXK_NEXT:
1030 Scroll(-1, sty + (5 * cliy / 6));
1031 break;
1032
1033 case WXK_HOME:
1034 Scroll(0, event.ControlDown() ? 0 : -1);
1035 break;
1036
1037 case WXK_END:
1038 Scroll(szx - clix, event.ControlDown() ? szy - cliy : -1);
1039 break;
1040
1041 case WXK_UP:
1042 Scroll(-1, sty - 1);
1043 break;
1044
1045 case WXK_DOWN:
1046 Scroll(-1, sty + 1);
1047 break;
1048
1049 case WXK_LEFT:
1050 Scroll(stx - 1, -1);
1051 break;
1052
1053 case WXK_RIGHT:
1054 Scroll(stx + 1, -1);
1055 break;
1056
1057 default:
1058 // not for us
1059 event.Skip();
1060 }
1061
1062 if ( m_xScrollPosition != xScrollOld )
1063 {
1064 wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_xScrollPosition,
1065 wxHORIZONTAL);
1066 event.SetEventObject(m_win);
1067 m_win->GetEventHandler()->ProcessEvent(event);
1068 }
1069
1070 if ( m_yScrollPosition != yScrollOld )
1071 {
1072 wxScrollWinEvent event(wxEVT_SCROLLWIN_THUMBTRACK, m_yScrollPosition,
1073 wxVERTICAL);
1074 event.SetEventObject(m_win);
1075 m_win->GetEventHandler()->ProcessEvent(event);
1076 }
1077 }
1078
1079 // ----------------------------------------------------------------------------
1080 // autoscroll stuff: these functions deal with sending fake scroll events when
1081 // a captured mouse is being held outside the window
1082 // ----------------------------------------------------------------------------
1083
1084 bool wxScrollHelper::SendAutoScrollEvents(wxScrollWinEvent& event) const
1085 {
1086 // only send the event if the window is scrollable in this direction
1087 wxWindow *win = (wxWindow *)event.GetEventObject();
1088 return win->HasScrollbar(event.GetOrientation());
1089 }
1090
1091 void wxScrollHelper::StopAutoScrolling()
1092 {
1093 #if wxUSE_TIMER
1094 if ( m_timerAutoScroll )
1095 {
1096 delete m_timerAutoScroll;
1097 m_timerAutoScroll = (wxTimer *)NULL;
1098 }
1099 #endif
1100 }
1101
1102 void wxScrollHelper::HandleOnMouseEnter(wxMouseEvent& event)
1103 {
1104 StopAutoScrolling();
1105
1106 event.Skip();
1107 }
1108
1109 void wxScrollHelper::HandleOnMouseLeave(wxMouseEvent& event)
1110 {
1111 // don't prevent the usual processing of the event from taking place
1112 event.Skip();
1113
1114 // when a captured mouse leave a scrolled window we start generate
1115 // scrolling events to allow, for example, extending selection beyond the
1116 // visible area in some controls
1117 if ( wxWindow::GetCapture() == m_targetWindow )
1118 {
1119 // where is the mouse leaving?
1120 int pos, orient;
1121 wxPoint pt = event.GetPosition();
1122 if ( pt.x < 0 )
1123 {
1124 orient = wxHORIZONTAL;
1125 pos = 0;
1126 }
1127 else if ( pt.y < 0 )
1128 {
1129 orient = wxVERTICAL;
1130 pos = 0;
1131 }
1132 else // we're lower or to the right of the window
1133 {
1134 wxSize size = m_targetWindow->GetClientSize();
1135 if ( pt.x > size.x )
1136 {
1137 orient = wxHORIZONTAL;
1138 pos = m_xScrollLines;
1139 }
1140 else if ( pt.y > size.y )
1141 {
1142 orient = wxVERTICAL;
1143 pos = m_yScrollLines;
1144 }
1145 else // this should be impossible
1146 {
1147 // but seems to happen sometimes under wxMSW - maybe it's a bug
1148 // there but for now just ignore it
1149
1150 //wxFAIL_MSG( _T("can't understand where has mouse gone") );
1151
1152 return;
1153 }
1154 }
1155
1156 // only start the auto scroll timer if the window can be scrolled in
1157 // this direction
1158 if ( !m_targetWindow->HasScrollbar(orient) )
1159 return;
1160
1161 #if wxUSE_TIMER
1162 delete m_timerAutoScroll;
1163 m_timerAutoScroll = new wxAutoScrollTimer
1164 (
1165 m_targetWindow, this,
1166 pos == 0 ? wxEVT_SCROLLWIN_LINEUP
1167 : wxEVT_SCROLLWIN_LINEDOWN,
1168 pos,
1169 orient
1170 );
1171 m_timerAutoScroll->Start(50); // FIXME: make configurable
1172 #endif
1173 }
1174 }
1175
1176 #if wxUSE_MOUSEWHEEL
1177
1178 void wxScrollHelper::HandleOnMouseWheel(wxMouseEvent& event)
1179 {
1180 m_wheelRotation += event.GetWheelRotation();
1181 int lines = m_wheelRotation / event.GetWheelDelta();
1182 m_wheelRotation -= lines * event.GetWheelDelta();
1183
1184 if (lines != 0)
1185 {
1186
1187 wxScrollWinEvent newEvent;
1188
1189 newEvent.SetPosition(0);
1190 newEvent.SetOrientation(wxVERTICAL);
1191 newEvent.m_eventObject = m_win;
1192
1193 if (event.IsPageScroll())
1194 {
1195 if (lines > 0)
1196 newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEUP;
1197 else
1198 newEvent.m_eventType = wxEVT_SCROLLWIN_PAGEDOWN;
1199
1200 m_win->GetEventHandler()->ProcessEvent(newEvent);
1201 }
1202 else
1203 {
1204 lines *= event.GetLinesPerAction();
1205 if (lines > 0)
1206 newEvent.m_eventType = wxEVT_SCROLLWIN_LINEUP;
1207 else
1208 newEvent.m_eventType = wxEVT_SCROLLWIN_LINEDOWN;
1209
1210 int times = abs(lines);
1211 for (; times > 0; times--)
1212 m_win->GetEventHandler()->ProcessEvent(newEvent);
1213 }
1214 }
1215 }
1216
1217 #endif // wxUSE_MOUSEWHEEL
1218
1219 // ----------------------------------------------------------------------------
1220 // wxGenericScrolledWindow implementation
1221 // ----------------------------------------------------------------------------
1222
1223 IMPLEMENT_DYNAMIC_CLASS(wxGenericScrolledWindow, wxPanel)
1224
1225 BEGIN_EVENT_TABLE(wxGenericScrolledWindow, wxPanel)
1226 EVT_PAINT(wxGenericScrolledWindow::OnPaint)
1227 END_EVENT_TABLE()
1228
1229 bool wxGenericScrolledWindow::Create(wxWindow *parent,
1230 wxWindowID id,
1231 const wxPoint& pos,
1232 const wxSize& size,
1233 long style,
1234 const wxString& name)
1235 {
1236 m_targetWindow = this;
1237
1238 bool ok = wxPanel::Create(parent, id, pos, size, style, name);
1239
1240 return ok;
1241 }
1242
1243 wxGenericScrolledWindow::~wxGenericScrolledWindow()
1244 {
1245 }
1246
1247 bool wxGenericScrolledWindow::Layout()
1248 {
1249 if (GetSizer() && m_targetWindow == this)
1250 {
1251 // If we're the scroll target, take into account the
1252 // virtual size and scrolled position of the window.
1253
1254 int x, y, w, h;
1255 CalcScrolledPosition(0,0, &x,&y);
1256 GetVirtualSize(&w, &h);
1257 GetSizer()->SetDimension(x, y, w, h);
1258 return TRUE;
1259 }
1260
1261 // fall back to default for LayoutConstraints
1262 return wxPanel::Layout();
1263 }
1264
1265 void wxGenericScrolledWindow::DoSetVirtualSize(int x, int y)
1266 {
1267 wxPanel::DoSetVirtualSize( x, y );
1268 AdjustScrollbars();
1269
1270 #if wxUSE_CONSTRAINTS
1271 if (GetAutoLayout())
1272 Layout();
1273 #endif
1274 }
1275
1276 void wxGenericScrolledWindow::OnPaint(wxPaintEvent& event)
1277 {
1278 // the user code didn't really draw the window if we got here, so set this
1279 // flag to try to call OnDraw() later
1280 m_handler->ResetDrawnFlag();
1281
1282 event.Skip();
1283 }
1284
1285 #ifdef __WXMSW__
1286 long
1287 wxGenericScrolledWindow::MSWWindowProc(WXUINT nMsg,
1288 WXWPARAM wParam,
1289 WXLPARAM lParam)
1290 {
1291 long rc = wxPanel::MSWWindowProc(nMsg, wParam, lParam);
1292
1293 #ifndef __WXWINCE__
1294 // we need to process arrows ourselves for scrolling
1295 if ( nMsg == WM_GETDLGCODE )
1296 {
1297 rc |= DLGC_WANTARROWS;
1298 }
1299 #endif
1300
1301 return rc;
1302 }
1303
1304 #endif // __WXMSW__
1305
1306 #endif // !wxGTK
1307
1308 // vi:sts=4:sw=4:et
wxWidgets (Impactor)