qwtplotcanvas.3

linux下qt的第三方的一个类

.TH "QwtPlotCanvas" 3 "16 Nov 2004" "Version 4.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtPlotCanvas \- 
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 
Canvas of a \fBQwtPlot\fP. 

\fBSee also:\fP
.RS 4
\fBQwtPlot\fP 
.RE
.PP

.PP
Definition at line 29 of file qwt_plot_canvas.h.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBFocusIndicator\fP { \fBNoFocusIndicator\fP, \fBCanvasFocusIndicator\fP, \fBItemFocusIndicator\fP }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBmousePressed\fP (const QMouseEvent &e)"
.br
.ti -1c
.RI "void \fBmouseReleased\fP (const QMouseEvent &e)"
.br
.ti -1c
.RI "void \fBmouseMoved\fP (const QMouseEvent &e)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetFocusIndicator\fP (\fBFocusIndicator\fP)"
.br
.ti -1c
.RI "\fBFocusIndicator\fP \fBfocusIndicator\fP () const"
.br
.ti -1c
.RI "void \fBsetCacheMode\fP (bool on)"
.br
.ti -1c
.RI "bool \fBcacheMode\fP () const"
.br
.ti -1c
.RI "const QPixmap * \fBcache\fP () const"
.br
.ti -1c
.RI "void \fBinvalidateCache\fP ()"
.br
.ti -1c
.RI "void \fBenableOutline\fP (bool tf)"
.br
.ti -1c
.RI "bool \fBoutlineEnabled\fP () const"
.br
.ti -1c
.RI "void \fBsetOutlinePen\fP (const QPen &p)"
.br
.ti -1c
.RI "const QPen & \fBoutlinePen\fP () const"
.br
.ti -1c
.RI "void \fBsetOutlineStyle\fP (Qwt::Shape os)"
.br
.ti -1c
.RI "Qwt::Shape \fBoutlineStyle\fP () const"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtPlotCanvas\fP (\fBQwtPlot\fP *)"
.br
.ti -1c
.RI "virtual \fB~QwtPlotCanvas\fP ()"
.br
.ti -1c
.RI "QPixmap * \fBcache\fP ()"
.br
.ti -1c
.RI "virtual void \fBframeChanged\fP ()"
.br
.ti -1c
.RI "virtual void \fBdrawContents\fP (QPainter *)"
.br
.ti -1c
.RI "virtual void \fBdrawFocusIndicator\fP (QPainter *, const QRect &)"
.br
.ti -1c
.RI "void \fBdrawCanvas\fP (QPainter *painter=NULL)"
.br
.ti -1c
.RI "virtual void \fBmousePressEvent\fP (QMouseEvent *)"
.br
.ti -1c
.RI "virtual void \fBmouseReleaseEvent\fP (QMouseEvent *)"
.br
.ti -1c
.RI "virtual void \fBmouseMoveEvent\fP (QMouseEvent *)"
.br
.in -1c
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtPlotCanvas::FocusIndicator\fP"
.PP
Focus indicator. 
.PP
.IP "\(bu" 2
NoFocusIndicator
.br
 Don磘 paint a focus indicator
.IP "\(bu" 2
CanvasFocusIndicator
.br
 The focus is related to the complete canvas. Paint the focus indicator using paintFocus()
.IP "\(bu" 2
ItemFocusIndicator
.br
 The focus is related to an item (curve, point, ...) on the canvas. It is up to the application to display a focus indication using f.e. highlighting.
