QwtPolarRenderer.3 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. .TH "QwtPolarRenderer" 3 "Fri Sep 19 2014" "Version 1.1.1" "Qwt Polar User's Guide" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. QwtPolarRenderer \-
  6. .PP
  7. Renderer for exporting a polar plot to a document, a printer or anything else, that is supported by QPainter/QPaintDevice\&.
  8. .SH SYNOPSIS
  9. .br
  10. .PP
  11. .PP
  12. \fC#include <qwt_polar_renderer\&.h>\fP
  13. .PP
  14. Inherits QObject\&.
  15. .SS "Public Member Functions"
  16. .in +1c
  17. .ti -1c
  18. .RI "\fBQwtPolarRenderer\fP (QObject *parent=NULL)"
  19. .br
  20. .ti -1c
  21. .RI "virtual \fB~QwtPolarRenderer\fP ()"
  22. .br
  23. .RI "\fIDestructor\&. \fP"
  24. .ti -1c
  25. .RI "void \fBrenderDocument\fP (\fBQwtPolarPlot\fP *, const QString &format, const QSizeF &sizeMM, int resolution=85)"
  26. .br
  27. .ti -1c
  28. .RI "void \fBrenderDocument\fP (\fBQwtPolarPlot\fP *, const QString &title, const QString &format, const QSizeF &sizeMM, int resolution=85)"
  29. .br
  30. .ti -1c
  31. .RI "void \fBrenderTo\fP (\fBQwtPolarPlot\fP *, QPrinter &) const "
  32. .br
  33. .RI "\fIRender the plot to a QPrinter\&. \fP"
  34. .ti -1c
  35. .RI "void \fBrenderTo\fP (\fBQwtPolarPlot\fP *, QPaintDevice &) const "
  36. .br
  37. .RI "\fIRender the plot to a \fCQPaintDevice\fP\&. \fP"
  38. .ti -1c
  39. .RI "virtual void \fBrender\fP (\fBQwtPolarPlot\fP *, QPainter *, const QRectF &rect) const "
  40. .br
  41. .RI "\fIRender the plot to a given rectangle ( f\&.e QPrinter, QSvgRenderer ) \fP"
  42. .ti -1c
  43. .RI "bool \fBexportTo\fP (\fBQwtPolarPlot\fP *, const QString &documentName, const QSizeF &sizeMM=QSizeF(200, 200), int resolution=85)"
  44. .br
  45. .RI "\fIExecute a file dialog and render the plot to the selected file\&. \fP"
  46. .ti -1c
  47. .RI "virtual void \fBrenderTitle\fP (QPainter *, const QRectF &) const "
  48. .br
  49. .ti -1c
  50. .RI "virtual void \fBrenderLegend\fP (const \fBQwtPolarPlot\fP *, QPainter *, const QRectF &) const "
  51. .br
  52. .in -1c
  53. .SH "Detailed Description"
  54. .PP
  55. Renderer for exporting a polar plot to a document, a printer or anything else, that is supported by QPainter/QPaintDevice\&.
  56. .SH "Constructor & Destructor Documentation"
  57. .PP
  58. .SS "QwtPolarRenderer::QwtPolarRenderer (QObject *parent = \fCNULL\fP)\fC [explicit]\fP"
  59. Constructor
  60. .PP
  61. \fBParameters:\fP
  62. .RS 4
  63. \fIparent\fP Parent object
  64. .RE
  65. .PP
  66. .SH "Member Function Documentation"
  67. .PP
  68. .SS "bool QwtPolarRenderer::exportTo (\fBQwtPolarPlot\fP *plot, const QString &documentName, const QSizeF &sizeMM = \fCQSizeF( 200, 200 )\fP, intresolution = \fC85\fP)"
  69. .PP
  70. Execute a file dialog and render the plot to the selected file\&. The document will be rendered in 85 dpi for a size 30x30 cm
  71. .PP
  72. \fBParameters:\fP
  73. .RS 4
  74. \fIplot\fP Plot widget
  75. .br
  76. \fIdocumentName\fP Default document name
  77. .br
  78. \fIsizeMM\fP Size for the document in millimeters\&.
  79. .br
  80. \fIresolution\fP Resolution in dots per Inch (dpi)
  81. .RE
  82. .PP
  83. \fBSee Also:\fP
  84. .RS 4
  85. \fBrenderDocument()\fP
  86. .RE
  87. .PP
  88. .SS "void QwtPolarRenderer::render (\fBQwtPolarPlot\fP *plot, QPainter *painter, const QRectF &plotRect) const\fC [virtual]\fP"
  89. .PP
  90. Render the plot to a given rectangle ( f\&.e QPrinter, QSvgRenderer )
  91. .PP
  92. \fBParameters:\fP
  93. .RS 4
  94. \fIplot\fP Plot widget to be rendered
  95. .br
  96. \fIpainter\fP Painter
  97. .br
  98. \fIplotRect\fP Bounding rectangle for the plot
  99. .RE
  100. .PP
  101. .SS "void QwtPolarRenderer::renderDocument (\fBQwtPolarPlot\fP *plot, const QString &fileName, const QSizeF &sizeMM, intresolution = \fC85\fP)"
  102. Render a polar plot to a file
  103. .PP
  104. The format of the document will be autodetected from the suffix of the filename\&.
  105. .PP
  106. \fBParameters:\fP
  107. .RS 4
  108. \fIplot\fP Plot widget
  109. .br
  110. \fIfileName\fP Path of the file, where the document will be stored
  111. .br
  112. \fIsizeMM\fP Size for the document in millimeters\&.
  113. .br
  114. \fIresolution\fP Resolution in dots per Inch (dpi)
  115. .RE
  116. .PP
  117. .SS "void QwtPolarRenderer::renderDocument (\fBQwtPolarPlot\fP *plot, const QString &fileName, const QString &format, const QSizeF &sizeMM, intresolution = \fC85\fP)"
  118. Render a plot to a file
  119. .PP
  120. Supported formats are:
  121. .PP
  122. .IP "\(bu" 2
  123. pdf
  124. .br
  125. .IP "\(bu" 2
  126. ps
  127. .br
  128. .IP "\(bu" 2
  129. svg
  130. .br
  131. .IP "\(bu" 2
  132. all image formats supported by Qt, see QImageWriter::supportedImageFormats()
  133. .PP
  134. .PP
  135. \fBParameters:\fP
  136. .RS 4
  137. \fIplot\fP Plot widget
  138. .br
  139. \fIfileName\fP Path of the file, where the document will be stored
  140. .br
  141. \fIformat\fP Format for the document
  142. .br
  143. \fIsizeMM\fP Size for the document in millimeters\&.
  144. .br
  145. \fIresolution\fP Resolution in dots per Inch (dpi)
  146. .RE
  147. .PP
  148. \fBSee Also:\fP
  149. .RS 4
  150. \fBrenderTo()\fP, \fBrender()\fP, QwtPainter::setRoundingAlignment()
  151. .RE
  152. .PP
  153. .SS "void QwtPolarRenderer::renderLegend (const \fBQwtPolarPlot\fP *plot, QPainter *painter, const QRectF &rect) const\fC [virtual]\fP"
  154. Render the legend into a given rectangle\&.
  155. .PP
  156. \fBParameters:\fP
  157. .RS 4
  158. \fIplot\fP Plot widget
  159. .br
  160. \fIpainter\fP Painter
  161. .br
  162. \fIrect\fP Bounding rectangle
  163. .RE
  164. .PP
  165. .SS "void QwtPolarRenderer::renderTitle (QPainter *painter, const QRectF &rect) const\fC [virtual]\fP"
  166. Render the title into a given rectangle\&.
  167. .PP
  168. \fBParameters:\fP
  169. .RS 4
  170. \fIpainter\fP Painter
  171. .br
  172. \fIrect\fP Bounding rectangle
  173. .RE
  174. .PP
  175. .SS "void QwtPolarRenderer::renderTo (\fBQwtPolarPlot\fP *plot, QPrinter &printer) const"
  176. .PP
  177. Render the plot to a QPrinter\&. This function renders the contents of a \fBQwtPolarPlot\fP instance to \fCQPaintDevice\fP object\&. The size is derived from the printer metrics\&.
  178. .PP
  179. \fBParameters:\fP
  180. .RS 4
  181. \fIplot\fP Plot to be rendered
  182. .br
  183. \fIprinter\fP Printer to paint on
  184. .RE
  185. .PP
  186. \fBSee Also:\fP
  187. .RS 4
  188. \fBrenderDocument()\fP, \fBrender()\fP, QwtPainter::setRoundingAlignment()
  189. .RE
  190. .PP
  191. .SS "void QwtPolarRenderer::renderTo (\fBQwtPolarPlot\fP *plot, QPaintDevice &paintDevice) const"
  192. .PP
  193. Render the plot to a \fCQPaintDevice\fP\&. This function renders the contents of a \fBQwtPolarPlot\fP instance to \fCQPaintDevice\fP object\&. The target rectangle is derived from its device metrics\&.
  194. .PP
  195. \fBParameters:\fP
  196. .RS 4
  197. \fIplot\fP Plot to be rendered
  198. .br
  199. \fIpaintDevice\fP device to paint on, f\&.e a QImage
  200. .RE
  201. .PP
  202. \fBSee Also:\fP
  203. .RS 4
  204. \fBrenderDocument()\fP, \fBrender()\fP, QwtPainter::setRoundingAlignment()
  205. .RE
  206. .PP
  207. .SH "Author"
  208. .PP
  209. Generated automatically by Doxygen for Qwt Polar User's Guide from the source code\&.