Manages a legend inside a QCustomPlot. More...

#include <qcustomplot.h>

Inherits QObject.

Public Types
enum	PositionStyle { PSManual, PSTopLeft, PSTop, PSTopRight, PSRight, PSBottomRight, PSBottom, PSBottomLeft, PSLeft }

Public Slots
QPen	borderPen () const

QBrush	brush () const

QFont	font () const

PositionStyle	positionStyle () const

QPoint	position () const

bool	autoSize () const

QSize	size () const

QSize	minimumSize () const

bool	visible () const

int	paddingLeft () const

int	paddingRight () const

int	paddingTop () const

int	paddingBottom () const

int	marginLeft () const

int	marginRight () const

int	marginTop () const

int	marginBottom () const

int	itemSpacing () const

QSize	iconSize () const

int	iconTextPadding () const

QPen	iconBorderPen () const

int	getItemIndex (const QPoint *point)

void	setBorderPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setFont (const QFont &font)

void	setPositionStyle (PositionStyle legendPositionStyle)

void	setPosition (const QPoint &pixelPosition)

void	setAutoSize (bool on)

void	setSize (const QSize &size)

void	setSize (int width, int height)

void	setMinimumSize (const QSize &size)

void	setMinimumSize (int width, int height)

void	setVisible (bool on)

void	setPaddingLeft (int padding)

void	setPaddingRight (int padding)

void	setPaddingTop (int padding)

void	setPaddingBottom (int padding)

void	setPadding (int left, int right, int top, int bottom)

void	setMarginLeft (int margin)

void	setMarginRight (int margin)

void	setMarginTop (int margin)

void	setMarginBottom (int margin)

void	setMargin (int left, int right, int top, int bottom)

void	setItemSpacing (int spacing)

void	setIconSize (const QSize &size)

void	setIconSize (int width, int height)

void	setIconTextPadding (int padding)

void	setIconBorderPen (const QPen &pen)

QCPAbstractLegendItem *	item (int index) const

QCPPlottableLegendItem *	itemWithPlottable (const QCPAbstractPlottable *plottable) const

int	itemCount () const

bool	hasItem (QCPAbstractLegendItem *item) const

bool	hasItemWithPlottable (const QCPAbstractPlottable *plottable) const

bool	addItem (QCPAbstractLegendItem *item)

bool	removeItem (int index)

bool	removeItem (QCPAbstractLegendItem *item)

void	clearItems ()

void	reArrange ()

Public Member Functions
	QCPLegend (QCustomPlot *parentPlot)

virtual	~QCPLegend ()

Protected Member Functions
virtual void	draw (QPainter *painter)

virtual void	calculateAutoSize ()

virtual void	calculateAutoPosition ()

Protected Attributes
QPen	mBorderPen

QPen	mIconBorderPen

QBrush	mBrush

QFont	mFont

QPoint	mPosition

QSize	mSize

QSize	mMinimumSize

QSize	mIconSize

PositionStyle	mPositionStyle

bool	mAutoSize

bool	mVisible

int	mPaddingLeft

int	mPaddingRight

int	mPaddingTop

int	mPaddingBottom

int	mMarginLeft

int	mMarginRight

int	mMarginTop

int	mMarginBottom

int	mItemSpacing

int	mIconTextPadding

QCustomPlot *	mParentPlot

QList< QCPAbstractLegendItem * >	mItems

Friends
class	QCustomPlot

Detailed Description

Manages a legend inside a QCustomPlot.

Doesn't need to be instantiated externally, rather access QCustomPlot::legend

Definition at line 554 of file qcustomplot.h.

Member Enumeration Documentation

◆ PositionStyle

enum QCPLegend::PositionStyle

Defines where the legend is positioned inside the QCustomPlot axis rect.

Enumerator
PSManual	Position is not changed automatically. Set manually via setPosition.
PSTopLeft	Legend is positioned in the top left corner of the axis rect with distance to the border corresponding to the currently set top and left margins.
PSTop	Legend is horizontally centered at the top of the axis rect with distance to the border corresponding to the currently set top margin.
PSTopRight	Legend is positioned in the top right corner of the axis rect with distance to the border corresponding to the currently set top and right margins.
PSRight	Legend is vertically centered at the right of the axis rect with distance to the border corresponding to the currently set right margin.
PSBottomRight	Legend is positioned in the bottom right corner of the axis rect with distance to the border corresponding to the currently set bottom and right margins.
PSBottom	Legend is horizontally centered at the bottom of the axis rect with distance to the border corresponding to the currently set bottom margin.
PSBottomLeft	Legend is positioned in the bottom left corner of the axis rect with distance to the border corresponding to the currently set bottom and left margins.
PSLeft	Legend is vertically centered at the left of the axis rect with distance to the border corresponding to the currently set left margin.

