~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.0/doc/man/man3/QwtPlotPrintFilter.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2008-05-26 10:26:31 UTC
  • mfrom: (1.1.3 upstream) (2.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080526102631-bp95mfccnrb957nx
Tags: 5.1.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "QwtPlotPrintFilter" 3 "1 May 2008" "Version 5.1.0" "Qwt User's Guide" \" -*- nroff -*-
2
 
.ad l
3
 
.nh
4
 
.SH NAME
5
 
QwtPlotPrintFilter \- 
6
 
.SH SYNOPSIS
7
 
.br
8
 
.PP
9
 
.SH "Detailed Description"
10
 
.PP 
11
 
A base class for plot print filters. 
12
 
 
13
 
A print filter can be used to customize \fBQwtPlot::print()\fP.
14
 
.PP
15
 
\fBDeprecated\fP
16
 
.RS 4
17
 
In Qwt 5.0 the design of \fBQwtPlot\fP allows/recommends writing individual QwtPlotItems, that are not known to \fBQwtPlotPrintFilter\fP. So this concept is outdated and \fBQwtPlotPrintFilter\fP will be removed/replaced in Qwt 6.x. 
18
 
.RE
19
 
.PP
20
 
 
21
 
.PP
22
 
Definition at line 30 of file qwt_plot_printfilter.h.
23
 
.SS "Public Types"
24
 
 
25
 
.in +1c
26
 
.ti -1c
27
 
.RI "enum \fBOptions\fP { \fBAlignScales\fP =  1, \fBIgnoreScrollbars\fP =  2, \fBIgnoreFrames\fP =  4, \fBIgnoreMargin\fP =  8, \fBIgnoreLegend\fP =  16, \fBPrintMargin\fP =  1, \fBPrintTitle\fP =  2, \fBPrintLegend\fP =  4, \fBPrintGrid\fP =  8, \fBPrintBackground\fP =  16, \fBPrintFrameWithScales\fP =  32, \fBPrintAll\fP =  ~PrintFrameWithScales }"
28
 
.br
29
 
.ti -1c
30
 
.RI "enum \fBItem\fP { \fBTitle\fP, \fBLegend\fP, \fBCurve\fP, \fBCurveSymbol\fP, \fBMarker\fP, \fBMarkerSymbol\fP, \fBMajorGrid\fP, \fBMinorGrid\fP, \fBCanvasBackground\fP, \fBAxisScale\fP, \fBAxisTitle\fP, \fBWidgetBackground\fP }"
31
 
.br
32
 
.in -1c
33
 
.SS "Public Member Functions"
34
 
 
35
 
.in +1c
36
 
.ti -1c
37
 
.RI "\fBQwtPlotPrintFilter\fP ()"
38
 
.br
39
 
.ti -1c
40
 
.RI "virtual \fB~QwtPlotPrintFilter\fP ()"
41
 
.br
42
 
.ti -1c
43
 
.RI "virtual QColor \fBcolor\fP (const QColor &, \fBItem\fP item) const"
44
 
.br
45
 
.ti -1c
46
 
.RI "virtual QFont \fBfont\fP (const QFont &, \fBItem\fP item) const"
47
 
.br
48
 
.ti -1c
49
 
.RI "void \fBsetOptions\fP (int options)"
50
 
.br
51
 
.ti -1c
52
 
.RI "int \fBoptions\fP () const"
53
 
.br
54
 
.ti -1c
55
 
.RI "virtual void \fBapply\fP (\fBQwtPlot\fP *) const"
56
 
.br
57
 
.ti -1c
58
 
.RI "virtual void \fBreset\fP (\fBQwtPlot\fP *) const"
59
 
.br
60
 
.ti -1c
61
 
.RI "virtual void \fBapply\fP (\fBQwtPlotItem\fP *) const "
62
 
.br
63
 
.ti -1c
64
 
.RI "virtual void \fBreset\fP (\fBQwtPlotItem\fP *) const "
65
 
.br
66
 
.in -1c
67
 
.SH "Member Enumeration Documentation"
68
 
.PP 
69
 
.SS "enum \fBQwtPlotPrintFilter::Options\fP"
70
 
.PP
71
 
Print options. 
72
 
.PP
73
 
Definition at line 34 of file qwt_plot_printfilter.h.
74
 
.SS "enum \fBQwtPlotPrintFilter::Item\fP"
75
 
.PP
76
 
Print items. 
77
 
.PP
78
 
Definition at line 47 of file qwt_plot_printfilter.h.
79
 
.SH "Constructor & Destructor Documentation"
80
 
.PP 
81
 
.SS "QwtPlotPrintFilter::QwtPlotPrintFilter ()\fC [explicit]\fP"
82
 
.PP
83
 
Sets filter options to PrintAll 
84
 
.PP
85
 
Definition at line 82 of file qwt_plot_printfilter.cpp.
86
 
.SS "QwtPlotPrintFilter::~QwtPlotPrintFilter ()\fC [virtual]\fP"
87
 
.PP
88
 
Destructor. 
89
 
.PP
90
 
Definition at line 88 of file qwt_plot_printfilter.cpp.
91
 
.SH "Member Function Documentation"
92
 
.PP 
93
 
.SS "QColor QwtPlotPrintFilter::color (const QColor & c, \fBItem\fP item) const\fC [virtual]\fP"
94
 
.PP
95
 
Modifies a color for printing. 
96
 
.PP
97
 
\fBParameters:\fP
98
 
.RS 4
99
 
\fIc\fP Color to be modified 
100
 
.br
101
 
\fIitem\fP Type of item where the color belongs 
102
 
.RE
103
 
.PP
104
 
\fBReturns:\fP
105
 
.RS 4
106
 
Modified color.
107
 
.RE
108
 
.PP
109
 
In case of !(\fBQwtPlotPrintFilter::options()\fP & PrintBackground) MajorGrid is modified to Qt::darkGray, MinorGrid to Qt::gray. All other colors are returned unmodified. 
110
 
.PP
111
 
Definition at line 124 of file qwt_plot_printfilter.cpp.
112
 
.PP
113
 
References options().
114
 
.PP
115
 
Referenced by apply().
116
 
.SS "QFont QwtPlotPrintFilter::font (const QFont & f, \fBItem\fP item) const\fC [virtual]\fP"
117
 
.PP
118
 
Modifies a font for printing. 
119
 
.PP
120
 
\fBParameters:\fP
121
 
.RS 4
122
 
\fIf\fP Font to be modified 
123
 
.br
124
 
\fIitem\fP Type of item where the font belongs
125
 
.RE
126
 
.PP
127
 
All fonts are returned unmodified 
128
 
.PP
129
 
Definition at line 148 of file qwt_plot_printfilter.cpp.
130
 
.PP
131
 
Referenced by apply().
132
 
.SS "void QwtPlotPrintFilter::setOptions (int options)"
133
 
.PP
134
 
Set plot print options. 
135
 
.PP
136
 
\fBParameters:\fP
137
 
.RS 4
138
 
\fIoptions\fP Or'd \fBQwtPlotPrintFilter::Options\fP values
139
 
.RE
140
 
.PP
141
 
\fBSee also:\fP
142
 
.RS 4
143
 
\fBoptions()\fP 
144
 
.RE
145
 
.PP
146
 
 
147
 
.PP
148
 
Definition at line 99 of file qwt_plot_printfilter.cpp.
149
 
.SS "int QwtPlotPrintFilter::options () const"
150
 
.PP
151
 
Get plot print options. 
152
 
.PP
153
 
\fBSee also:\fP
154
 
.RS 4
155
 
\fBsetOptions()\fP 
156
 
.RE
157
 
.PP
158
 
 
159
 
.PP
160
 
Definition at line 108 of file qwt_plot_printfilter.cpp.
161
 
.PP
162
 
Referenced by color(), QwtPlot::drawItems(), QwtPlot::print(), and QwtPlot::printCanvas().
163
 
.SS "void QwtPlotPrintFilter::apply (\fBQwtPlot\fP * plot) const\fC [virtual]\fP"
164
 
.PP
165
 
Change color and fonts of a plot 
166
 
.PP
167
 
\fBSee also:\fP
168
 
.RS 4
169
 
\fBapply\fP 
170
 
.RE
171
 
.PP
172
 
 
173
 
.PP
174
 
Definition at line 157 of file qwt_plot_printfilter.cpp.
175
 
.PP
176
 
References QwtPlot::autoReplot(), QwtPlot::axisWidget(), QwtSymbol::brush(), QwtPlot::canvasBackground(), QwtText::color(), color(), QwtText::font(), font(), QwtPlotDict::itemList(), QwtPlot::legend(), QwtLegend::legendItems(), QwtSymbol::pen(), QwtPlot::setAutoReplot(), QwtSymbol::setBrush(), QwtPlot::setCanvasBackground(), QwtText::setColor(), QwtText::setFont(), QwtSymbol::setPen(), QwtText::testPaintAttribute(), QwtScaleWidget::title(), and QwtPlot::titleLabel().
177
 
.PP
178
 
Referenced by QwtPlot::print().
179
 
.SS "void QwtPlotPrintFilter::reset (\fBQwtPlot\fP * plot) const\fC [virtual]\fP"
180
 
.PP
181
 
Reset color and fonts of a plot 
182
 
.PP
183
 
\fBSee also:\fP
184
 
.RS 4
185
 
\fBapply\fP 
186
 
.RE
187
 
.PP
188
 
 
189
 
.PP
190
 
Definition at line 366 of file qwt_plot_printfilter.cpp.
191
 
.PP
192
 
References QwtPlot::autoReplot(), QwtPlot::axisWidget(), QwtSymbol::brush(), QwtLegend::find(), QwtPlotDict::itemList(), QwtPlot::legend(), QwtLegend::legendItems(), QwtSymbol::pen(), QwtPlot::setAutoReplot(), QwtSymbol::setBrush(), QwtPlot::setCanvasBackground(), QwtText::setColor(), QwtSymbol::setPen(), QwtScaleWidget::setTitle(), QwtTextLabel::text(), and QwtPlot::titleLabel().
193
 
.PP
194
 
Referenced by QwtPlot::print().
195
 
 
196
 
.SH "Author"
197
 
.PP 
198
 
Generated automatically by Doxygen for Qwt User's Guide from the source code.