The Thermometer Widget. More...

#include <qwt_thermo.h>

Inheritance diagram for QwtThermo:

Classes
class	PrivateData
Public Types
enum	OriginMode { OriginMinimum, OriginMaximum, OriginCustom }
enum	ScalePosition { NoScale, LeadingScale, TrailingScale }
Public Slots
virtual void	setValue (double val)
Public Member Functions
QBrush	alarmBrush () const
bool	alarmEnabled () const
double	alarmLevel () const
int	borderWidth () const
QwtColorMap *	colorMap ()
const QwtColorMap *	colorMap () const
QBrush	fillBrush () const
virtual QSize	minimumSizeHint () const
Qt::Orientation	orientation () const
double	origin () const
OriginMode	originMode () const
int	pipeWidth () const
	QwtThermo (QWidget *parent=NULL)
QwtInterval::BorderFlags	rangeFlags () const
const QwtScaleDraw *	scaleDraw () const
ScalePosition	scalePosition () const
void	setAlarmBrush (const QBrush &b)
	Specify the liquid brush above the alarm threshold.
void	setAlarmEnabled (bool tf)
	Enable or disable the alarm threshold.
void	setAlarmLevel (double v)
void	setBorderWidth (int w)
void	setColorMap (QwtColorMap *)
	Assign a color map for the fill color.
void	setFillBrush (const QBrush &b)
	Change the brush of the liquid.
void	setOrientation (Qt::Orientation)
	Set the orientation.
void	setOrigin (double)
	Specifies the custom origin.
void	setOriginMode (OriginMode)
	Change how the origin is determined.
void	setPipeWidth (int w)
void	setRangeFlags (QwtInterval::BorderFlags)
	Exclude/Include min/max values.
void	setScaleDraw (QwtScaleDraw *)
	Set a scale draw.
void	setScalePosition (ScalePosition)
	Change the position of the scale.
void	setSpacing (int)
	Change the spacing between pipe and scale.
virtual QSize	sizeHint () const
int	spacing () const
double	value () const
virtual	~QwtThermo ()
	Destructor.
Protected Member Functions
QRect	alarmRect (const QRect &) const
	Calculate the alarm rectangle of the pipe.
virtual void	changeEvent (QEvent *)
virtual void	drawLiquid (QPainter *, const QRect &) const
QRect	fillRect (const QRect &) const
	Calculate the filled rectangle of the pipe.
virtual void	paintEvent (QPaintEvent *)
QRect	pipeRect () const
virtual void	resizeEvent (QResizeEvent *)
virtual void	scaleChange ()
	Notify a scale change.
QwtScaleDraw *	scaleDraw ()
Properties
bool	alarmEnabled
double	alarmLevel
int	borderWidth
Qt::Orientation	orientation
double	origin
OriginMode	originMode
int	pipeWidth
ScalePosition	scalePosition
int	spacing
double	value
	Return the value.
Private Member Functions
void	layoutThermo (bool)
Private Attributes
PrivateData *	d_data

Detailed Description

The Thermometer Widget.

QwtThermo is a widget which displays a value in an interval. It supports:

a horizontal or vertical layout;
a range;
a scale;
an alarm level.

The fill colors might be calculated from an optional color map If no color map has been assigned QwtThermo uses the following colors/brushes from the widget palette:

QPalette::Base Background of the pipe
QPalette::ButtonText Fill brush below the alarm level
QPalette::Highlight Fill brush for the values above the alarm level
QPalette::WindowText For the axis of the scale
QPalette::Text For the labels of the scale

Definition at line 46 of file qwt_thermo.h.

Member Enumeration Documentation

enum QwtThermo::OriginMode

Origin mode. This property specifies where the beginning of the liquid is placed.

See also:: setOriginMode(), setOrigin()

Enumerator:

OriginMinimum	The origin is the minimum of the scale.
OriginMaximum	The origin is the maximum of the scale.
OriginCustom	The origin is specified using the origin() property.

