Biomedical Image Analysis Library
The Biomedical Image Analysis Library is a poweful tool for developers, physicians, researchers, engineers, and so on.
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
QCPItemAnchor Class Reference

An anchor of an item to which positions can be attached to. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemAnchor:
Inheritance graph
Collaboration diagram for QCPItemAnchor:
Collaboration graph

Public Member Functions

 QCPItemAnchor (QCustomPlot *parentPlot, QCPAbstractItem *parentItem, const QString name, int anchorId=-1)
 
virtual ~QCPItemAnchor ()
 
QString name () const
 
virtual QPointF pixelPoint () const
 

Protected Member Functions

virtual QCPItemPosition * toQCPItemPosition ()
 
void addChildX (QCPItemPosition *pos)
 
void removeChildX (QCPItemPosition *pos)
 
void addChildY (QCPItemPosition *pos)
 
void removeChildY (QCPItemPosition *pos)
 

Protected Attributes

QString mName
 
QCustomPlot * mParentPlot
 
QCPAbstractItem * mParentItem
 
int mAnchorId
 
QSet< QCPItemPosition * > mChildrenX
 
QSet< QCPItemPosition * > mChildrenY
 

Friends

class QCPItemPosition
 

Detailed Description

An anchor of an item to which positions can be attached to.

An item (QCPAbstractItem) may have one or more anchors. Unlike QCPItemPosition, an anchor doesn't control anything on its item, but provides a way to tie other items via their positions to the anchor.

For example, a QCPItemRect is defined by its positions topLeft and bottomRight. Additionally it has various anchors like top, topRight or bottomLeft etc. So you can attach the start (which is a QCPItemPosition) of a QCPItemLine to one of the anchors by calling QCPItemPosition::setParentAnchor on start, passing the wanted anchor of the QCPItemRect. This way the start of the line will now always follow the respective anchor location on the rect item.

Note that QCPItemPosition derives from QCPItemAnchor, so every position can also serve as an anchor to other positions.

To learn how to provide anchors in your own item subclasses, see the subclassing section of the QCPAbstractItem documentation.

Definition at line 1503 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPItemAnchor::QCPItemAnchor ( QCustomPlot *  parentPlot,
QCPAbstractItem *  parentItem,
const QString  name,
int  anchorId = -1 
)

Creates a new QCPItemAnchor. You shouldn't create QCPItemAnchor instances directly, even if you want to make a new item subclass. Use QCPAbstractItem::createAnchor instead, as explained in the subclassing section of the QCPAbstractItem documentation.

Definition at line 7450 of file qcustomplot.cpp.

QCPItemAnchor::~QCPItemAnchor ( )
virtual

Definition at line 7458 of file qcustomplot.cpp.

Member Function Documentation

void QCPItemAnchor::addChildX ( QCPItemPosition *  pos)
protected

Definition at line 7506 of file qcustomplot.cpp.

void QCPItemAnchor::addChildY ( QCPItemPosition *  pos)
protected

Definition at line 7534 of file qcustomplot.cpp.

QString QCPItemAnchor::name ( ) const
inline

Definition at line 1510 of file qcustomplot.h.

QPointF QCPItemAnchor::pixelPoint ( ) const
virtual

Returns the final absolute pixel position of the QCPItemAnchor on the QCustomPlot surface.

The pixel information is internally retrieved via QCPAbstractItem::anchorPixelPosition of the parent item, QCPItemAnchor is just an intermediary.

Reimplemented in QCPItemPosition.

Definition at line 7479 of file qcustomplot.cpp.

void QCPItemAnchor::removeChildX ( QCPItemPosition *  pos)
protected

Definition at line 7520 of file qcustomplot.cpp.

void QCPItemAnchor::removeChildY ( QCPItemPosition *  pos)
protected

Definition at line 7548 of file qcustomplot.cpp.

QCPItemPosition * QCPItemAnchor::toQCPItemPosition ( )
inlineprotectedvirtual

Returns 0 if this instance is merely a QCPItemAnchor, and a valid pointer of type QCPItemPosition* if it actually is a QCPItemPosition (which is a subclass of QCPItemAnchor).

This safe downcast functionality could also be achieved with a dynamic_cast. However, QCustomPlot avoids dynamic_cast to work with projects that don't have RTTI support enabled (e.g. -fno-rtti flag with gcc compiler).

Reimplemented in QCPItemPosition.

Definition at line 1524 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPItemPosition
friend

Definition at line 1535 of file qcustomplot.h.

Member Data Documentation

int QCPItemAnchor::mAnchorId
protected

Definition at line 1520 of file qcustomplot.h.

QSet<QCPItemPosition*> QCPItemAnchor::mChildrenX
protected

Definition at line 1521 of file qcustomplot.h.

QSet<QCPItemPosition*> QCPItemAnchor::mChildrenY
protected

Definition at line 1521 of file qcustomplot.h.

QString QCPItemAnchor::mName
protected

Definition at line 1515 of file qcustomplot.h.

QCPAbstractItem* QCPItemAnchor::mParentItem
protected

Definition at line 1519 of file qcustomplot.h.

QCustomPlot* QCPItemAnchor::mParentPlot
protected

Definition at line 1518 of file qcustomplot.h.

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