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

The abstract base class for all entries in a QCPLegend. More...

#include <qcustomplot.h>

Inheritance diagram for QCPAbstractLegendItem:
Inheritance graph
Collaboration diagram for QCPAbstractLegendItem:
Collaboration graph

Signals

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

Public Member Functions

 QCPAbstractLegendItem (QCPLegend *parent)
 
QCPLegend * parentLegend () const
 
QFont font () const
 
QColor textColor () const
 
QFont selectedFont () const
 
QColor selectedTextColor () const
 
bool selectable () const
 
bool selected () const
 
void setFont (const QFont &font)
 
void setTextColor (const QColor &color)
 
void setSelectedFont (const QFont &font)
 
void setSelectedTextColor (const QColor &color)
 
Q_SLOT void setSelectable (bool selectable)
 
Q_SLOT void setSelected (bool selected)
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 
- Public Member Functions inherited from QCPLayoutElement
 QCPLayoutElement (QCustomPlot *parentPlot=0)
 
virtual ~QCPLayoutElement ()
 
QCPLayout * layout () const
 
QRect rect () const
 
QRect outerRect () const
 
QMargins margins () const
 
QMargins minimumMargins () const
 
QCP::MarginSides autoMargins () const
 
QSize minimumSize () const
 
QSize maximumSize () const
 
QCPMarginGroup * marginGroup (QCP::MarginSide side) const
 
QHash< QCP::MarginSide, QCPMarginGroup * > marginGroups () const
 
void setOuterRect (const QRect &rect)
 
void setMargins (const QMargins &margins)
 
void setMinimumMargins (const QMargins &margins)
 
void setAutoMargins (QCP::MarginSides sides)
 
void setMinimumSize (const QSize &size)
 
void setMinimumSize (int width, int height)
 
void setMaximumSize (const QSize &size)
 
void setMaximumSize (int width, int height)
 
void setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)
 
virtual void update (UpdatePhase phase)
 
virtual QSize minimumSizeHint () const
 
virtual QSize maximumSizeHint () const
 
virtual QList< QCPLayoutElement * > elements (bool recursive) const
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlot * parentPlot () const
 
QCPLayerable * parentLayerable () const
 
QCPLayer * layer () 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
 

Protected Member Functions

virtual QCP::Interaction selectionCategory () const
 
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) const
 
virtual QRect clipRect () const
 
virtual void draw (QCPPainter *painter)=0
 