Definition at line 561 of file qcustomplot.h.

                      {PSManual,      
                       PSTopLeft,     
                       PSTop,         
                       PSTopRight,    
                       PSRight,       
                       PSBottomRight, 
                       PSBottom,      
                       PSBottomLeft,  
                       PSLeft         
                      };

Constructor & Destructor Documentation

◆ QCPLegend()

QCPLegend::QCPLegend ( QCustomPlot * parentPlot )

explicit

Constructs a new QCPLegend instance with parentPlot as the containing plot and default values. Under normal usage, QCPLegend needn't be instantiated outside of QCustomPlot. Access QCustomPlot::legend to modify the legend (set to invisible by default, see setVisible).

Definition at line 2505 of file qcustomplot.cc.

                                             : 
   QObject(parentPlot)
 {
   mParentPlot = parentPlot;
   setVisible(true);
   setBorderPen(QPen(Qt::black));
   setIconBorderPen(Qt::NoPen);
   setBrush(QBrush(Qt::white));
   setFont(parentPlot->font());
   setPositionStyle(PSTopRight);
   setSize(100, 28);
   setMinimumSize(100, 0);
   setAutoSize(true);
   
   setMargin(12, 12, 12, 12);
   setPadding(8, 8, 3, 3);
   setIconSize(32, 18);
   setItemSpacing(3);
   setIconTextPadding(7);
 }

◆ ~QCPLegend()

QCPLegend::~QCPLegend ( )

virtual

Definition at line 2526 of file qcustomplot.cc.

 {
   clearItems();
 }

Member Function Documentation

◆ addItem

bool QCPLegend::addItem ( QCPAbstractLegendItem * item )

slot

Adds item to the legend, if it's not present already.

Returns true on sucess, i.e. if the item wasn't in the list already and has been successfully added.

The legend takes ownership of the item.

Definition at line 2867 of file qcustomplot.cc.

 {
   if (!mItems.contains(item))
   {
     mItems.append(item);
     return true;
   } else
     return false;
 }

◆ autoSize

bool QCPLegend::autoSize ( ) const

inlineslot

Definition at line 583 of file qcustomplot.h.

583 { return mAutoSize; }

QCPLegend::mAutoSize

bool mAutoSize

Definition: qcustomplot.h:650

◆ borderPen

QPen QCPLegend::borderPen ( ) const

inlineslot

Definition at line 578 of file qcustomplot.h.

578 { return mBorderPen; }

QCPLegend::mBorderPen

QPen mBorderPen

Definition: qcustomplot.h:644

◆ brush

QBrush QCPLegend::brush ( ) const

inlineslot

Definition at line 579 of file qcustomplot.h.

579 { return mBrush; }

QCPLegend::mBrush

QBrush mBrush

Definition: qcustomplot.h:645

◆ calculateAutoPosition()

void QCPLegend::calculateAutoPosition ( )

protectedvirtual

Definition at line 3029 of file qcustomplot.cc.

 {
   if (mPositionStyle == PSTopLeft)
   {
     mPosition = mParentPlot->mAxisRect.topLeft() + QPoint(mMarginLeft, mMarginTop);
   } else if (mPositionStyle == PSTop)
   {
     mPosition = mParentPlot->mAxisRect.topLeft() + QPoint(mParentPlot->mAxisRect.width()/2.0-mSize.width()/2.0, mMarginTop);
   } else if (mPositionStyle == PSTopRight)
   {
     mPosition = mParentPlot->mAxisRect.topRight() + QPoint(-mMarginRight-mSize.width(), mMarginTop);
   } else if (mPositionStyle == PSRight)
   {
     mPosition = mParentPlot->mAxisRect.topRight() + QPoint(-mMarginRight-mSize.width(), mParentPlot->mAxisRect.height()/2.0-mSize.height()/2.0);
   } else if (mPositionStyle == PSBottomRight)
   {
     mPosition = mParentPlot->mAxisRect.bottomRight() + QPoint(-mMarginRight-mSize.width(), -mMarginBottom-mSize.height());
   } else if (mPositionStyle == PSBottom)
   {
     mPosition = mParentPlot->mAxisRect.bottomLeft() + QPoint(mParentPlot->mAxisRect.width()/2.0-mSize.width()/2.0, -mMarginBottom-mSize.height());
   } else if (mPositionStyle == PSBottomLeft)
   {
     mPosition = mParentPlot->mAxisRect.bottomLeft() + QPoint(mMarginLeft, -mMarginBottom-mSize.height());
   } else if (mPositionStyle == PSLeft)
   {
     mPosition = mParentPlot->mAxisRect.topLeft() + QPoint(mMarginLeft, mParentPlot->mAxisRect.height()/2.0-mSize.height()/2.0);
   }
 }

