QwtPlotSeriesItem< T > Class Template Reference

Class template for plot items representing a series of samples. More...

#include <qwt_plot_seriesitem.h>

Inheritance diagram for QwtPlotSeriesItem< T >:

Inheritance graph
[legend]

List of all members.

Public Types

enum  ItemAttribute {
  Legend = 0x01,
  AutoScale = 0x02
}
typedef QFlags< ItemAttributeItemAttributes
enum  RenderHint { RenderAntialiased = 1 }
typedef QFlags< RenderHintRenderHints
enum  RttiValues {
  Rtti_PlotItem = 0,
  Rtti_PlotGrid,
  Rtti_PlotScale,
  Rtti_PlotMarker,
  Rtti_PlotCurve,
  Rtti_PlotSpectroCurve,
  Rtti_PlotIntervalCurve,
  Rtti_PlotHistogram,
  Rtti_PlotSpectrogram,
  Rtti_PlotSVG,
  Rtti_PlotUserItem = 1000
}

Public Member Functions

void attach (QwtPlot *plot)
virtual QRectF boundingRect () const
const QwtSeriesData< T > * data () const
QwtSeriesData< T > * data ()
size_t dataSize () const
void detach ()
virtual void draw (QPainter *p, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &) const
virtual void drawLegendIdentifier (QPainter *, const QRectF &) const
virtual void drawSeries (QPainter *painter, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF &canvasRect, int from, int to) const =0
void hide ()
bool isVisible () const
virtual void itemChanged ()
virtual QWidget * legendItem () const
Qt::Orientation orientation () const
QRectF paintRect (const QwtScaleMap &, const QwtScaleMap &) const
QwtPlotplot () const
 QwtPlotSeriesItem (const QwtText &title)
 QwtPlotSeriesItem (const QString &title=QString::null)
virtual int rtti () const
sample (int index) const
QRectF scaleRect (const QwtScaleMap &, const QwtScaleMap &) const
void setAxes (int xAxis, int yAxis)
void setData (QwtSeriesData< T > *)
void setItemAttribute (ItemAttribute, bool on=true)
void setOrientation (Qt::Orientation)
void setRenderHint (RenderHint, bool on=true)
void setTitle (const QwtText &title)
void setTitle (const QString &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 QwtTexttitle () const
virtual void updateLegend (QwtLegend *) const
virtual void updateScaleDiv (const QwtScaleDiv &, const QwtScaleDiv &)
int xAxis () const
int yAxis () const
double z () const
virtual ~QwtPlotSeriesItem ()

Protected Attributes

QwtSeriesData< T > * d_series


Detailed Description

template<typename T>
class QwtPlotSeriesItem< T >

Class template for plot items representing a series of samples.

Member Typedef Documentation

typedef QFlags<ItemAttribute> QwtPlotItem::ItemAttributes [inherited]

Plot Item Attributes.

typedef QFlags<RenderHint> QwtPlotItem::RenderHints [inherited]

Render hints.


Member Enumeration Documentation

enum QwtPlotItem::ItemAttribute [inherited]

Plot Item Attributes

See also:
setItemAttribute(), testItemAttribute()
Enumerator:
Legend  The item is represented on the legend.
AutoScale  The boundingRect() of the item is included in the autoscaling calculation.

enum QwtPlotItem::RenderHint [inherited]

Render hints.

Enumerator:
RenderAntialiased  Enable antialiasing.

enum QwtPlotItem::RttiValues [inherited]

Runtime type information.

RttiValues is used to cast plot items, without having to enable runtime type information of the compiler.


Constructor & Destructor Documentation

template<typename T >
QwtPlotSeriesItem< T >::QwtPlotSeriesItem ( const QString &  title = QString::null  )  [inline, explicit]

Constructor

Parameters:
title Title of the series item

template<typename T >
QwtPlotSeriesItem< T >::QwtPlotSeriesItem ( const QwtText title  )  [inline, explicit]

Constructor

Parameters:
title Title of the series item

template<typename T >
QwtPlotSeriesItem< T >::~QwtPlotSeriesItem (  )  [inline, virtual]

Destructor.


Member Function Documentation

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.

Parameters:
plot Plot widget
See also:
detach()

template<typename T >
QRectF QwtPlotSeriesItem< T >::boundingRect (  )  const [inline, virtual]

Returns:
Bounding rectangle of the data. If there is no bounding rect, like for empty data the rectangle is invalid.
See also:
QwtSeriesData<T>::boundingRect(), QRectF::isValid()

Reimplemented from QwtPlotItem.

Reimplemented in QwtPlotHistogram, and QwtPlotIntervalCurve.

template<typename T >
const QwtSeriesData< T > * QwtPlotSeriesItem< T >::data (  )  const [inline]

Returns:
the the curve data

template<typename T >
QwtSeriesData< T > * QwtPlotSeriesItem< T >::data (  )  [inline]

Returns:
the the curve data

template<typename T >
size_t QwtPlotSeriesItem< T >::dataSize (  )  const [inline]

Return the size of the data arrays

See also:
setData()

void QwtPlotItem::detach (  )  [inherited]

This method detaches a QwtPlotItem from any QwtPlot it has been associated with.

detach() is equivalent to calling attach( NULL )

See also:
attach()

void QwtPlotAbstractSeriesItem::draw ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect 
) const [virtual, inherited]

