From 59c96f54635aed579fcb40a1980ff3694af46bd8 Mon Sep 17 00:00:00 2001
From: Bill Spitzak
Date: Wed, 27 Jan 1999 08:45:11 +0000
Subject: Fixes to documentation. Restored the lines drawn around symbols, it
uses fl_color_average to pick a dark line color that is still deactivatable.
Requested by CE.
git-svn-id: file:///fltk/svn/fltk/trunk@249 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
documentation/functions.html | 57 +++++++++++++++++++++++++-------------------
1 file changed, 32 insertions(+), 25 deletions(-)
(limited to 'documentation/functions.html')
diff --git a/documentation/functions.html b/documentation/functions.html
index 96ddc536b..d8943d3b7 100644
--- a/documentation/functions.html
+++ b/documentation/functions.html
@@ -38,25 +38,27 @@ the user types ESC or clicks outside the window.
waits for the user to hit the button. The message will wrap to fit the
window, or may be many lines by putting \n characters into it.
The enter key is a shortcut for the OK button.
-
+
Same as fl_message() except for the "!" symbol.
-
+
Displays a printf-style message in a pop-up box with an "Yes" and "No"
button and waits for the user to hit a button. The return value is 1
if the user hits Yes, 0 if they pick No. The enter key is a shortcut
for Yes and ESC is a shortcut for No.
-
+
- Shows the message with three buttons below it marked with the strings
-b0, b1, and b2. Returns 0, 1, or 2 depending on
-which button is hit. ESC is a shortcut for button 0 and the enter key
-is a shortcut for button 1. Notice the "misordered" position of the
-buttons. You can hide buttons by passing NULL as their
-labels.
-
+
+ Shows the message with three buttons below it marked with the strings
+ b0, b1, and b2. Returns 0, 1, or 2
+depending on which button is hit. ESC is a shortcut for button 0 and
+the enter key is a shortcut for button 1. Notice the buttons are
+positioned "backwards" You can hide buttons by passing
+NULL as their labels.
+
+
Pops up a window displaying a string, lets the user edit it, and
@@ -64,12 +66,12 @@ return the new value. The cancel button returns NULL. The
returned pointer is only valid until the next time fl_input()
is called. Due to back-compatability, the arguments to any printf
commands in the label are after the default value.
-
+
Same as fl_input() except an
Fl_Secret_Input field is used.
-
+
Change the font and font size used for the messages in all the popups.
@@ -269,7 +271,9 @@ index of each word. The callback should return zero if the switch is
unrecognized, and not change i. It should return non-zero if
the switch is recognized, and add at least 1 to i (it can add
more to consume words after the switch). This function is called
-before any other tests, so you can override any FLTK switch.
+before any other tests, so you can override any FLTK
+switch (this is why fltk can use very short switches instead of
+the long ones all other toolkits force you to use).
On return i is set to the index of the first non-switch.
This is either:
@@ -282,7 +286,7 @@ This is either:
in which case it is zero. If your program takes no arguments other
than switches you should produce an error if the return value is less
than argc.
-All switches may be abbreviated to two letters and case is ignored:
+All switches except -bg2 may be abbreviated one letter and case is ignored:
- -display host:n.n The X display to use (ignored under
WIN32).
@@ -354,8 +358,10 @@ windows are displayed.
If true then flush() will do something.
- Sets the X display to use for all windows. This function is ignored
-under WIN32.
+ Sets the X display to use for all windows. Actually this just sets
+ the environment variable $DISPLAY to the passed string, so this only
+ works before you show() the first window or otherwise open the display,
+ and does nothing useful under WIN32.
Enables the symbol drawing code.
@@ -501,10 +507,10 @@ colormap.
static void Fl::get_color(Fl_Color, uchar &r, uchar &g, uchar &b)
Returns the color index or RGB value for the given FLTK color index.
-
+
static const char *Fl::get_font_name(int
face, int *attributes = 0)
Get a human-readable string describing the family of this face. This
@@ -550,8 +556,8 @@ call this so your X windows use the same visual as an See Fl_Gl_Window
for a list of additional values for the argument.
-static void Fl::grab(Fl_Window static Fl_Window
-*Fl::grab()
+static void Fl::grab(Fl_Window&)
+
static Fl_Window* Fl::grab()
This is used when pop-up menu systems are active. Send all events to
the passed window no matter where the pointer or focus is (including in
other programs). The window does not have to be shown()
@@ -575,13 +581,14 @@ widget uses the event.
This is the usage string that is displayed if Fl::args()
detects an invalid argument on the command-line.
static Fl_Window *Fl::modal()
- The modal() window has its handle() method called
-for all events, and no other windows will have handle()
- called. If grab() has been done then this
-is equal to grab(). Otherwise this is the most recently
+Returns the top-most modal() window currently shown.
+This is the most recently
shown() window with
modal() true, or NULL if there are no modal()
- windows shown().
+windows shown().
+The modal() window has its handle() method called
+for all events, and no other windows will have handle()
+called (grab() overrides this).
static Fl_Window *Fl::next_window(Fl_Window *)
Returns the next top-level window in the widget hierarchy.
--
cgit v1.2.3