summaryrefslogtreecommitdiff
path: root/FL/Fl_Window.H
diff options
context:
space:
mode:
authorManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-05 09:37:48 +0100
committerManoloFLTK <41016272+ManoloFLTK@users.noreply.github.com>2023-02-05 09:37:48 +0100
commitb4b7166b85aeb976c6abe0c019234713292635d5 (patch)
tree2024b7811ceabae7c3058c9c4cefa031a4b2557b /FL/Fl_Window.H
parent62331e4a388bab03e8945f3ad57ccf35e50d1ed2 (diff)
Better document Fl_Window::show(int, char**)
This removes one \todo.
Diffstat (limited to 'FL/Fl_Window.H')
-rw-r--r--FL/Fl_Window.H22
1 files changed, 11 insertions, 11 deletions
diff --git a/FL/Fl_Window.H b/FL/Fl_Window.H
index 5da402402..7ea3fd8ec 100644
--- a/FL/Fl_Window.H
+++ b/FL/Fl_Window.H
@@ -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);