gre-ilya/fltk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better document Fl_Window::show(int, char**)

Browse Source 
This removes one \todo.
This commit is contained in:
ManoloFLTK 2023-02-05 09:37:48 +01:00
parent 62331e4a38
commit b4b7166b85
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
FL/Fl_Window.H
View File

@ -402,8 +402,8 @@ public:
*/
int shown() {return flx_ != 0;}
/**
Puts the window on the screen. Usually (on X) this has the side
effect of opening the display.
Puts the window on the screen. This has the side
effect of opening the display, if not done before.
If the window is already shown then it is restored and raised to the
top. This is really convenient because your program can call show()
@ -434,24 +434,24 @@ public:
*/
void hide() FL_OVERRIDE;
/**
Puts the window on the screen and parses command-line arguments.
Puts the window on the screen with show() and parses command-line arguments.
Usually (on X) this has the side effect of opening the display.
This form should be used for top-level windows, at least for the
first (main) window. It allows standard arguments to be parsed
This call should be used for top-level windows, at least for the
first (main) window. It allows standard arguments to be parsed, as done by Fl::args(int, char **),
from the command-line. You can use \p argc and \p argv from
main(int argc, char **argv) for this call.
The first call also sets up some system-specific internal
variables like the system colors.
\todo explain which system parameters are set up.
This call also sets up some system-specific internal variables, that is,
it sets FL_SELECTION_COLOR and calls Fl::background(), Fl::background2(), Fl::foreground()
with default or X resources-given values, and calls Fl::scheme(const char *) for the current scheme.
On X11, it also calls Fl::dnd_text_ops(int), Fl_Tooltip::enable(int),
Fl::visible_focus(int) with X resources-given values.
\param argc command-line argument count, usually from main()
\param argv command-line argument vector, usually from main()
\see virtual void Fl_Window::show()
\see Fl::args(int, char **)
*/
void show(int argc, char **argv);