summaryrefslogtreecommitdiff
path: root/FL/Fl_Progress.H
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-09-15 00:27:28 +0000
committerFabien Costantini <fabien@onepost.net>2008-09-15 00:27:28 +0000
commitfdcfef214e67b0b1162ef4098ba960efd7049523 (patch)
treeec879deb42fe1fbf3ec5a93cf2d7227cf09ed25e /FL/Fl_Progress.H
parente760e8a6e7335ab0689686b907dcafe94aa168db (diff)
Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to doxyfy.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'FL/Fl_Progress.H')
-rw-r--r--FL/Fl_Progress.H10
1 files changed, 9 insertions, 1 deletions
diff --git a/FL/Fl_Progress.H b/FL/Fl_Progress.H
index 6f5819a2b..12ccf09c6 100644
--- a/FL/Fl_Progress.H
+++ b/FL/Fl_Progress.H
@@ -38,7 +38,9 @@
//
// Progress class...
//
-
+/**
+ Displays a progress bar for the user.
+*/
class FL_EXPORT Fl_Progress : public Fl_Widget
{
float value_,
@@ -53,13 +55,19 @@ class FL_EXPORT Fl_Progress : public Fl_Widget
Fl_Progress(int x, int y, int w, int h, const char *l = 0);
+ /** Sets the maximum value in the progress widget. */
void maximum(float v) { maximum_ = v; redraw(); }
+ /** Gets the maximum value in the progress widget. */
float maximum() const { return (maximum_); }
+ /** Sets the minimum value in the progress widget. */
void minimum(float v) { minimum_ = v; redraw(); }
+ /** Gets the minimum value in the progress widget. */
float minimum() const { return (minimum_); }
+ /** Sets the current value in the progress widget. */
void value(float v) { value_ = v; redraw(); }
+ /** Gets the current value in the progress widget. */
float value() const { return (value_); }
};