Definition at line 91 of file qwt_thermo.h.

enum QwtThermo::ScalePosition

Position of the scale

See also:: setScalePosition(), setOrientation()

Enumerator:

NoScale	The slider has no scale.
LeadingScale	The scale is right of a vertical or below of a horizontal slider.
TrailingScale	The scale is left of a vertical or above of a horizontal slider.

Definition at line 73 of file qwt_thermo.h.

Constructor & Destructor Documentation

QwtThermo::QwtThermo ( QWidget * parent = NULL ) [explicit]

Constructor

Parameters:

parent Parent widget

Definition at line 117 of file qwt_thermo.cpp.

QwtThermo::~QwtThermo ( ) [virtual]

Destructor.

Definition at line 133 of file qwt_thermo.cpp.

Member Function Documentation

QBrush QwtThermo::alarmBrush ( ) const

Returns:: Liquid brush ( QPalette::Highlight ) above the alarm threshold.

See also:: setAlarmBrush(), QWidget::palette()

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 757 of file qwt_thermo.cpp.

bool QwtThermo::alarmEnabled ( ) const

double QwtThermo::alarmLevel ( ) const

QRect QwtThermo::alarmRect ( const QRect & fillRect ) const [protected]

Calculate the alarm rectangle of the pipe.

Parameters:

fillRect Filled rectangle in the pipe

Returns:: Rectangle to be filled with the alarm brush

See also:: pipeRect(), fillRect(), alarmLevel(), alarmBrush()

Definition at line 941 of file qwt_thermo.cpp.

int QwtThermo::borderWidth ( ) const

void QwtThermo::changeEvent ( QEvent * event ) [protected, virtual]

Qt change event handler

Parameters:

event Event

Reimplemented from QwtAbstractScale.

Definition at line 273 of file qwt_thermo.cpp.

QwtColorMap * QwtThermo::colorMap ( )

Returns:: Color map for the fill color

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 693 of file qwt_thermo.cpp.

const QwtColorMap * QwtThermo::colorMap ( ) const

Returns:: Color map for the fill color

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 703 of file qwt_thermo.cpp.

void QwtThermo::drawLiquid	(	QPainter *	painter,
		const QRect &	pipeRect
	)		const `[protected, virtual]`

Redraw the liquid in thermometer pipe.

Parameters:

painter	Painter
pipeRect	Bounding rectangle of the pipe without borders

Definition at line 542 of file qwt_thermo.cpp.

QBrush QwtThermo::fillBrush ( ) const

Returns:: Liquid ( QPalette::ButtonText ) brush.

See also:: setFillBrush(), QWidget::palette()

Definition at line 727 of file qwt_thermo.cpp.

QRect QwtThermo::fillRect ( const QRect & pipeRect ) const [protected]

Calculate the filled rectangle of the pipe.

Parameters:

pipeRect Rectangle of the pipe

Returns:: Rectangle to be filled ( fill and alarm brush )

See also:: pipeRect(), alarmRect()

Definition at line 894 of file qwt_thermo.cpp.

void QwtThermo::layoutThermo ( bool update_geometry ) [private]

Recalculate the QwtThermo geometry and layout based on pipeRect() and the fonts.

Parameters:

update_geometry notify the layout system and call update to redraw the scale

Definition at line 295 of file qwt_thermo.cpp.

QSize QwtThermo::minimumSizeHint ( ) const [virtual]

Returns:: Minimum size hint

Warning:: The return value depends on the font and the scale.

See also:: sizeHint()

Definition at line 852 of file qwt_thermo.cpp.

Qt::Orientation QwtThermo::orientation ( ) const

double QwtThermo::origin ( ) const

OriginMode QwtThermo::originMode ( ) const

void QwtThermo::paintEvent ( QPaintEvent * event ) [protected, virtual]

Paint event handler

