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;
353 m_targetWindow
= NULL
;
355 m_timerAutoScroll
= NULL
;
361 m_win
->SetScrollHelper(static_cast<wxScrollHelper
*>(this));
363 // by default, the associated window is also the target window
364 DoSetTargetWindow(win
);
367 wxScrollHelperBase::~wxScrollHelperBase()
374 // ----------------------------------------------------------------------------
375 // setting scrolling parameters
376 // ----------------------------------------------------------------------------
378 void wxScrollHelperBase::SetScrollbars(int pixelsPerUnitX
,
388 CalcUnscrolledPosition(xPos
, yPos
, &xpos
, &ypos
);
391 (noUnitsX
!= 0 && m_xScrollLines
== 0) ||
392 (noUnitsX
< m_xScrollLines
&& xpos
> pixelsPerUnitX
* noUnitsX
) ||
394 (noUnitsY
!= 0 && m_yScrollLines
== 0) ||
395 (noUnitsY
< m_yScrollLines
&& ypos
> pixelsPerUnitY
* noUnitsY
) ||
396 (xPos
!= m_xScrollPosition
) ||
397 (yPos
!= m_yScrollPosition
)
400 m_xScrollPixelsPerLine
= pixelsPerUnitX
;
401 m_yScrollPixelsPerLine
= pixelsPerUnitY
;
402 m_xScrollPosition
= xPos
;
403 m_yScrollPosition
= yPos
;
405 int w
= noUnitsX
* pixelsPerUnitX
;
406 int h
= noUnitsY
* pixelsPerUnitY
;
408 // For better backward compatibility we set persisting limits
409 // here not just the size. It makes SetScrollbars 'sticky'
410 // emulating the old non-autoscroll behaviour.
411 // m_targetWindow->SetVirtualSizeHints( w, h );
413 // The above should arguably be deprecated, this however we still need.
415 // take care not to set 0 virtual size, 0 means that we don't have any
416 // scrollbars and hence we should use the real size instead of the virtual
417 // one which is indicated by using wxDefaultCoord
418 m_targetWindow
->SetVirtualSize( w
? w
: wxDefaultCoord
,
419 h
? h
: wxDefaultCoord
);
421 if (do_refresh
&& !noRefresh
)
422 m_targetWindow
->Refresh(true, GetScrollRect());
424 #ifndef __WXUNIVERSAL__
425 // If the target is not the same as the window with the scrollbars,
426 // then we need to update the scrollbars here, since they won't have
427 // been updated by SetVirtualSize().
428 if ( m_targetWindow
!= m_win
)
429 #endif // !__WXUNIVERSAL__
433 #ifndef __WXUNIVERSAL__
436 // otherwise this has been done by AdjustScrollbars, above
438 #endif // !__WXUNIVERSAL__
441 // ----------------------------------------------------------------------------
442 // [target] window handling
443 // ----------------------------------------------------------------------------
445 void wxScrollHelperBase::DeleteEvtHandler()
447 // search for m_handler in the handler list
448 if ( m_win
&& m_handler
)
450 if ( m_win
->RemoveEventHandler(m_handler
) )
454 //else: something is very wrong, so better [maybe] leak memory than
455 // risk a crash because of double deletion
461 void wxScrollHelperBase::ResetDrawnFlag()
463 wxCHECK_RET( m_handler
, "invalid use of ResetDrawnFlag - no handler?" );
464 m_handler
->ResetDrawnFlag();
467 void wxScrollHelperBase::DoSetTargetWindow(wxWindow
*target
)
469 m_targetWindow
= target
;
471 target
->MacSetClipChildren( true ) ;
474 // install the event handler which will intercept the events we're
475 // interested in (but only do it for our real window, not the target window
476 // which we scroll - we don't need to hijack its events)
477 if ( m_targetWindow
== m_win
)
479 // if we already have a handler, delete it first
482 m_handler
= new wxScrollHelperEvtHandler(this);
483 m_targetWindow
->PushEventHandler(m_handler
);
487 void wxScrollHelperBase::SetTargetWindow(wxWindow
*target
)
489 wxCHECK_RET( target
, wxT("target window must not be NULL") );
491 if ( target
== m_targetWindow
)
494 DoSetTargetWindow(target
);
497 wxWindow
*wxScrollHelperBase::GetTargetWindow() const
499 return m_targetWindow
;
502 // ----------------------------------------------------------------------------
503 // scrolling implementation itself
504 // ----------------------------------------------------------------------------
506 void wxScrollHelperBase::HandleOnScroll(wxScrollWinEvent
& event
)
508 int nScrollInc
= CalcScrollInc(event
);
509 if ( nScrollInc
== 0 )
511 // can't scroll further
517 bool needsRefresh
= false;
520 int orient
= event
.GetOrientation();
521 if (orient
== wxHORIZONTAL
)
523 if ( m_xScrollingEnabled
)
525 dx
= -m_xScrollPixelsPerLine
* nScrollInc
;
534 if ( m_yScrollingEnabled
)
536 dy
= -m_yScrollPixelsPerLine
* nScrollInc
;
546 // flush all pending repaints before we change m_{x,y}ScrollPosition, as
547 // otherwise invalidated area could be updated incorrectly later when
548 // ScrollWindow() makes sure they're repainted before scrolling them
550 // wxWindowMac is taking care of making sure the update area is correctly
551 // set up, while not forcing an immediate redraw
553 m_targetWindow
->Update();
557 if (orient
== wxHORIZONTAL
)
559 m_xScrollPosition
+= nScrollInc
;
560 m_win
->SetScrollPos(wxHORIZONTAL
, m_xScrollPosition
);
564 m_yScrollPosition
+= nScrollInc
;
565 m_win
->SetScrollPos(wxVERTICAL
, m_yScrollPosition
);
570 m_targetWindow
->Refresh(true, GetScrollRect());
574 m_targetWindow
->ScrollWindow(dx
, dy
, GetScrollRect());
578 int wxScrollHelperBase::CalcScrollInc(wxScrollWinEvent
& event
)
580 int pos
= event
.GetPosition();
581 int orient
= event
.GetOrientation();
584 if (event
.GetEventType() == wxEVT_SCROLLWIN_TOP
)
586 if (orient
== wxHORIZONTAL
)
587 nScrollInc
= - m_xScrollPosition
;
589 nScrollInc
= - m_yScrollPosition
;
591 if (event
.GetEventType() == wxEVT_SCROLLWIN_BOTTOM
)
593 if (orient
== wxHORIZONTAL
)
594 nScrollInc
= m_xScrollLines
- m_xScrollPosition
;
596 nScrollInc
= m_yScrollLines
- m_yScrollPosition
;
598 if (event
.GetEventType() == wxEVT_SCROLLWIN_LINEUP
)
602 if (event
.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN
)
606 if (event
.GetEventType() == wxEVT_SCROLLWIN_PAGEUP
)
608 if (orient
== wxHORIZONTAL
)
609 nScrollInc
= -GetScrollPageSize(wxHORIZONTAL
);
611 nScrollInc
= -GetScrollPageSize(wxVERTICAL
);
613 if (event
.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN
)
615 if (orient
== wxHORIZONTAL
)
616 nScrollInc
= GetScrollPageSize(wxHORIZONTAL
);
618 nScrollInc
= GetScrollPageSize(wxVERTICAL
);
620 if ((event
.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK
) ||
621 (event
.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE
))
623 if (orient
== wxHORIZONTAL
)
624 nScrollInc
= pos
- m_xScrollPosition
;
626 nScrollInc
= pos
- m_yScrollPosition
;
629 if (orient
== wxHORIZONTAL
)
631 if ( m_xScrollPosition
+ nScrollInc
< 0 )
633 // As -ve as we can go
634 nScrollInc
= -m_xScrollPosition
;
636 else // check for the other bound
638 const int posMax
= m_xScrollLines
- m_xScrollLinesPerPage
;
639 if ( m_xScrollPosition
+ nScrollInc
> posMax
)
641 // As +ve as we can go
642 nScrollInc
= posMax
- m_xScrollPosition
;
648 if ( m_yScrollPosition
+ nScrollInc
< 0 )
650 // As -ve as we can go
651 nScrollInc
= -m_yScrollPosition
;
653 else // check for the other bound
655 const int posMax
= m_yScrollLines
- m_yScrollLinesPerPage
;
656 if ( m_yScrollPosition
+ nScrollInc
> posMax
)
658 // As +ve as we can go
659 nScrollInc
= posMax
- m_yScrollPosition
;
667 void wxScrollHelperBase::DoPrepareDC(wxDC
& dc
)
669 wxPoint pt
= dc
.GetDeviceOrigin();
671 // It may actually be correct to always query
672 // the m_sign from the DC here, but I leave the
673 // #ifdef GTK for now.
674 if (m_win
->GetLayoutDirection() == wxLayout_RightToLeft
)
675 dc
.SetDeviceOrigin( pt
.x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
,
676 pt
.y
- m_yScrollPosition
* m_yScrollPixelsPerLine
);
679 dc
.SetDeviceOrigin( pt
.x
- m_xScrollPosition
* m_xScrollPixelsPerLine
,
680 pt
.y
- m_yScrollPosition
* m_yScrollPixelsPerLine
);
681 dc
.SetUserScale( m_scaleX
, m_scaleY
);
684 void wxScrollHelperBase::SetScrollRate( int xstep
, int ystep
)
686 int old_x
= m_xScrollPixelsPerLine
* m_xScrollPosition
;
687 int old_y
= m_yScrollPixelsPerLine
* m_yScrollPosition
;
689 m_xScrollPixelsPerLine
= xstep
;
690 m_yScrollPixelsPerLine
= ystep
;
692 int new_x
= m_xScrollPixelsPerLine
* m_xScrollPosition
;
693 int new_y
= m_yScrollPixelsPerLine
* m_yScrollPosition
;
695 m_win
->SetScrollPos( wxHORIZONTAL
, m_xScrollPosition
);
696 m_win
->SetScrollPos( wxVERTICAL
, m_yScrollPosition
);
697 m_targetWindow
->ScrollWindow( old_x
- new_x
, old_y
- new_y
);
702 void wxScrollHelperBase::GetScrollPixelsPerUnit (int *x_unit
, int *y_unit
) const
705 *x_unit
= m_xScrollPixelsPerLine
;
707 *y_unit
= m_yScrollPixelsPerLine
;
711 int wxScrollHelperBase::GetScrollLines( int orient
) const
713 if ( orient
== wxHORIZONTAL
)
714 return m_xScrollLines
;
716 return m_yScrollLines
;
719 int wxScrollHelperBase::GetScrollPageSize(int orient
) const
721 if ( orient
== wxHORIZONTAL
)
722 return m_xScrollLinesPerPage
;
724 return m_yScrollLinesPerPage
;
727 void wxScrollHelperBase::SetScrollPageSize(int orient
, int pageSize
)
729 if ( orient
== wxHORIZONTAL
)
730 m_xScrollLinesPerPage
= pageSize
;
732 m_yScrollLinesPerPage
= pageSize
;
735 void wxScrollHelperBase::EnableScrolling (bool x_scroll
, bool y_scroll
)
737 m_xScrollingEnabled
= x_scroll
;
738 m_yScrollingEnabled
= y_scroll
;
741 // Where the current view starts from
742 void wxScrollHelperBase::DoGetViewStart (int *x
, int *y
) const
745 *x
= m_xScrollPosition
;
747 *y
= m_yScrollPosition
;
750 void wxScrollHelperBase::DoCalcScrolledPosition(int x
, int y
,
751 int *xx
, int *yy
) const
754 *xx
= x
- m_xScrollPosition
* m_xScrollPixelsPerLine
;
756 *yy
= y
- m_yScrollPosition
* m_yScrollPixelsPerLine
;
759 void wxScrollHelperBase::DoCalcUnscrolledPosition(int x
, int y
,
760 int *xx
, int *yy
) const
763 *xx
= x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
;
765 *yy
= y
+ m_yScrollPosition
* m_yScrollPixelsPerLine
;
768 // ----------------------------------------------------------------------------
770 // ----------------------------------------------------------------------------
772 bool wxScrollHelperBase::ScrollLayout()
774 if ( m_win
->GetSizer() && m_targetWindow
== m_win
)
776 // If we're the scroll target, take into account the
777 // virtual size and scrolled position of the window.
779 int x
= 0, y
= 0, w
= 0, h
= 0;
780 CalcScrolledPosition(0,0, &x
,&y
);
781 m_win
->GetVirtualSize(&w
, &h
);
782 m_win
->GetSizer()->SetDimension(x
, y
, w
, h
);
786 // fall back to default for LayoutConstraints
787 return m_win
->wxWindow::Layout();
790 void wxScrollHelperBase::ScrollDoSetVirtualSize(int x
, int y
)
792 m_win
->wxWindow::DoSetVirtualSize( x
, y
);
795 if (m_win
->GetAutoLayout())
799 // wxWindow's GetBestVirtualSize returns the actual window size,
800 // whereas we want to return the virtual size
801 wxSize
wxScrollHelperBase::ScrollGetBestVirtualSize() const
803 wxSize
clientSize(m_win
->GetClientSize());
804 if ( m_win
->GetSizer() )
805 clientSize
.IncTo(m_win
->GetSizer()->CalcMin());
810 // ----------------------------------------------------------------------------
812 // ----------------------------------------------------------------------------
814 // Default OnSize resets scrollbars, if any
815 void wxScrollHelperBase::HandleOnSize(wxSizeEvent
& WXUNUSED(event
))
817 if ( m_targetWindow
->GetAutoLayout() )
819 wxSize size
= m_targetWindow
->GetBestVirtualSize();
821 // This will call ::Layout() and ::AdjustScrollbars()
822 m_win
->SetVirtualSize( size
);
830 // This calls OnDraw, having adjusted the origin according to the current
832 void wxScrollHelperBase::HandleOnPaint(wxPaintEvent
& WXUNUSED(event
))
834 // don't use m_targetWindow here, this is always called for ourselves
841 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
842 // compatibility here - if we used OnKeyDown(), the programs which process
843 // arrows themselves in their OnChar() would never get the message and like
844 // this they always have the priority
845 void wxScrollHelperBase::HandleOnChar(wxKeyEvent
& event
)
847 // prepare the event this key press maps to
848 wxScrollWinEvent newEvent
;
850 newEvent
.SetPosition(0);
851 newEvent
.SetEventObject(m_win
);
853 // this is the default, it's changed to wxHORIZONTAL below if needed
854 newEvent
.SetOrientation(wxVERTICAL
);
856 // some key events result in scrolling in both horizontal and vertical
857 // direction, e.g. Ctrl-{Home,End}, if this flag is true we should generate
858 // a second event in horizontal direction in addition to the primary one
859 bool sendHorizontalToo
= false;
861 switch ( event
.GetKeyCode() )
864 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEUP
);
868 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN
);
872 newEvent
.SetEventType(wxEVT_SCROLLWIN_TOP
);
874 sendHorizontalToo
= event
.ControlDown();
878 newEvent
.SetEventType(wxEVT_SCROLLWIN_BOTTOM
);
880 sendHorizontalToo
= event
.ControlDown();
884 newEvent
.SetOrientation(wxHORIZONTAL
);
888 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEUP
);
892 newEvent
.SetOrientation(wxHORIZONTAL
);
896 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEDOWN
);
900 // not a scrolling key
905 m_win
->ProcessWindowEvent(newEvent
);
907 if ( sendHorizontalToo
)
909 newEvent
.SetOrientation(wxHORIZONTAL
);
910 m_win
->ProcessWindowEvent(newEvent
);
914 // ----------------------------------------------------------------------------
915 // autoscroll stuff: these functions deal with sending fake scroll events when
916 // a captured mouse is being held outside the window
917 // ----------------------------------------------------------------------------
919 bool wxScrollHelperBase::SendAutoScrollEvents(wxScrollWinEvent
& event
) const
921 // only send the event if the window is scrollable in this direction
922 wxWindow
*win
= (wxWindow
*)event
.GetEventObject();
923 return win
->HasScrollbar(event
.GetOrientation());
926 void wxScrollHelperBase::StopAutoScrolling()
929 wxDELETE(m_timerAutoScroll
);
933 void wxScrollHelperBase::HandleOnMouseEnter(wxMouseEvent
& event
)
940 void wxScrollHelperBase::HandleOnMouseLeave(wxMouseEvent
& event
)
942 // don't prevent the usual processing of the event from taking place
945 // when a captured mouse leave a scrolled window we start generate
946 // scrolling events to allow, for example, extending selection beyond the
947 // visible area in some controls
948 if ( wxWindow::GetCapture() == m_targetWindow
)
950 // where is the mouse leaving?
952 wxPoint pt
= event
.GetPosition();
955 orient
= wxHORIZONTAL
;
963 else // we're lower or to the right of the window
965 wxSize size
= m_targetWindow
->GetClientSize();
968 orient
= wxHORIZONTAL
;
969 pos
= m_xScrollLines
;
971 else if ( pt
.y
> size
.y
)
974 pos
= m_yScrollLines
;
976 else // this should be impossible
978 // but seems to happen sometimes under wxMSW - maybe it's a bug
979 // there but for now just ignore it
981 //wxFAIL_MSG( wxT("can't understand where has mouse gone") );
987 // only start the auto scroll timer if the window can be scrolled in
989 if ( !m_targetWindow
->HasScrollbar(orient
) )
993 delete m_timerAutoScroll
;
994 m_timerAutoScroll
= new wxAutoScrollTimer
996 m_targetWindow
, this,
997 pos
== 0 ? wxEVT_SCROLLWIN_LINEUP
998 : wxEVT_SCROLLWIN_LINEDOWN
,
1002 m_timerAutoScroll
->Start(50); // FIXME: make configurable
1009 #if wxUSE_MOUSEWHEEL
1011 void wxScrollHelperBase::HandleOnMouseWheel(wxMouseEvent
& event
)
1013 m_wheelRotation
+= event
.GetWheelRotation();
1014 int lines
= m_wheelRotation
/ event
.GetWheelDelta();
1015 m_wheelRotation
-= lines
* event
.GetWheelDelta();
1020 wxScrollWinEvent newEvent
;
1022 newEvent
.SetPosition(0);
1023 newEvent
.SetOrientation( event
.GetWheelAxis() == 0 ? wxVERTICAL
: wxHORIZONTAL
);
1024 newEvent
.SetEventObject(m_win
);
1026 if (event
.IsPageScroll())
1029 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEUP
);
1031 newEvent
.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN
);
1033 m_win
->GetEventHandler()->ProcessEvent(newEvent
);
1037 lines
*= event
.GetLinesPerAction();
1039 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEUP
);
1041 newEvent
.SetEventType(wxEVT_SCROLLWIN_LINEDOWN
);
1043 int times
= abs(lines
);
1044 for (; times
> 0; times
--)
1045 m_win
->GetEventHandler()->ProcessEvent(newEvent
);
1050 #endif // wxUSE_MOUSEWHEEL
1052 void wxScrollHelperBase::HandleOnChildFocus(wxChildFocusEvent
& event
)
1054 // this event should be processed by all windows in parenthood chain,
1055 // e.g. so that nested wxScrolledWindows work correctly
1058 // find the immediate child under which the window receiving focus is:
1059 wxWindow
*win
= event
.GetWindow();
1061 if ( win
== m_targetWindow
)
1062 return; // nothing to do
1064 #if defined( __WXOSX__ ) && wxUSE_SCROLLBAR
1065 if (wxDynamicCast(win
, wxScrollBar
))
1069 // Fixing ticket: http://trac.wxwidgets.org/ticket/9563
1070 // When a child inside a wxControlContainer receives a focus, the
1071 // wxControlContainer generates an artificial wxChildFocusEvent for
1072 // itself, telling its parent that 'it' received the focus. The effect is
1073 // that this->HandleOnChildFocus is called twice, first with the
1074 // artificial wxChildFocusEvent and then with the original event. We need
1075 // to ignore the artificial event here or otherwise HandleOnChildFocus
1076 // would first scroll the target window to make the entire
1077 // wxControlContainer visible and immediately afterwards scroll the target
1078 // window again to make the child widget visible. This leads to ugly
1079 // flickering when using nested wxPanels/wxScrolledWindows.
1081 // Ignore this event if 'win' is derived from wxControlContainer AND its
1082 // parent is the m_targetWindow AND 'win' is not actually reciving the
1083 // focus (win != FindFocus). TODO: This affects all wxControlContainer
1084 // objects, but wxControlContainer is not part of the wxWidgets RTTI and
1085 // so wxDynamicCast(win, wxControlContainer) does not compile. Find a way
1086 // to determine if 'win' derives from wxControlContainer. Until then,
1087 // testing if 'win' derives from wxPanel will probably get >90% of all
1090 wxWindow
*actual_focus
=wxWindow::FindFocus();
1091 if (win
!= actual_focus
&&
1092 wxDynamicCast(win
, wxPanel
) != 0 &&
1093 win
->GetParent() == m_targetWindow
)
1094 // if win is a wxPanel and receives the focus, it should not be
1095 // scrolled into view
1098 const wxRect
viewRect(m_targetWindow
->GetClientRect());
1100 // For composite controls such as wxComboCtrl we should try to fit the
1101 // entire control inside the visible area of the target window, not just
1102 // the focused child of the control. Otherwise we'd make only the textctrl
1103 // part of a wxComboCtrl visible and the button would still be outside the
1104 // scrolled area. But do so only if the parent fits *entirely* inside the
1105 // scrolled window. In other situations, such as nested wxPanel or
1106 // wxScrolledWindows, the parent might be way to big to fit inside the
1107 // scrolled window. If that is the case, then make only the focused window
1109 if ( win
->GetParent() != m_targetWindow
)
1111 wxWindow
*parent
=win
->GetParent();
1112 wxSize parent_size
=parent
->GetSize();
1113 if (parent_size
.GetWidth() <= viewRect
.GetWidth() &&
1114 parent_size
.GetHeight() <= viewRect
.GetHeight())
1115 // make the immediate parent visible instead of the focused control
1119 // make win position relative to the m_targetWindow viewing area instead of
1122 winRect(m_targetWindow
->ScreenToClient(win
->GetScreenPosition()),
1125 // check if it's fully visible
1126 if ( viewRect
.Contains(winRect
) )
1128 // it is, nothing to do
1132 // check if we can make it fully visible: this is only possible if it's not
1133 // larger than our view area
1134 if ( winRect
.GetWidth() > viewRect
.GetWidth() ||
1135 winRect
.GetHeight() > viewRect
.GetHeight() )
1137 // we can't make it fit so avoid scrolling it at all, this is only
1138 // going to be confusing and not helpful
1143 // do make the window fit inside the view area by scrolling to it
1145 GetScrollPixelsPerUnit(&stepx
, &stepy
);
1148 GetViewStart(&startx
, &starty
);
1150 // first in vertical direction:
1155 if ( winRect
.GetTop() < 0 )
1157 diff
= winRect
.GetTop();
1159 else if ( winRect
.GetBottom() > viewRect
.GetHeight() )
1161 diff
= winRect
.GetBottom() - viewRect
.GetHeight() + 1;
1162 // round up to next scroll step if we can't get exact position,
1163 // so that the window is fully visible:
1167 starty
= (starty
* stepy
+ diff
) / stepy
;
1175 if ( winRect
.GetLeft() < 0 )
1177 diff
= winRect
.GetLeft();
1179 else if ( winRect
.GetRight() > viewRect
.GetWidth() )
1181 diff
= winRect
.GetRight() - viewRect
.GetWidth() + 1;
1182 // round up to next scroll step if we can't get exact position,
1183 // so that the window is fully visible:
1187 startx
= (startx
* stepx
+ diff
) / stepx
;
1190 Scroll(startx
, starty
);
1194 #ifdef wxHAS_GENERIC_SCROLLWIN
1196 // ----------------------------------------------------------------------------
1197 // wxScrollHelper implementation
1198 // ----------------------------------------------------------------------------
1200 wxScrollHelper::wxScrollHelper(wxWindow
*winToScroll
)
1201 : wxScrollHelperBase(winToScroll
)
1204 m_yVisibility
= wxSHOW_SB_DEFAULT
;
1207 void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz
,
1208 wxScrollbarVisibility vert
)
1210 if ( horz
!= m_xVisibility
|| vert
!= m_yVisibility
)
1212 m_xVisibility
= horz
;
1213 m_yVisibility
= vert
;
1220 wxScrollHelper::DoAdjustScrollbar(int orient
,
1225 int& scrollPosition
,
1226 int& scrollLinesPerPage
,
1227 wxScrollbarVisibility visibility
)
1229 // scroll lines per page: if 0, no scrolling is needed
1230 // check if we need scrollbar in this direction at all
1231 if ( pixelsPerUnit
== 0 || clientSize
>= virtSize
)
1233 // scrolling is disabled or unnecessary
1236 scrollLinesPerPage
= 0;
1238 else // might need scrolling
1240 // Round up integer division to catch any "leftover" client space.
1241 scrollUnits
= (virtSize
+ pixelsPerUnit
- 1) / pixelsPerUnit
;
1243 // Calculate the number of fully scroll units
1244 scrollLinesPerPage
= clientSize
/ pixelsPerUnit
;
1246 if ( scrollLinesPerPage
>= scrollUnits
)
1248 // we're big enough to not need scrolling
1251 scrollLinesPerPage
= 0;
1253 else // we do need a scrollbar
1255 if ( scrollLinesPerPage
< 1 )
1256 scrollLinesPerPage
= 1;
1258 // Correct position if greater than extent of canvas minus
1259 // the visible portion of it or if below zero
1260 const int posMax
= scrollUnits
- scrollLinesPerPage
;
1261 if ( scrollPosition
> posMax
)
1262 scrollPosition
= posMax
;
1263 else if ( scrollPosition
< 0 )
1268 // in wxSHOW_SB_NEVER case don't show the scrollbar even if it's needed, in
1269 // wxSHOW_SB_ALWAYS case show the scrollbar even if it's not needed by
1270 // passing a special range value to SetScrollbar()
1272 switch ( visibility
)
1274 case wxSHOW_SB_NEVER
:
1278 case wxSHOW_SB_ALWAYS
:
1279 range
= scrollUnits
? scrollUnits
: -1;
1283 wxFAIL_MSG( wxS("unknown scrollbar visibility") );
1286 case wxSHOW_SB_DEFAULT
:
1287 range
= scrollUnits
;
1292 m_win
->SetScrollbar(orient
, scrollPosition
, scrollLinesPerPage
, range
);
1295 void wxScrollHelper::AdjustScrollbars()
1297 static wxRecursionGuardFlag s_flagReentrancy
;
1298 wxRecursionGuard
guard(s_flagReentrancy
);
1299 if ( guard
.IsInside() )
1301 // don't reenter AdjustScrollbars() while another call to
1302 // AdjustScrollbars() is in progress because this may lead to calling
1303 // ScrollWindow() twice and this can really happen under MSW if
1304 // SetScrollbar() call below adds or removes the scrollbar which
1305 // changes the window size and hence results in another
1306 // AdjustScrollbars() call
1310 int oldXScroll
= m_xScrollPosition
;
1311 int oldYScroll
= m_yScrollPosition
;
1313 // we may need to readjust the scrollbars several times as enabling one of
1314 // them reduces the area available for the window contents and so can make
1315 // the other scrollbar necessary now although it wasn't necessary before
1317 // VZ: normally this loop should be over in at most 2 iterations, I don't
1318 // know why do we need 5 of them
1319 for ( int iterationCount
= 0; iterationCount
< 5; iterationCount
++ )
1321 wxSize clientSize
= GetTargetSize();
1322 const wxSize virtSize
= m_targetWindow
->GetVirtualSize();
1324 // this block of code tries to work around the following problem: the
1325 // window could have been just resized to have enough space to show its
1326 // full contents without the scrollbars, but its client size could be
1327 // not big enough because it does have the scrollbars right now and so
1328 // the scrollbars would remain even though we don't need them any more
1330 // to prevent this from happening, check if we have enough space for
1331 // everything without the scrollbars and explicitly disable them then
1332 const wxSize availSize
= GetSizeAvailableForScrollTarget(
1333 m_win
->GetSize() - m_win
->GetWindowBorderSize());
1334 if ( availSize
!= clientSize
)
1336 if ( availSize
.x
>= virtSize
.x
&& availSize
.y
>= virtSize
.y
)
1338 // this will be enough to make the scrollbars disappear below
1339 // and then the client size will indeed become equal to the
1340 // full available size
1341 clientSize
= availSize
;
1346 DoAdjustScrollbar(wxHORIZONTAL
,
1349 m_xScrollPixelsPerLine
,
1352 m_xScrollLinesPerPage
,
1355 DoAdjustScrollbar(wxVERTICAL
,
1358 m_yScrollPixelsPerLine
,
1361 m_yScrollLinesPerPage
,
1365 // If a scrollbar (dis)appeared as a result of this, we need to adjust
1366 // them again but if the client size didn't change, then we're done
1367 if ( GetTargetSize() == clientSize
)
1372 // Sorry, some Motif-specific code to implement a backing pixmap
1373 // for the wxRETAINED style. Implementing a backing store can't
1374 // be entirely generic because it relies on the wxWindowDC implementation
1375 // to duplicate X drawing calls for the backing pixmap.
1377 if ( m_targetWindow
->GetWindowStyle() & wxRETAINED
)
1379 Display
* dpy
= XtDisplay((Widget
)m_targetWindow
->GetMainWidget());
1381 int totalPixelWidth
= m_xScrollLines
* m_xScrollPixelsPerLine
;
1382 int totalPixelHeight
= m_yScrollLines
* m_yScrollPixelsPerLine
;
1383 if (m_targetWindow
->GetBackingPixmap() &&
1384 !((m_targetWindow
->GetPixmapWidth() == totalPixelWidth
) &&
1385 (m_targetWindow
->GetPixmapHeight() == totalPixelHeight
)))
1387 XFreePixmap (dpy
, (Pixmap
) m_targetWindow
->GetBackingPixmap());
1388 m_targetWindow
->SetBackingPixmap((WXPixmap
) 0);
1391 if (!m_targetWindow
->GetBackingPixmap() &&
1392 (m_xScrollLines
!= 0) && (m_yScrollLines
!= 0))
1394 int depth
= wxDisplayDepth();
1395 m_targetWindow
->SetPixmapWidth(totalPixelWidth
);
1396 m_targetWindow
->SetPixmapHeight(totalPixelHeight
);
1397 m_targetWindow
->SetBackingPixmap((WXPixmap
) XCreatePixmap (dpy
, RootWindow (dpy
, DefaultScreen (dpy
)),
1398 m_targetWindow
->GetPixmapWidth(), m_targetWindow
->GetPixmapHeight(), depth
));
1404 if (oldXScroll
!= m_xScrollPosition
)
1406 if (m_xScrollingEnabled
)
1407 m_targetWindow
->ScrollWindow( m_xScrollPixelsPerLine
* (oldXScroll
- m_xScrollPosition
), 0,
1410 m_targetWindow
->Refresh(true, GetScrollRect());
1413 if (oldYScroll
!= m_yScrollPosition
)
1415 if (m_yScrollingEnabled
)
1416 m_targetWindow
->ScrollWindow( 0, m_yScrollPixelsPerLine
* (oldYScroll
-m_yScrollPosition
),
1419 m_targetWindow
->Refresh(true, GetScrollRect());
1423 void wxScrollHelper::DoScroll( int x_pos
, int y_pos
)
1425 if (!m_targetWindow
)
1428 if (((x_pos
== -1) || (x_pos
== m_xScrollPosition
)) &&
1429 ((y_pos
== -1) || (y_pos
== m_yScrollPosition
))) return;
1432 GetTargetSize(&w
, &h
);
1434 // compute new position:
1435 int new_x
= m_xScrollPosition
;
1436 int new_y
= m_yScrollPosition
;
1438 if ((x_pos
!= -1) && (m_xScrollPixelsPerLine
))
1442 // Calculate page size i.e. number of scroll units you get on the
1443 // current client window
1444 int noPagePositions
= w
/m_xScrollPixelsPerLine
;
1445 if (noPagePositions
< 1) noPagePositions
= 1;
1447 // Correct position if greater than extent of canvas minus
1448 // the visible portion of it or if below zero
1449 new_x
= wxMin( m_xScrollLines
-noPagePositions
, new_x
);
1450 new_x
= wxMax( 0, new_x
);
1452 if ((y_pos
!= -1) && (m_yScrollPixelsPerLine
))
1456 // Calculate page size i.e. number of scroll units you get on the
1457 // current client window
1458 int noPagePositions
= h
/m_yScrollPixelsPerLine
;
1459 if (noPagePositions
< 1) noPagePositions
= 1;
1461 // Correct position if greater than extent of canvas minus
1462 // the visible portion of it or if below zero
1463 new_y
= wxMin( m_yScrollLines
-noPagePositions
, new_y
);
1464 new_y
= wxMax( 0, new_y
);
1467 if ( new_x
== m_xScrollPosition
&& new_y
== m_yScrollPosition
)
1468 return; // nothing to do, the position didn't change
1470 // flush all pending repaints before we change m_{x,y}ScrollPosition, as
1471 // otherwise invalidated area could be updated incorrectly later when
1472 // ScrollWindow() makes sure they're repainted before scrolling them
1473 m_targetWindow
->Update();
1475 // update the position and scroll the window now:
1476 if (m_xScrollPosition
!= new_x
)
1478 int old_x
= m_xScrollPosition
;
1479 m_xScrollPosition
= new_x
;
1480 m_win
->SetScrollPos( wxHORIZONTAL
, new_x
);
1481 m_targetWindow
->ScrollWindow( (old_x
-new_x
)*m_xScrollPixelsPerLine
, 0,
1485 if (m_yScrollPosition
!= new_y
)
1487 int old_y
= m_yScrollPosition
;
1488 m_yScrollPosition
= new_y
;
1489 m_win
->SetScrollPos( wxVERTICAL
, new_y
);
1490 m_targetWindow
->ScrollWindow( 0, (old_y
-new_y
)*m_yScrollPixelsPerLine
,
1495 #endif // wxHAS_GENERIC_SCROLLWIN
1497 // ----------------------------------------------------------------------------
1498 // wxScrolled<T> and wxScrolledWindow implementation
1499 // ----------------------------------------------------------------------------
1501 wxSize
wxScrolledT_Helper::FilterBestSize(const wxWindow
*win
,
1502 const wxScrollHelper
*helper
,
1503 const wxSize
& origBest
)
1505 // NB: We don't do this in WX_FORWARD_TO_SCROLL_HELPER, because not
1506 // all scrollable windows should behave like this, only those that
1507 // contain children controls within scrollable area
1508 // (i.e., wxScrolledWindow) and other some scrollable windows may
1509 // have different DoGetBestSize() implementation (e.g. wxTreeCtrl).
1511 wxSize best
= origBest
;
1513 if ( win
->GetAutoLayout() )
1515 // Only use the content to set the window size in the direction
1516 // where there's no scrolling; otherwise we're going to get a huge
1517 // window in the direction in which scrolling is enabled
1519 helper
->GetScrollPixelsPerUnit(&ppuX
, &ppuY
);
1521 // NB: This code used to use *current* size if min size wasn't
1522 // specified, presumably to get some reasonable (i.e., larger than
1523 // minimal) size. But that's a wrong thing to do in GetBestSize(),
1524 // so we use minimal size as specified. If the app needs some
1525 // minimal size for its scrolled window, it should set it and put
1526 // the window into sizer as expandable so that it can use all space
1529 // See also http://svn.wxwidgets.org/viewvc/wx?view=rev&revision=45864
1531 wxSize minSize
= win
->GetMinSize();
1534 best
.x
= minSize
.x
+ wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
1537 best
.y
= minSize
.y
+ wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
1544 WXLRESULT
wxScrolledT_Helper::FilterMSWWindowProc(WXUINT nMsg
, WXLRESULT rc
)
1547 // we need to process arrows ourselves for scrolling
1548 if ( nMsg
== WM_GETDLGCODE
)
1550 rc
|= DLGC_WANTARROWS
;
1557 // NB: skipping wxScrolled<T> in wxRTTI information because being a templte,
1558 // it doesn't and can't implement wxRTTI support
1559 IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow
, wxPanel
)