◆ calculateAutoSize()

void QCPLegend::calculateAutoSize ( )

protectedvirtual

Definition at line 2989 of file qcustomplot.cc.

 {
   int width = mMinimumSize.width()-mPaddingLeft-mPaddingRight; // start with minimum width and only expand from there
   int currentTop;
   bool repeat = true;
   int repeatCount = 0;
   while (repeat && repeatCount < 3) // repeat until we find self-consistent width (usually 2 runs)
   {
     repeat = false;
     currentTop = mPaddingTop;
     for (int i=0; i<mItems.size(); ++i)
     {
       QSize s = mItems.at(i)->size(QSize(width, 0));
       currentTop += s.height();
       if (i < mItems.size()-1) // vertical spacer for all but last item
         currentTop += mItemSpacing;
       if (width < s.width())
       {
         width = s.width();
         repeat = true; // changed width, so need a new run with new width to let other items adapt their height to that new width
       }
     }
     repeatCount++;
   }
   if (repeat)
     qDebug() << FUNCNAME << "hit repeat limit for iterative width calculation";
   currentTop += mPaddingBottom;
   width += mPaddingLeft+mPaddingRight;
   
   mSize.setWidth(width);
   if (currentTop > mMinimumSize.height())
     mSize.setHeight(currentTop);
   else
     mSize.setHeight(mMinimumSize.height());
 }

◆ clearItems

void QCPLegend::clearItems ( )

slot

Removes all items from the legend.

Definition at line 2911 of file qcustomplot.cc.

 {
   qDeleteAll(mItems);
   mItems.clear();
 }

◆ draw()

void QCPLegend::draw ( QPainter * painter )

protectedvirtual

Definition at line 2935 of file qcustomplot.cc.

 {
   if (!mVisible) return;
   painter->save();
   painter->setBrush(mBrush);
   painter->setPen(mBorderPen);
   // draw background rect:
   painter->drawRect(QRect(mPosition, mSize));
   // draw legend items:
   painter->setClipRect(QRect(mPosition, mSize).adjusted(1, 1, 0, 0));
   painter->setPen(QPen());
   painter->setBrush(Qt::NoBrush);
   int currentTop = mPosition.y()+mPaddingTop;
   for (int i=0; i<mItems.size(); ++i)
   {
     QSize itemSize = mItems.at(i)->size(QSize(mSize.width(), 0));
     painter->save(); // this might be user subclass, so we save painter outside - just in case
     mItems.at(i)->draw(painter, QRect(QPoint(mPosition.x()+mPaddingLeft, currentTop), itemSize));
     painter->restore();
     currentTop += itemSize.height()+mItemSpacing;
   }
   painter->restore();
 }

◆ font

QFont QCPLegend::font ( ) const

inlineslot

Definition at line 580 of file qcustomplot.h.

580 { return mFont; }

QCPLegend::mFont

QFont mFont

Definition: qcustomplot.h:646

◆ getItemIndex

int QCPLegend::getItemIndex ( const QPoint * point )

slot

Definition at line 2959 of file qcustomplot.cc.

 {
   if (!mVisible) return -1;
     
   int currentTop = mPosition.y() + mPaddingTop;
   
   for (int i=0; i<mItems.size(); ++i)
   {
     QSize itemSize = mItems.at(i)->size(QSize(mSize.width(), 0));
     QPoint itemPosTopLeft = QPoint(mPosition.x()+mPaddingLeft, currentTop);
     
     if (point->x() >= itemPosTopLeft.x() &&
         point->x() <= itemPosTopLeft.x()+itemSize.width() &&
         point->y() >= itemPosTopLeft.y() &&
         point->y() <= itemPosTopLeft.y()+itemSize.height()) 
     {
       return i;
     }
     
     currentTop += itemSize.height()+mItemSpacing;
   }
   
   return -1;
 }

