Applied patch [ 654023 ] Enables HtmlHelp (native)

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

diff --git a/docs/latex/wx/tipprov.tex b/docs/latex/wx/tipprov.tex
index c824373aab8481eda24dc669398272242f2150d7..0caa5e74411defee062a40d5c52066a8aed917df 100644 (file)
--- a/docs/latex/wx/tipprov.tex
+++ b/docs/latex/wx/tipprov.tex
@@ -38,11 +38,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.
 
 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}
 
 \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 
 GetTip).
 
 The program usually remembers the value returned by this function after calling