DOKK / manpages / debian 10 / libqwt5-doc / QwtLegend.3.en
QwtLegend(3) Qwt User's Guide QwtLegend(3)

QwtLegend -

#include <qwt_legend.h>


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


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


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

The legend widget.

The QwtLegend widget is a tabular arrangement of legend items. Legend items might be any type of widget, but in general they will be a QwtLegendItem.

See also:

QwtLegendItem, QwtLegendItemManager QwtPlot

enum QwtLegend::LegendDisplayPolicy

Display policy. .IP "•" 2 NoIdentifier
The client code is responsible how to display of each legend item. The Qwt library will not interfere.

  • 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.

See also:

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

enum QwtLegend::LegendItemMode

Interaction mode for the legend items. .IP "•" 2 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.

See also:

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

Constructor

Parameters:

parent Parent widget

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

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

QwtLegend::LegendDisplayPolicy QwtLegend::displayPolicy () const

Returns:

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

See also:

setDisplayPolicy(), LegendDisplayPolicy

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

Parameters:

o Object to be filtered
e Event

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

Returns:

The preferred height, for the width w.

Parameters:

width Width

Returns:

Horizontal scrollbar

See also:

verticalScrollBar()

Returns:

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

Default is ShowLine | ShowSymbol | ShowText.

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()

QwtLegend::LegendItemMode QwtLegend::itemMode () const

See also:

LegendItemMode

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

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

Parameters:

plotItem Plot item

Resize event

Parameters:

e Resize event

Set the legend display policy to:

Parameters:

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

See also:

displayPolicy(), LegendDisplayPolicy

See also:

LegendItemMode

Returns:

Vertical scrollbar

See also:

horizontalScrollBar()

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

Tue Nov 20 2012 Version 5.2.3