1 /////////////////////////////////////////////////////////////////////////////
2 // Name: generic/scrolwin.cpp
3 // Purpose: wxScrolledWindow implementation
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart and Markus Holzem
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "scrolwin.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
32 #include "wx/dcclient.h"
34 #include "wx/generic/scrolwin.h"
42 // For wxRETAINED implementation
43 #ifdef __VMS__ //VMS's Xm.h is not (yet) compatible with C++
44 //This code switches off the compiler warnings
45 # pragma message disable nosimpint
49 # pragma message enable nosimpint
53 // ----------------------------------------------------------------------------
55 // ----------------------------------------------------------------------------
57 BEGIN_EVENT_TABLE(wxScrolledWindow
, wxPanel
)
58 EVT_SCROLLWIN(wxScrolledWindow::OnScroll
)
59 EVT_SIZE(wxScrolledWindow::OnSize
)
60 EVT_PAINT(wxScrolledWindow::OnPaint
)
61 EVT_CHAR(wxScrolledWindow::OnChar
)
64 IMPLEMENT_DYNAMIC_CLASS(wxScrolledWindow
, wxPanel
)
66 // ============================================================================
68 // ============================================================================
70 // ----------------------------------------------------------------------------
71 // wxScrolledWindow creation
72 // ----------------------------------------------------------------------------
74 wxScrolledWindow::wxScrolledWindow()
76 m_xScrollPixelsPerLine
= 0;
77 m_yScrollPixelsPerLine
= 0;
78 m_xScrollingEnabled
= TRUE
;
79 m_yScrollingEnabled
= TRUE
;
80 m_xScrollPosition
= 0;
81 m_yScrollPosition
= 0;
84 m_xScrollLinesPerPage
= 0;
85 m_yScrollLinesPerPage
= 0;
88 m_targetWindow
= (wxWindow
*) NULL
;
91 bool wxScrolledWindow::Create(wxWindow
*parent
,
98 m_xScrollPixelsPerLine
= 0;
99 m_yScrollPixelsPerLine
= 0;
100 m_xScrollingEnabled
= TRUE
;
101 m_yScrollingEnabled
= TRUE
;
102 m_xScrollPosition
= 0;
103 m_yScrollPosition
= 0;
106 m_xScrollLinesPerPage
= 0;
107 m_yScrollLinesPerPage
= 0;
111 m_targetWindow
= this;
113 // we need wxWANTS_CHARS to process arrows ourselves
114 return wxPanel::Create(parent
, id
, pos
, size
, style
| wxWANTS_CHARS
, name
);
117 wxScrolledWindow::~wxScrolledWindow()
121 // ----------------------------------------------------------------------------
122 // setting scrolling parameters
123 // ----------------------------------------------------------------------------
126 * pixelsPerUnitX/pixelsPerUnitY: number of pixels per unit (e.g. pixels per text line)
127 * noUnitsX/noUnitsY: : no. units per scrollbar
129 void wxScrolledWindow::SetScrollbars (int pixelsPerUnitX
, int pixelsPerUnitY
,
130 int noUnitsX
, int noUnitsY
,
131 int xPos
, int yPos
, bool noRefresh
)
135 CalcUnscrolledPosition(xPos
, yPos
, &xpos
, &ypos
);
138 (noUnitsX
!= 0 && m_xScrollLines
== 0) ||
139 (noUnitsX
< m_xScrollLines
&& xpos
> pixelsPerUnitX
*noUnitsX
) ||
141 (noUnitsY
!= 0 && m_yScrollLines
== 0) ||
142 (noUnitsY
< m_yScrollLines
&& ypos
> pixelsPerUnitY
*noUnitsY
) ||
143 (xPos
!= m_xScrollPosition
) ||
144 (yPos
!= m_yScrollPosition
)
145 // (pixelsPerUnitX != m_xScrollPixelsPerLine) ||
146 // (pixelsPerUnitY != m_yScrollPixelsPerLine)
149 m_xScrollPixelsPerLine
= pixelsPerUnitX
;
150 m_yScrollPixelsPerLine
= pixelsPerUnitY
;
151 m_xScrollPosition
= xPos
;
152 m_yScrollPosition
= yPos
;
153 m_xScrollLines
= noUnitsX
;
154 m_yScrollLines
= noUnitsY
;
157 // Sorry, some Motif-specific code to implement a backing pixmap
158 // for the wxRETAINED style. Implementing a backing store can't
159 // be entirely generic because it relies on the wxWindowDC implementation
160 // to duplicate X drawing calls for the backing pixmap.
162 if ((m_windowStyle
& wxRETAINED
) == wxRETAINED
)
164 Display
* dpy
= XtDisplay((Widget
) GetMainWidget());
166 int totalPixelWidth
= m_xScrollLines
* m_xScrollPixelsPerLine
;
167 int totalPixelHeight
= m_yScrollLines
* m_yScrollPixelsPerLine
;
168 if (m_backingPixmap
&&
169 !((m_pixmapWidth
== totalPixelWidth
) &&
170 (m_pixmapHeight
== totalPixelHeight
)))
172 XFreePixmap (dpy
, (Pixmap
) m_backingPixmap
);
173 m_backingPixmap
= (WXPixmap
) 0;
176 if (!m_backingPixmap
&&
177 (noUnitsX
!= 0) && (noUnitsY
!= 0))
179 int depth
= wxDisplayDepth();
180 m_pixmapWidth
= totalPixelWidth
;
181 m_pixmapHeight
= totalPixelHeight
;
182 m_backingPixmap
= (WXPixmap
) XCreatePixmap (dpy
, RootWindow (dpy
, DefaultScreen (dpy
)),
183 m_pixmapWidth
, m_pixmapHeight
, depth
);
191 if (do_refresh
&& !noRefresh
)
192 m_targetWindow
->Refresh();
195 // GRG: if this turns out to be really necessary, we could
196 // at least move it to the above if { ... } so that it is
197 // only done if noRefresh = FALSE (the default). OTOH, if
198 // this doesn't break anything, which seems to be the
199 // case, we could just leave it out.
202 // UpdateWindow ((HWND) m_targetWindow->GetHWND());
205 m_targetWindow
->MacUpdateImmediately() ;
209 // ----------------------------------------------------------------------------
210 // target window handling
211 // ----------------------------------------------------------------------------
213 void wxScrolledWindow::SetTargetWindow( wxWindow
*target
)
215 wxASSERT_MSG( target
, wxT("target window must not be NULL") );
216 m_targetWindow
= target
;
219 wxWindow
*wxScrolledWindow::GetTargetWindow()
221 return m_targetWindow
;
224 // ----------------------------------------------------------------------------
225 // scrolling implementation itself
226 // ----------------------------------------------------------------------------
228 void wxScrolledWindow::OnScroll(wxScrollWinEvent
& event
)
230 int orient
= event
.GetOrientation();
232 int nScrollInc
= CalcScrollInc(event
);
233 if (nScrollInc
== 0) return;
235 if (orient
== wxHORIZONTAL
)
237 int newPos
= m_xScrollPosition
+ nScrollInc
;
238 SetScrollPos(wxHORIZONTAL
, newPos
, TRUE
);
242 int newPos
= m_yScrollPosition
+ nScrollInc
;
243 SetScrollPos(wxVERTICAL
, newPos
, TRUE
);
246 if (orient
== wxHORIZONTAL
)
248 m_xScrollPosition
+= nScrollInc
;
252 m_yScrollPosition
+= nScrollInc
;
255 if (orient
== wxHORIZONTAL
)
257 if (m_xScrollingEnabled
)
258 m_targetWindow
->ScrollWindow(-m_xScrollPixelsPerLine
* nScrollInc
, 0, (const wxRect
*) NULL
);
260 m_targetWindow
->Refresh();
264 if (m_yScrollingEnabled
)
265 m_targetWindow
->ScrollWindow(0, -m_yScrollPixelsPerLine
* nScrollInc
, (const wxRect
*) NULL
);
267 m_targetWindow
->Refresh();
270 m_targetWindow
->MacUpdateImmediately() ;
274 int wxScrolledWindow::CalcScrollInc(wxScrollWinEvent
& event
)
276 int pos
= event
.GetPosition();
277 int orient
= event
.GetOrientation();
280 switch (event
.GetEventType())
282 case wxEVT_SCROLLWIN_TOP
:
284 if (orient
== wxHORIZONTAL
)
285 nScrollInc
= - m_xScrollPosition
;
287 nScrollInc
= - m_yScrollPosition
;
290 case wxEVT_SCROLLWIN_BOTTOM
:
292 if (orient
== wxHORIZONTAL
)
293 nScrollInc
= m_xScrollLines
- m_xScrollPosition
;
295 nScrollInc
= m_yScrollLines
- m_yScrollPosition
;
298 case wxEVT_SCROLLWIN_LINEUP
:
303 case wxEVT_SCROLLWIN_LINEDOWN
:
308 case wxEVT_SCROLLWIN_PAGEUP
:
310 if (orient
== wxHORIZONTAL
)
311 nScrollInc
= -GetScrollPageSize(wxHORIZONTAL
);
313 nScrollInc
= -GetScrollPageSize(wxVERTICAL
);
316 case wxEVT_SCROLLWIN_PAGEDOWN
:
318 if (orient
== wxHORIZONTAL
)
319 nScrollInc
= GetScrollPageSize(wxHORIZONTAL
);
321 nScrollInc
= GetScrollPageSize(wxVERTICAL
);
324 case wxEVT_SCROLLWIN_THUMBTRACK
:
325 case wxEVT_SCROLLWIN_THUMBRELEASE
:
327 if (orient
== wxHORIZONTAL
)
328 nScrollInc
= pos
- m_xScrollPosition
;
330 nScrollInc
= pos
- m_yScrollPosition
;
339 if (orient
== wxHORIZONTAL
)
341 if (m_xScrollPixelsPerLine
> 0)
344 m_targetWindow
->GetClientSize(&w
, &h
);
346 int nMaxWidth
= m_xScrollLines
*m_xScrollPixelsPerLine
;
347 int noPositions
= (int) ( ((nMaxWidth
- w
)/(double)m_xScrollPixelsPerLine
) + 0.5 );
351 if ( (m_xScrollPosition
+ nScrollInc
) < 0 )
352 nScrollInc
= -m_xScrollPosition
; // As -ve as we can go
353 else if ( (m_xScrollPosition
+ nScrollInc
) > noPositions
)
354 nScrollInc
= noPositions
- m_xScrollPosition
; // As +ve as we can go
357 m_targetWindow
->Refresh();
361 if (m_yScrollPixelsPerLine
> 0)
364 m_targetWindow
->GetClientSize(&w
, &h
);
366 int nMaxHeight
= m_yScrollLines
*m_yScrollPixelsPerLine
;
367 int noPositions
= (int) ( ((nMaxHeight
- h
)/(double)m_yScrollPixelsPerLine
) + 0.5 );
371 if ( (m_yScrollPosition
+ nScrollInc
) < 0 )
372 nScrollInc
= -m_yScrollPosition
; // As -ve as we can go
373 else if ( (m_yScrollPosition
+ nScrollInc
) > noPositions
)
374 nScrollInc
= noPositions
- m_yScrollPosition
; // As +ve as we can go
377 m_targetWindow
->Refresh();
383 // Adjust the scrollbars - new version.
384 void wxScrolledWindow::AdjustScrollbars()
387 m_targetWindow
->GetClientSize(&w
, &h
);
389 int oldXScroll
= m_xScrollPosition
;
390 int oldYScroll
= m_yScrollPosition
;
392 if (m_xScrollLines
> 0)
394 // Calculate page size i.e. number of scroll units you get on the
395 // current client window
396 int noPagePositions
= (int) ( (w
/(double)m_xScrollPixelsPerLine
) + 0.5 );
397 if (noPagePositions
< 1) noPagePositions
= 1;
399 // Correct position if greater than extent of canvas minus
400 // the visible portion of it or if below zero
401 m_xScrollPosition
= wxMin( m_xScrollLines
-noPagePositions
, m_xScrollPosition
);
402 m_xScrollPosition
= wxMax( 0, m_xScrollPosition
);
404 SetScrollbar(wxHORIZONTAL
, m_xScrollPosition
, noPagePositions
, m_xScrollLines
);
405 // The amount by which we scroll when paging
406 SetScrollPageSize(wxHORIZONTAL
, noPagePositions
);
410 m_xScrollPosition
= 0;
411 SetScrollbar (wxHORIZONTAL
, 0, 0, 0, FALSE
);
414 if (m_yScrollLines
> 0)
416 // Calculate page size i.e. number of scroll units you get on the
417 // current client window
418 int noPagePositions
= (int) ( (h
/(double)m_yScrollPixelsPerLine
) + 0.5 );
419 if (noPagePositions
< 1) noPagePositions
= 1;
421 // Correct position if greater than extent of canvas minus
422 // the visible portion of it or if below zero
423 m_yScrollPosition
= wxMin( m_yScrollLines
-noPagePositions
, m_yScrollPosition
);
424 m_yScrollPosition
= wxMax( 0, m_yScrollPosition
);
426 SetScrollbar(wxVERTICAL
, m_yScrollPosition
, noPagePositions
, m_yScrollLines
);
427 // The amount by which we scroll when paging
428 SetScrollPageSize(wxVERTICAL
, noPagePositions
);
432 m_yScrollPosition
= 0;
433 SetScrollbar (wxVERTICAL
, 0, 0, 0, FALSE
);
436 if (oldXScroll
!= m_xScrollPosition
)
438 if (m_xScrollingEnabled
)
439 m_targetWindow
->ScrollWindow( m_xScrollPixelsPerLine
* (oldXScroll
-m_xScrollPosition
), 0, (const wxRect
*) NULL
);
441 m_targetWindow
->Refresh();
444 if (oldYScroll
!= m_yScrollPosition
)
446 if (m_yScrollingEnabled
)
447 m_targetWindow
->ScrollWindow( 0, m_yScrollPixelsPerLine
* (oldYScroll
-m_yScrollPosition
), (const wxRect
*) NULL
);
449 m_targetWindow
->Refresh();
453 // Override this function if you don't want to have wxScrolledWindow
454 // automatically change the origin according to the scroll position.
455 void wxScrolledWindow::PrepareDC(wxDC
& dc
)
457 dc
.SetDeviceOrigin( -m_xScrollPosition
* m_xScrollPixelsPerLine
,
458 -m_yScrollPosition
* m_yScrollPixelsPerLine
);
459 dc
.SetUserScale( m_scaleX
, m_scaleY
);
462 #if WXWIN_COMPATIBILITY
463 void wxScrolledWindow::GetScrollUnitsPerPage (int *x_page
, int *y_page
) const
465 *x_page
= GetScrollPageSize(wxHORIZONTAL
);
466 *y_page
= GetScrollPageSize(wxVERTICAL
);
469 void wxScrolledWindow::CalcUnscrolledPosition(int x
, int y
, float *xx
, float *yy
) const
472 *xx
= (float)(x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
);
474 *yy
= (float)(y
+ m_yScrollPosition
* m_yScrollPixelsPerLine
);
476 #endif // WXWIN_COMPATIBILITY
478 void wxScrolledWindow::GetScrollPixelsPerUnit (int *x_unit
, int *y_unit
) const
481 *x_unit
= m_xScrollPixelsPerLine
;
483 *y_unit
= m_yScrollPixelsPerLine
;
486 int wxScrolledWindow::GetScrollPageSize(int orient
) const
488 if ( orient
== wxHORIZONTAL
)
489 return m_xScrollLinesPerPage
;
491 return m_yScrollLinesPerPage
;
494 void wxScrolledWindow::SetScrollPageSize(int orient
, int pageSize
)
496 if ( orient
== wxHORIZONTAL
)
497 m_xScrollLinesPerPage
= pageSize
;
499 m_yScrollLinesPerPage
= pageSize
;
503 * Scroll to given position (scroll position, not pixel position)
505 void wxScrolledWindow::Scroll( int x_pos
, int y_pos
)
510 if (((x_pos
== -1) || (x_pos
== m_xScrollPosition
)) &&
511 ((y_pos
== -1) || (y_pos
== m_yScrollPosition
))) return;
514 m_targetWindow
->GetClientSize(&w
, &h
);
518 int old_x
= m_xScrollPosition
;
519 m_xScrollPosition
= x_pos
;
521 // Calculate page size i.e. number of scroll units you get on the
522 // current client window
523 int noPagePositions
= (int) ( (w
/(double)m_xScrollPixelsPerLine
) + 0.5 );
524 if (noPagePositions
< 1) noPagePositions
= 1;
526 // Correct position if greater than extent of canvas minus
527 // the visible portion of it or if below zero
528 m_xScrollPosition
= wxMin( m_xScrollLines
-noPagePositions
, m_xScrollPosition
);
529 m_xScrollPosition
= wxMax( 0, m_xScrollPosition
);
531 if (old_x
== m_xScrollPosition
) return;
533 m_targetWindow
->SetScrollPos( wxHORIZONTAL
, m_xScrollPosition
, TRUE
);
534 m_targetWindow
->ScrollWindow( (old_x
-m_xScrollPosition
)*m_xScrollPixelsPerLine
, 0 );
538 int old_y
= m_yScrollPosition
;
539 m_yScrollPosition
= y_pos
;
541 // Calculate page size i.e. number of scroll units you get on the
542 // current client window
543 int noPagePositions
= (int) ( (h
/(double)m_yScrollPixelsPerLine
) + 0.5 );
544 if (noPagePositions
< 1) noPagePositions
= 1;
546 // Correct position if greater than extent of canvas minus
547 // the visible portion of it or if below zero
548 m_yScrollPosition
= wxMin( m_yScrollLines
-noPagePositions
, m_yScrollPosition
);
549 m_yScrollPosition
= wxMax( 0, m_yScrollPosition
);
551 if (old_y
== m_yScrollPosition
) return;
553 m_targetWindow
->SetScrollPos( wxVERTICAL
, m_yScrollPosition
, TRUE
);
554 m_targetWindow
->ScrollWindow( 0, (old_y
-m_yScrollPosition
)*m_yScrollPixelsPerLine
);
558 m_targetWindow
->MacUpdateImmediately();
562 void wxScrolledWindow::EnableScrolling (bool x_scroll
, bool y_scroll
)
564 m_xScrollingEnabled
= x_scroll
;
565 m_yScrollingEnabled
= y_scroll
;
568 void wxScrolledWindow::GetVirtualSize (int *x
, int *y
) const
571 *x
= m_xScrollPixelsPerLine
* m_xScrollLines
;
573 *y
= m_yScrollPixelsPerLine
* m_yScrollLines
;
576 // Where the current view starts from
577 void wxScrolledWindow::GetViewStart (int *x
, int *y
) const
580 *x
= m_xScrollPosition
;
582 *y
= m_yScrollPosition
;
585 void wxScrolledWindow::CalcScrolledPosition(int x
, int y
, int *xx
, int *yy
) const
588 *xx
= x
- m_xScrollPosition
* m_xScrollPixelsPerLine
;
590 *yy
= y
- m_yScrollPosition
* m_yScrollPixelsPerLine
;
593 void wxScrolledWindow::CalcUnscrolledPosition(int x
, int y
, int *xx
, int *yy
) const
596 *xx
= x
+ m_xScrollPosition
* m_xScrollPixelsPerLine
;
598 *yy
= y
+ m_yScrollPosition
* m_yScrollPixelsPerLine
;
601 // ----------------------------------------------------------------------------
603 // ----------------------------------------------------------------------------
605 // Default OnSize resets scrollbars, if any
606 void wxScrolledWindow::OnSize(wxSizeEvent
& WXUNUSED(event
))
608 #if wxUSE_CONSTRAINTS
616 // This calls OnDraw, having adjusted the origin according to the current
618 void wxScrolledWindow::OnPaint(wxPaintEvent
& WXUNUSED(event
))
626 // kbd handling: notice that we use OnChar() and not OnKeyDown() for
627 // compatibility here - if we used OnKeyDown(), the programs which process
628 // arrows themselves in their OnChar() would never get the message and like
629 // this they always have the priority
630 void wxScrolledWindow::OnChar(wxKeyEvent
& event
)
632 int stx
, sty
, // view origin
633 szx
, szy
, // view size (total)
634 clix
, cliy
; // view size (on screen)
636 ViewStart(&stx
, &sty
);
637 GetClientSize(&clix
, &cliy
);
638 GetVirtualSize(&szx
, &szy
);
640 if( m_xScrollPixelsPerLine
)
642 clix
/= m_xScrollPixelsPerLine
;
643 szx
/= m_xScrollPixelsPerLine
;
650 if( m_yScrollPixelsPerLine
)
652 cliy
/= m_yScrollPixelsPerLine
;
653 szy
/= m_yScrollPixelsPerLine
;
661 switch ( event
.KeyCode() )
665 Scroll(-1, sty
- (5 * cliy
/ 6));
670 Scroll(-1, sty
+ (5 * cliy
/ 6));
674 Scroll(0, event
.ControlDown() ? 0 : -1);
678 Scroll(szx
- clix
, event
.ControlDown() ? szy
- cliy
: -1);