X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b32c6ff0624aca1857e5184c4cda675037efaf00..fd495ab3ea1282ddb8bb0cd0fb79fc758ae5fcee:/docs/latex/wx/scrolwin.tex diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex index ef24da24c9..e89c1ae6fc 100644 --- a/docs/latex/wx/scrolwin.tex +++ b/docs/latex/wx/scrolwin.tex @@ -16,7 +16,7 @@ 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'll normally only have to scroll the (usually white) cell area, whereas the +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 \helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} which means that pressing the scrollbars will scroll a different window. @@ -121,6 +121,9 @@ CalcScrolledPosition(0, 0, \&xx, \&yy) will return 10 in yy. \pythonnote{The wxPython version of this methods accepts only two parameters and returns xx and yy as a tuple of values.} +\perlnote{In wxPerl this method takes two parameters and returns a +2-element list {\tt ( xx, yy )}.} + \membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition} \constfunc{void}{CalcUnscrolledPosition}{ @@ -141,6 +144,9 @@ CalcUnscrolledPosition(0, 10, \&xx, \&yy) will return 0 in yy. \pythonnote{The wxPython version of this methods accepts only two parameters and returns xx and yy as a tuple of values.} +\perlnote{In wxPerl this method takes two parameters and returns a +2-element list {\tt ( xx, yy )}.} + \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate} \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp @@ -196,6 +202,8 @@ scrolling in that direction. \pythonnote{The wxPython version of this methods accepts no 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::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize} @@ -224,6 +232,9 @@ to translate these units to logical units. \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::IsRetained}\label{wxscrolledwindowisretained} \constfunc{bool}{IsRetained}{\void} @@ -301,7 +312,8 @@ 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}} +\param{int }{xPos = 0}, \param{int}{ yPos = 0},\rtfsp +\param{bool }{noRefresh = FALSE}} Sets up vertical and/or horizontal scrollbars. @@ -319,6 +331,8 @@ 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.} + \wxheading{Remarks} The first pair of parameters give the number of pixels per `scroll step', i.e. amount @@ -351,9 +365,9 @@ adjusting the scrollbars appropriately. Call this function to tell wxScrolledWindow to perform the actually scrolling on a different window (not on itself). -\membersection{wxScrolledWindow::ViewStart}\label{wxscrolledwindowviewstart} +\membersection{wxScrolledWindow::GetViewStart}\label{wxscrolledwindowgetviewstart} -\constfunc{void}{ViewStart}{\param{int* }{x}, \param{int* }{ y}} +\constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{ y}} Get the position at which the visible portion of the window starts. @@ -379,3 +393,6 @@ by the number of pixels per scroll increment. \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 )}.} +