QwtIntervalSymbol.3 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286
  1. .TH "QwtIntervalSymbol" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtIntervalSymbol \- A drawing primitive for displaying an interval like an error bar\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_interval_symbol\&.h>\fP
  11. .SS "Public Types"
  12. .in +1c
  13. .ti -1c
  14. .RI "enum \fBStyle\fP { \fBNoSymbol\fP = -1, \fBBar\fP, \fBBox\fP, \fBUserSymbol\fP = 1000 }"
  15. .br
  16. .RI "Symbol style\&. "
  17. .in -1c
  18. .SS "Public Member Functions"
  19. .in +1c
  20. .ti -1c
  21. .RI "\fBQwtIntervalSymbol\fP (\fBStyle\fP=\fBNoSymbol\fP)"
  22. .br
  23. .ti -1c
  24. .RI "\fBQwtIntervalSymbol\fP (const \fBQwtIntervalSymbol\fP &)"
  25. .br
  26. .RI "Copy constructor\&. "
  27. .ti -1c
  28. .RI "virtual \fB~QwtIntervalSymbol\fP ()"
  29. .br
  30. .RI "Destructor\&. "
  31. .ti -1c
  32. .RI "\fBQwtIntervalSymbol\fP & \fBoperator=\fP (const \fBQwtIntervalSymbol\fP &)"
  33. .br
  34. .RI "Assignment operator\&. "
  35. .ti -1c
  36. .RI "bool \fBoperator==\fP (const \fBQwtIntervalSymbol\fP &) const"
  37. .br
  38. .RI "Compare two symbols\&. "
  39. .ti -1c
  40. .RI "bool \fBoperator!=\fP (const \fBQwtIntervalSymbol\fP &) const"
  41. .br
  42. .RI "Compare two symbols\&. "
  43. .ti -1c
  44. .RI "void \fBsetWidth\fP (int)"
  45. .br
  46. .ti -1c
  47. .RI "int \fBwidth\fP () const"
  48. .br
  49. .ti -1c
  50. .RI "void \fBsetBrush\fP (const QBrush &)"
  51. .br
  52. .RI "Assign a brush\&. "
  53. .ti -1c
  54. .RI "const QBrush & \fBbrush\fP () const"
  55. .br
  56. .ti -1c
  57. .RI "void \fBsetPen\fP (const QColor &, qreal \fBwidth\fP=0\&.0, Qt::PenStyle=Qt::SolidLine)"
  58. .br
  59. .ti -1c
  60. .RI "void \fBsetPen\fP (const QPen &)"
  61. .br
  62. .ti -1c
  63. .RI "const QPen & \fBpen\fP () const"
  64. .br
  65. .ti -1c
  66. .RI "void \fBsetStyle\fP (\fBStyle\fP)"
  67. .br
  68. .ti -1c
  69. .RI "\fBStyle\fP \fBstyle\fP () const"
  70. .br
  71. .ti -1c
  72. .RI "virtual void \fBdraw\fP (QPainter *, Qt::Orientation, const QPointF &from, const QPointF &to) const"
  73. .br
  74. .in -1c
  75. .SH "Detailed Description"
  76. .PP
  77. A drawing primitive for displaying an interval like an error bar\&.
  78. .PP
  79. \fBSee also\fP
  80. .RS 4
  81. \fBQwtPlotIntervalCurve\fP
  82. .RE
  83. .PP
  84. .SH "Member Enumeration Documentation"
  85. .PP
  86. .SS "enum \fBQwtIntervalSymbol::Style\fP"
  87. .PP
  88. Symbol style\&.
  89. .PP
  90. \fBEnumerator\fP
  91. .in +1c
  92. .TP
  93. \fB\fINoSymbol \fP\fP
  94. No Style\&. The symbol cannot be drawn\&.
  95. .TP
  96. \fB\fIBar \fP\fP
  97. The symbol displays a line with caps at the beginning/end\&. The size of the caps depends on the symbol \fBwidth()\fP\&.
  98. .TP
  99. \fB\fIBox \fP\fP
  100. The symbol displays a plain rectangle using \fBpen()\fP and \fBbrush()\fP\&. The size of the rectangle depends on the translated interval and the \fBwidth()\fP,
  101. .TP
  102. \fB\fIUserSymbol \fP\fP
  103. Styles >= UserSymbol are reserved for derived classes of \fBQwtIntervalSymbol\fP that overload \fBdraw()\fP with additional application specific symbol types\&.
  104. .SH "Constructor & Destructor Documentation"
  105. .PP
  106. .SS "QwtIntervalSymbol::QwtIntervalSymbol (\fBStyle\fP style = \fC\fBNoSymbol\fP\fP)"
  107. Constructor
  108. .PP
  109. \fBParameters\fP
  110. .RS 4
  111. \fIstyle\fP Style of the symbol
  112. .RE
  113. .PP
  114. \fBSee also\fP
  115. .RS 4
  116. \fBsetStyle()\fP, \fBstyle()\fP, \fBStyle\fP
  117. .RE
  118. .PP
  119. .SH "Member Function Documentation"
  120. .PP
  121. .SS "const QBrush & QwtIntervalSymbol::brush () const"
  122. .PP
  123. \fBReturns\fP
  124. .RS 4
  125. Brush
  126. .RE
  127. .PP
  128. \fBSee also\fP
  129. .RS 4
  130. \fBsetBrush()\fP
  131. .RE
  132. .PP
  133. .SS "void QwtIntervalSymbol::draw (QPainter * painter, Qt::Orientation orientation, const QPointF & from, const QPointF & to) const\fC [virtual]\fP"
  134. Draw a symbol depending on its style
  135. .PP
  136. \fBParameters\fP
  137. .RS 4
  138. \fIpainter\fP Painter
  139. .br
  140. \fIorientation\fP Orientation
  141. .br
  142. \fIfrom\fP Start point of the interval in target device coordinates
  143. .br
  144. \fIto\fP End point of the interval in target device coordinates
  145. .RE
  146. .PP
  147. \fBSee also\fP
  148. .RS 4
  149. \fBsetStyle()\fP
  150. .RE
  151. .PP
  152. .SS "const QPen & QwtIntervalSymbol::pen () const"
  153. .PP
  154. \fBReturns\fP
  155. .RS 4
  156. Pen
  157. .RE
  158. .PP
  159. \fBSee also\fP
  160. .RS 4
  161. \fBsetPen()\fP, \fBbrush()\fP
  162. .RE
  163. .PP
  164. .SS "void QwtIntervalSymbol::setBrush (const QBrush & brush)"
  165. .PP
  166. Assign a brush\&. The brush is used for the Box style\&.
  167. .PP
  168. \fBParameters\fP
  169. .RS 4
  170. \fIbrush\fP Brush
  171. .RE
  172. .PP
  173. \fBSee also\fP
  174. .RS 4
  175. \fBbrush()\fP
  176. .RE
  177. .PP
  178. .SS "void QwtIntervalSymbol::setPen (const QColor & color, qreal width = \fC0\&.0\fP, Qt::PenStyle style = \fCQt::SolidLine\fP)"
  179. Build and assign a pen
  180. .PP
  181. 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\&.
  182. .PP
  183. \fBParameters\fP
  184. .RS 4
  185. \fIcolor\fP Pen color
  186. .br
  187. \fIwidth\fP Pen width
  188. .br
  189. \fIstyle\fP Pen style
  190. .RE
  191. .PP
  192. \fBSee also\fP
  193. .RS 4
  194. \fBpen()\fP, \fBbrush()\fP
  195. .RE
  196. .PP
  197. .SS "void QwtIntervalSymbol::setPen (const QPen & pen)"
  198. Assign a pen
  199. .PP
  200. \fBParameters\fP
  201. .RS 4
  202. \fIpen\fP Pen
  203. .RE
  204. .PP
  205. \fBSee also\fP
  206. .RS 4
  207. \fBpen()\fP, \fBsetBrush()\fP
  208. .RE
  209. .PP
  210. .SS "void QwtIntervalSymbol::setStyle (\fBStyle\fP style)"
  211. Specify the symbol style
  212. .PP
  213. \fBParameters\fP
  214. .RS 4
  215. \fIstyle\fP Style
  216. .RE
  217. .PP
  218. \fBSee also\fP
  219. .RS 4
  220. \fBstyle()\fP, \fBStyle\fP
  221. .RE
  222. .PP
  223. .SS "void QwtIntervalSymbol::setWidth (int width)"
  224. Specify the width of the symbol It is used depending on the style\&.
  225. .PP
  226. \fBParameters\fP
  227. .RS 4
  228. \fIwidth\fP Width
  229. .RE
  230. .PP
  231. \fBSee also\fP
  232. .RS 4
  233. \fBwidth()\fP, \fBsetStyle()\fP
  234. .RE
  235. .PP
  236. .SS "\fBQwtIntervalSymbol::Style\fP QwtIntervalSymbol::style () const"
  237. .PP
  238. \fBReturns\fP
  239. .RS 4
  240. Current symbol style
  241. .RE
  242. .PP
  243. \fBSee also\fP
  244. .RS 4
  245. \fBsetStyle()\fP
  246. .RE
  247. .PP
  248. .SS "int QwtIntervalSymbol::width () const"
  249. .PP
  250. \fBReturns\fP
  251. .RS 4
  252. Width of the symbol\&.
  253. .RE
  254. .PP
  255. \fBSee also\fP
  256. .RS 4
  257. \fBsetWidth()\fP, \fBsetStyle()\fP
  258. .RE
  259. .PP
  260. .SH "Author"
  261. .PP
  262. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.