◆ hasItem

bool QCPLegend::hasItem ( QCPAbstractLegendItem * item ) const

slot

Returns whether the legend contains item.

Definition at line 2844 of file qcustomplot.cc.

 {
   return mItems.contains(item);
 }

◆ hasItemWithPlottable

bool QCPLegend::hasItemWithPlottable ( const QCPAbstractPlottable * plottable ) const

slot

Returns whether the legend contains a QCPPlottableLegendItem which is associated with plottable (e.g. a QCPGraph*). If such an item isn't in the legend, returns false.

See also: itemWithPlottable

Definition at line 2855 of file qcustomplot.cc.

 {
   return itemWithPlottable(plottable);
 }

◆ iconBorderPen

QPen QCPLegend::iconBorderPen ( ) const

inlineslot

Definition at line 598 of file qcustomplot.h.

598 { return mIconBorderPen; }

QCPLegend::mIconBorderPen

QPen mIconBorderPen

Definition: qcustomplot.h:644

◆ iconSize

QSize QCPLegend::iconSize ( ) const

inlineslot

Definition at line 596 of file qcustomplot.h.

596 { return mIconSize; }

QCPLegend::mIconSize

QSize mIconSize

Definition: qcustomplot.h:648

◆ iconTextPadding

int QCPLegend::iconTextPadding ( ) const

inlineslot

Definition at line 597 of file qcustomplot.h.

597 { return mIconTextPadding; }

QCPLegend::mIconTextPadding

int mIconTextPadding

Definition: qcustomplot.h:653

◆ item

QCPAbstractLegendItem * QCPLegend::item ( int index ) const

slot

Returns the item with index i.

See also: itemCount

Definition at line 2805 of file qcustomplot.cc.

 {
   if (index >= 0 && index < mItems.size())
     return mItems[index];
   else
     return 0;
 }

◆ itemCount

int QCPLegend::itemCount ( ) const

slot

Returns the number of items currently in the legend.

See also: item

Definition at line 2836 of file qcustomplot.cc.

 {
   return mItems.size();
 }

◆ itemSpacing

int QCPLegend::itemSpacing ( ) const

inlineslot

Definition at line 595 of file qcustomplot.h.

595 { return mItemSpacing; }

QCPLegend::mItemSpacing

int mItemSpacing

Definition: qcustomplot.h:653

◆ itemWithPlottable

QCPPlottableLegendItem * QCPLegend::itemWithPlottable ( const QCPAbstractPlottable * plottable ) const

slot

Returns the QCPPlottableLegendItem which is associated with plottable (e.g. a QCPGraph*). If such an item isn't in the legend, returns 0.

See also: hasItemWithPlottable

Definition at line 2819 of file qcustomplot.cc.

 {
   for (int i=0; i<mItems.size(); ++i)
   {
     if (QCPPlottableLegendItem *lip = dynamic_cast<QCPPlottableLegendItem*>(mItems.at(i)))
     {
       if (lip->plottable() == plottable)
         return lip;
     }
   }
   return 0;
 }

◆ marginBottom

int QCPLegend::marginBottom ( ) const

inlineslot

Definition at line 594 of file qcustomplot.h.

594 { return mMarginBottom; }

QCPLegend::mMarginBottom

int mMarginBottom

Definition: qcustomplot.h:652

◆ marginLeft

int QCPLegend::marginLeft ( ) const

inlineslot

Definition at line 591 of file qcustomplot.h.

591 { return mMarginLeft; }

QCPLegend::mMarginLeft

int mMarginLeft

Definition: qcustomplot.h:652

◆ marginRight

int QCPLegend::marginRight ( ) const

inlineslot

Definition at line 592 of file qcustomplot.h.

592 { return mMarginRight; }

QCPLegend::mMarginRight

int mMarginRight

Definition: qcustomplot.h:652

◆ marginTop

int QCPLegend::marginTop ( ) const

inlineslot

Definition at line 593 of file qcustomplot.h.

593 { return mMarginTop; }

QCPLegend::mMarginTop

int mMarginTop

Definition: qcustomplot.h:652

◆ minimumSize

QSize QCPLegend::minimumSize ( ) const

inlineslot

Definition at line 585 of file qcustomplot.h.

585 { return mMinimumSize; }

QCPLegend::mMinimumSize

QSize mMinimumSize

Definition: qcustomplot.h:648