.PP
.PP
\fBSee also:\fP
.RS 4
\fBsetFocusIndicator()\fP, \fBfocusIndicator()\fP, paintFocus() 
.RE
.PP
Definition at line 51 of file qwt_plot_canvas.h.
.PP
Referenced by focusIndicator().
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtPlotCanvas::QwtPlotCanvas (\fBQwtPlot\fP *)\fC [protected]\fP"
.PP
Sets a cross cursor, and an invisible red outline. 
.PP
Definition at line 25 of file qwt_plot_canvas.cpp.
.SS "QwtPlotCanvas::~\fBQwtPlotCanvas\fP ()\fC [protected, virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 42 of file qwt_plot_canvas.cpp.
.SH "Member Function Documentation"
.PP 
.SS "QPixmap * QwtPlotCanvas::cache ()\fC [protected]\fP"
.PP
Return the paint cache, might be null. 
.PP
Definition at line 89 of file qwt_plot_canvas.cpp.
.SS "const QPixmap * QwtPlotCanvas::cache () const"
.PP
Return the paint cache, might be null. 
.PP
Definition at line 95 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::drawCurve().
.SS "bool QwtPlotCanvas::cacheMode () const"
.PP
\fBReturns:\fP
.RS 4
Cache mode 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBsetCacheMode\fP 
.RE
.PP
Definition at line 83 of file qwt_plot_canvas.cpp.
.PP
Referenced by drawCanvas(), drawContents(), and QwtPlot::drawCurve().
.SS "void QwtPlotCanvas::drawCanvas (QPainter * painter = \fCNULL\fP)\fC [protected]\fP"
.PP
Draw the the canvas
.PP
Paints all plot items to the contentsRect(), using \fBQwtPlot::drawCanvas\fP and updates the cache.
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlot::drawCanvas\fP, \fBsetCacheMode()\fP, \fBcacheMode()\fP 
.RE
.PP
Definition at line 174 of file qwt_plot_canvas.cpp.
.PP
References QwtPaintBuffer::buffer(), cacheMode(), QwtPaintBuffer::isEnabled(), and QwtPaintBuffer::painter().
.PP
Referenced by drawContents().
.SS "void QwtPlotCanvas::drawContents (QPainter *)\fC [protected, virtual]\fP"
.PP
Redraw the canvas, and focus rect. 
.PP
Definition at line 139 of file qwt_plot_canvas.cpp.
.PP
References cacheMode(), drawCanvas(), drawFocusIndicator(), and focusIndicator().
.SS "void QwtPlotCanvas::drawFocusIndicator (QPainter *, const QRect &)\fC [protected, virtual]\fP"
.PP
Draw the focus indication. 
.PP
Definition at line 221 of file qwt_plot_canvas.cpp.
.PP
Referenced by drawContents().
.SS "void QwtPlotCanvas::enableOutline (bool tf)"
.PP
Enables or disables outline drawing. 
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
When the outline feature is enabled, a shape will be drawn in the plotting region when the user presses or drags the mouse. It can be used to implement crosshairs, mark a selected region, etc. 
.PP
\fBParameters:\fP
.RS 4
\fItf\fP \fCTRUE\fP (enabled) or \fCFALSE\fP (disabled) 
.RE
.PP
\fBWarning:\fP
.RS 4
An outline style has to be specified. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::setOutlineStyle()\fP 
.RE
.PP
Definition at line 315 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::enableOutline().
.SS "\fBQwtPlotCanvas::FocusIndicator\fP QwtPlotCanvas::focusIndicator () const"
.PP
\fBReturns:\fP
.RS 4
Focus indicator
.RE
.PP
\fBSee also:\fP
.RS 4
\fBFocusIndicator\fP, \fBsetFocusIndicator\fP 
.RE
.PP
Definition at line 122 of file qwt_plot_canvas.cpp.
.PP
References FocusIndicator.
.PP
Referenced by drawContents().
.SS "void QwtPlotCanvas::frameChanged ()\fC [protected, virtual]\fP"
.PP
Requires layout updates of the parent plot. 
.PP
Definition at line 128 of file qwt_plot_canvas.cpp.
.SS "void QwtPlotCanvas::invalidateCache ()"
.PP
Invalidate the internal paint cache. 
.PP
Definition at line 101 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::replot().
.SS "void QwtPlotCanvas::mouseMoved (const QMouseEvent & e)\fC [signal]\fP"
.PP
A signal which is emitted when the mouse is moved in the canvas.
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIe\fP Mouse event object 
.RE
.PP

.PP
Referenced by mouseMoveEvent().
.SS "void QwtPlotCanvas::mouseMoveEvent (QMouseEvent *)\fC [protected, virtual]\fP"
.PP
Mouse event handler. 
.PP
Definition at line 284 of file qwt_plot_canvas.cpp.
.PP
References mouseMoved().
.SS "void QwtPlotCanvas::mousePressed (const QMouseEvent & e)\fC [signal]\fP"
.PP
A signal which is emitted when the mouse is pressed in the canvas.
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIe\fP Mouse event object 
.RE
.PP

.PP
Referenced by mousePressEvent().
.SS "void QwtPlotCanvas::mousePressEvent (QMouseEvent *)\fC [protected, virtual]\fP"
.PP
Mouse event handler. 
.PP
Definition at line 234 of file qwt_plot_canvas.cpp.
.PP
References mousePressed().
.SS "void QwtPlotCanvas::mouseReleased (const QMouseEvent & e)\fC [signal]\fP"
.PP
A signal which is emitted when a mouse button has been released in the canvas.
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIe\fP Mouse event object 
.RE
.PP

