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)
	Construct a division without ticks.

	QwtScaleDiv (const QwtInterval &, QList< double >[NTickTypes])
	Construct a scale division.

	QwtScaleDiv (double lowerBound, double upperBound, QList< double >[NTickTypes])
	Construct a scale division.

	QwtScaleDiv (double lowerBound, double upperBound, const QList< double > &minorTicks, const QList< double > &mediumTicks, const QList< double > &majorTicks)
	Construct a scale division.

	QwtScaleDiv (const QwtScaleDiv &)
	Copy constructor.

	QwtScaleDiv (QwtScaleDiv &&) noexcept=default

QwtScaleDiv &	operator= (const QwtScaleDiv &)
	Copy assignment.

QwtScaleDiv &	operator= (QwtScaleDiv &&) noexcept=default

bool	operator== (const QwtScaleDiv &) const
	Equality operator.

bool	operator!= (const QwtScaleDiv &) const
	Inequality operator.

bool	fuzzyCompare (const QwtScaleDiv &other) const
	Fuzzy comparison.

void	setInterval (double lowerBound, double upperBound)
	Change the interval.

void	setInterval (const QwtInterval &)
	Change the interval.

QwtInterval	interval () const
	Get the interval from lowerBound to upperBound.

void	setLowerBound (double) noexcept
	Set the first boundary.

double	lowerBound () const noexcept
	Get the first boundary.

void	setUpperBound (double) noexcept
	Set the second boundary.

double	upperBound () const noexcept
	Get the upper bound.

double	range () const noexcept
	Get the range (upperBound - lowerBound)

bool	contains (double value) const
	Check if a value is between lowerBound() and upperBound()

void	setTicks (int tickType, const QList< double > &)
	Assign ticks.

QList< double >	ticks (int tickType) const
	Return a list of ticks.

bool	isEmpty () const
	Check if the scale division is empty.

bool	isIncreasing () const
	Check if the scale division is increasing.

void	invert ()
	Invert the scale division.

QwtScaleDiv	inverted () const
	Get a scale division with inverted boundaries and ticks.

QwtScaleDiv	bounded (double lowerBound, double upperBound) const
	Return a scale division with an interval [lowerBound, upperBound] where all ticks outside this interval are removed.

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 upperBound() might be smaller than the lowerBound() to indicate inverted scales.

Scale divisions can be calculated from a QwtScaleEngine.

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

Member Enumeration Documentation

◆ TickType

enum QwtScaleDiv::TickType

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() [1/4]

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

explicit

Construct a division without ticks.

Parameters

lowerBound	First boundary
upperBound	Second boundary

Note: lowerBound might be greater than upperBound for inverted scales

◆ QwtScaleDiv() [2/4]

QwtScaleDiv::QwtScaleDiv	(	const QwtInterval &	interval,
		QList< double >	ticks[NTickTypes]
	)

explicit

Construct a scale division.

Parameters

interval	Interval
ticks	List of major, medium and minor ticks

◆ QwtScaleDiv() [3/4]

QwtScaleDiv::QwtScaleDiv	(	double	lowerBound,
		double	upperBound,
		QList< double >	ticks[NTickTypes]
	)

explicit

Construct a scale division.

Parameters

lowerBound	First boundary
upperBound	Second boundary
ticks	List of major, medium and minor ticks

Note: lowerBound might be greater than upperBound for inverted scales

◆ QwtScaleDiv() [4/4]

QwtScaleDiv::QwtScaleDiv	(	double	lowerBound,
		double	upperBound,
		const QList< double > &	minorTicks,
		const QList< double > &	mediumTicks,
		const QList< double > &	majorTicks
	)

explicit

Construct a scale division.

Parameters

lowerBound	First boundary
upperBound	Second boundary
minorTicks	List of minor ticks
mediumTicks	List of medium ticks
majorTicks	List of major ticks

Note: lowerBound might be greater than upperBound for inverted scales

Member Function Documentation

◆ bounded()

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

lowerBound	Lower bound
upperBound	Upper bound

Returns: Scale division with all ticks inside of the given interval

Note: lowerBound might be greater than upperBound for inverted scales

◆ contains()

