· · ·
Public Functions | Protected Functions
QCPItemAnchor Class Reference

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

Inheritance diagram for QCPItemAnchor:

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

## Protected Functions
virtual QCPItemPosition * | toQCPItemPosition ()
void | addChild (QCPItemPosition *pos)
void | removeChild (QCPItemPosition *pos)

## 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.

## 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.

## Member Function Documentation

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.

QCPItemPosition * QCPItemAnchor::toQCPItemPosition | ( |  | ) |
| inline protected virtual

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.

void QCPItemAnchor::addChild | ( | QCPItemPosition * | pos | ) |
| protected

Adds pos to the child list of this anchor. This is necessary to notify the children prior to destruction of the anchor.

Note that this function does not change the parent setting in pos.

void QCPItemAnchor::removeChild | ( | QCPItemPosition * | pos | ) |
| protected

Removes pos from the child list of this anchor.

Note that this function does not change the parent setting in pos.

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

- src/item.h
- src/item.cpp

Generated with Doxygen 1.8.1.2