adjusted indentation with astyle; added Id keyword

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions

View File

@@ -9,38 +9,38 @@
/**
@class wxTipProvider
@wxheader{tipdlg.h}
This is the class used together with wxShowTip function.
It must implement wxTipProvider::GetTip 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 wxCreateFileTipProvider.
@library{wxadv}
@category{FIXME}
@seealso
@ref overview_tipsoverview "Startup tips overview", ::wxShowTip
*/
class wxTipProvider
class wxTipProvider
{
public:
/**
Constructor.
@param currentTip
@param currentTip
The starting tip index.
*/
wxTipProvider(size_t currentTip);
/**
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
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.
@@ -55,11 +55,11 @@ public:
/**
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
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
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.
*/
virtual wxString PreProcessTip(const wxString& tip);
@@ -73,14 +73,14 @@ public:
/**
This function creates a wxTipProvider which may be
used with wxShowTip.
@param filename
@param filename
The name of the file containing the tips, one per line
@param currentTip
@param currentTip
The index of the first tip to show - normally this index
is remembered between the 2 program runs.
@sa @ref overview_tipsoverview "Tips overview"
*/
wxTipProvider * wxCreateFileTipProvider(const wxString& filename,