← Back to branch summary

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

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtDynGridLayout.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
http://bugs.debian.org/437877
http://bugs.debian.org/443110
* 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:
qwt-5.0.2/doc/man/man3/QwtDynGridLayout.3
 
1
.TH "QwtDynGridLayout" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtDynGridLayout \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
The \fBQwtDynGridLayout\fP class lays out widgets in a grid, adjusting the number of columns and rows to the current size. 
 
12
 
 
13
\fBQwtDynGridLayout\fP takes the space it gets, divides it up into rows and columns, and puts each of the widgets it manages into the correct cell(s). It lays out as many number of columns as possible (limited by \fBmaxCols()\fP). 
 
14
.PP
 
15
Definition at line 32 of file qwt_dyngrid_layout.h.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtDynGridLayout\fP (QWidget *, int margin=0, int space=-1)"
 
21
.br
 
22
.ti -1c
 
23
.RI "\fBQwtDynGridLayout\fP (int space=-1)"
 
24
.br
 
25
.ti -1c
 
26
.RI "virtual \fB~QwtDynGridLayout\fP ()"
 
27
.br
 
28
.ti -1c
 
29
.RI "virtual void \fBinvalidate\fP ()"
 
30
.br
 
31
.ti -1c
 
32
.RI "void \fBsetMaxCols\fP (uint maxCols)"
 
33
.br
 
34
.ti -1c
 
35
.RI "uint \fBmaxCols\fP () const "
 
36
.br
 
37
.ti -1c
 
38
.RI "uint \fBnumRows\fP () const "
 
39
.br
 
40
.ti -1c
 
41
.RI "uint \fBnumCols\fP () const "
 
42
.br
 
43
.ti -1c
 
44
.RI "virtual void \fBaddItem\fP (QLayoutItem *)"
 
45
.br
 
46
.ti -1c
 
47
.RI "virtual QLayoutItem * \fBitemAt\fP (int index) const "
 
48
.br
 
49
.ti -1c
 
50
.RI "virtual QLayoutItem * \fBtakeAt\fP (int index)"
 
51
.br
 
52
.ti -1c
 
53
.RI "virtual int \fBcount\fP () const "
 
54
.br
 
55
.ti -1c
 
56
.RI "void \fBsetExpandingDirections\fP (Qt::Orientations)"
 
57
.br
 
58
.ti -1c
 
59
.RI "virtual Qt::Orientations \fBexpandingDirections\fP () const "
 
60
.br
 
61
.ti -1c
 
62
.RI "QList< QRect > \fBlayoutItems\fP (const QRect &, uint numCols) const "
 
63
.br
 
64
.ti -1c
 
65
.RI "virtual int \fBmaxItemWidth\fP () const "
 
66
.br
 
67
.ti -1c
 
68
.RI "virtual void \fBsetGeometry\fP (const QRect &rect)"
 
69
.br
 
70
.ti -1c
 
71
.RI "virtual bool \fBhasHeightForWidth\fP () const "
 
72
.br
 
73
.ti -1c
 
74
.RI "virtual int \fBheightForWidth\fP (int) const "
 
75
.br
 
76
.ti -1c
 
77
.RI "virtual QSize \fBsizeHint\fP () const "
 
78
.br
 
79
.ti -1c
 
80
.RI "virtual bool \fBisEmpty\fP () const "
 
81
.br
 
82
.ti -1c
 
83
.RI "uint \fBitemCount\fP () const "
 
84
.br
 
85
.ti -1c
 
86
.RI "virtual uint \fBcolumnsForWidth\fP (int width) const "
 
87
.br
 
88
.in -1c
 
89
.SS "Protected Member Functions"
 
90
 
 
91
.in +1c
 
92
.ti -1c
 
93
.RI "void \fBlayoutGrid\fP (uint numCols, QwtArray< int > &rowHeight, QwtArray< int > &colWidth) const "
 
94
.br
 
95
.ti -1c
 
96
.RI "void \fBstretchGrid\fP (const QRect &rect, uint numCols, QwtArray< int > &rowHeight, QwtArray< int > &colWidth) const "
 