bool QwtScaleDiv::contains ( double value ) const

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

Parameters

value Value

Returns: true if value is within bounds

◆ fuzzyCompare()

bool QwtScaleDiv::fuzzyCompare ( const QwtScaleDiv & other ) const

Fuzzy comparison.

Parameters

other Other scale division

Returns: true if this instance is approximately equal to other

◆ interval()

QwtInterval QwtScaleDiv::interval ( ) const

Get the interval from lowerBound to upperBound.

Returns: Interval from lowerBound to upperBound

◆ invert()

void QwtScaleDiv::invert ( )

Invert the scale division.

See also: inverted()

◆ inverted()

QwtScaleDiv QwtScaleDiv::inverted ( ) const

Get a scale division with inverted boundaries and ticks.

Returns: A scale division with inverted boundaries and ticks

See also: invert()

◆ isEmpty()

bool QwtScaleDiv::isEmpty ( ) const

Check if the scale division is empty.

Returns: true if lowerBound() == upperBound()

◆ isIncreasing()

bool QwtScaleDiv::isIncreasing ( ) const

Check if the scale division is increasing.

Returns: true if lowerBound() <= upperBound()

◆ lowerBound()

double QwtScaleDiv::lowerBound ( ) const

noexcept

Get the first boundary.

Returns: First boundary

See also: upperBound()

◆ operator!=()

bool QwtScaleDiv::operator!= ( const QwtScaleDiv & other ) const

Inequality operator.

Returns: true if this instance is not equal to other

◆ operator==()

bool QwtScaleDiv::operator== ( const QwtScaleDiv & other ) const

Equality operator.

Returns: true if this instance is equal to other

◆ range()

double QwtScaleDiv::range ( ) const

noexcept

Get the range (upperBound - lowerBound)

Returns: upperBound() - lowerBound()

◆ setInterval() [1/2]

void QwtScaleDiv::setInterval ( const QwtInterval & interval )

Change the interval.

Parameters

interval Interval

◆ setInterval() [2/2]

void QwtScaleDiv::setInterval	(	double	lowerBound,
		double	upperBound
	)

Change the interval.

Parameters

lowerBound	First boundary
upperBound	Second boundary

Note: lowerBound might be greater than upperBound for inverted scales

◆ setLowerBound()

void QwtScaleDiv::setLowerBound ( double lowerBound )

noexcept

Set the first boundary.

Parameters

lowerBound First boundary

See also: lowerBound(), setUpperBound()

◆ setTicks()

void QwtScaleDiv::setTicks	(	int	tickType,
		const QList< double > &	ticks
	)

Assign ticks.

Parameters

tickType	MinorTick, MediumTick or MajorTick
ticks	Values of the tick positions

◆ setUpperBound()

void QwtScaleDiv::setUpperBound ( double upperBound )

noexcept

Set the second boundary.

Parameters

upperBound Second boundary

See also: upperBound(), setLowerBound()

◆ ticks()

QList< double > QwtScaleDiv::ticks ( int tickType ) const

Return a list of ticks.

Parameters

tickType MinorTick, MediumTick or MajorTick

Returns: Tick list

◆ upperBound()

double QwtScaleDiv::upperBound ( ) const

noexcept

Get the upper bound.

Returns: Upper bound

See also: lowerBound()

The documentation for this class was generated from the following files:

/home/runner/work/QWT/QWT/src/core/qwt_scale_div.h
/home/runner/work/QWT/QWT/src/core/qwt_scale_div.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ TickType

Constructor & Destructor Documentation

◆ QwtScaleDiv() [1/4]

◆ QwtScaleDiv() [2/4]

◆ QwtScaleDiv() [3/4]

◆ QwtScaleDiv() [4/4]

Member Function Documentation

◆ bounded()

◆ contains()

◆ fuzzyCompare()

◆ interval()

◆ invert()

◆ inverted()

◆ isEmpty()

◆ isIncreasing()

◆ lowerBound()

◆ operator!=()

◆ operator==()

◆ range()

◆ setInterval() [1/2]

◆ setInterval() [2/2]

◆ setLowerBound()

◆ setTicks()

◆ setUpperBound()

◆ ticks()

◆ upperBound()