X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/30760ce7e58df02af3308cd7de8bd7694e791b8d..3b50432abf11a0dbdab6b8d4136c3956ce4def1f:/docs/latex/wx/scrolwin.tex diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex index e8a364b900..e89c1ae6fc 100644 --- a/docs/latex/wx/scrolwin.tex +++ b/docs/latex/wx/scrolwin.tex @@ -16,13 +16,13 @@ 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. Note that the underlying system knows nothing about scrolling coordinates, so that all system -functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows +functions (mouse events, expose events, refresh calls etc) as well as the position of subwindows are relative to the "physical" origin of the scrolled window. If the user insert a child window at position (10,10) and scrolls the window down 100 pixels (moving the child window out of the visible area), the child window will report a position of (10,-90). @@ -118,6 +118,12 @@ CalcScrolledPosition(0, 0, \&xx, \&yy) will return 10 in yy. \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition} +\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}{ @@ -135,6 +141,12 @@ CalcUnscrolledPosition(0, 10, \&xx, \&yy) will return 0 in yy. \helpref{CalcScrolledPosition}{wxscrolledwindowcalcscrolledposition} +\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 @@ -187,6 +199,12 @@ scrolling in that direction. \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp \helpref{wxScrolledWindow::GetVirtualSize}{wxscrolledwindowgetvirtualsize} +\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} \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}} @@ -211,6 +229,12 @@ to translate these units to logical units. \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp \helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit} +\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} @@ -253,7 +277,7 @@ void MyWindow::OnEvent(wxMouseEvent& event) \func{virtual void}{OnDraw}{\param{wxDC\& }{dc}} Called by the default paint event handler to allow the application to define -painting behaviour without having to worry about calling +painting behaviour without having to worry about calling \helpref{wxScrolledWindow::PrepareDC}{wxscrolledwindowpreparedc}. Instead of overriding this function you may also just process the paint event @@ -288,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. @@ -306,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 @@ -338,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. @@ -363,3 +390,9 @@ by the number of pixels per scroll increment. \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 )}.} +