The legend widget. More...

#include <qwt_legend.h>

Inheritance diagram for QwtLegend:

Classes
class	PrivateData
Public Slots
virtual void	updateLegend (const QVariant &, const QList< QwtLegendData > &)
	Update the entries for an item.
Signals
void	checked (const QVariant &itemInfo, bool on, int index)
void	clicked (const QVariant &itemInfo, int index)
Public Member Functions
QWidget *	contentsWidget ()
const QWidget *	contentsWidget () const
QwtLegendData::Mode	defaultItemMode () const
virtual bool	eventFilter (QObject , QEvent )
virtual int	heightForWidth (int w) const
QScrollBar *	horizontalScrollBar () const
virtual bool	isEmpty () const
QVariant	itemInfo (const QWidget *) const
QWidget *	legendWidget (const QVariant &) const
QList< QWidget * >	legendWidgets (const QVariant &) const
uint	maxColumns () const
	QwtLegend (QWidget *parent=NULL)
virtual void	renderItem (QPainter , const QWidget , const QRectF &, bool fillBackground) const
virtual void	renderLegend (QPainter *, const QRectF &, bool fillBackground) const
virtual int	scrollExtent (Qt::Orientation) const
void	setDefaultItemMode (QwtLegendData::Mode)
	Set the default mode for legend labels.
void	setMaxColumns (uint numColums)
	Set the maximum number of entries in a row.
virtual QSize	sizeHint () const
	Return a size hint.
QScrollBar *	verticalScrollBar () const
virtual	~QwtLegend ()
	Destructor.
Protected Slots
void	itemChecked (bool)
void	itemClicked ()
Protected Member Functions
virtual QWidget *	createWidget (const QwtLegendData &) const
	Create a widget to be inserted into the legend.
virtual void	updateWidget (QWidget *widget, const QwtLegendData &data)
	Update the widget.
Private Member Functions
void	updateTabOrder ()
Private Attributes
PrivateData *	d_data

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

See also:: QwtLegendLabel, QwtPlotItem, QwtPlot

Definition at line 29 of file qwt_legend.h.

Constructor & Destructor Documentation

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

Constructor

Parameters:

parent Parent widget

Definition at line 254 of file qwt_legend.cpp.

QwtLegend::~QwtLegend ( ) [virtual]

Destructor.

Definition at line 277 of file qwt_legend.cpp.

Member Function Documentation

void QwtLegend::checked	(	const QVariant &	itemInfo,
		bool	on,
		int	index
	)		`[signal]`

A signal which is emitted when the user has clicked on a legend label, which is in QwtLegendData::Checkable mode

Parameters:

itemInfo	Info for the item of the selected legend label
index	Index of the legend label in the list of widgets that are associated with the plot item
on	True when the legend label is checked

Note:: clicks are disabled as default

See also:: setDefaultItemMode(), defaultItemMode(), QwtPlot::itemToInfo()

void QwtLegend::clicked	(	const QVariant &	itemInfo,
		int	index
	)		`[signal]`

A signal which is emitted when the user has clicked on a legend label, which is in QwtLegendData::Clickable mode.

Parameters:

itemInfo	Info for the item item of the selected legend item
index	Index of the legend label in the list of widgets that are associated with the plot item

Note:: clicks are disabled as default

See also:: setDefaultItemMode(), defaultItemMode(), QwtPlot::itemToInfo()

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

Definition at line 349 of file qwt_legend.cpp.

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

Definition at line 379 of file qwt_legend.cpp.

QWidget * QwtLegend::createWidget ( const QwtLegendData & data ) const [protected, virtual]

Create a widget to be inserted into the legend.

The default implementation returns a QwtLegendLabel.

Parameters:

data	Attributes of the legend entry

Returns:: Widget representing data on the legend

Note:: updateWidget() will called soon after createWidget() with the same attributes.

Definition at line 463 of file qwt_legend.cpp.

QwtLegendData::Mode QwtLegend::defaultItemMode ( ) const

Returns:: Default item mode

See also:: setDefaultItemMode()

Definition at line 338 of file qwt_legend.cpp.

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

Returns:: Forwarded to QwtAbstractLegend::eventFilter()

Definition at line 555 of file qwt_legend.cpp.

int QwtLegend::heightForWidth ( int width ) const [virtual]

Returns:: The preferred height, for a width.

Parameters:

width Width

Definition at line 534 of file qwt_legend.cpp.

QScrollBar * QwtLegend::horizontalScrollBar ( ) const

Returns:: Horizontal scrollbar

See also:: verticalScrollBar()

Definition at line 358 of file qwt_legend.cpp.

bool QwtLegend::isEmpty ( ) const [virtual]

Returns:: True, when no item is inserted

Implements QwtAbstractLegend.

Definition at line 793 of file qwt_legend.cpp.

void QwtLegend::itemChecked ( bool on ) [protected, slot]

Called internally when the legend has been checked Emits a checked() signal.

Definition at line 628 of file qwt_legend.cpp.

