QwtPlotPanner.3 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. .TH "QwtPlotPanner" 3 "Mon Dec 28 2020" "Version 6.1.6" "Qwt User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPlotPanner \- \fBQwtPlotPanner\fP provides panning of a plot canvas\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <qwt_plot_panner\&.h>\fP
  11. .PP
  12. Inherits \fBQwtPanner\fP\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBQwtPlotPanner\fP (QWidget *)"
  17. .br
  18. .RI "A panner for the canvas of a \fBQwtPlot\fP\&. "
  19. .ti -1c
  20. .RI "virtual \fB~QwtPlotPanner\fP ()"
  21. .br
  22. .RI "Destructor\&. "
  23. .ti -1c
  24. .RI "QWidget * \fBcanvas\fP ()"
  25. .br
  26. .RI "Return observed plot canvas\&. "
  27. .ti -1c
  28. .RI "const QWidget * \fBcanvas\fP () const"
  29. .br
  30. .RI "Return Observed plot canvas\&. "
  31. .ti -1c
  32. .RI "\fBQwtPlot\fP * \fBplot\fP ()"
  33. .br
  34. .RI "Return plot widget, containing the observed plot canvas\&. "
  35. .ti -1c
  36. .RI "const \fBQwtPlot\fP * \fBplot\fP () const"
  37. .br
  38. .RI "Return plot widget, containing the observed plot canvas\&. "
  39. .ti -1c
  40. .RI "void \fBsetAxisEnabled\fP (int axis, bool on)"
  41. .br
  42. .RI "En/Disable an axis\&. "
  43. .ti -1c
  44. .RI "bool \fBisAxisEnabled\fP (int axis) const"
  45. .br
  46. .in -1c
  47. .SS "Protected Slots"
  48. .in +1c
  49. .ti -1c
  50. .RI "virtual void \fBmoveCanvas\fP (int dx, int dy)"
  51. .br
  52. .in -1c
  53. .SS "Protected Member Functions"
  54. .in +1c
  55. .ti -1c
  56. .RI "virtual QBitmap \fBcontentsMask\fP () const"
  57. .br
  58. .ti -1c
  59. .RI "virtual QPixmap \fBgrab\fP () const"
  60. .br
  61. .in -1c
  62. .SS "Additional Inherited Members"
  63. .SH "Detailed Description"
  64. .PP
  65. \fBQwtPlotPanner\fP provides panning of a plot canvas\&.
  66. \fBQwtPlotPanner\fP is a panner for a plot canvas, that adjusts the scales of the axes after dropping the canvas on its new position\&.
  67. .PP
  68. Together with \fBQwtPlotZoomer\fP and \fBQwtPlotMagnifier\fP powerful ways of navigating on a \fBQwtPlot\fP widget can be implemented easily\&.
  69. .PP
  70. \fBNote\fP
  71. .RS 4
  72. The axes are not updated, while dragging the canvas
  73. .RE
  74. .PP
  75. \fBSee also\fP
  76. .RS 4
  77. \fBQwtPlotZoomer\fP, \fBQwtPlotMagnifier\fP
  78. .RE
  79. .PP
  80. .SH "Constructor & Destructor Documentation"
  81. .PP
  82. .SS "QwtPlotPanner::QwtPlotPanner (QWidget * canvas)\fC [explicit]\fP"
  83. .PP
  84. A panner for the canvas of a \fBQwtPlot\fP\&. The panner is enabled for all axes
  85. .PP
  86. \fBParameters\fP
  87. .RS 4
  88. \fIcanvas\fP Plot canvas to pan, also the parent object
  89. .RE
  90. .PP
  91. \fBSee also\fP
  92. .RS 4
  93. \fBsetAxisEnabled()\fP
  94. .RE
  95. .PP
  96. .SH "Member Function Documentation"
  97. .PP
  98. .SS "QBitmap QwtPlotPanner::contentsMask () const\fC [protected]\fP, \fC [virtual]\fP"
  99. Calculate a mask from the border path of the canvas
  100. .PP
  101. \fBReturns\fP
  102. .RS 4
  103. Mask as bitmap
  104. .RE
  105. .PP
  106. \fBSee also\fP
  107. .RS 4
  108. \fBQwtPlotCanvas::borderPath()\fP
  109. .RE
  110. .PP
  111. .PP
  112. Reimplemented from \fBQwtPanner\fP\&.
  113. .SS "QPixmap QwtPlotPanner::grab () const\fC [protected]\fP, \fC [virtual]\fP"
  114. .PP
  115. \fBReturns\fP
  116. .RS 4
  117. Pixmap with the content of the canvas
  118. .RE
  119. .PP
  120. .PP
  121. Reimplemented from \fBQwtPanner\fP\&.
  122. .SS "bool QwtPlotPanner::isAxisEnabled (int axis) const"
  123. Test if an axis is enabled
  124. .PP
  125. \fBParameters\fP
  126. .RS 4
  127. \fIaxis\fP Axis, see \fBQwtPlot::Axis\fP
  128. .RE
  129. .PP
  130. \fBReturns\fP
  131. .RS 4
  132. True, if the axis is enabled
  133. .RE
  134. .PP
  135. \fBSee also\fP
  136. .RS 4
  137. \fBsetAxisEnabled()\fP, \fBmoveCanvas()\fP
  138. .RE
  139. .PP
  140. .SS "void QwtPlotPanner::moveCanvas (int dx, int dy)\fC [protected]\fP, \fC [virtual]\fP, \fC [slot]\fP"
  141. Adjust the enabled axes according to dx/dy
  142. .PP
  143. \fBParameters\fP
  144. .RS 4
  145. \fIdx\fP Pixel offset in x direction
  146. .br
  147. \fIdy\fP Pixel offset in y direction
  148. .RE
  149. .PP
  150. \fBSee also\fP
  151. .RS 4
  152. \fBQwtPanner::panned()\fP
  153. .RE
  154. .PP
  155. .SS "void QwtPlotPanner::setAxisEnabled (int axis, bool on)"
  156. .PP
  157. En/Disable an axis\&. Axes that are enabled will be synchronized to the result of panning\&. All other axes will remain unchanged\&.
  158. .PP
  159. \fBParameters\fP
  160. .RS 4
  161. \fIaxis\fP Axis, see \fBQwtPlot::Axis\fP
  162. .br
  163. \fIon\fP On/Off
  164. .RE
  165. .PP
  166. \fBSee also\fP
  167. .RS 4
  168. \fBisAxisEnabled()\fP, \fBmoveCanvas()\fP
  169. .RE
  170. .PP
  171. .SH "Author"
  172. .PP
  173. Generated automatically by Doxygen for Qwt User's Guide from the source code\&.