QwtPolarItemDict.3 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. .TH "QwtPolarItemDict" 3 "Fri Sep 19 2014" "Version 1.1.1" "Qwt Polar User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPolarItemDict \-
  6. .PP
  7. A dictionary for polar plot items\&.
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. .PP
  12. \fC#include <qwt_polar_itemdict\&.h>\fP
  13. .PP
  14. Inherited by \fBQwtPolarPlot\fP\&.
  15. .SS "Public Member Functions"
  16. .in +1c
  17. .ti -1c
  18. .RI "\fBQwtPolarItemDict\fP ()"
  19. .br
  20. .ti -1c
  21. .RI "\fB~QwtPolarItemDict\fP ()"
  22. .br
  23. .ti -1c
  24. .RI "void \fBsetAutoDelete\fP (bool)"
  25. .br
  26. .ti -1c
  27. .RI "bool \fBautoDelete\fP () const "
  28. .br
  29. .ti -1c
  30. .RI "const QwtPolarItemList & \fBitemList\fP () const "
  31. .br
  32. .RI "\fIA QwtPolarItemList of all attached plot items\&. \fP"
  33. .ti -1c
  34. .RI "void \fBdetachItems\fP (int rtti=\fBQwtPolarItem::Rtti_PolarItem\fP, bool \fBautoDelete\fP=true)"
  35. .br
  36. .in -1c
  37. .SS "Protected Member Functions"
  38. .in +1c
  39. .ti -1c
  40. .RI "void \fBinsertItem\fP (\fBQwtPolarItem\fP *)"
  41. .br
  42. .ti -1c
  43. .RI "void \fBremoveItem\fP (\fBQwtPolarItem\fP *)"
  44. .br
  45. .in -1c
  46. .SH "Detailed Description"
  47. .PP
  48. A dictionary for polar plot items\&.
  49. \fBQwtPolarItemDict\fP organizes polar plot items in increasing z-order\&. If \fBautoDelete()\fP is enabled, all attached items will be deleted in the destructor of the dictionary\&.
  50. .PP
  51. \fBSee Also:\fP
  52. .RS 4
  53. \fBQwtPolarItem::attach()\fP, \fBQwtPolarItem::detach()\fP, \fBQwtPolarItem::z()\fP
  54. .RE
  55. .PP
  56. .SH "Constructor & Destructor Documentation"
  57. .PP
  58. .SS "QwtPolarItemDict::QwtPolarItemDict ()\fC [explicit]\fP"
  59. Constructor
  60. .PP
  61. Auto deletion is enabled\&.
  62. .PP
  63. \fBSee Also:\fP
  64. .RS 4
  65. \fBsetAutoDelete\fP, attachItem
  66. .RE
  67. .PP
  68. .SS "QwtPolarItemDict::~QwtPolarItemDict ()"
  69. Destructor
  70. .PP
  71. If autoDelete is on, all attached items will be deleted
  72. .PP
  73. \fBSee Also:\fP
  74. .RS 4
  75. \fBsetAutoDelete\fP, \fBautoDelete\fP, attachItem
  76. .RE
  77. .PP
  78. .SH "Member Function Documentation"
  79. .PP
  80. .SS "bool QwtPolarItemDict::autoDelete () const"
  81. .PP
  82. \fBReturns:\fP
  83. .RS 4
  84. true if auto deletion is enabled
  85. .RE
  86. .PP
  87. \fBSee Also:\fP
  88. .RS 4
  89. \fBsetAutoDelete\fP, attachItem
  90. .RE
  91. .PP
  92. .SS "void QwtPolarItemDict::detachItems (intrtti = \fC\fBQwtPolarItem::Rtti_PolarItem\fP\fP, boolautoDelete = \fCtrue\fP)"
  93. Detach items from the dictionary
  94. .PP
  95. \fBParameters:\fP
  96. .RS 4
  97. \fIrtti\fP In case of QwtPolarItem::Rtti_PlotItem detach all items otherwise only those items of the type rtti\&.
  98. .br
  99. \fIautoDelete\fP If true, delete all detached items
  100. .RE
  101. .PP
  102. .SS "void QwtPolarItemDict::insertItem (\fBQwtPolarItem\fP *item)\fC [protected]\fP"
  103. Insert a plot item
  104. .PP
  105. \fBParameters:\fP
  106. .RS 4
  107. \fIitem\fP PlotItem
  108. .RE
  109. .PP
  110. \fBSee Also:\fP
  111. .RS 4
  112. \fBremoveItem()\fP
  113. .RE
  114. .PP
  115. .SS "const QwtPolarItemList & QwtPolarItemDict::itemList () const"
  116. .PP
  117. A QwtPolarItemList of all attached plot items\&.
  118. .PP
  119. \fBReturns:\fP
  120. .RS 4
  121. List of all attached plot items\&.
  122. .RE
  123. .PP
  124. \fBNote:\fP
  125. .RS 4
  126. Use caution when iterating these lists, as removing/detaching an item will invalidate the iterator\&. Instead you can place pointers to objects to be removed in a removal list, and traverse that list later\&.
  127. .RE
  128. .PP
  129. .SS "void QwtPolarItemDict::removeItem (\fBQwtPolarItem\fP *item)\fC [protected]\fP"
  130. Remove a plot item
  131. .PP
  132. \fBParameters:\fP
  133. .RS 4
  134. \fIitem\fP PlotItem
  135. .RE
  136. .PP
  137. \fBSee Also:\fP
  138. .RS 4
  139. \fBinsertItem()\fP
  140. .RE
  141. .PP
  142. .SS "void QwtPolarItemDict::setAutoDelete (boolautoDelete)"
  143. En/Disable Auto deletion
  144. .PP
  145. If Auto deletion is on all attached plot items will be deleted in the destructor of \fBQwtPolarItemDict\fP\&. The default value is on\&.
  146. .PP
  147. \fBSee Also:\fP
  148. .RS 4
  149. \fBautoDelete\fP, attachItem
  150. .RE
  151. .PP
  152. .SH "Author"
  153. .PP
  154. Generated automatically by Doxygen for Qwt Polar User's Guide from the source code\&.