97
.br
 
98
.in -1c
 
99
.SH "Constructor & Destructor Documentation"
 
100
.PP 
 
101
.SS "QwtDynGridLayout::QwtDynGridLayout (QWidget * parent, int margin = \fC0\fP, int spacing = \fC-1\fP)\fC [explicit]\fP"
 
102
.PP
 
103
\fBParameters:\fP
 
104
.RS 4
 
105
\fIparent\fP Parent widget 
 
106
.br
 
107
\fImargin\fP Margin 
 
108
.br
 
109
\fIspacing\fP Spacing 
 
110
.RE
 
111
.PP
 
112
 
 
113
.PP
 
114
Definition at line 107 of file qwt_dyngrid_layout.cpp.
 
115
.SS "QwtDynGridLayout::QwtDynGridLayout (int spacing = \fC-1\fP)\fC [explicit]\fP"
 
116
.PP
 
117
\fBParameters:\fP
 
118
.RS 4
 
119
\fIspacing\fP Spacing 
 
120
.RE
 
121
.PP
 
122
 
 
123
.PP
 
124
Definition at line 133 of file qwt_dyngrid_layout.cpp.
 
125
.SS "QwtDynGridLayout::~QwtDynGridLayout ()\fC [virtual]\fP"
 
126
.PP
 
127
Destructor. 
 
128
.PP
 
129
Definition at line 158 of file qwt_dyngrid_layout.cpp.
 
130
.SH "Member Function Documentation"
 
131
.PP 
 
132
.SS "void QwtDynGridLayout::addItem (QLayoutItem *)\fC [virtual]\fP"
 
133
.PP
 
134
Adds item to the next free position. 
 
135
.PP
 
136
Definition at line 212 of file qwt_dyngrid_layout.cpp.
 
137
.PP
 
138
References invalidate().
 
139
.SS "uint QwtDynGridLayout::columnsForWidth (int width) const\fC [virtual]\fP"
 
140
.PP
 
141
Calculate the number of columns for a given width. It tries to use as many columns as possible (limited by \fBmaxCols()\fP)
 
142
.PP
 
143
\fBParameters:\fP
 
144
.RS 4
 
145
\fIwidth\fP Available width for all columns 
 
146
.RE
 
147
.PP
 
148
\fBSee also:\fP
 
149
.RS 4
 
150
\fBQwtDynGridLayout::maxCols()\fP, \fBQwtDynGridLayout::setMaxCols()\fP 
 
151
.RE
 
152
.PP
 
153
 
 
154
.PP
 
155
Definition at line 353 of file qwt_dyngrid_layout.cpp.
 
156
.PP
 
157
References isEmpty(), itemCount(), maxCols(), and numCols().
 
158
.PP
 
159
Referenced by heightForWidth(), QwtPlot::printLegend(), and setGeometry().
 
160
.SS "bool QwtDynGridLayout::hasHeightForWidth () const\fC [virtual]\fP"
 
161
.PP
 
162
\fBReturns:\fP
 
163
.RS 4
 
164
true: \fBQwtDynGridLayout\fP implements heightForWidth. 
 
165
.RE
 
166
.PP
 
167
\fBSee also:\fP
 
168
.RS 4
 
169
\fBQwtDynGridLayout::heightForWidth()\fP 
 
170
.RE
 
171
.PP
 
172
 
 
173
.PP
 
174
Definition at line 547 of file qwt_dyngrid_layout.cpp.
 
175
.SS "int QwtDynGridLayout::heightForWidth (int width) const\fC [virtual]\fP"
 
176
.PP
 
177
\fBReturns:\fP
 
178
.RS 4
 
179
The preferred height for this layout, given the width w. 
 
180
.RE
 
181
.PP
 
182
\fBSee also:\fP
 
183
.RS 4
 
184
\fBQwtDynGridLayout::hasHeightForWidth()\fP 
 
185
.RE
 
186
.PP
 
187
 
 
188
.PP
 
189
Definition at line 557 of file qwt_dyngrid_layout.cpp.
 
190
.PP
 
