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_Input.H | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

(limited to 'FL/Fl_Value_Input.H')

diff --git a/FL/Fl_Value_Input.H b/FL/Fl_Value_Input.H
index e3c476597..0ede3cf39 100644
--- a/FL/Fl_Value_Input.H
+++ b/FL/Fl_Value_Input.H
@@ -31,6 +31,33 @@
 #include "Fl_Valuator.H"
 #include "Fl_Input.H"
 
+/**
+  The Fl_Value_Input widget displays a numeric value.
+  The user can click in the text field and edit it - there is in
+  fact a hidden Fl_Input widget with
+  type(FL_FLOAT_INPUT) or type(FL_INT_INPUT) in
+  there - and when they hit return or tab the value updates to
+  what they typed and the callback is done.
+  
+  <P>If step() is non-zero and integral, then the range of numbers
+  is limited to integers instead of floating point numbers. As
+  well as displaying the value as an integer, typed input is also
+  limited to integer values, even if the hidden Fl_Input widget
+  is of type(FL_FLOAT_INPUT).</P>
+  
+  <P>If step() is non-zero, the user can also drag the
+  mouse across the object and thus slide the value. The left
+  button moves one step() per pixel, the middle by 10
+  * step(), and the right button by 100 * step(). It
+  is therefore impossible to select text by dragging across it,
+  although clicking can still move the insertion cursor.</P>
+  
+  <P>If step() is non-zero and integral, then the range
+  of numbers are limited to integers instead of floating point
+  values.
+  
+  <P ALIGN="CENTER">\image html Fl_Value_Input.gif
+*/
 class FL_EXPORT Fl_Value_Input : public Fl_Valuator {
 public:
   Fl_Input input;
@@ -44,19 +71,50 @@ public:
   void resize(int,int,int,int);
   Fl_Value_Input(int x,int y,int w,int h,const char *l=0);
 
+  /** See void Fl_Value_Input::soft(char s) */
   void soft(char 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. The default is true.
+  */
   char soft() const {return soft_;}
-
+  /**
+    The first form returns the current shortcut key for the Input.
+    <P>The second form sets the shortcut key to key. Setting this
+    overrides the use of '&' in the label().  The value is a bitwise
+    OR of a key and a set of shift flags, for example FL_ALT | 'a'
+    , FL_ALT | (FL_F + 10), or just 'a'.  A value
+    of 0 disables the shortcut. </P>
+    <P>The key can be any value returned by 
+    Fl::event_key(), but will usually be an ASCII letter.  Use
+    a lower-case letter unless you require the shift key to be held down. </P>
+    <P>The shift flags can be any set of values accepted by 
+    Fl::event_state().  If the bit is on that shift key must
+    be pushed.  Meta, Alt, Ctrl, and Shift must be off if they are not in
+    the shift flags (zero for the other bits indicates a &quot;don't care&quot;
+    setting).
+  */
   int shortcut() const {return input.shortcut();}
+  /** See int Fl_Value_Input::shortcut() const */
   void shortcut(int s) {input.shortcut(s);}
 
+  /** Gets the typeface of the text in the value box.  */
   Fl_Font textfont() const {return input.textfont();}
+  /** Sets the typeface of the text in the value box.  */
   void textfont(Fl_Font s) {input.textfont(s);}
+  /** Gets the size of the text in the value box.  */
   Fl_Fontsize textsize() const {return input.textsize();}
+  /** Sets the size of the text in the value box.  */
   void textsize(Fl_Fontsize s) {input.textsize(s);}
+  /** Gets the color of the text in the value box.  */
   Fl_Color textcolor() const {return input.textcolor();}
+  /** Sets the color of the text in the value box.*/
   void textcolor(unsigned n) {input.textcolor(n);}
+  /** Gets the color of the text cursor. The text cursor is black by default. */
   Fl_Color cursor_color() const {return input.cursor_color();}
+  /** Sets the color of the text cursor. The text cursor is black by default. */
   void cursor_color(unsigned n) {input.cursor_color(n);}
 
 };
-- 
cgit v1.2.3