◆ paddingBottom

int QCPLegend::paddingBottom ( ) const

inlineslot

Definition at line 590 of file qcustomplot.h.

590 { return mPaddingBottom; }

QCPLegend::mPaddingBottom

int mPaddingBottom

Definition: qcustomplot.h:651

◆ paddingLeft

int QCPLegend::paddingLeft ( ) const

inlineslot

Definition at line 587 of file qcustomplot.h.

587 { return mPaddingLeft; }

QCPLegend::mPaddingLeft

int mPaddingLeft

Definition: qcustomplot.h:651

◆ paddingRight

int QCPLegend::paddingRight ( ) const

inlineslot

Definition at line 588 of file qcustomplot.h.

588 { return mPaddingRight; }

QCPLegend::mPaddingRight

int mPaddingRight

Definition: qcustomplot.h:651

◆ paddingTop

int QCPLegend::paddingTop ( ) const

inlineslot

Definition at line 589 of file qcustomplot.h.

589 { return mPaddingTop; }

QCPLegend::mPaddingTop

int mPaddingTop

Definition: qcustomplot.h:651

◆ position

QPoint QCPLegend::position ( ) const

inlineslot

Definition at line 582 of file qcustomplot.h.

582 { return mPosition; }

QCPLegend::mPosition

QPoint mPosition

Definition: qcustomplot.h:647

◆ positionStyle

PositionStyle QCPLegend::positionStyle ( ) const

inlineslot

Definition at line 581 of file qcustomplot.h.

581 { return mPositionStyle; }

QCPLegend::mPositionStyle

PositionStyle mPositionStyle

Definition: qcustomplot.h:649

◆ reArrange

void QCPLegend::reArrange ( )

slot

If setAutoSize is true, the size needed to fit all legend contents is calculated and applied. Finally, the automatic positioning of the legend is performed, depending on the setPositionStyle setting.

Definition at line 2922 of file qcustomplot.cc.

 {
   if (mAutoSize)
   {
     calculateAutoSize();
   }
   calculateAutoPosition();
 }

◆ removeItem [1/2]

bool QCPLegend::removeItem ( int index )

slot

Removes the item with index index from the legend.

Returns true, if successfull.

See also: itemCount, clearItems

Definition at line 2884 of file qcustomplot.cc.

 {
   if (index >= 0 && index < mItems.size())
   {
     delete mItems.at(index);
     mItems.removeAt(index);
     return true;
   } else
     return false;
 }

◆ removeItem [2/2]

bool QCPLegend::removeItem ( QCPAbstractLegendItem * item )

slot

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Removes item from the legend.

Returns true, if successfull.

See also: clearItems

Definition at line 2903 of file qcustomplot.cc.

 {
   return removeItem(mItems.indexOf(item));
 }

◆ setAutoSize

void QCPLegend::setAutoSize ( bool on )

slot

Sets whether the size of the legend should be calculated automatically to fit all the content (plus padding), or whether the size must be specified manually with setSize.

If the autoSize mechanism is enabled, the legend will have the smallest possible size to still display all its content. For items with text wrapping (QCPPlottableLegendItem::setTextWrap) this means, they would become very compressed, i.e. wrapped at every word. To prevent this, set a reasonable setMinimumSize width.

Definition at line 2589 of file qcustomplot.cc.

 {
   mAutoSize = on;
 }

◆ setBorderPen

void QCPLegend::setBorderPen ( const QPen & pen )

slot

Sets the pen, the border of the entire legend is drawn with.

Definition at line 2534 of file qcustomplot.cc.

 {
   mBorderPen = pen;
 }

◆ setBrush

void QCPLegend::setBrush ( const QBrush & brush )

slot

Sets the brush of the legend background.

Definition at line 2542 of file qcustomplot.cc.

 {
   mBrush = brush;
 }

◆ setFont

void QCPLegend::setFont ( const QFont & font )

slot

Sets the default font of legend text. Legend items that draw text (e.g. the name of a graph) will use this font by default. However, a different font can be specified on a per-item-basis by accessing the specific legend item.

Definition at line 2552 of file qcustomplot.cc.

 {
   mFont = font;
   for (int i=0; i<mItems.size(); ++i)
     mItems.at(i)->setFont(mFont);
 }

◆ setIconBorderPen

void QCPLegend::setIconBorderPen ( const QPen & pen )

slot

