documented wxCONCAT

[wxWidgets.git] / docs / latex / wx / scrolwin.tex

diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex
index 15c5be4cc1c8ae8fc7544a9309b7687d2aadfe98..58a60fc5335729be1afb6932252700d85c442d71 100644 (file)
--- a/docs/latex/wx/scrolwin.tex
+++ b/docs/latex/wx/scrolwin.tex
@@ -4,7 +4,47 @@ 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.
 
-As with all windows, an application can draw onto a wxScrolledWindow using a \helpref{device context}{dcoverview}.
+Starting from version 2.4 of wxWindows, 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
+\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}.
+This is the way it used to be in any previous version of wxWindows
+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 \helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize},
+or \helpref{wxWindow::FitInside}{wxwindowfitinside}, and setting the
+scrolling increments for it by calling 
+\helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.
+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 \helpref{wxWindow::SetSizer}{wxwindowsetsizer}.
+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 
+\helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.
+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
+\helpref{wxWindow::SetVirtualSizeHints}{wxwindowsetvirtualsizehints}.
+(calling \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
+ has analogous effects in wxWindows 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 \helpref{device context}{dcoverview}.
 
 You have the option of handling the OnPaint handler
 or overriding the \helpref{OnDraw}{wxscrolledwindowondraw} function, which is passed
@@ -57,7 +97,8 @@ to build your own scroll behaviour.
 
 \wxheading{See also}
 
-\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxClientDC}{wxclientdc}, \helpref{wxPaintDC}{wxpaintdc}
+\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxClientDC}{wxclientdc},\\
+\helpref{wxPaintDC}{wxpaintdc}, \helpref{wxVScrolledWindow}{wxvscrolledwindow}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -171,9 +212,9 @@ is disabled.
 
 \wxheading{Parameters}
 
-\docparam{xScrolling}{If TRUE, enables physical scrolling in the x direction.}
+\docparam{xScrolling}{If true, enables physical scrolling in the x direction.}
 
-\docparam{yScrolling}{If TRUE, enables physical scrolling in the y direction.}
+\docparam{yScrolling}{If true, enables physical scrolling in the y direction.}
 
 \wxheading{Remarks}
 
@@ -270,7 +311,7 @@ parameters and returns a tuple of values for x and y.}
 
 \constfunc{bool}{IsRetained}{\void}
 
-Motif only: TRUE if the window has a backing bitmap.
+Motif only: true if the window has a backing bitmap.
 
 \membersection{wxScrolledWindow::PrepareDC}\label{wxscrolledwindowpreparedc}
 
@@ -344,7 +385,7 @@ that direction).
 \func{void}{SetScrollbars}{\param{int}{ pixelsPerUnitX}, \param{int}{ pixelsPerUnitY},\rtfsp
 \param{int}{ noUnitsX}, \param{int}{ noUnitsY},\rtfsp
 \param{int }{xPos = 0}, \param{int}{ yPos = 0},\rtfsp
-\param{bool }{noRefresh = FALSE}}
+\param{bool }{noRefresh = false}}
 
 Sets up vertical and/or horizontal scrollbars.
 
@@ -362,7 +403,7 @@ Sets up vertical and/or horizontal scrollbars.
 
 \docparam{yPos}{Position to initialize the scrollbars in the vertical direction, in scroll units.}
 
-\docparam{noRefresh}{Will not refresh window if TRUE.}
+\docparam{noRefresh}{Will not refresh window if true.}
 
 \wxheading{Remarks}
 
@@ -395,9 +436,9 @@ adjusting the scrollbars appropriately.
 
 \membersection{wxScrolledWindow::SetScrollRate}\label{wxscrolledwindowsetscrollrate}
 
-\func{void}{SetScrollRate}{\param{int}{xstep}, \param{int}{ystep}}
+\func{void}{SetScrollRate}{\param{int}{ xstep}, \param{int}{ ystep}}
 
-Set the horizontal and vertical scrolling increment only.  See the pixelsPerUnit
+Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit
 parameter in SetScrollbars.
 
 \membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow}
@@ -405,5 +446,5 @@ parameter in SetScrollbars.
 \func{void}{SetTargetWindow}{\param{wxWindow* }{window}}
 
 Call this function to tell wxScrolledWindow to perform the actual scrolling on
-a different window (not on itself).
+a different window (and not on itself).