]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/tipprov.tex
Always draw the selection of selected items, not just when they have
[wxWidgets.git] / docs / latex / wx / tipprov.tex
... / ...
CommitLineData
1\section{\class{wxTipProvider}}\label{wxtipprovider}
2
3This is the class used together with \helpref{wxShowTip}{wxshowtip} function.
4It must implement \helpref{GetTip}{wxtipprovidergettip} function and return the
5current tip from it (different tip each time it is called).
6
7You will never use this class yourself, but you need it to show startup tips
8with wxShowTip. Also, if you want to get the tips text from elsewhere than a
9simple text file, you will want to derive a new class from wxTipProvider and
10use it instead of the one returned by \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}.
11
12\wxheading{Derived from}
13
14None.
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
30Constructor.
31
32\docparam{currentTip}{The starting tip index.}
33
34\membersection{wxTipProvider::GetTip}\label{wxtipprovidergettip}
35
36\func{wxString}{GetTip}{\void}
37
38Return the text of the current tip and pass to the next one. This function is
39pure virtual, it should be implemented in the derived classes.
40
41\membersection{wxTipProvider::PreprocessTip}\label{wxtipproviderpreprocesstip}
42
43\func{virtual wxString}{PreProcessTip}{\param{const wxString\&}{tip}}
44
45Returns a modified tip. This function will be called immediately after read,
46and before being check whether it is a comment, an empty string or a string
47to translate. You can optionally override this in your custom user-derived class
48to optionally to modify the tip as soon as it is read. You can return any
49modification to the string. If you return wxEmptyString, then this tip is
50skipped, and the next one is read.
51
52\membersection{wxCurrentTipProvider::GetCurrentTip}\label{wxtipprovidergetcurrenttip}
53
54\constfunc{size\_t}{GetCurrentTip}{\void}
55
56Returns the index of the current tip (i.e. the one which would be returned by
57GetTip).
58
59The 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
61was passed to wxShowTip $+ 1$ because the user might have pressed the "Next"
62button in the tip dialog.
63