1. exchanged binary ROPs wxSET/wxCLEAR meaning for wxMSW to match wxGTK

[wxWidgets.git] / docs / latex / wx / scrolwin.tex

diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex
index e8a364b9002ae125be53110e5094ce9ed9d75da3..8224091442a344ec088319576f6123980af6c30d 100644 (file)
--- a/docs/latex/wx/scrolwin.tex
+++ b/docs/latex/wx/scrolwin.tex
@@ -22,7 +22,7 @@ call \helpref{SetTargetWindow}{wxscrolledwindowsettargetwindow} which means that
 the scrollbars will scroll a different window.
 
 Note that the underlying system knows nothing about scrolling coordinates, so that all system
 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).
 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,9 @@ CalcScrolledPosition(0, 0, \&xx, \&yy) will return 10 in yy.
 
 \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
 
 
 \helpref{CalcUnscrolledPosition}{wxscrolledwindowcalcunscrolledposition}
 

+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+

 \membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition}
 
 \constfunc{void}{CalcUnscrolledPosition}{
 \membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition}
 
 \constfunc{void}{CalcUnscrolledPosition}{


@@ -135,6 +138,9 @@ CalcUnscrolledPosition(0, 10, \&xx, \&yy) will return 0 in yy.
 
 \helpref{CalcScrolledPosition}{wxscrolledwindowcalcscrolledposition}
 
 
 \helpref{CalcScrolledPosition}{wxscrolledwindowcalcscrolledposition}
 

+\pythonnote{The wxPython version of this methods accepts only two
+parameters and returns xx and yy as a tuple of values.}
+

 \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp
 \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp


@@ -187,6 +193,10 @@ scrolling in that direction.
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetVirtualSize}{wxscrolledwindowgetvirtualsize}
 
 \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.}
+
+

 \membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
 
 \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}
 \membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
 
 \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}


@@ -211,6 +221,9 @@ to translate these units to logical units.
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit}
 
 \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.}
+

 \membersection{wxScrolledWindow::IsRetained}\label{wxscrolledwindowisretained}
 
 \constfunc{bool}{IsRetained}{\void}
 \membersection{wxScrolledWindow::IsRetained}\label{wxscrolledwindowisretained}
 
 \constfunc{bool}{IsRetained}{\void}


@@ -253,7 +266,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
 \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
 \helpref{wxScrolledWindow::PrepareDC}{wxscrolledwindowpreparedc}.
 
 Instead of overriding this function you may also just process the paint event


@@ -288,7 +301,8 @@ that direction).
 
 \func{void}{SetScrollbars}{\param{int}{ pixelsPerUnitX}, \param{int}{ pixelsPerUnitY},\rtfsp
 \param{int}{ noUnitsX}, \param{int}{ noUnitsY},\rtfsp
 
 \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.
 
 
 Sets up vertical and/or horizontal scrollbars.
 


@@ -306,6 +320,8 @@ Sets up vertical and/or horizontal scrollbars.
 
 \docparam{yPos}{Position to initialize the scrollbars in the vertical direction, in scroll units.}
 
 
 \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
 \wxheading{Remarks}
 
 The first pair of parameters give the number of pixels per `scroll step', i.e. amount


@@ -338,9 +354,9 @@ adjusting the scrollbars appropriately.
 Call this function to tell wxScrolledWindow to perform the actually scrolling on
 a different window (not on itself).
 
 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.
 
 
 Get the position at which the visible portion of the window starts.
 


@@ -363,3 +379,6 @@ by the number of pixels per scroll increment.
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 

+\pythonnote{The wxPython version of this methods accepts no
+parameters and returns a tuple of values for x and y.}
+