1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/scrlwing.cpp
3 // Purpose: wxScrolledWindow 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.
9 // Copyright: (c) wxWidgets team
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
13 // ============================================================================
15 // ============================================================================
17 // ----------------------------------------------------------------------------
19 // ----------------------------------------------------------------------------
21 // For compilers that support precompilation, includes "wx.h".
22 #include "wx/wxprec.h"
28 #include "wx/scrolwin.h"
33 #include "wx/dcclient.h"
36 #include "wx/settings.h"
40 #include "wx/scrolbar.h"
43 #include "wx/recguard.h"
46 #include <windows.h> // for DLGC_WANTARROWS
47 #include "wx/msw/winundef.h"
51 // For wxRETAINED implementation
52 #ifdef __VMS__ //VMS's Xm.h is not (yet) compatible with C++
53 //This code switches off the compiler warnings
54 # pragma message disable nosimpint
58 # pragma message enable nosimpint
64 style wxHSCROLL | wxVSCROLL
67 // ----------------------------------------------------------------------------
68 // wxScrollHelperEvtHandler: intercept the events from the window and forward
69 // them to wxScrollHelper
70 // ----------------------------------------------------------------------------
72 class WXDLLEXPORT wxScrollHelperEvtHandler
: public wxEvtHandler
75 wxScrollHelperEvtHandler(wxScrollHelperBase
*scrollHelper
)
77 m_scrollHelper
= scrollHelper
;
80 virtual bool ProcessEvent(wxEvent
& event
);
82 void ResetDrawnFlag() { m_hasDrawnWindow
= false; }
85 wxScrollHelperBase
*m_scrollHelper
;
87 bool m_hasDrawnWindow
;
89 wxDECLARE_NO_COPY_CLASS(wxScrollHelperEvtHandler
);
93 // ----------------------------------------------------------------------------
94 // wxAutoScrollTimer: the timer used to generate a stream of scroll events when
95 // a captured mouse is held outside the window
96 // ----------------------------------------------------------------------------
98 class wxAutoScrollTimer
: public wxTimer
101 wxAutoScrollTimer(wxWindow
*winToScroll
,
102 wxScrollHelperBase
*scroll
,
103 wxEventType eventTypeToSend
,
104 int pos
, int orient
);
106 virtual void Notify();
110 wxScrollHelperBase
*m_scrollHelper
;
111 wxEventType m_eventType
;
115 wxDECLARE_NO_COPY_CLASS(wxAutoScrollTimer
);
118 // ============================================================================
120 // ============================================================================
122 // ----------------------------------------------------------------------------
124 // ----------------------------------------------------------------------------
126 wxAutoScrollTimer::wxAutoScrollTimer(wxWindow
*winToScroll
,
127 wxScrollHelperBase
*scroll
,
128 wxEventType eventTypeToSend
,
132 m_scrollHelper
= scroll
;
133 m_eventType
= eventTypeToSend
;
138 void wxAutoScrollTimer::Notify()
140 // only do all this as long as the window is capturing the mouse
141 if ( wxWindow::GetCapture() != m_win
)
145 else // we still capture the mouse, continue generating events
147 // first scroll the window if we are allowed to do it
148 wxScrollWinEvent
event1(m_eventType
, m_pos
, m_orient
);
149 event1
.SetEventObject(m_win
);
150 if ( m_scrollHelper
->SendAutoScrollEvents(event1
) &&
151 m_win
->GetEventHandler()->ProcessEvent(event1
) )
153 // and then send a pseudo mouse-move event to refresh the selection
154 wxMouseEvent
event2(wxEVT_MOTION
);
155 event2
.SetPosition(wxGetMousePosition());
157 // the mouse event coordinates should be client, not screen as
158 // returned by wxGetMousePosition
159 wxWindow
*parentTop
= m_win
;
160 while ( parentTop
->GetParent() )
161 parentTop
= parentTop
->GetParent();
162 wxPoint ptOrig
= parentTop
->GetPosition();
163 event2
.m_x
-= ptOrig
.x
;
164 event2
.m_y
-= ptOrig
.y
;
166 event2
.SetEventObject(m_win
);
168 // FIXME: we don't fill in the other members - ok?
170 m_win
->GetEventHandler()->ProcessEvent(event2
);
172 else // can't scroll further, stop
180 // ----------------------------------------------------------------------------
181 // wxScrollHelperEvtHandler
182 // ----------------------------------------------------------------------------
184 bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent
& event
)
186 wxEventType evType
= event
.GetEventType();
188 // the explanation of wxEVT_PAINT processing hack: for historic reasons
189 // there are 2 ways to process this event in classes deriving from
190 // wxScrolledWindow. The user code may
192 // 1. override wxScrolledWindow::OnDraw(dc)
193 // 2. define its own OnPaint() handler
195 // In addition, in wxUniversal wxWindow defines OnPaint() itself and
196 // always processes the draw event, so we can't just try the window
197 // OnPaint() first and call our HandleOnPaint() if it doesn't process it
198 // (the latter would never be called in wxUniversal).
200 // So the solution is to have a flag telling us whether the user code drew
201 // anything in the window. We set it to true here but reset it to false in
202 // wxScrolledWindow::OnPaint() handler (which wouldn't be called if the
203 // user code defined OnPaint() in the derived class)
204 m_hasDrawnWindow
= true;
206 // Pass it on to the real handler: notice that we must not call
207 // ProcessEvent() on this object itself as it wouldn't pass it to the next
208 // handler (i.e. the real window) if we're called from a previous handler
209 // (as indicated by "process here only" flag being set) and we do want to
210 // execute the handler defined in the window we're associated with right
211 // now, without waiting until TryAfter() is called from wxEvtHandler.
212 bool processed
= m_nextHandler
->ProcessEvent(event
);
214 // always process the size events ourselves, even if the user code handles
215 // them as well, as we need to AdjustScrollbars()
217 // NB: it is important to do it after processing the event in the normal
218 // way as HandleOnSize() may generate a wxEVT_SIZE itself if the
219 // scrollbar[s] (dis)appear and it should be seen by the user code
221 if ( evType
== wxEVT_SIZE
)
223 m_scrollHelper
->HandleOnSize((wxSizeEvent
&)event
);
230 // normally, nothing more to do here - except if it was a paint event
231 // which wasn't really processed, then we'll try to call our
232 // OnDraw() below (from HandleOnPaint)
233 if ( m_hasDrawnWindow
|| event
.IsCommandEvent() )
239 if ( evType
== wxEVT_PAINT
)
241 m_scrollHelper
->HandleOnPaint((wxPaintEvent
&)event
);
245 if ( evType
== wxEVT_CHILD_FOCUS
)
247 m_scrollHelper
->HandleOnChildFocus((wxChildFocusEvent
&)event
);
251 // reset the skipped flag (which might have been set to true in
252 // ProcessEvent() above) to be able to test it below
253 bool wasSkipped
= event
.GetSkipped();
257 if ( evType
== wxEVT_SCROLLWIN_TOP
||
258 evType
== wxEVT_SCROLLWIN_BOTTOM
||
259 evType
== wxEVT_SCROLLWIN_LINEUP
||
260 evType
== wxEVT_SCROLLWIN_LINEDOWN
||
261 evType
== wxEVT_SCROLLWIN_PAGEUP
||
262 evType
== wxEVT_SCROLLWIN_PAGEDOWN
||
263 evType
== wxEVT_SCROLLWIN_THUMBTRACK
||
264 evType
== wxEVT_SCROLLWIN_THUMBRELEASE
)
266 m_scrollHelper
->HandleOnScroll((wxScrollWinEvent
&)event
);
267 if ( !event
.GetSkipped() )
269 // it makes sense to indicate that we processed the message as we
270 // did scroll the window (and also notice that wxAutoScrollTimer
271 // relies on our return value to stop scrolling when we are at top
272 // or bottom already)
278 if ( evType
== wxEVT_ENTER_WINDOW
)
280 m_scrollHelper
->HandleOnMouseEnter((wxMouseEvent
&)event
);
282 else if ( evType
== wxEVT_LEAVE_WINDOW
)
284 m_scrollHelper
->HandleOnMouseLeave((wxMouseEvent
&)event
);
287 // Use GTK's own scroll wheel handling in GtkScrolledWindow
289 else if ( evType
== wxEVT_MOUSEWHEEL
)
291 m_scrollHelper
->HandleOnMouseWheel((wxMouseEvent
&)event
);
295 #endif // wxUSE_MOUSEWHEEL
296 else if ( evType
== wxEVT_CHAR
)
298 m_scrollHelper
->HandleOnChar((wxKeyEvent
&)event
);
299 if ( !event
.GetSkipped() )
306 event
.Skip(wasSkipped
);
308 // We called ProcessEvent() on the next handler, meaning that we explicitly
309 // worked around the request to process the event in this handler only. As
310 // explained above, this is unfortunately really necessary but the trouble
311 // is that the event will continue to be post-processed by the previous
312 // handler resulting in duplicate calls to event handlers. Call the special
313 // function below to prevent this from happening, base class DoTryChain()
314 // will check for it and behave accordingly.
316 // And if we're not called from DoTryChain(), this won't do anything anyhow.
317 event
.DidntHonourProcessOnlyIn();
322 // ============================================================================
323 // wxScrollHelperBase implementation
324 // ============================================================================
326 // ----------------------------------------------------------------------------
327 // wxScrollHelperBase construction
328 // ----------------------------------------------------------------------------
330 wxScrollHelperBase::wxScrollHelperBase(wxWindow
*win
)
332 wxASSERT_MSG( win
, wxT("associated window can't be NULL in wxScrollHelper") );
334 m_xScrollPixelsPerLine
=
335 m_yScrollPixelsPerLine
=
340 m_xScrollLinesPerPage
=
341 m_yScrollLinesPerPage
= 0;
343 m_xScrollingEnabled
=
344 m_yScrollingEnabled
= true;
346 m_kbdScrollingEnabled
= true;
355 m_targetWindow
= NULL
;
357 m_timerAutoScroll
= NULL
;
363 m_win
->SetScrollHelper(static_cast<wxScrollHelper
*>(this));
365 // by default, the associated window is also the target window
366 DoSetTargetWindow(win
);
369 wxScrollHelperBase::~wxScrollHelperBase()
376 // ----------------------------------------------------------------------------
377 // setting scrolling parameters
378 // ----------------------------------------------------------------------------
380 void wxScrollHelperBase::SetScrollbars(int pixelsPerUnitX
,
390 CalcUnscrolledPosition(xPos
, yPos
, &xpos
, &ypos
);
393 (noUnitsX
!= 0 && m_xScrollLines
== 0) ||
394 (noUnitsX
< m_xScrollLines
&& xpos
> pixelsPerUnitX
* noUnitsX
) ||
396 (noUnitsY
!= 0 && m_yScrollLines
== 0) ||
397 (noUnitsY
< m_yScrollLines
&& ypos
> pixelsPerUnitY
* noUnitsY
) ||
398 (xPos
!= m_xScrollPosition
) ||
399 (yPos
!= m_yScrollPosition
)
402 m_xScrollPixelsPerLine
= pixelsPerUnitX
;
403 m_yScrollPixelsPerLine
= pixelsPerUnitY
;
404 m_xScrollPosition
= xPos
;
405 m_yScrollPosition
= yPos
;
407 int w
= noUnitsX
* pixelsPerUnitX
;
408 int h
= noUnitsY
* pixelsPerUnitY
;
410 // For better backward compatibility we set persisting limits
411 // here not just the size. It makes SetScrollbars 'sticky'
412 // emulating the old non-autoscroll behaviour.
413 // m_targetWindow->SetVirtualSizeHints( w, h );
415 // The above should arguably be deprecated, this however we still need.
417 // take care not to set 0 virtual size, 0 means that we don't have any
418 // scrollbars and hence we should use the real size instead of the virtual
419 // one which is indicated by using wxDefaultCoord
420 m_targetWindow
->SetVirtualSize( w
? w
: wxDefaultCoord
,
421 h
? h
: wxDefaultCoord
);
423 if (do_refresh
&& !noRefresh
)
424 m_targetWindow
->Refresh(true, GetScrollRect());
426 #ifndef __WXUNIVERSAL__
427 // If the target is not the same as the window with the scrollbars,
428 // then we need to update the scrollbars here, since they won't have
429 // been updated by SetVirtualSize().
430 if ( m_targetWindow
!= m_win
)
431 #endif // !__WXUNIVERSAL__
435 #ifndef __WXUNIVERSAL__
438 // otherwise this has been done by AdjustScrollbars, above
440 #endif // !__WXUNIVERSAL__
443 // ----------------------------------------------------------------------------
444 // [target] window handling
445 // ----------------------------------------------------------------------------
447 void wxScrollHelperBase::DeleteEvtHandler()
449 // search for m_handler in the handler list
450 if ( m_win
&& m_handler
)
452 if ( m_win
->RemoveEventHandler(m_handler
) )
456 //else: something is very wrong, so better [maybe] leak memory than
457 // risk a crash because of double deletion
463 void wxScrollHelperBase::ResetDrawnFlag()
465 wxCHECK_RET( m_handler
, "invalid use of ResetDrawnFlag - no handler?" );
466 m_handler
->ResetDrawnFlag();
469 void wxScrollHelperBase::DoSetTargetWindow(wxWindow
*target
)
471 m_targetWindow
= target
;
473 target
->MacSetClipChildren( true ) ;
476 // install the event handler which will intercept the events we're
477 // interested in (but only do it for our real window, not the target window
478 // which we scroll - we don't need to hijack its events)
479 if ( m_targetWindow
== m_win
)
481 // if we already have a handler, delete it first
484 m_handler
= new wxScrollHelperEvtHandler(this);
485 m_targetWindow
->PushEventHandler(m_handler
);
489 void wxScrollHelperBase::SetTargetWindow(wxWindow
*target
)
491 wxCHECK_RET( target
, wxT("target window must not be NULL") );
493 if ( target
== m_targetWindow
)
496 DoSetTargetWindow(target
);
499 wxWindow
*wxScrollHelperBase::GetTargetWindow() const
501 return m_targetWindow
;
504 // ----------------------------------------------------------------------------
505 // scrolling implementation itself
506 // ----------------------------------------------------------------------------
508 void wxScrollHelperBase::HandleOnScroll(wxScrollWinEvent
& event
)
510 int nScrollInc
= CalcScrollInc(event
);
511 if ( nScrollInc
== 0 )
513 // can't scroll further
519 bool needsRefresh
= false;
522 int orient
= event
.GetOrientation();
523 if (orient
== wxHORIZONTAL
)
525 if ( m_xScrollingEnabled
)
527 dx
= -m_xScrollPixelsPerLine
* nScrollInc
;
536 if ( m_yScrollingEnabled
)
538 dy
= -m_yScrollPixelsPerLine
* nScrollInc
;
548 // flush all pending repaints before we change m_{x,y}ScrollPosition, as
549 // otherwise invalidated area could be updated incorrectly later when
550 // ScrollWindow() makes sure they're repainted before scrolling them
552 // wxWindowMac is taking care of making sure the update area is correctly
553 // set up, while not forcing an immediate redraw
555 m_targetWindow
->Update();
559 if (orient
== wxHORIZONTAL
)
561 m_xScrollPosition
+= nScrollInc
;
562 m_win
->SetScrollPos(wxHORIZONTAL
, m_xScrollPosition
);
566 m_yScrollPosition
+= nScrollInc
;
567 m_win
->SetScrollPos(wxVERTICAL
, m_yScrollPosition
);
572 m_targetWindow
->Refresh(true, GetScrollRect());
576 m_targetWindow
->ScrollWindow(dx
, dy
, GetScrollRect());
580 int wxScrollHelperBase::CalcScrollInc(wxScrollWinEvent
& event
)
582 int pos
= event
.GetPosition();
583 int orient
= event
.GetOrientation();
586 if (event
.GetEventType() == wxEVT_SCROLLWIN_TOP
)
588 if (orient
== wxHORIZONTAL
)
589 nScrollInc
= - m_xScrollPosition
;
591 nScrollInc
= - m_yScrollPosition
;
593 if (event
.GetEventType() == wxEVT_SCROLLWIN_BOTTOM
)
595 if (orient
== wxHORIZONTAL
)
596 nScrollInc
= m_xScrollLines
- m_xScrollPosition
;
598 nScrollInc
= m_yScrollLines
- m_yScrollPosition
;
600 if (event
.GetEventType() == wxEVT_SCROLLWIN_LINEUP
)
604 if (event
.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN
)
608 if (event
.GetEventType() == wxEVT_SCROLLWIN_PAGEUP
)
610 if (orient
== wxHORIZONTAL
)
611 nScrollInc
= -GetScrollPageSize(wxHORIZONTAL
);
613 nScrollInc
= -GetScrollPageSize(wxVERTICAL
);
615 if (event
.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN
)
617 if (orient
== wxHORIZONTAL
)
618 nScrollInc
= GetScrollPageSize(wxHORIZONTAL
);
620 nScrollInc
= GetScrollPageSize(wxVERTICAL
);
622 if ((event
.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK
) ||
623 (event
.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE
))
625 if (orient
== wxHORIZONTAL
)
626 nScrollInc
= pos
- m_xScrollPosition
;
628 nScrollInc
= pos
- m_yScrollPosition
;
631 if (orient
== wxHORIZONTAL
)
633 if ( m_xScrollPosition
+ nScrollInc
< 0 )
635 // As -ve as we can go
636 nScrollInc
= -m_xScrollPosition
;
638 else // check for the other bound
640 const int posMax
= m_xScrollLines
- m_xScrollLinesPerPage
;
641 if ( m_xScrollPosition
+ nScrollInc
> posMax
)
643 // As +ve as we can go
644 nScrollInc
= posMax
- m_xScrollPosition
;
650 if ( m_yScrollPosition
+ nScrollInc
< 0 )
652 // As -ve as we can go
653 nScrollInc
= -m_yScrollPosition
;
655 else // check for the other bound
657 const int posMax
= m_yScrollLines
- m_yScrollLinesPerPage
;
658 if ( m_yScrollPosition
+ nScrollInc
> posMax
)
660 // As +ve as we can go
661 nScrollInc
= posMax
- m_yScrollPosition
;
669 void wxScrollHelperBase::DoPrepareDC(wxDC
& dc
)
671 wxPoint pt
= dc
.GetDeviceOrigin();
673 // It may actually be correct to always query
674 // the m_sign from the DC here, but I leave the
675 // #ifdef GTK for now.
676 if (m_win
->GetLayoutDirection() == wxLayout_RightToLeft
)
677 dc
.SetDeviceOrigin( pt
.x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
,
678 pt
.y
- m_yScrollPosition
* m_yScrollPixelsPerLine
);
681 dc
.SetDeviceOrigin( pt
.x
- m_xScrollPosition
* m_xScrollPixelsPerLine
,
682 pt
.y
- m_yScrollPosition
* m_yScrollPixelsPerLine
);
683 dc
.SetUserScale( m_scaleX
, m_scaleY
);
686 void wxScrollHelperBase::SetScrollRate( int xstep
, int ystep
)
688 int old_x
= m_xScrollPixelsPerLine
* m_xScrollPosition
;
689 int old_y
= m_yScrollPixelsPerLine
* m_yScrollPosition
;
691 m_xScrollPixelsPerLine
= xstep
;
692 m_yScrollPixelsPerLine
= ystep
;
694 int new_x
= m_xScrollPixelsPerLine
* m_xScrollPosition
;
695 int new_y
= m_yScrollPixelsPerLine
* m_yScrollPosition
;
697 m_win
->SetScrollPos( wxHORIZONTAL
, m_xScrollPosition
);
698 m_win
->SetScrollPos( wxVERTICAL
, m_yScrollPosition
);
699 m_targetWindow
->ScrollWindow( old_x
- new_x
, old_y
- new_y
);
704 void wxScrollHelperBase::GetScrollPixelsPerUnit (int *x_unit
, int *y_unit
) const
707 *x_unit
= m_xScrollPixelsPerLine
;
709 *y_unit
= m_yScrollPixelsPerLine
;
713 int wxScrollHelperBase::GetScrollLines( int orient
) const
715 if ( orient
== wxHORIZONTAL
)
716 return m_xScrollLines
;
718 return m_yScrollLines
;
721 int wxScrollHelperBase::GetScrollPageSize(int orient
) const
723 if ( orient
== wxHORIZONTAL
)
724 return m_xScrollLinesPerPage
;
726 return m_yScrollLinesPerPage
;
729 void wxScrollHelperBase::SetScrollPageSize(int orient
, int pageSize
)
731 if ( orient
== wxHORIZONTAL
)
732 m_xScrollLinesPerPage
= pageSize
;
734 m_yScrollLinesPerPage
= pageSize
;
737 void wxScrollHelperBase::EnableScrolling (bool x_scroll
, bool y_scroll
)
739 m_xScrollingEnabled
= x_scroll
;
740 m_yScrollingEnabled
= y_scroll
;
743 // Where the current view starts from
744 void wxScrollHelperBase::DoGetViewStart (int *x
, int *y
) const
747 *x
= m_xScrollPosition
;
749 *y
= m_yScrollPosition
;
752 void wxScrollHelperBase::DoCalcScrolledPosition(int x
, int y
,
753 int *xx
, int *yy
) const
756 *xx
= x
- m_xScrollPosition
* m_xScrollPixelsPerLine
;
758 *yy
= y
- m_yScrollPosition
* m_yScrollPixelsPerLine
;
761 void wxScrollHelperBase::DoCalcUnscrolledPosition(int x
, int y
,
762 int *xx
, int *yy
) const
765 *xx
= x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
;
767 *yy
= y
+ m_yScrollPosition
* m_yScrollPixelsPerLine
;
770 // ----------------------------------------------------------------------------
772 // ----------------------------------------------------------------------------
774 bool wxScrollHelperBase::ScrollLayout()
776 if ( m_win
->GetSizer() && m_targetWindow
== m_win
)
778 // If we're the scroll target, take into account the
779 // virtual size and scrolled position of the window.
781 int x
= 0, y
= 0, w
= 0, h
= 0;
782 CalcScrolledPosition(0,0, &x
,&y
);
783 m_win
->GetVirtualSize(&w
, &h
);
784 m_win
->GetSizer()->SetDimension(x
, y
, w
, h
);
788 // fall back to default for LayoutConstraints
789 return m_win
->wxWindow::Layout();
792 void wxScrollHelperBase::ScrollDoSetVirtualSize(int x
, int y
)
794 m_win
->wxWindow::DoSetVirtualSize( x
, y
);
797 if (m_win
->GetAutoLayout())
801 // wxWindow's GetBestVirtualSize returns the actual window size,
802 // whereas we want to return the virtual size
803 wxSize
wxScrollHelperBase::ScrollGetBestVirtualSize() const
805 wxSize
clientSize(m_win
->GetClientSize());
806 if ( m_win
->GetSizer() )
807 clientSize
.IncTo(m_win
->GetSizer()->CalcMin());
812 // ----------------------------------------------------------------------------
814 // ----------------------------------------------------------------------------
816 // Default OnSize resets scrollbars, if any
817 void wxScrollHelperBase::HandleOnSize(wxSizeEvent
& WXUNUSED(event
))
819 if ( m_targetWindow
->GetAutoLayout() )
821 wxSize size
= m_targetWindow
->GetBestVirtualSize();
823 // This will call ::Layout() and ::AdjustScrollbars()
824 m_win
->SetVirtualSize( size
);
832 // This calls OnDraw, having adjusted the origin according to the current
834 void wxScrollHelperBase::HandleOnPaint(wxPaintEvent
& WXUNUSED(event
))
836 // don't use m_targetWindow here, this is always called for ourselves
843 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
844 // compatibility here - if we used OnKeyDown(), the programs which process
845 // arrows themselves in their OnChar() would never get the message and like
846 // this they always have the priority
847 void wxScrollHelperBase::HandleOnChar(wxKeyEvent
& event
)
849 if ( !m_kbdScrollingEnabled
)
855 // prepare the event this key press maps to
856 wxScrollWinEvent newEvent
;
858 newEvent
.SetPosition(0);
859 newEvent
.SetEventObject(m_win
);
861 // this is the default, it's changed to wxHORIZONTAL below if needed
862 newEvent
.SetOrientation(wxVERTICAL
);
864 // some key events result in scrolling in both horizontal and vertical
865 // direction, e.g. Ctrl-{Home,End}, if this flag is true we should generate
866 // a second event in horizontal direction in addition to the primary one
867 bool sendHorizontalToo
= false;
869 switch ( event
.GetKeyCode() )
872 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEUP
);
876 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN
);
880 newEvent
.SetEventType(wxEVT_SCROLLWIN_TOP
);
882 sendHorizontalToo
= event
.ControlDown();
886 newEvent
.SetEventType(wxEVT_SCROLLWIN_BOTTOM
);
888 sendHorizontalToo
= event
.ControlDown();
892 newEvent
.SetOrientation(wxHORIZONTAL
);
896 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEUP
);
900 newEvent
.SetOrientation(wxHORIZONTAL
);
904 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEDOWN
);
908 // not a scrolling key
913 m_win
->ProcessWindowEvent(newEvent
);
915 if ( sendHorizontalToo
)
917 newEvent
.SetOrientation(wxHORIZONTAL
);
918 m_win
->ProcessWindowEvent(newEvent
);
922 // ----------------------------------------------------------------------------
923 // autoscroll stuff: these functions deal with sending fake scroll events when
924 // a captured mouse is being held outside the window
925 // ----------------------------------------------------------------------------
927 bool wxScrollHelperBase::SendAutoScrollEvents(wxScrollWinEvent
& event
) const
929 // only send the event if the window is scrollable in this direction
930 wxWindow
*win
= (wxWindow
*)event
.GetEventObject();
931 return win
->HasScrollbar(event
.GetOrientation());
934 void wxScrollHelperBase::StopAutoScrolling()
937 wxDELETE(m_timerAutoScroll
);
941 void wxScrollHelperBase::HandleOnMouseEnter(wxMouseEvent
& event
)
948 void wxScrollHelperBase::HandleOnMouseLeave(wxMouseEvent
& event
)
950 // don't prevent the usual processing of the event from taking place
953 // when a captured mouse leave a scrolled window we start generate
954 // scrolling events to allow, for example, extending selection beyond the
955 // visible area in some controls
956 if ( wxWindow::GetCapture() == m_targetWindow
)
958 // where is the mouse leaving?
960 wxPoint pt
= event
.GetPosition();
963 orient
= wxHORIZONTAL
;
971 else // we're lower or to the right of the window
973 wxSize size
= m_targetWindow
->GetClientSize();
976 orient
= wxHORIZONTAL
;
977 pos
= m_xScrollLines
;
979 else if ( pt
.y
> size
.y
)
982 pos
= m_yScrollLines
;
984 else // this should be impossible
986 // but seems to happen sometimes under wxMSW - maybe it's a bug
987 // there but for now just ignore it
989 //wxFAIL_MSG( wxT("can't understand where has mouse gone") );
995 // only start the auto scroll timer if the window can be scrolled in
997 if ( !m_targetWindow
->HasScrollbar(orient
) )
1001 delete m_timerAutoScroll
;
1002 m_timerAutoScroll
= new wxAutoScrollTimer
1004 m_targetWindow
, this,
1005 pos
== 0 ? wxEVT_SCROLLWIN_LINEUP
1006 : wxEVT_SCROLLWIN_LINEDOWN
,
1010 m_timerAutoScroll
->Start(50); // FIXME: make configurable
1017 #if wxUSE_MOUSEWHEEL
1019 void wxScrollHelperBase::HandleOnMouseWheel(wxMouseEvent
& event
)
1021 m_wheelRotation
+= event
.GetWheelRotation();
1022 int lines
= m_wheelRotation
/ event
.GetWheelDelta();
1023 m_wheelRotation
-= lines
* event
.GetWheelDelta();
1028 wxScrollWinEvent newEvent
;
1030 newEvent
.SetPosition(0);
1031 newEvent
.SetOrientation( event
.GetWheelAxis() == 0 ? wxVERTICAL
: wxHORIZONTAL
);
1032 newEvent
.SetEventObject(m_win
);
1034 if (event
.IsPageScroll())
1037 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEUP
);
1039 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN
);
1041 m_win
->GetEventHandler()->ProcessEvent(newEvent
);
1045 lines
*= event
.GetLinesPerAction();
1047 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEUP
);
1049 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEDOWN
);
1051 int times
= abs(lines
);
1052 for (; times
> 0; times
--)
1053 m_win
->GetEventHandler()->ProcessEvent(newEvent
);
1058 #endif // wxUSE_MOUSEWHEEL
1060 void wxScrollHelperBase::HandleOnChildFocus(wxChildFocusEvent
& event
)
1062 // this event should be processed by all windows in parenthood chain,
1063 // e.g. so that nested wxScrolledWindows work correctly
1066 // find the immediate child under which the window receiving focus is:
1067 wxWindow
*win
= event
.GetWindow();
1069 if ( win
== m_targetWindow
)
1070 return; // nothing to do
1072 #if defined( __WXOSX__ ) && wxUSE_SCROLLBAR
1073 if (wxDynamicCast(win
, wxScrollBar
))
1077 // Fixing ticket: http://trac.wxwidgets.org/ticket/9563
1078 // When a child inside a wxControlContainer receives a focus, the
1079 // wxControlContainer generates an artificial wxChildFocusEvent for
1080 // itself, telling its parent that 'it' received the focus. The effect is
1081 // that this->HandleOnChildFocus is called twice, first with the
1082 // artificial wxChildFocusEvent and then with the original event. We need
1083 // to ignore the artificial event here or otherwise HandleOnChildFocus
1084 // would first scroll the target window to make the entire
1085 // wxControlContainer visible and immediately afterwards scroll the target
1086 // window again to make the child widget visible. This leads to ugly
1087 // flickering when using nested wxPanels/wxScrolledWindows.
1089 // Ignore this event if 'win' is derived from wxControlContainer AND its
1090 // parent is the m_targetWindow AND 'win' is not actually reciving the
1091 // focus (win != FindFocus). TODO: This affects all wxControlContainer
1092 // objects, but wxControlContainer is not part of the wxWidgets RTTI and
1093 // so wxDynamicCast(win, wxControlContainer) does not compile. Find a way
1094 // to determine if 'win' derives from wxControlContainer. Until then,
1095 // testing if 'win' derives from wxPanel will probably get >90% of all
1098 wxWindow
*actual_focus
=wxWindow::FindFocus();
1099 if (win
!= actual_focus
&&
1100 wxDynamicCast(win
, wxPanel
) != 0 &&
1101 win
->GetParent() == m_targetWindow
)
1102 // if win is a wxPanel and receives the focus, it should not be
1103 // scrolled into view
1106 const wxRect
viewRect(m_targetWindow
->GetClientRect());
1108 // For composite controls such as wxComboCtrl we should try to fit the
1109 // entire control inside the visible area of the target window, not just
1110 // the focused child of the control. Otherwise we'd make only the textctrl
1111 // part of a wxComboCtrl visible and the button would still be outside the
1112 // scrolled area. But do so only if the parent fits *entirely* inside the
1113 // scrolled window. In other situations, such as nested wxPanel or
1114 // wxScrolledWindows, the parent might be way to big to fit inside the
1115 // scrolled window. If that is the case, then make only the focused window
1117 if ( win
->GetParent() != m_targetWindow
)
1119 wxWindow
*parent
=win
->GetParent();
1120 wxSize parent_size
=parent
->GetSize();
1121 if (parent_size
.GetWidth() <= viewRect
.GetWidth() &&
1122 parent_size
.GetHeight() <= viewRect
.GetHeight())
1123 // make the immediate parent visible instead of the focused control
1127 // make win position relative to the m_targetWindow viewing area instead of
1130 winRect(m_targetWindow
->ScreenToClient(win
->GetScreenPosition()),
1133 // check if it's fully visible
1134 if ( viewRect
.Contains(winRect
) )
1136 // it is, nothing to do
1140 // check if we can make it fully visible: this is only possible if it's not
1141 // larger than our view area
1142 if ( winRect
.GetWidth() > viewRect
.GetWidth() ||
1143 winRect
.GetHeight() > viewRect
.GetHeight() )
1145 // we can't make it fit so avoid scrolling it at all, this is only
1146 // going to be confusing and not helpful
1151 // do make the window fit inside the view area by scrolling to it
1153 GetScrollPixelsPerUnit(&stepx
, &stepy
);
1156 GetViewStart(&startx
, &starty
);
1158 // first in vertical direction:
1163 if ( winRect
.GetTop() < 0 )
1165 diff
= winRect
.GetTop();
1167 else if ( winRect
.GetBottom() > viewRect
.GetHeight() )
1169 diff
= winRect
.GetBottom() - viewRect
.GetHeight() + 1;
1170 // round up to next scroll step if we can't get exact position,
1171 // so that the window is fully visible:
1175 starty
= (starty
* stepy
+ diff
) / stepy
;
1183 if ( winRect
.GetLeft() < 0 )
1185 diff
= winRect
.GetLeft();
1187 else if ( winRect
.GetRight() > viewRect
.GetWidth() )
1189 diff
= winRect
.GetRight() - viewRect
.GetWidth() + 1;
1190 // round up to next scroll step if we can't get exact position,
1191 // so that the window is fully visible:
1195 startx
= (startx
* stepx
+ diff
) / stepx
;
1198 Scroll(startx
, starty
);
1202 #ifdef wxHAS_GENERIC_SCROLLWIN
1204 // ----------------------------------------------------------------------------
1205 // wxScrollHelper implementation
1206 // ----------------------------------------------------------------------------
1208 wxScrollHelper::wxScrollHelper(wxWindow
*winToScroll
)
1209 : wxScrollHelperBase(winToScroll
)
1212 m_yVisibility
= wxSHOW_SB_DEFAULT
;
1215 void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz
,
1216 wxScrollbarVisibility vert
)
1218 if ( horz
!= m_xVisibility
|| vert
!= m_yVisibility
)
1220 m_xVisibility
= horz
;
1221 m_yVisibility
= vert
;
1228 wxScrollHelper::DoAdjustScrollbar(int orient
,
1233 int& scrollPosition
,
1234 int& scrollLinesPerPage
,
1235 wxScrollbarVisibility visibility
)
1237 // scroll lines per page: if 0, no scrolling is needed
1238 // check if we need scrollbar in this direction at all
1239 if ( pixelsPerUnit
== 0 || clientSize
>= virtSize
)
1241 // scrolling is disabled or unnecessary
1244 scrollLinesPerPage
= 0;
1246 else // might need scrolling
1248 // Round up integer division to catch any "leftover" client space.
1249 scrollUnits
= (virtSize
+ pixelsPerUnit
- 1) / pixelsPerUnit
;
1251 // Calculate the number of fully scroll units
1252 scrollLinesPerPage
= clientSize
/ pixelsPerUnit
;
1254 if ( scrollLinesPerPage
>= scrollUnits
)
1256 // we're big enough to not need scrolling
1259 scrollLinesPerPage
= 0;
1261 else // we do need a scrollbar
1263 if ( scrollLinesPerPage
< 1 )
1264 scrollLinesPerPage
= 1;
1266 // Correct position if greater than extent of canvas minus
1267 // the visible portion of it or if below zero
1268 const int posMax
= scrollUnits
- scrollLinesPerPage
;
1269 if ( scrollPosition
> posMax
)
1270 scrollPosition
= posMax
;
1271 else if ( scrollPosition
< 0 )
1276 // in wxSHOW_SB_NEVER case don't show the scrollbar even if it's needed, in
1277 // wxSHOW_SB_ALWAYS case show the scrollbar even if it's not needed by
1278 // passing a special range value to SetScrollbar()
1280 switch ( visibility
)
1282 case wxSHOW_SB_NEVER
:
1286 case wxSHOW_SB_ALWAYS
:
1287 range
= scrollUnits
? scrollUnits
: -1;
1291 wxFAIL_MSG( wxS("unknown scrollbar visibility") );
1294 case wxSHOW_SB_DEFAULT
:
1295 range
= scrollUnits
;
1300 m_win
->SetScrollbar(orient
, scrollPosition
, scrollLinesPerPage
, range
);
1303 void wxScrollHelper::AdjustScrollbars()
1305 static wxRecursionGuardFlag s_flagReentrancy
;
1306 wxRecursionGuard
guard(s_flagReentrancy
);
1307 if ( guard
.IsInside() )
1309 // don't reenter AdjustScrollbars() while another call to
1310 // AdjustScrollbars() is in progress because this may lead to calling
1311 // ScrollWindow() twice and this can really happen under MSW if
1312 // SetScrollbar() call below adds or removes the scrollbar which
1313 // changes the window size and hence results in another
1314 // AdjustScrollbars() call
1318 int oldXScroll
= m_xScrollPosition
;
1319 int oldYScroll
= m_yScrollPosition
;
1321 // we may need to readjust the scrollbars several times as enabling one of
1322 // them reduces the area available for the window contents and so can make
1323 // the other scrollbar necessary now although it wasn't necessary before
1325 // VZ: normally this loop should be over in at most 2 iterations, I don't
1326 // know why do we need 5 of them
1327 for ( int iterationCount
= 0; iterationCount
< 5; iterationCount
++ )
1329 wxSize clientSize
= GetTargetSize();
1330 const wxSize virtSize
= m_targetWindow
->GetVirtualSize();
1332 // this block of code tries to work around the following problem: the
1333 // window could have been just resized to have enough space to show its
1334 // full contents without the scrollbars, but its client size could be
1335 // not big enough because it does have the scrollbars right now and so
1336 // the scrollbars would remain even though we don't need them any more
1338 // to prevent this from happening, check if we have enough space for
1339 // everything without the scrollbars and explicitly disable them then
1340 const wxSize availSize
= GetSizeAvailableForScrollTarget(
1341 m_win
->GetSize() - m_win
->GetWindowBorderSize());
1342 if ( availSize
!= clientSize
)
1344 if ( availSize
.x
>= virtSize
.x
&& availSize
.y
>= virtSize
.y
)
1346 // this will be enough to make the scrollbars disappear below
1347 // and then the client size will indeed become equal to the
1348 // full available size
1349 clientSize
= availSize
;
1354 DoAdjustScrollbar(wxHORIZONTAL
,
1357 m_xScrollPixelsPerLine
,
1360 m_xScrollLinesPerPage
,
1363 DoAdjustScrollbar(wxVERTICAL
,
1366 m_yScrollPixelsPerLine
,
1369 m_yScrollLinesPerPage
,
1373 // If a scrollbar (dis)appeared as a result of this, we need to adjust
1374 // them again but if the client size didn't change, then we're done
1375 if ( GetTargetSize() == clientSize
)
1380 // Sorry, some Motif-specific code to implement a backing pixmap
1381 // for the wxRETAINED style. Implementing a backing store can't
1382 // be entirely generic because it relies on the wxWindowDC implementation
1383 // to duplicate X drawing calls for the backing pixmap.
1385 if ( m_targetWindow
->GetWindowStyle() & wxRETAINED
)
1387 Display
* dpy
= XtDisplay((Widget
)m_targetWindow
->GetMainWidget());
1389 int totalPixelWidth
= m_xScrollLines
* m_xScrollPixelsPerLine
;
1390 int totalPixelHeight
= m_yScrollLines
* m_yScrollPixelsPerLine
;
1391 if (m_targetWindow
->GetBackingPixmap() &&
1392 !((m_targetWindow
->GetPixmapWidth() == totalPixelWidth
) &&
1393 (m_targetWindow
->GetPixmapHeight() == totalPixelHeight
)))
1395 XFreePixmap (dpy
, (Pixmap
) m_targetWindow
->GetBackingPixmap());
1396 m_targetWindow
->SetBackingPixmap((WXPixmap
) 0);
1399 if (!m_targetWindow
->GetBackingPixmap() &&
1400 (m_xScrollLines
!= 0) && (m_yScrollLines
!= 0))
1402 int depth
= wxDisplayDepth();
1403 m_targetWindow
->SetPixmapWidth(totalPixelWidth
);
1404 m_targetWindow
->SetPixmapHeight(totalPixelHeight
);
1405 m_targetWindow
->SetBackingPixmap((WXPixmap
) XCreatePixmap (dpy
, RootWindow (dpy
, DefaultScreen (dpy
)),
1406 m_targetWindow
->GetPixmapWidth(), m_targetWindow
->GetPixmapHeight(), depth
));
1412 if (oldXScroll
!= m_xScrollPosition
)
1414 if (m_xScrollingEnabled
)
1415 m_targetWindow
->ScrollWindow( m_xScrollPixelsPerLine
* (oldXScroll
- m_xScrollPosition
), 0,
1418 m_targetWindow
->Refresh(true, GetScrollRect());
1421 if (oldYScroll
!= m_yScrollPosition
)
1423 if (m_yScrollingEnabled
)
1424 m_targetWindow
->ScrollWindow( 0, m_yScrollPixelsPerLine
* (oldYScroll
-m_yScrollPosition
),
1427 m_targetWindow
->Refresh(true, GetScrollRect());
1431 void wxScrollHelper::DoScroll( int x_pos
, int y_pos
)
1433 if (!m_targetWindow
)
1436 if (((x_pos
== -1) || (x_pos
== m_xScrollPosition
)) &&
1437 ((y_pos
== -1) || (y_pos
== m_yScrollPosition
))) return;
1440 GetTargetSize(&w
, &h
);
1442 // compute new position:
1443 int new_x
= m_xScrollPosition
;
1444 int new_y
= m_yScrollPosition
;
1446 if ((x_pos
!= -1) && (m_xScrollPixelsPerLine
))
1450 // Calculate page size i.e. number of scroll units you get on the
1451 // current client window
1452 int noPagePositions
= w
/m_xScrollPixelsPerLine
;
1453 if (noPagePositions
< 1) noPagePositions
= 1;
1455 // Correct position if greater than extent of canvas minus
1456 // the visible portion of it or if below zero
1457 new_x
= wxMin( m_xScrollLines
-noPagePositions
, new_x
);
1458 new_x
= wxMax( 0, new_x
);
1460 if ((y_pos
!= -1) && (m_yScrollPixelsPerLine
))
1464 // Calculate page size i.e. number of scroll units you get on the
1465 // current client window
1466 int noPagePositions
= h
/m_yScrollPixelsPerLine
;
1467 if (noPagePositions
< 1) noPagePositions
= 1;
1469 // Correct position if greater than extent of canvas minus
1470 // the visible portion of it or if below zero
1471 new_y
= wxMin( m_yScrollLines
-noPagePositions
, new_y
);
1472 new_y
= wxMax( 0, new_y
);
1475 if ( new_x
== m_xScrollPosition
&& new_y
== m_yScrollPosition
)
1476 return; // nothing to do, the position didn't change
1478 // flush all pending repaints before we change m_{x,y}ScrollPosition, as
1479 // otherwise invalidated area could be updated incorrectly later when
1480 // ScrollWindow() makes sure they're repainted before scrolling them
1481 m_targetWindow
->Update();
1483 // update the position and scroll the window now:
1484 if (m_xScrollPosition
!= new_x
)
1486 int old_x
= m_xScrollPosition
;
1487 m_xScrollPosition
= new_x
;
1488 m_win
->SetScrollPos( wxHORIZONTAL
, new_x
);
1489 m_targetWindow
->ScrollWindow( (old_x
-new_x
)*m_xScrollPixelsPerLine
, 0,
1493 if (m_yScrollPosition
!= new_y
)
1495 int old_y
= m_yScrollPosition
;
1496 m_yScrollPosition
= new_y
;
1497 m_win
->SetScrollPos( wxVERTICAL
, new_y
);
1498 m_targetWindow
->ScrollWindow( 0, (old_y
-new_y
)*m_yScrollPixelsPerLine
,
1503 #endif // wxHAS_GENERIC_SCROLLWIN
1505 // ----------------------------------------------------------------------------
1506 // wxScrolled<T> and wxScrolledWindow implementation
1507 // ----------------------------------------------------------------------------
1509 wxSize
wxScrolledT_Helper::FilterBestSize(const wxWindow
*win
,
1510 const wxScrollHelper
*helper
,
1511 const wxSize
& origBest
)
1513 // NB: We don't do this in WX_FORWARD_TO_SCROLL_HELPER, because not
1514 // all scrollable windows should behave like this, only those that
1515 // contain children controls within scrollable area
1516 // (i.e., wxScrolledWindow) and other some scrollable windows may
1517 // have different DoGetBestSize() implementation (e.g. wxTreeCtrl).
1519 wxSize best
= origBest
;
1521 if ( win
->GetAutoLayout() )
1523 // Only use the content to set the window size in the direction
1524 // where there's no scrolling; otherwise we're going to get a huge
1525 // window in the direction in which scrolling is enabled
1527 helper
->GetScrollPixelsPerUnit(&ppuX
, &ppuY
);
1529 // NB: This code used to use *current* size if min size wasn't
1530 // specified, presumably to get some reasonable (i.e., larger than
1531 // minimal) size. But that's a wrong thing to do in GetBestSize(),
1532 // so we use minimal size as specified. If the app needs some
1533 // minimal size for its scrolled window, it should set it and put
1534 // the window into sizer as expandable so that it can use all space
1537 // See also http://svn.wxwidgets.org/viewvc/wx?view=rev&revision=45864
1539 wxSize minSize
= win
->GetMinSize();
1542 best
.x
= minSize
.x
+ wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
1545 best
.y
= minSize
.y
+ wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
1552 WXLRESULT
wxScrolledT_Helper::FilterMSWWindowProc(WXUINT nMsg
, WXLRESULT rc
)
1555 // we need to process arrows ourselves for scrolling
1556 if ( nMsg
== WM_GETDLGCODE
)
1558 rc
|= DLGC_WANTARROWS
;
1565 // NB: skipping wxScrolled<T> in wxRTTI information because being a templte,
1566 // it doesn't and can't implement wxRTTI support
1567 IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow
, wxPanel
)