X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2a70e6eb3f86b630f0296bbace6b2565e0a1765c..38f1526768e108c7e2e1da50d16115b46004b89f:/docs/latex/wx/vscroll.tex diff --git a/docs/latex/wx/vscroll.tex b/docs/latex/wx/vscroll.tex index d354571d2a..83d151170f 100644 --- a/docs/latex/wx/vscroll.tex +++ b/docs/latex/wx/vscroll.tex @@ -90,6 +90,25 @@ Just as with the ctor above, {\tt wxVSCROLL} style is always used, there is no need to specify it explicitly. +\membersection{wxVScrolledWindow::EstimateTotalHeight}\label{wxvscrolledwindowestimatetotalheight} + +\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} +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. + +If it is undesirable to access all these lines (some of which might be never +shown) just for the total height calculation, you may override the function and +provide your own guess better and/or faster. + +Note that although returning a totally wrong value would still work, it risks +to result in very strange scrollbar behaviour so this function should really +try to make the best guess possible. + + \membersection{wxVScrolledWindow::GetFirstVisibleLine}\label{wxvscrolledwindowgetfirstvisibleline} \constfunc{size\_t}{GetFirstVisibleLine}{\void} @@ -112,6 +131,24 @@ Get the number of lines this window contains (previously set by \helpref{SetLineCount()}{wxvscrolledwindowsetlinecount}) +\membersection{wxVScrolledWindow::HitTest}\label{wxvscrolledwindowhittest} + +\constfunc{int}{HitTest}{\param{wxCoord }{x}, \param{wxCoord }{y}} + +\constfunc{int}{HitTest}{\param{const wxPoint\& }{pt}} + +Return the item at the specified (in physical coordinates) position or +{\tt wxNOT\_FOUND} if none, i.e. if it is below the last item. + + +\membersection{wxVScrolledWindow::IsVisible}\label{wxvscrolledwindowisvisible} + +\constfunc{bool}{IsVisible}{\param{size\_t }{line}} + +Returns {\tt true} if the given line is (at least partially) visible or +{\tt false} otherwise. + + \membersection{wxVScrolledWindow::OnGetLineHeight}\label{wxvscrolledwindowongetlineheight} \constfunc{wxCoord}{OnGetLineHeight}{\param{size\_t }{n}} @@ -144,6 +181,40 @@ Finally note that {\it lineMin} is inclusive, while {\it lineMax} is exclusive, as usual. +\membersection{wxVScrolledWindow::RefreshLine}\label{wxvscrolledwindowrefreshline} + +\func{void}{RefreshLine}{\param{size\_t }{line}} + +Refreshes the specified line -- it will be redrawn during the next main loop +iteration. + +\wxheading{See also} + +\helpref{RefreshLines}{wxvscrolledwindowrefreshlines} + + +\membersection{wxVScrolledWindow::RefreshLines}\label{wxvscrolledwindowrefreshlines} + +\func{void}{RefreshLines}{\param{size\_t }{from}, \param{size\_t }{to}} + +Refreshes all lines between {\it from} and {\it to}, inclusive. {\it from} +should be less than or equal to {\it to}. + +\wxheading{See also} + +\helpref{RefreshLine}{wxvscrolledwindowrefreshline} + + +\membersection{wxVScrolledWindow::RefreshAll}\label{wxvscrolledwindowrefreshall} + +\func{void}{RefreshAll}{\void} + +This function completely refreshes the control, recalculating the number of +items shown on screen and repaining them. It should be called when the values +returned by \helpref{OnGetLineHeight}{wxvscrolledwindowongetlineheight} change +for some reason and the window must be updated to reflect this. + + \membersection{wxVScrolledWindow::ScrollLines}\label{wxvscrolledwindowscrolllines} \func{bool}{ScrollLines}{\param{int }{lines}}