Vespucci  1.0.0
QCPItemRect Class Reference

A rectangle. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemRect:
QCPAbstractItem QCPLayerable

Public Member Functions

 QCPItemRect (QCustomPlot *parentPlot)
 
virtual ~QCPItemRect ()
 
QPen pen () const
 
QPen selectedPen () const
 
QBrush brush () const
 
QBrush selectedBrush () const
 
void setPen (const QPen &pen)
 
void setSelectedPen (const QPen &pen)
 
void setBrush (const QBrush &brush)
 
void setSelectedBrush (const QBrush &brush)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 
virtual ~QCPAbstractItem ()
 
bool clipToAxisRect () const
 
QCPAxisRectclipAxisRect () const
 
bool selectable () const
 
bool selected () const
 
void setClipToAxisRect (bool clip)
 
void setClipAxisRect (QCPAxisRect *rect)
 
Q_SLOT void setSelectable (bool selectable)
 
Q_SLOT void setSelected (bool selected)
 
QList< QCPItemPosition * > positions () const
 
QList< QCPItemAnchor * > anchors () const
 
QCPItemPositionposition (const QString &name) const
 
QCPItemAnchoranchor (const QString &name) const
 
bool hasAnchor (const QString &name) const
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 
Q_SLOT bool setLayer (QCPLayer *layer)
 
bool setLayer (const QString &layerName)
 
void setAntialiased (bool enabled)
 
bool realVisibility () const
 

Public Attributes

QCPItemPosition *const topLeft
 
QCPItemPosition *const bottomRight
 
QCPItemAnchor *const top
 
QCPItemAnchor *const topRight
 
QCPItemAnchor *const right
 
QCPItemAnchor *const bottom
 
QCPItemAnchor *const bottomLeft
 
QCPItemAnchor *const left
 

Protected Types

enum  AnchorIndex {
  aiTop, aiTopRight, aiRight, aiBottom,
  aiBottomLeft, aiLeft
}
 

Protected Member Functions

virtual void draw (QCPPainter *painter)
 
virtual QPointF anchorPixelPoint (int anchorId) const
 
QPen mainPen () const
 
QBrush mainBrush () const
 
- Protected Member Functions inherited from QCPAbstractItem
virtual QCP::Interaction selectionCategory () const
 
virtual QRect clipRect () const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
double distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const
 
double rectSelectTest (const QRectF &rect, const QPointF &pos, bool filledRect) const
 
QCPItemPositioncreatePosition (const QString &name)
 
QCPItemAnchorcreateAnchor (const QString &name, int anchorId)
 
- Protected Member Functions inherited from QCPLayerable
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
void initializeParentPlot (QCustomPlot *parentPlot)
 
void setParentLayerable (QCPLayerable *parentLayerable)
 
bool moveToLayer (QCPLayer *layer, bool prepend)
 
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
 

Protected Attributes

QPen mPen
 
QPen mSelectedPen
 
QBrush mBrush
 
QBrush mSelectedBrush
 
- Protected Attributes inherited from QCPAbstractItem
bool mClipToAxisRect
 
QPointer< QCPAxisRectmClipAxisRect
 
QList< QCPItemPosition * > mPositions
 
QList< QCPItemAnchor * > mAnchors
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlotmParentPlot
 
QPointer< QCPLayerablemParentLayerable
 
QCPLayermLayer
 
bool mAntialiased
 

Additional Inherited Members

- Signals inherited from QCPAbstractItem
void selectionChanged (bool selected)
 
void selectableChanged (bool selectable)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Detailed Description

A rectangle.

QCPItemRect.png
Rectangle example. Blue dotted circles are anchors, solid blue discs are positions.

It has two positions, topLeft and bottomRight, which define the rectangle.

Definition at line 3417 of file qcustomplot.h.

Member Enumeration Documentation

enum QCPItemRect::AnchorIndex
protected
Enumerator
aiTop 
aiTopRight 
aiRight 
aiBottom 
aiBottomLeft 
aiLeft 