void QwtLegend::itemClicked ( ) [protected, slot]

Called internally when the legend has been clicked on. Emits a clicked() signal.

Definition at line 606 of file qwt_legend.cpp.

QVariant QwtLegend::itemInfo ( const QWidget * widget ) const

Find the item that is associated to a widget

Parameters:

widget Widget on the legend

Returns:: Associated item info

See also:: legendWidget()

Definition at line 787 of file qwt_legend.cpp.

QWidget * QwtLegend::legendWidget ( const QVariant & itemInfo ) const

Returns:: First widget in the list of widgets associated to an item

Parameters:

itemInfo Info about an item

See also:: itemInfo(), QwtPlot::itemToInfo()

Note:: Almost all types of items have only one widget

Definition at line 771 of file qwt_legend.cpp.

QList< QWidget * > QwtLegend::legendWidgets ( const QVariant & itemInfo ) const

Returns:: List of widgets associated to a item

Parameters:

itemInfo Info about an item

See also:: legendWidget(), itemInfo(), QwtPlot::itemToInfo()

Definition at line 760 of file qwt_legend.cpp.

uint QwtLegend::maxColumns ( ) const

Returns:: Maximum number of entries in a row

See also:: setMaxColumns(), QwtDynGridLayout::maxColumns()

Definition at line 304 of file qwt_legend.cpp.

void QwtLegend::renderItem	(	QPainter *	painter,
		const QWidget *	widget,
		const QRectF &	rect,
		bool	fillBackground
	)		const `[virtual]`

Render a legend entry into a given rectangle.

Parameters:

painter	Painter
widget	Widget representing a legend entry
rect	Bounding rectangle
fillBackground	When true, fill rect with the widget background

Note:: When widget is not derived from QwtLegendLabel renderItem does nothing beside the background

Definition at line 718 of file qwt_legend.cpp.

void QwtLegend::renderLegend	(	QPainter *	painter,
		const QRectF &	rect,
		bool	fillBackground
	)		const `[virtual]`

Render the legend into a given rectangle.

Parameters:

painter	Painter
rect	Bounding rectangle
fillBackground	When true, fill rect with the widget background

See also:: renderLegend() is used by QwtPlotRenderer - not by QwtLegend itself

Implements QwtAbstractLegend.

Definition at line 655 of file qwt_legend.cpp.

int QwtLegend::scrollExtent ( Qt::Orientation orientation ) const [virtual]

Return the extent, that is needed for the scrollbars

Parameters:

orientation Orientation (

Returns:: The width of the vertical scrollbar for Qt::Horizontal and v.v.

Reimplemented from QwtAbstractLegend.

Definition at line 804 of file qwt_legend.cpp.

void QwtLegend::setDefaultItemMode ( QwtLegendData::Mode mode )

Set the default mode for legend labels.

Legend labels will be constructed according to the attributes in a QwtLegendData object. When it doesn't contain a value for the QwtLegendData::ModeRole the label will be initialized with the default mode of the legend.

Parameters:

mode	Default item mode

See also:: itemMode(), QwtLegendData::value(), QwtPlotItem::legendData()

Note:: Changing the mode doesn't have any effect on existing labels.

Definition at line 329 of file qwt_legend.cpp.

void QwtLegend::setMaxColumns ( uint numColums )

Set the maximum number of entries in a row.

F.e when the maximum is set to 1 all items are aligned vertically. 0 means unlimited

Parameters:

numColums Maximum number of entries in a row

See also:: maxColumns(), QwtDynGridLayout::setMaxColumns()

Definition at line 292 of file qwt_legend.cpp.

QSize QwtLegend::sizeHint ( ) const [virtual]

Return a size hint.

Definition at line 522 of file qwt_legend.cpp.

void QwtLegend::updateLegend	(	const QVariant &	itemInfo,
		const QList< QwtLegendData > &	data
	)		`[virtual, slot]`

Update the entries for an item.

Parameters:

itemInfo	Info for an item
data	List of legend entry attributes for the item

Implements QwtAbstractLegend.

Definition at line 390 of file qwt_legend.cpp.

void QwtLegend::updateTabOrder ( ) [private]

Definition at line 501 of file qwt_legend.cpp.

void QwtLegend::updateWidget	(	QWidget *	widget,
		const QwtLegendData &	data
	)		`[protected, virtual]`

Update the widget.

Parameters:

widget	Usually a QwtLegendLabel
data	Attributes to be displayed

See also:: createWidget()

Note:: When widget is no QwtLegendLabel updateWidget() does nothing.

Definition at line 485 of file qwt_legend.cpp.

QScrollBar * QwtLegend::verticalScrollBar ( ) const

Returns:: Vertical scrollbar

See also:: horizontalScrollBar()

Definition at line 367 of file qwt_legend.cpp.

Member Data Documentation

PrivateData* QwtLegend::d_data [private]

Definition at line 113 of file qwt_legend.h.

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

Classes

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation