sani7/qwt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add files from zip

Browse Source
This commit is contained in:
Sani7
2023-10-31 09:22:42 +01:00
parent 6bacdc5f6d
commit 4dae68036f
2788 changed files with 492537 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

628
doc/man/man3/QwtAbstractScale.3 Normal file
View File

@@ -0,0 +1,628 @@
.TH "QwtAbstractScale" 3 "Sun Jul 18 2021" "Version 6.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtAbstractScale \- An abstract base class for widgets having a scale\&.
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_abstract_scale\&.h>\fP
.PP
Inherits QWidget\&.
.PP
Inherited by \fBQwtAbstractSlider\fP, and \fBQwtThermo\fP\&.
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBQwtAbstractScale\fP (QWidget *parent=NULL)"
.br
.ti -1c
.RI "virtual \fB~QwtAbstractScale\fP ()"
.br
.RI "Destructor\&. "
.ti -1c
.RI "void \fBsetScale\fP (double \fBlowerBound\fP, double \fBupperBound\fP)"
.br
.RI "Specify a scale\&. "
.ti -1c
.RI "void \fBsetScale\fP (const \fBQwtInterval\fP &)"
.br
.RI "Specify a scale\&. "
.ti -1c
.RI "void \fBsetScale\fP (const \fBQwtScaleDiv\fP &)"
.br
.RI "Specify a scale\&. "
.ti -1c
.RI "const \fBQwtScaleDiv\fP & \fBscaleDiv\fP () const"
.br
.ti -1c
.RI "void \fBsetLowerBound\fP (double value)"
.br
.ti -1c
.RI "double \fBlowerBound\fP () const"
.br
.ti -1c
.RI "void \fBsetUpperBound\fP (double value)"
.br
.ti -1c
.RI "double \fBupperBound\fP () const"
.br
.ti -1c
.RI "void \fBsetScaleStepSize\fP (double stepSize)"
.br
.RI "Set the step size used for calculating a scale division\&. "
.ti -1c
.RI "double \fBscaleStepSize\fP () const"
.br
.ti -1c
.RI "void \fBsetScaleMaxMajor\fP (int ticks)"
.br
.RI "Set the maximum number of major tick intervals\&. "
.ti -1c
.RI "int \fBscaleMaxMinor\fP () const"
.br
.ti -1c
.RI "void \fBsetScaleMaxMinor\fP (int ticks)"
.br
.RI "Set the maximum number of minor tick intervals\&. "
.ti -1c
.RI "int \fBscaleMaxMajor\fP () const"
.br
.ti -1c
.RI "void \fBsetScaleEngine\fP (\fBQwtScaleEngine\fP *)"
.br
.RI "Set a scale engine\&. "
.ti -1c
.RI "const \fBQwtScaleEngine\fP * \fBscaleEngine\fP () const"
.br
.ti -1c
.RI "\fBQwtScaleEngine\fP * \fBscaleEngine\fP ()"
.br
.ti -1c
.RI "int \fBtransform\fP (double) const"
.br
.ti -1c
.RI "double \fBinvTransform\fP (int) const"
.br
.ti -1c
.RI "bool \fBisInverted\fP () const"
.br
.ti -1c
.RI "double \fBminimum\fP () const"
.br
.ti -1c
.RI "double \fBmaximum\fP () const"
.br
.ti -1c
.RI "const \fBQwtScaleMap\fP & \fBscaleMap\fP () const"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "virtual void \fBchangeEvent\fP (QEvent *) override"
.br
.ti -1c
.RI "void \fBrescale\fP (double \fBlowerBound\fP, double \fBupperBound\fP, double stepSize)"
.br
.ti -1c
.RI "void \fBsetAbstractScaleDraw\fP (\fBQwtAbstractScaleDraw\fP *)"
.br
.RI "Set a scale draw\&. "
.ti -1c
.RI "const \fBQwtAbstractScaleDraw\fP * \fBabstractScaleDraw\fP () const"
.br
.ti -1c
.RI "\fBQwtAbstractScaleDraw\fP * \fBabstractScaleDraw\fP ()"
.br
.ti -1c
.RI "void \fBupdateScaleDraw\fP ()"
.br
.ti -1c
.RI "virtual void \fBscaleChange\fP ()"
.br
.RI "Notify changed scale\&. "
.in -1c
.SH "Detailed Description"
.PP
An abstract base class for widgets having a scale\&.
The scale of an \fBQwtAbstractScale\fP is determined by a \fBQwtScaleDiv\fP definition, that contains the boundaries and the ticks of the scale\&. The scale is painted using a \fBQwtScaleDraw\fP object\&.
.PP
The scale division might be assigned explicitly - but usually it is calculated from the boundaries using a \fBQwtScaleEngine\fP\&.
.PP
The scale engine also decides the type of transformation of the scale ( linear, logarithmic \&.\&.\&. )\&.
.PP
Definition at line 36 of file qwt_abstract_scale\&.h\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "QwtAbstractScale::QwtAbstractScale (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
Constructor
.PP
\fBParameters\fP
.RS 4
\fIparent\fP Parent widget
.RE
.PP
Creates a default \fBQwtScaleDraw\fP and a \fBQwtLinearScaleEngine\fP\&. The initial scale boundaries are set to [ 0\&.0, 100\&.0 ]
.PP
The \fBscaleStepSize()\fP is initialized to 0\&.0, \fBscaleMaxMajor()\fP to 5 and scaleMaxMajor to 3\&.
.PP
Definition at line 57 of file qwt_abstract_scale\&.cpp\&.
.SH "Member Function Documentation"
.PP
.SS "\fBQwtAbstractScaleDraw\fP * QwtAbstractScale::abstractScaleDraw ()\fC [protected]\fP"
.PP
\fBReturns\fP
.RS 4
Scale draw
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetAbstractScaleDraw()\fP
.RE
.PP
.PP
Definition at line 293 of file qwt_abstract_scale\&.cpp\&.
.SS "const \fBQwtAbstractScaleDraw\fP * QwtAbstractScale::abstractScaleDraw () const\fC [protected]\fP"
.PP
\fBReturns\fP
.RS 4
Scale draw
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetAbstractScaleDraw()\fP
.RE
.PP
.PP
Definition at line 302 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::changeEvent (QEvent * event)\fC [override]\fP, \fC [protected]\fP, \fC [virtual]\fP"
Change Event handler
.PP
\fBParameters\fP
.RS 4
\fIevent\fP Change event
.RE
.PP
Invalidates internal caches if necessary
.PP
Reimplemented in \fBQwtThermo\fP, \fBQwtSlider\fP, \fBQwtKnob\fP, and \fBQwtDial\fP\&.
.PP
Definition at line 453 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::invTransform (int value) const"
Translate a widget coordinate into a scale value
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Widget coordinate
.RE
.PP
\fBReturns\fP
.RS 4
Corresponding scale coordinate for value
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleMap()\fP, \fBtransform()\fP
.RE
.PP
.PP
Definition at line 381 of file qwt_abstract_scale\&.cpp\&.
.SS "bool QwtAbstractScale::isInverted () const"
.PP
\fBReturns\fP
.RS 4
True, when the scale is increasing in opposite direction to the widget coordinates
.RE
.PP
.PP
Definition at line 390 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::lowerBound () const"
.PP
\fBReturns\fP
.RS 4
Lower bound of the scale
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetLowerBound()\fP, \fBsetScale()\fP, \fBupperBound()\fP
.RE
.PP
.PP
Definition at line 88 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::maximum () const"
.PP
\fBReturns\fP
.RS 4
The boundary with the larger value
.RE
.PP
\fBSee also\fP
.RS 4
\fBminimum()\fP, \fBlowerBound()\fP, \fBupperBound()\fP
.RE
.PP
.PP
Definition at line 409 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::minimum () const"
.PP
\fBReturns\fP
.RS 4
The boundary with the smaller value
.RE
.PP
\fBSee also\fP
.RS 4
\fBmaximum()\fP, \fBlowerBound()\fP, \fBupperBound()\fP
.RE
.PP
.PP
Definition at line 399 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::rescale (double lowerBound, double upperBound, double stepSize)\fC [protected]\fP"
Recalculate the scale division and update the scale\&.
.PP
\fBParameters\fP
.RS 4
\fIlowerBound\fP Lower limit of the scale interval
.br
\fIupperBound\fP Upper limit of the scale interval
.br
\fIstepSize\fP Major step size
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleChange()\fP
.RE
.PP
.PP
Definition at line 429 of file qwt_abstract_scale\&.cpp\&.
.SS "const \fBQwtScaleDiv\fP & QwtAbstractScale::scaleDiv () const"
.PP
\fBReturns\fP
.RS 4
Scale boundaries and positions of the ticks
.RE
.PP
The scale division might have been assigned explicitly or calculated implicitly by \fBrescale()\fP\&.
.PP
Definition at line 349 of file qwt_abstract_scale\&.cpp\&.
.SS "\fBQwtScaleEngine\fP * QwtAbstractScale::scaleEngine ()"
.PP
\fBReturns\fP
.RS 4
Scale engine
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetScaleEngine()\fP
.RE
.PP
.PP
Definition at line 338 of file qwt_abstract_scale\&.cpp\&.
.SS "const \fBQwtScaleEngine\fP * QwtAbstractScale::scaleEngine () const"
.PP
\fBReturns\fP
.RS 4
Scale engine
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetScaleEngine()\fP
.RE
.PP
.PP
Definition at line 329 of file qwt_abstract_scale\&.cpp\&.
.SS "const \fBQwtScaleMap\fP & QwtAbstractScale::scaleMap () const"
.PP
\fBReturns\fP
.RS 4
Map to translate between scale and widget coordinates
.RE
.PP
.PP
Definition at line 357 of file qwt_abstract_scale\&.cpp\&.
.SS "int QwtAbstractScale::scaleMaxMajor () const"
.PP
\fBReturns\fP
.RS 4
Maximal number of major tick intervals
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetScaleMaxMajor()\fP, \fBscaleMaxMinor()\fP
.RE
.PP
.PP
Definition at line 202 of file qwt_abstract_scale\&.cpp\&.
.SS "int QwtAbstractScale::scaleMaxMinor () const"
.PP
\fBReturns\fP
.RS 4
Maximal number of minor tick intervals
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetScaleMaxMinor()\fP, \fBscaleMaxMajor()\fP
.RE
.PP
.PP
Definition at line 232 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::scaleStepSize () const"
.PP
\fBReturns\fP
.RS 4
Hint for the step size of the scale
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetScaleStepSize()\fP, \fBQwtScaleEngine::divideScale()\fP
.RE
.PP
.PP
Definition at line 264 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setAbstractScaleDraw (\fBQwtAbstractScaleDraw\fP * scaleDraw)\fC [protected]\fP"
.PP
Set a scale draw\&. scaleDraw has to be created with new and will be deleted in the destructor or the next call of \fBsetAbstractScaleDraw()\fP\&.
.PP
\fBSee also\fP
.RS 4
\fBabstractScaleDraw()\fP
.RE
.PP
.PP
Definition at line 277 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setLowerBound (double value)"
Set the lower bound of the scale
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Lower bound
.RE
.PP
\fBSee also\fP
.RS 4
\fBlowerBound()\fP, \fBsetScale()\fP, \fBsetUpperBound()\fP
.RE
.PP
\fBNote\fP
.RS 4
For inverted scales the lower bound is greater than the upper bound
.RE
.PP
.PP
Definition at line 79 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScale (const \fBQwtInterval\fP & interval)"
.PP
Specify a scale\&. Define a scale by an interval
.PP
The ticks are calculated using \fBscaleMaxMinor()\fP, \fBscaleMaxMajor()\fP and \fBscaleStepSize()\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIinterval\fP Interval
.RE
.PP
.PP
Definition at line 145 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScale (const \fBQwtScaleDiv\fP & scaleDiv)"
.PP
Specify a scale\&. \fBscaleMaxMinor()\fP, \fBscaleMaxMajor()\fP and \fBscaleStepSize()\fP and have no effect\&.
.PP
\fBParameters\fP
.RS 4
\fIscaleDiv\fP Scale division
.RE
.PP
\fBSee also\fP
.RS 4
setAutoScale()
.RE
.PP
.PP
Definition at line 158 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScale (double lowerBound, double upperBound)"
.PP
Specify a scale\&. Define a scale by an interval
.PP
The ticks are calculated using \fBscaleMaxMinor()\fP, \fBscaleMaxMajor()\fP and \fBscaleStepSize()\fP\&.
.PP
\fBParameters\fP
.RS 4
\fIlowerBound\fP lower limit of the scale interval
.br
\fIupperBound\fP upper limit of the scale interval
.RE
.PP
\fBNote\fP
.RS 4
For inverted scales the lower bound is greater than the upper bound
.RE
.PP
.PP
Definition at line 130 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScaleEngine (\fBQwtScaleEngine\fP * scaleEngine)"
.PP
Set a scale engine\&. The scale engine is responsible for calculating the scale division and provides a transformation between scale and widget coordinates\&.
.PP
scaleEngine has to be created with new and will be deleted in the destructor or the next call of setScaleEngine\&.
.PP
Definition at line 316 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScaleMaxMajor (int ticks)"
.PP
Set the maximum number of major tick intervals\&. The scale's major ticks are calculated automatically such that the number of major intervals does not exceed ticks\&.
.PP
The default value is 5\&.
.PP
\fBParameters\fP
.RS 4
\fIticks\fP Maximal number of major ticks\&.
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleMaxMajor()\fP, \fBsetScaleMaxMinor()\fP, \fBsetScaleStepSize()\fP, \fBQwtScaleEngine::divideInterval()\fP
.RE
.PP
.PP
Definition at line 189 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScaleMaxMinor (int ticks)"
.PP
Set the maximum number of minor tick intervals\&. The scale's minor ticks are calculated automatically such that the number of minor intervals does not exceed ticks\&. The default value is 3\&.
.PP
\fBParameters\fP
.RS 4
\fIticks\fP Maximal number of minor ticks\&.
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleMaxMajor()\fP, \fBsetScaleMaxMinor()\fP, \fBsetScaleStepSize()\fP, \fBQwtScaleEngine::divideInterval()\fP
.RE
.PP
.PP
Definition at line 219 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setScaleStepSize (double stepSize)"
.PP
Set the step size used for calculating a scale division\&. The step size is hint for calculating the intervals for the major ticks of the scale\&. A value of 0\&.0 is interpreted as no hint\&.
.PP
\fBParameters\fP
.RS 4
\fIstepSize\fP Hint for the step size of the scale
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleStepSize()\fP, \fBQwtScaleEngine::divideScale()\fP
.RE
.PP
\fBNote\fP
.RS 4
Position and distance between the major ticks also depends on \fBscaleMaxMajor()\fP\&.
.RE
.PP
.PP
Definition at line 251 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::setUpperBound (double value)"
Set the upper bound of the scale
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Upper bound
.RE
.PP
\fBSee also\fP
.RS 4
\fBupperBound()\fP, \fBsetScale()\fP, \fBsetLowerBound()\fP
.RE
.PP
\fBNote\fP
.RS 4
For inverted scales the lower bound is greater than the upper bound
.RE
.PP
.PP
Definition at line 102 of file qwt_abstract_scale\&.cpp\&.
.SS "int QwtAbstractScale::transform (double value) const"
Translate a scale value into a widget coordinate
.PP
\fBParameters\fP
.RS 4
\fIvalue\fP Scale value
.RE
.PP
\fBReturns\fP
.RS 4
Corresponding widget coordinate for value
.RE
.PP
\fBSee also\fP
.RS 4
\fBscaleMap()\fP, \fBinvTransform()\fP
.RE
.PP
.PP
Definition at line 369 of file qwt_abstract_scale\&.cpp\&.
.SS "void QwtAbstractScale::updateScaleDraw ()\fC [protected]\fP"
Recalculate ticks and scale boundaries\&.
.PP
Definition at line 466 of file qwt_abstract_scale\&.cpp\&.
.SS "double QwtAbstractScale::upperBound () const"
.PP
\fBReturns\fP
.RS 4
Upper bound of the scale
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetUpperBound()\fP, \fBsetScale()\fP, \fBlowerBound()\fP
.RE
.PP
.PP
Definition at line 111 of file qwt_abstract_scale\&.cpp\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.