~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtTextLabel.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "QwtTextLabel" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtTextLabel \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by \fBQwtLegendItem\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
A Widget which displays a \fBQwtText\fP. 
 
14
.PP
 
15
Definition at line 25 of file qwt_text_label.h.
 
16
.SS "Public Slots"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "void \fBsetText\fP (const QString &, \fBQwtText::TextFormat\fP textFormat=QwtText::AutoText)"
 
21
.br
 
22
.ti -1c
 
23
.RI "virtual void \fBsetText\fP (const \fBQwtText\fP &)"
 
24
.br
 
25
.ti -1c
 
26
.RI "void \fBclear\fP ()"
 
27
.br
 
28
.in -1c
 
29
.SS "Public Member Functions"
 
30
 
 
31
.in +1c
 
32
.ti -1c
 
33
.RI "\fBQwtTextLabel\fP (QWidget *parent=NULL)"
 
34
.br
 
35
.ti -1c
 
36
.RI "\fBQwtTextLabel\fP (const \fBQwtText\fP &, QWidget *parent=NULL)"
 
37
.br
 
38
.ti -1c
 
39
.RI "virtual \fB~QwtTextLabel\fP ()"
 
40
.br
 
41
.ti -1c
 
42
.RI "const \fBQwtText\fP & \fBtext\fP () const "
 
43
.br
 
44
.ti -1c
 
45
.RI "int \fBindent\fP () const "
 
46
.br
 
47
.ti -1c
 
48
.RI "void \fBsetIndent\fP (int)"
 
49
.br
 
50
.ti -1c
 
51
.RI "int \fBmargin\fP () const "
 
52
.br
 
53
.ti -1c
 
54
.RI "void \fBsetMargin\fP (int)"
 
55
.br
 
56
.ti -1c
 
57
.RI "virtual QSize \fBsizeHint\fP () const "
 
58
.br
 
59
.ti -1c
 
60
.RI "virtual QSize \fBminimumSizeHint\fP () const "
 
61
.br
 
62
.ti -1c
 
63
.RI "virtual int \fBheightForWidth\fP (int) const "
 
64
.br
 
65
.ti -1c
 
66
.RI "QRect \fBtextRect\fP () const "
 
67
.br
 
68
.in -1c
 
69
.SS "Protected Member Functions"
 
70
 
 
71
.in +1c
 
72
.ti -1c
 
73
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *e)"
 
74
.br
 
75
.ti -1c
 
76
.RI "virtual void \fBdrawContents\fP (QPainter *)"
 
77
.br
 
78
.ti -1c
 
79
.RI "virtual void \fBdrawText\fP (QPainter *, const QRect &)"
 
80
.br
 
81
.in -1c
 
82
.SH "Constructor & Destructor Documentation"
 
83
.PP 
 
84
.SS "QwtTextLabel::QwtTextLabel (QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
85
.PP
 
86
Constructs an empty label. 
 
87
.PP
 
88
\fBParameters:\fP
 
89
.RS 4
 
90
\fIparent\fP Parent widget 
 
91
.RE
 
92
.PP
 
93
 
 
94
.PP
 
95
Definition at line 36 of file qwt_text_label.cpp.
 
96
.SS "QwtTextLabel::QwtTextLabel (const \fBQwtText\fP & text, QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
97
.PP
 
98
Constructs a label that displays the text, text 
 
99
.PP
 
100
\fBParameters:\fP
 
101
.RS 4
 
102
\fIparent\fP Parent widget 
 
103
.br
 
104
\fItext\fP Text 
 
105
.RE
 
106
.PP
 
107
 
 
108
.PP
 
109
Definition at line 60 of file qwt_text_label.cpp.
 
110
.PP
 
111
References text().
 
112
.SS "QwtTextLabel::~QwtTextLabel ()\fC [virtual]\fP"
 
113
.PP
 
114
Destructor. 
 
115
.PP
 
116
Definition at line 68 of file qwt_text_label.cpp.
 
117
.SH "Member Function Documentation"
 
118
.PP 
 
119
.SS "void QwtTextLabel::clear ()\fC [slot]\fP"
 
120
.PP
 
121
Clear the text and all \fBQwtText\fP attributes. 
 
122
.PP
 
123
Definition at line 113 of file qwt_text_label.cpp.
 
124
.SS "void QwtTextLabel::drawContents (QPainter *)\fC [protected, virtual]\fP"
 
125
.PP
 
126
Redraw the text and focus indicator. 
 
127
.PP
 
128
Definition at line 241 of file qwt_text_label.cpp.
 
129
.PP
 
130
References QwtPainter::drawFocusRect(), drawText(), margin(), and textRect().
 
131
.PP
 
132
Referenced by paintEvent(), and QwtLegendItem::paintEvent().
 
133
.SS "void QwtTextLabel::drawText (QPainter *, const QRect &)\fC [protected, virtual]\fP"
 
134
.PP
 
135
Redraw the text. 
 
136
.PP
 
137
Reimplemented in \fBQwtLegendItem\fP.
 
138
.PP
 
139
Definition at line 270 of file qwt_text_label.cpp.
 
140
.PP
 
141
Referenced by drawContents(), and QwtLegendItem::drawText().
 
142
.SS "int QwtTextLabel::heightForWidth (int width) const\fC [virtual]\fP"
 
143
.PP
 
144
Returns the preferred height for this widget, given the width. 
 
145
.PP
 
146
\fBParameters:\fP
 
147
.RS 4
 
148
\fIwidth\fP Width 
 
149
.RE
 
150
.PP
 
151
 
 
152
.PP
 
