Mark GetMinSize() as virtual and explain why.

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

diff --git a/docs/latex/wx/vscroll.tex b/docs/latex/wx/vscroll.tex
index d304d6f1726d42bcf46106015e0038590ca1ac00..d75c4775196d3a27a20a3db1655ea78abec2dca4 100644 (file)
--- a/docs/latex/wx/vscroll.tex
+++ b/docs/latex/wx/vscroll.tex
@@ -18,20 +18,20 @@ are shown on the screen need to be measured; or, even, "vertical" because
 this class only supports scrolling in one direction currently (this could
 and probably will change in the future however).
 
 this class only supports scrolling in one direction currently (this could
 and probably will change in the future however).
 

-In any case, this is a generalization of the 
+In any case, this is a generalization of the

 \helpref{wxScrolledWindow}{wxscrolledwindow} class which can be only used when
 all lines have the same height. It lacks some other wxScrolledWindow features
 however, notably there is currently no support for horizontal scrolling; it
 can't scroll another window nor only a rectangle of the window and not its
 entire client area.
 \helpref{wxScrolledWindow}{wxscrolledwindow} class which can be only used when
 all lines have the same height. It lacks some other wxScrolledWindow features
 however, notably there is currently no support for horizontal scrolling; it
 can't scroll another window nor only a rectangle of the window and not its
 entire client area.

- 
-To use this class, you need to derive from it and implement 
+
+To use this class, you need to derive from it and implement

 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} pure virtual
 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} pure virtual

-method. You also must call \helpref{SetLineCount}{wxvscrolledwindowsetlinecount} 
+method. You also must call \helpref{SetLineCount}{wxvscrolledwindowsetlinecount}

 to let the base class know how many lines it should display but from that
 moment on the scrolling is handled entirely by wxVScrolledWindow, you only
 need to draw the visible part of contents in your {\tt OnPaint()} method as
 to let the base class know how many lines it should display but from that
 moment on the scrolling is handled entirely by wxVScrolledWindow, you only
 need to draw the visible part of contents in your {\tt OnPaint()} method as

-usual. You should use \helpref{GetFirstVisibleLine()}{wxvscrolledwindowgetfirstvisibleline} 
+usual. You should use \helpref{GetFirstVisibleLine()}{wxvscrolledwindowgetfirstvisibleline}

 and \helpref{GetLastVisibleLine()}{wxvscrolledwindowgetlastvisibleline} to
 select the lines to display. Note that the device context origin is not shifted
 so the first visible line always appears at the point $(0, 0)$ in physical as
 and \helpref{GetLastVisibleLine()}{wxvscrolledwindowgetlastvisibleline} to
 select the lines to display. Note that the device context origin is not shifted
 so the first visible line always appears at the point $(0, 0)$ in physical as


@@ -39,7 +39,10 @@ well as logical coordinates.
 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxPanel}{wxpanel}
+\helpref{wxPanel}{wxpanel}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -60,7 +63,7 @@ no need to specify it explicitly.
 
 \func{}{wxVScrolledWindow}{\void}
 
 
 \func{}{wxVScrolledWindow}{\void}
 

-Default constructor, you must call \helpref{Create()}{wxvscrolledwindowcreate} 
+Default constructor, you must call \helpref{Create()}{wxvscrolledwindowcreate}

 later.
 
 \wxheading{Parameters}
 later.
 
 \wxheading{Parameters}


@@ -95,7 +98,7 @@ need to specify it explicitly.
 \constfunc{virtual wxCoord}{EstimateTotalHeight}{\void}
 
 This protected function is used internally by wxVScrolledWindow to estimate the
 \constfunc{virtual wxCoord}{EstimateTotalHeight}{\void}
 
 This protected function is used internally by wxVScrolledWindow to estimate the

-total height of the window when \helpref{SetLineCount}{wxvscrolledwindowsetlinecount} 
+total height of the window when \helpref{SetLineCount}{wxvscrolledwindowsetlinecount}

 is called. The default implementation uses the brute force approach if the
 number of the items in the control is small enough. Otherwise, it tries to find
 the average line height using some lines in the beginning, middle and the end.
 is called. The default implementation uses the brute force approach if the
 number of the items in the control is small enough. Otherwise, it tries to find
 the average line height using some lines in the beginning, middle and the end.


