Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
interface/timer.h
View File

@@ -49,7 +49,7 @@ public:
SetOwner() for the description of parameters.
*/
wxTimer();
wxTimer(wxEvtHandler * owner, int id = -1);
wxTimer(wxEvtHandler* owner, int id = -1);
//@}
/**
@@ -88,43 +88,38 @@ public:
/**
This member should be overridden by the user if the default constructor was
used and SetOwner() wasn't called.
Perform whatever action which is to be taken periodically here.
*/
void Notify();
/**
Associates the timer with the given @e owner object. When the timer is
Associates the timer with the given @a owner object. When the timer is
running, the owner will receive @ref overview_wxtimerevent "timer events" with
id equal to @e id specified here.
id equal to @a id specified here.
*/
void SetOwner(wxEvtHandler * owner, int id = -1);
void SetOwner(wxEvtHandler* owner, int id = -1);
/**
(Re)starts the timer. If @e milliseconds parameter is -1 (value by default),
(Re)starts the timer. If @a milliseconds parameter is -1 (value by default),
the previous value is used. Returns @false if the timer could not be started,
@true otherwise (in MS Windows timers are a limited resource).
If @e oneShot is @false (the default), the Notify()
If @a oneShot is @false (the default), the Notify()
function will be called repeatedly until the timer is stopped. If @true,
it will be called only once and the timer will stop automatically. To make your
code more readable you may also use the following symbolic constants:
wxTIMER_CONTINUOUS
Start a normal, continuously running, timer
wxTIMER_ONE_SHOT
Start a one shot timer
If the timer was already running, it will be stopped by this method before
restarting it.
*/
bool Start(int milliseconds = -1, bool oneShot = @false);
bool Start(int milliseconds = -1, bool oneShot = false);
/**
Stops the timer.