Parameters:

event Paint event

Definition at line 231 of file qwt_thermo.cpp.

QRect QwtThermo::pipeRect ( ) const [protected]

Returns:: Bounding rectangle of the pipe ( without borders ) in widget coordinates

Definition at line 381 of file qwt_thermo.cpp.

int QwtThermo::pipeWidth ( ) const

QwtInterval::BorderFlags QwtThermo::rangeFlags ( ) const

Returns:: Range flags

See also:: setRangeFlags()

Definition at line 166 of file qwt_thermo.cpp.

void QwtThermo::resizeEvent ( QResizeEvent * event ) [protected, virtual]

Resize event handler

Parameters:

event Resize event

Definition at line 263 of file qwt_thermo.cpp.

void QwtThermo::scaleChange ( ) [protected, virtual]

Notify a scale change.

Reimplemented from QwtAbstractScale.

Definition at line 532 of file qwt_thermo.cpp.

const QwtScaleDraw * QwtThermo::scaleDraw ( ) const

Returns:: the scale draw of the thermo

See also:: setScaleDraw()

Definition at line 213 of file qwt_thermo.cpp.

QwtScaleDraw * QwtThermo::scaleDraw ( ) [protected]

Returns:: the scale draw of the thermo

See also:: setScaleDraw()

Definition at line 222 of file qwt_thermo.cpp.

ScalePosition QwtThermo::scalePosition ( ) const

void QwtThermo::setAlarmBrush ( const QBrush & brush )

Specify the liquid brush above the alarm threshold.

Changes the QPalette::Highlight brush of the palette.

Parameters:

brush New brush.

See also:: alarmBrush(), QWidget::setPalette()

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 743 of file qwt_thermo.cpp.

void QwtThermo::setAlarmEnabled ( bool on )

Enable or disable the alarm threshold.

Parameters:

on	true (disabled) or false (enabled)

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 821 of file qwt_thermo.cpp.

void QwtThermo::setAlarmLevel ( double level )

Specify the alarm threshold.

Parameters:

level Alarm threshold

See also:: alarmLevel()

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 771 of file qwt_thermo.cpp.

void QwtThermo::setBorderWidth ( int width )

Set the border width of the pipe.

Parameters:

width Border width

See also:: borderWidth()

Definition at line 651 of file qwt_thermo.cpp.

void QwtThermo::setColorMap ( QwtColorMap * colorMap )

Assign a color map for the fill color.

Parameters:

colorMap Color map

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 679 of file qwt_thermo.cpp.

void QwtThermo::setFillBrush ( const QBrush & brush )

Change the brush of the liquid.

Changes the QPalette::ButtonText brush of the palette.

Parameters:

brush New brush.

See also:: fillBrush(), QWidget::setPalette()

Definition at line 716 of file qwt_thermo.cpp.

void QwtThermo::setOrientation ( Qt::Orientation orientation )

Set the orientation.

Parameters:

orientation Allowed values are Qt::Horizontal and Qt::Vertical.

See also:: orientation(), scalePosition()

Definition at line 428 of file qwt_thermo.cpp.

void QwtThermo::setOrigin ( double origin )

Specifies the custom origin.

If originMode is set to OriginCustom this property controls where the liquid starts.

Parameters:

origin New origin level

See also:: setOriginMode(), originMode(), origin()

Definition at line 487 of file qwt_thermo.cpp.

void QwtThermo::setOriginMode ( OriginMode m )

Change how the origin is determined.

See also:: originMode(), serOrigin(), origin()

Definition at line 460 of file qwt_thermo.cpp.

void QwtThermo::setPipeWidth ( int width )

Change the width of the pipe.

Parameters:

width Width of the pipe

See also:: pipeWidth()

Definition at line 796 of file qwt_thermo.cpp.

void QwtThermo::setRangeFlags ( QwtInterval::BorderFlags flags )

Exclude/Include min/max values.

