mirrors/fltk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: separate docs of Fl::wait() and Fl::wait(double) as Doxygen mandates.

Browse Source 
Also, for Fl::run_also_windowless() and Fl::wait_also_windowless(), mention that
MacOS is a platform supporting the windowless mode and what happens with
platforms that don't support it.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@12660 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
This commit is contained in:
Manolo Gouy 2018-02-10 16:55:25 +00:00
parent b8ad5c2bd6
commit f42e2bfc4f
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/Fl.cxx
View File

@ -493,7 +493,14 @@ void fl_trigger_clipboard_notify(int source) {
void (*Fl::idle)(); // see Fl::add_idle.cxx for the add/remove functions
/**
See int Fl::wait()
Waits a maximum of \e time seconds or until "something happens".
See Fl::wait() for the description of operations performed when
"something happens".
\return Always 1 on Windows. Otherwise, it is positive
if an event or fd happens before the time elapsed.
It is zero if nothing happens. It is negative if an error
occurs (this will happen on X11 if a signal happens).
*/
double Fl::wait(double time_to_wait) {
// delete all widgets that were listed during callbacks
@ -504,8 +511,8 @@ double Fl::wait(double time_to_wait) {
#define FOREVER 1e20
/**
As long as any windows are displayed this calls Fl::wait()
repeatedly. When all the windows are closed it returns zero
Calls Fl::wait()repeatedly as long as any windows are displayed.
When all the windows are closed it returns zero
(supposedly it would return non-zero on any errors, but FLTK calls
exit directly for these). A normal program will end main()
with return Fl::run();.
@ -528,16 +535,8 @@ int Fl::run() {
any Fl::add_fd() callbacks. It then handles the events and
calls the callbacks and then returns.
The return value of Fl::wait() is non-zero if there are any
\return non-zero if there are any
visible windows - this may change in future versions of FLTK.
Fl::wait(time) waits a maximum of \e time seconds.
<i>It can return much sooner if something happens.</i>
The return value is positive if an event or fd happens before the
time elapsed. It is zero if nothing happens (on Win32 this will only
return zero if \e time is zero). It is negative if an error
occurs (this will happen on UNIX if a signal happens).
*/
int Fl::wait() {
if (!Fl_X::first) return 0;
@ -590,6 +589,8 @@ int Fl::ready()
}
/** Run the event loop even without any mapped window if the platform supports it.
Identical to Fl::run() for platforms that don't support running windowless.
The MacOS platform supports it.
\return zero indicates the event loop has been terminated.
\version 1.4.0
*/
@ -598,6 +599,8 @@ int Fl::run_also_windowless() {
}
/** Wait for \p delay seconds or until an event occurs, even without any mapped window if the platform supports it.
Identical to Fl::wait(delay) for platforms that don't support running windowless.
The MacOS platform supports it.
\return non zero indicates the event loop should be terminated
\version 1.4.0
*/