]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scrolwin.tex
added a more convenient version of wxFileType::GetOpenCommand()
[wxWidgets.git] / docs / latex / wx / scrolwin.tex
index 2cf1f691cd4b785946a6f23d558ae196b839d574..15c5be4cc1c8ae8fc7544a9309b7687d2aadfe98 100644 (file)
@@ -112,7 +112,7 @@ Destructor.
 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, 0, \&xx, \&yy) will return 10 in yy.
+CalcScrolledPosition(0, 10, \&xx, \&yy) will return 0 in yy.
 
 \wxheading{See also}
 
@@ -135,7 +135,7 @@ parameters and returns xx and yy as a tuple of values.}
 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, 10, \&xx, \&yy) will return 0 in yy.
+CalcUnscrolledPosition(0, 0, \&xx, \&yy) will return 10 in yy.
 
 \wxheading{See also}
 
@@ -205,6 +205,37 @@ parameters and returns a tuple of values for xUnit and yUnit.}
 \perlnote{In wxPerl this method takes no parameters and returns a
 2-element list {\tt ( xUnit, yUnit )}.}
 
+\membersection{wxScrolledWindow::GetViewStart}\label{wxscrolledwindowgetviewstart}
+
+\constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{ y}}
+
+Get the position at which the visible portion of the window starts.
+
+\wxheading{Parameters}
+
+\docparam{x}{Receives the first visible x position in scroll units.}
+
+\docparam{y}{Receives the first visible y position in scroll units.}
+
+\wxheading{Remarks}
+
+If either of the scrollbars is not at the home position, {\it x} and/or
+\rtfsp{\it y} will be greater than zero.  Combined with \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize},
+the application can use this function to efficiently redraw only the
+visible portion of the window.  The positions are in logical scroll
+units, not pixels, so to convert to pixels you will have to multiply
+by the number of pixels per scroll increment.
+
+\wxheading{See also}
+
+\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
+
+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+
+\perlnote{In wxPerl this method takes no parameters and returns a
+2-element list {\tt ( x, y )}.}
+
 \membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
 
 \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}
@@ -358,40 +389,21 @@ scroll steps may be variable according to the position in the document, it will
 necessary to derive a new class from wxWindow, overriding {\bf OnSize} and
 adjusting the scrollbars appropriately.
 
-\membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow}
-
-\func{void}{SetTargetWindow}{\param{wxWindow* }{window}}
-
-Call this function to tell wxScrolledWindow to perform the actually scrolling on
-a different window (not on itself).
-
-\membersection{wxScrolledWindow::GetViewStart}\label{wxscrolledwindowgetviewstart}
-
-\constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{ y}}
-
-Get the position at which the visible portion of the window starts.
+\wxheading{See also}
 
-\wxheading{Parameters}
+\helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize}
 
-\docparam{x}{Receives the first visible x position in scroll units.}
+\membersection{wxScrolledWindow::SetScrollRate}\label{wxscrolledwindowsetscrollrate}
 
-\docparam{y}{Receives the first visible y position in scroll units.}
+\func{void}{SetScrollRate}{\param{int}{xstep}, \param{int}{ystep}}
 
-\wxheading{Remarks}
+Set the horizontal and vertical scrolling increment only.  See the pixelsPerUnit
+parameter in SetScrollbars.
 
-If either of the scrollbars is not at the home position, {\it x} and/or
-\rtfsp{\it y} will be greater than zero.  Combined with \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize},
-the application can use this function to efficiently redraw only the
-visible portion of the window.  The positions are in logical scroll
-units, not pixels, so to convert to pixels you will have to multiply
-by the number of pixels per scroll increment.
-
-\wxheading{See also}
+\membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow}
 
-\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
+\func{void}{SetTargetWindow}{\param{wxWindow* }{window}}
 
-\pythonnote{The wxPython version of this methods accepts no
-parameters and returns a tuple of values for x and y.}
+Call this function to tell wxScrolledWindow to perform the actual scrolling on
+a different window (not on itself).
 
-\perlnote{In wxPerl this method takes no parameters and returns a
-2-element list {\tt ( x, y )}.}