@@ -125,7 +128,7 @@ exists only for symmetry with \helpref{GetLastVisibleLine}{wxvscrolledwindowgetl
 
 Returns the index of the last currently visible line. Note that this method
 returns \texttt{(size\_t)-1} (i.e. a huge positive number) if the control is
 
 Returns the index of the last currently visible line. Note that this method
 returns \texttt{(size\_t)-1} (i.e. a huge positive number) if the control is

-empty so if this is possible you should use \helpref{GetVisibleEnd}{wxvscrolledwindowgetvisibleend} 
+empty so if this is possible you should use \helpref{GetVisibleEnd}{wxvscrolledwindowgetvisibleend}

 instead.
 
 \wxheading{See also}
 instead.
 
 \wxheading{See also}


@@ -137,7 +140,7 @@ instead.
 
 \constfunc{size\_t}{GetLineCount}{\void}
 
 
 \constfunc{size\_t}{GetLineCount}{\void}
 

-Get the number of lines this window contains (previously set by 
+Get the number of lines this window contains (previously set by

 \helpref{SetLineCount()}{wxvscrolledwindowsetlinecount})
 
 
 \helpref{SetLineCount()}{wxvscrolledwindowsetlinecount})
 
 


@@ -159,7 +162,7 @@ Returns the index of the first currently visible line.
 Returns the index of the first line after the currently visible one. If the
 return value is $0$ it means that no lines are currently shown (which only
 happens if the control is empty). Note that the index returned by this method
 Returns the index of the first line after the currently visible one. If the
 return value is $0$ it means that no lines are currently shown (which only
 happens if the control is empty). Note that the index returned by this method

-is not always a valid index as it may be equal to \helpref{GetLineCount}{wxvscrolledwindowsetlinecount}.
+is not always a valid index as it may be equal to \helpref{GetLineCount}{wxvscrolledwindowgetlinecount}.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -180,13 +183,13 @@ Return the item at the specified (in physical coordinates) position or
 
 \constfunc{bool}{IsVisible}{\param{size\_t }{line}}
 
 
 \constfunc{bool}{IsVisible}{\param{size\_t }{line}}
 

-Returns {\tt true} if the given line is (at least partially) visible or 
+Returns {\tt true} if the given line is (at least partially) visible or

 {\tt false} otherwise.
 
 
 \membersection{wxVScrolledWindow::OnGetLineHeight}\label{wxvscrolledwindowongetlineheight}
 
 {\tt false} otherwise.
 
 
 \membersection{wxVScrolledWindow::OnGetLineHeight}\label{wxvscrolledwindowongetlineheight}
 

-\constfunc{wxCoord}{OnGetLineHeight}{\param{size\_t }{n}}
+\constfunc{virtual wxCoord}{OnGetLineHeight}{\param{size\_t }{n}}

 
 This protected virtual function must be overridden in the derived class and it
 should return the height of the given line in pixels.
 
 This protected virtual function must be overridden in the derived class and it
 should return the height of the given line in pixels.


@@ -198,14 +201,14 @@ should return the height of the given line in pixels.
 
 \membersection{wxVScrolledWindow::OnGetLinesHint}\label{wxvscrolledwindowongetlineshint}
 
 
 \membersection{wxVScrolledWindow::OnGetLinesHint}\label{wxvscrolledwindowongetlineshint}
 

-\constfunc{void}{OnGetLinesHint}{\param{size\_t }{lineMin}, \param{size\_t }{lineMax}}
+\constfunc{virtual void}{OnGetLinesHint}{\param{size\_t }{lineMin}, \param{size\_t }{lineMax}}

 
 This function doesn't have to be overridden but it may be useful to do
 it if calculating the lines heights is a relatively expensive operation
 as it gives the user code a possibility to calculate several of them at
 once.
 
 
 This function doesn't have to be overridden but it may be useful to do
 it if calculating the lines heights is a relatively expensive operation
 as it gives the user code a possibility to calculate several of them at
 once.
 

-{\tt OnGetLinesHint()} is normally called just before 
+{\tt OnGetLinesHint()} is normally called just before

 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} but you
 shouldn't rely on the latter being called for all lines in the interval
 specified here. It is also possible that OnGetLineHeight() will be
 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} but you
 shouldn't rely on the latter being called for all lines in the interval
 specified here. It is also possible that OnGetLineHeight() will be


@@ -297,4 +300,3 @@ Set the number of lines the window contains: the derived class must
 provide the heights for all lines with indices up to the one given here
 in its \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight}.
 
 provide the heights for all lines with indices up to the one given here
 in its \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight}.
 

-