QwtAbstractLegend.3 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. .TH "QwtAbstractLegend" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtAbstractLegend \- Abstract base class for legend widgets\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_abstract_legend\&.h>\fP
  11. .PP
  12. Inherits QFrame\&.
  13. .PP
  14. Inherited by \fBQwtLegend\fP\&.
  15. .SS "Public Slots"
  16. .in +1c
  17. .ti -1c
  18. .RI "virtual void \fBupdateLegend\fP (const QVariant &itemInfo, const QList< \fBQwtLegendData\fP > &data)=0"
  19. .br
  20. .RI "Update the entries for a plot item\&. "
  21. .in -1c
  22. .SS "Public Member Functions"
  23. .in +1c
  24. .ti -1c
  25. .RI "\fBQwtAbstractLegend\fP (QWidget *parent=NULL)"
  26. .br
  27. .ti -1c
  28. .RI "virtual \fB~QwtAbstractLegend\fP ()"
  29. .br
  30. .RI "Destructor\&. "
  31. .ti -1c
  32. .RI "virtual void \fBrenderLegend\fP (QPainter *painter, const QRectF &rect, bool fillBackground) const =0"
  33. .br
  34. .ti -1c
  35. .RI "virtual bool \fBisEmpty\fP () const =0"
  36. .br
  37. .ti -1c
  38. .RI "virtual int \fBscrollExtent\fP (Qt::Orientation) const"
  39. .br
  40. .in -1c
  41. .SH "Detailed Description"
  42. .PP
  43. Abstract base class for legend widgets\&.
  44. Legends, that need to be under control of the \fBQwtPlot\fP layout system need to be derived from \fBQwtAbstractLegend\fP\&.
  45. .PP
  46. \fBNote\fP
  47. .RS 4
  48. Other type of legends can be implemented by connecting to the \fBQwtPlot::legendDataChanged()\fP signal\&. But as these legends are unknown to the plot layout system the layout code ( on screen and for \fBQwtPlotRenderer\fP ) need to be organized in application code\&.
  49. .RE
  50. .PP
  51. \fBSee also\fP
  52. .RS 4
  53. \fBQwtLegend\fP
  54. .RE
  55. .PP
  56. .SH "Constructor & Destructor Documentation"
  57. .PP
  58. .SS "QwtAbstractLegend::QwtAbstractLegend (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
  59. Constructor
  60. .PP
  61. \fBParameters\fP
  62. .RS 4
  63. \fIparent\fP Parent widget
  64. .RE
  65. .PP
  66. .SH "Member Function Documentation"
  67. .PP
  68. .SS "virtual bool QwtAbstractLegend::isEmpty () const\fC [pure virtual]\fP"
  69. .PP
  70. \fBReturns\fP
  71. .RS 4
  72. True, when no plot item is inserted
  73. .RE
  74. .PP
  75. .PP
  76. Implemented in \fBQwtLegend\fP\&.
  77. .SS "virtual void QwtAbstractLegend::renderLegend (QPainter * painter, const QRectF & rect, bool fillBackground) const\fC [pure virtual]\fP"
  78. Render the legend into a given rectangle\&.
  79. .PP
  80. \fBParameters\fP
  81. .RS 4
  82. \fIpainter\fP Painter
  83. .br
  84. \fIrect\fP Bounding rectangle
  85. .br
  86. \fIfillBackground\fP When true, fill rect with the widget background
  87. .RE
  88. .PP
  89. \fBSee also\fP
  90. .RS 4
  91. \fBrenderLegend()\fP is used by \fBQwtPlotRenderer\fP
  92. .RE
  93. .PP
  94. .PP
  95. Implemented in \fBQwtLegend\fP\&.
  96. .SS "int QwtAbstractLegend::scrollExtent (Qt::Orientation orientation) const\fC [virtual]\fP"
  97. Return the extent, that is needed for elements to scroll the legend ( usually scrollbars ),
  98. .PP
  99. \fBParameters\fP
  100. .RS 4
  101. \fIorientation\fP Orientation
  102. .RE
  103. .PP
  104. \fBReturns\fP
  105. .RS 4
  106. Extent of the corresponding scroll element
  107. .RE
  108. .PP
  109. .PP
  110. Reimplemented in \fBQwtLegend\fP\&.
  111. .SS "virtual void QwtAbstractLegend::updateLegend (const QVariant & itemInfo, const QList< \fBQwtLegendData\fP > & data)\fC [pure virtual]\fP, \fC [slot]\fP"
  112. .PP
  113. Update the entries for a plot item\&.
  114. .PP
  115. \fBParameters\fP
  116. .RS 4
  117. \fIitemInfo\fP Info about an item
  118. .br
  119. \fIdata\fP List of legend entry attributes for the item
  120. .RE
  121. .PP
  122. .SH "Author"
  123. .PP
  124. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.