QwtPlotGLCanvas.3 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406
  1. .TH "QwtPlotGLCanvas" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPlotGLCanvas \- An alternative canvas for a \fBQwtPlot\fP derived from QGLWidget\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_plot_glcanvas\&.h>\fP
  11. .PP
  12. Inherits QGLWidget\&.
  13. .SS "Public Types"
  14. .in +1c
  15. .ti -1c
  16. .RI "enum \fBShadow\fP { \fBPlain\fP = QFrame::Plain, \fBRaised\fP = QFrame::Raised, \fBSunken\fP = QFrame::Sunken }"
  17. .br
  18. .RI "Frame shadow\&. "
  19. .ti -1c
  20. .RI "enum \fBShape\fP { \fBNoFrame\fP = QFrame::NoFrame, \fBBox\fP = QFrame::Box, \fBPanel\fP = QFrame::Panel }"
  21. .br
  22. .RI "Frame shape\&. "
  23. .in -1c
  24. .SS "Public Slots"
  25. .in +1c
  26. .ti -1c
  27. .RI "void \fBreplot\fP ()"
  28. .br
  29. .RI "Calls repaint() "
  30. .in -1c
  31. .SS "Public Member Functions"
  32. .in +1c
  33. .ti -1c
  34. .RI "\fBQwtPlotGLCanvas\fP (\fBQwtPlot\fP *=NULL)"
  35. .br
  36. .RI "Constructor\&. "
  37. .ti -1c
  38. .RI "virtual \fB~QwtPlotGLCanvas\fP ()"
  39. .br
  40. .RI "Destructor\&. "
  41. .ti -1c
  42. .RI "void \fBsetFrameStyle\fP (int style)"
  43. .br
  44. .ti -1c
  45. .RI "int \fBframeStyle\fP () const"
  46. .br
  47. .ti -1c
  48. .RI "void \fBsetFrameShadow\fP (\fBShadow\fP)"
  49. .br
  50. .ti -1c
  51. .RI "\fBShadow\fP \fBframeShadow\fP () const"
  52. .br
  53. .ti -1c
  54. .RI "void \fBsetFrameShape\fP (\fBShape\fP)"
  55. .br
  56. .ti -1c
  57. .RI "\fBShape\fP \fBframeShape\fP () const"
  58. .br
  59. .ti -1c
  60. .RI "void \fBsetLineWidth\fP (int)"
  61. .br
  62. .ti -1c
  63. .RI "int \fBlineWidth\fP () const"
  64. .br
  65. .ti -1c
  66. .RI "void \fBsetMidLineWidth\fP (int)"
  67. .br
  68. .ti -1c
  69. .RI "int \fBmidLineWidth\fP () const"
  70. .br
  71. .ti -1c
  72. .RI "int \fBframeWidth\fP () const"
  73. .br
  74. .ti -1c
  75. .RI "QRect \fBframeRect\fP () const"
  76. .br
  77. .ti -1c
  78. .RI "Q_INVOKABLE QPainterPath \fBborderPath\fP (const QRect &) const"
  79. .br
  80. .ti -1c
  81. .RI "virtual bool \fBevent\fP (QEvent *)"
  82. .br
  83. .in -1c
  84. .SS "Protected Member Functions"
  85. .in +1c
  86. .ti -1c
  87. .RI "virtual void \fBpaintEvent\fP (QPaintEvent *)"
  88. .br
  89. .ti -1c
  90. .RI "virtual void \fBdrawBackground\fP (QPainter *)"
  91. .br
  92. .ti -1c
  93. .RI "virtual void \fBdrawBorder\fP (QPainter *)"
  94. .br
  95. .ti -1c
  96. .RI "virtual void \fBdrawItems\fP (QPainter *)"
  97. .br
  98. .in -1c
  99. .SH "Detailed Description"
  100. .PP
  101. An alternative canvas for a \fBQwtPlot\fP derived from QGLWidget\&.
  102. \fBQwtPlotGLCanvas\fP implements the very basics to act as canvas inside of a \fBQwtPlot\fP widget\&. It might be extended to a full featured alternative to \fBQwtPlotCanvas\fP in a future version of Qwt\&.
  103. .PP
  104. Even if \fBQwtPlotGLCanvas\fP is not derived from QFrame it imitates its API\&. When using style sheets it supports the box model - beside backgrounds with rounded borders\&.
  105. .PP
  106. \fBSee also\fP
  107. .RS 4
  108. \fBQwtPlot::setCanvas()\fP, \fBQwtPlotCanvas\fP
  109. .RE
  110. .PP
  111. \fBNote\fP
  112. .RS 4
  113. With Qt4 you might want to use the QPaintEngine::OpenGL paint engine ( see QGL::setPreferredPaintEngine() )\&. On a Linux test system QPaintEngine::OpenGL2 shows very basic problems like translated geometries\&.
  114. .RE
  115. .PP
  116. .SH "Member Enumeration Documentation"
  117. .PP
  118. .SS "enum \fBQwtPlotGLCanvas::Shadow\fP"
  119. .PP
  120. Frame shadow\&. Unfortunately it is not possible to use QFrame::Shadow as a property of a widget that is not derived from QFrame\&. The following enum is made for the designer only\&. It is safe to use QFrame::Shadow instead\&.
  121. .PP
  122. \fBEnumerator\fP
  123. .in +1c
  124. .TP
  125. \fB\fIPlain \fP\fP
  126. QFrame::Plain\&.
  127. .TP
  128. \fB\fIRaised \fP\fP
  129. QFrame::Raised\&.
  130. .TP
  131. \fB\fISunken \fP\fP
  132. QFrame::Sunken\&.
  133. .SS "enum \fBQwtPlotGLCanvas::Shape\fP"
  134. .PP
  135. Frame shape\&. Unfortunately it is not possible to use QFrame::Shape as a property of a widget that is not derived from QFrame\&. The following enum is made for the designer only\&. It is safe to use QFrame::Shadow instead\&.
  136. .PP
  137. \fBNote\fP
  138. .RS 4
  139. QFrame::StyledPanel and QFrame::WinPanel are unsupported and will be displayed as QFrame::Panel\&.
  140. .RE
  141. .PP
  142. .SH "Constructor & Destructor Documentation"
  143. .PP
  144. .SS "QwtPlotGLCanvas::QwtPlotGLCanvas (\fBQwtPlot\fP * plot = \fCNULL\fP)\fC [explicit]\fP"
  145. .PP
  146. Constructor\&.
  147. .PP
  148. \fBParameters\fP
  149. .RS 4
  150. \fIplot\fP Parent plot widget
  151. .RE
  152. .PP
  153. \fBSee also\fP
  154. .RS 4
  155. \fBQwtPlot::setCanvas()\fP
  156. .RE
  157. .PP
  158. .SH "Member Function Documentation"
  159. .PP
  160. .SS "QPainterPath QwtPlotGLCanvas::borderPath (const QRect & rect) const"
  161. .PP
  162. \fBReturns\fP
  163. .RS 4
  164. Empty path
  165. .RE
  166. .PP
  167. .SS "void QwtPlotGLCanvas::drawBackground (QPainter * painter)\fC [protected]\fP, \fC [virtual]\fP"
  168. Draw the background of the canvas
  169. .PP
  170. \fBParameters\fP
  171. .RS 4
  172. \fIpainter\fP Painter
  173. .RE
  174. .PP
  175. .SS "void QwtPlotGLCanvas::drawBorder (QPainter * painter)\fC [protected]\fP, \fC [virtual]\fP"
  176. Draw the border of the canvas
  177. .PP
  178. \fBParameters\fP
  179. .RS 4
  180. \fIpainter\fP Painter
  181. .RE
  182. .PP
  183. .SS "void QwtPlotGLCanvas::drawItems (QPainter * painter)\fC [protected]\fP, \fC [virtual]\fP"
  184. Draw the plot items
  185. .PP
  186. \fBParameters\fP
  187. .RS 4
  188. \fIpainter\fP Painter
  189. .RE
  190. .PP
  191. \fBSee also\fP
  192. .RS 4
  193. \fBQwtPlot::drawCanvas()\fP
  194. .RE
  195. .PP
  196. .SS "bool QwtPlotGLCanvas::event (QEvent * event)\fC [virtual]\fP"
  197. Qt event handler for QEvent::PolishRequest and QEvent::StyleChange
  198. .PP
  199. \fBParameters\fP
  200. .RS 4
  201. \fIevent\fP Qt Event
  202. .RE
  203. .PP
  204. \fBReturns\fP
  205. .RS 4
  206. See QGLWidget::event()
  207. .RE
  208. .PP
  209. .SS "QRect QwtPlotGLCanvas::frameRect () const"
  210. .PP
  211. \fBReturns\fP
  212. .RS 4
  213. The rectangle where the frame is drawn in\&.
  214. .RE
  215. .PP
  216. .SS "\fBQwtPlotGLCanvas::Shadow\fP QwtPlotGLCanvas::frameShadow () const"
  217. .PP
  218. \fBReturns\fP
  219. .RS 4
  220. Frame shadow
  221. .RE
  222. .PP
  223. \fBSee also\fP
  224. .RS 4
  225. \fBsetFrameShadow()\fP, QFrame::setFrameShadow()
  226. .RE
  227. .PP
  228. .SS "\fBQwtPlotGLCanvas::Shape\fP QwtPlotGLCanvas::frameShape () const"
  229. .PP
  230. \fBReturns\fP
  231. .RS 4
  232. Frame shape
  233. .RE
  234. .PP
  235. \fBSee also\fP
  236. .RS 4
  237. \fBsetFrameShape()\fP, QFrame::frameShape()
  238. .RE
  239. .PP
  240. .SS "int QwtPlotGLCanvas::frameStyle () const"
  241. .PP
  242. \fBReturns\fP
  243. .RS 4
  244. The bitwise OR between a \fBframeShape()\fP and a \fBframeShadow()\fP
  245. .RE
  246. .PP
  247. \fBSee also\fP
  248. .RS 4
  249. \fBsetFrameStyle()\fP, QFrame::frameStyle()
  250. .RE
  251. .PP
  252. .SS "int QwtPlotGLCanvas::frameWidth () const"
  253. .PP
  254. \fBReturns\fP
  255. .RS 4
  256. Frame width depending on the style, line width and midline width\&.
  257. .RE
  258. .PP
  259. .SS "int QwtPlotGLCanvas::lineWidth () const"
  260. .PP
  261. \fBReturns\fP
  262. .RS 4
  263. Line width of the frame
  264. .RE
  265. .PP
  266. \fBSee also\fP
  267. .RS 4
  268. \fBsetLineWidth()\fP, \fBmidLineWidth()\fP
  269. .RE
  270. .PP
  271. .SS "int QwtPlotGLCanvas::midLineWidth () const"
  272. .PP
  273. \fBReturns\fP
  274. .RS 4
  275. Midline width of the frame
  276. .RE
  277. .PP
  278. \fBSee also\fP
  279. .RS 4
  280. \fBsetMidLineWidth()\fP, \fBlineWidth()\fP
  281. .RE
  282. .PP
  283. .SS "void QwtPlotGLCanvas::paintEvent (QPaintEvent * event)\fC [protected]\fP, \fC [virtual]\fP"
  284. Paint event
  285. .PP
  286. \fBParameters\fP
  287. .RS 4
  288. \fIevent\fP Paint event
  289. .RE
  290. .PP
  291. \fBSee also\fP
  292. .RS 4
  293. \fBQwtPlot::drawCanvas()\fP
  294. .RE
  295. .PP
  296. .SS "void QwtPlotGLCanvas::setFrameShadow (\fBShadow\fP shadow)"
  297. Set the frame shadow
  298. .PP
  299. \fBParameters\fP
  300. .RS 4
  301. \fIshadow\fP Frame shadow
  302. .RE
  303. .PP
  304. \fBSee also\fP
  305. .RS 4
  306. \fBframeShadow()\fP, \fBsetFrameShape()\fP, QFrame::setFrameShadow()
  307. .RE
  308. .PP
  309. .SS "void QwtPlotGLCanvas::setFrameShape (\fBShape\fP shape)"
  310. Set the frame shape
  311. .PP
  312. \fBParameters\fP
  313. .RS 4
  314. \fIshape\fP Frame shape
  315. .RE
  316. .PP
  317. \fBSee also\fP
  318. .RS 4
  319. \fBframeShape()\fP, \fBsetFrameShadow()\fP, QFrame::frameShape()
  320. .RE
  321. .PP
  322. .SS "void QwtPlotGLCanvas::setFrameStyle (int style)"
  323. Set the frame style
  324. .PP
  325. \fBParameters\fP
  326. .RS 4
  327. \fIstyle\fP The bitwise OR between a shape and a shadow\&.
  328. .RE
  329. .PP
  330. \fBSee also\fP
  331. .RS 4
  332. \fBframeStyle()\fP, QFrame::setFrameStyle(), \fBsetFrameShadow()\fP, \fBsetFrameShape()\fP
  333. .RE
  334. .PP
  335. .SS "void QwtPlotGLCanvas::setLineWidth (int width)"
  336. Set the frame line width
  337. .PP
  338. The default line width is 2 pixels\&.
  339. .PP
  340. \fBParameters\fP
  341. .RS 4
  342. \fIwidth\fP Line width of the frame
  343. .RE
  344. .PP
  345. \fBSee also\fP
  346. .RS 4
  347. \fBlineWidth()\fP, \fBsetMidLineWidth()\fP
  348. .RE
  349. .PP
  350. .SS "void QwtPlotGLCanvas::setMidLineWidth (int width)"
  351. Set the frame mid line width
  352. .PP
  353. The default midline width is 0 pixels\&.
  354. .PP
  355. \fBParameters\fP
  356. .RS 4
  357. \fIwidth\fP Midline width of the frame
  358. .RE
  359. .PP
  360. \fBSee also\fP
  361. .RS 4
  362. \fBmidLineWidth()\fP, \fBsetLineWidth()\fP
  363. .RE
  364. .PP
  365. .SH "Author"
  366. .PP
  367. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.