QCPItemBracket
Public Types | |
enum | BracketStyle { bsSquare , bsRound , bsCurly , bsCalligraphic } |
Public Types inherited from QObject | |
typedef | QObjectList |
Public Member Functions | |
QCPItemBracket (QCustomPlot *parentPlot) | |
double | length () const |
QPen | pen () const |
QPen | selectedPen () const |
virtual double | selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=nullptr) const override |
void | setLength (double length) |
void | setPen (const QPen &pen) |
void | setSelectedPen (const QPen &pen) |
void | setStyle (BracketStyle style) |
BracketStyle | style () const |
Public Member Functions inherited from QCPAbstractItem | |
QCPAbstractItem (QCustomPlot *parentPlot) | |
QCPItemAnchor * | anchor (const QString &name) const |
QList< QCPItemAnchor * > | anchors () const |
QCPAxisRect * | clipAxisRect () const |
bool | clipToAxisRect () const |
bool | hasAnchor (const QString &name) const |
QCPItemPosition * | position (const QString &name) const |
QList< QCPItemPosition * > | positions () const |
bool | selectable () const |
bool | selected () const |
void | setClipAxisRect (QCPAxisRect *rect) |
void | setClipToAxisRect (bool clip) |
Q_SLOT void | setSelectable (bool selectable) |
Q_SLOT void | setSelected (bool selected) |
Public Member Functions inherited from QCPLayerable | |
QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=nullptr) | |
bool | antialiased () const |
QCPLayer * | layer () const |
QCPLayerable * | parentLayerable () const |
QCustomPlot * | parentPlot () const |
bool | realVisibility () const |
void | setAntialiased (bool enabled) |
bool | setLayer (const QString &layerName) |
Q_SLOT bool | setLayer (QCPLayer *layer) |
void | setVisible (bool on) |
bool | visible () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Public Attributes | |
QCPItemAnchor *const | center |
QCPItemPosition *const | left |
QCPItemPosition *const | right |
Protected Types | |
enum | AnchorIndex { aiCenter } |
Protected Member Functions | |
virtual QPointF | anchorPixelPosition (int anchorId) const override |
virtual void | draw (QCPPainter *painter) override |
QPen | mainPen () const |
Protected Member Functions inherited from QCPAbstractItem | |
virtual void | applyDefaultAntialiasingHint (QCPPainter *painter) const override |
virtual QRect | clipRect () const override |
QCPItemAnchor * | createAnchor (const QString &name, int anchorId) |
QCPItemPosition * | createPosition (const QString &name) |
virtual void | deselectEvent (bool *selectionStateChanged) override |
double | rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const |
virtual void | selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged) override |
virtual QCP::Interaction | selectionCategory () const override |
Protected Member Functions inherited from QCPLayerable | |
void | applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const |
void | initializeParentPlot (QCustomPlot *parentPlot) |
virtual void | mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseMoveEvent (QMouseEvent *event, const QPointF &startPos) |
virtual void | mousePressEvent (QMouseEvent *event, const QVariant &details) |
virtual void | mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos) |
bool | moveToLayer (QCPLayer *layer, bool prepend) |
virtual void | parentPlotInitialized (QCustomPlot *parentPlot) |
void | setParentLayerable (QCPLayerable *parentLayerable) |
virtual void | wheelEvent (QWheelEvent *event) |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Protected Attributes | |
double | mLength |
QPen | mPen |
QPen | mSelectedPen |
BracketStyle | mStyle |
Protected Attributes inherited from QCPAbstractItem | |
QList< QCPItemAnchor * > | mAnchors |
QPointer< QCPAxisRect > | mClipAxisRect |
bool | mClipToAxisRect |
QList< QCPItemPosition * > | mPositions |
bool | mSelectable |
bool | mSelected |
Protected Attributes inherited from QCPLayerable | |
bool | mAntialiased |
QCPLayer * | mLayer |
QPointer< QCPLayerable > | mParentLayerable |
QCustomPlot * | mParentPlot |
bool | mVisible |
Additional Inherited Members | |
Properties inherited from QObject | |
objectName | |
Signals inherited from QCPAbstractItem | |
void | selectableChanged (bool selectable) |
void | selectionChanged (bool selected) |
Signals inherited from QCPLayerable | |
void | layerChanged (QCPLayer *newLayer) |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Detailed Description
A bracket for referencing/highlighting certain parts in the plot.
It has two positions, left and right, which define the span of the bracket. If left is actually farther to the left than right, the bracket is opened to the bottom, as shown in the example image.
The bracket supports multiple styles via setStyle. The length, i.e. how far the bracket stretches away from the embraced span, can be controlled with setLength.
It provides an anchor center, to allow connection of other items, e.g. an arrow (QCPItemLine or QCPItemCurve) or a text label (QCPItemText), to the bracket.
Definition at line 6939 of file qcustomplot.h.
Member Enumeration Documentation
◆ AnchorIndex
|
protected |
Definition at line 6986 of file qcustomplot.h.
◆ BracketStyle
Defines the various visual shapes of the bracket item. The appearance can be further modified by setLength and setPen.
- See also
- setStyle
Enumerator | |
---|---|
bsSquare | A brace with angled edges. |
bsRound | A brace with round edges. |
bsCurly | A curly brace. |
bsCalligraphic | A curly brace with varying stroke width giving a calligraphic impression. |
Definition at line 6955 of file qcustomplot.h.
Constructor & Destructor Documentation
◆ QCPItemBracket()
|
explicit |
Creates a bracket item and sets default values.
The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.
Definition at line 30802 of file qcustomplot.cpp.
◆ ~QCPItemBracket()
|
overridevirtual |
Definition at line 30817 of file qcustomplot.cpp.
Member Function Documentation
◆ anchorPixelPosition()
|
overrideprotectedvirtual |
Returns the pixel position of the anchor with Id anchorId. This function must be reimplemented in item subclasses if they want to provide anchors (QCPItemAnchor).
For example, if the item has two anchors with id 0 and 1, this function takes one of these anchor ids and returns the respective pixel points of the specified anchor.
- See also
- createAnchor
Reimplemented from QCPAbstractItem.
Definition at line 30978 of file qcustomplot.cpp.
◆ draw()
|
overrideprotectedvirtual |
Draws this item with the provided painter.
The cliprect of the provided painter is set to the rect returned by clipRect before this function is called. The clipRect depends on the clipping settings defined by setClipToAxisRect and setClipAxisRect.
Implements QCPAbstractItem.
Definition at line 30909 of file qcustomplot.cpp.
◆ length()
|
inline |
Definition at line 6968 of file qcustomplot.h.
◆ mainPen()
|
protected |
Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected and mSelectedPen when it is.
Definition at line 31003 of file qcustomplot.cpp.
◆ pen()
|
inline |
Definition at line 6966 of file qcustomplot.h.
◆ selectedPen()
|
inline |
Definition at line 6967 of file qcustomplot.h.
◆ selectTest()
|
overridevirtual |
This function is used to decide whether a click hits a layerable object or not.
pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.
If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).
Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).
The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/ deselectEvent methods.
details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.
In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.
You may pass nullptr
as details to indicate that you are not interested in those selection details.
- See also
- selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect
Implements QCPAbstractItem.
Definition at line 30869 of file qcustomplot.cpp.
◆ setLength()
void QCPItemBracket::setLength | ( | double | length | ) |
Sets the length in pixels how far the bracket extends in the direction towards the embraced span of the bracket (i.e. perpendicular to the left-right-direction)
Definition at line 30853 of file qcustomplot.cpp.
◆ setPen()
void QCPItemBracket::setPen | ( | const QPen & | pen | ) |
Sets the pen that will be used to draw the bracket.
Note that when the style is bsCalligraphic, only the color will be taken from the pen, the stroke and width are ignored. To change the apparent stroke width of a calligraphic bracket, use setLength, which has a similar effect.
- See also
- setSelectedPen
Definition at line 30830 of file qcustomplot.cpp.
◆ setSelectedPen()
void QCPItemBracket::setSelectedPen | ( | const QPen & | pen | ) |
Sets the pen that will be used to draw the bracket when selected
- See also
- setPen, setSelected
Definition at line 30840 of file qcustomplot.cpp.
◆ setStyle()
void QCPItemBracket::setStyle | ( | QCPItemBracket::BracketStyle | style | ) |
Sets the style of the bracket, i.e. the shape/visual appearance.
- See also
- setPen
Definition at line 30863 of file qcustomplot.cpp.
◆ style()
|
inline |
Definition at line 6969 of file qcustomplot.h.
Member Data Documentation
◆ center
QCPItemAnchor* const QCPItemBracket::center |
Definition at line 6982 of file qcustomplot.h.
◆ left
QCPItemPosition* const QCPItemBracket::left |
Definition at line 6980 of file qcustomplot.h.
◆ mLength
|
protected |
Definition at line 6988 of file qcustomplot.h.
◆ mPen
|
protected |
Definition at line 6987 of file qcustomplot.h.
◆ mSelectedPen
|
protected |
Definition at line 6987 of file qcustomplot.h.
◆ mStyle
|
protected |
Definition at line 6989 of file qcustomplot.h.
◆ right
QCPItemPosition* const QCPItemBracket::right |
Definition at line 6981 of file qcustomplot.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:04:48 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.