qwtdblrange.3

linux下qt的第三方的一个类

.TH "QwtDblRange" 3 "16 Nov 2004" "Version 4.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtDblRange \- 
.SH SYNOPSIS
.br
.PP
Inherited by \fBQwtCounter\fP, and \fBQwtSliderBase\fP.
.PP
.SH "Detailed Description"
.PP 
A class which controls a value within an interval. 

This class is useful as a base class or a member for sliders. It represents an interval of type double within which a value can be moved. The value can be either an arbitrary point inside the interval (see \fBQwtDblRange::setValue\fP), or it can be fitted into a step raster (see \fBQwtDblRange::fitValue\fP and \fBQwtDblRange::incValue\fP).
.PP
As a special case, a QwtDblRange can be periodic, which means that a value outside the interval will be mapped to a value inside the interval when \fBQwtDblRange::setValue()\fP, \fBQwtDblRange::fitValue()\fP, \fBQwtDblRange::incValue()\fP or \fBQwtDblRange::incPages()\fP are called. 
.PP
Definition at line 31 of file qwt_drange.h.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtDblRange\fP ()"
.br
.ti -1c
.RI "virtual \fB~QwtDblRange\fP ()"
.br
.ti -1c
.RI "void \fBsetRange\fP (double vmin, double vmax, double vstep=0.0, int pagesize=1)"
.br
.ti -1c
.RI "void \fBsetValid\fP (bool)"
.br
.ti -1c
.RI "bool \fBisValid\fP () const"
.br
.ti -1c
.RI "virtual void \fBsetValue\fP (double)"
.br
.ti -1c
.RI "double \fBvalue\fP () const"
.br
.ti -1c
.RI "void \fBsetPeriodic\fP (bool tf)"
.br
.ti -1c
.RI "bool \fBperiodic\fP () const"
.br
.ti -1c
.RI "void \fBsetStep\fP (double)"
.br
.ti -1c
.RI "double \fBstep\fP () const"
.br
.ti -1c
.RI "double \fBmaxValue\fP () const"
.br
.ti -1c
.RI "double \fBminValue\fP () const"
.br
.ti -1c
.RI "int \fBpageSize\fP () const"
.br
.ti -1c
.RI "virtual void \fBincValue\fP (int)"
.br
.ti -1c
.RI "virtual void \fBincPages\fP (int)"
.br
.ti -1c
.RI "virtual void \fBfitValue\fP (double)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "double \fBexactValue\fP () const"
.br
.ti -1c
.RI "double \fBexactPrevValue\fP () const"
.br
.ti -1c
.RI "double \fBprevValue\fP () const"
.br
.ti -1c
.RI "virtual void \fBvalueChange\fP ()"
.br
.ti -1c
.RI "virtual void \fBstepChange\fP ()"
.br
.ti -1c
.RI "virtual void \fBrangeChange\fP ()"
.br
.in -1c
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtDblRange::QwtDblRange ()"
.PP
The range is initialized to [0.0, 100.0], the step size to 1.0, and the value to 0.0. Definition at line 21 of file qwt_drange.cpp.
.SS "QwtDblRange::~\fBQwtDblRange\fP ()\fC [virtual]\fP"
.PP
Destroys the QwtDblRange. 
.PP
Definition at line 36 of file qwt_drange.cpp.
.SH "Member Function Documentation"
.PP 
.SS "double QwtDblRange::exactPrevValue () const\fC [protected]\fP"
.PP
Returns the exact previous value. 
.PP
Definition at line 380 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::mouseMoveEvent().
.SS "double QwtDblRange::exactValue () const\fC [protected]\fP"
.PP
Returns the exact value. 
.PP
The exact value is the value which \fBQwtDblRange::value\fP would return if the value were not adjusted to the step raster. It differs from the current value only if \fBQwtDblRange::fitValue\fP or \fBQwtDblRange::incValue\fP have been used before. This function is intended for internal use in derived classes. Definition at line 374 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::mouseMoveEvent(), and QwtSliderBase::timerEvent().
.SS "void QwtDblRange::fitValue (double x)\fC [virtual]\fP"
.PP
Adjust the value to the closest point in the step raster. 
.PP
\fBParameters:\fP
.RS 4
\fIx\fP value 
.RE
.PP
\fBWarning:\fP
.RS 4
The value is clipped when it lies outside the range. When the range is \fBQwtDblRange::periodic\fP, it will be mapped to a point in the interval such that 
.PP
.nf
 new value := x + n * (max. value - min. value)
.fi
.PP
with an integer number n. 
.RE
.PP

