]> git.saurik.com Git - wxWidgets.git/blame - src/generic/scrlwing.cpp
Remove unused ItemList type from datavgen.cpp.
[wxWidgets.git] / src / generic / scrlwing.cpp
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
ed4b0fdc 2// Name: src/generic/scrlwing.cpp
d32e78bd 3// Purpose: wxScrolledWindow implementation
c801d85f 4// Author: Julian Smart
566d84a7
RL
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.
c801d85f
KB
7// Created: 01/02/97
8// RCS-ID: $Id$
77ffb593 9// Copyright: (c) wxWidgets team
65571936 10// Licence: wxWindows licence
c801d85f
KB
11/////////////////////////////////////////////////////////////////////////////
12
d80cd92a
VZ
13// ============================================================================
14// declarations
15// ============================================================================
16
17// ----------------------------------------------------------------------------
18// headers
19// ----------------------------------------------------------------------------
20
c801d85f
KB
21// For compilers that support precompilation, includes "wx.h".
22#include "wx/wxprec.h"
23
c801d85f 24#ifdef __BORLANDC__
d80cd92a 25 #pragma hdrstop
c801d85f
KB
26#endif
27
de6185e2
WS
28#include "wx/scrolwin.h"
29
30#ifndef WX_PRECOMP
31 #include "wx/utils.h"
8e609c82 32 #include "wx/panel.h"
ed4b0fdc 33 #include "wx/dcclient.h"
7d616e99 34 #include "wx/timer.h"
ed2fbeb8 35 #include "wx/sizer.h"
7d616e99 36 #include "wx/settings.h"
4b316329 37#endif
ed4b0fdc 38
b9dac1ab
JS
39#ifdef __WXMAC__
40#include "wx/scrolbar.h"
41#endif
42
2a201ef8 43#include "wx/recguard.h"
c801d85f 44
48d1144b 45#ifdef __WXMSW__
1e6feb95 46 #include <windows.h> // for DLGC_WANTARROWS
7acf6a92 47 #include "wx/msw/winundef.h"
48d1144b
JS
48#endif
49
a91b47e8
JS
50#ifdef __WXMOTIF__
51// For wxRETAINED implementation
338dd992
JJ
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
55#endif
a91b47e8 56#include <Xm/Xm.h>
338dd992
JJ
57#ifdef __VMS__
58# pragma message enable nosimpint
59#endif
a91b47e8
JS
60#endif
61
066f1b7a 62/*
ca65c044
WS
63 TODO PROPERTIES
64 style wxHSCROLL | wxVSCROLL
066f1b7a
SC
65*/
66
d80cd92a 67// ----------------------------------------------------------------------------
1e6feb95
VZ
68// wxScrollHelperEvtHandler: intercept the events from the window and forward
69// them to wxScrollHelper
d80cd92a
VZ
70// ----------------------------------------------------------------------------
71
349efbaa 72class WXDLLEXPORT wxScrollHelperEvtHandler : public wxEvtHandler
1e6feb95
VZ
73{
74public:
29e1398f 75 wxScrollHelperEvtHandler(wxScrollHelperBase *scrollHelper)
1e6feb95
VZ
76 {
77 m_scrollHelper = scrollHelper;
78 }
d80cd92a 79
1e6feb95
VZ
80 virtual bool ProcessEvent(wxEvent& event);
81
ca65c044 82 void ResetDrawnFlag() { m_hasDrawnWindow = false; }
349efbaa 83
1e6feb95 84private:
29e1398f 85 wxScrollHelperBase *m_scrollHelper;
349efbaa
VZ
86
87 bool m_hasDrawnWindow;
22f3361e 88
c0c133e1 89 wxDECLARE_NO_COPY_CLASS(wxScrollHelperEvtHandler);
1e6feb95
VZ
90};
91
4b316329 92#if wxUSE_TIMER
1e6feb95
VZ
93// ----------------------------------------------------------------------------
94// wxAutoScrollTimer: the timer used to generate a stream of scroll events when
95// a captured mouse is held outside the window
96// ----------------------------------------------------------------------------
97
98class wxAutoScrollTimer : public wxTimer
99{
100public:
29e1398f
VZ
101 wxAutoScrollTimer(wxWindow *winToScroll,
102 wxScrollHelperBase *scroll,
1e6feb95
VZ
103 wxEventType eventTypeToSend,
104 int pos, int orient);
105
106 virtual void Notify();
107
108private:
109 wxWindow *m_win;
29e1398f 110 wxScrollHelperBase *m_scrollHelper;
1e6feb95
VZ
111 wxEventType m_eventType;
112 int m_pos,
113 m_orient;
22f3361e 114
c0c133e1 115 wxDECLARE_NO_COPY_CLASS(wxAutoScrollTimer);
1e6feb95 116};
d80cd92a
VZ
117
118// ============================================================================
119// implementation
120// ============================================================================
121
122// ----------------------------------------------------------------------------
1e6feb95 123// wxAutoScrollTimer
d80cd92a
VZ
124// ----------------------------------------------------------------------------
125
1e6feb95 126wxAutoScrollTimer::wxAutoScrollTimer(wxWindow *winToScroll,
29e1398f 127 wxScrollHelperBase *scroll,
1e6feb95
VZ
128 wxEventType eventTypeToSend,
129 int pos, int orient)
c801d85f 130{
1e6feb95
VZ
131 m_win = winToScroll;
132 m_scrollHelper = scroll;
133 m_eventType = eventTypeToSend;
134 m_pos = pos;
135 m_orient = orient;
c801d85f
KB
136}
137
1e6feb95 138void wxAutoScrollTimer::Notify()
c801d85f 139{
1e6feb95
VZ
140 // only do all this as long as the window is capturing the mouse
141 if ( wxWindow::GetCapture() != m_win )
142 {
143 Stop();
144 }
145 else // we still capture the mouse, continue generating events
146 {
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) )
152 {
153 // and then send a pseudo mouse-move event to refresh the selection
154 wxMouseEvent event2(wxEVT_MOTION);
b19bcdeb 155 event2.SetPosition(wxGetMousePosition());
1e6feb95
VZ
156
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;
165
166 event2.SetEventObject(m_win);
167
168 // FIXME: we don't fill in the other members - ok?
169
170 m_win->GetEventHandler()->ProcessEvent(event2);
171 }
172 else // can't scroll further, stop
173 {
174 Stop();
175 }
176 }
177}
4b316329 178#endif
1e6feb95
VZ
179
180// ----------------------------------------------------------------------------
181// wxScrollHelperEvtHandler
182// ----------------------------------------------------------------------------
183
184bool wxScrollHelperEvtHandler::ProcessEvent(wxEvent& event)
185{
9a268018 186 wxEventType evType = event.GetEventType();
2feed004 187
349efbaa
VZ
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
191 //
192 // 1. override wxScrolledWindow::OnDraw(dc)
193 // 2. define its own OnPaint() handler
194 //
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).
199 //
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)
ca65c044 204 m_hasDrawnWindow = true;
349efbaa 205
52212bcb
VZ
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.
52212bcb 212 bool processed = m_nextHandler->ProcessEvent(event);
ff186591
VZ
213
214 // always process the size events ourselves, even if the user code handles
215 // them as well, as we need to AdjustScrollbars()
216 //
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
220 // after this one
221 if ( evType == wxEVT_SIZE )
222 {
223 m_scrollHelper->HandleOnSize((wxSizeEvent &)event);
224
ca65c044 225 return true;
ff186591
VZ
226 }
227
228 if ( processed )
349efbaa
VZ
229 {
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)
c6b81ceb 233 if ( m_hasDrawnWindow || event.IsCommandEvent() )
349efbaa 234 {
ca65c044 235 return true;
349efbaa
VZ
236 }
237 }
2feed004 238
e421922f
VZ
239 if ( evType == wxEVT_PAINT )
240 {
241 m_scrollHelper->HandleOnPaint((wxPaintEvent &)event);
ca65c044 242 return true;
e421922f 243 }
1e6feb95 244
06b9c2a2
VS
245 if ( evType == wxEVT_CHILD_FOCUS )
246 {
247 m_scrollHelper->HandleOnChildFocus((wxChildFocusEvent &)event);
248 return true;
249 }
250
35c71386
VZ
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();
254 if ( wasSkipped )
255 event.Skip(false);
256
e421922f
VZ
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 )
265 {
35c71386
VZ
266 m_scrollHelper->HandleOnScroll((wxScrollWinEvent &)event);
267 if ( !event.GetSkipped() )
268 {
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)
273 processed = true;
274 wasSkipped = false;
275 }
e421922f 276 }
1e6feb95 277
e421922f
VZ
278 if ( evType == wxEVT_ENTER_WINDOW )
279 {
280 m_scrollHelper->HandleOnMouseEnter((wxMouseEvent &)event);
281 }
282 else if ( evType == wxEVT_LEAVE_WINDOW )
283 {
284 m_scrollHelper->HandleOnMouseLeave((wxMouseEvent &)event);
285 }
286#if wxUSE_MOUSEWHEEL
602e3365
RR
287 // Use GTK's own scroll wheel handling in GtkScrolledWindow
288#ifndef __WXGTK20__
e421922f
VZ
289 else if ( evType == wxEVT_MOUSEWHEEL )
290 {
291 m_scrollHelper->HandleOnMouseWheel((wxMouseEvent &)event);
602e3365 292 return true;
e421922f 293 }
602e3365 294#endif
e421922f 295#endif // wxUSE_MOUSEWHEEL
e421922f
VZ
296 else if ( evType == wxEVT_CHAR )
297 {
298 m_scrollHelper->HandleOnChar((wxKeyEvent &)event);
35c71386
VZ
299 if ( !event.GetSkipped() )
300 {
301 processed = true;
302 wasSkipped = false;
303 }
1e6feb95
VZ
304 }
305
d4a58a7c 306 event.Skip(wasSkipped);
35c71386 307
bbdee10d
VZ
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.
315 //
316 // And if we're not called from DoTryChain(), this won't do anything anyhow.
317 event.DidntHonourProcessOnlyIn();
318
35c71386 319 return processed;
1e6feb95
VZ
320}
321
29e1398f
VZ
322// ============================================================================
323// wxScrollHelperBase implementation
324// ============================================================================
325
1e6feb95 326// ----------------------------------------------------------------------------
29e1398f 327// wxScrollHelperBase construction
1e6feb95
VZ
328// ----------------------------------------------------------------------------
329
29e1398f 330wxScrollHelperBase::wxScrollHelperBase(wxWindow *win)
1e6feb95 331{
9a83f860 332 wxASSERT_MSG( win, wxT("associated window can't be NULL in wxScrollHelper") );
d32e78bd 333
1e6feb95
VZ
334 m_xScrollPixelsPerLine =
335 m_yScrollPixelsPerLine =
336 m_xScrollPosition =
337 m_yScrollPosition =
338 m_xScrollLines =
339 m_yScrollLines =
340 m_xScrollLinesPerPage =
139adb6a 341 m_yScrollLinesPerPage = 0;
1e6feb95
VZ
342
343 m_xScrollingEnabled =
ca65c044 344 m_yScrollingEnabled = true;
1e6feb95 345
d6a658ff
VZ
346 m_kbdScrollingEnabled = true;
347
1e6feb95 348 m_scaleX =
139adb6a 349 m_scaleY = 1.0;
24ce4c18 350#if wxUSE_MOUSEWHEEL
d2c52078 351 m_wheelRotation = 0;
24ce4c18 352#endif
a58a12e9 353
1e6feb95 354 m_win =
29e1398f 355 m_targetWindow = NULL;
139adb6a 356
29e1398f 357 m_timerAutoScroll = NULL;
d7da9756 358
349efbaa
VZ
359 m_handler = NULL;
360
d32e78bd 361 m_win = win;
29e1398f
VZ
362
363 m_win->SetScrollHelper(static_cast<wxScrollHelper *>(this));
d32e78bd
VZ
364
365 // by default, the associated window is also the target window
366 DoSetTargetWindow(win);
1e6feb95 367}
d7da9756 368
29e1398f 369wxScrollHelperBase::~wxScrollHelperBase()
d80cd92a 370{
1e6feb95
VZ
371 StopAutoScrolling();
372
349efbaa 373 DeleteEvtHandler();
d80cd92a
VZ
374}
375
376// ----------------------------------------------------------------------------
377// setting scrolling parameters
378// ----------------------------------------------------------------------------
379
29e1398f
VZ
380void wxScrollHelperBase::SetScrollbars(int pixelsPerUnitX,
381 int pixelsPerUnitY,
382 int noUnitsX,
383 int noUnitsY,
384 int xPos,
385 int yPos,
386 bool noRefresh)
c801d85f 387{
b0486e0d
SN
388 int xpos, ypos;
389
390 CalcUnscrolledPosition(xPos, yPos, &xpos, &ypos);
139adb6a
RR
391 bool do_refresh =
392 (
c801d85f 393 (noUnitsX != 0 && m_xScrollLines == 0) ||
566d84a7 394 (noUnitsX < m_xScrollLines && xpos > pixelsPerUnitX * noUnitsX) ||
b0486e0d 395
c801d85f 396 (noUnitsY != 0 && m_yScrollLines == 0) ||
566d84a7 397 (noUnitsY < m_yScrollLines && ypos > pixelsPerUnitY * noUnitsY) ||
c801d85f 398 (xPos != m_xScrollPosition) ||
b0486e0d 399 (yPos != m_yScrollPosition)
139adb6a 400 );
a58a12e9 401
139adb6a
RR
402 m_xScrollPixelsPerLine = pixelsPerUnitX;
403 m_yScrollPixelsPerLine = pixelsPerUnitY;
404 m_xScrollPosition = xPos;
405 m_yScrollPosition = yPos;
a91b47e8 406
150c8d89
RL
407 int w = noUnitsX * pixelsPerUnitX;
408 int h = noUnitsY * pixelsPerUnitY;
409
2b5f62a0
VZ
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.
2b43d588 413 // m_targetWindow->SetVirtualSizeHints( w, h );
a58a12e9 414
2b5f62a0
VZ
415 // The above should arguably be deprecated, this however we still need.
416
f18f464c
VZ
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);
dc429f89 422
a58a12e9 423 if (do_refresh && !noRefresh)
ca65c044 424 m_targetWindow->Refresh(true, GetScrollRect());
a58a12e9 425
1f066698
VZ
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__
432 {
433 AdjustScrollbars();
434 }
435#ifndef __WXUNIVERSAL__
436 else
437 {
438 // otherwise this has been done by AdjustScrollbars, above
1f066698
VZ
439 }
440#endif // !__WXUNIVERSAL__
c801d85f
KB
441}
442
d80cd92a 443// ----------------------------------------------------------------------------
af4088f1 444// [target] window handling
d80cd92a 445// ----------------------------------------------------------------------------
ecab4dba 446
29e1398f 447void wxScrollHelperBase::DeleteEvtHandler()
ecab4dba 448{
248d771c
VZ
449 // search for m_handler in the handler list
450 if ( m_win && m_handler )
349efbaa 451 {
74f6bbf9 452 if ( m_win->RemoveEventHandler(m_handler) )
248d771c 453 {
74f6bbf9 454 delete m_handler;
248d771c 455 }
74f6bbf9
VZ
456 //else: something is very wrong, so better [maybe] leak memory than
457 // risk a crash because of double deletion
248d771c 458
74f6bbf9 459 m_handler = NULL;
349efbaa
VZ
460 }
461}
462
29e1398f 463void wxScrollHelperBase::ResetDrawnFlag()
16361ec9
VS
464{
465 wxCHECK_RET( m_handler, "invalid use of ResetDrawnFlag - no handler?" );
466 m_handler->ResetDrawnFlag();
467}
468
29e1398f 469void wxScrollHelperBase::DoSetTargetWindow(wxWindow *target)
349efbaa 470{
ecab4dba 471 m_targetWindow = target;
8adc196b
SC
472#ifdef __WXMAC__
473 target->MacSetClipChildren( true ) ;
474#endif
349efbaa
VZ
475
476 // install the event handler which will intercept the events we're
af4088f1
VZ
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 )
13ff9344 480 {
248d771c
VZ
481 // if we already have a handler, delete it first
482 DeleteEvtHandler();
483
13ff9344
JS
484 m_handler = new wxScrollHelperEvtHandler(this);
485 m_targetWindow->PushEventHandler(m_handler);
486 }
349efbaa
VZ
487}
488
29e1398f 489void wxScrollHelperBase::SetTargetWindow(wxWindow *target)
349efbaa
VZ
490{
491 wxCHECK_RET( target, wxT("target window must not be NULL") );
492
493 if ( target == m_targetWindow )
494 return;
495
af4088f1 496 DoSetTargetWindow(target);
ecab4dba
RR
497}
498
29e1398f 499wxWindow *wxScrollHelperBase::GetTargetWindow() const
ecab4dba
RR
500{
501 return m_targetWindow;
502}
503
d80cd92a
VZ
504// ----------------------------------------------------------------------------
505// scrolling implementation itself
506// ----------------------------------------------------------------------------
507
29e1398f 508void wxScrollHelperBase::HandleOnScroll(wxScrollWinEvent& event)
c801d85f 509{
139adb6a 510 int nScrollInc = CalcScrollInc(event);
1e6feb95 511 if ( nScrollInc == 0 )
139adb6a 512 {
1e6feb95
VZ
513 // can't scroll further
514 event.Skip();
515
516 return;
139adb6a 517 }
c801d85f 518
ca65c044 519 bool needsRefresh = false;
1e6feb95
VZ
520 int dx = 0,
521 dy = 0;
b97dc9c8 522 int orient = event.GetOrientation();
139adb6a
RR
523 if (orient == wxHORIZONTAL)
524 {
1e6feb95
VZ
525 if ( m_xScrollingEnabled )
526 {
527 dx = -m_xScrollPixelsPerLine * nScrollInc;
528 }
139adb6a 529 else
1e6feb95 530 {
ca65c044 531 needsRefresh = true;
1e6feb95 532 }
139adb6a 533 }
c801d85f 534 else
139adb6a 535 {
1e6feb95
VZ
536 if ( m_yScrollingEnabled )
537 {
538 dy = -m_yScrollPixelsPerLine * nScrollInc;
539 }
139adb6a 540 else
1e6feb95 541 {
ca65c044 542 needsRefresh = true;
1e6feb95
VZ
543 }
544 }
545
b97dc9c8
VS
546 if ( !needsRefresh )
547 {
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
93727870
SC
551#ifdef __WXMAC__
552 // wxWindowMac is taking care of making sure the update area is correctly
553 // set up, while not forcing an immediate redraw
554#else
b97dc9c8 555 m_targetWindow->Update();
93727870 556#endif
b97dc9c8
VS
557 }
558
559 if (orient == wxHORIZONTAL)
560 {
561 m_xScrollPosition += nScrollInc;
562 m_win->SetScrollPos(wxHORIZONTAL, m_xScrollPosition);
563 }
564 else
565 {
566 m_yScrollPosition += nScrollInc;
567 m_win->SetScrollPos(wxVERTICAL, m_yScrollPosition);
568 }
569
1e6feb95
VZ
570 if ( needsRefresh )
571 {
ca65c044 572 m_targetWindow->Refresh(true, GetScrollRect());
1e6feb95
VZ
573 }
574 else
575 {
d5d58a93 576 m_targetWindow->ScrollWindow(dx, dy, GetScrollRect());
3d2b9c20 577 }
c801d85f
KB
578}
579
29e1398f 580int wxScrollHelperBase::CalcScrollInc(wxScrollWinEvent& event)
c801d85f 581{
ecab4dba
RR
582 int pos = event.GetPosition();
583 int orient = event.GetOrientation();
c801d85f 584
ecab4dba 585 int nScrollInc = 0;
1a8caf94 586 if (event.GetEventType() == wxEVT_SCROLLWIN_TOP)
c801d85f 587 {
ecab4dba
RR
588 if (orient == wxHORIZONTAL)
589 nScrollInc = - m_xScrollPosition;
590 else
591 nScrollInc = - m_yScrollPosition;
1a8caf94
RR
592 } else
593 if (event.GetEventType() == wxEVT_SCROLLWIN_BOTTOM)
594 {
ecab4dba
RR
595 if (orient == wxHORIZONTAL)
596 nScrollInc = m_xScrollLines - m_xScrollPosition;
597 else
598 nScrollInc = m_yScrollLines - m_yScrollPosition;
1a8caf94
RR
599 } else
600 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEUP)
601 {
ecab4dba 602 nScrollInc = -1;
1a8caf94
RR
603 } else
604 if (event.GetEventType() == wxEVT_SCROLLWIN_LINEDOWN)
605 {
ecab4dba 606 nScrollInc = 1;
1a8caf94
RR
607 } else
608 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEUP)
609 {
ecab4dba
RR
610 if (orient == wxHORIZONTAL)
611 nScrollInc = -GetScrollPageSize(wxHORIZONTAL);
612 else
613 nScrollInc = -GetScrollPageSize(wxVERTICAL);
1a8caf94
RR
614 } else
615 if (event.GetEventType() == wxEVT_SCROLLWIN_PAGEDOWN)
616 {
ecab4dba
RR
617 if (orient == wxHORIZONTAL)
618 nScrollInc = GetScrollPageSize(wxHORIZONTAL);
619 else
620 nScrollInc = GetScrollPageSize(wxVERTICAL);
1a8caf94
RR
621 } else
622 if ((event.GetEventType() == wxEVT_SCROLLWIN_THUMBTRACK) ||
623 (event.GetEventType() == wxEVT_SCROLLWIN_THUMBRELEASE))
624 {
ecab4dba
RR
625 if (orient == wxHORIZONTAL)
626 nScrollInc = pos - m_xScrollPosition;
627 else
628 nScrollInc = pos - m_yScrollPosition;
c801d85f 629 }
88150e60 630
ecab4dba
RR
631 if (orient == wxHORIZONTAL)
632 {
2e9c0c01 633 if ( m_xScrollPosition + nScrollInc < 0 )
ecab4dba 634 {
2e9c0c01
VZ
635 // As -ve as we can go
636 nScrollInc = -m_xScrollPosition;
637 }
638 else // check for the other bound
639 {
640 const int posMax = m_xScrollLines - m_xScrollLinesPerPage;
641 if ( m_xScrollPosition + nScrollInc > posMax )
878ddad5 642 {
2e9c0c01
VZ
643 // As +ve as we can go
644 nScrollInc = posMax - m_xScrollPosition;
878ddad5 645 }
ecab4dba 646 }
9d9355c6 647 }
2e9c0c01 648 else // wxVERTICAL
ecab4dba 649 {
2e9c0c01 650 if ( m_yScrollPosition + nScrollInc < 0 )
d80cd92a 651 {
2e9c0c01
VZ
652 // As -ve as we can go
653 nScrollInc = -m_yScrollPosition;
ecab4dba 654 }
2e9c0c01 655 else // check for the other bound
be9b0663 656 {
2e9c0c01
VZ
657 const int posMax = m_yScrollLines - m_yScrollLinesPerPage;
658 if ( m_yScrollPosition + nScrollInc > posMax )
659 {
660 // As +ve as we can go
661 nScrollInc = posMax - m_yScrollPosition;
662 }
be9b0663 663 }
9d9355c6 664 }
9d9355c6 665
ecab4dba 666 return nScrollInc;
c801d85f
KB
667}
668
29e1398f 669void wxScrollHelperBase::DoPrepareDC(wxDC& dc)
c801d85f 670{
1e6feb95 671 wxPoint pt = dc.GetDeviceOrigin();
807a572e
RR
672#ifdef __WXGTK__
673 // It may actually be correct to always query
69367c56 674 // the m_sign from the DC here, but I leave the
807a572e
RR
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 );
679 else
680#endif
681 dc.SetDeviceOrigin( pt.x - m_xScrollPosition * m_xScrollPixelsPerLine,
682 pt.y - m_yScrollPosition * m_yScrollPixelsPerLine );
139adb6a 683 dc.SetUserScale( m_scaleX, m_scaleY );
c801d85f
KB
684}
685
29e1398f 686void wxScrollHelperBase::SetScrollRate( int xstep, int ystep )
566d84a7
RL
687{
688 int old_x = m_xScrollPixelsPerLine * m_xScrollPosition;
689 int old_y = m_yScrollPixelsPerLine * m_yScrollPosition;
690
691 m_xScrollPixelsPerLine = xstep;
692 m_yScrollPixelsPerLine = ystep;
693
694 int new_x = m_xScrollPixelsPerLine * m_xScrollPosition;
695 int new_y = m_yScrollPixelsPerLine * m_yScrollPosition;
696
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 );
700
701 AdjustScrollbars();
702}
703
29e1398f 704void wxScrollHelperBase::GetScrollPixelsPerUnit (int *x_unit, int *y_unit) const
c801d85f 705{
a0bc2c1d
VZ
706 if ( x_unit )
707 *x_unit = m_xScrollPixelsPerLine;
708 if ( y_unit )
709 *y_unit = m_yScrollPixelsPerLine;
c801d85f
KB
710}
711
5713b349 712
29e1398f 713int wxScrollHelperBase::GetScrollLines( int orient ) const
5713b349
RR
714{
715 if ( orient == wxHORIZONTAL )
716 return m_xScrollLines;
717 else
718 return m_yScrollLines;
719}
720
29e1398f 721int wxScrollHelperBase::GetScrollPageSize(int orient) const
c801d85f
KB
722{
723 if ( orient == wxHORIZONTAL )
724 return m_xScrollLinesPerPage;
725 else
726 return m_yScrollLinesPerPage;
727}
728
29e1398f 729void wxScrollHelperBase::SetScrollPageSize(int orient, int pageSize)
c801d85f
KB
730{
731 if ( orient == wxHORIZONTAL )
732 m_xScrollLinesPerPage = pageSize;
733 else
734 m_yScrollLinesPerPage = pageSize;
735}
736
29e1398f 737void wxScrollHelperBase::EnableScrolling (bool x_scroll, bool y_scroll)
c801d85f 738{
29e1398f
VZ
739 m_xScrollingEnabled = x_scroll;
740 m_yScrollingEnabled = y_scroll;
741}
a58a12e9 742
29e1398f
VZ
743// Where the current view starts from
744void wxScrollHelperBase::DoGetViewStart (int *x, int *y) const
745{
746 if ( x )
747 *x = m_xScrollPosition;
748 if ( y )
749 *y = m_yScrollPosition;
750}
c801d85f 751
29e1398f
VZ
752void wxScrollHelperBase::DoCalcScrolledPosition(int x, int y,
753 int *xx, int *yy) const
754{
755 if ( xx )
756 *xx = x - m_xScrollPosition * m_xScrollPixelsPerLine;
757 if ( yy )
758 *yy = y - m_yScrollPosition * m_yScrollPixelsPerLine;
759}
8ea45699 760
29e1398f
VZ
761void wxScrollHelperBase::DoCalcUnscrolledPosition(int x, int y,
762 int *xx, int *yy) const
763{
764 if ( xx )
765 *xx = x + m_xScrollPosition * m_xScrollPixelsPerLine;
766 if ( yy )
767 *yy = y + m_yScrollPosition * m_yScrollPixelsPerLine;
768}
a58a12e9 769
29e1398f
VZ
770// ----------------------------------------------------------------------------
771// geometry
772// ----------------------------------------------------------------------------
139adb6a 773
29e1398f
VZ
774bool wxScrollHelperBase::ScrollLayout()
775{
776 if ( m_win->GetSizer() && m_targetWindow == m_win )
c801d85f 777 {
29e1398f
VZ
778 // If we're the scroll target, take into account the
779 // virtual size and scrolled position of the window.
139adb6a 780
29e1398f
VZ
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);
785 return true;
b97dc9c8 786 }
d2c52078 787
29e1398f
VZ
788 // fall back to default for LayoutConstraints
789 return m_win->wxWindow::Layout();
790}
b97dc9c8 791
29e1398f
VZ
792void wxScrollHelperBase::ScrollDoSetVirtualSize(int x, int y)
793{
794 m_win->wxWindow::DoSetVirtualSize( x, y );
795 AdjustScrollbars();
d32e78bd
VZ
796
797 if (m_win->GetAutoLayout())
798 m_win->Layout();
799}
800
801// wxWindow's GetBestVirtualSize returns the actual window size,
802// whereas we want to return the virtual size
29e1398f 803wxSize wxScrollHelperBase::ScrollGetBestVirtualSize() const
d32e78bd
VZ
804{
805 wxSize clientSize(m_win->GetClientSize());
806 if ( m_win->GetSizer() )
807 clientSize.IncTo(m_win->GetSizer()->CalcMin());
808
809 return clientSize;
810}
811
d80cd92a
VZ
812// ----------------------------------------------------------------------------
813// event handlers
814// ----------------------------------------------------------------------------
815
816// Default OnSize resets scrollbars, if any
29e1398f 817void wxScrollHelperBase::HandleOnSize(wxSizeEvent& WXUNUSED(event))
d80cd92a 818{
c376d80f 819 if ( m_targetWindow->GetAutoLayout() )
2b5f62a0 820 {
c376d80f 821 wxSize size = m_targetWindow->GetBestVirtualSize();
d32e78bd 822
c376d80f 823 // This will call ::Layout() and ::AdjustScrollbars()
168f82ce 824 m_win->SetVirtualSize( size );
2b5f62a0
VZ
825 }
826 else
c376d80f 827 {
2b5f62a0 828 AdjustScrollbars();
c376d80f 829 }
d80cd92a
VZ
830}
831
832// This calls OnDraw, having adjusted the origin according to the current
833// scroll position
29e1398f 834void wxScrollHelperBase::HandleOnPaint(wxPaintEvent& WXUNUSED(event))
d80cd92a 835{
af4088f1
VZ
836 // don't use m_targetWindow here, this is always called for ourselves
837 wxPaintDC dc(m_win);
1e6feb95 838 DoPrepareDC(dc);
d80cd92a
VZ
839
840 OnDraw(dc);
841}
842
438e3558
VZ
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
29e1398f 847void wxScrollHelperBase::HandleOnChar(wxKeyEvent& event)
d80cd92a 848{
d6a658ff
VZ
849 if ( !m_kbdScrollingEnabled )
850 {
851 event.Skip();
852 return;
853 }
854
e2495f72
VZ
855 // prepare the event this key press maps to
856 wxScrollWinEvent newEvent;
d80cd92a 857
e2495f72
VZ
858 newEvent.SetPosition(0);
859 newEvent.SetEventObject(m_win);
56dade3c 860
e2495f72
VZ
861 // this is the default, it's changed to wxHORIZONTAL below if needed
862 newEvent.SetOrientation(wxVERTICAL);
d80cd92a 863
e2495f72
VZ
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;
39c869a6 868
4995ca80 869 switch ( event.GetKeyCode() )
d80cd92a
VZ
870 {
871 case WXK_PAGEUP:
e2495f72 872 newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEUP);
d80cd92a
VZ
873 break;
874
875 case WXK_PAGEDOWN:
e2495f72 876 newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN);
d80cd92a
VZ
877 break;
878
d80cd92a 879 case WXK_HOME:
e2495f72 880 newEvent.SetEventType(wxEVT_SCROLLWIN_TOP);
d80cd92a 881
e2495f72 882 sendHorizontalToo = event.ControlDown();
d80cd92a
VZ
883 break;
884
e2495f72
VZ
885 case WXK_END:
886 newEvent.SetEventType(wxEVT_SCROLLWIN_BOTTOM);
d80cd92a 887
e2495f72 888 sendHorizontalToo = event.ControlDown();
d80cd92a
VZ
889 break;
890
891 case WXK_LEFT:
e2495f72
VZ
892 newEvent.SetOrientation(wxHORIZONTAL);
893 // fall through
894
895 case WXK_UP:
896 newEvent.SetEventType(wxEVT_SCROLLWIN_LINEUP);
d80cd92a
VZ
897 break;
898
899 case WXK_RIGHT:
e2495f72
VZ
900 newEvent.SetOrientation(wxHORIZONTAL);
901 // fall through
902
903 case WXK_DOWN:
904 newEvent.SetEventType(wxEVT_SCROLLWIN_LINEDOWN);
d80cd92a
VZ
905 break;
906
907 default:
e2495f72 908 // not a scrolling key
d80cd92a 909 event.Skip();
e2495f72 910 return;
d80cd92a 911 }
39c869a6 912
e2495f72 913 m_win->ProcessWindowEvent(newEvent);
39c869a6 914
e2495f72 915 if ( sendHorizontalToo )
39c869a6 916 {
e2495f72
VZ
917 newEvent.SetOrientation(wxHORIZONTAL);
918 m_win->ProcessWindowEvent(newEvent);
39c869a6 919 }
d80cd92a 920}
d2c52078 921
1e6feb95
VZ
922// ----------------------------------------------------------------------------
923// autoscroll stuff: these functions deal with sending fake scroll events when
924// a captured mouse is being held outside the window
925// ----------------------------------------------------------------------------
926
29e1398f 927bool wxScrollHelperBase::SendAutoScrollEvents(wxScrollWinEvent& event) const
1e6feb95
VZ
928{
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());
932}
933
29e1398f 934void wxScrollHelperBase::StopAutoScrolling()
1e6feb95 935{
4b316329 936#if wxUSE_TIMER
5276b0a5 937 wxDELETE(m_timerAutoScroll);
4b316329 938#endif
1e6feb95 939}
d2c52078 940
29e1398f 941void wxScrollHelperBase::HandleOnMouseEnter(wxMouseEvent& event)
d2c52078 942{
1e6feb95
VZ
943 StopAutoScrolling();
944
945 event.Skip();
946}
d2c52078 947
29e1398f 948void wxScrollHelperBase::HandleOnMouseLeave(wxMouseEvent& event)
1e6feb95
VZ
949{
950 // don't prevent the usual processing of the event from taking place
951 event.Skip();
952
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 )
957 {
958 // where is the mouse leaving?
959 int pos, orient;
960 wxPoint pt = event.GetPosition();
961 if ( pt.x < 0 )
962 {
963 orient = wxHORIZONTAL;
964 pos = 0;
965 }
966 else if ( pt.y < 0 )
967 {
968 orient = wxVERTICAL;
969 pos = 0;
970 }
971 else // we're lower or to the right of the window
972 {
973 wxSize size = m_targetWindow->GetClientSize();
974 if ( pt.x > size.x )
975 {
976 orient = wxHORIZONTAL;
977 pos = m_xScrollLines;
978 }
979 else if ( pt.y > size.y )
980 {
981 orient = wxVERTICAL;
982 pos = m_yScrollLines;
983 }
984 else // this should be impossible
985 {
986 // but seems to happen sometimes under wxMSW - maybe it's a bug
987 // there but for now just ignore it
988
9a83f860 989 //wxFAIL_MSG( wxT("can't understand where has mouse gone") );
1e6feb95
VZ
990
991 return;
992 }
993 }
994
995 // only start the auto scroll timer if the window can be scrolled in
996 // this direction
997 if ( !m_targetWindow->HasScrollbar(orient) )
998 return;
999
4b316329 1000#if wxUSE_TIMER
1e6feb95
VZ
1001 delete m_timerAutoScroll;
1002 m_timerAutoScroll = new wxAutoScrollTimer
1003 (
1004 m_targetWindow, this,
1005 pos == 0 ? wxEVT_SCROLLWIN_LINEUP
1006 : wxEVT_SCROLLWIN_LINEDOWN,
1007 pos,
1008 orient
1009 );
1010 m_timerAutoScroll->Start(50); // FIXME: make configurable
534b127c
WS
1011#else
1012 wxUnusedVar(pos);
4b316329 1013#endif
1e6feb95
VZ
1014 }
1015}
1016
e421922f
VZ
1017#if wxUSE_MOUSEWHEEL
1018
29e1398f 1019void wxScrollHelperBase::HandleOnMouseWheel(wxMouseEvent& event)
1e6feb95 1020{
d2c52078 1021 m_wheelRotation += event.GetWheelRotation();
1e6feb95 1022 int lines = m_wheelRotation / event.GetWheelDelta();
d2c52078
RD
1023 m_wheelRotation -= lines * event.GetWheelDelta();
1024
1e6feb95
VZ
1025 if (lines != 0)
1026 {
1e6feb95 1027
b6b85bdc
JS
1028 wxScrollWinEvent newEvent;
1029
ac6f6ffc 1030 newEvent.SetPosition(0);
6682e732 1031 newEvent.SetOrientation( event.GetWheelAxis() == 0 ? wxVERTICAL : wxHORIZONTAL);
687706f5 1032 newEvent.SetEventObject(m_win);
b6b85bdc 1033
9b9337da 1034 if (event.IsPageScroll())
4b056ef5
RD
1035 {
1036 if (lines > 0)
687706f5 1037 newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEUP);
4b056ef5 1038 else
687706f5 1039 newEvent.SetEventType(wxEVT_SCROLLWIN_PAGEDOWN);
4b056ef5 1040
b6b85bdc 1041 m_win->GetEventHandler()->ProcessEvent(newEvent);
4b056ef5
RD
1042 }
1043 else
1044 {
1045 lines *= event.GetLinesPerAction();
1046 if (lines > 0)
687706f5 1047 newEvent.SetEventType(wxEVT_SCROLLWIN_LINEUP);
4b056ef5 1048 else
687706f5 1049 newEvent.SetEventType(wxEVT_SCROLLWIN_LINEDOWN);
b6b85bdc 1050
4b056ef5
RD
1051 int times = abs(lines);
1052 for (; times > 0; times--)
1053 m_win->GetEventHandler()->ProcessEvent(newEvent);
1054 }
d2c52078
RD
1055 }
1056}
1057
e421922f
VZ
1058#endif // wxUSE_MOUSEWHEEL
1059
29e1398f 1060void wxScrollHelperBase::HandleOnChildFocus(wxChildFocusEvent& event)
06b9c2a2
VS
1061{
1062 // this event should be processed by all windows in parenthood chain,
1063 // e.g. so that nested wxScrolledWindows work correctly
1064 event.Skip();
1065
1066 // find the immediate child under which the window receiving focus is:
1067 wxWindow *win = event.GetWindow();
02a33891
VS
1068
1069 if ( win == m_targetWindow )
1070 return; // nothing to do
1071
2e1517a2 1072#if defined( __WXOSX__ ) && wxUSE_SCROLLBAR
380e1c0c
JS
1073 if (wxDynamicCast(win, wxScrollBar))
1074 return;
1075#endif
1076
3ec704b4
RD
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.
1088 //
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
1096 // cases.
1097
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
29e1398f 1104 return;
3ec704b4 1105
888e9638 1106 const wxRect viewRect(m_targetWindow->GetClientRect());
3ec704b4
RD
1107
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
d13b34d3 1114 // wxScrolledWindows, the parent might be way too big to fit inside the
3ec704b4
RD
1115 // scrolled window. If that is the case, then make only the focused window
1116 // visible
1117 if ( win->GetParent() != m_targetWindow)
06b9c2a2 1118 {
3ec704b4
RD
1119 wxWindow *parent=win->GetParent();
1120 wxSize parent_size=parent->GetSize();
888e9638
VZ
1121 if (parent_size.GetWidth() <= viewRect.GetWidth() &&
1122 parent_size.GetHeight() <= viewRect.GetHeight())
3ec704b4 1123 // make the immediate parent visible instead of the focused control
29e1398f 1124 win=parent;
06b9c2a2
VS
1125 }
1126
888e9638
VZ
1127 // make win position relative to the m_targetWindow viewing area instead of
1128 // its parent
1129 const wxRect
1130 winRect(m_targetWindow->ScreenToClient(win->GetScreenPosition()),
1131 win->GetSize());
1132
1133 // check if it's fully visible
1134 if ( viewRect.Contains(winRect) )
1135 {
1136 // it is, nothing to do
1137 return;
1138 }
1139
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() )
1144 {
1145 // we can't make it fit so avoid scrolling it at all, this is only
1146 // going to be confusing and not helpful
1147 return;
1148 }
1149
1150
1151 // do make the window fit inside the view area by scrolling to it
06b9c2a2
VS
1152 int stepx, stepy;
1153 GetScrollPixelsPerUnit(&stepx, &stepy);
1154
06b9c2a2
VS
1155 int startx, starty;
1156 GetViewStart(&startx, &starty);
1157
1158 // first in vertical direction:
1159 if ( stepy > 0 )
1160 {
1161 int diff = 0;
1162
888e9638 1163 if ( winRect.GetTop() < 0 )
06b9c2a2 1164 {
888e9638 1165 diff = winRect.GetTop();
06b9c2a2 1166 }
888e9638 1167 else if ( winRect.GetBottom() > viewRect.GetHeight() )
06b9c2a2 1168 {
888e9638 1169 diff = winRect.GetBottom() - viewRect.GetHeight() + 1;
06b9c2a2
VS
1170 // round up to next scroll step if we can't get exact position,
1171 // so that the window is fully visible:
1172 diff += stepy - 1;
1173 }
1174
1175 starty = (starty * stepy + diff) / stepy;
1176 }
1177
1178 // then horizontal:
1179 if ( stepx > 0 )
1180 {
1181 int diff = 0;
1182
888e9638 1183 if ( winRect.GetLeft() < 0 )
06b9c2a2 1184 {
888e9638 1185 diff = winRect.GetLeft();
06b9c2a2 1186 }
888e9638 1187 else if ( winRect.GetRight() > viewRect.GetWidth() )
06b9c2a2 1188 {
888e9638 1189 diff = winRect.GetRight() - viewRect.GetWidth() + 1;
06b9c2a2
VS
1190 // round up to next scroll step if we can't get exact position,
1191 // so that the window is fully visible:
1192 diff += stepx - 1;
1193 }
1194
1195 startx = (startx * stepx + diff) / stepx;
1196 }
1197
1198 Scroll(startx, starty);
1199}
1200
29e1398f
VZ
1201
1202#ifdef wxHAS_GENERIC_SCROLLWIN
1203
1204// ----------------------------------------------------------------------------
1205// wxScrollHelper implementation
1206// ----------------------------------------------------------------------------
1207
1208wxScrollHelper::wxScrollHelper(wxWindow *winToScroll)
1209 : wxScrollHelperBase(winToScroll)
1210{
1211 m_xVisibility =
1212 m_yVisibility = wxSHOW_SB_DEFAULT;
1213}
1214
1215void wxScrollHelper::DoShowScrollbars(wxScrollbarVisibility horz,
1216 wxScrollbarVisibility vert)
1217{
1218 if ( horz != m_xVisibility || vert != m_yVisibility )
1219 {
1220 m_xVisibility = horz;
1221 m_yVisibility = vert;
1222
1223 AdjustScrollbars();
1224 }
1225}
1226
1227void
1228wxScrollHelper::DoAdjustScrollbar(int orient,
1229 int clientSize,
1230 int virtSize,
1ddb6d28 1231 int pixelsPerUnit,
29e1398f
VZ
1232 int& scrollUnits,
1233 int& scrollPosition,
1ddb6d28 1234 int& scrollLinesPerPage,
29e1398f
VZ
1235 wxScrollbarVisibility visibility)
1236{
29e1398f 1237 // scroll lines per page: if 0, no scrolling is needed
29e1398f 1238 // check if we need scrollbar in this direction at all
1ddb6d28 1239 if ( pixelsPerUnit == 0 || clientSize >= virtSize )
29e1398f
VZ
1240 {
1241 // scrolling is disabled or unnecessary
1242 scrollUnits =
1243 scrollPosition = 0;
1ddb6d28 1244 scrollLinesPerPage = 0;
29e1398f
VZ
1245 }
1246 else // might need scrolling
1247 {
1248 // Round up integer division to catch any "leftover" client space.
1249 scrollUnits = (virtSize + pixelsPerUnit - 1) / pixelsPerUnit;
1250
1251 // Calculate the number of fully scroll units
1ddb6d28 1252 scrollLinesPerPage = clientSize / pixelsPerUnit;
29e1398f 1253
1ddb6d28 1254 if ( scrollLinesPerPage >= scrollUnits )
29e1398f
VZ
1255 {
1256 // we're big enough to not need scrolling
1257 scrollUnits =
1258 scrollPosition = 0;
1ddb6d28 1259 scrollLinesPerPage = 0;
29e1398f
VZ
1260 }
1261 else // we do need a scrollbar
1262 {
1ddb6d28
VZ
1263 if ( scrollLinesPerPage < 1 )
1264 scrollLinesPerPage = 1;
29e1398f
VZ
1265
1266 // Correct position if greater than extent of canvas minus
1267 // the visible portion of it or if below zero
1ddb6d28 1268 const int posMax = scrollUnits - scrollLinesPerPage;
29e1398f
VZ
1269 if ( scrollPosition > posMax )
1270 scrollPosition = posMax;
1271 else if ( scrollPosition < 0 )
1272 scrollPosition = 0;
1273 }
1274 }
1275
1ddb6d28
VZ
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()
36e5a9a7 1279 int range;
1ddb6d28
VZ
1280 switch ( visibility )
1281 {
1282 case wxSHOW_SB_NEVER:
1283 range = 0;
1284 break;
1285
36e5a9a7
VZ
1286 case wxSHOW_SB_ALWAYS:
1287 range = scrollUnits ? scrollUnits : -1;
1288 break;
1289
1290 default:
1291 wxFAIL_MSG( wxS("unknown scrollbar visibility") );
1292 // fall through
1293
1ddb6d28
VZ
1294 case wxSHOW_SB_DEFAULT:
1295 range = scrollUnits;
1296 break;
1297
1ddb6d28 1298 }
29e1398f 1299
1ddb6d28 1300 m_win->SetScrollbar(orient, scrollPosition, scrollLinesPerPage, range);
29e1398f
VZ
1301}
1302
1303void wxScrollHelper::AdjustScrollbars()
1304{
1305 static wxRecursionGuardFlag s_flagReentrancy;
1306 wxRecursionGuard guard(s_flagReentrancy);
1307 if ( guard.IsInside() )
1308 {
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
1315 return;
1316 }
1317
1318 int oldXScroll = m_xScrollPosition;
1319 int oldYScroll = m_yScrollPosition;
1320
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
1324 //
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++ )
1328 {
1329 wxSize clientSize = GetTargetSize();
1330 const wxSize virtSize = m_targetWindow->GetVirtualSize();
1331
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
1337 //
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 )
1343 {
1344 if ( availSize.x >= virtSize.x && availSize.y >= virtSize.y )
1345 {
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;
1350 }
1351 }
1352
1353
1354 DoAdjustScrollbar(wxHORIZONTAL,
1355 clientSize.x,
1356 virtSize.x,
1357 m_xScrollPixelsPerLine,
1358 m_xScrollLines,
1359 m_xScrollPosition,
1ddb6d28 1360 m_xScrollLinesPerPage,
29e1398f
VZ
1361 m_xVisibility);
1362
1363 DoAdjustScrollbar(wxVERTICAL,
1364 clientSize.y,
1365 virtSize.y,
1366 m_yScrollPixelsPerLine,
1367 m_yScrollLines,
1368 m_yScrollPosition,
1ddb6d28 1369 m_yScrollLinesPerPage,
29e1398f
VZ
1370 m_yVisibility);
1371
1372
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 )
1376 break;
1377 }
1378
1379#ifdef __WXMOTIF__
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.
1384
1385 if ( m_targetWindow->GetWindowStyle() & wxRETAINED )
1386 {
1387 Display* dpy = XtDisplay((Widget)m_targetWindow->GetMainWidget());
1388
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)))
1394 {
1395 XFreePixmap (dpy, (Pixmap) m_targetWindow->GetBackingPixmap());
1396 m_targetWindow->SetBackingPixmap((WXPixmap) 0);
1397 }
1398
1399 if (!m_targetWindow->GetBackingPixmap() &&
1400 (m_xScrollLines != 0) && (m_yScrollLines != 0))
1401 {
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));
1407 }
1408
1409 }
1410#endif // Motif
1411
1412 if (oldXScroll != m_xScrollPosition)
1413 {
1414 if (m_xScrollingEnabled)
1415 m_targetWindow->ScrollWindow( m_xScrollPixelsPerLine * (oldXScroll - m_xScrollPosition), 0,
1416 GetScrollRect() );
1417 else
1418 m_targetWindow->Refresh(true, GetScrollRect());
1419 }
1420
1421 if (oldYScroll != m_yScrollPosition)
1422 {
1423 if (m_yScrollingEnabled)
1424 m_targetWindow->ScrollWindow( 0, m_yScrollPixelsPerLine * (oldYScroll-m_yScrollPosition),
1425 GetScrollRect() );
1426 else
1427 m_targetWindow->Refresh(true, GetScrollRect());
1428 }
1429}
1430
1431void wxScrollHelper::DoScroll( int x_pos, int y_pos )
1432{
1433 if (!m_targetWindow)
1434 return;
1435
1436 if (((x_pos == -1) || (x_pos == m_xScrollPosition)) &&
1437 ((y_pos == -1) || (y_pos == m_yScrollPosition))) return;
1438
1439 int w = 0, h = 0;
1440 GetTargetSize(&w, &h);
1441
1442 // compute new position:
1443 int new_x = m_xScrollPosition;
1444 int new_y = m_yScrollPosition;
1445
1446 if ((x_pos != -1) && (m_xScrollPixelsPerLine))
1447 {
1448 new_x = x_pos;
1449
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;
1454
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 );
1459 }
1460 if ((y_pos != -1) && (m_yScrollPixelsPerLine))
1461 {
1462 new_y = y_pos;
1463
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;
1468
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 );
1473 }
1474
1475 if ( new_x == m_xScrollPosition && new_y == m_yScrollPosition )
1476 return; // nothing to do, the position didn't change
1477
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();
1482
1483 // update the position and scroll the window now:
1484 if (m_xScrollPosition != new_x)
1485 {
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,
1490 GetScrollRect() );
1491 }
1492
1493 if (m_yScrollPosition != new_y)
1494 {
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,
1499 GetScrollRect() );
1500 }
1501}
1502
1503#endif // wxHAS_GENERIC_SCROLLWIN
1504
1e6feb95 1505// ----------------------------------------------------------------------------
16361ec9 1506// wxScrolled<T> and wxScrolledWindow implementation
1e6feb95
VZ
1507// ----------------------------------------------------------------------------
1508
16361ec9 1509wxSize wxScrolledT_Helper::FilterBestSize(const wxWindow *win,
29e1398f 1510 const wxScrollHelper *helper,
16361ec9 1511 const wxSize& origBest)
7d616e99
VS
1512{
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).
1518
16361ec9 1519 wxSize best = origBest;
7d616e99 1520
16361ec9 1521 if ( win->GetAutoLayout() )
7d616e99
VS
1522 {
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
1526 int ppuX, ppuY;
16361ec9 1527 helper->GetScrollPixelsPerUnit(&ppuX, &ppuY);
7d616e99
VS
1528
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
1535 // available to it.
1536 //
1537 // See also http://svn.wxwidgets.org/viewvc/wx?view=rev&revision=45864
1538
16361ec9 1539 wxSize minSize = win->GetMinSize();
7d616e99
VS
1540
1541 if ( ppuX > 0 )
1542 best.x = minSize.x + wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
1543
1544 if ( ppuY > 0 )
1545 best.y = minSize.y + wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y);
1546 }
1547
1548 return best;
1549}
1550
0cf5b099 1551#ifdef __WXMSW__
f2a6c918 1552WXLRESULT wxScrolledT_Helper::FilterMSWWindowProc(WXUINT nMsg, WXLRESULT rc)
0cf5b099 1553{
4676948b 1554#ifndef __WXWINCE__
0cf5b099
VZ
1555 // we need to process arrows ourselves for scrolling
1556 if ( nMsg == WM_GETDLGCODE )
1557 {
1558 rc |= DLGC_WANTARROWS;
1559 }
4676948b 1560#endif
0cf5b099
VZ
1561 return rc;
1562}
0cf5b099 1563#endif // __WXMSW__
16361ec9
VS
1564
1565// NB: skipping wxScrolled<T> in wxRTTI information because being a templte,
1566// it doesn't and can't implement wxRTTI support
1567IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow, wxPanel)