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

\section{\class{wxTipProvider}}\label{wxtipprovider}

This is the class used together with \helpref{wxShowTip}{wxshowtip} function.
It must implement \helpref{GetTip}{wxtipprovidergettip} function and return the
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}.

\wxheading{Derived from}

None.

\wxheading{Include files}

<wx/tipdlg.h>

\wxheading{See also}

\helpref{Startup tips overview}{tipsoverview}, \helpref{::wxShowTip}{wxshowtip}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxTipProvider::wxTipProvider}\label{wxtipproviderctor}

\func{}{wxTipProvider}{\param{size\_t }{currentTip}}

Constructor.

\docparam{currentTip}{The starting tip index.}

\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{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 
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.
Commit	Line	Data
c50f1fb9 VZ	1	\section{\class{wxTipProvider}}\label{wxtipprovider}
	2
	3	This is the class used together with \helpref{wxShowTip}{wxshowtip} function.
	4	It must implement \helpref{GetTip}{wxtipprovidergettip} function and return the
	5	current tip from it (different tip each time it is called).
	6
	7	You will never use this class yourself, but you need it to show startup tips
	8	with wxShowTip. Also, if you want to get the tips text from elsewhere than a
	9	simple text file, you will want to derive a new class from wxTipProvider and
d7cb14ce	10	use it instead of the one returned by \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
c50f1fb9 VZ	11
	12	\wxheading{Derived from}
	13
	14	None.
	15
	16	\wxheading{Include files}
	17
	18	<wx/tipdlg.h>
	19
	20	\wxheading{See also}
	21
	22	\helpref{Startup tips overview}{tipsoverview}, \helpref{::wxShowTip}{wxshowtip}
	23
	24	\latexignore{\rtfignore{\wxheading{Members}}}
	25
	26	\membersection{wxTipProvider::wxTipProvider}\label{wxtipproviderctor}
	27
	28	\func{}{wxTipProvider}{\param{size\_t }{currentTip}}
	29
	30	Constructor.
	31
	32	\docparam{currentTip}{The starting tip index.}
	33
d7cb14ce	34	\membersection{wxTipProvider::GetTip}\label{wxtipprovidergettip}
c50f1fb9 VZ	35
	36	\func{wxString}{GetTip}{\void}
	37
	38	Return the text of the current tip and pass to the next one. This function is
	39	pure virtual, it should be implemented in the derived classes.
	40
70373b5a	41	\membersection{wxTipProvider::PreprocessTip}\label{wxtipproviderpreprocesstip}
0b0625e9 JS	42
0b0625e9 JS	43	\func{virtual wxString}{PreProcessTip}{\param{const wxString\&}{tip}}
70373b5a JS	44
	45	Returns a modified tip. This function will be called immediately after read,
	46	and before being check whether it is a comment, an empty string or a string
	47	to translate. You can optionally override this in your custom user-derived class
	48	to optionally to modify the tip as soon as it is read. You can return any
	49	modification to the string. If you return wxEmptyString, then this tip is
	50	skipped, and the next one is read.
	51
d7cb14ce	52	\membersection{wxCurrentTipProvider::GetCurrentTip}\label{wxtipprovidergetcurrenttip}
c50f1fb9 VZ	53
	54	\constfunc{size\_t}{GetCurrentTip}{\void}
	55
70373b5a	56	Returns the index of the current tip (i.e. the one which would be returned by
c50f1fb9 VZ	57	GetTip).
	58
	59	The program usually remembers the value returned by this function after calling
	60	\helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which
	61	was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
	62	button in the tip dialog.
0b0625e9	63