.TH "QwtPlotGrid" 3 "Mon Aug 1 2011" "Version 5.2.2" "Qwt User's Guide" \" -*- nroff -*- .ad l .nh .SH NAME QwtPlotGrid \- .PP A class which draws a coordinate grid. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBQwtPlotItem\fP. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBItemAttribute\fP { \fBLegend\fP = 1, \fBAutoScale\fP = 2 }" .br .ti -1c .RI "enum \fBRenderHint\fP { \fBRenderAntialiased\fP = 1 }" .br .ti -1c .RI "enum \fBRttiValues\fP { \fBRtti_PlotItem\fP = 0, \fBRtti_PlotGrid\fP, \fBRtti_PlotScale\fP, \fBRtti_PlotMarker\fP, \fBRtti_PlotCurve\fP, \fBRtti_PlotHistogram\fP, \fBRtti_PlotSpectrogram\fP, \fBRtti_PlotSVG\fP, \fBRtti_PlotUserItem\fP = 1000 }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "void \fBattach\fP (\fBQwtPlot\fP *plot)" .br .ti -1c .RI "virtual QwtDoubleRect \fBboundingRect\fP () const " .br .ti -1c .RI "void \fBdetach\fP ()" .br .ti -1c .RI "virtual void \fBdraw\fP (QPainter *p, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &rect) const " .br .ti -1c .RI "void \fBenableX\fP (bool tf)" .br .ti -1c .RI "void \fBenableXMin\fP (bool tf)" .br .ti -1c .RI "void \fBenableY\fP (bool tf)" .br .ti -1c .RI "void \fBenableYMin\fP (bool tf)" .br .ti -1c .RI "void \fBhide\fP ()" .br .ti -1c .RI "QwtDoubleRect \fBinvTransform\fP (const \fBQwtScaleMap\fP &, const \fBQwtScaleMap\fP &, const QRect &) const " .br .ti -1c .RI "bool \fBisVisible\fP () const " .br .ti -1c .RI "virtual void \fBitemChanged\fP ()" .br .ti -1c .RI "virtual QWidget * \fBlegendItem\fP () const " .br .ti -1c .RI "const QPen & \fBmajPen\fP () const " .br .ti -1c .RI "const QPen & \fBminPen\fP () const " .br .ti -1c .RI "QRect \fBpaintRect\fP (const \fBQwtScaleMap\fP &, const \fBQwtScaleMap\fP &) const " .br .ti -1c .RI "\fBQwtPlot\fP * \fBplot\fP () const " .br .ti -1c .RI "\fBQwtPlotGrid\fP ()" .br .ti -1c .RI "virtual int \fBrtti\fP () const " .br .ti -1c .RI "QwtDoubleRect \fBscaleRect\fP (const \fBQwtScaleMap\fP &, const \fBQwtScaleMap\fP &) const " .br .ti -1c .RI "void \fBsetAxis\fP (int xAxis, int yAxis)" .br .ti -1c .RI "void \fBsetItemAttribute\fP (\fBItemAttribute\fP, bool on=true)" .br .ti -1c .RI "void \fBsetMajPen\fP (const QPen &p)" .br .ti -1c .RI "void \fBsetMinPen\fP (const QPen &p)" .br .ti -1c .RI "void \fBsetPen\fP (const QPen &p)" .br .ti -1c .RI "void \fBsetRenderHint\fP (\fBRenderHint\fP, bool on=true)" .br .ti -1c .RI "void \fBsetTitle\fP (const QString &title)" .br .ti -1c .RI "void \fBsetTitle\fP (const \fBQwtText\fP &title)" .br .ti -1c .RI "virtual void \fBsetVisible\fP (bool)" .br .ti -1c .RI "void \fBsetXAxis\fP (int axis)" .br .ti -1c .RI "void \fBsetXDiv\fP (const \fBQwtScaleDiv\fP &sx)" .br .ti -1c .RI "void \fBsetYAxis\fP (int axis)" .br .ti -1c .RI "void \fBsetYDiv\fP (const \fBQwtScaleDiv\fP &sy)" .br .ti -1c .RI "void \fBsetZ\fP (double z)" .br .ti -1c .RI "void \fBshow\fP ()" .br .ti -1c .RI "bool \fBtestItemAttribute\fP (\fBItemAttribute\fP) const " .br .ti -1c .RI "bool \fBtestRenderHint\fP (\fBRenderHint\fP) const " .br .ti -1c .RI "const \fBQwtText\fP & \fBtitle\fP () const " .br .ti -1c .RI "QRect \fBtransform\fP (const \fBQwtScaleMap\fP &, const \fBQwtScaleMap\fP &, const QwtDoubleRect &) const " .br .ti -1c .RI "virtual void \fBupdateLegend\fP (\fBQwtLegend\fP *) const " .br .ti -1c .RI "virtual void \fBupdateScaleDiv\fP (const \fBQwtScaleDiv\fP &xMap, const \fBQwtScaleDiv\fP &yMap)" .br .ti -1c .RI "int \fBxAxis\fP () const " .br .ti -1c .RI "bool \fBxEnabled\fP () const " .br .ti -1c .RI "bool \fBxMinEnabled\fP () const " .br .ti -1c .RI "const \fBQwtScaleDiv\fP & \fBxScaleDiv\fP () const " .br .ti -1c .RI "int \fByAxis\fP () const " .br .ti -1c .RI "bool \fByEnabled\fP () const " .br .ti -1c .RI "bool \fByMinEnabled\fP () const " .br .ti -1c .RI "const \fBQwtScaleDiv\fP & \fByScaleDiv\fP () const " .br .ti -1c .RI "double \fBz\fP () const " .br .ti -1c .RI "virtual \fB~QwtPlotGrid\fP ()" .br .in -1c .SH "Detailed Description" .PP A class which draws a coordinate grid. The \fBQwtPlotGrid\fP class can be used to draw a coordinate grid. A coordinate grid consists of major and minor vertical and horizontal gridlines. The locations of the gridlines are determined by the X and Y scale divisions which can be assigned with \fBsetXDiv()\fP and \fBsetYDiv()\fP. The \fBdraw()\fP member draws the grid within a bounding rectangle. .SH "Member Enumeration Documentation" .PP .SS "enum \fBQwtPlotItem::ItemAttribute\fP\fC [inherited]\fP"Plot Item Attributes .PP .IP "\(bu" 2 Legend .br The item is represented on the legend. .IP "\(bu" 2 AutoScale .br The \fBboundingRect()\fP of the item is included in the autoscaling calculation. .PP .PP \fBSee also:\fP .RS 4 \fBsetItemAttribute()\fP, \fBtestItemAttribute()\fP .RE .PP .SS "enum \fBQwtPlotItem::RenderHint\fP\fC [inherited]\fP" .PP Render hints. .SS "enum \fBQwtPlotItem::RttiValues\fP\fC [inherited]\fP" .PP Runtime type information. RttiValues is used to cast plot items, without having to enable runtime type information of the compiler. .SH "Constructor & Destructor Documentation" .PP .SS "QwtPlotGrid::QwtPlotGrid ()\fC [explicit]\fP" .PP Enables major grid, disables minor grid. .SS "QwtPlotGrid::~QwtPlotGrid ()\fC [virtual]\fP" .PP Destructor. .SH "Member Function Documentation" .PP .SS "void QwtPlotItem::attach (\fBQwtPlot\fP *plot)\fC [inherited]\fP" .PP Attach the item to a plot. This method will attach a \fBQwtPlotItem\fP to the \fBQwtPlot\fP argument. It will first detach the \fBQwtPlotItem\fP from any plot from a previous call to attach (if necessary). If a NULL argument is passed, it will detach from any \fBQwtPlot\fP it was attached to. .PP \fBParameters:\fP .RS 4 \fIplot\fP Plot widget .RE .PP \fBSee also:\fP .RS 4 \fBQwtPlotItem::detach()\fP .RE .PP .SS "QwtDoubleRect QwtPlotItem::boundingRect () const\fC [virtual, inherited]\fP"\fBReturns:\fP .RS 4 An invalid bounding rect: QwtDoubleRect(1.0, 1.0, \-2.0, \-2.0) .RE .PP .PP Reimplemented in \fBQwtPlotCurve\fP, \fBQwtPlotMarker\fP, \fBQwtPlotSpectrogram\fP, and \fBQwtPlotSvgItem\fP. .SS "void QwtPlotItem::detach ()\fC [inline, inherited]\fP" .PP This method detaches a \fBQwtPlotItem\fP from any \fBQwtPlot\fP it has been associated with. \fBdetach()\fP is equivalent to calling attach( NULL ) .PP \fBSee also:\fP .RS 4 \fBattach( QwtPlot* plot )\fP .RE .PP .SS "void QwtPlotGrid::draw (QPainter *painter, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &canvasRect) const\fC [virtual]\fP" .PP Draw the grid. The grid is drawn into the bounding rectangle such that gridlines begin and end at the rectangle's borders. The X and Y maps are used to map the scale divisions into the drawing region screen. .PP \fBParameters:\fP .RS 4 \fIpainter\fP Painter .br \fIxMap\fP X axis map .br \fIyMap\fP Y axis .br \fIcanvasRect\fP Contents rect of the plot canvas .RE .PP .PP Implements \fBQwtPlotItem\fP. .SS "void QwtPlotGrid::enableX (booltf)" .PP Enable or disable vertical gridlines. \fBParameters:\fP .RS 4 \fItf\fP Enable (true) or disable .RE .PP \fBSee also:\fP .RS 4 Minor gridlines can be enabled or disabled with \fBenableXMin()\fP .RE .PP .SS "void QwtPlotGrid::enableXMin (booltf)" .PP Enable or disable minor vertical gridlines. \fBParameters:\fP .RS 4 \fItf\fP Enable (true) or disable .RE .PP \fBSee also:\fP .RS 4 \fBenableX()\fP .RE .PP .SS "void QwtPlotGrid::enableY (booltf)" .PP Enable or disable horizontal gridlines. \fBParameters:\fP .RS 4 \fItf\fP Enable (true) or disable .RE .PP \fBSee also:\fP .RS 4 Minor gridlines can be enabled or disabled with \fBenableYMin()\fP .RE .PP .SS "void QwtPlotGrid::enableYMin (booltf)" .PP Enable or disable minor horizontal gridlines. \fBParameters:\fP .RS 4 \fItf\fP Enable (true) or disable .RE .PP \fBSee also:\fP .RS 4 \fBenableY()\fP .RE .PP .SS "void QwtPlotItem::hide ()\fC [inherited]\fP" .PP Hide the item. .SS "QwtDoubleRect QwtPlotItem::invTransform (const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRect &rect) const\fC [inherited]\fP"Transform a rectangle from paint to scale coordinates .PP \fBParameters:\fP .RS 4 \fIxMap\fP X map .br \fIyMap\fP Y map .br \fIrect\fP Rectangle in paint coordinates .RE .PP \fBReturns:\fP .RS 4 Rectangle in scale coordinates .RE .PP \fBSee also:\fP .RS 4 \fBtransform()\fP .RE .PP .SS "bool QwtPlotItem::isVisible () const\fC [inherited]\fP"\fBReturns:\fP .RS 4 true if visible .RE .PP \fBSee also:\fP .RS 4 \fBsetVisible()\fP, \fBshow()\fP, \fBhide()\fP .RE .PP .SS "void QwtPlotItem::itemChanged ()\fC [virtual, inherited]\fP"Update the legend and call \fBQwtPlot::autoRefresh\fP for the parent plot. .PP \fBSee also:\fP .RS 4 \fBupdateLegend()\fP .RE .PP .SS "QWidget * QwtPlotItem::legendItem () const\fC [virtual, inherited]\fP" .PP Allocate the widget that represents the item on the legend. The default implementation is made for \fBQwtPlotCurve\fP and returns a QwtLegendItem(), but an item could be represented by any type of widget, by overloading \fBlegendItem()\fP and \fBupdateLegend()\fP. .PP \fBReturns:\fP .RS 4 QwtLegendItem() .RE .PP \fBSee also:\fP .RS 4 \fBupdateLegend()\fP QwtLegend() .RE .PP .PP Implements \fBQwtLegendItemManager\fP. .SS "const QPen & QwtPlotGrid::majPen () const"\fBReturns:\fP .RS 4 the pen for the major gridlines .RE .PP \fBSee also:\fP .RS 4 \fBsetMajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP .RE .PP .SS "const QPen & QwtPlotGrid::minPen () const"\fBReturns:\fP .RS 4 the pen for the minor gridlines .RE .PP \fBSee also:\fP .RS 4 \fBsetMinPen()\fP, \fBsetMajPen()\fP, \fBsetPen()\fP .RE .PP .SS "QRect QwtPlotItem::paintRect (const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap) const\fC [inherited]\fP" .PP Calculate the bounding paint rect of 2 maps. \fBParameters:\fP .RS 4 \fIxMap\fP X map .br \fIyMap\fP X map .RE .PP \fBReturns:\fP .RS 4 Bounding rect of the scale maps .RE .PP .SS "\fBQwtPlot\fP * QwtPlotItem::plot () const\fC [inherited]\fP" .PP Return attached plot. .SS "int QwtPlotGrid::rtti () const\fC [virtual]\fP"\fBReturns:\fP .RS 4 QwtPlotItem::Rtti_PlotGrid .RE .PP .PP Reimplemented from \fBQwtPlotItem\fP. .SS "QwtDoubleRect QwtPlotItem::scaleRect (const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap) const\fC [inherited]\fP" .PP Calculate the bounding scale rect of 2 maps. \fBParameters:\fP .RS 4 \fIxMap\fP X map .br \fIyMap\fP X map .RE .PP \fBReturns:\fP .RS 4 Bounding rect of the scale maps .RE .PP .SS "void QwtPlotItem::setAxis (intxAxis, intyAxis)\fC [inherited]\fP"Set X and Y axis .PP The item will painted according to the coordinates its Axes. .PP \fBParameters:\fP .RS 4 \fIxAxis\fP X Axis .br \fIyAxis\fP Y Axis .RE .PP \fBSee also:\fP .RS 4 \fBsetXAxis()\fP, \fBsetYAxis()\fP, \fBxAxis()\fP, \fByAxis()\fP .RE .PP .SS "void QwtPlotItem::setItemAttribute (\fBItemAttribute\fPattribute, boolon = \fCtrue\fP)\fC [inherited]\fP"Toggle an item attribute .PP \fBParameters:\fP .RS 4 \fIattribute\fP Attribute type .br \fIon\fP true/false .RE .PP \fBSee also:\fP .RS 4 \fBtestItemAttribute()\fP, \fBItemAttribute\fP .RE .PP .SS "void QwtPlotGrid::setMajPen (const QPen &pen)"Assign a pen for the major gridlines .PP The width of non cosmetic pens is scaled according to the resolution of the paint device. .PP \fBParameters:\fP .RS 4 \fIpen\fP Pen .RE .PP \fBSee also:\fP .RS 4 \fBmajPen()\fP, \fBsetMinPen()\fP, \fBsetPen()\fP, \fBQwtPainter::scaledPen()\fP .RE .PP .SS "void QwtPlotGrid::setMinPen (const QPen &pen)"Assign a pen for the minor gridlines .PP The width of non cosmetic pens is scaled according to the resolution of the paint device. .PP \fBParameters:\fP .RS 4 \fIpen\fP Pen .RE .PP \fBSee also:\fP .RS 4 \fBminPen()\fP, \fBsetMajPen()\fP, \fBsetPen()\fP, \fBQwtPainter::scaledPen()\fP .RE .PP .SS "void QwtPlotGrid::setPen (const QPen &pen)"Assign a pen for both major and minor gridlines .PP The width of non cosmetic pens is scaled according to the resolution of the paint device. .PP \fBParameters:\fP .RS 4 \fIpen\fP Pen .RE .PP \fBSee also:\fP .RS 4 \fBsetMajPen()\fP, \fBsetMinPen()\fP, \fBQwtPainter::scaledPen()\fP .RE .PP .SS "void QwtPlotItem::setRenderHint (\fBRenderHint\fPhint, boolon = \fCtrue\fP)\fC [inherited]\fP"Toggle an render hint .PP \fBParameters:\fP .RS 4 \fIhint\fP Render hint .br \fIon\fP true/false .RE .PP \fBSee also:\fP .RS 4 \fBtestRenderHint()\fP, \fBRenderHint\fP .RE .PP .SS "void QwtPlotItem::setTitle (const \fBQwtText\fP &title)\fC [inherited]\fP"Set a new title .PP \fBParameters:\fP .RS 4 \fItitle\fP Title .RE .PP \fBSee also:\fP .RS 4 \fBtitle()\fP .RE .PP .SS "void QwtPlotItem::setTitle (const QString &title)\fC [inherited]\fP"Set a new title .PP \fBParameters:\fP .RS 4 \fItitle\fP Title .RE .PP \fBSee also:\fP .RS 4 \fBtitle()\fP .RE .PP .SS "void QwtPlotItem::setVisible (boolon)\fC [virtual, inherited]\fP"Show/Hide the item .PP \fBParameters:\fP .RS 4 \fIon\fP Show if true, otherwise hide .RE .PP \fBSee also:\fP .RS 4 \fBisVisible()\fP, \fBshow()\fP, \fBhide()\fP .RE .PP .SS "void QwtPlotItem::setXAxis (intaxis)\fC [inherited]\fP"Set the X axis .PP The item will painted according to the coordinates its Axes. .PP \fBParameters:\fP .RS 4 \fIaxis\fP X Axis .RE .PP \fBSee also:\fP .RS 4 \fBsetAxis()\fP, \fBsetYAxis()\fP, \fBxAxis()\fP .RE .PP .SS "void QwtPlotGrid::setXDiv (const \fBQwtScaleDiv\fP &scaleDiv)"Assign an x axis scale division .PP \fBParameters:\fP .RS 4 \fIscaleDiv\fP Scale division .RE .PP .SS "void QwtPlotItem::setYAxis (intaxis)\fC [inherited]\fP"Set the Y axis .PP The item will painted according to the coordinates its Axes. .PP \fBParameters:\fP .RS 4 \fIaxis\fP Y Axis .RE .PP \fBSee also:\fP .RS 4 \fBsetAxis()\fP, \fBsetXAxis()\fP, \fByAxis()\fP .RE .PP .SS "void QwtPlotGrid::setYDiv (const \fBQwtScaleDiv\fP &scaleDiv)"Assign a y axis division .PP \fBParameters:\fP .RS 4 \fIscaleDiv\fP Scale division .RE .PP .SS "void QwtPlotItem::setZ (doublez)\fC [inherited]\fP" .PP Set the z value. Plot items are painted in increasing z-order. .PP \fBParameters:\fP .RS 4 \fIz\fP Z-value .RE .PP \fBSee also:\fP .RS 4 \fBz()\fP, \fBQwtPlotDict::itemList()\fP .RE .PP .SS "void QwtPlotItem::show ()\fC [inherited]\fP" .PP Show the item. .SS "bool QwtPlotItem::testItemAttribute (\fBItemAttribute\fPattribute) const\fC [inherited]\fP"Test an item attribute .PP \fBParameters:\fP .RS 4 \fIattribute\fP Attribute type .RE .PP \fBReturns:\fP .RS 4 true/false .RE .PP \fBSee also:\fP .RS 4 \fBsetItemAttribute()\fP, \fBItemAttribute\fP .RE .PP .SS "bool QwtPlotItem::testRenderHint (\fBRenderHint\fPhint) const\fC [inherited]\fP"Test a render hint .PP \fBParameters:\fP .RS 4 \fIhint\fP Render hint .RE .PP \fBReturns:\fP .RS 4 true/false .RE .PP \fBSee also:\fP .RS 4 \fBsetRenderHint()\fP, \fBRenderHint\fP .RE .PP .SS "const \fBQwtText\fP & QwtPlotItem::title () const\fC [inherited]\fP"\fBReturns:\fP .RS 4 Title of the item .RE .PP \fBSee also:\fP .RS 4 \fBsetTitle()\fP .RE .PP .SS "QRect QwtPlotItem::transform (const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QwtDoubleRect &rect) const\fC [inherited]\fP"Transform a rectangle .PP \fBParameters:\fP .RS 4 \fIxMap\fP X map .br \fIyMap\fP Y map .br \fIrect\fP Rectangle in scale coordinates .RE .PP \fBReturns:\fP .RS 4 Rectangle in paint coordinates .RE .PP \fBSee also:\fP .RS 4 \fBinvTransform()\fP .RE .PP .SS "void QwtPlotItem::updateLegend (\fBQwtLegend\fP *legend) const\fC [virtual, inherited]\fP" .PP Update the widget that represents the item on the legend. \fBupdateLegend()\fP is called from \fBitemChanged()\fP to adopt the widget representing the item on the legend to its new configuration. .PP The default implementation is made for \fBQwtPlotCurve\fP and updates a QwtLegendItem(), but an item could be represented by any type of widget, by overloading \fBlegendItem()\fP and \fBupdateLegend()\fP. .PP \fBParameters:\fP .RS 4 \fIlegend\fP Legend .RE .PP \fBSee also:\fP .RS 4 \fBlegendItem()\fP, \fBitemChanged()\fP, QwtLegend() .RE .PP .PP Implements \fBQwtLegendItemManager\fP. .PP Reimplemented in \fBQwtPlotCurve\fP. .SS "void QwtPlotGrid::updateScaleDiv (const \fBQwtScaleDiv\fP &xScaleDiv, const \fBQwtScaleDiv\fP &yScaleDiv)\fC [virtual]\fP"Update the grid to changes of the axes scale division .PP \fBParameters:\fP .RS 4 \fIxScaleDiv\fP Scale division of the x-axis .br \fIyScaleDiv\fP Scale division of the y-axis .RE .PP \fBSee also:\fP .RS 4 \fBQwtPlot::updateAxes()\fP .RE .PP .PP Reimplemented from \fBQwtPlotItem\fP. .SS "int QwtPlotItem::xAxis () const\fC [inherited]\fP" .PP Return xAxis. .SS "bool QwtPlotGrid::xEnabled () const"\fBReturns:\fP .RS 4 true if vertical gridlines are enabled .RE .PP \fBSee also:\fP .RS 4 \fBenableX()\fP .RE .PP .SS "bool QwtPlotGrid::xMinEnabled () const"\fBReturns:\fP .RS 4 true if minor vertical gridlines are enabled .RE .PP \fBSee also:\fP .RS 4 \fBenableXMin()\fP .RE .PP .SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::xScaleDiv () const"\fBReturns:\fP .RS 4 the scale division of the x axis .RE .PP .SS "int QwtPlotItem::yAxis () const\fC [inherited]\fP" .PP Return yAxis. .SS "bool QwtPlotGrid::yEnabled () const"\fBReturns:\fP .RS 4 true if horizontal gridlines are enabled .RE .PP \fBSee also:\fP .RS 4 \fBenableY()\fP .RE .PP .SS "bool QwtPlotGrid::yMinEnabled () const"\fBReturns:\fP .RS 4 true if minor horizontal gridlines are enabled .RE .PP \fBSee also:\fP .RS 4 \fBenableYMin()\fP .RE .PP .SS "const \fBQwtScaleDiv\fP & QwtPlotGrid::yScaleDiv () const"\fBReturns:\fP .RS 4 the scale division of the y axis .RE .PP .SS "double QwtPlotItem::z () const\fC [inherited]\fP"Plot items are painted in increasing z-order. .PP \fBReturns:\fP .RS 4 \fBsetZ()\fP, \fBQwtPlotDict::itemList()\fP .RE .PP .SH "Author" .PP Generated automatically by Doxygen for Qwt User's Guide from the source code.