Sets the default pen used to draw a border around each legend icon. Legend items that draw an icon (e.g. a visual representation of the graph) will use this pen by default. However, different values can be specified on a per-item-basis by accessing the specific legend item.

If no border is wanted, set this to Qt::NoPen.

Definition at line 2795 of file qcustomplot.cc.

 {
   mIconBorderPen = pen;
 }

◆ setIconSize [1/2]

void QCPLegend::setIconSize ( const QSize & size )

slot

Sets the default size of legend icons. Legend items that draw an icon (e.g. a visual representation of the graph) will use this size by default. However, different values can be specified on a per-item-basis by accessing the specific legend item.

Definition at line 2762 of file qcustomplot.cc.

 {
   mIconSize = size;
 }

◆ setIconSize [2/2]

void QCPLegend::setIconSize	(	int	width,
		int	height
	)

slot

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2769 of file qcustomplot.cc.

 {
   mIconSize.setWidth(width);
   mIconSize.setHeight(height);
 }

◆ setIconTextPadding

void QCPLegend::setIconTextPadding ( int padding )

slot

Sets the default horizontal space in pixels between the legend icon and the text next to it. Legend items that draw an icon (e.g. a visual representation of the graph) and text (e.g. the name of the graph) will use this space by default. However, different values can be specified on a per-item-basis by accessing the specific legend item.

See also: setItemSpacing

Definition at line 2783 of file qcustomplot.cc.

 {
   mIconTextPadding = padding;
 }

◆ setItemSpacing

void QCPLegend::setItemSpacing ( int spacing )

slot

Sets the vertical space between two legend items in the legend.

See also: setIconTextPadding, setPadding

Definition at line 2752 of file qcustomplot.cc.

 {
   mItemSpacing = spacing;
 }

◆ setMargin

void QCPLegend::setMargin	(	int	left,
		int	right,
		int	top,
		int	bottom
	)

slot

Sets the margin of the legend. Margins are the distances the legend will keep to the axis rect, when setPositionStyle is not PSManual.

Definition at line 2739 of file qcustomplot.cc.

 {
   mMarginLeft = left;
   mMarginRight = right;
   mMarginTop = top;
   mMarginBottom = bottom;
 }

◆ setMarginBottom

void QCPLegend::setMarginBottom ( int margin )

slot

Sets the bottom margin of the legend. Margins are the distances the legend will keep to the axis rect, when setPositionStyle is not PSManual.

Definition at line 2730 of file qcustomplot.cc.

 {
   mMarginBottom = margin;
 }

◆ setMarginLeft

void QCPLegend::setMarginLeft ( int margin )

slot

Sets the left margin of the legend. Margins are the distances the legend will keep to the axis rect, when setPositionStyle is not PSManual.

Definition at line 2703 of file qcustomplot.cc.

 {
   mMarginLeft = margin;
 }

◆ setMarginRight

void QCPLegend::setMarginRight ( int margin )

slot

Sets the right margin of the legend. Margins are the distances the legend will keep to the axis rect, when setPositionStyle is not PSManual.

Definition at line 2712 of file qcustomplot.cc.

 {
   mMarginRight = margin;
 }

◆ setMarginTop

void QCPLegend::setMarginTop ( int margin )

slot

Sets the top margin of the legend. Margins are the distances the legend will keep to the axis rect, when setPositionStyle is not PSManual.

Definition at line 2721 of file qcustomplot.cc.

 {
   mMarginTop = margin;
 }

◆ setMinimumSize [1/2]

void QCPLegend::setMinimumSize ( const QSize & size )

slot

Sets the minimum size of the legend when setAutoSize is enabled.

If text wrapping is enabled in the legend items (e.g. QCPPlottableLegendItem::setTextWrap), this minimum size defines the width at which the wrapping will occur. Note that the wrapping will happen only at word boundaries, so the actual size might still be bigger than the size given here, but not smaller.

If setAutoSize is not enabled, the minimum size is ignored. Setting a smaller legend size with setSize manually, is not prevented.

See also: setAutoSize, setSize, QCPPlottableLegendItem::setTextWrap

Definition at line 2626 of file qcustomplot.cc.

 {
   mMinimumSize = size;
 }

◆ setMinimumSize [2/2]

void QCPLegend::setMinimumSize	(	int	width,
		int	height
	)

slot

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2633 of file qcustomplot.cc.

 {
   mMinimumSize = QSize(width, height);
 }

◆ setPadding

void QCPLegend::setPadding	(	int	left,
		int	right,
		int	top,
		int	bottom
	)

