.\" This is a wxWidgets manpage page generated from the XML docs .TH wxScrolledWindow 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation" .SH NAME wxScrolledWindow \- Window with automatically managed scrollbars .SH DESCRIPTION The wxScrolledWindow class manages scrolling for its client area, transforming the coordinates according to the scrollbar positions, and setting the scroll positions, thumb sizes and ranges according to the area in view. Starting from version 2.4 of wxWidgets, there are several ways to use a wxScrolledWindow. In particular, there are now three ways to set the size of the scrolling area: One way is to set the scrollbars directly using a call to wxScrolledWindow::SetScrollbars . This is the way it used to be in any previous version of wxWidgets and it will be kept for backwards compatibility. An additional method of manual control, which requires a little less computation of your own, is to set the total size of the scrolling area by calling either wxWindow::SetVirtualSize , or wxWindow::FitInside , and setting the scrolling increments for it by calling wxScrolledWindow::SetScrollRate . Scrolling in some orientation is enabled by setting a non zero increment for it. The most automatic and newest way is to simply let sizers determine the scrolling area. This is now the default when you set an interior sizer into a wxScrolledWindow with wxWindow::SetSizer . The scrolling area will be set to the size requested by the sizer and the scrollbars will be assigned for each orientation according to the need for them and the scrolling increment set by wxScrolledWindow::SetScrollRate . As above, scrolling is only enabled in orientations with a non-zero increment. You can influence the minimum size of the scrolled area controlled by a sizer by calling wxWindow::SetVirtualSizeHints . (calling wxScrolledWindow::SetScrollbars has analogous effects in wxWidgets 2.4 -- in later versions it may not continue to override the sizer) Note: if Maximum size hints are still supported by SetVirtualSizeHints, use them at your own dire risk. They may or may not have been removed for 2.4, but it really only makes sense to set minimum size hints here. We should probably replace SetVirtualSizeHints with SetMinVirtualSize or similar and remove it entirely in future. As with all windows, an application can draw onto a wxScrolledWindow using a device context . You have the option of handling the OnPaint handler or overriding the OnDraw function, which is passed a pre-scrolled device context (prepared by DoPrepareDC ). If you don't wish to calculate your own scrolling, you must call DoPrepareDC when not drawing from within OnDraw, to set the device origin for the device context according to the current scroll position. A wxScrolledWindow will normally scroll itself and therefore its child windows as well. It might however be desired to scroll a different window than itself: e.g. when designing a spreadsheet, you will normally only have to scroll the (usually white) cell area, whereas the (usually grey) label area will scroll very differently. For this special purpose, you can call SetTargetWindow which means that pressing the scrollbars will scroll a different window. Note that the underlying system knows nothing about scrolling coordinates, so that all system functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90). .SH REMARKS Use wxScrolledWindow for applications where the user scrolls by a fixed amount, and where a `page' can be interpreted to be the current visible portion of the window. For more sophisticated applications, use the wxScrolledWindow implementation as a guide to build your own scroll behaviour. .SH "PARENTS" wxPanel wxWindow wxEvtHandler wxObject .SH "INCLUDE FILES" wx/scrolwin.h .SH MEMBERS .SS wxScrolledWindow () Default constructor. .SS wxScrolledWindow (wxWindow* parentwxWindowID id = -1const wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxHSCROLLconst wxString& name = ``scrolledWindow") Constructor. .SS ~wxScrolledWindow () Destructor. .SS void CalcScrolledPosition (int xint yint *xxint *yy) Translates the logical coordinates to the device ones. For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcScrolledPosition(0, 10, &xx, &yy) will return 0 in yy. .SS void CalcUnscrolledPosition (int xint yint *xxint *yy) Translates the device coordinates to the logical ones. For example, if a window is scrolled 10 pixels to the bottom, the device coordinates of the origin are (0, 0) (as always), but the logical coordinates are (0, 10) and so the call to CalcUnscrolledPosition(0, 0, &xx, &yy) will return 10 in yy. .SS bool Create (wxWindow* parentwxWindowID id = -1const wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxHSCROLLconst wxString& name = ``scrolledWindow") Creates the window for two-step construction. Derived classes should call or replace this function. See wxScrolledWindow::wxScrolledWindow for details. .SS void EnableScrolling (const bool xScrollingconst bool yScrolling) Enable or disable physical scrolling in the given direction. Physical scrolling is the physical transfer of bits up or down the screen when a scroll event occurs. If the application scrolls by a variable amount (e.g. if there are different font sizes) then physical scrolling will not work, and you should switch it off. Note that you will have to reposition child windows yourself, if physical scrolling is disabled. .SS void GetScrollPixelsPerUnit (int* xUnitint* yUnit) Get the number of pixels per scroll unit (line), in each direction, as set by wxScrolledWindow::SetScrollbars . A value of zero indicates no scrolling in that direction. .SS void GetViewStart (int* xint* y) Get the position at which the visible portion of the window starts. .SS void GetVirtualSize (int* xint* y) Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible). .SS bool IsRetained () Motif only: true if the window has a backing bitmap. .SS void DoPrepareDC (wxDC& dc) Call this function to prepare the device context for drawing a scrolled image. It sets the device origin according to the current scroll position. DoPrepareDC is called automatically within the default wxScrolledWindow::OnPaint event handler, so your wxScrolledWindow::OnDraw override will be passed a 'pre-scrolled' device context. However, if you wish to draw from outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you must call this function yourself. For example: void MyWindow::OnEvent(wxMouseEvent& event) { wxClientDC dc(this); DoPrepareDC(dc); dc.SetPen(*wxBLACK_PEN); float x, y; event.Position(&x, &y); if (xpos > -1 && ypos > -1 && event.Dragging()) { dc.DrawLine(xpos, ypos, x, y); } xpos = x; ypos = y; } .SS virtual void OnDraw (wxDC& dc) Called by the default paint event handler to allow the application to define painting behaviour without having to worry about calling wxScrolledWindow::DoPrepareDC . Instead of overriding this function you may also just process the paint event in the derived class as usual, but then you will have to call DoPrepareDC() yourself. .SS void PrepareDC (wxDC& dc) This function is for backwards compatibility only and simply calls DoPrepareDC now. Notice that it is not called by the default paint event handle (DoPrepareDC() is), so overriding this method in your derived class is useless. .SS void Scroll (int xint y) Scrolls a window so the view start is at the given point. .SS void SetScrollbars (int pixelsPerUnitXint pixelsPerUnitYint noUnitsXint noUnitsYint xPos = 0int yPos = 0bool noRefresh = false) Sets up vertical and/or horizontal scrollbars. .SS void SetScrollRate (int xstepint ystep) Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit parameter in SetScrollbars. .SS void SetTargetWindow (wxWindow* window) Call this function to tell wxScrolledWindow to perform the actual scrolling on a different window (and not on itself). .SH "WINDOW STYLES" .SS wxRETAINED Uses a backing pixmap to speed refreshes. Motif only. .SH "SEE ALSO" wxPanel wxWindow wxEvtHandler wxObject wxScrollBar wxClientDC , wxPaintDC wxVScrolledWindow .SH "AUTHORS" Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.