silence gcc warnings about values not handled in switch

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

diff --git a/docs/latex/wx/tipprov.tex b/docs/latex/wx/tipprov.tex
index dcc3336c5e815d6e61182eee707d0053784eec8e..0caa5e74411defee062a40d5c52066a8aed917df 100644 (file)
--- a/docs/latex/wx/tipprov.tex
+++ b/docs/latex/wx/tipprov.tex
@@ -7,8 +7,7 @@ current tip from it (different tip each time it is called).
 You will never use this class yourself, but you need it to show startup tips
 with wxShowTip. Also, if you want to get the tips text from elsewhere than a
 simple text file, you will want to derive a new class from wxTipProvider and
-use it instead of the one returned by 
-\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
+use it instead of the one returned by \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
 
 \wxheading{Derived from}
 
@@ -32,21 +31,33 @@ Constructor.
 
 \docparam{currentTip}{The starting tip index.}
 
-\membersection{wxTipProvider::GetTip}{wxtipprovidergettip}
+\membersection{wxTipProvider::GetTip}\label{wxtipprovidergettip}
 
 \func{wxString}{GetTip}{\void}
 
 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{wxCurrentTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip}
+\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.
+