Author: AlbrechtS Date: 2009-07-04 04:10:04 -0700 (Sat, 04 Jul 2009) New Revision: 6826 Log: Documentation update for STR #2150 (see svn -r 6786).
I also removed the note that fl_message() would handle <html> tags, because this change was reverted previously (maybe in 1.3.x ?). Modified: branches/branch-1.1/documentation/functions.html Modified: branches/branch-1.1/documentation/functions.html =================================================================== --- branches/branch-1.1/documentation/functions.html 2009-07-04 05:18:29 UTC (rev 6825) +++ branches/branch-1.1/documentation/functions.html 2009-07-04 11:10:04 UTC (rev 6826) @@ -375,6 +375,10 @@ <P>Same as <tt>fl_message()</tt> except for the "!" symbol. +<p><b>Note: </b>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.</p> + <P ALIGN=CENTER><IMG src="fl_alert.gif" ALT="The fl_alert window"> @@ -399,16 +403,22 @@ <P>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. + +<p><b>Note: </b>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.</p> + + <P ALIGN="CENTER"><IMG SRC="fl_ask.gif" ALT="The fl_ask window."> -<p><b>Note:</b> Use of this function is <i>strongly</i> -discouraged, and it will be removed in FLTK 2.0. Instead, use <a -href='#fl_choice2'><tt>fl_choice()</tt></a> instead and provide -unambiguous verbs in place of "Yes" and "No".</p> +<p><b>Note: </b>Use of this function is <i>strongly</i> +discouraged, and it will be removed in a later FLTK release. +Instead, use <a href='#fl_choice2'><tt>fl_choice()</tt></a> and +provide unambiguous verbs in place of "Yes" and "No".</p> <!-- NEED 4in --> <H2><A name="fl_beep">fl_beep</A></H2> @@ -476,11 +486,16 @@ <P>Shows the message with three buttons below it marked with the strings <tt> b0</tt>, <tt>b1</tt>, and <tt>b2</tt>. 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 <tt>NULL</tt> as their labels. +<p><b>Note: </b>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.</p> + <P ALIGN="CENTER"><IMG SRC="fl_choice.gif" ALT="The fl_choice window."> @@ -1212,13 +1227,18 @@ <H3>Description</H3> -<P>Pops up a window displaying a string, lets the user edit it, -and return the new value. The cancel button returns -<tt>NULL</tt>. <I>The returned pointer is only valid until the -next time <tt>fl_input()</tt> is called</I>. Due to -back-compatability, the arguments to any printf commands in the -label are after the default value. +<P>Pops up a window displaying a string, lets the user edit it, and +returns the new value. The function returns <tt>NULL</tt> if the +<b>Cancel</b> button is hit or another dialog box is still open. +<I>The returned pointer is only valid until the +next time <tt>fl_input()</tt> is called</I>. +Due to back-compatibility, the arguments to any printf commands +in the label are after the default value. +<p><b>Note: </b>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.</p> + <P ALIGN=CENTER><IMG SRC="fl_input.gif" ALT="The fl_input window."> @@ -1269,13 +1289,12 @@ putting <tt>\n</tt> characters into it. The enter key is a shortcut for the OK button. -<P>A message text can be further formatted with html tags by -adding <tt><html></tt> at the beginning of the message. -See <tt><a href="Fl_Help_View.html">Fl_Help_View</a></tt> for -details. - <P>The message text is limited to 1024 characters. +<p><b>Note: </b>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.</p> + <P ALIGN="CENTER"><IMG src="fl_message.gif" ALT="The fl_message window."> @@ -1371,11 +1390,15 @@ <H3>Description</H3> -<P>Same as <tt>fl_input()</tt>, except an <A -href=Fl_Secret_Input.html><tt>Fl_Secret_Input</tt></A> field is -used. +<P>Same as <tt>fl_input()</tt>, except an +<A href=Fl_Secret_Input.html><tt>Fl_Secret_Input</tt></A> +field is used. +<p><b>Note: </b>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.</p> + <!-- NEED 4in --> <H2><A NAME="fl_register_images">fl_register_images</A></H2> _______________________________________________ fltk-commit mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-commit
