X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/tipprov.tex diff --git a/docs/latex/wx/tipprov.tex b/docs/latex/wx/tipprov.tex index c824373aab..50eae53af6 100644 --- a/docs/latex/wx/tipprov.tex +++ b/docs/latex/wx/tipprov.tex @@ -17,6 +17,10 @@ None. +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + \wxheading{See also} \helpref{Startup tips overview}{tipsoverview}, \helpref{::wxShowTip}{wxshowtip} @@ -38,11 +42,22 @@ Constructor. Return the text of the current tip and pass to the next one. This function is pure virtual, it should be implemented in the derived classes. +\membersection{wxTipProvider::PreprocessTip}\label{wxtipproviderpreprocesstip} + +\func{virtual wxString}{PreProcessTip}{\param{const wxString\&}{tip}} + +Returns a modified tip. This function will be called immediately after read, +and before being check whether it is a comment, an empty string or a string +to translate. You can optionally override this in your custom user-derived class +to optionally to modify the tip as soon as it is read. You can return any +modification to the string. If you return wxEmptyString, then this tip is +skipped, and the next one is read. + \membersection{wxCurrentTipProvider::GetCurrentTip}\label{wxtipprovidergetcurrenttip} \constfunc{size\_t}{GetCurrentTip}{\void} -Returns the index of the current tip (i.e. the one which would be returned by +Returns the index of the current tip (i.e. the one which would be returned by GetTip). The program usually remembers the value returned by this function after calling