no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/tipprov.tex b/docs/latex/wx/tipprov.tex
index a651e5b85358cba15fa3cd7ab9fb6a8f29d77506..50eae53af6cc7304194fb89c8da2ad3f8228982f 100644 (file)
--- a/docs/latex/wx/tipprov.tex
+++ b/docs/latex/wx/tipprov.tex
@@ -17,6 +17,10 @@ None.
 
 <wx/tipdlg.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{Startup tips overview}{tipsoverview}, \helpref{::wxShowTip}{wxshowtip}
@@ -38,14 +42,26 @@ 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 
 \helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which
 was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
 button in the tip dialog.
+