QWT API (English) 7.3.0
Qt Widget Library for Technical Applications - English API Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | List of all members
QwtPlotDict Class Reference

A dictionary for plot items. More...

#include <qwt_plot_dict.h>

Inheritance diagram for QwtPlotDict:
QwtPlot

Classes

class  PrivateData
 

Public Member Functions

 QwtPlotDict ()
 Constructor.
 
void setAutoDelete (bool)
 Enable/disable auto deletion.
 
bool autoDelete () const
 Check if auto deletion is enabled.
 
const QwtPlotItemListitemList () const
 Get the list of all attached plot items.
 
QwtPlotItemList itemList (int rtti) const
 Get the list of all attached plot items of a specific type.
 
void detachItems (int rtti=QwtPlotItem::Rtti_PlotItem, bool autoDelete=true)
 Detach items from the dictionary.
 

Protected Member Functions

void insertItem (QwtPlotItem *)
 Insert an item into the dictionary.
 
void removeItem (QwtPlotItem *)
 Remove an item from the dictionary.
 

Detailed Description

A dictionary for plot items.

QwtPlotDict organizes plot items in increasing z-order. If autoDelete() is enabled, all attached items will be deleted in the destructor of the dictionary. QwtPlotDict can be used to get access to all QwtPlotItem items - or all items of a specific type - that are currently on the plot.

See also
QwtPlotItem::attach(), QwtPlotItem::detach(), QwtPlotItem::z()

Constructor & Destructor Documentation

◆ QwtPlotDict()

QwtPlotDict::QwtPlotDict ( )
explicit

Constructor.

Auto deletion is enabled.

See also
setAutoDelete(), QwtPlotItem::attach()

Destructor

If autoDelete() is on, all attached items will be deleted.

See also
setAutoDelete(), autoDelete(), QwtPlotItem::attach()

Member Function Documentation

◆ autoDelete()

bool QwtPlotDict::autoDelete ( ) const

Check if auto deletion is enabled.

Returns
True if auto deletion is enabled
See also
setAutoDelete(), insertItem()

◆ detachItems()

void QwtPlotDict::detachItems ( int  rtti = QwtPlotItem::Rtti_PlotItem,
bool  autoDelete = true 
)

Detach items from the dictionary.

Parameters
[in]rttiIn case of QwtPlotItem::Rtti_PlotItem detach all items, otherwise only those items of the type rtti.
[in]autoDeleteIf true, delete all detached items

◆ insertItem()

void QwtPlotDict::insertItem ( QwtPlotItem item)
protected

Insert an item into the dictionary.

Insert a plot item.

Parameters
itemPlotItem
See also
removeItem()

◆ itemList() [1/2]

const QwtPlotItemList & QwtPlotDict::itemList ( ) const

Get the list 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.

Returns
List of all attached plot items

◆ itemList() [2/2]

QwtPlotItemList QwtPlotDict::itemList ( int  rtti) const

Get the list of all attached plot items of a specific type.

Parameters
[in]rttiSee QwtPlotItem::RttiValues
Returns
List of all attached plot items of a specific type
See also
QwtPlotItem::rtti()

◆ removeItem()

void QwtPlotDict::removeItem ( QwtPlotItem item)
protected

Remove an item from the dictionary.

Remove a plot item.

Parameters
itemPlotItem
See also
insertItem()

◆ setAutoDelete()

void QwtPlotDict::setAutoDelete ( bool  autoDelete)

Enable/disable auto deletion.

If Auto deletion is on all attached plot items will be deleted in the destructor of QwtPlotDict. The default value is on.

Parameters
[in]autoDeleteTrue to enable auto deletion
See also
autoDelete(), insertItem()

The documentation for this class was generated from the following files: