[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}{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}

\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
	10	use it instead of the one returned by
	11	\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
	12
	13	\wxheading{Derived from}
	14
	15	None.
	16
	17	\wxheading{Include files}
	18
	19	<wx/tipdlg.h>
	20
	21	\wxheading{See also}
	22
	23	\helpref{Startup tips overview}{tipsoverview}, \helpref{::wxShowTip}{wxshowtip}
	24
	25	\latexignore{\rtfignore{\wxheading{Members}}}
	26
	27	\membersection{wxTipProvider::wxTipProvider}\label{wxtipproviderctor}
	28
	29	\func{}{wxTipProvider}{\param{size\_t }{currentTip}}
	30
	31	Constructor.
	32
	33	\docparam{currentTip}{The starting tip index.}
	34
	35	\membersection{wxTipProvider::GetTip}{wxtipprovidergettip}
	36
	37	\func{wxString}{GetTip}{\void}
	38
	39	Return the text of the current tip and pass to the next one. This function is
	40	pure virtual, it should be implemented in the derived classes.
	41
	42	\membersection{wxCurrentTipProvider::GetCurrentTip}{wxtipprovidergetcurrenttip}
	43
	44	\constfunc{size\_t}{GetCurrentTip}{\void}
	45
	46	Returns the index of the current tip (i.e. the one which would be returned by
	47	GetTip).
	48
	49	The program usually remembers the value returned by this function after calling
	50	\helpref{wxShowTip}{wxshowtip}. Note that it is not the same as the value which
	51	was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
	52	button in the tip dialog.