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

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)

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

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.

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.

Member Function Documentation

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.

void QCPAbstractLegendItem::setFont ( const QFont & font )

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