Sources_For_Linux/Qwt/doc/man/man3/QwtPlotDict.3

.TH "QwtPlotDict" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtPlotDict \- A dictionary for plot items\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_plot_dict\&.h>\fP
.PP
Inherited by \fBQwtPlot\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtPlotDict\fP ()"
.br
.ti -1c
.RI "virtual \fB~QwtPlotDict\fP ()"
.br
.ti -1c
.RI "void \fBsetAutoDelete\fP (bool)"
.br
.ti -1c
.RI "bool \fBautoDelete\fP () const"
.br
.ti -1c
.RI "const QwtPlotItemList & \fBitemList\fP () const"
.br
.RI "A QwtPlotItemList of all attached plot items\&. "
.ti -1c
.RI "QwtPlotItemList \fBitemList\fP (int rtti) const"
.br
.ti -1c
.RI "void \fBdetachItems\fP (int rtti=\fBQwtPlotItem::Rtti_PlotItem\fP, bool \fBautoDelete\fP=true)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBinsertItem\fP (\fBQwtPlotItem\fP *)"
.br
.ti -1c
.RI "void \fBremoveItem\fP (\fBQwtPlotItem\fP *)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A dictionary for plot items\&. 

\fBQwtPlotDict\fP organizes plot items in increasing z-order\&. If \fBautoDelete()\fP is enabled, all attached items will be deleted in the destructor of the dictionary\&. \fBQwtPlotDict\fP can be used to get access to all \fBQwtPlotItem\fP items - or all items of a specific type - that are currently on the plot\&.
.PP
\fBSee also\fP
.RS 4
\fBQwtPlotItem::attach()\fP, \fBQwtPlotItem::detach()\fP, \fBQwtPlotItem::z()\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtPlotDict::QwtPlotDict ()\fC [explicit]\fP"
Constructor
.PP
Auto deletion is enabled\&. 
.PP
\fBSee also\fP
.RS 4
\fBsetAutoDelete()\fP, \fBQwtPlotItem::attach()\fP 
.RE
.PP

.SS "QwtPlotDict::~QwtPlotDict ()\fC [virtual]\fP"
Destructor
.PP
If \fBautoDelete()\fP is on, all attached items will be deleted 
.PP
\fBSee also\fP
.RS 4
\fBsetAutoDelete()\fP, \fBautoDelete()\fP, \fBQwtPlotItem::attach()\fP 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "bool QwtPlotDict::autoDelete () const"

.PP
\fBReturns\fP
.RS 4
true if auto deletion is enabled 
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetAutoDelete()\fP, \fBinsertItem()\fP 
.RE
.PP

.SS "void QwtPlotDict::detachItems (int rtti = \fC\fBQwtPlotItem::Rtti_PlotItem\fP\fP, bool autoDelete = \fCtrue\fP)"
Detach items from the dictionary
.PP
\fBParameters\fP
.RS 4
\fIrtti\fP In case of \fBQwtPlotItem::Rtti_PlotItem\fP detach all items otherwise only those items of the type rtti\&. 
.br
\fIautoDelete\fP If true, delete all detached items 
.RE
.PP

.SS "void QwtPlotDict::insertItem (\fBQwtPlotItem\fP * item)\fC [protected]\fP"
Insert a plot item
.PP
\fBParameters\fP
.RS 4
\fIitem\fP PlotItem 
.RE
.PP
\fBSee also\fP
.RS 4
\fBremoveItem()\fP 
.RE
.PP

.SS "const QwtPlotItemList & QwtPlotDict::itemList () const"

.PP
A QwtPlotItemList of all attached plot items\&. Use caution when iterating these lists, as removing/detaching an item will invalidate the iterator\&. Instead you can place pointers to objects to be removed in a removal list, and traverse that list later\&.
.PP
\fBReturns\fP
.RS 4
List of all attached plot items\&. 
.RE
.PP

.SS "QwtPlotItemList QwtPlotDict::itemList (int rtti) const"

.PP
\fBReturns\fP
.RS 4
List of all attached plot items of a specific type\&. 
.RE
.PP
\fBParameters\fP
.RS 4
\fIrtti\fP See \fBQwtPlotItem::RttiValues\fP 
.RE
.PP
\fBSee also\fP
.RS 4
\fBQwtPlotItem::rtti()\fP 
.RE
.PP

.SS "void QwtPlotDict::removeItem (\fBQwtPlotItem\fP * item)\fC [protected]\fP"
Remove a plot item
.PP
\fBParameters\fP
.RS 4
\fIitem\fP PlotItem 
.RE
.PP
\fBSee also\fP
.RS 4
\fBinsertItem()\fP 
.RE
.PP

.SS "void QwtPlotDict::setAutoDelete (bool autoDelete)"
En/Disable Auto deletion
.PP
If Auto deletion is on all attached plot items will be deleted in the destructor of \fBQwtPlotDict\fP\&. The default value is on\&.
.PP
\fBSee also\fP
.RS 4
\fBautoDelete()\fP, \fBinsertItem()\fP 
.RE
.PP


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