logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

QwtThermo - The Thermometer Widget.

Author

       Generated automatically by Doxygen for Qwt User's Guide from the source code.

Version 6.1.4                                    Wed Jan 2 2019                                     QwtThermo(3)

Constructor & Destructor Documentation

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

       Parameters:parent Parent widget

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

Member Enumeration Documentation

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

       Seealso:setOriginMode(), setOrigin()EnumeratorOriginMinimum
              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.

   enumQwtThermo::ScalePosition
       Position of the scale

       Seealso:setScalePosition(), setOrientation()EnumeratorNoScale
              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.

Member Function Documentation

QBrushQwtThermo::alarmBrush()constReturns:
           Liquid brush ( QPalette::Highlight ) above the alarm threshold.

       Seealso:setAlarmBrush(), QWidget::palette()

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

   boolQwtThermo::alarmEnabled()constReturns:
           True, when the alarm threshold is enabled.

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

   doubleQwtThermo::alarmLevel()constReturns:
           Alarm threshold.

       Seealso:setAlarmLevel()Warning:
           The alarm threshold has no effect, when a color map has been assigned

   QRectQwtThermo::alarmRect(constQRect&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

       Seealso:pipeRect(), fillRect(), alarmLevel(), alarmBrush()intQwtThermo::borderWidth()constReturns:
           Border width of the thermometer pipe.

       Seealso:setBorderWidth()voidQwtThermo::changeEvent(QEvent*event)[protected],[virtual]
       Qt change event handler

       Parameters:event Event

   QwtColorMap*QwtThermo::colorMap()Returns:
           Color map for the fill color

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

   constQwtColorMap*QwtThermo::colorMap()constReturns:
           Color map for the fill color

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

   voidQwtThermo::drawLiquid(QPainter*painter,constQRect&pipeRect)const[protected],[virtual]
       Redraw the liquid in thermometer pipe.

       Parameters:painter Painter
           pipeRect Bounding rectangle of the pipe without borders

   QBrushQwtThermo::fillBrush()constReturns:
           Liquid ( QPalette::ButtonText ) brush.

       Seealso:setFillBrush(), QWidget::palette()

   QRectQwtThermo::fillRect(constQRect&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 )

       Seealso:pipeRect(), alarmRect()QSizeQwtThermo::minimumSizeHint()const[virtual]Returns:
           Minimum size hint

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

       Seealso:sizeHint()Qt::OrientationQwtThermo::orientation()constReturns:
           Orientation

       Seealso:setOrientation()doubleQwtThermo::origin()constReturns:
           Origin of the thermo, when OriginCustom is enabled

       Seealso:setOrigin(), setOriginMode(), originMode()QwtThermo::OriginModeQwtThermo::originMode()constReturns:
           Mode, how the origin is determined.

       Seealso:setOriginMode(), serOrigin(), origin()voidQwtThermo::paintEvent(QPaintEvent*event)[protected],[virtual]
       Paint event handler

       Parameters:event Paint event

   QRectQwtThermo::pipeRect()const[protected]Returns:
           Bounding rectangle of the pipe ( without borders ) in widget coordinates

   intQwtThermo::pipeWidth()constReturns:
           Width of the pipe.

       Seealso:setPipeWidth()QwtInterval::BorderFlagsQwtThermo::rangeFlags()constReturns:
           Range flags

       Seealso:setRangeFlags()voidQwtThermo::resizeEvent(QResizeEvent*event)[protected],[virtual]
       Resize event handler

       Parameters:event Resize event

   constQwtScaleDraw*QwtThermo::scaleDraw()constReturns:
           the scale draw of the thermo

       Seealso:setScaleDraw()QwtScaleDraw*QwtThermo::scaleDraw()[protected]Returns:
           the scale draw of the thermo

       Seealso:setScaleDraw()QwtThermo::ScalePositionQwtThermo::scalePosition()constReturns:
           Scale position.

       Seealso:setScalePosition()voidQwtThermo::setAlarmBrush(constQBrush&brush)
       Specify the liquid brush above the alarm threshold. Changes the QPalette::Highlight brush of the palette.

       Parameters:brush New brush.

       Seealso:alarmBrush(), QWidget::setPalette()

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

   voidQwtThermo::setAlarmEnabled(boolon)
       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

   voidQwtThermo::setAlarmLevel(doublelevel)
       Specify the alarm threshold.

       Parameters:level Alarm threshold

       Seealso:alarmLevel()Warning:
           The alarm threshold has no effect, when a color map has been assigned

   voidQwtThermo::setBorderWidth(intwidth)
       Set the border width of the pipe.

       Parameters:width Border width

       Seealso:borderWidth()voidQwtThermo::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

   voidQwtThermo::setFillBrush(constQBrush&brush)
       Change the brush of the liquid. Changes the QPalette::ButtonText brush of the palette.

       Parameters:brush New brush.

       Seealso:fillBrush(), QWidget::setPalette()

   voidQwtThermo::setOrientation(Qt::Orientationorientation)
       Set the orientation.

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

       Seealso:orientation(), scalePosition()voidQwtThermo::setOrigin(doubleorigin)
       Specifies the custom origin. If originMode is set to OriginCustom this property controls where the liquid
       starts.

       Parameters:origin New origin level

       Seealso:setOriginMode(), originMode(), origin()voidQwtThermo::setOriginMode(OriginModem)
       Change how the origin is determined.

       Seealso:originMode(), serOrigin(), origin()voidQwtThermo::setPipeWidth(intwidth)
       Change the width of the pipe.

       Parameters:width Width of the pipe

       Seealso:pipeWidth()voidQwtThermo::setRangeFlags(QwtInterval::BorderFlagsflags)
       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

       Seealso:rangeFlags()voidQwtThermo::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().

   voidQwtThermo::setScalePosition(ScalePositionscalePosition)
       Change the position of the scale.

       Parameters:scalePosition Position of the scale.

       Seealso:ScalePosition, scalePosition()voidQwtThermo::setSpacing(intspacing)
       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

       Seealso:spacing();

   voidQwtThermo::setValue(doublevalue)[virtual],[slot]
       Set the current value.

       Parameters:value New Value

       Seealso:value()QSizeQwtThermo::sizeHint()const[virtual]Returns:
           the minimum size hint

       Seealso:minimumSizeHint()intQwtThermo::spacing()constReturns:
           Number of pixels between pipe and scale

       Seealso:setSpacing()

Name

       QwtThermo - The Thermometer Widget.

Synopsis

       #include <qwt_thermo.h>

       Inherits QwtAbstractScale.

   PublicTypes
       enum ScalePosition { NoScale, LeadingScale, TrailingScale }
       enum OriginMode { OriginMinimum, OriginMaximum, OriginCustom }

   PublicSlots
       virtual void setValue (double)

   PublicMemberFunctionsQwtThermo (QWidget *parent=NULL)
       virtual ~QwtThermo ()
           Destructor.
       void setOrientation (Qt::Orientation)
           Set the orientation.
       Qt::Orientation orientation () const
       void setScalePosition (ScalePosition)
           Change the position of the scale.
       ScalePositionscalePosition () const
       void setSpacing (int)
           Change the spacing between pipe and scale.
       int spacing () const
       void setBorderWidth (int)
       int borderWidth () const
       void setOriginMode (OriginMode)
           Change how the origin is determined.
       OriginModeoriginMode () const
       void setOrigin (double)
           Specifies the custom origin.
       double origin () const
       void setFillBrush (const QBrush &)
           Change the brush of the liquid.
       QBrush fillBrush () const
       void setAlarmBrush (const QBrush &)
           Specify the liquid brush above the alarm threshold.
       QBrush alarmBrush () const
       void setAlarmLevel (double)
       double alarmLevel () const
       void setAlarmEnabled (bool)
           Enable or disable the alarm threshold.
       bool alarmEnabled () const
       void setColorMap (QwtColorMap *)
           Assign a color map for the fill color.
       QwtColorMap * colorMap ()
       const QwtColorMap * colorMap () const
       void setPipeWidth (int)
       int pipeWidth () const
       void setRangeFlags (QwtInterval::BorderFlags)
           Exclude/Include min/max values.
       QwtInterval::BorderFlagsrangeFlags () const
       double value () const
           Return the value.
       virtual QSize sizeHint () const
       virtual QSize minimumSizeHint () const
       void setScaleDraw (QwtScaleDraw *)
           Set a scale draw.
       const QwtScaleDraw * scaleDraw () const

   ProtectedMemberFunctions
       virtual void drawLiquid (QPainter *, const QRect &) const
       virtual void scaleChange ()
           Notify a scale change.
       virtual void paintEvent (QPaintEvent *)
       virtual void resizeEvent (QResizeEvent *)
       virtual void changeEvent (QEvent *)
       QwtScaleDraw * scaleDraw ()
       QRect pipeRect () const
       QRect fillRect (const QRect &) const
           Calculate the filled rectangle of the pipe.
       QRect alarmRect (const QRect &) const
           Calculate the alarm rectangle of the pipe.

See Also