[ 1504474 ] Small hyperlink doc fix.

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

diff --git a/docs/latex/wx/vscroll.tex b/docs/latex/wx/vscroll.tex
index 7ed76887165015e1356d2a2b8081a202008d1342..b965f1fd1508affb96a2bccc6848595443662927 100644 (file)
--- a/docs/latex/wx/vscroll.tex
+++ b/docs/latex/wx/vscroll.tex
@@ -115,12 +115,22 @@ try to make the best guess possible.
 
 Returns the index of the first currently visible line.
 
+This is same as \helpref{GetVisibleBegin}{wxvscrolledwindowgetvisiblebegin} and
+exists only for symmetry with \helpref{GetLastVisibleLine}{wxvscrolledwindowgetlastvisibleline}.
+
 
 \membersection{wxVScrolledWindow::GetLastVisibleLine}\label{wxvscrolledwindowgetlastvisibleline}
 
 \constfunc{size\_t}{GetLastVisibleLine}{\void}
 
-Returns the index of the last currently visible line.
+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} 
+instead.
+
+\wxheading{See also}
+
+\helpref{GetFirstVisibleLine}{wxvscrolledwindowgetfirstvisibleline}
 
 
 \membersection{wxVScrolledWindow::GetLineCount}\label{wxvscrolledwindowgetlinecount}
@@ -131,6 +141,31 @@ Get the number of lines this window contains (previously set by
 \helpref{SetLineCount()}{wxvscrolledwindowsetlinecount})
 
 
+\membersection{wxVScrolledWindow::GetVisibleBegin}\label{wxvscrolledwindowgetvisiblebegin}
+
+\constfunc{size\_t}{GetVisibleBegin}{\void}
+
+Returns the index of the first currently visible line.
+
+\wxheading{See also}
+
+\helpref{GetVisibleEnd}{wxvscrolledwindowgetvisibleend}
+
+
+\membersection{wxVScrolledWindow::GetVisibleEnd}\label{wxvscrolledwindowgetvisibleend}
+
+\constfunc{size\_t}{GetVisibleEnd}{\void}
+
+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}{wxvscrolledwindowgetlinecount}.
+
+\wxheading{See also}
+
+\helpref{GetVisibleBegin}{wxvscrolledwindowgetvisiblebegin}
+
+
 \membersection{wxVScrolledWindow::HitTest}\label{wxvscrolledwindowhittest}
 
 \constfunc{int}{HitTest}{\param{wxCoord }{x}, \param{wxCoord }{y}}
@@ -151,7 +186,7 @@ Returns {\tt true} if the given line is (at least partially) visible or
 
 \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.
@@ -163,7 +198,7 @@ should return the height of the given line in pixels.
 
 \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