Draw the complete series.

Parameters:
painter Painter
xMap Maps x-values into pixel coordinates.
yMap Maps y-values into pixel coordinates.
canvasRect Contents rect of the canvas

Implements QwtPlotItem.

virtual void QwtLegendItemManager::drawLegendIdentifier ( QPainter *  ,
const QRectF &   
) const [inline, virtual, inherited]

QwtLegendItem can display an icon-identifier followed by a text. The icon helps to identify a plot item on the plot canvas and depends on the type of information, that is displayed.

The default implementation paints nothing.

Reimplemented in QwtPlotCurve, QwtPlotHistogram, QwtPlotIntervalCurve, and QwtPlotMarker.

virtual void QwtPlotAbstractSeriesItem::drawSeries ( QPainter *  painter,
const QwtScaleMap xMap,
const QwtScaleMap yMap,
const QRectF &  canvasRect,
int  from,
int  to 
) const [pure virtual, inherited]

Draw a subset of the samples

Parameters:
painter Painter
xMap Maps x-values into pixel coordinates.
yMap Maps y-values into pixel coordinates.
canvasRect Contents rect of the canvas
from Index of the first point to be painted
to Index of the last point to be painted. If to < 0 the curve will be painted to its last point.

Implemented in QwtPlotCurve, QwtPlotHistogram, QwtPlotIntervalCurve, and QwtPlotSpectroCurve.

void QwtPlotItem::hide (  )  [inherited]

Hide the item.

bool QwtPlotItem::isVisible (  )  const [inherited]

Returns:
true if visible
See also:
setVisible(), show(), hide()

void QwtPlotItem::itemChanged (  )  [virtual, inherited]

Update the legend and call QwtPlot::autoRefresh for the parent plot.

See also:
updateLegend()

QWidget * QwtPlotItem::legendItem (  )  const [virtual, inherited]

Allocate the widget that represents the item on the legend.

The default implementation returns a QwtLegendItem(), but an item could be represented by any type of widget, by overloading legendItem() and updateLegend().

Returns:
QwtLegendItem()
See also:
updateLegend() QwtLegend()

Implements QwtLegendItemManager.

Qt::Orientation QwtPlotAbstractSeriesItem::orientation (  )  const [inherited]

Returns:
Orientation of the plot item
See also:
setOrientation()

QRectF QwtPlotItem::paintRect ( const QwtScaleMap xMap,
const QwtScaleMap yMap 
) const [inherited]

Calculate the bounding paint rect of 2 maps.

Parameters:
xMap X map
yMap X map
Returns:
Bounding paint rect of the scale maps, normalized

QwtPlot * QwtPlotItem::plot (  )  const [inherited]

Return attached plot.

int QwtPlotItem::rtti (  )  const [virtual, inherited]

Return rtti for the specific class represented. QwtPlotItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.

The rtti value is useful for environments, where the runtime type information is disabled and it is not possible to do a dynamic_cast<...>.

Returns:
rtti value
See also:
RttiValues

Reimplemented in QwtPlotCurve, QwtPlotGrid, QwtPlotHistogram, QwtPlotIntervalCurve, QwtPlotMarker, QwtPlotScaleItem, QwtPlotSpectroCurve, QwtPlotSpectrogram, and QwtPlotSvgItem.

template<typename T >
T QwtPlotSeriesItem< T >::sample ( int  index  )  const [inline]

Parameters:
index Index
Returns:
Sample at position index

QRectF QwtPlotItem::scaleRect ( const QwtScaleMap xMap,
const QwtScaleMap yMap 
) const [inherited]