virtual void selectEvent (QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
 
virtual void deselectEvent (bool *selectionStateChanged)
 
- Protected Member Functions inherited from QCPLayoutElement
virtual int calculateAutoMargin (QCP::MarginSide side)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void wheelEvent (QWheelEvent *event)
 
virtual void parentPlotInitialized (QCustomPlot *parentPlot)
 
- Protected Member Functions inherited from QCPLayerable
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

QCPLegend * mParentLegend
 
QFont mFont
 
QColor mTextColor
 
QFont mSelectedFont
 
QColor mSelectedTextColor
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayoutElement
QCPLayout * mParentLayout
 
QSize mMinimumSize
 
QSize mMaximumSize
 
QRect mRect
 
QRect mOuterRect
 
QMargins mMargins
 
QMargins mMinimumMargins
 
QCP::MarginSides mAutoMargins
 
QHash< QCP::MarginSide, QCPMarginGroup * > mMarginGroups
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlot * mParentPlot
 
QPointer< QCPLayerable > mParentLayerable
 
QCPLayer * mLayer
 
bool mAntialiased
 

Friends

class QCPLegend
 

Additional Inherited Members

- Public Types inherited from QCPLayoutElement
enum  UpdatePhase { upPreparation, upMargins, upLayout }
 

Detailed Description

The abstract base class for all entries in a QCPLegend.

It defines a very basic interface for entries in a QCPLegend. For representing plottables in the legend, the subclass QCPPlottableLegendItem is more suitable.

Only derive directly from this class when you need absolute freedom (e.g. a custom legend entry that's not even associated with a plottable).

You must implement the following pure virtual functions:

You inherit the following members you may use:

QCPLegend *mParentLegend A pointer to the parent QCPLegend.
QFont mFont The generic font of the item. You should use this font for all or at least the most prominent text of the item.

Definition at line 2081 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPAbstractLegendItem::QCPAbstractLegendItem ( QCPLegend *  parent)
explicit

Constructs a QCPAbstractLegendItem and associates it with the QCPLegend parent. This does not cause the item to be added to parent, so QCPLegend::addItem must be called separately.

Definition at line 12641 of file qcustomplot.cpp.

Member Function Documentation

void QCPAbstractLegendItem::applyDefaultAntialiasingHint ( QCPPainter *  painter) const
protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 12743 of file qcustomplot.cpp.

QRect QCPAbstractLegendItem::clipRect ( ) const
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 12749 of file qcustomplot.cpp.

void QCPAbstractLegendItem::deselectEvent ( bool *  selectionStateChanged)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 12769 of file qcustomplot.cpp.

virtual void QCPAbstractLegendItem::draw ( QCPPainter *  painter)
protectedpure virtual

Reimplemented from QCPLayoutElement.

Implemented in QCPPlottableLegendItem.

QFont QCPAbstractLegendItem::font ( ) const
inline

Definition at line 2098 of file qcustomplot.h.

QCPLegend* QCPAbstractLegendItem::parentLegend ( ) const
inline

Definition at line 2097 of file qcustomplot.h.

bool QCPAbstractLegendItem::selectable ( ) const
inline

Definition at line 2102 of file qcustomplot.h.

void QCPAbstractLegendItem::selectableChanged ( bool  selectable)
signal
bool QCPAbstractLegendItem::selected ( ) const
inline

Definition at line 2103 of file qcustomplot.h.

QFont QCPAbstractLegendItem::selectedFont ( ) const
inline

Definition at line 2100 of file qcustomplot.h.

QColor QCPAbstractLegendItem::selectedTextColor ( ) const
inline

Definition at line 2101 of file qcustomplot.h.

void QCPAbstractLegendItem::selectEvent ( QMouseEvent *  event,
bool  additive,
const QVariant &  details,
bool *  selectionStateChanged 
)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 12755 of file qcustomplot.cpp.

QCP::Interaction QCPAbstractLegendItem::selectionCategory ( ) const
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 13459 of file qcustomplot.cpp.

void QCPAbstractLegendItem::selectionChanged ( bool  selected)
signal

This signal is emitted when the selection state of this legend item has changed, either by user interaction or by a direct call to setSelected.

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

Layout elements are sensitive to events inside their outer rect. If pos is within the outer rect, this method returns a value corresponding to 0.99 times the parent plot's selection tolerance. However, layout elements are not selectable by default. So if onlySelectable is true, -1.0 is returned.

See QCPLayerable::selectTest for a general explanation of this virtual method.

QCPLayoutElement subclasses may reimplement this method to provide more specific selection test behaviour.

Reimplemented from QCPLayoutElement.

Definition at line 12729 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setFont ( const QFont &  font)

Sets the default font of this specific legend item to font.

See also
setTextColor, QCPLegend::setFont

Definition at line 12660 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setSelectable ( bool  selectable)

Sets whether this specific legend item is selectable.

See also
setSelectedParts, QCustomPlot::setInteractions

Definition at line 12702 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setSelected ( bool  selected)

Sets whether this specific legend item is selected.

It is possible to set the selection state of this item by calling this function directly, even if setSelectable is set to false.

See also
setSelectableParts, QCustomPlot::setInteractions

Definition at line 12719 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setSelectedFont ( const QFont &  font)

When this legend item is selected, font is used to draw generic text, instead of the normal font set with setFont.

See also
setFont, QCPLegend::setSelectedFont

Definition at line 12681 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setSelectedTextColor ( const QColor &  color)

When this legend item is selected, color is used to draw generic text, instead of the normal color set with setTextColor.

See also
setTextColor, QCPLegend::setSelectedTextColor

Definition at line 12692 of file qcustomplot.cpp.

void QCPAbstractLegendItem::setTextColor ( const QColor &  color)

Sets the default text color of this specific legend item to color.

See also
setFont, QCPLegend::setTextColor

Definition at line 12670 of file qcustomplot.cpp.

QColor QCPAbstractLegendItem::textColor ( ) const
inline

Definition at line 2099 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPLegend
friend

Definition at line 2141 of file qcustomplot.h.

Member Data Documentation

QFont QCPAbstractLegendItem::mFont
protected

Definition at line 2123 of file qcustomplot.h.

QCPLegend* QCPAbstractLegendItem::mParentLegend
protected

Definition at line 2122 of file qcustomplot.h.

bool QCPAbstractLegendItem::mSelectable
protected

Definition at line 2127 of file qcustomplot.h.

bool QCPAbstractLegendItem::mSelected
protected

Definition at line 2127 of file qcustomplot.h.

QFont QCPAbstractLegendItem::mSelectedFont
protected

Definition at line 2125 of file qcustomplot.h.

QColor QCPAbstractLegendItem::mSelectedTextColor
protected

Definition at line 2126 of file qcustomplot.h.

QColor QCPAbstractLegendItem::mTextColor
protected

Definition at line 2124 of file qcustomplot.h.

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