Scroll to navigation

QwtLegend(3) Qwt User's Guide QwtLegend(3)

NAME

QwtLegend -
The legend widget.

SYNOPSIS

#include <qwt_legend.h>

Public Types


enum LegendItemMode { ReadOnlyItem, ClickableItem, CheckableItem }
 

Public Member Functions


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

Protected Member Functions


virtual void layoutContents ()
 

Detailed Description

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

Member Enumeration Documentation

enum QwtLegend::LegendItemMode

Interaction mode for the legend items. The default is QwtLegend::ReadOnlyItem.
See also:
setItemMode(), itemMode(), QwtLegendItem::IdentifierMode QwtLegendItem::clicked(), QwtLegendItem::checked(), QwtPlot::legendClicked(), QwtPlot::legendChecked()
Enumerator:
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.

Constructor & Destructor Documentation

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

Parameters:
parent Parent widget

QwtLegend::~QwtLegend () [virtual]

Destructor.

Member Function Documentation

void QwtLegend::clear ()

Remove all items.

QWidget * QwtLegend::contentsWidget () The contents widget is the only child of the viewport of the internal QScrollArea and the parent widget of all legend items.

Returns:
Container widget of the legend items

const QWidget * QwtLegend::contentsWidget () const The contents widget is the only child of the viewport of the internal QScrollArea and the parent widget of all legend items.

Returns:
Container widget of the legend items

bool QwtLegend::eventFilter (QObject *object, QEvent *event) [virtual] Handle QEvent::ChildRemoved andQEvent::LayoutRequest events for the contentsWidget().

Parameters:
object Object to be filtered
 
event Event

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

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

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

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

bool QwtLegend::isEmpty () const

Return true, if there are no legend items.

uint QwtLegend::itemCount () const

Return the number of legend items.

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

QList< QWidget * > QwtLegend::legendItems () const [virtual]

Return a list of all legend items.

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::setItemMode ( LegendItemModemode) See also:

LegendItemMode

QSize QwtLegend::sizeHint () const [virtual]

Return a size hint.

QScrollBar * QwtLegend::verticalScrollBar () const Returns:

Vertical scrollbar
See also:
horizontalScrollBar()

Author

Generated automatically by Doxygen for Qwt User's Guide from the source code.
Fri Apr 15 2011 Version 6.0.0