Remove use of GetVolumeInformation since it causes long delays on network drives.

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

diff --git a/docs/latex/wx/scrolwin.tex b/docs/latex/wx/scrolwin.tex
index f7f83b067742dc11e0723a1c36ff08a6f3b67d95..23c1ec00cdf8804e89cb770135091d607a6b622e 100644 (file)
--- a/docs/latex/wx/scrolwin.tex
+++ b/docs/latex/wx/scrolwin.tex
@@ -4,13 +4,13 @@ The wxScrolledWindow class manages scrolling for its client area, transforming
 the coordinates according to the scrollbar positions, and setting the
 scroll positions, thumb sizes and ranges according to the area in view.
 
 the coordinates according to the scrollbar positions, and setting the
 scroll positions, thumb sizes and ranges according to the area in view.
 

-Starting from version 2.4 of wxWindows, there are several ways to use a
+Starting from version 2.4 of wxWidgets, there are several ways to use a

 wxScrolledWindow. In particular, there are now three ways to set the
 size of the scrolling area:
 
 One way is to set the scrollbars directly using a call to
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}.
 wxScrolledWindow. In particular, there are now three ways to set the
 size of the scrolling area:
 
 One way is to set the scrollbars directly using a call to
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}.

-This is the way it used to be in any previous version of wxWindows
+This is the way it used to be in any previous version of wxWidgets

 and it will be kept for backwards compatibility.
 
 An additional method of manual control, which requires a little less
 and it will be kept for backwards compatibility.
 
 An additional method of manual control, which requires a little less


@@ -19,7 +19,7 @@ calling either \helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize},
 or \helpref{wxWindow::FitInside}{wxwindowfitinside}, and setting the
 scrolling increments for it by calling 
 \helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.
 or \helpref{wxWindow::FitInside}{wxwindowfitinside}, and setting the
 scrolling increments for it by calling 
 \helpref{wxScrolledWindow::SetScrollRate}{wxscrolledwindowsetscrollrate}.

-Scrolling in some orientation is enabled by setting a non zero increment
+Scrolling in some orientation is enabled by setting a non-zero increment

 for it.
 
 The most automatic and newest way is to simply let sizers determine the
 for it.
 
 The most automatic and newest way is to simply let sizers determine the


@@ -34,7 +34,7 @@ increment.  You can influence the minimum size of the scrolled area
 controlled by a sizer by calling
 \helpref{wxWindow::SetVirtualSizeHints}{wxwindowsetvirtualsizehints}.
 (calling \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}
 controlled by a sizer by calling
 \helpref{wxWindow::SetVirtualSizeHints}{wxwindowsetvirtualsizehints}.
 (calling \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}

- has analogous effects in wxWindows 2.4 -- in later versions it may not continue
+ has analogous effects in wxWidgets 2.4 -- in later versions it may not continue

  to override the sizer)
 
 Note:  if Maximum size hints are still supported by SetVirtualSizeHints, use
  to override the sizer)
 
 Note:  if Maximum size hints are still supported by SetVirtualSizeHints, use


@@ -47,10 +47,11 @@ As with all windows, an application can draw onto a wxScrolledWindow using
 a \helpref{device context}{dcoverview}.
 
 You have the option of handling the OnPaint handler
 a \helpref{device context}{dcoverview}.
 
 You have the option of handling the OnPaint handler

-or overriding the \helpref{OnDraw}{wxscrolledwindowondraw} function, which is passed
-a pre-scrolled device context (prepared by \helpref{PrepareDC}{wxscrolledwindowpreparedc}).
+or overriding the \helpref{OnDraw}{wxscrolledwindowondraw} function, which is
+passed a pre-scrolled device context (prepared by 
+\helpref{DoPrepareDC}{wxscrolledwindowdopreparedc}).

 
 

-If you don't wish to calculate your own scrolling, you must call PrepareDC when not drawing from
+If you don't wish to calculate your own scrolling, you must call DoPrepareDC when not drawing from

 within OnDraw, to set the device origin for the device context according to the current
 scroll position.
 
 within OnDraw, to set the device origin for the device context according to the current
 scroll position.
 


@@ -97,11 +98,13 @@ to build your own scroll behaviour.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxClientDC}{wxclientdc}, \helpref{wxPaintDC}{wxpaintdc}
+\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxClientDC}{wxclientdc},\\
+\helpref{wxPaintDC}{wxpaintdc}, \helpref{wxVScrolledWindow}{wxvscrolledwindow}

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxScrolledWindow::wxScrolledWindow}\label{wxscrolledwindowconstr}
+
+\membersection{wxScrolledWindow::wxScrolledWindow}\label{wxscrolledwindowctor}

 
 \func{}{wxScrolledWindow}{\void}
 
 
 \func{}{wxScrolledWindow}{\void}
 


@@ -135,12 +138,14 @@ The window is initially created without visible scrollbars.
 Call \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars} to
 specify how big the virtual window size should be.
 
 Call \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars} to
 specify how big the virtual window size should be.
 

