Qwt User's Guide 5.2.2
|
A class which draws a scale inside the plot canvas. More...
#include <qwt_plot_scaleitem.h>
Public Types | |
enum | ItemAttribute { Legend = 1, AutoScale = 2 } |
enum | RenderHint { RenderAntialiased = 1 } |
enum | RttiValues { Rtti_PlotItem = 0, Rtti_PlotGrid, Rtti_PlotScale, Rtti_PlotMarker, Rtti_PlotCurve, Rtti_PlotHistogram, Rtti_PlotSpectrogram, Rtti_PlotSVG, Rtti_PlotUserItem = 1000 } |
Public Member Functions | |
void | attach (QwtPlot *plot) |
int | borderDistance () const |
virtual QwtDoubleRect | boundingRect () const |
void | detach () |
virtual void | draw (QPainter *p, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRect &rect) const |
QFont | font () const |
void | hide () |
QwtDoubleRect | invTransform (const QwtScaleMap &, const QwtScaleMap &, const QRect &) const |
bool | isScaleDivFromAxis () const |
bool | isVisible () const |
virtual void | itemChanged () |
virtual QWidget * | legendItem () const |
QRect | paintRect (const QwtScaleMap &, const QwtScaleMap &) const |
QPalette | palette () const |
QwtPlot * | plot () const |
double | position () const |
QwtPlotScaleItem (QwtScaleDraw::Alignment=QwtScaleDraw::BottomScale, const double pos=0.0) | |
virtual int | rtti () const |
const QwtScaleDiv & | scaleDiv () const |
const QwtScaleDraw * | scaleDraw () const |
QwtScaleDraw * | scaleDraw () |
QwtDoubleRect | scaleRect (const QwtScaleMap &, const QwtScaleMap &) const |
void | setAlignment (QwtScaleDraw::Alignment) |
void | setAxis (int xAxis, int yAxis) |
void | setBorderDistance (int numPixels) |
void | setFont (const QFont &) |
void | setItemAttribute (ItemAttribute, bool on=true) |
void | setPalette (const QPalette &) |
void | setPosition (double pos) |
void | setRenderHint (RenderHint, bool on=true) |
void | setScaleDiv (const QwtScaleDiv &) |
void | setScaleDivFromAxis (bool on) |
void | setScaleDraw (QwtScaleDraw *) |
void | setTitle (const QString &title) |
void | setTitle (const QwtText &title) |
virtual void | setVisible (bool) |
void | setXAxis (int axis) |
void | setYAxis (int axis) |
void | setZ (double z) |
void | show () |
bool | testItemAttribute (ItemAttribute) const |
bool | testRenderHint (RenderHint) const |
const QwtText & | title () const |
QRect | transform (const QwtScaleMap &, const QwtScaleMap &, const QwtDoubleRect &) const |
virtual void | updateLegend (QwtLegend *) const |
virtual void | updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &) |
int | xAxis () const |
int | yAxis () const |
double | z () const |
virtual | ~QwtPlotScaleItem () |
A class which draws a scale inside the plot canvas.
QwtPlotScaleItem can be used to draw an axis inside the plot canvas. It might by synchronized to one of the axis of the plot, but can also display its own ticks and labels.
It is allowed to synchronize the scale item with a disabled axis. In plots with vertical and horizontal scale items, it might be necessary to remove ticks at the intersections, by overloading updateScaleDiv().
The scale might be at a specific position (f.e 0.0) or it might be aligned to a canvas border.
QwtPlotScaleItem *scaleItem = new QwtPlotScaleItem(QwtScaleDraw::RightScale, 0.0); scaleItem->setFont(plot->axisWidget(QwtPlot::yLeft)->font()); scaleItem->attach(plot); plot->enableAxis(QwtPlot::yLeft, false);
enum QwtPlotItem::ItemAttribute [inherited] |
Plot Item Attributes
enum QwtPlotItem::RenderHint [inherited] |
Render hints.
enum QwtPlotItem::RttiValues [inherited] |
Runtime type information.
RttiValues is used to cast plot items, without having to enable runtime type information of the compiler.
QwtPlotScaleItem::QwtPlotScaleItem | ( | QwtScaleDraw::Alignment | alignment = QwtScaleDraw::BottomScale , |
const double | pos = 0.0 |
||
) | [explicit] |
Constructor for scale item at the position pos.
alignment | In case of QwtScaleDraw::BottomScale/QwtScaleDraw::TopScale the scale item is corresponding to the xAxis(), otherwise it corresponds to the yAxis(). |
pos | x or y position, depending on the corresponding axis. |
QwtPlotScaleItem::~QwtPlotScaleItem | ( | ) | [virtual] |
Destructor.
void QwtPlotItem::attach | ( | QwtPlot * | plot | ) | [inherited] |
Attach the item to a plot.
This method will attach a QwtPlotItem to the QwtPlot argument. It will first detach the QwtPlotItem from any plot from a previous call to attach (if necessary). If a NULL argument is passed, it will detach from any QwtPlot it was attached to.
plot | Plot widget |
int QwtPlotScaleItem::borderDistance | ( | ) | const |
QwtDoubleRect QwtPlotItem::boundingRect | ( | ) | const [virtual, inherited] |
Reimplemented in QwtPlotCurve, QwtPlotMarker, QwtPlotSpectrogram, and QwtPlotSvgItem.
void QwtPlotItem::detach | ( | ) | [inline, inherited] |
This method detaches a QwtPlotItem from any QwtPlot it has been associated with.
detach() is equivalent to calling attach( NULL )
void QwtPlotScaleItem::draw | ( | QPainter * | p, |
const QwtScaleMap & | xMap, | ||
const QwtScaleMap & | yMap, | ||
const QRect & | rect | ||
) | const [virtual] |
Draw the scale.
Implements QwtPlotItem.
QFont QwtPlotScaleItem::font | ( | ) | const |
void QwtPlotItem::hide | ( | ) | [inherited] |
Hide the item.
QwtDoubleRect QwtPlotItem::invTransform | ( | const QwtScaleMap & | xMap, |
const QwtScaleMap & | yMap, | ||
const QRect & | rect | ||
) | const [inherited] |
Transform a rectangle from paint to scale coordinates
xMap | X map |
yMap | Y map |
rect | Rectangle in paint coordinates |
bool QwtPlotScaleItem::isScaleDivFromAxis | ( | ) | const |
bool QwtPlotItem::isVisible | ( | ) | const [inherited] |
void QwtPlotItem::itemChanged | ( | ) | [virtual, inherited] |
Update the legend and call QwtPlot::autoRefresh for the parent plot.
QWidget * QwtPlotItem::legendItem | ( | ) | const [virtual, inherited] |
Allocate the widget that represents the item on the legend.
The default implementation is made for QwtPlotCurve and returns a QwtLegendItem(), but an item could be represented by any type of widget, by overloading legendItem() and updateLegend().
Implements QwtLegendItemManager.
QRect QwtPlotItem::paintRect | ( | const QwtScaleMap & | xMap, |
const QwtScaleMap & | yMap | ||
) | const [inherited] |
Calculate the bounding paint rect of 2 maps.
xMap | X map |
yMap | X map |
QPalette QwtPlotScaleItem::palette | ( | ) | const |
QwtPlot * QwtPlotItem::plot | ( | ) | const [inherited] |
Return attached plot.
double QwtPlotScaleItem::position | ( | ) | const |
int QwtPlotScaleItem::rtti | ( | ) | const [virtual] |
Reimplemented from QwtPlotItem.
const QwtScaleDiv & QwtPlotScaleItem::scaleDiv | ( | ) | const |
const QwtScaleDraw * QwtPlotScaleItem::scaleDraw | ( | ) | const |
QwtScaleDraw * QwtPlotScaleItem::scaleDraw | ( | ) |
QwtDoubleRect QwtPlotItem::scaleRect | ( | const QwtScaleMap & | xMap, |
const QwtScaleMap & | yMap | ||
) | const [inherited] |
Calculate the bounding scale rect of 2 maps.
xMap | X map |
yMap | X map |
void QwtPlotScaleItem::setAlignment | ( | QwtScaleDraw::Alignment | alignment | ) |
Change the alignment of the scale
The alignment sets the orientation of the scale and the position of the ticks:
For horizontal scales the position corresponds to QwtPlotItem::yAxis(), otherwise to QwtPlotItem::xAxis().
void QwtPlotItem::setAxis | ( | int | xAxis, |
int | yAxis | ||
) | [inherited] |
Set X and Y axis
The item will painted according to the coordinates its Axes.
xAxis | X Axis |
yAxis | Y Axis |
void QwtPlotScaleItem::setBorderDistance | ( | int | distance | ) |
Align the scale to the canvas.
If distance is >= 0 the scale will be aligned to a border of the contents rect of the canvas. If alignment() is QwtScaleDraw::LeftScale, the scale will be aligned to the right border, if it is QwtScaleDraw::TopScale it will be aligned to the bottom (and vice versa),
If distance is < 0 the scale will be at the position().
distance | Number of pixels between the canvas border and the backbone of the scale. |
void QwtPlotScaleItem::setFont | ( | const QFont & | font | ) |
Change the tick label font
void QwtPlotItem::setItemAttribute | ( | ItemAttribute | attribute, |
bool | on = true |
||
) | [inherited] |
Toggle an item attribute
attribute | Attribute type |
on | true/false |
void QwtPlotScaleItem::setPalette | ( | const QPalette & | palette | ) |
Set the palette
void QwtPlotScaleItem::setPosition | ( | double | pos | ) |
Change the position of the scale
The position is interpreted as y value for horizontal axes and as x value for vertical axes.
The border distance is set to -1.
pos | New position |
void QwtPlotItem::setRenderHint | ( | RenderHint | hint, |
bool | on = true |
||
) | [inherited] |
Toggle an render hint
hint | Render hint |
on | true/false |
void QwtPlotScaleItem::setScaleDiv | ( | const QwtScaleDiv & | scaleDiv | ) |
Assign a scale division.
When assigning a scaleDiv the scale division won't be synchronized with the corresponding axis anymore.
scaleDiv | Scale division |
void QwtPlotScaleItem::setScaleDivFromAxis | ( | bool | on | ) |
Enable/Disable the synchronization of the scale division with the corresponding axis.
on | true/false |
void QwtPlotScaleItem::setScaleDraw | ( | QwtScaleDraw * | scaleDraw | ) |
Set a scale draw.
scaleDraw | object responsible for drawing scales. |
The main use case for replacing the default QwtScaleDraw is to overload QwtAbstractScaleDraw::label, to replace or swallow tick labels.
void QwtPlotItem::setTitle | ( | const QString & | title | ) | [inherited] |
void QwtPlotItem::setTitle | ( | const QwtText & | title | ) | [inherited] |
void QwtPlotItem::setVisible | ( | bool | on | ) | [virtual, inherited] |
void QwtPlotItem::setXAxis | ( | int | axis | ) | [inherited] |
Set the X axis
The item will painted according to the coordinates its Axes.
axis | X Axis |
void QwtPlotItem::setYAxis | ( | int | axis | ) | [inherited] |
Set the Y axis
The item will painted according to the coordinates its Axes.
axis | Y Axis |
void QwtPlotItem::setZ | ( | double | z | ) | [inherited] |
Set the z value.
Plot items are painted in increasing z-order.
z | Z-value |
void QwtPlotItem::show | ( | ) | [inherited] |
Show the item.
bool QwtPlotItem::testItemAttribute | ( | ItemAttribute | attribute | ) | const [inherited] |
Test an item attribute
attribute | Attribute type |
bool QwtPlotItem::testRenderHint | ( | RenderHint | hint | ) | const [inherited] |
Test a render hint
hint | Render hint |
const QwtText & QwtPlotItem::title | ( | ) | const [inherited] |
QRect QwtPlotItem::transform | ( | const QwtScaleMap & | xMap, |
const QwtScaleMap & | yMap, | ||
const QwtDoubleRect & | rect | ||
) | const [inherited] |
Transform a rectangle
xMap | X map |
yMap | Y map |
rect | Rectangle in scale coordinates |
void QwtPlotItem::updateLegend | ( | QwtLegend * | legend | ) | const [virtual, inherited] |
Update the widget that represents the item on the legend.
updateLegend() is called from itemChanged() to adopt the widget representing the item on the legend to its new configuration.
The default implementation is made for QwtPlotCurve and updates a QwtLegendItem(), but an item could be represented by any type of widget, by overloading legendItem() and updateLegend().
legend | Legend |
Implements QwtLegendItemManager.
Reimplemented in QwtPlotCurve.
void QwtPlotScaleItem::updateScaleDiv | ( | const QwtScaleDiv & | xScaleDiv, |
const QwtScaleDiv & | yScaleDiv | ||
) | [virtual] |
Update the item to changes of the axes scale division.
In case of isScaleDivFromAxis(), the scale draw is synchronized to the correspond axis.
xScaleDiv | Scale division of the x-axis |
yScaleDiv | Scale division of the y-axis |
Reimplemented from QwtPlotItem.
int QwtPlotItem::xAxis | ( | ) | const [inherited] |
Return xAxis.
int QwtPlotItem::yAxis | ( | ) | const [inherited] |
Return yAxis.
double QwtPlotItem::z | ( | ) | const [inherited] |
Plot items are painted in increasing z-order.