191
References columnsForWidth(), isEmpty(), itemCount(), layoutGrid(), and numRows().
 
192
.SS "bool QwtDynGridLayout::isEmpty () const\fC [virtual]\fP"
 
193
.PP
 
194
\fBReturns:\fP
 
195
.RS 4
 
196
true if this layout is empty. 
 
197
.RE
 
198
.PP
 
199
 
 
200
.PP
 
201
Definition at line 222 of file qwt_dyngrid_layout.cpp.
 
202
.PP
 
203
Referenced by columnsForWidth(), heightForWidth(), maxItemWidth(), setGeometry(), sizeHint(), and stretchGrid().
 
204
.SS "uint QwtDynGridLayout::itemCount () const"
 
205
.PP
 
206
\fBReturns:\fP
 
207
.RS 4
 
208
number of layout items 
 
209
.RE
 
210
.PP
 
211
 
 
212
.PP
 
213
Definition at line 231 of file qwt_dyngrid_layout.cpp.
 
214
.PP
 
215
Referenced by columnsForWidth(), heightForWidth(), setGeometry(), and sizeHint().
 
216
.SS "void QwtDynGridLayout::layoutGrid (uint numCols, QwtArray< int > & rowHeight, QwtArray< int > & colWidth) const\fC [protected]\fP"
 
217
.PP
 
218
Calculate the dimensions for the columns and rows for a grid of numCols columns. 
 
219
.PP
 
220
\fBParameters:\fP
 
221
.RS 4
 
222
\fInumCols\fP Number of columns. 
 
223
.br
 
224
\fIrowHeight\fP Array where to fill in the calculated row heights. 
 
225
.br
 
226
\fIcolWidth\fP Array where to fill in the calculated column widths. 
 
227
.RE
 
228
.PP
 
229
 
 
230
.PP
 
231
Definition at line 518 of file qwt_dyngrid_layout.cpp.
 
232
.PP
 
233
Referenced by heightForWidth(), and sizeHint().
 
234
.SS "QList< QRect > QwtDynGridLayout::layoutItems (const QRect & rect, uint numCols) const"
 
235
.PP
 
236
Calculate the geometries of the layout items for a layout with numCols columns and a given rect. 
 
237
.PP
 
238
\fBParameters:\fP
 
239
.RS 4
 
240
\fIrect\fP Rect where to place the items 
 
241
.br
 
242
\fInumCols\fP Number of columns 
 
243
.RE
 
244
.PP
 
245
\fBReturns:\fP
 
246
.RS 4
 
247
item geometries 
 
248
.RE
 
249
.PP
 
250
 
 
251
.PP
 
252
Definition at line 440 of file qwt_dyngrid_layout.cpp.
 
253
.PP
 
254
References d_data.
 
255
.PP
 
256
Referenced by QwtPlot::printLegend(), and setGeometry().
 
257
.SS "uint QwtDynGridLayout::maxCols () const"
 
258
.PP
 
259
Return the upper limit for the number of columns. 0 means unlimited, what is the default. 
 
260
.PP
 
261
\fBSee also:\fP
 
262
.RS 4
 
263
\fBQwtDynGridLayout::setMaxCols()\fP 
 
264
.RE
 
265
.PP
 
266
 
 
267
.PP
 
268
Definition at line 205 of file qwt_dyngrid_layout.cpp.
 
269
.PP
 
270
Referenced by columnsForWidth().
 
271
.SS "int QwtDynGridLayout::maxItemWidth () const\fC [virtual]\fP"
 
272
.PP
 
273
\fBReturns:\fP
 
274
.RS 4
 
275
the maximum width of all layout items 
 
276
.RE
 
277
.PP
 
278
 
 
279
.PP
 
280
Definition at line 409 of file qwt_dyngrid_layout.cpp.
 
281
.PP
 
282
References isEmpty().
 
283
.SS "uint QwtDynGridLayout::numCols () const"
 
284
.PP
 
285
\fBReturns:\fP
 
286
.RS 4
 
287
Number of columns of the current layout. 
 
288
.RE
 
289
.PP
 
290
\fBSee also:\fP
 