Calculate the bounding scale rect of 2 maps.

Parameters:
xMap X map
yMap X map
Returns:
Bounding scale rect of the scale maps, normalized

void QwtPlotItem::setAxes ( int  xAxis,
int  yAxis 
) [inherited]

Set X and Y axis

The item will painted according to the coordinates its Axes.

Parameters:
xAxis X Axis
yAxis Y Axis
See also:
setXAxis(), setYAxis(), xAxis(), yAxis()

template<typename T>
void QwtPlotSeriesItem< T >::setData ( QwtSeriesData< T > *  data  )  [inline]

Assign a series of samples

Parameters:
data Data
Warning:
The item takes ownership of the data object, deleting it when its not used anymore.

void QwtPlotItem::setItemAttribute ( ItemAttribute  attribute,
bool  on = true 
) [inherited]

Toggle an item attribute

Parameters:
attribute Attribute type
on true/false
See also:
testItemAttribute(), ItemAttribute

void QwtPlotAbstractSeriesItem::setOrientation ( Qt::Orientation  orientation  )  [inherited]

Set the orientation of the item.

The orientation() might be used in specific way by a plot item. F.e. a QwtPlotCurve uses it to identify how to display the curve int QwtPlotCurve::Steps or QwtPlotCurve::Sticks style.

See also:
orientation()

void QwtPlotItem::setRenderHint ( RenderHint  hint,
bool  on = true 
) [inherited]

Toggle an render hint

Parameters:
hint Render hint
on true/false
See also:
testRenderHint(), RenderHint

void QwtPlotItem::setTitle ( const QwtText title  )  [inherited]

Set a new title

Parameters:
title Title
See also:
title()

void QwtPlotItem::setTitle ( const QString &  title  )  [inherited]

Set a new title

Parameters:
title Title
See also:
title()

void QwtPlotItem::setVisible ( bool  on  )  [virtual, inherited]

Show/Hide the item

Parameters:
on Show if true, otherwise hide
See also:
isVisible(), show(), hide()

void QwtPlotItem::setXAxis ( int  axis  )  [inherited]

Set the X axis

The item will painted according to the coordinates its Axes.

Parameters:
axis X Axis
See also:
setAxes(), setYAxis(), xAxis()

void QwtPlotItem::setYAxis ( int  axis  )  [inherited]

Set the Y axis

The item will painted according to the coordinates its Axes.

Parameters:
axis Y Axis
See also:
setAxes(), setXAxis(), yAxis()

void QwtPlotItem::setZ ( double  z  )  [inherited]

Set the z value.

Plot items are painted in increasing z-order.

Parameters:
z Z-value
See also:
z(), QwtPlotDict::itemList()

void QwtPlotItem::show (  )  [inherited]

Show the item.

bool QwtPlotItem::testItemAttribute ( ItemAttribute  attribute  )  const [inherited]

Test an item attribute

Parameters:
attribute Attribute type
Returns:
true/false
See also:
setItemAttribute(), ItemAttribute

bool QwtPlotItem::testRenderHint ( RenderHint  hint  )  const [inherited]

Test a render hint

Parameters:
hint Render hint
Returns:
true/false
See also:
setRenderHint(), RenderHint

const QwtText & QwtPlotItem::title (  )  const [inherited]

Returns:
Title of the item
See also:
setTitle()

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 updates a QwtLegendItem(), but an item could be represented by any type of widget, by overloading legendItem() and updateLegend().

Parameters:
legend Legend
See also:
legendItem(), itemChanged(), QwtLegend()

Implements QwtLegendItemManager.

Reimplemented in QwtPlotCurve, and QwtPlotMarker.

template<typename T >
void QwtPlotSeriesItem< T >::updateScaleDiv ( const QwtScaleDiv xScaleDiv,
const QwtScaleDiv yScaleDiv 
) [inline, virtual]

Update the rect of interest according to the current scale ranges

Parameters:
xScaleDiv Scale division of the x-axis
yScaleDiv Scale division of the y-axis
See also:
QwtSeriesData<T>::setRectOfInterest()

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.

Returns:
setZ(), QwtPlotDict::itemList()


Member Data Documentation

template<typename T>
QwtSeriesData<T>* QwtPlotSeriesItem< T >::d_series [protected]

Series.


Generated on Wed Jan 11 15:23:03 2012 for Qwt User's Guide by  doxygen 1.5.9