diff options
Diffstat (limited to 'FL')
| -rw-r--r-- | FL/Fl_Scrollbar.H | 55 | ||||
| -rw-r--r-- | FL/Fl_Slider.H | 68 |
2 files changed, 66 insertions, 57 deletions
diff --git a/FL/Fl_Scrollbar.H b/FL/Fl_Scrollbar.H index f6dbb566b..61c04e190 100644 --- a/FL/Fl_Scrollbar.H +++ b/FL/Fl_Scrollbar.H @@ -34,18 +34,20 @@ #include "Fl_Slider.H" /** - The Fl_Scrollbar widget displays a slider with arrow buttons - at the ends of the scrollbar. Clicking on the arrows move up/left and - down/right by linesize(). Scrollbars also accept - FL_SHORTCUT events: the arrows move by linesize(), and - vertical scrollbars take Page Up/Down (they move by the page size minus - linesize()) and Home/End (they jump to the top or bottom). - <P>Scrollbars have step(1) preset (they always return - integers). If desired you can set the step() to non-integer - values. You will then have to use casts to get at the floating-point - versions of value() from Fl_Slider. </P> - <P ALIGN=CENTER>\image html scrollbar.gif - \image latex scrollbar.eps "Fl_Scrollbar" width=4cm + The Fl_Scrollbar widget displays a slider with arrow buttons at + the ends of the scrollbar. Clicking on the arrows move up/left and + down/right by linesize(). Scrollbars also accept FL_SHORTCUT events: + the arrows move by linesize(), and vertical scrollbars take Page + Up/Down (they move by the page size minus linesize()) and Home/End + (they jump to the top or bottom). + + Scrollbars have step(1) preset (they always return integers). If + desired you can set the step() to non-integer values. You will then + have to use casts to get at the floating-point versions of value() + from Fl_Slider. + + \image html scrollbar.gif + \image latex scrollbar.eps "Fl_Scrollbar" width=4cm */ class FL_EXPORT Fl_Scrollbar : public Fl_Slider { @@ -58,30 +60,32 @@ protected: public: - Fl_Scrollbar(int x,int y,int w,int h, const char *l = 0); + Fl_Scrollbar(int X,int Y,int W,int H, const char *L = 0); ~Fl_Scrollbar(); int handle(int); /** Gets the integer value (position) of the slider in the scrollbar. You can get the floating point value with Fl_Slider::value(). + \see Fl_Scrollbar::value(int p) - \see Fl_Scrollbar::value(int p, int s, int top, int total) + \see Fl_Scrollbar::value(int pos, int size, int first, int total) */ int value() const {return int(Fl_Slider::value());} /** Sets the value (position) of the slider in the scrollbar. + \see Fl_Scrollbar::value() - \see Fl_Scrollbar::value(int p, int s, int top, int total) + \see Fl_Scrollbar::value(int pos, int size, int first, int total) */ int value(int p) {return int(Fl_Slider::value((double)p));} /** Sets the position, size and range of the slider in the scrollbar. - \param[in] p position, first line displayed - \param[in] s window size, number of lines displayed - \param[in] top number of first line + \param[in] pos position, first line displayed + \param[in] size window size, number of lines displayed + \param[in] first number of first line \param[in] total total number of lines You should call this every time your window changes size, your data @@ -89,21 +93,20 @@ public: to a callback from this scrollbar). All necessary calls to redraw() are done. - Calls Fl_Slider::scrollvalue(int p, int s, int top, int total). + Calls Fl_Slider::scrollvalue(int pos, int size, int first, int total). */ - int value(int p, int s, int top, int total) { - return scrollvalue(p, s, top, total); + int value(int pos, int size, int first, int total) { + return scrollvalue(pos, size, first, total); } /** - This number controls how big the steps are that the arrow keys do. In - addition page up/down move by the size last sent to value() - minus one linesize(). The default is 16. + Get the size of step, in lines, that the arror keys move. */ int linesize() const {return linesize_;} + /** - This number controls how big the steps are that the arrow keys do. In - addition page up/down move by the size last sent to value() + This number controls how big the steps are that the arrow keys do. + In addition page up/down move by the size last sent to value() minus one linesize(). The default is 16. */ void linesize(int i) {linesize_ = i;} 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. - <P>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: - <UL> - <LI>FL_VERTICAL - Draws a vertical slider (this is the - default). </LI> - <LI>FL_HORIZONTAL - Draws a horizontal slider. </LI> - <LI>FL_VERT_FILL_SLIDER - Draws a filled vertical slider, - useful as a progress or value meter. </LI> - <LI>FL_HOR_FILL_SLIDER - Draws a filled horizontal slider, - useful as a progress or value meter. </LI> - <LI>FL_VERT_NICE_SLIDER - Draws a vertical slider with a nice - looking control knob. </LI> - <LI>FL_HOR_NICE_SLIDER - Draws a horizontal slider with a - nice looking control knob. </LI> - </UL> - <P ALIGN=CENTER>\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. - <P>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;} }; |