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

#include <qcustomplot.h>

Inheritance diagram for QCPAbstractLegendItem:

Signals
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Public Member Functions
QFont	font () const

QCPLegend *	parentLegend () const

	QCPAbstractLegendItem (QCPLegend *parent)

bool	selectable () const

bool	selected () const

QFont	selectedFont () const

QColor	selectedTextColor () const

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

void	setFont (const QFont &font)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

void	setSelectedFont (const QFont &font)

void	setSelectedTextColor (const QColor &color)

void	setTextColor (const QColor &color)

QColor	textColor () const

Public Member Functions inherited from QCPLayoutElement
QCP::MarginSides	autoMargins () const

virtual QList< QCPLayoutElement * >	elements (bool recursive) const

QCPLayout *	layout () const

QCPMarginGroup *	marginGroup (QCP::MarginSide side) const

QHash< QCP::MarginSide, QCPMarginGroup * >	marginGroups () const

QMargins	margins () const

virtual QSize	maximumOuterSizeHint () const

QSize	maximumSize () const

QMargins	minimumMargins () const

virtual QSize	minimumOuterSizeHint () const

QSize	minimumSize () const

QRect	outerRect () const

	QCPLayoutElement (QCustomPlot *parentPlot=0)

QRect	rect () const

void	setAutoMargins (QCP::MarginSides sides)

void	setMarginGroup (QCP::MarginSides sides, QCPMarginGroup *group)

void	setMargins (const QMargins &margins)

void	setMaximumSize (const QSize &size)

void	setMaximumSize (int width, int height)

void	setMinimumMargins (const QMargins &margins)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int width, int height)

void	setOuterRect (const QRect &rect)

void	setSizeConstraintRect (SizeConstraintRect constraintRect)

SizeConstraintRect	sizeConstraintRect () const

virtual void	update (UpdatePhase phase)

virtual	~QCPLayoutElement ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Protected Member Functions
virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual QRect	clipRect () const Q_DECL_OVERRIDE

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE=0

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual QCP::Interaction	selectionCategory () const Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayoutElement
virtual int	calculateAutoMargin (QCP::MarginSide side)

virtual void	layoutChanged ()

virtual void	parentPlotInitialized (QCustomPlot *parentPlot) Q_DECL_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)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
QFont	mFont

QCPLegend *	mParentLegend

bool	mSelectable

bool	mSelected

QFont	mSelectedFont

QColor	mSelectedTextColor

QColor	mTextColor

Protected Attributes inherited from QCPLayoutElement
QCP::MarginSides	mAutoMargins

QHash< QCP::MarginSide, QCPMarginGroup * >	mMarginGroups

QMargins	mMargins

QSize	mMaximumSize

QMargins	mMinimumMargins

QSize	mMinimumSize

QRect	mOuterRect

QCPLayout *	mParentLayout

QRect	mRect

SizeConstraintRect	mSizeConstraintRect

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Friends
class	QCPLegend

Additional Inherited Members
Public Types inherited from QCPLayoutElement
enum	SizeConstraintRect { scrInnerRect, scrOuterRect }

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:

draw (from QCPLayerable)

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 4719 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPAbstractLegendItem()

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 18006 of file qcustomplot.cpp.

Member Function Documentation

◆ applyDefaultAntialiasingHint()

void QCPAbstractLegendItem::applyDefaultAntialiasingHint ( QCPPainter * painter ) const

protectedvirtual

Reimplemented from QCPLayoutElement.

Definition at line 18108 of file qcustomplot.cpp.

◆ clipRect()

QRect QCPAbstractLegendItem::clipRect ( ) const

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18114 of file qcustomplot.cpp.

◆ deselectEvent()

void QCPAbstractLegendItem::deselectEvent ( bool * selectionStateChanged )

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18134 of file qcustomplot.cpp.

◆ draw()

virtual void QCPAbstractLegendItem::draw ( QCPPainter * painter )

protectedpure virtual

Reimplemented from QCPLayoutElement.

Implemented in QCPPlottableLegendItem.

◆ font()

QFont QCPAbstractLegendItem::font ( ) const