According to the flags minValue() and maxValue() are included/excluded from the pipe. In case of an excluded value the corresponding tick is painted 1 pixel off of the pipeRect().

F.e. when a minimum of 0.0 has to be displayed as an empty pipe the minValue() needs to be excluded.

Parameters:

flags Range flags

See also:: rangeFlags()

Definition at line 153 of file qwt_thermo.cpp.

void QwtThermo::setScaleDraw ( QwtScaleDraw * scaleDraw )

Set a scale draw.

For changing the labels of the scales, it is necessary to derive from QwtScaleDraw and overload QwtScaleDraw::label().

Parameters:

scaleDraw ScaleDraw object, that has to be created with new and will be deleted in ~QwtThermo() or the next call of setScaleDraw().

Definition at line 203 of file qwt_thermo.cpp.

void QwtThermo::setScalePosition ( ScalePosition scalePosition )

Change the position of the scale.

Parameters:

scalePosition Position of the scale.

See also:: ScalePosition, scalePosition()

Definition at line 511 of file qwt_thermo.cpp.

void QwtThermo::setSpacing ( int spacing )

Change the spacing between pipe and scale.

A spacing of 0 means, that the backbone of the scale is below the pipe.

The default setting is 3 pixels.

Parameters:

spacing Number of pixels

See also:: spacing();

Definition at line 625 of file qwt_thermo.cpp.

void QwtThermo::setValue ( double value ) [virtual, slot]

Set the current value.

Parameters:

value New Value

See also:: value()

Definition at line 177 of file qwt_thermo.cpp.

QSize QwtThermo::sizeHint ( ) const [virtual]

Returns:: the minimum size hint

See also:: minimumSizeHint()

Definition at line 842 of file qwt_thermo.cpp.

int QwtThermo::spacing ( ) const

double QwtThermo::value ( ) const

Member Data Documentation

PrivateData* QwtThermo::d_data [private]

Reimplemented from QwtAbstractScale.

Definition at line 174 of file qwt_thermo.h.

Property Documentation

bool QwtThermo::alarmEnabled [read, write]

Returns:: True, when the alarm threshold is enabled.

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 59 of file qwt_thermo.h.

double QwtThermo::alarmLevel [read, write]

Returns:: Alarm threshold.

See also:: setAlarmLevel()

Warning:: The alarm threshold has no effect, when a color map has been assigned

Definition at line 60 of file qwt_thermo.h.

int QwtThermo::borderWidth [read, write]

Returns:: Border width of the thermometer pipe.

See also:: setBorderWidth()

Definition at line 63 of file qwt_thermo.h.

Qt::Orientation QwtThermo::orientation [read, write]

Returns:: Orientation

See also:: setOrientation()

Definition at line 54 of file qwt_thermo.h.

double QwtThermo::origin [read, write]

Returns:: Origin of the thermo, when OriginCustom is enabled

See also:: setOrigin(), setOriginMode(), originMode()

Definition at line 61 of file qwt_thermo.h.

QwtThermo::OriginMode QwtThermo::originMode [read, write]

Returns:: Mode, how the origin is determined.

See also:: setOriginMode(), serOrigin(), origin()

Definition at line 57 of file qwt_thermo.h.

int QwtThermo::pipeWidth [read, write]

Returns:: Width of the pipe.

See also:: setPipeWidth()

Definition at line 64 of file qwt_thermo.h.

QwtThermo::ScalePosition QwtThermo::scalePosition [read, write]

Returns:: Scale position.

See also:: setScalePosition()

Definition at line 56 of file qwt_thermo.h.

int QwtThermo::spacing [read, write]

Returns:: Number of pixels between pipe and scale

See also:: setSpacing()

Definition at line 62 of file qwt_thermo.h.

double QwtThermo::value [read, write]

Return the value.

Definition at line 65 of file qwt_thermo.h.

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

Classes

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation