QwtPolarPicker.3 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  1. .TH "QwtPolarPicker" 3 "Fri Sep 19 2014" "Version 1.1.1" "Qwt Polar User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPolarPicker \-
  6. .PP
  7. \fBQwtPolarPicker\fP provides selections on a plot canvas\&.
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. .PP
  12. \fC#include <qwt_polar_picker\&.h>\fP
  13. .PP
  14. Inherits QwtPicker\&.
  15. .SS "Signals"
  16. .in +1c
  17. .ti -1c
  18. .RI "void \fBselected\fP (const QwtPointPolar &pos)"
  19. .br
  20. .ti -1c
  21. .RI "void \fBselected\fP (const QVector< QwtPointPolar > &points)"
  22. .br
  23. .ti -1c
  24. .RI "void \fBappended\fP (const QwtPointPolar &pos)"
  25. .br
  26. .ti -1c
  27. .RI "void \fBmoved\fP (const QwtPointPolar &pos)"
  28. .br
  29. .in -1c
  30. .SS "Public Member Functions"
  31. .in +1c
  32. .ti -1c
  33. .RI "\fBQwtPolarPicker\fP (\fBQwtPolarCanvas\fP *)"
  34. .br
  35. .RI "\fICreate a polar plot picker\&. \fP"
  36. .ti -1c
  37. .RI "virtual \fB~QwtPolarPicker\fP ()"
  38. .br
  39. .RI "\fIDestructor\&. \fP"
  40. .ti -1c
  41. .RI "\fBQwtPolarPicker\fP (RubberBand rubberBand, DisplayMode trackerMode, \fBQwtPolarCanvas\fP *)"
  42. .br
  43. .ti -1c
  44. .RI "\fBQwtPolarPlot\fP * \fBplot\fP ()"
  45. .br
  46. .ti -1c
  47. .RI "const \fBQwtPolarPlot\fP * \fBplot\fP () const "
  48. .br
  49. .ti -1c
  50. .RI "\fBQwtPolarCanvas\fP * \fBcanvas\fP ()"
  51. .br
  52. .ti -1c
  53. .RI "const \fBQwtPolarCanvas\fP * \fBcanvas\fP () const "
  54. .br
  55. .ti -1c
  56. .RI "virtual QRect \fBpickRect\fP () const "
  57. .br
  58. .in -1c
  59. .SS "Protected Member Functions"
  60. .in +1c
  61. .ti -1c
  62. .RI "QwtPointPolar \fBinvTransform\fP (const QPoint &) const "
  63. .br
  64. .ti -1c
  65. .RI "virtual QwtText \fBtrackerText\fP (const QPoint &) const "
  66. .br
  67. .ti -1c
  68. .RI "virtual QwtText \fBtrackerTextPolar\fP (const QwtPointPolar &) const "
  69. .br
  70. .RI "\fITranslate a position into a position string\&. \fP"
  71. .ti -1c
  72. .RI "virtual void \fBmove\fP (const QPoint &)"
  73. .br
  74. .ti -1c
  75. .RI "virtual void \fBappend\fP (const QPoint &)"
  76. .br
  77. .ti -1c
  78. .RI "virtual bool \fBend\fP (bool ok=true)"
  79. .br
  80. .in -1c
  81. .SH "Detailed Description"
  82. .PP
  83. \fBQwtPolarPicker\fP provides selections on a plot canvas\&.
  84. \fBQwtPolarPicker\fP is a QwtPicker tailored for selections on a polar plot canvas\&.
  85. .SH "Constructor & Destructor Documentation"
  86. .PP
  87. .SS "QwtPolarPicker::QwtPolarPicker (\fBQwtPolarCanvas\fP *canvas)\fC [explicit]\fP"
  88. .PP
  89. Create a polar plot picker\&.
  90. .PP
  91. \fBParameters:\fP
  92. .RS 4
  93. \fIcanvas\fP Plot canvas to observe, also the parent object
  94. .RE
  95. .PP
  96. .SS "QwtPolarPicker::QwtPolarPicker (RubberBandrubberBand, DisplayModetrackerMode, \fBQwtPolarCanvas\fP *canvas)\fC [explicit]\fP"
  97. Create a plot picker
  98. .PP
  99. \fBParameters:\fP
  100. .RS 4
  101. \fIrubberBand\fP Rubberband style
  102. .br
  103. \fItrackerMode\fP Tracker mode
  104. .br
  105. \fIcanvas\fP Plot canvas to observe, also the parent object
  106. .RE
  107. .PP
  108. \fBSee Also:\fP
  109. .RS 4
  110. QwtPicker, QwtPicker::setSelectionFlags(), QwtPicker::setRubberBand(), QwtPicker::setTrackerMode
  111. .PP
  112. \fBQwtPolarPlot::autoReplot()\fP, \fBQwtPolarPlot::replot()\fP, scaleRect()
  113. .RE
  114. .PP
  115. .SH "Member Function Documentation"
  116. .PP
  117. .SS "void QwtPolarPicker::append (const QPoint &pos)\fC [protected]\fP, \fC [virtual]\fP"
  118. Append a point to the selection and update rubberband and tracker\&.
  119. .PP
  120. \fBParameters:\fP
  121. .RS 4
  122. \fIpos\fP Additional point
  123. .RE
  124. .PP
  125. \fBSee Also:\fP
  126. .RS 4
  127. isActive, begin(), \fBend()\fP, \fBmove()\fP, \fBappended()\fP
  128. .RE
  129. .PP
  130. \fBNote:\fP
  131. .RS 4
  132. The appended(const QPoint &), appended(const QDoublePoint &) signals are emitted\&.
  133. .RE
  134. .PP
  135. .SS "void QwtPolarPicker::appended (const QwtPointPolar &pos)\fC [signal]\fP"
  136. A signal emitted when a point has been appended to the selection
  137. .PP
  138. \fBParameters:\fP
  139. .RS 4
  140. \fIpos\fP Position of the appended point\&.
  141. .RE
  142. .PP
  143. \fBSee Also:\fP
  144. .RS 4
  145. \fBappend()\fP\&. \fBmoved()\fP
  146. .RE
  147. .PP
  148. .SS "\fBQwtPolarCanvas\fP * QwtPolarPicker::canvas ()"
  149. .PP
  150. \fBReturns:\fP
  151. .RS 4
  152. Observed plot canvas
  153. .RE
  154. .PP
  155. .SS "const \fBQwtPolarCanvas\fP * QwtPolarPicker::canvas () const"
  156. .PP
  157. \fBReturns:\fP
  158. .RS 4
  159. Observed plot canvas
  160. .RE
  161. .PP
  162. .SS "bool QwtPolarPicker::end (boolok = \fCtrue\fP)\fC [protected]\fP, \fC [virtual]\fP"
  163. Close a selection setting the state to inactive\&.
  164. .PP
  165. \fBParameters:\fP
  166. .RS 4
  167. \fIok\fP If true, complete the selection and emit selected signals otherwise discard the selection\&.
  168. .RE
  169. .PP
  170. \fBReturns:\fP
  171. .RS 4
  172. true if the selection is accepted, false otherwise
  173. .RE
  174. .PP
  175. .SS "QwtPointPolar QwtPolarPicker::invTransform (const QPoint &pos) const\fC [protected]\fP"
  176. Translate a point from widget into plot coordinates
  177. .PP
  178. \fBParameters:\fP
  179. .RS 4
  180. \fIpos\fP Point in widget coordinates of the plot canvas
  181. .RE
  182. .PP
  183. \fBReturns:\fP
  184. .RS 4
  185. Point in plot coordinates
  186. .RE
  187. .PP
  188. \fBSee Also:\fP
  189. .RS 4
  190. transform(), \fBcanvas()\fP
  191. .RE
  192. .PP
  193. .SS "void QwtPolarPicker::move (const QPoint &pos)\fC [protected]\fP, \fC [virtual]\fP"
  194. Move the last point of the selection
  195. .PP
  196. \fBParameters:\fP
  197. .RS 4
  198. \fIpos\fP New position
  199. .RE
  200. .PP
  201. \fBSee Also:\fP
  202. .RS 4
  203. isActive, begin(), \fBend()\fP, \fBappend()\fP
  204. .RE
  205. .PP
  206. \fBNote:\fP
  207. .RS 4
  208. The moved(const QPoint &), moved(const QDoublePoint &) signals are emitted\&.
  209. .RE
  210. .PP
  211. .SS "void QwtPolarPicker::moved (const QwtPointPolar &pos)\fC [signal]\fP"
  212. A signal emitted whenever the last appended point of the selection has been moved\&.
  213. .PP
  214. \fBParameters:\fP
  215. .RS 4
  216. \fIpos\fP Position of the moved last point of the selection\&.
  217. .RE
  218. .PP
  219. \fBSee Also:\fP
  220. .RS 4
  221. \fBmove()\fP, \fBappended()\fP
  222. .RE
  223. .PP
  224. .SS "QRect QwtPolarPicker::pickRect () const\fC [virtual]\fP"
  225. .PP
  226. \fBReturns:\fP
  227. .RS 4
  228. Bounding rectangle of the region, where picking is supported\&.
  229. .RE
  230. .PP
  231. .SS "\fBQwtPolarPlot\fP * QwtPolarPicker::plot ()"
  232. .PP
  233. \fBReturns:\fP
  234. .RS 4
  235. Plot widget, containing the observed plot canvas
  236. .RE
  237. .PP
  238. .SS "const \fBQwtPolarPlot\fP * QwtPolarPicker::plot () const"
  239. .PP
  240. \fBReturns:\fP
  241. .RS 4
  242. Plot widget, containing the observed plot canvas
  243. .RE
  244. .PP
  245. .SS "void QwtPolarPicker::selected (const QwtPointPolar &pos)\fC [signal]\fP"
  246. A signal emitted in case of selectionFlags() & PointSelection\&.
  247. .PP
  248. \fBParameters:\fP
  249. .RS 4
  250. \fIpos\fP Selected point
  251. .RE
  252. .PP
  253. .SS "void QwtPolarPicker::selected (const QVector< QwtPointPolar > &points)\fC [signal]\fP"
  254. A signal emitting the selected points, at the end of a selection\&.
  255. .PP
  256. \fBParameters:\fP
  257. .RS 4
  258. \fIpoints\fP Selected points
  259. .RE
  260. .PP
  261. .SS "QwtText QwtPolarPicker::trackerText (const QPoint &pos) const\fC [protected]\fP, \fC [virtual]\fP"
  262. Translate a pixel position into a position string
  263. .PP
  264. \fBParameters:\fP
  265. .RS 4
  266. \fIpos\fP Position in pixel coordinates
  267. .RE
  268. .PP
  269. \fBReturns:\fP
  270. .RS 4
  271. Position string
  272. .RE
  273. .PP
  274. .SS "QwtText QwtPolarPicker::trackerTextPolar (const QwtPointPolar &pos) const\fC [protected]\fP, \fC [virtual]\fP"
  275. .PP
  276. Translate a position into a position string\&. In case of HLineRubberBand the label is the value of the y position, in case of VLineRubberBand the value of the x position\&. Otherwise the label contains x and y position separated by a ',' \&.
  277. .PP
  278. The format for the double to string conversion is '%\&.4f'\&.
  279. .PP
  280. \fBParameters:\fP
  281. .RS 4
  282. \fIpos\fP Position
  283. .RE
  284. .PP
  285. \fBReturns:\fP
  286. .RS 4
  287. Position string
  288. .RE
  289. .PP
  290. .SH "Author"
  291. .PP
  292. Generated automatically by Doxygen for Qwt Polar User's Guide from the source code\&.