inline

Definition at line 4736 of file qcustomplot.h.

◆ parentLegend()

QCPLegend* QCPAbstractLegendItem::parentLegend ( ) const

inline

Definition at line 4735 of file qcustomplot.h.

◆ selectable()

bool QCPAbstractLegendItem::selectable ( ) const

inline

Definition at line 4740 of file qcustomplot.h.

◆ selectableChanged

void QCPAbstractLegendItem::selectableChanged ( bool selectable )

signal

◆ selected()

bool QCPAbstractLegendItem::selected ( ) const

inline

Definition at line 4741 of file qcustomplot.h.

◆ selectedFont()

QFont QCPAbstractLegendItem::selectedFont ( ) const

inline

Definition at line 4738 of file qcustomplot.h.

◆ selectedTextColor()

QColor QCPAbstractLegendItem::selectedTextColor ( ) const

inline

Definition at line 4739 of file qcustomplot.h.

◆ selectEvent()

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

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18120 of file qcustomplot.cpp.

◆ selectionCategory()

QCP::Interaction QCPAbstractLegendItem::selectionCategory ( ) const

protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 18863 of file qcustomplot.cpp.

◆ selectionChanged

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.

◆ selectTest()

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 18094 of file qcustomplot.cpp.

◆ setFont()

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 18025 of file qcustomplot.cpp.

◆ setSelectable()

void QCPAbstractLegendItem::setSelectable ( bool selectable )

Sets whether this specific legend item is selectable.

See also: setSelectedParts, QCustomPlot::setInteractions

Definition at line 18067 of file qcustomplot.cpp.

◆ setSelected()

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 18084 of file qcustomplot.cpp.

◆ setSelectedFont()

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 18046 of file qcustomplot.cpp.

◆ setSelectedTextColor()

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 18057 of file qcustomplot.cpp.

◆ setTextColor()

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 18035 of file qcustomplot.cpp.

◆ textColor()

QColor QCPAbstractLegendItem::textColor ( ) const

inline

Definition at line 4737 of file qcustomplot.h.

Friends And Related Function Documentation

◆ QCPLegend

friend class QCPLegend

friend

Definition at line 4779 of file qcustomplot.h.

Member Data Documentation

◆ mFont

QFont QCPAbstractLegendItem::mFont

protected

Definition at line 4761 of file qcustomplot.h.

◆ mParentLegend

QCPLegend* QCPAbstractLegendItem::mParentLegend

protected

Definition at line 4760 of file qcustomplot.h.

◆ mSelectable

bool QCPAbstractLegendItem::mSelectable

protected

Definition at line 4765 of file qcustomplot.h.

◆ mSelected

bool QCPAbstractLegendItem::mSelected

protected

Definition at line 4765 of file qcustomplot.h.

◆ mSelectedFont

QFont QCPAbstractLegendItem::mSelectedFont

protected

Definition at line 4763 of file qcustomplot.h.

◆ mSelectedTextColor

QColor QCPAbstractLegendItem::mSelectedTextColor

protected

Definition at line 4764 of file qcustomplot.h.

◆ mTextColor

QColor QCPAbstractLegendItem::mTextColor

protected

Definition at line 4762 of file qcustomplot.h.

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

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCPAbstractLegendItem()

Member Function Documentation

◆ applyDefaultAntialiasingHint()

◆ clipRect()

◆ deselectEvent()

◆ draw()

◆ font()

◆ parentLegend()

◆ selectable()

◆ selectableChanged

◆ selected()

◆ selectedFont()

◆ selectedTextColor()

◆ selectEvent()

◆ selectionCategory()

◆ selectionChanged

◆ selectTest()

◆ setFont()

◆ setSelectable()

◆ setSelected()

◆ setSelectedFont()

◆ setSelectedTextColor()

◆ setTextColor()

◆ textColor()

Friends And Related Function Documentation

◆ QCPLegend

Member Data Documentation

◆ mFont

◆ mParentLegend

◆ mSelectable

◆ mSelected

◆ mSelectedFont

◆ mSelectedTextColor

◆ mTextColor