153
Definition at line 196 of file qwt_text_label.cpp.
 
154
.PP
 
155
References indent().
 
156
.SS "int QwtTextLabel::indent () const"
 
157
.PP
 
158
Return label's text indent in pixels. 
 
159
.PP
 
160
Definition at line 122 of file qwt_text_label.cpp.
 
161
.PP
 
162
Referenced by heightForWidth(), and minimumSizeHint().
 
163
.SS "int QwtTextLabel::margin () const"
 
164
.PP
 
165
Return label's text indent in pixels. 
 
166
.PP
 
167
Definition at line 143 of file qwt_text_label.cpp.
 
168
.PP
 
169
Referenced by drawContents(), QwtLegendItem::drawItem(), QwtLegendItem::paintEvent(), QwtLegendItem::setIdentfierWidth(), and QwtLegendItem::setSpacing().
 
170
.SS "QSize QwtTextLabel::minimumSizeHint () const\fC [virtual]\fP"
 
171
.PP
 
172
Return a minimum size hint. 
 
173
.PP
 
174
Definition at line 167 of file qwt_text_label.cpp.
 
175
.PP
 
176
References indent().
 
177
.PP
 
178
Referenced by sizeHint().
 
179
.SS "void QwtTextLabel::paintEvent (QPaintEvent * e)\fC [protected, virtual]\fP"
 
180
.PP
 
181
Qt paint event. 
 
182
.PP
 
183
Reimplemented in \fBQwtLegendItem\fP.
 
184
.PP
 
185
Definition at line 218 of file qwt_text_label.cpp.
 
186
.PP
 
187
References drawContents().
 
188
.SS "void QwtTextLabel::setIndent (int indent)"
 
189
.PP
 
190
Set label's text indent in pixels 
 
191
.PP
 
192
\fBParameters:\fP
 
193
.RS 4
 
194
\fIindent\fP Indentation in pixels 
 
195
.RE
 
196
.PP
 
197
 
 
198
.PP
 
199
Definition at line 131 of file qwt_text_label.cpp.
 
200
.PP
 
201
Referenced by QwtLegendItem::setIdentfierWidth(), and QwtLegendItem::setSpacing().
 
202
.SS "void QwtTextLabel::setMargin (int margin)"
 
203
.PP
 
204
Set label's margin in pixels 
 
205
.PP
 
206
\fBParameters:\fP
 
207
.RS 4
 
208
\fImargin\fP Margin in pixels 
 
209
.RE
 
210
.PP
 
211
 
 
212
.PP
 
213
Definition at line 152 of file qwt_text_label.cpp.
 
214
.PP
 
215
Referenced by QwtLegendItem::setItemMode().
 
216
.SS "void QwtTextLabel::setText (const \fBQwtText\fP & text)\fC [virtual, slot]\fP"
 
217
.PP
 
218
Change the label's text 
 
219
.PP
 
220
\fBParameters:\fP
 
221
.RS 4
 
222
\fItext\fP New text 
 
223
.RE
 
224
.PP
 
225
 
 
226
.PP
 
227
Reimplemented in \fBQwtLegendItem\fP.
 
228
.PP
 
229
Definition at line 98 of file qwt_text_label.cpp.
 
230
.PP
 
231
References text().
 
232
.SS "void QwtTextLabel::setText (const QString & text, \fBQwtText::TextFormat\fP textFormat = \fCQwtText::AutoText\fP)\fC [slot]\fP"
 
233
.PP
 
234
Change the label's text, keeping all other \fBQwtText\fP attributes 
 
235
.PP
 
236
\fBParameters:\fP
 
237
.RS 4
 
238
\fItext\fP New text 
 
239
.br
 
240
\fItextFormat\fP Format of text
 
241
.RE
 
242
.PP
 
243
\fBSee also:\fP
 
244
.RS 4
 
245
\fBQwtText\fP 
 
246
.RE
 
247
.PP
 
248
 
 
249
.PP
 
250
Definition at line 86 of file qwt_text_label.cpp.
 
251
.PP
 
252
Referenced by QwtLegendItem::setText().
 
253
.SS "QSize QwtTextLabel::sizeHint () const\fC [virtual]\fP"
 
254
.PP
 
255
Return label's margin in pixels. 
 
256
.PP
 
257
Reimplemented in \fBQwtLegendItem\fP.
 
258
.PP
 
259
Definition at line 161 of file qwt_text_label.cpp.
 
260
.PP
 
261
References minimumSizeHint().
 
262
.PP
 
263
Referenced by QwtLegendItem::sizeHint().
 
264
.SS "const \fBQwtText\fP & QwtTextLabel::text () const"
 
265
.PP
 
266
Return the text. 
 
267
.PP
 
268
Definition at line 107 of file qwt_text_label.cpp.
 
269
.PP
 
270
Referenced by QwtLegendItem::drawItem(), QwtPlot::printTitle(), QwtLegendItem::QwtLegendItem(), QwtTextLabel(), QwtPlotPrintFilter::reset(), setText(), and QwtLegendItem::setText().
 
271
.SS "QRect QwtTextLabel::textRect () const"
 
272
.PP
 
273
Calculate the rect for the text in widget coordinates 
 
274
.PP
 
275
\fBReturns:\fP
 
276
.RS 4
 
277
Text rect 
 
278
.RE
 
279
.PP
 
280
 
 
281
.PP
 
282
Definition at line 279 of file qwt_text_label.cpp.
 
283
.PP
 
284
Referenced by drawContents().
 
285
 
 
286
.SH "Author"
 
287
.PP 
 
288
Generated automatically by Doxygen for Qwt User's Guide from the source code.