-\membersection{wxScrolledWindow::\destruct{wxScrolledWindow}}
+
+\membersection{wxScrolledWindow::\destruct{wxScrolledWindow}}\label{wxscrolledwindowdtor}

 
 \func{}{\destruct{wxScrolledWindow}}{\void}
 
 Destructor.
 
 
 \func{}{\destruct{wxScrolledWindow}}{\void}
 
 Destructor.
 

+

 \membersection{wxScrolledWindow::CalcScrolledPosition}\label{wxscrolledwindowcalcscrolledposition}
 
 \constfunc{void}{CalcScrolledPosition}{
 \membersection{wxScrolledWindow::CalcScrolledPosition}\label{wxscrolledwindowcalcscrolledposition}
 
 \constfunc{void}{CalcScrolledPosition}{


@@ -164,6 +169,7 @@ 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 )}.}
 
 \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}{
 \membersection{wxScrolledWindow::CalcUnscrolledPosition}\label{wxscrolledwindowcalcunscrolledposition}
 
 \constfunc{void}{CalcUnscrolledPosition}{


@@ -187,6 +193,7 @@ 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 )}.}
 
 \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
 \membersection{wxScrolledWindow::Create}\label{wxscrolledwindowcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id = -1},\rtfsp


@@ -194,9 +201,10 @@ parameters and returns xx and yy as a tuple of values.}
 \param{long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}}
 
 Creates the window for two-step construction. Derived classes
 \param{long}{ style = wxHSCROLL \pipe wxVSCROLL}, \param{const wxString\& }{name = ``scrolledWindow"}}
 
 Creates the window for two-step construction. Derived classes

-should call or replace this function. See \helpref{wxScrolledWindow::wxScrolledWindow}{wxscrolledwindowconstr}\rtfsp
+should call or replace this function. See \helpref{wxScrolledWindow::wxScrolledWindow}{wxscrolledwindowctor}\rtfsp

 for details.
 
 for details.
 

+

 \membersection{wxScrolledWindow::EnableScrolling}\label{wxscrolledwindowenablescrolling}
 
 \func{void}{EnableScrolling}{\param{const bool}{ xScrolling}, \param{const bool}{ yScrolling}}
 \membersection{wxScrolledWindow::EnableScrolling}\label{wxscrolledwindowenablescrolling}
 
 \func{void}{EnableScrolling}{\param{const bool}{ xScrolling}, \param{const bool}{ yScrolling}}


@@ -211,15 +219,16 @@ is disabled.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{xScrolling}{If TRUE, enables physical scrolling in the x direction.}
+\docparam{xScrolling}{If true, enables physical scrolling in the x direction.}

 
 

-\docparam{yScrolling}{If TRUE, enables physical scrolling in the y direction.}
+\docparam{yScrolling}{If true, enables physical scrolling in the y direction.}

 
 \wxheading{Remarks}
 
 Physical scrolling may not be available on all platforms. Where it is available, it is enabled
 by default.
 
 
 \wxheading{Remarks}
 
 Physical scrolling may not be available on all platforms. Where it is available, it is enabled
 by default.
 

+

 \membersection{wxScrolledWindow::GetScrollPixelsPerUnit}\label{wxscrolledwindowgetscrollpixelsperunit}
 
 \constfunc{void}{GetScrollPixelsPerUnit}{\param{int* }{xUnit}, \param{int* }{yUnit}}
 \membersection{wxScrolledWindow::GetScrollPixelsPerUnit}\label{wxscrolledwindowgetscrollpixelsperunit}
 
 \constfunc{void}{GetScrollPixelsPerUnit}{\param{int* }{xUnit}, \param{int* }{yUnit}}


@@ -245,6 +254,7 @@ 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 )}.}
 
 \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}}
 \membersection{wxScrolledWindow::GetViewStart}\label{wxscrolledwindowgetviewstart}
 
 \constfunc{void}{GetViewStart}{\param{int* }{x}, \param{int* }{ y}}


@@ -276,6 +286,7 @@ 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 )}.}
 
 \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}}
 \membersection{wxScrolledWindow::GetVirtualSize}\label{wxscrolledwindowgetvirtualsize}
 
 \constfunc{void}{GetVirtualSize}{\param{int* }{x}, \param{int* }{y}}


@@ -306,20 +317,22 @@ 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 )}.}
 
 \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}
 
 \membersection{wxScrolledWindow::IsRetained}\label{wxscrolledwindowisretained}
 
 \constfunc{bool}{IsRetained}{\void}
 

-Motif only: TRUE if the window has a backing bitmap.
+Motif only: true if the window has a backing bitmap.

 
 

-\membersection{wxScrolledWindow::PrepareDC}\label{wxscrolledwindowpreparedc}

 
 

-\func{void}{PrepareDC}{\param{wxDC\& }{dc}}
+\membersection{wxScrolledWindow::DoPrepareDC}\label{wxscrolledwindowdopreparedc}
+
+\func{void}{DoPrepareDC}{\param{wxDC\& }{dc}}

 
 Call this function to prepare the device context for drawing a scrolled image. It
 sets the device origin according to the current scroll position.
 
 
 Call this function to prepare the device context for drawing a scrolled image. It
 sets the device origin according to the current scroll position.
 

