From 26c355b6a083e8fe1599705c69130db49b2a565d Mon Sep 17 00:00:00 2001 From: engelsman Date: Sat, 14 Mar 2009 11:46:43 +0000 Subject: updated Fl_Slider and Fl_Scrollbar documentation (STR #2156 - part 2) converted html tags to doxygen rationalised doxygen comments renamed Fl_Slider::scrollvalue() and Fl_Scrollbar::value() parameters git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6683 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- FL/Fl_Slider.H | 68 ++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 37 insertions(+), 31 deletions(-) (limited to 'FL/Fl_Slider.H') diff --git a/FL/Fl_Slider.H b/FL/Fl_Slider.H index fb0b3e701..e26be48b9 100644 --- a/FL/Fl_Slider.H +++ b/FL/Fl_Slider.H @@ -44,29 +44,28 @@ #define FL_HOR_NICE_SLIDER 5 /** - The Fl_Slider widget contains a sliding knob inside a box. It - if often used as a scrollbar. Moving the box all the way to the - top/left sets it to the minimum(), and to the bottom/right to - the maximum(). The minimum() may be greater than the - maximum() to reverse the slider direction. + The Fl_Slider widget contains a sliding knob inside a box. It if + often used as a scrollbar. Moving the box all the way to the + top/left sets it to the minimum(), and to the bottom/right to the + maximum(). The minimum() may be greater than the maximum() to + reverse the slider direction. -

Use void Fl_Widget::type(int) to set how the slider is drawn, + Use void Fl_Widget::type(int) to set how the slider is drawn, which can be one of the following: -

-

\image html slider.gif - \image latex slider.eps "Fl_Slider" width=4cm + + \li FL_VERTICAL - Draws a vertical slider (this is the default). + \li FL_HORIZONTAL - Draws a horizontal slider. + \li FL_VERT_FILL_SLIDER - Draws a filled vertical slider, + useful as a progress or value meter. + \li FL_HOR_FILL_SLIDER - Draws a filled horizontal slider, + useful as a progress or value meter. + \li FL_VERT_NICE_SLIDER - Draws a vertical slider with a nice + looking control knob. + \li FL_HOR_NICE_SLIDER - Draws a horizontal slider with a + nice looking control knob. + + \image html slider.gif + \image latex slider.eps "Fl_Slider" width=4cm */ class FL_EXPORT Fl_Slider : public Fl_Valuator { @@ -85,24 +84,31 @@ protected: public: int handle(int); - Fl_Slider(int x,int y,int w,int h, const char *l = 0); - Fl_Slider(uchar t,int x,int y,int w,int h, const char *l); + Fl_Slider(int X,int Y,int W,int H, const char *L = 0); + Fl_Slider(uchar t,int X,int Y,int W,int H, const char *L); - int scrollvalue(int windowtop,int windowsize,int first,int totalsize); + int scrollvalue(int pos,int size,int first,int total); void bounds(double a, double b); + /** - Get or set the dimensions of the moving piece of slider. This is the - fraction of the size of the entire widget. If you set this to 1 then - the slider cannot move. The default value is .08. -

For the "fill" sliders this is the size of the area around the end - that causes a drag effect rather than causing the slider to jump to the - mouse. + Get the dimensions of the moving piece of slider. */ float slider_size() const {return slider_size_;} - /** See float slider_size() const */ + + /** + Set the dimensions of the moving piece of slider. This is + the fraction of the size of the entire widget. If you set this + to 1 then the slider cannot move. The default value is .08. + + For the "fill" sliders this is the size of the area around the + end that causes a drag effect rather than causing the slider to + jump to the mouse. + */ void slider_size(double v); + /** Gets the slider box type. */ Fl_Boxtype slider() const {return (Fl_Boxtype)slider_;} + /** Sets the slider box type. */ void slider(Fl_Boxtype c) {slider_ = c;} }; -- cgit v1.2.3