slot

Sets the padding of the legend. Padding is the space by what the legend box is made larger than minimally needed for the content to fit. I.e. it's the space left blank on each side inside the legend.

Definition at line 2691 of file qcustomplot.cc.

 {
   mPaddingLeft = left;
   mPaddingRight = right;
   mPaddingTop = top;
   mPaddingBottom = bottom;
 }

◆ setPaddingBottom

void QCPLegend::setPaddingBottom ( int padding )

slot

Sets the bottom padding of the legend. Padding is the space by what the legend box is made larger than minimally needed for the content to fit. I.e. it's the space left blank on each side inside the legend.

Definition at line 2681 of file qcustomplot.cc.

 {
   mPaddingBottom = padding;
 }

◆ setPaddingLeft

void QCPLegend::setPaddingLeft ( int padding )

slot

Sets the left padding of the legend. Padding is the space by what the legend box is made larger than minimally needed for the content to fit. I.e. it's the space left blank on each side inside the legend.

Definition at line 2651 of file qcustomplot.cc.

 {
   mPaddingLeft = padding;
 }

◆ setPaddingRight

void QCPLegend::setPaddingRight ( int padding )

slot

Sets the right padding of the legend. Padding is the space by what the legend box is made larger than minimally needed for the content to fit. I.e. it's the space left blank on each side inside the legend.

Definition at line 2661 of file qcustomplot.cc.

 {
   mPaddingRight = padding;
 }

◆ setPaddingTop

void QCPLegend::setPaddingTop ( int padding )

slot

Sets the top padding of the legend. Padding is the space by what the legend box is made larger than minimally needed for the content to fit. I.e. it's the space left blank on each side inside the legend.

Definition at line 2671 of file qcustomplot.cc.

 {
   mPaddingTop = padding;
 }

◆ setPosition

void QCPLegend::setPosition ( const QPoint & pixelPosition )

slot

Sets the exact pixel Position of the legend inside the QCustomPlot widget, if setPositionStyle is set to PSManual. Margins have no effect in that case.

Definition at line 2575 of file qcustomplot.cc.

 {
   mPosition = pixelPosition;
 }

◆ setPositionStyle

void QCPLegend::setPositionStyle ( PositionStyle legendPositionStyle )

slot

Sets the position style of the legend. If the legendPositionStyle is not PSManual, the position is found automatically depending on the specific legendPositionStyle and the legend margins. If legendPositionStyle is PSManual, the exact pixel position of the legend must be specified via setPosition. Margins have no effect in that case.

See also: setMargin

Definition at line 2566 of file qcustomplot.cc.

 {
   mPositionStyle = legendPositionStyle;
 }

◆ setSize [1/2]

void QCPLegend::setSize ( const QSize & size )

slot

Sets the size of the legend. Setting the size manually with this function only has an effect, if setAutoSize is set to false.

If you want to control the minimum size (or the text-wrapping width) while still leaving the autoSize mechanism enabled, consider using setMinimumSize.

See also: setAutoSize, setMinimumSize

Definition at line 2603 of file qcustomplot.cc.

 {
   mSize = size;
 }

◆ setSize [2/2]

void QCPLegend::setSize	(	int	width,
		int	height
	)

slot

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 2610 of file qcustomplot.cc.

 {
   mSize = QSize(width, height);
 }

◆ setVisible

void QCPLegend::setVisible ( bool on )

slot

Sets the visibility of the legend.

Definition at line 2641 of file qcustomplot.cc.

 {
   mVisible = on;
 }

◆ size

QSize QCPLegend::size ( ) const

inlineslot

Definition at line 584 of file qcustomplot.h.

584 { return mSize; }

QCPLegend::mSize

QSize mSize

Definition: qcustomplot.h:648

◆ visible

bool QCPLegend::visible ( ) const

inlineslot

Definition at line 586 of file qcustomplot.h.

586 { return mVisible; }

QCPLegend::mVisible

bool mVisible

Definition: qcustomplot.h:650

Friends And Related Function Documentation

◆ QCustomPlot

friend class QCustomPlot

friend

Definition at line 664 of file qcustomplot.h.

Member Data Documentation

◆ mAutoSize

bool QCPLegend::mAutoSize

protected

Definition at line 650 of file qcustomplot.h.

◆ mBorderPen

QPen QCPLegend::mBorderPen

protected

Definition at line 644 of file qcustomplot.h.