-PrepareDC is called automatically within the default wxScrolledWindow::OnPaint event
+DoPrepareDC is called automatically within the default wxScrolledWindow::OnPaint event

 handler, so your \helpref{wxScrolledWindow::OnDraw}{wxscrolledwindowondraw} override
 will be passed a 'pre-scrolled' device context. However, if you wish to draw from
 outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you must
 handler, so your \helpref{wxScrolledWindow::OnDraw}{wxscrolledwindowondraw} override
 will be passed a 'pre-scrolled' device context. However, if you wish to draw from
 outside of OnDraw (via OnPaint), or you wish to implement OnPaint yourself, you must


@@ -329,7 +342,7 @@ call this function yourself. For example:
 void MyWindow::OnEvent(wxMouseEvent& event)
 {
   wxClientDC dc(this);
 void MyWindow::OnEvent(wxMouseEvent& event)
 {
   wxClientDC dc(this);

-  PrepareDC(dc);
+  DoPrepareDC(dc);

 
   dc.SetPen(*wxBLACK_PEN);
   float x, y;
 
   dc.SetPen(*wxBLACK_PEN);
   float x, y;


@@ -343,18 +356,30 @@ void MyWindow::OnEvent(wxMouseEvent& event)
 }
 \end{verbatim}
 
 }
 \end{verbatim}
 

+

 \membersection{wxScrolledWindow::OnDraw}\label{wxscrolledwindowondraw}
 
 \func{virtual void}{OnDraw}{\param{wxDC\& }{dc}}
 
 Called by the default paint event handler to allow the application to define
 \membersection{wxScrolledWindow::OnDraw}\label{wxscrolledwindowondraw}
 
 \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
-\helpref{wxScrolledWindow::PrepareDC}{wxscrolledwindowpreparedc}.
+painting behaviour without having to worry about calling 
+\helpref{wxScrolledWindow::DoPrepareDC}{wxscrolledwindowdopreparedc}.

 
 Instead of overriding this function you may also just process the paint event
 
 Instead of overriding this function you may also just process the paint event

-in the derived class as usual, but then you will have to call PrepareDC()
+in the derived class as usual, but then you will have to call DoPrepareDC()

 yourself.
 
 yourself.
 

+
+\membersection{wxScrolledWindow::PrepareDC}\label{wxscrolledwindowpreparedc}
+
+\func{void}{PrepareDC}{\param{wxDC\& }{dc}}
+
+This function is for backwards compatibility only and simply calls 
+\helpref{DoPrepareDC}{wxscrolledwindowdopreparedc} now. Notice that it is 
+\emph{not} called by the default paint event handle (DoPrepareDC() is), so
+overriding this method in your derived class is useless.
+
+

 \membersection{wxScrolledWindow::Scroll}\label{wxscrolledwindowscroll}
 
 \func{void}{Scroll}{\param{int}{ x}, \param{int}{ y}}
 \membersection{wxScrolledWindow::Scroll}\label{wxscrolledwindowscroll}
 
 \func{void}{Scroll}{\param{int}{ x}, \param{int}{ y}}


@@ -379,12 +404,13 @@ that direction).
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit}
 
 \helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp
 \helpref{wxScrolledWindow::GetScrollPixelsPerUnit}{wxscrolledwindowgetscrollpixelsperunit}
 

+

 \membersection{wxScrolledWindow::SetScrollbars}\label{wxscrolledwindowsetscrollbars}
 
 \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},\rtfsp
 \membersection{wxScrolledWindow::SetScrollbars}\label{wxscrolledwindowsetscrollbars}
 
 \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},\rtfsp

-\param{bool }{noRefresh = FALSE}}
+\param{bool }{noRefresh = false}}

 
 Sets up vertical and/or horizontal scrollbars.
 
 
 Sets up vertical and/or horizontal scrollbars.
 


@@ -402,7 +428,7 @@ 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.}
+\docparam{noRefresh}{Will not refresh window if true.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -433,6 +459,7 @@ adjusting the scrollbars appropriately.
 
 \helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize}
 
 
 \helpref{wxWindow::SetVirtualSize}{wxwindowsetvirtualsize}
 

+

 \membersection{wxScrolledWindow::SetScrollRate}\label{wxscrolledwindowsetscrollrate}
 
 \func{void}{SetScrollRate}{\param{int}{ xstep}, \param{int}{ ystep}}
 \membersection{wxScrolledWindow::SetScrollRate}\label{wxscrolledwindowsetscrollrate}
 
 \func{void}{SetScrollRate}{\param{int}{ xstep}, \param{int}{ ystep}}


@@ -440,6 +467,7 @@ adjusting the scrollbars appropriately.
 Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit
 parameter in SetScrollbars.
 
 Set the horizontal and vertical scrolling increment only. See the pixelsPerUnit
 parameter in SetScrollbars.
 

+

 \membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow}
 
 \func{void}{SetTargetWindow}{\param{wxWindow* }{window}}
 \membersection{wxScrolledWindow::SetTargetWindow}\label{wxscrolledwindowsettargetwindow}
 
 \func{void}{SetTargetWindow}{\param{wxWindow* }{window}}