remaining t*h interface revisions

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56076 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-04 11:55:28 +00:00
parent c6cf894ae2
commit 78e87bf7b8
5 changed files with 573 additions and 408 deletions

View File

@@ -19,9 +19,9 @@
use it instead of the one returned by wxCreateFileTipProvider().
@library{wxadv}
@category{FIXME}
@category{misc}
@see @ref overview_tipsoverview "Startup tips overview", ::wxShowTip
@see @ref overview_tips, ::wxShowTip
*/
class wxTipProvider
{
@@ -35,26 +35,27 @@ public:
wxTipProvider(size_t currentTip);
/**
Returns the index of the current tip (i.e. the one which would be returned by
GetTip).
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
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.
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.
*/
size_t GetCurrentTip() const;
/**
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.
*/
wxString GetTip();
/**
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
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.