]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scrolwin.tex
fixed indentation in case there's only one cell on line
[wxWidgets.git] / docs / latex / wx / scrolwin.tex
index 9507fb04be19e14852e61d0267d47750e328d84e..cb984551af15f0ca6b9a40845a45d4160f9c20f6 100644 (file)
@@ -4,20 +4,20 @@ 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 wxWindows, there are several ways to use a
+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
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}.
-This is the way it used to be in any previous version of wxWindows
+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 \helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize},
 or \helpref{wxWindow::FitInside}{wxwindowfitinside}, and setting the
-scrolling increments for it by calling
+scrolling increments for it by calling 
 \helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.
 Scrolling in some orientation is enabled by setting a non zero increment
 for it.
@@ -34,7 +34,7 @@ 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
+ 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
@@ -97,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}}}
 
@@ -211,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}
 
@@ -310,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}
 
@@ -384,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.
 
@@ -402,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}
 
@@ -435,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}
@@ -445,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).