◆ mBrush

QBrush QCPLegend::mBrush

protected

Definition at line 645 of file qcustomplot.h.

◆ mFont

QFont QCPLegend::mFont

protected

Definition at line 646 of file qcustomplot.h.

◆ mIconBorderPen

QPen QCPLegend::mIconBorderPen

protected

Definition at line 644 of file qcustomplot.h.

◆ mIconSize

QSize QCPLegend::mIconSize

protected

Definition at line 648 of file qcustomplot.h.

◆ mIconTextPadding

int QCPLegend::mIconTextPadding

protected

Definition at line 653 of file qcustomplot.h.

◆ mItems

QList<QCPAbstractLegendItem*> QCPLegend::mItems

protected

Definition at line 657 of file qcustomplot.h.

◆ mItemSpacing

int QCPLegend::mItemSpacing

protected

Definition at line 653 of file qcustomplot.h.

◆ mMarginBottom

int QCPLegend::mMarginBottom

protected

Definition at line 652 of file qcustomplot.h.

◆ mMarginLeft

int QCPLegend::mMarginLeft

protected

Definition at line 652 of file qcustomplot.h.

◆ mMarginRight

int QCPLegend::mMarginRight

protected

Definition at line 652 of file qcustomplot.h.

◆ mMarginTop

int QCPLegend::mMarginTop

protected

Definition at line 652 of file qcustomplot.h.

◆ mMinimumSize

QSize QCPLegend::mMinimumSize

protected

Definition at line 648 of file qcustomplot.h.

◆ mPaddingBottom

int QCPLegend::mPaddingBottom

protected

Definition at line 651 of file qcustomplot.h.

◆ mPaddingLeft

int QCPLegend::mPaddingLeft

protected

Definition at line 651 of file qcustomplot.h.

◆ mPaddingRight

int QCPLegend::mPaddingRight

protected

Definition at line 651 of file qcustomplot.h.

◆ mPaddingTop

int QCPLegend::mPaddingTop

protected

Definition at line 651 of file qcustomplot.h.

◆ mParentPlot

QCustomPlot* QCPLegend::mParentPlot

protected

Definition at line 656 of file qcustomplot.h.

◆ mPosition

QPoint QCPLegend::mPosition

protected

Definition at line 647 of file qcustomplot.h.

◆ mPositionStyle

PositionStyle QCPLegend::mPositionStyle

protected

Definition at line 649 of file qcustomplot.h.

◆ mSize

QSize QCPLegend::mSize

protected

Definition at line 648 of file qcustomplot.h.

◆ mVisible

bool QCPLegend::mVisible

protected

Definition at line 650 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

Public Types

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ PositionStyle

Constructor & Destructor Documentation

◆ QCPLegend()

◆ ~QCPLegend()

Member Function Documentation

◆ addItem

◆ autoSize

◆ borderPen

◆ brush

◆ calculateAutoPosition()

◆ calculateAutoSize()

◆ clearItems

◆ draw()

◆ font

◆ getItemIndex

◆ hasItem

◆ hasItemWithPlottable

◆ iconBorderPen

◆ iconSize

◆ iconTextPadding

◆ item

◆ itemCount

◆ itemSpacing

◆ itemWithPlottable

◆ marginBottom

◆ marginLeft

◆ marginRight

◆ marginTop

◆ minimumSize

◆ paddingBottom

◆ paddingLeft

◆ paddingRight

◆ paddingTop

◆ position

◆ positionStyle

◆ reArrange

◆ removeItem [1/2]

◆ removeItem [2/2]

◆ setAutoSize

◆ setBorderPen

◆ setBrush

◆ setFont

◆ setIconBorderPen

◆ setIconSize [1/2]

◆ setIconSize [2/2]

◆ setIconTextPadding

◆ setItemSpacing

◆ setMargin

◆ setMarginBottom

◆ setMarginLeft

◆ setMarginRight

◆ setMarginTop

◆ setMinimumSize [1/2]

◆ setMinimumSize [2/2]

◆ setPadding

◆ setPaddingBottom

◆ setPaddingLeft

◆ setPaddingRight

◆ setPaddingTop

◆ setPosition

◆ setPositionStyle

◆ setSize [1/2]

◆ setSize [2/2]

◆ setVisible

◆ size

◆ visible

Friends And Related Function Documentation

◆ QCustomPlot

Member Data Documentation

◆ mAutoSize

◆ mBorderPen

◆ mBrush