Qwt User's Guide  6.1.0
 All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | List of all members
QwtScaleDiv Class Reference

A class representing a scale division. More...

#include <qwt_scale_div.h>

Public Types

enum  TickType {
  NoTick = -1, MinorTick, MediumTick, MajorTick,
  NTickTypes
}
 Scale tick types. More...
 

Public Member Functions

 QwtScaleDiv (double lowerBound=0.0, double upperBound=0.0)
 
 QwtScaleDiv (const QwtInterval &, QList< double >[NTickTypes])
 
 QwtScaleDiv (double lowerBound, double upperBound, QList< double >[NTickTypes])
 
 QwtScaleDiv (double lowerBound, double upperBound, const QList< double > &minorTicks, const QList< double > &mediumTicks, const QList< double > &majorTicks)
 
bool operator== (const QwtScaleDiv &) const
 Equality operator. More...
 
bool operator!= (const QwtScaleDiv &) const
 Inequality. More...
 
void setInterval (double lowerBound, double upperBound)
 
void setInterval (const QwtInterval &)
 
QwtInterval interval () const
 
void setLowerBound (double)
 
double lowerBound () const
 
void setUpperBound (double)
 
double upperBound () const
 
double range () const
 
bool contains (double value) const
 
void setTicks (int tickType, const QList< double > &)
 
QList< double > ticks (int tickType) const
 
bool isEmpty () const
 Check if the scale division is empty( lowerBound() == upperBound() )
 
bool isIncreasing () const
 Check if the scale division is increasing( lowerBound() <= upperBound() )
 
void invert ()
 
QwtScaleDiv inverted () const
 
QwtScaleDiv bounded (double lowerBound, double upperBound) const
 

Detailed Description

A class representing a scale division.

A Qwt scale is defined by its boundaries and 3 list for the positions of the major, medium and minor ticks.

The upperLimit() might be smaller than the lowerLimit() to indicate inverted scales.

Scale divisions can be calculated from a QwtScaleEngine.

See Also
QwtScaleEngine::divideScale(), QwtPlot::setAxisScaleDiv(), QwtAbstractSlider::setScaleDiv()

Member Enumeration Documentation

Scale tick types.

Enumerator
NoTick 

No ticks.

MinorTick 

Minor ticks.

MediumTick 

Medium ticks.

MajorTick 

Major ticks.

NTickTypes 

Number of valid tick types.

Constructor & Destructor Documentation

QwtScaleDiv::QwtScaleDiv ( double  lowerBound = 0.0,
double  upperBound = 0.0 
)
explicit

Construct a division without ticks

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
Note
lowerBound might be greater than upperBound for inverted scales
QwtScaleDiv::QwtScaleDiv ( const QwtInterval interval,
QList< double >  ticks[NTickTypes] 
)
explicit

Construct a scale division

Parameters
intervalInterval
ticksList of major, medium and minor ticks
QwtScaleDiv::QwtScaleDiv ( double  lowerBound,
double  upperBound,
QList< double >  ticks[NTickTypes] 
)
explicit

Construct a scale division

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
ticksList of major, medium and minor ticks
Note
lowerBound might be greater than upperBound for inverted scales
QwtScaleDiv::QwtScaleDiv ( double  lowerBound,
double  upperBound,
const QList< double > &  minorTicks,
const QList< double > &  mediumTicks,
const QList< double > &  majorTicks 
)
explicit

Construct a scale division

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
minorTicksList of minor ticks
mediumTicksList medium ticks
majorTicksList of major ticks
Note
lowerBound might be greater than upperBound for inverted scales

Member Function Documentation

QwtScaleDiv QwtScaleDiv::bounded ( double  lowerBound,
double  upperBound 
) const

Return a scale division with an interval [lowerBound, upperBound] where all ticks outside this interval are removed

Parameters
lowerBoundLower bound
upperBoundUpper bound
Returns
Scale division with all ticks inside of the given interval
Note
lowerBound might be greater than upperBound for inverted scales
bool QwtScaleDiv::contains ( double  value) const

Return if a value is between lowerBound() and upperBound()

Parameters
valueValue
Returns
true/false
QwtInterval QwtScaleDiv::interval ( ) const
Returns
lowerBound -> upperBound
void QwtScaleDiv::invert ( )

Invert the scale division

See Also
inverted()
QwtScaleDiv QwtScaleDiv::inverted ( ) const
Returns
A scale division with inverted boundaries and ticks
See Also
invert()
double QwtScaleDiv::lowerBound ( ) const
Returns
First boundary
See Also
upperBound()
bool QwtScaleDiv::operator!= ( const QwtScaleDiv other) const

Inequality.

Returns
true if this instance is not equal to other
bool QwtScaleDiv::operator== ( const QwtScaleDiv other) const

Equality operator.

Returns
true if this instance is equal to other
double QwtScaleDiv::range ( ) const
void QwtScaleDiv::setInterval ( double  lowerBound,
double  upperBound 
)

Change the interval

Parameters
lowerBoundFirst boundary
upperBoundSecond boundary
Note
lowerBound might be greater than upperBound for inverted scales
void QwtScaleDiv::setInterval ( const QwtInterval interval)

Change the interval

Parameters
intervalInterval
void QwtScaleDiv::setLowerBound ( double  lowerBound)

Set the first boundary

Parameters
lowerBoundFirst boundary
See Also
lowerBiound(), setUpperBound()
void QwtScaleDiv::setTicks ( int  type,
const QList< double > &  ticks 
)

Assign ticks

Parameters
typeMinorTick, MediumTick or MajorTick
ticksValues of the tick positions
void QwtScaleDiv::setUpperBound ( double  upperBound)

Set the second boundary

Parameters
upperBoundSecond boundary
See Also
upperBound(), setLowerBound()
QList< double > QwtScaleDiv::ticks ( int  type) const

Return a list of ticks

Parameters
typeMinorTick, MediumTick or MajorTick
Returns
Tick list
double QwtScaleDiv::upperBound ( ) const
Returns
upper bound
See Also
lowerBound()