QwtPlotZoneItem.3 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  1. .TH "QwtPlotZoneItem" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPlotZoneItem \- A plot item, which displays a zone\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_plot_zoneitem\&.h>\fP
  11. .PP
  12. Inherits \fBQwtPlotItem\fP\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBQwtPlotZoneItem\fP ()"
  17. .br
  18. .RI "Constructor\&. "
  19. .ti -1c
  20. .RI "virtual \fB~QwtPlotZoneItem\fP ()"
  21. .br
  22. .RI "Destructor\&. "
  23. .ti -1c
  24. .RI "virtual int \fBrtti\fP () const"
  25. .br
  26. .ti -1c
  27. .RI "void \fBsetOrientation\fP (Qt::Orientation)"
  28. .br
  29. .RI "Set the orientation of the zone\&. "
  30. .ti -1c
  31. .RI "Qt::Orientation \fBorientation\fP ()"
  32. .br
  33. .ti -1c
  34. .RI "void \fBsetInterval\fP (double min, double max)"
  35. .br
  36. .ti -1c
  37. .RI "void \fBsetInterval\fP (const \fBQwtInterval\fP &)"
  38. .br
  39. .ti -1c
  40. .RI "\fBQwtInterval\fP \fBinterval\fP () const"
  41. .br
  42. .ti -1c
  43. .RI "void \fBsetPen\fP (const QColor &, qreal width=0\&.0, Qt::PenStyle=Qt::SolidLine)"
  44. .br
  45. .ti -1c
  46. .RI "void \fBsetPen\fP (const QPen &)"
  47. .br
  48. .RI "Assign a pen\&. "
  49. .ti -1c
  50. .RI "const QPen & \fBpen\fP () const"
  51. .br
  52. .ti -1c
  53. .RI "void \fBsetBrush\fP (const QBrush &)"
  54. .br
  55. .RI "Assign a brush\&. "
  56. .ti -1c
  57. .RI "const QBrush & \fBbrush\fP () const"
  58. .br
  59. .ti -1c
  60. .RI "virtual void \fBdraw\fP (QPainter *, const \fBQwtScaleMap\fP &, const \fBQwtScaleMap\fP &, const QRectF &) const"
  61. .br
  62. .ti -1c
  63. .RI "virtual QRectF \fBboundingRect\fP () const"
  64. .br
  65. .in -1c
  66. .SS "Additional Inherited Members"
  67. .SH "Detailed Description"
  68. .PP
  69. A plot item, which displays a zone\&.
  70. A horizontal zone highlights an interval of the y axis - a vertical zone an interval of the x axis - and is unbounded in the opposite direction\&. It is filled with a brush and its border lines are optionally displayed with a pen\&.
  71. .PP
  72. \fBNote\fP
  73. .RS 4
  74. For displaying an area that is bounded for x and y coordinates use \fBQwtPlotShapeItem\fP
  75. .RE
  76. .PP
  77. .SH "Constructor & Destructor Documentation"
  78. .PP
  79. .SS "QwtPlotZoneItem::QwtPlotZoneItem ()\fC [explicit]\fP"
  80. .PP
  81. Constructor\&. Initializes the zone with no pen and a semi transparent gray brush
  82. .PP
  83. Sets the following item attributes:
  84. .PP
  85. .IP "\(bu" 2
  86. \fBQwtPlotItem::AutoScale\fP: false
  87. .IP "\(bu" 2
  88. \fBQwtPlotItem::Legend\fP: false
  89. .PP
  90. .PP
  91. The z value is initialized by 5
  92. .PP
  93. \fBSee also\fP
  94. .RS 4
  95. \fBQwtPlotItem::setItemAttribute()\fP, \fBQwtPlotItem::setZ()\fP
  96. .RE
  97. .PP
  98. .SH "Member Function Documentation"
  99. .PP
  100. .SS "QRectF QwtPlotZoneItem::boundingRect () const\fC [virtual]\fP"
  101. The bounding rectangle is build from the interval in one direction and something invalid for the opposite direction\&.
  102. .PP
  103. \fBReturns\fP
  104. .RS 4
  105. An invalid rectangle with valid boundaries in one direction
  106. .RE
  107. .PP
  108. .PP
  109. Reimplemented from \fBQwtPlotItem\fP\&.
  110. .SS "const QBrush & QwtPlotZoneItem::brush () const"
  111. .PP
  112. \fBReturns\fP
  113. .RS 4
  114. Brush used to fill the zone
  115. .RE
  116. .PP
  117. \fBSee also\fP
  118. .RS 4
  119. \fBsetPen()\fP, \fBbrush()\fP
  120. .RE
  121. .PP
  122. .SS "void QwtPlotZoneItem::draw (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRectF & canvasRect) const\fC [virtual]\fP"
  123. Draw the zone
  124. .PP
  125. \fBParameters\fP
  126. .RS 4
  127. \fIpainter\fP Painter
  128. .br
  129. \fIxMap\fP x Scale Map
  130. .br
  131. \fIyMap\fP y Scale Map
  132. .br
  133. \fIcanvasRect\fP Contents rectangle of the canvas in painter coordinates
  134. .RE
  135. .PP
  136. .PP
  137. Implements \fBQwtPlotItem\fP\&.
  138. .SS "\fBQwtInterval\fP QwtPlotZoneItem::interval () const"
  139. .PP
  140. \fBReturns\fP
  141. .RS 4
  142. Zone interval
  143. .RE
  144. .PP
  145. \fBSee also\fP
  146. .RS 4
  147. \fBsetInterval()\fP, \fBorientation()\fP
  148. .RE
  149. .PP
  150. .SS "Qt::Orientation QwtPlotZoneItem::orientation ()"
  151. .PP
  152. \fBReturns\fP
  153. .RS 4
  154. Orientation of the zone
  155. .RE
  156. .PP
  157. \fBSee also\fP
  158. .RS 4
  159. \fBsetOrientation()\fP
  160. .RE
  161. .PP
  162. .SS "const QPen & QwtPlotZoneItem::pen () const"
  163. .PP
  164. \fBReturns\fP
  165. .RS 4
  166. Pen used to draw the border lines
  167. .RE
  168. .PP
  169. \fBSee also\fP
  170. .RS 4
  171. \fBsetPen()\fP, \fBbrush()\fP
  172. .RE
  173. .PP
  174. .SS "int QwtPlotZoneItem::rtti () const\fC [virtual]\fP"
  175. .PP
  176. \fBReturns\fP
  177. .RS 4
  178. \fBQwtPlotItem::Rtti_PlotZone\fP
  179. .RE
  180. .PP
  181. .PP
  182. Reimplemented from \fBQwtPlotItem\fP\&.
  183. .SS "void QwtPlotZoneItem::setBrush (const QBrush & brush)"
  184. .PP
  185. Assign a brush\&. The brush is used to fill the zone
  186. .PP
  187. \fBParameters\fP
  188. .RS 4
  189. \fIbrush\fP Brush
  190. .RE
  191. .PP
  192. \fBSee also\fP
  193. .RS 4
  194. \fBpen()\fP, \fBsetBrush()\fP
  195. .RE
  196. .PP
  197. .SS "void QwtPlotZoneItem::setInterval (const \fBQwtInterval\fP & interval)"
  198. Set the interval of the zone
  199. .PP
  200. For a horizontal zone the interval is related to the y axis, for a vertical zone it is related to the x axis\&.
  201. .PP
  202. \fBParameters\fP
  203. .RS 4
  204. \fIinterval\fP Zone interval
  205. .RE
  206. .PP
  207. \fBSee also\fP
  208. .RS 4
  209. \fBinterval()\fP, \fBsetOrientation()\fP
  210. .RE
  211. .PP
  212. .SS "void QwtPlotZoneItem::setInterval (double min, double max)"
  213. Set the interval of the zone
  214. .PP
  215. For a horizontal zone the interval is related to the y axis, for a vertical zone it is related to the x axis\&.
  216. .PP
  217. \fBParameters\fP
  218. .RS 4
  219. \fImin\fP Minimum of the interval
  220. .br
  221. \fImax\fP Maximum of the interval
  222. .RE
  223. .PP
  224. \fBSee also\fP
  225. .RS 4
  226. \fBinterval()\fP, \fBsetOrientation()\fP
  227. .RE
  228. .PP
  229. .SS "void QwtPlotZoneItem::setOrientation (Qt::Orientation orientation)"
  230. .PP
  231. Set the orientation of the zone\&. A horizontal zone highlights an interval of the y axis, a vertical zone of the x axis\&. It is unbounded in the opposite direction\&.
  232. .PP
  233. \fBSee also\fP
  234. .RS 4
  235. \fBorientation()\fP, \fBQwtPlotItem::setAxes()\fP
  236. .RE
  237. .PP
  238. .SS "void QwtPlotZoneItem::setPen (const QColor & color, qreal width = \fC0\&.0\fP, Qt::PenStyle style = \fCQt::SolidLine\fP)"
  239. Build and assign a pen
  240. .PP
  241. In Qt5 the default pen width is 1\&.0 ( 0\&.0 in Qt4 ) what makes it non cosmetic ( see QPen::isCosmetic() )\&. This method has been introduced to hide this incompatibility\&.
  242. .PP
  243. \fBParameters\fP
  244. .RS 4
  245. \fIcolor\fP Pen color
  246. .br
  247. \fIwidth\fP Pen width
  248. .br
  249. \fIstyle\fP Pen style
  250. .RE
  251. .PP
  252. \fBSee also\fP
  253. .RS 4
  254. \fBpen()\fP, \fBbrush()\fP
  255. .RE
  256. .PP
  257. .SS "void QwtPlotZoneItem::setPen (const QPen & pen)"
  258. .PP
  259. Assign a pen\&. The pen is used to draw the border lines of the zone
  260. .PP
  261. \fBParameters\fP
  262. .RS 4
  263. \fIpen\fP Pen
  264. .RE
  265. .PP
  266. \fBSee also\fP
  267. .RS 4
  268. \fBpen()\fP, \fBsetBrush()\fP
  269. .RE
  270. .PP
  271. .SH "Author"
  272. .PP
  273. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.