Definition at line 3455 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPItemRect::QCPItemRect ( QCustomPlot parentPlot)

Creates a rectangle item and sets default values.

The constructed item can be added to the plot with QCustomPlot::addItem.

Definition at line 22466 of file qcustomplot.cpp.

QCPItemRect::~QCPItemRect ( )
virtual

Definition at line 22486 of file qcustomplot.cpp.

Member Function Documentation

QPointF QCPItemRect::anchorPixelPoint ( int  anchorId) const
protectedvirtual

Reimplemented from QCPAbstractItem.

Definition at line 22563 of file qcustomplot.cpp.

QBrush QCPItemRect::brush ( ) const
inline

Definition at line 3433 of file qcustomplot.h.

void QCPItemRect::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractItem.

Definition at line 22545 of file qcustomplot.cpp.

QBrush QCPItemRect::mainBrush ( ) const
protected

Definition at line 22595 of file qcustomplot.cpp.

QPen QCPItemRect::mainPen ( ) const
protected

Definition at line 22585 of file qcustomplot.cpp.

QPen QCPItemRect::pen ( ) const
inline

Definition at line 3431 of file qcustomplot.h.

QBrush QCPItemRect::selectedBrush ( ) const
inline

Definition at line 3434 of file qcustomplot.h.

QPen QCPItemRect::selectedPen ( ) const
inline

Definition at line 3432 of file qcustomplot.h.

double QCPItemRect::selectTest ( const QPointF &  pos,
bool  onlySelectable,
QVariant *  details = 0 
) const
virtual

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 item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function returns -1.0.

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.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also
selectEvent, deselectEvent, QCustomPlot::setInteractions

Implements QCPAbstractItem.

Definition at line 22533 of file qcustomplot.cpp.

void QCPItemRect::setBrush ( const QBrush &  brush)

Sets the brush that will be used to fill the rectangle. To disable filling, set brush to Qt::NoBrush.

See also
setSelectedBrush, setPen

Definition at line 22516 of file qcustomplot.cpp.

void QCPItemRect::setPen ( const QPen &  pen)

Sets the pen that will be used to draw the line of the rectangle

See also
setSelectedPen, setBrush

Definition at line 22495 of file qcustomplot.cpp.

void QCPItemRect::setSelectedBrush ( const QBrush &  brush)

Sets the brush that will be used to fill the rectangle when selected. To disable filling, set brush to Qt::NoBrush.

See also
setBrush

Definition at line 22527 of file qcustomplot.cpp.

void QCPItemRect::setSelectedPen ( const QPen &  pen)

Sets the pen that will be used to draw the line of the rectangle when selected

See also
setPen, setSelected

Definition at line 22505 of file qcustomplot.cpp.

Member Data Documentation

QCPItemAnchor* const QCPItemRect::bottom

Definition at line 3450 of file qcustomplot.h.

QCPItemAnchor* const QCPItemRect::bottomLeft

Definition at line 3451 of file qcustomplot.h.

QCPItemPosition* const QCPItemRect::bottomRight

Definition at line 3446 of file qcustomplot.h.

QCPItemAnchor* const QCPItemRect::left

Definition at line 3452 of file qcustomplot.h.

QBrush QCPItemRect::mBrush
protected

Definition at line 3459 of file qcustomplot.h.

QPen QCPItemRect::mPen
protected

Definition at line 3458 of file qcustomplot.h.

QBrush QCPItemRect::mSelectedBrush
protected

Definition at line 3459 of file qcustomplot.h.

QPen QCPItemRect::mSelectedPen
protected

Definition at line 3458 of file qcustomplot.h.

QCPItemAnchor* const QCPItemRect::right

Definition at line 3449 of file qcustomplot.h.

QCPItemAnchor* const QCPItemRect::top

Definition at line 3447 of file qcustomplot.h.

QCPItemPosition* const QCPItemRect::topLeft

Definition at line 3445 of file qcustomplot.h.

QCPItemAnchor* const QCPItemRect::topRight

Definition at line 3448 of file qcustomplot.h.


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