QwtColumnSymbol.3 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. .TH "QwtColumnSymbol" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtColumnSymbol \- A drawing primitive for columns\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_column_symbol\&.h>\fP
  11. .SS "Public Types"
  12. .in +1c
  13. .ti -1c
  14. .RI "enum \fBStyle\fP { \fBNoStyle\fP = -1, \fBBox\fP, \fBUserStyle\fP = 1000 }"
  15. .br
  16. .ti -1c
  17. .RI "enum \fBFrameStyle\fP { \fBNoFrame\fP, \fBPlain\fP, \fBRaised\fP }"
  18. .br
  19. .in -1c
  20. .SS "Public Member Functions"
  21. .in +1c
  22. .ti -1c
  23. .RI "\fBQwtColumnSymbol\fP (\fBStyle\fP=\fBNoStyle\fP)"
  24. .br
  25. .ti -1c
  26. .RI "virtual \fB~QwtColumnSymbol\fP ()"
  27. .br
  28. .RI "Destructor\&. "
  29. .ti -1c
  30. .RI "void \fBsetFrameStyle\fP (\fBFrameStyle\fP)"
  31. .br
  32. .ti -1c
  33. .RI "\fBFrameStyle\fP \fBframeStyle\fP () const"
  34. .br
  35. .ti -1c
  36. .RI "void \fBsetLineWidth\fP (int width)"
  37. .br
  38. .ti -1c
  39. .RI "int \fBlineWidth\fP () const"
  40. .br
  41. .ti -1c
  42. .RI "void \fBsetPalette\fP (const QPalette &)"
  43. .br
  44. .ti -1c
  45. .RI "const QPalette & \fBpalette\fP () const"
  46. .br
  47. .ti -1c
  48. .RI "void \fBsetStyle\fP (\fBStyle\fP)"
  49. .br
  50. .ti -1c
  51. .RI "\fBStyle\fP \fBstyle\fP () const"
  52. .br
  53. .ti -1c
  54. .RI "virtual void \fBdraw\fP (QPainter *, const \fBQwtColumnRect\fP &) const"
  55. .br
  56. .in -1c
  57. .SS "Protected Member Functions"
  58. .in +1c
  59. .ti -1c
  60. .RI "void \fBdrawBox\fP (QPainter *, const \fBQwtColumnRect\fP &) const"
  61. .br
  62. .in -1c
  63. .SH "Detailed Description"
  64. .PP
  65. A drawing primitive for columns\&.
  66. .SH "Member Enumeration Documentation"
  67. .PP
  68. .SS "enum \fBQwtColumnSymbol::FrameStyle\fP"
  69. Frame Style used in Box \fBstyle()\fP\&.
  70. .PP
  71. \fBSee also\fP
  72. .RS 4
  73. \fBStyle\fP, \fBsetFrameStyle()\fP, \fBframeStyle()\fP, \fBsetStyle()\fP, \fBsetPalette()\fP
  74. .RE
  75. .PP
  76. .PP
  77. \fBEnumerator\fP
  78. .in +1c
  79. .TP
  80. \fB\fINoFrame \fP\fP
  81. No frame\&.
  82. .TP
  83. \fB\fIPlain \fP\fP
  84. A plain frame style\&.
  85. .TP
  86. \fB\fIRaised \fP\fP
  87. A raised frame style\&.
  88. .SS "enum \fBQwtColumnSymbol::Style\fP"
  89. Style
  90. .PP
  91. \fBSee also\fP
  92. .RS 4
  93. \fBsetStyle()\fP, \fBstyle()\fP
  94. .RE
  95. .PP
  96. .PP
  97. \fBEnumerator\fP
  98. .in +1c
  99. .TP
  100. \fB\fINoStyle \fP\fP
  101. No Style, the symbol draws nothing\&.
  102. .TP
  103. \fB\fIBox \fP\fP
  104. The column is painted with a frame depending on the \fBframeStyle()\fP and \fBlineWidth()\fP using the \fBpalette()\fP\&.
  105. .TP
  106. \fB\fIUserStyle \fP\fP
  107. Styles >= \fBQwtColumnSymbol::UserStyle\fP are reserved for derived classes of \fBQwtColumnSymbol\fP that overload \fBdraw()\fP with additional application specific symbol types\&.
  108. .SH "Constructor & Destructor Documentation"
  109. .PP
  110. .SS "QwtColumnSymbol::QwtColumnSymbol (\fBStyle\fP style = \fC\fBNoStyle\fP\fP)"
  111. Constructor
  112. .PP
  113. \fBParameters\fP
  114. .RS 4
  115. \fIstyle\fP Style of the symbol
  116. .RE
  117. .PP
  118. \fBSee also\fP
  119. .RS 4
  120. \fBsetStyle()\fP, \fBstyle()\fP, \fBStyle\fP
  121. .RE
  122. .PP
  123. .SH "Member Function Documentation"
  124. .PP
  125. .SS "void QwtColumnSymbol::draw (QPainter * painter, const \fBQwtColumnRect\fP & rect) const\fC [virtual]\fP"
  126. Draw the symbol depending on its style\&.
  127. .PP
  128. \fBParameters\fP
  129. .RS 4
  130. \fIpainter\fP Painter
  131. .br
  132. \fIrect\fP Directed rectangle
  133. .RE
  134. .PP
  135. \fBSee also\fP
  136. .RS 4
  137. \fBdrawBox()\fP
  138. .RE
  139. .PP
  140. .SS "void QwtColumnSymbol::drawBox (QPainter * painter, const \fBQwtColumnRect\fP & rect) const\fC [protected]\fP"
  141. Draw the symbol when it is in Box style\&.
  142. .PP
  143. \fBParameters\fP
  144. .RS 4
  145. \fIpainter\fP Painter
  146. .br
  147. \fIrect\fP Directed rectangle
  148. .RE
  149. .PP
  150. \fBSee also\fP
  151. .RS 4
  152. \fBdraw()\fP
  153. .RE
  154. .PP
  155. .SS "\fBQwtColumnSymbol::FrameStyle\fP QwtColumnSymbol::frameStyle () const"
  156. .PP
  157. \fBReturns\fP
  158. .RS 4
  159. Current frame style, that is used for the Box style\&.
  160. .RE
  161. .PP
  162. \fBSee also\fP
  163. .RS 4
  164. \fBsetFrameStyle()\fP, \fBlineWidth()\fP, \fBsetStyle()\fP
  165. .RE
  166. .PP
  167. .SS "int QwtColumnSymbol::lineWidth () const"
  168. .PP
  169. \fBReturns\fP
  170. .RS 4
  171. Line width of the frame, that is used for the Box style\&.
  172. .RE
  173. .PP
  174. \fBSee also\fP
  175. .RS 4
  176. \fBsetLineWidth()\fP, \fBframeStyle()\fP, \fBsetStyle()\fP
  177. .RE
  178. .PP
  179. .SS "const QPalette & QwtColumnSymbol::palette () const"
  180. .PP
  181. \fBReturns\fP
  182. .RS 4
  183. Current palette
  184. .RE
  185. .PP
  186. \fBSee also\fP
  187. .RS 4
  188. \fBsetPalette()\fP
  189. .RE
  190. .PP
  191. .SS "void QwtColumnSymbol::setFrameStyle (\fBFrameStyle\fP frameStyle)"
  192. Set the frame, that is used for the Box style\&.
  193. .PP
  194. \fBParameters\fP
  195. .RS 4
  196. \fIframeStyle\fP Frame style
  197. .RE
  198. .PP
  199. \fBSee also\fP
  200. .RS 4
  201. \fBframeStyle()\fP, \fBsetLineWidth()\fP, \fBsetStyle()\fP
  202. .RE
  203. .PP
  204. .SS "void QwtColumnSymbol::setLineWidth (int width)"
  205. Set the line width of the frame, that is used for the Box style\&.
  206. .PP
  207. \fBParameters\fP
  208. .RS 4
  209. \fIwidth\fP Width
  210. .RE
  211. .PP
  212. \fBSee also\fP
  213. .RS 4
  214. \fBlineWidth()\fP, \fBsetFrameStyle()\fP
  215. .RE
  216. .PP
  217. .SS "void QwtColumnSymbol::setPalette (const QPalette & palette)"
  218. Assign a palette for the symbol
  219. .PP
  220. \fBParameters\fP
  221. .RS 4
  222. \fIpalette\fP Palette
  223. .RE
  224. .PP
  225. \fBSee also\fP
  226. .RS 4
  227. \fBpalette()\fP, \fBsetStyle()\fP
  228. .RE
  229. .PP
  230. .SS "void QwtColumnSymbol::setStyle (\fBStyle\fP style)"
  231. Specify the symbol style
  232. .PP
  233. \fBParameters\fP
  234. .RS 4
  235. \fIstyle\fP Style
  236. .RE
  237. .PP
  238. \fBSee also\fP
  239. .RS 4
  240. \fBstyle()\fP, \fBsetPalette()\fP
  241. .RE
  242. .PP
  243. .SS "\fBQwtColumnSymbol::Style\fP QwtColumnSymbol::style () const"
  244. .PP
  245. \fBReturns\fP
  246. .RS 4
  247. Current symbol style
  248. .RE
  249. .PP
  250. \fBSee also\fP
  251. .RS 4
  252. \fBsetStyle()\fP
  253. .RE
  254. .PP
  255. .SH "Author"
  256. .PP
  257. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.