qwtlegend.3

linux下qt的第三方的一个类

.TH "QwtLegend" 3 "16 Nov 2004" "Version 4.2.0" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtLegend \- 
.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 
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 \fBQwtLegendButton\fP.
.PP
\fBSee also:\fP
.RS 4
\fBQwtLegendButton\fP, \fBQwtPlot\fP 
.RE
.PP

.PP
Definition at line 158 of file qwt_legend.h.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBLegendDisplayPolicy\fP { \fBNone\fP =  0, \fBFixed\fP =  1, \fBAuto\fP =  2 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtLegend\fP (QWidget *parent=0, const char *name=0)"
.br
.ti -1c
.RI "void \fBsetReadOnly\fP (bool readOnly)"
.br
.ti -1c
.RI "bool \fBisReadOnly\fP () const"
.br
.ti -1c
.RI "void \fBsetDisplayPolicy\fP (\fBLegendDisplayPolicy\fP policy, int mode=-1)"
.br
.ti -1c
.RI "\fBLegendDisplayPolicy\fP \fBdisplayPolicy\fP () const"
.br
.ti -1c
.RI "int \fBidentifierMode\fP () const"
.br
.ti -1c
.RI "QWidget * \fBcontentsWidget\fP ()"
.br
.ti -1c
.RI "const QWidget * \fBcontentsWidget\fP () const"
.br
.ti -1c
.RI "void \fBinsertItem\fP (QWidget *, long key)"
.br
.ti -1c
.RI "QWidget * \fBfindItem\fP (long key)"
.br
.ti -1c
.RI "const QWidget * \fBfindItem\fP (long key) const"
.br
.ti -1c
.RI "QWidget * \fBtakeItem\fP (long key)"
.br
.ti -1c
.RI "virtual QWidgetIntDictIt \fBitemIterator\fP () const"
.br
.ti -1c
.RI "long \fBkey\fP (const QWidget *) const"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "bool \fBisEmpty\fP () const"
.br
.ti -1c
.RI "uint \fBitemCount\fP () const"
.br
.ti -1c
.RI "virtual bool \fBeventFilter\fP (QObject *, QEvent *)"
.br
.ti -1c
.RI "virtual QSize \fBsizeHint\fP () const"
.br
.ti -1c
.RI "virtual int \fBheightForWidth\fP (int w) const"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBviewportResizeEvent\fP (QResizeEvent *)"
.br
.ti -1c
.RI "virtual void \fBlayoutContents\fP ()"
.br
.in -1c
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtLegend::LegendDisplayPolicy\fP"
.PP
Display policy. 
.PP
.IP "\(bu" 2
None
.br
 the client code is responsible how to display of each legend item. The Qwt library will not interfere.
.PP
.PP
.IP "\(bu" 2
Fixed
.br
 all legend items are displayed with the \fBQwtLegendItem::IdentifierMode\fP to be passed in 'mode'.
.PP
.PP
.IP "\(bu" 2
Auto
.br
 each legend item is displayed with a mode that is a bitwise or of
.IP "  \(bu" 4
QwtLegendItem::ShowLine (if its curve is drawn with a line) and
.IP "  \(bu" 4
QwtLegendItem::ShowSymbol (if its curve is drawn with symbols) and
.IP "  \(bu" 4
QwtLegendItem::ShowText (if the has a title).
.PP

.PP
.PP
Default is LegendDisplayPolicy::Auto. 
.PP
\fBSee also:\fP
.RS 4
\fBQwtLegend::setDisplayPolicy\fP, \fBQwtLegend::displayPolicy\fP, \fBQwtLegendItem::IdentifierMode\fP 
.RE
.PP
Definition at line 187 of file qwt_legend.h.
.PP
Referenced by displayPolicy().
.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtLegend::QwtLegend (QWidget * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP Parent widget 
.br
\fIname\fP Widget name 
.RE
.PP
Definition at line 388 of file qwt_legend.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void QwtLegend::clear ()"
.PP
Remove all items. 
.PP
Definition at line 565 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::clear(), QwtPlot::enableLegend(), and QwtPlot::removeCurves().
.SS "const QWidget * QwtLegend::contentsWidget () const"
.PP
The contents widget is the only child of the viewport() and the parent widget of all legend items. Definition at line 481 of file qwt_legend.cpp.
.SS "QWidget * QwtLegend::contentsWidget ()"
.PP
The contents widget is the only child of the viewport() and the parent widget of all legend items. Definition at line 471 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::insertLegendItem(), QwtPlot::printLegend(), QwtPlot::setLegendPosition(), and QwtPlot::updateTabOrder().
.SS "\fBQwtLegend::LegendDisplayPolicy\fP QwtLegend::displayPolicy () const"
.PP
\fBReturns:\fP
.RS 4
the legend display policy. Default is LegendDisplayPolicy::Auto. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtLegend::setDisplayPolicy\fP, \fBQwtLegend::LegendDisplayPolicy\fP 
.RE
.PP
Definition at line 450 of file qwt_legend.cpp.
.PP
References LegendDisplayPolicy.
.PP
Referenced by QwtPlot::updateLegendItem().
.SS "bool QwtLegend::eventFilter (QObject *, QEvent *)\fC [virtual]\fP"
.PP
Event filter. 
.PP
Definition at line 662 of file qwt_legend.cpp.
.PP
References key(), layoutContents(), and takeItem().
.SS "const QWidget * QwtLegend::findItem (long key) const"
.PP
Find the item for a given key. 
.PP
Definition at line 537 of file qwt_legend.cpp.
.SS "QWidget * QwtLegend::findItem (long key)"
.PP
Find the item for a given key. 
.PP
Definition at line 531 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::enableLegend(), QwtPlot::legendEnabled(), QwtPlot::removeCurve(), and QwtPlot::updateLegendItem().
.SS "int QwtLegend::heightForWidth (int w) const\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
The preferred height, for the width w. 
.RE
.PP
Definition at line 608 of file qwt_legend.cpp.
.PP
Referenced by QwtPlotLayout::minimumSizeHint().
.SS "int QwtLegend::identifierMode () const"
.PP
\fBReturns:\fP
.RS 4
the IdentifierMode to be used in combination with LegendDisplayPolicy::Fixed.
.RE
.PP
Default is ShowLine | ShowSymbol | ShowText. Definition at line 462 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::updateLegendItem().
.SS "void QwtLegend::insertItem (QWidget * item, long key)"
.PP
Insert a new item for a specific key. 
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP New legend item 
.br
\fIkey\fP Unique key. Key must be >= 0. 
.RE
.PP
\fBNote:\fP
.RS 4
The parent of item will be changed to \fBQwtLegend::contentsWidget()\fP 
.PP
In case of key < 0, nothing will be inserted. 
.RE
.PP
Definition at line 493 of file qwt_legend.cpp.
.PP
References layoutContents().
.PP
Referenced by QwtPlot::insertLegendItem().
.SS "bool QwtLegend::isEmpty () const"
.PP
Return TRUE, if there are no legend items. 
.PP
Definition at line 239 of file qwt_legend.h.
.PP
Referenced by QwtPlotLayout::activate(), QwtPlotLayout::minimumSizeHint(), QwtPlot::print(), and QwtPlot::printLegend().
.SS "bool QwtLegend::isReadOnly () const"
.PP
A mode telling \fBQwtPlot\fP to insert read only items 
.PP
\fBSee also:\fP
.RS 4
\fBsetReadOnly\fP 
.RE
.PP
Definition at line 424 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::insertLegendItem().
.SS "uint QwtLegend::itemCount () const"
.PP
Return the number of legend items. 
.PP
Definition at line 245 of file qwt_legend.h.
.PP
Referenced by QwtPlot::enableLegend(), and QwtPlot::updateLayout().
.SS "QWidgetIntDictIt QwtLegend::itemIterator () const\fC [virtual]\fP"
.PP
Return an item iterator. 
.PP
Definition at line 591 of file qwt_legend.cpp.
.PP
Referenced by QwtPlotPrintFilter::apply(), and QwtPlotPrintFilter::reset().
.SS "long QwtLegend::key (const QWidget * item) const"
.PP
Return the key of an legend item. 
.PP
\fBParameters:\fP
.RS 4
\fIitem\fP Legend item 
.RE
.PP
\fBReturns:\fP
.RS 4
key of the item, or -1 if the item can't be found. 
.RE
.PP
Definition at line 553 of file qwt_legend.cpp.
.PP
Referenced by eventFilter(), and QwtPlot::lgdClicked().
.SS "void QwtLegend::layoutContents ()\fC [protected, virtual]\fP"
.PP
Adjust contents widget and item layout to the size of the viewport(). Definition at line 629 of file qwt_legend.cpp.
.PP
References QwtDynGridLayout::heightForWidth(), and QwtDynGridLayout::maxItemWidth().
.PP
Referenced by eventFilter(), and insertItem().
.SS "void QwtLegend::setDisplayPolicy (\fBLegendDisplayPolicy\fP policy, int mode = \fC-1\fP)"
.PP
Set the legend display policy to:
.PP
\fBParameters:\fP
.RS 4
\fIpolicy\fP Legend display policy 
.br
\fImode\fP Identifier mode (or'd ShowLine, ShowSymbol, ShowText)
.RE
.PP
\fBSee also:\fP
.RS 4
\fBQwtLegend::displayPolicy\fP, \fBQwtLegend::LegendDisplayPolicy\fP 
.RE
.PP
Definition at line 437 of file qwt_legend.cpp.
.PP
Referenced by QwtPlot::setLegendDisplayPolicy().
.SS "void QwtLegend::setReadOnly (bool readOnly)"
.PP
A mode telling \fBQwtPlot\fP to insert read only items 
.PP
\fBSee also:\fP
.RS 4
\fBisReadOnly\fP 
.RE
.PP
Definition at line 415 of file qwt_legend.cpp.
.SS "QSize QwtLegend::sizeHint () const\fC [virtual]\fP"
.PP
Return a size hint. 
.PP
Definition at line 597 of file qwt_legend.cpp.
.PP
Referenced by QwtPlotLayout::minimumSizeHint().
.SS "QWidget * QwtLegend::takeItem (long key)"
.PP
Find the item for a given key and remove it from the item list. 
.PP
Definition at line 543 of file qwt_legend.cpp.
.PP
Referenced by eventFilter().
.SS "void QwtLegend::viewportResizeEvent (QResizeEvent * e)\fC [protected, virtual]\fP"
.PP
Resize the viewport() and post a QEvent::LayoutHint to \fBQwtLegend::contentsWidget()\fP to update the layout. Definition at line 692 of file qwt_legend.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code.