QCPPlottableLegendItem Class Reference

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

#include <qcustomplot.h>

Inherits QCPAbstractLegendItem.

Public Member Functions
	QCPPlottableLegendItem (QCPLegend *parent, const QCPAbstractPlottable *plottable)
virtual	~QCPPlottableLegendItem ()
const QCPAbstractPlottable *	plottable () const
void	setTextWrap (bool wrap)
bool	textWrap () const
Public Member Functions inherited from QCPAbstractLegendItem
	QCPAbstractLegendItem (QCPLegend *parent)
virtual	~QCPAbstractLegendItem ()
QFont	font () const
void	setFont (const QFont &font)

Protected Member Functions
virtual void	draw (QPainter *painter, const QRect &rect) const
virtual QSize	size (const QSize &targetSize) const

Protected Attributes
const QCPAbstractPlottable *	mPlottable
QSize	mIconSize
QPen	mIconBorderPen
int	mIconTextPadding
bool	mTextWrap
Protected Attributes inherited from QCPAbstractLegendItem
QCPLegend *	mParentLegend
QFont	mFont

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 with a single scatter point in the middle and filling (if enabled) below.

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. If setTextWrap is set to true, the plottable name will wrap at the right legend boundary (see QCPLegend::setMinimumSize). 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 in the default implementation. However, these functions may be reimplemented such that a different kind of legend item (e.g a direct subclass of QCPAbstractLegendItem) is used for that plottable.

Definition at line 533 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPPlottableLegendItem()

QCPPlottableLegendItem::QCPPlottableLegendItem	(	QCPLegend *	parent,
		const 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 6418 of file qcustomplot.cc.

                                                                                                       :
  QCPAbstractLegendItem(parent),
  mPlottable(plottable)
{
  // take default values from parent legend:
  mIconSize = parent->iconSize();
  mIconBorderPen = parent->iconBorderPen();
  mIconTextPadding = parent->iconTextPadding();
  mTextWrap = false;
}

~QCPPlottableLegendItem()

virtual QCPPlottableLegendItem::~QCPPlottableLegendItem ( )

inlinevirtual

Definition at line 537 of file qcustomplot.h.

{}

Member Function Documentation

draw()

void QCPPlottableLegendItem::draw ( QPainter *  painter, const QRect &  rect  ) const

protectedvirtual

Draws this legend item with painter inside the specified rect. The rect typically has the size which was returned from a preceding size call.

Implements QCPAbstractLegendItem.

Definition at line 6451 of file qcustomplot.cc.

{
  if (!mPlottable) return;
  painter->setFont(mFont);
  QRect textRect;
  QRect iconRect(rect.topLeft(), mIconSize);
  if (mTextWrap)
  {
    // take width from rect since our text should wrap there (only icon must fit at least):
    textRect = painter->fontMetrics().boundingRect(0, 0, rect.width()-mIconTextPadding-mIconSize.width(), rect.height(), Qt::TextDontClip | Qt::TextWordWrap, mPlottable->name());
    if (textRect.height() < mIconSize.height()) // text smaller than icon, center text vertically in icon height
    {
      painter->drawText(rect.x()+mIconSize.width()+mIconTextPadding, rect.y(), rect.width()-mIconTextPadding-mIconSize.width(), mIconSize.height(), Qt::TextDontClip | Qt::TextWordWrap, mPlottable->name());
    } else // text bigger than icon, position top of text with top of icon
    {
      painter->drawText(rect.x()+mIconSize.width()+mIconTextPadding, rect.y(), rect.width()-mIconTextPadding-mIconSize.width(), textRect.height(), Qt::TextDontClip | Qt::TextWordWrap, mPlottable->name());
    }
  } else
  {
    // text can't wrap (except with explicit newlines), center at current item size (icon size)
    textRect = painter->fontMetrics().boundingRect(0, 0, 0, rect.height(), Qt::TextDontClip, mPlottable->name());
    if (textRect.height() < mIconSize.height()) // text smaller than icon, center text vertically in icon height
    {
      painter->drawText(rect.x()+mIconSize.width()+mIconTextPadding, rect.y(), rect.width(), mIconSize.height(), Qt::TextDontClip, mPlottable->name());
    } else // text bigger than icon, position top of text with top of icon
    {
      painter->drawText(rect.x()+mIconSize.width()+mIconTextPadding, rect.y(), rect.width(), textRect.height(), Qt::TextDontClip, mPlottable->name());
    }
  }
  // draw icon:
  painter->save();
  painter->setClipRect(iconRect, Qt::IntersectClip);
  mPlottable->drawLegendIcon(painter, iconRect);
  painter->restore();
  // draw icon border:
  if (mIconBorderPen.style() != Qt::NoPen)
  {
    painter->setPen(mIconBorderPen);
    painter->setBrush(Qt::NoBrush);
    painter->drawRect(iconRect);
  }
}

plottable()

const QCPAbstractPlottable* QCPPlottableLegendItem::plottable ( ) const

inline

Definition at line 539 of file qcustomplot.h.

{ return mPlottable; }

setTextWrap()

void QCPPlottableLegendItem::setTextWrap

(

bool

wrap

)

Sets whether the text of the legend item is wrapped at word boundaries to fit the with of the legend.

To prevent the legend autoSize feature (QCPLegend::setAutoSize) from compressing the text too strong by wrapping it very often, set an appropriate minimum width with QCPLegend::setMinimumSize.

Definition at line 6437 of file qcustomplot.cc.

{
  mTextWrap = wrap;
}

size()

QSize QCPPlottableLegendItem::size ( const QSize &  targetSize ) const

protectedvirtual

Returns the size this item occupies in the legend. The legend will adapt its layout with the help of this function. If this legend item can have a variable width (e.g. auto-wrapping text), this function tries to find a size with a width close to the width of targetSize. The height of targetSize only may have meaning in specific sublasses. Typically, it's ignored.

Implements QCPAbstractLegendItem.

Definition at line 6505 of file qcustomplot.cc.

{
  if (!mPlottable) return QSize();
  QSize result(0, 0);
  QRect textRect;
  QFontMetrics fontMetrics(mFont);
  if (mTextWrap)
  {
    // take width from targetSize since our text can wrap (Only icon must fit at least):
    textRect = fontMetrics.boundingRect(0, 0, targetSize.width()-mIconTextPadding-mIconSize.width(), mIconSize.height(), Qt::TextDontClip | Qt::TextWordWrap, mPlottable->name());
  } else
  {
    // text can't wrap (except with explicit newlines), center at current item size (icon size)
    textRect = fontMetrics.boundingRect(0, 0, 0, mIconSize.height(), Qt::TextDontClip, mPlottable->name());
  }
  result.setWidth(mIconSize.width() + mIconTextPadding + textRect.width());
  result.setHeight(qMax(textRect.height(), mIconSize.height()));
  return result;
}

textWrap()

bool QCPPlottableLegendItem::textWrap ( ) const

inline

Definition at line 541 of file qcustomplot.h.

{ return mTextWrap; }

Member Data Documentation

mIconBorderPen

QPen QCPPlottableLegendItem::mIconBorderPen

protected

Definition at line 546 of file qcustomplot.h.

mIconSize

QSize QCPPlottableLegendItem::mIconSize

protected

Definition at line 545 of file qcustomplot.h.

mIconTextPadding

int QCPPlottableLegendItem::mIconTextPadding

protected

Definition at line 547 of file qcustomplot.h.

mPlottable

const QCPAbstractPlottable* QCPPlottableLegendItem::mPlottable

protected

Definition at line 544 of file qcustomplot.h.

mTextWrap

bool QCPPlottableLegendItem::mTextWrap

protected

Definition at line 548 of file qcustomplot.h.

---

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

• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/plot2d/qcustomplot.h
• /build/rock-master-18.09-gui-rock-widget-collection-0.20180124/src/plot2d/qcustomplot.cc