QwtLegend(3)

💖 QwtLegend — straight from the Qwt User's Guide 💖

okay so bestie, pull up a chair 🫶 this whole page lives in the Qwt User's Guide manual, and it's all about one little widget that's secretly carrying the whole plot. let's get into it ✨

---

🌸 NAME 🌸

QwtLegend — that's it, that's the name. the legend widget itself. iconic behavior honestly 💅

---

✨ SYNOPSIS ✨

first things first, you gotta let the compiler know you want in:

#include <qwt_legend.h>

🎀 Public Types 🎀

two enums, both absolute main characters:

enum LegendDisplayPolicy { NoIdentifier =  0, FixedIdentifier =  1,
    AutoIdentifier =  2 }
enum LegendItemMode { ReadOnlyItem, ClickableItem, CheckableItem }

💜 Public Member Functions 💜

the full roster, no cap, nobody gets left out:

QwtLegend (QWidget *parent=NULL)
virtual ~QwtLegend ()
void clear ()
QWidget * contentsWidget ()
const QWidget * contentsWidget () const
LegendDisplayPolicy displayPolicy () const
virtual bool eventFilter (QObject *, QEvent *)
QWidget * find (const QwtLegendItemManager *) const
QwtLegendItemManager * find (const QWidget *) const
virtual int heightForWidth (int w) const
QScrollBar * horizontalScrollBar () const
int identifierMode () const
void insert (const QwtLegendItemManager *, QWidget *)
bool isEmpty () const
uint itemCount () const
LegendItemMode itemMode () const
virtual QList< QWidget * > legendItems () const
void remove (const QwtLegendItemManager *)
void setDisplayPolicy (LegendDisplayPolicy policy, int mode)
void setItemMode (LegendItemMode)
virtual QSize sizeHint () const
QScrollBar * verticalScrollBar () const

🦋 Protected Member Functions 🦋

the backstage crew, only your subclasses get to hang with them:

virtual void layoutContents ()
virtual void resizeEvent (QResizeEvent *)

---

🌈 Detailed Description 🌈

The legend widget.

The QwtLegend widget is a tabular arrangement of legend items. and like… what even is a legend item? plot twist: it might be any type of widget, literally anything. but in general, bestie, they're gonna be a QwtLegendItem.

See also: QwtLegendItem, QwtLegendItemManager, QwtPlot — the little friend group iykyk 💕

---

👑 Member Enumeration Documentation 👑

🍓 enum QwtLegend::LegendDisplayPolicy

Display policy. here's the vibe check on all three:

• NoIdentifier — The client code is responsible how to display of each legend item. The Qwt library will not interfere. (so it's giving "you're on your own, bestie, we're not touching that" 🙈)
• FixedIdentifier — All legend items are displayed with the QwtLegendItem::IdentifierMode to be passed in mode.
• AutoIdentifier — Each legend item is displayed with a mode that is a bitwise or of:
  • QwtLegendItem::ShowLine (if its curve is drawn with a line) and
  • QwtLegendItem::ShowSymbol (if its curve is drawn with symbols) and
  • QwtLegendItem::ShowText (if the has a title).

Default is AutoIdentifier. she's the default for a reason 💅

See also: setDisplayPolicy(), displayPolicy(), QwtLegendItem::IdentifierMode

🧚 enum QwtLegend::LegendItemMode

Interaction mode for the legend items. choose your fighter:

• ReadOnlyItem — The legend item is not interactive, like a label
• ClickableItem — The legend item is clickable, like a push button
• CheckableItem — The legend item is checkable, like a checkable button

Default is ReadOnlyItem. she just sits there and looks pretty, no thoughts, head empty 🌸

See also: setItemMode(), itemMode(), QwtLegendItem::IdentifierMode, QwtLegendItem::clicked(), QwtLegendItem::checked(), QwtPlot::legendClicked(), QwtPlot::legendChecked()

---

🫶 Constructor & Destructor Documentation 🫶

💫 QwtLegend::QwtLegend (QWidget *parent = NULL) [explicit]

Constructor. yes bestie, we're being [explicit] about it, no sneaky implicit conversions around here.

Parameters:

• parent — Parent widget

---

🔥 Member Function Documentation 🔥

⭐ QWidget * QwtLegend::contentsWidget ()

The contents widget is the only child of the viewport() and the parent widget of all legend items.

⭐ const QWidget * QwtLegend::contentsWidget () const

The contents widget is the only child of the viewport() and the parent widget of all legend items.

(yes, same energy, one's just const — she promised not to touch anything 🤝)

💖 QwtLegend::LegendDisplayPolicy QwtLegend::displayPolicy () const

Returns: the legend display policy. Default is LegendDisplayPolicy::Auto.

See also: setDisplayPolicy(), LegendDisplayPolicy

🎀 bool QwtLegend::eventFilter (QObject *o, QEvent *e) [virtual]

Filter layout related events of QwtLegend::contentsWidget().

Parameters:

• o — Object to be filtered
• e — Event

🌸 QWidget * QwtLegend::find (const QwtLegendItemManager *plotItem) const

Find the widget that represents a plot item.

Parameters:

• plotItem — Plot item

Returns: Widget on the legend, or NULL

🌸 QwtLegendItemManager * QwtLegend::find (const QWidget *legendItem) const

Find the widget that represents a plot item.

Parameters:

• legendItem — Legend item

Returns: Widget on the legend, or NULL

🦋 int QwtLegend::heightForWidth (intwidth) const [virtual]

Returns: The preferred height, for the width w.

Parameters:

• width — Width

💜 QScrollBar * QwtLegend::horizontalScrollBar () const

Returns: Horizontal scrollbar

See also: verticalScrollBar()

✨ int QwtLegend::identifierMode () const

Returns: the IdentifierMode to be used in combination with LegendDisplayPolicy::Fixed.

Default is ShowLine | ShowSymbol | ShowText.

🍓 void QwtLegend::insert (const QwtLegendItemManager *plotItem, QWidget *legendItem)

Insert a new item for a plot item.

Parameters:

• plotItem — Plot item
• legendItem — New legend item

Note: The parent of item will be changed to QwtLegend::contentsWidget() — so heads up, your widget is getting re-parented, no take-backs 💀

🌈 QwtLegend::LegendItemMode QwtLegend::itemMode () const

See also: LegendItemMode

🌿 void QwtLegend::layoutContents () [protected], [virtual]

Adjust contents widget and item layout to the size of the viewport().

🧚 void QwtLegend::remove (const QwtLegendItemManager *plotItem)

Find the corresponding item for a plotItem and remove it from the item list.

Parameters:

• plotItem — Plot item

⭐ void QwtLegend::resizeEvent (QResizeEvent *e) [protected], [virtual]

Resize event.

Parameters:

• e — Resize event

👑 void QwtLegend::setDisplayPolicy (LegendDisplayPolicypolicy, intmode)

Set the legend display policy to:

Parameters:

• policy — Legend display policy
• mode — Identifier mode (or'd ShowLine, ShowSymbol, ShowText)

See also: displayPolicy(), LegendDisplayPolicy

🎀 void QwtLegend::setItemMode (LegendItemModemode)

See also: LegendItemMode

💫 QScrollBar * QwtLegend::verticalScrollBar () const

Returns: Vertical scrollbar

See also: horizontalScrollBar()

---

🌟 Author 🌟

Generated automatically by Doxygen for Qwt User's Guide from the source code.

---

okay and that's the whole page, bestie!! 🥳 thanks for reading all the way through, you ate that fr fr 💅✨ this was Version 5.2.3, dated Tue Nov 20 2012 — yeah she's vintage, she's a classic, we stan an elder icon 👑🦋 byeeee 🫶