.PP
Reimplemented in \fBQwtSliderBase\fP.
.PP
Definition at line 132 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::fitValue(), QwtSliderBase::mouseReleaseEvent(), QwtSliderBase::setPosition(), and QwtSliderBase::timerEvent().
.SS "void QwtDblRange::incPages (int nPages)\fC [virtual]\fP"
.PP
Increment the value by a specified number of pages. 
.PP
\fBParameters:\fP
.RS 4
\fInPages\fP Number of pages to increment. A negative number decrements the value. 
.RE
.PP
\fBWarning:\fP
.RS 4
The Page size is specified in the constructor. 
.RE
.PP
Definition at line 271 of file qwt_drange.cpp.
.PP
References isValid().
.PP
Referenced by QwtSliderBase::mouseReleaseEvent(), QwtSliderBase::timerEvent(), and QwtSliderBase::wheelEvent().
.SS "void QwtDblRange::incValue (int nSteps)\fC [virtual]\fP"
.PP
Increment the value by a specified number of steps. 
.PP
\fBParameters:\fP
.RS 4
\fInSteps\fP Number of steps to increment 
.RE
.PP
\fBWarning:\fP
.RS 4
As a result of this operation, the new value will always be adjusted to the step raster. 
.RE
.PP

.PP
Reimplemented in \fBQwtSliderBase\fP.
.PP
Definition at line 259 of file qwt_drange.cpp.
.PP
References isValid().
.PP
Referenced by QwtSliderBase::incValue(), QwtSliderBase::keyPressEvent(), and QwtDial::keyPressEvent().
.SS "bool QwtDblRange::isValid () const"
.PP
Indicates if the value is valid. 
.PP
Reimplemented in \fBQwtSliderBase\fP.
.PP
Definition at line 51 of file qwt_drange.cpp.
.PP
Referenced by incPages(), incValue(), and QwtSliderBase::isValid().
.SS "double QwtDblRange::maxValue () const"
.PP
Returns the value of the second border of the range. 
.PP
maxValue returns the value which has been specified as the second parameter in \fBQwtDblRange::setRange\fP.
.PP
\fBSee also:\fP
.RS 4
\fBQwtDblRange::setRange()\fP 
.RE
.PP
Definition at line 326 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::drawContents(), QwtWheel::drawWheel(), QwtWheel::getValue(), QwtSlider::getValue(), QwtDial::getValue(), QwtDial::keyPressEvent(), QwtCounter::maxVal(), QwtSlider::rangeChange(), QwtSlider::scaleChange(), QwtCounter::setMinValue(), QwtDial::updateScale(), and QwtSlider::xyPosition().
.SS "double QwtDblRange::minValue () const"
.PP
Returns the value at the first border of the range. 
.PP
minValue returns the value which has been specified as the first parameter in \fBsetRange()\fP.
.PP
\fBSee also:\fP
.RS 4
\fBQwtDblRange::setRange()\fP 
.RE
.PP
Definition at line 339 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::drawContents(), QwtWheel::drawWheel(), QwtWheel::getValue(), QwtSlider::getValue(), QwtDial::getValue(), QwtDial::keyPressEvent(), QwtCounter::minVal(), QwtSlider::rangeChange(), QwtSlider::scaleChange(), QwtCounter::setMaxValue(), QwtDial::updateScale(), and QwtSlider::xyPosition().
.SS "int QwtDblRange::pageSize () const"
.PP
Returns the page size in steps. 
.PP
Definition at line 354 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::keyPressEvent().
.SS "bool QwtDblRange::periodic () const"
.PP
Returns TRUE if the range is periodic. 
.PP
\fBSee also:\fP
.RS 4
\fBQwtDblRange::setPeriodic()\fP 
.RE
.PP
Definition at line 348 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::wrapping().
.SS "double QwtDblRange::prevValue () const\fC [protected]\fP"
.PP
Returns the previous value. 
.PP
Definition at line 386 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::keyPressEvent(), QwtDial::keyPressEvent(), QwtSliderBase::mouseMoveEvent(), and QwtSliderBase::wheelEvent().
.SS "void QwtDblRange::rangeChange ()\fC [protected, virtual]\fP"
.PP
Notify a change of the range. 
.PP
This virtual function is called whenever the range changes. The default implementation does nothing. 
.PP
Reimplemented in \fBQwtCounter\fP, \fBQwtDial\fP, and \fBQwtSlider\fP.
.PP
Definition at line 294 of file qwt_drange.cpp.
.PP
Referenced by QwtSlider::rangeChange(), and setRange().
.SS "void QwtDblRange::setPeriodic (bool tf)"
.PP
Make the range periodic. 
.PP
When the range is periodic, the value will be set to a point inside the interval such that
.PP
.PP
.nf
 point = value + n * width .fi