291
.RS 4
 
292
\fBQwtDynGridLayout::numRows\fP 
 
293
.RE
 
294
.PP
 
295
\fBWarning:\fP
 
296
.RS 4
 
297
The number of columns might change whenever the geometry changes 
 
298
.RE
 
299
.PP
 
300
 
 
301
.PP
 
302
Definition at line 688 of file qwt_dyngrid_layout.cpp.
 
303
.PP
 
304
Referenced by columnsForWidth().
 
305
.SS "uint QwtDynGridLayout::numRows () const"
 
306
.PP
 
307
\fBReturns:\fP
 
308
.RS 4
 
309
Number of rows of the current layout. 
 
310
.RE
 
311
.PP
 
312
\fBSee also:\fP
 
313
.RS 4
 
314
\fBQwtDynGridLayout::numCols\fP 
 
315
.RE
 
316
.PP
 
317
\fBWarning:\fP
 
318
.RS 4
 
319
The number of rows might change whenever the geometry changes 
 
320
.RE
 
321
.PP
 
322
 
 
323
.PP
 
324
Definition at line 678 of file qwt_dyngrid_layout.cpp.
 
325
.PP
 
326
Referenced by heightForWidth(), and sizeHint().
 
327
.SS "void QwtDynGridLayout::setGeometry (const QRect & rect)\fC [virtual]\fP"
 
328
.PP
 
329
Reorganizes columns and rows and resizes managed widgets within the rectangle rect. 
 
330
.PP
 
331
Definition at line 314 of file qwt_dyngrid_layout.cpp.
 
332
.PP
 
333
References columnsForWidth(), isEmpty(), itemCount(), and layoutItems().
 
334
.SS "void QwtDynGridLayout::setMaxCols (uint maxCols)"
 
335
.PP
 
336
Limit the number of columns. 
 
337
.PP
 
338
\fBParameters:\fP
 
339
.RS 4
 
340
\fImaxCols\fP upper limit, 0 means unlimited 
 
341
.RE
 
342
.PP
 
343
\fBSee also:\fP
 
344
.RS 4
 
345
\fBQwtDynGridLayout::maxCols()\fP 
 
346
.RE
 
347
.PP
 
348
 
 
349
.PP
 
350
Definition at line 194 of file qwt_dyngrid_layout.cpp.
 
351
.SS "QSize QwtDynGridLayout::sizeHint () const\fC [virtual]\fP"
 
352
.PP
 
353
Return the size hint. If \fBmaxCols()\fP > 0 it is the size for a grid with \fBmaxCols()\fP columns, otherwise it is the size for a grid with only one row. 
 
354
.PP
 
355
\fBSee also:\fP
 
356
.RS 4
 
357
\fBQwtDynGridLayout::maxCols()\fP, \fBQwtDynGridLayout::setMaxCols()\fP 
 
358
.RE
 
359
.PP
 
360
 
 
361
.PP
 
362
Definition at line 647 of file qwt_dyngrid_layout.cpp.
 
363
.PP
 
364
References isEmpty(), itemCount(), layoutGrid(), and numRows().
 
365
.SS "void QwtDynGridLayout::stretchGrid (const QRect & rect, uint numCols, QwtArray< int > & rowHeight, QwtArray< int > & colWidth) const\fC [protected]\fP"
 
366
.PP
 
367
Stretch columns in case of expanding() & QSizePolicy::Horizontal and rows in case of expanding() & QSizePolicy::Vertical to fill the entire rect. Rows and columns are stretched with the same factor. 
 
368
.PP
 
369
\fBSee also:\fP
 
370
.RS 4
 
371
QwtDynGridLayout::setExpanding(), QwtDynGridLayout::expanding() 
 
372
.RE
 
373
.PP
 
374
 
 
375
.PP
 
376
Definition at line 586 of file qwt_dyngrid_layout.cpp.
 
377
.PP
 
378
References expandingDirections(), and isEmpty().
 
379
 
 
380
.SH "Author"
 
381
.PP 
 
382
Generated automatically by Doxygen for Qwt User's Guide from the source code.