From fe7b9d0013782c17776afa0c06ea93d176ac20ff Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sat, 4 Jul 2009 11:10:04 +0000 Subject: [PATCH] Documentation update for STR #2150 (see svn -r 6786). I also removed the note that fl_message() would handle tags, because this change was reverted previously (maybe in 1.3.x ?). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@6826 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/functions.html | 67 ++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 22 deletions(-) diff --git a/documentation/functions.html b/documentation/functions.html index 8624f9d6e..4abf8bd30 100644 --- a/documentation/functions.html +++ b/documentation/functions.html @@ -375,6 +375,10 @@ void fl_alert(const char *, ...);

Same as fl_message() except for the "!" symbol. +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.

+

The fl_alert window @@ -399,16 +403,22 @@ int fl_ask(const char *, ...);

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. +to hit a button. The return value is 1 if the user hits Yes, +0 if they pick No or another dialog box is still open. + +The enter key is a shortcut for Yes and ESC is a shortcut for No. + +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.

+

The fl_ask window. -

Note: Use of this function is strongly -discouraged, and it will be removed in FLTK 2.0. Instead, use fl_choice() instead and provide -unambiguous verbs in place of "Yes" and "No".

+

Note: Use of this function is strongly +discouraged, and it will be removed in a later FLTK release. +Instead, use fl_choice() and +provide unambiguous verbs in place of "Yes" and "No".

fl_beep

@@ -476,11 +486,16 @@ int fl_choice(const char *q, const char *b0, const char *b1, const char *b2, ...

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 +if button 0 is hit or another dialog box is still open. Returns +1 or 2 for buttons 1 or 2, respectively. 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. +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.

+

The fl_choice window. @@ -1212,12 +1227,17 @@ const char *fl_input(const char *label, const char *deflt = 0, ...);

Description

-

Pops up a window displaying a string, lets the user edit it, -and 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. +

Pops up a window displaying a string, lets the user edit it, and +returns the new value. The function returns NULL if the +Cancel button is hit or another dialog box is still open. +The returned pointer is only valid until the +next time fl_input() is called. +Due to back-compatibility, the arguments to any printf commands +in the label are after the default value. + +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.

The fl_input window. @@ -1269,13 +1289,12 @@ 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. -

A message text can be further formatted with html tags by -adding <html> at the beginning of the message. -See Fl_Help_View for -details. -

The message text is limited to 1024 characters. +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.

+

The fl_message window. @@ -1371,9 +1390,13 @@ const char *fl_password(const char *label, const char *deflt = 0, ...);

Description

-

Same as fl_input(), except an Fl_Secret_Input field is -used. +

Same as fl_input(), except an +Fl_Secret_Input +field is used. + +

Note: Common dialog boxes are application modal. +No more than one common dialog box can be open at any time. +Requests for additional dialog boxes are ignored.