.PP
.PP
if the user tries to set a new value which is outside the range. If the range is nonperiodic (the default), values outside the range will be clipped.
.PP
\fBParameters:\fP
.RS 4
\fItf\fP TRUE for a periodic range 
.RE
.PP
Definition at line 248 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::setWrapping().
.SS "void QwtDblRange::setRange (double vmin, double vmax, double vstep = \fC0.0\fP, int pageSize = \fC1\fP)"
.PP
Specify range and step size. 
.PP
\fBParameters:\fP
.RS 4
\fIvmin\fP lower boundary of the interval 
.br
\fIvmax\fP higher boundary of the interval 
.br
\fIvstep\fP step width 
.br
\fIpageSize\fP page size in steps 
.RE
.PP
\fBWarning:\fP
.RS 4
.PD 0
.IP "\(bu" 2
A change of the range changes the value if it lies outside the new range. The current value will *not* be adjusted to the new step raster. 
.IP "\(bu" 2
vmax < vmin is allowed. 
.IP "\(bu" 2
If the step size is left out or set to zero, it will be set to 1/100 of the interval length. 
.IP "\(bu" 2
If the step size has an absurd value, it will be corrected to a better one. 
.PP
.RE
.PP
Definition at line 169 of file qwt_drange.cpp.
.PP
References qwtLim(), rangeChange(), and setStep().
.PP
Referenced by QwtAnalogClock::QwtAnalogClock(), QwtCounter::QwtCounter(), QwtDial::QwtDial(), QwtSliderBase::QwtSliderBase(), QwtCounter::setMaxValue(), and QwtCounter::setMinValue().
.SS "void QwtDblRange::setStep (double vstep)"
.PP
Change the step raster. 
.PP
\fBParameters:\fP
.RS 4
\fIvstep\fP new step width 
.RE
.PP
\fBWarning:\fP
.RS 4
The value will \fInot\fP be adjusted to the new step raster. 
.RE
.PP

.PP
Reimplemented in \fBQwtCounter\fP.
.PP
Definition at line 208 of file qwt_drange.cpp.
.PP
References stepChange().
.PP
Referenced by setRange(), and QwtCounter::setStep().
.SS "void QwtDblRange::setValid (bool)"
.PP
Set the value to be valid/invalid. 
.PP
Reimplemented in \fBQwtSliderBase\fP.
.PP
Definition at line 41 of file qwt_drange.cpp.
.PP
References valueChange().
.PP
Referenced by QwtSliderBase::setValid().
.SS "void QwtDblRange::setValue (double x)\fC [virtual]\fP"
.PP
Set a new value without adjusting to the step raster. 
.PP
\fBParameters:\fP
.RS 4
\fIx\fP new value 
.RE
.PP
\fBWarning:\fP
.RS 4
The value is clipped when it lies outside the range. When the range is \fBQwtDblRange::periodic\fP, it will be mapped to a point in the interval such that 
.PP
.nf
 new value := x + n * (max. value - min. value)
.fi
.PP
with an integer number n. 
.RE
.PP

.PP
Reimplemented in \fBQwtCounter\fP, and \fBQwtSliderBase\fP.
.PP
Definition at line 147 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::setValue(), and QwtCounter::setValue().
.SS "double QwtDblRange::step () const"
.PP
\fBReturns:\fP
.RS 4
the step size 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtDblRange::setStep\fP, \fBQwtDblRange::setRange\fP 
.RE
.PP

.PP
Reimplemented in \fBQwtCounter\fP.
.PP
Definition at line 313 of file qwt_drange.cpp.
.PP
Referenced by QwtSliderBase::mouseReleaseEvent(), QwtCounter::setMaxValue(), QwtCounter::setMinValue(), QwtCounter::step(), and QwtSliderBase::timerEvent().
.SS "void QwtDblRange::stepChange ()\fC [protected, virtual]\fP"
.PP
Notify a change of the step size. 
.PP
This virtual function is called whenever the step size changes. The default implementation does nothing. Definition at line 305 of file qwt_drange.cpp.
.PP
Referenced by setStep().
.SS "double QwtDblRange::value () const"
.PP
Returns the current value. 
.PP
Reimplemented in \fBQwtCounter\fP.
.PP
Definition at line 360 of file qwt_drange.cpp.
.PP
Referenced by QwtDial::drawContents(), QwtAnalogClock::drawNeedle(), QwtCompass::drawScaleContents(), QwtSlider::drawSlider(), QwtWheel::drawWheel(), QwtSlider::getScrollMode(), QwtDial::getValue(), QwtSliderBase::keyPressEvent(), QwtDial::keyPressEvent(), QwtCompass::keyPressEvent(), QwtSliderBase::mouseMoveEvent(), QwtSliderBase::mousePressEvent(), QwtSliderBase::mouseReleaseEvent(), QwtSliderBase::timerEvent(), QwtCounter::value(), QwtSliderBase::valueChange(), and QwtSliderBase::wheelEvent().
.SS "void QwtDblRange::valueChange ()\fC [protected, virtual]\fP"
.PP
Notify a change of value. 
.PP
This virtual function is called whenever the value changes. The default implementation does nothing. 
.PP
Reimplemented in \fBQwtDial\fP, \fBQwtSliderBase\fP, \fBQwtSlider\fP, and \fBQwtWheel\fP.
.PP
Definition at line 283 of file qwt_drange.cpp.
.PP
Referenced by setValid().

.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code.