From 09f3094aef152ece5bf802983d54f1642d803e0d Mon Sep 17 00:00:00 2001
From: Fabien Costantini <fabien@onepost.net>
Date: Mon, 15 Sep 2008 12:46:49 +0000
Subject: Doxygen documentation WP10 Done. Reserved WP11.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_Value_Output.H | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'FL/Fl_Value_Output.H')

diff --git a/FL/Fl_Value_Output.H b/FL/Fl_Value_Output.H
index cc61cdd6c..b8dc1f98e 100644
--- a/FL/Fl_Value_Output.H
+++ b/FL/Fl_Value_Output.H
@@ -32,6 +32,17 @@
 #include "Fl_Valuator.H"
 #endif
 
+/**
+  The Fl_Value_Output widget displays a floating point value.
+  If step() is not zero, the user can adjust the value by
+  dragging the mouse left and right.  The left button moves one step()
+  per pixel, the middle by 10 * step(), and the right button by 
+  100 * step().
+  <P>This is much lighter-weight than 
+  Fl_Value_Input because it contains no text editing code or
+  character buffer. </P>
+  <P ALIGN=CENTER>\image html Fl_Value_Output.gif
+*/
 class FL_EXPORT Fl_Value_Output : public Fl_Valuator {
   Fl_Font textfont_;
   Fl_Fontsize textsize_;
@@ -42,14 +53,31 @@ public:
   void draw();
   Fl_Value_Output(int x,int y,int w,int h,const char *l=0);
 
+  /**
+    If &quot;soft&quot; is turned on, the user is allowed to drag the value outside
+    the range.  If they drag the value to one of the ends, let go, then
+    grab again and continue to drag, they can get to any value.  Default is
+    one.
+  */
   void soft(uchar s) {soft_ = s;}
+  /**
+    If &quot;soft&quot; is turned on, the user is allowed to drag the value outside
+    the range.  If they drag the value to one of the ends, let go, then
+    grab again and continue to drag, they can get to any value.  Default is
+    one.
+  */
   uchar soft() const {return soft_;}
 
+  /**    Gets the typeface of the text in the value box.  */
   Fl_Font textfont() const {return textfont_;}
+  /**    Sets the typeface of the text in the value box.  */
   void textfont(Fl_Font s) {textfont_ = s;}
+  /**    Gets the size of the text in the value box.  */
   Fl_Fontsize textsize() const {return textsize_;}
   void textsize(Fl_Fontsize s) {textsize_ = s;}
+  /**    Sets the color of the text in the value box.  */
   Fl_Color textcolor() const {return (Fl_Color)textcolor_;}
+  /**    Gets the color of the text in the value box.  */
   void textcolor(unsigned s) {textcolor_ = s;}
 };
 
-- 
cgit v1.2.3