A legend item representing a plottable with an icon and the plottable name. More...

#include <qcustomplot.h>

Inheritance diagram for QCPPlottableLegendItem:

Public Member Functions
QCPAbstractPlottable *	plottable ()

	QCPPlottableLegendItem (QCPLegend parent, QCPAbstractPlottable plottable)

Public Member Functions inherited from QCPAbstractLegendItem
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

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	draw (QCPPainter *painter) Q_DECL_OVERRIDE

QFont	getFont () const

QPen	getIconBorderPen () const

QColor	getTextColor () const

virtual QSize	minimumOuterSizeHint () const Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPAbstractLegendItem
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	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
QCPAbstractPlottable *	mPlottable

Protected Attributes inherited from QCPAbstractLegendItem
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

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

enum	UpdatePhase { upPreparation, upMargins, upLayout }

Signals inherited from QCPAbstractLegendItem
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Detailed Description

A legend item representing a plottable with an icon and the plottable name.

This is the standard legend item for plottables. It displays an icon of the plottable next to the plottable name. The icon is drawn by the respective plottable itself (QCPAbstractPlottable::drawLegendIcon), and tries to give an intuitive symbol for the plottable. For example, the QCPGraph draws a centered horizontal line and/or a single scatter point in the middle.

Legend items of this type are always associated with one plottable (retrievable via the plottable() function and settable with the constructor). You may change the font of the plottable name with setFont. Icon padding and border pen is taken from the parent QCPLegend, see QCPLegend::setIconBorderPen and QCPLegend::setIconTextPadding.

The function QCPAbstractPlottable::addToLegend/QCPAbstractPlottable::removeFromLegend creates/removes legend items of this type.

Since QCPLegend is based on QCPLayoutGrid, a legend item itself is just a subclass of QCPLayoutElement. While it could be added to a legend (or any other layout) via the normal layout interface, QCPLegend has specialized functions for handling legend items conveniently, see the documentation of QCPLegend.

Definition at line 4783 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPPlottableLegendItem()

QCPPlottableLegendItem::QCPPlottableLegendItem	(	QCPLegend *	parent,
		QCPAbstractPlottable *	plottable
	)

Creates a new legend item associated with plottable.

Once it's created, it can be added to the legend via QCPLegend::addItem.

A more convenient way of adding/removing a plottable to/from the legend is via the functions QCPAbstractPlottable::addToLegend and QCPAbstractPlottable::removeFromLegend.

Definition at line 18180 of file qcustomplot.cpp.

Member Function Documentation

◆ draw()

void QCPPlottableLegendItem::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractLegendItem.

Definition at line 18223 of file qcustomplot.cpp.

◆ getFont()

QFont QCPPlottableLegendItem::getFont ( ) const

protected

Definition at line 18212 of file qcustomplot.cpp.

◆ getIconBorderPen()

QPen QCPPlottableLegendItem::getIconBorderPen ( ) const

protected

Definition at line 18192 of file qcustomplot.cpp.

◆ getTextColor()

QColor QCPPlottableLegendItem::getTextColor ( ) const

protected

Definition at line 18202 of file qcustomplot.cpp.

◆ minimumOuterSizeHint()

QSize QCPPlottableLegendItem::minimumOuterSizeHint ( ) const

protectedvirtual

Returns the suggested minimum size this layout element (the outerRect) may be compressed to, if no manual minimum size is set.

if a minimum size (setMinimumSize) was not set manually, parent layouts use the returned size (usually indirectly through QCPLayout::getFinalMinimumOuterSize) to determine the minimum allowed size of this layout element.

A manual minimum size is considered set if it is non-zero.

The default implementation simply returns the sum of the horizontal margins for the width and the sum of the vertical margins for the height. Reimplementations may use their detailed knowledge about the layout element's content to provide size hints.

Reimplemented from QCPLayoutElement.

Definition at line 18256 of file qcustomplot.cpp.

◆ plottable()

QCPAbstractPlottable* QCPPlottableLegendItem::plottable ( )

inline

Definition at line 4790 of file qcustomplot.h.

Member Data Documentation

◆ mPlottable

QCPAbstractPlottable* QCPPlottableLegendItem::mPlottable

protected

Definition at line 4794 of file qcustomplot.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCPPlottableLegendItem()

Member Function Documentation

◆ draw()

◆ getFont()

◆ getIconBorderPen()

◆ getTextColor()

◆ minimumOuterSizeHint()

◆ plottable()

Member Data Documentation

◆ mPlottable