X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/783d4c893170286815a6d401d79229d10f9367dc..05dedde7d01d55cde7f13f6b6201e24b5b408344:/docs/latex/wx/scrolwin.tex diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex index 0129bee043..15c5be4cc1 100644 --- a/docs/latex/wx/scrolwin.tex +++ b/docs/latex/wx/scrolwin.tex @@ -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,41 +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{Parameters} - -\docparam{x}{Receives the first visible x position in scroll units.} +\wxheading{See also} -\docparam{y}{Receives the first visible y position in scroll units.} +\helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize} -\wxheading{Remarks} +\membersection{wxScrolledWindow::SetScrollRate}\label{wxscrolledwindowsetscrollrate} -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. +\func{void}{SetScrollRate}{\param{int}{xstep}, \param{int}{ystep}} -\wxheading{See also} +Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit +parameter in SetScrollbars. -\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars} +\membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow} -\pythonnote{The wxPython version of this methods accepts no -parameters and returns a tuple of values for x and y.} +\func{void}{SetTargetWindow}{\param{wxWindow* }{window}} -\perlnote{In wxPerl this method takes no parameters and returns a -2-element list {\tt ( x, y )}.} +Call this function to tell wxScrolledWindow to perform the actual scrolling on +a different window (not on itself).