From 17374b20bb7bc6230170e341105bed9f2e4e3b05 Mon Sep 17 00:00:00 2001
From: Michael R Sweet <michael.r.sweet@gmail.com>
Date: Tue, 9 Apr 2002 09:38:15 +0000
Subject: Update fl_beep() to use the PC speaker for FL_BEEP_DEFAULT.

Add docos for fl_beep...


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2059 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 documentation/functions.html | 34 +++++++++++++++++++++++++++++++---
 1 file changed, 31 insertions(+), 3 deletions(-)

(limited to 'documentation/functions.html')

diff --git a/documentation/functions.html b/documentation/functions.html
index 4a8f827e9..e999f4214 100644
--- a/documentation/functions.html
+++ b/documentation/functions.html
@@ -8,13 +8,41 @@ A</A>.
 
 <h2>Functions</h2>
 
+<h3><A name="fl_beep">void fl_beep(int type = FL_BEEP_DEFAULT)</A></h3>
+
+<P>Sounds an audible notification; the default <CODE>type</CODE> argument
+sounds a simple "beep" sound. Other values for <CODE>type</CODE> may use
+a system or user-defined sound file:
+
+<UL>
+
+	<LI><TT>FL_BEEP_DEFAULT</TT> - Make a generic "beep" sound.
+
+	<LI><TT>FL_BEEP_MESSAGE</TT> - Make a sound appropriate for an
+	informational message.
+
+	<LI><TT>FL_BEEP_ERROR</TT> - Make a sound appropriate for an
+	error message.
+
+	<LI><TT>FL_BEEP_QUESTION</TT> - Make a sound appropriate for
+	a question.
+
+	<LI><TT>FL_BEEP_PASSWORD</TT> - Make a sound appropriate for
+	a password prompt.
+
+	<LI><TT>FL_BEEP_NOTIFICATION</TT> - Make a sound appropriate for
+	an event notification ("you have mail", etc.)
+
+</UL>
+
 <h3><A name="fl_color_chooser_func">int fl_color_chooser(const char
 *title, double &amp;r, double &amp;g, double &amp;b)
 <br>int fl_color_chooser(const char *title, uchar &amp;r, uchar &amp;g, uchar &amp;b)</A></h3>
 
-The double version takes RGB values in the range 0.0 to 1.0.  The
-uchar version takes RGB values in the range 0 to 255. The <tt>title</tt>
-argument specifies the label (title) for the window.
+<P>The <CODE>double</CODE> version takes RGB values in the range
+0.0 to 1.0.  The <CODE>uchar</CODE> version takes RGB values in
+the range 0 to 255. The <tt>title</tt> argument specifies the
+label (title) for the window.
 
 <p align=center><img src="fl_color_chooser.jpg" ALT="The fl_color_chooser dialog.">
 
-- 
cgit v1.2.3