.PP
Referenced by mouseReleaseEvent().
.SS "void QwtPlotCanvas::mouseReleaseEvent (QMouseEvent *)\fC [protected, virtual]\fP"
.PP
Mouse event handler. 
.PP
Definition at line 266 of file qwt_plot_canvas.cpp.
.PP
References mouseReleased().
.SS "bool QwtPlotCanvas::outlineEnabled () const"
.PP
\fBReturns:\fP
.RS 4
\fCTRUE\fP if the outline feature is enabled
.RE
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::enableOutline\fP 
.RE
.PP
Definition at line 340 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::outlineEnabled().
.SS "const QPen & QwtPlotCanvas::outlinePen () const"
.PP
\fBReturns:\fP
.RS 4
the pen used to draw outlines
.RE
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::setOutlinePen\fP 
.RE
.PP
Definition at line 433 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::outlinePen().
.SS "Qwt::Shape QwtPlotCanvas::outlineStyle () const"
.PP
\fBReturns:\fP
.RS 4
the outline style
.RE
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::setOutlineStyle()\fP 
.RE
.PP
Definition at line 404 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::outlineStyle().
.SS "void QwtPlotCanvas::setCacheMode (bool on)"
.PP
En/Disable caching. 
.PP
When cache mode is enabled the canvas contents are copied to a pixmap that is used for trivial repaints. Such repaints happen when a plot gets unhidden, deiconified or changes the focus.
.PP
The win of caching depends on the costs of \fBQwtPlot::drawCanvas\fP. In case of plots with huge data it might be significant. The price of caching is wasting memory for the cache, what is a pixmap in size of contentsRect(). In case of \fBQwtPaintBuffer::isEnabled()\fP updating the cache produces no performance overhead as it reuses the temporary paintbuffer of the double buffering. Otherwise canvas updates have to painted twice to widget and cache.
.PP
\fBParameters:\fP
.RS 4
\fIon\fP Enable caching, when TRUE
.RE
.PP
\fBSee also:\fP
.RS 4
\fBcacheMode()\fP, \fBdrawCanvas()\fP, \fBdrawContents()\fP, \fBcache()\fP 
.RE
.PP
Definition at line 66 of file qwt_plot_canvas.cpp.
.SS "void QwtPlotCanvas::setFocusIndicator (\fBFocusIndicator\fP focusIndicator)"
.PP
Set the focus indicator
.PP
\fBSee also:\fP
.RS 4
\fBFocusIndicator\fP, \fBfocusIndicator\fP 
.RE
.PP
Definition at line 112 of file qwt_plot_canvas.cpp.
.SS "void QwtPlotCanvas::setOutlinePen (const QPen & pen)"
.PP
Specify a pen for the outline. 
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
\fBParameters:\fP
.RS 4
\fIpen\fP new pen 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::outlinePen\fP 
.RE
.PP
Definition at line 419 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::setOutlinePen().
.SS "void QwtPlotCanvas::setOutlineStyle (Qwt::Shape os)"
.PP
Specify the style of the outline. 
.PP
\fBWarning:\fP
.RS 4
Outlining functionality is obsolete: use \fBQwtPlotPicker\fP or \fBQwtPlotZoomer\fP.
.RE
.PP
The outline style determines which kind of shape is drawn in the plotting region when the user presses a mouse button or drags the mouse. Valid Styles are: 
.PP
\fBParameters:\fP
.RS 4
\fIos\fP Outline Style. Valid values are: \fCQwt::HLine\fP, \fCQwt::VLine\fP, \fCQwt::Cross\fP, \fCQwt::Rect\fP, \fCQwt::Ellipse\fP 
.IP "\fBQwt::Cros \fP" 1c
Cross hairs are drawn across the plotting area when the user presses a mouse button. The lines intersect at the point where the mouse was pressed and move with the mouse pointer. 
.IP "\fBQwt::HLine, Qwt::VLine \fP" 1c
A horizontal or vertical line appears when the user presses a mouse button. This is useful for moving line markers. 
.IP "\fBQwt::Rect \fP" 1c
A rectangle is displayed when the user drags the mouse. One corner is fixed at the point where the mouse was pressed, and the opposite corner moves with the mouse pointer. This can be used for selecting regions. 
.IP "\fBQwt::Ellipse \fP" 1c
Similar to Qwt::Rect, but with an ellipse inside a bounding rectangle. 
.PP
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtPlotCanvas::enableOutline()\fP, \fBQwtPlotCanvas::outlineStyle()\fP 
.RE
.PP
Definition at line 379 of file qwt_plot_canvas.cpp.
.PP
Referenced by QwtPlot::setOutlineStyle().

.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code.