OpenCoverage

qsizepolicy.cpp

Absolute File Name:

/home/qt/qt5_coco/qt5/qtbase/src/widgets/kernel/qsizepolicy.cpp

Source code

Switch to Preprocessed file

Line Source Count

1 /**************************************************************************** -

2 ** -

4 ** Contact: https://www.qt.io/licensing/ -

5 ** -

6 ** This file is part of the QtWidgets module of the Qt Toolkit. -

7 ** -

8 ** $QT_BEGIN_LICENSE:LGPL$ -

9 ** Commercial License Usage -

10 ** Licensees holding valid commercial Qt licenses may use this file in -

11 ** accordance with the commercial license agreement provided with the -

12 ** Software or, alternatively, in accordance with the terms contained in -

13 ** a written agreement between you and The Qt Company. For licensing terms -

14 ** and conditions see https://www.qt.io/terms-conditions. For further -

15 ** information use the contact form at https://www.qt.io/contact-us. -

16 ** -

17 ** GNU Lesser General Public License Usage -

18 ** Alternatively, this file may be used under the terms of the GNU Lesser -

19 ** General Public License version 3 as published by the Free Software -

20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the -

21 ** packaging of this file. Please review the following information to -

22 ** ensure the GNU Lesser General Public License version 3 requirements -

23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -

24 ** -

25 ** GNU General Public License Usage -

26 ** Alternatively, this file may be used under the terms of the GNU -

27 ** General Public License version 2.0 or (at your option) the GNU General -

28 ** Public license version 3 or any later version approved by the KDE Free -

29 ** Qt Foundation. The licenses are as published by the Free Software -

30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -

31 ** included in the packaging of this file. Please review the following -

32 ** information to ensure the GNU General Public License requirements will -

33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and -

34 ** https://www.gnu.org/licenses/gpl-3.0.html. -

35 ** -

36 ** $QT_END_LICENSE$ -

37 ** -

38 ****************************************************************************/ -

39 -

40 #include "qsizepolicy.h" -

41 -

42 #include <qdatastream.h> -

43 #include <qdebug.h> -

44 #include <qvariant.h> -

45 -

46 QT_BEGIN_NAMESPACE -

47 -

48 /*! -

49 \class QSizePolicy -

50 \brief The QSizePolicy class is a layout attribute describing horizontal -

51 and vertical resizing policy. -

52 -

53 \ingroup geomanagement -

54 \inmodule QtWidgets -

55 -

56 The size policy of a widget is an expression of its willingness to -

57 be resized in various ways, and affects how the widget is treated -

58 by the \l{Layout Management}{layout engine}. Each widget returns a -

59 QSizePolicy that describes the horizontal and vertical resizing -

60 policy it prefers when being laid out. You can change this for -

61 a specific widget by changing its QWidget::sizePolicy property. -

62 -

63 QSizePolicy contains two independent QSizePolicy::Policy values -

64 and two stretch factors; one describes the widgets's horizontal -

65 size policy, and the other describes its vertical size policy. It -

66 also contains a flag to indicate whether the height and width of -

67 its preferred size are related. -

68 -

69 The horizontal and vertical policies can be set in the -

70 constructor, and altered using the setHorizontalPolicy() and -

71 setVerticalPolicy() functions. The stretch factors can be set -

72 using the setHorizontalStretch() and setVerticalStretch() -

73 functions. The flag indicating whether the widget's -

74 \l{QWidget::sizeHint()}{sizeHint()} is width-dependent (such as a -

75 menu bar or a word-wrapping label) can be set using the -

76 setHeightForWidth() function. -

77 -

78 The current size policies and stretch factors be retrieved using -

79 the horizontalPolicy(), verticalPolicy(), horizontalStretch() and -

80 verticalStretch() functions. Alternatively, use the transpose() -

81 function to swap the horizontal and vertical policies and -

82 stretches. The hasHeightForWidth() function returns the current -

83 status of the flag indicating the size hint dependencies. -

84 -

85 Use the expandingDirections() function to determine whether the -

86 associated widget can make use of more space than its -

87 \l{QWidget::sizeHint()}{sizeHint()} function indicates, as well as -

88 find out in which directions it can expand. -

89 -

90 Finally, the QSizePolicy class provides operators comparing this -

91 size policy to a given policy, as well as a QVariant operator -

92 storing this QSizePolicy as a QVariant object. -

93 -

94 \sa QSize, QWidget::sizeHint(), QWidget::sizePolicy, -

95 QLayoutItem::sizeHint() -

96 */ -

97 -

98 /*! -

99 \enum QSizePolicy::PolicyFlag -

100 -

101 These flags are combined together to form the various \l{Policy} -

102 values: -

103 -

104 \value GrowFlag The widget can grow beyond its size hint if necessary. -

105 \value ExpandFlag The widget should get as much space as possible. -

106 \value ShrinkFlag The widget can shrink below its size hint if necessary. -

107 \value IgnoreFlag The widget's size hint is ignored. The widget will get -

108 as much space as possible. -

109 -

110 \sa Policy -

111 */ -

112 -

113 /*! -

114 \enum QSizePolicy::Policy -

115 -

116 This enum describes the various per-dimension sizing types used -

117 when constructing a QSizePolicy. -

118 -

119 \value Fixed The QWidget::sizeHint() is the only acceptable -

120 alternative, so the widget can never grow or shrink (e.g. the -

121 vertical direction of a push button). -

122 -

123 \value Minimum The sizeHint() is minimal, and sufficient. The -

124 widget can be expanded, but there is no advantage to it being -

125 larger (e.g. the horizontal direction of a push button). -

126 It cannot be smaller than the size provided by sizeHint(). -

127 -

128 \value Maximum The sizeHint() is a maximum. The widget can be -

129 shrunk any amount without detriment if other widgets need the -

130 space (e.g. a separator line). -

131 It cannot be larger than the size provided by sizeHint(). -

132 -

133 \value Preferred The sizeHint() is best, but the widget can be -

134 shrunk and still be useful. The widget can be expanded, but there -

135 is no advantage to it being larger than sizeHint() (the default -

136 QWidget policy). -

137 -

138 \value Expanding The sizeHint() is a sensible size, but the -

139 widget can be shrunk and still be useful. The widget can make use -

140 of extra space, so it should get as much space as possible (e.g. -

141 the horizontal direction of a horizontal slider). -

142 -

143 \value MinimumExpanding The sizeHint() is minimal, and sufficient. -

144 The widget can make use of extra space, so it should get as much -

145 space as possible (e.g. the horizontal direction of a horizontal -

146 slider). -

147 -

148 \value Ignored The sizeHint() is ignored. The widget will get as -

149 much space as possible. -

150 -

151 \sa PolicyFlag, setHorizontalPolicy(), setVerticalPolicy() -

152 */ -

153 -

154 /*! -

155 \fn QSizePolicy::QSizePolicy() -

156 -

157 Constructs a QSizePolicy object with \l Fixed as its horizontal -

158 and vertical policies. -

159 -

160 The policies can be altered using the setHorizontalPolicy() and -

161 setVerticalPolicy() functions. Use the setHeightForWidth() -

162 function if the preferred height of the widget is dependent on the -

163 width of the widget (for example, a QLabel with line wrapping). -

164 -

165 \sa setHorizontalStretch(), setVerticalStretch() -

166 */ -

167 -

168 /*! -

169 \fn QSizePolicy::QSizePolicy(Policy horizontal, Policy vertical, ControlType type) -

170 \since 4.3 -

171 -

172 Constructs a QSizePolicy object with the given \a horizontal and -

173 \a vertical policies, and the specified control \a type. -

174 -

175 Use setHeightForWidth() if the preferred height of the widget is -

176 dependent on the width of the widget (for example, a QLabel with -

177 line wrapping). -

178 -

179 \sa setHorizontalStretch(), setVerticalStretch(), controlType() -

180 */ -

181 -

182 /*! -

183 \fn QSizePolicy::Policy QSizePolicy::horizontalPolicy() const -

184 -

185 Returns the horizontal component of the size policy. -

186 -

187 \sa setHorizontalPolicy(), verticalPolicy(), horizontalStretch() -

188 */ -

189 -

190 /*! -

191 \fn QSizePolicy::Policy QSizePolicy::verticalPolicy() const -

192 -

193 Returns the vertical component of the size policy. -

194 -

195 \sa setVerticalPolicy(), horizontalPolicy(), verticalStretch() -

196 */ -

197 -

198 /*! -

199 \fn void QSizePolicy::setHorizontalPolicy(Policy policy) -

200 -

201 Sets the horizontal component to the given \a policy. -

202 -

203 \sa horizontalPolicy(), setVerticalPolicy(), setHorizontalStretch() -

204 */ -

205 -

206 /*! -

207 \fn void QSizePolicy::setVerticalPolicy(Policy policy) -

208 -

209 Sets the vertical component to the given \a policy. -

210 -

211 \sa verticalPolicy(), setHorizontalPolicy(), setVerticalStretch() -

212 */ -

213 -

214 /*! -

215 \fn Qt::Orientations QSizePolicy::expandingDirections() const -

216 -

217 Returns whether a widget can make use of more space than the -

218 QWidget::sizeHint() function indicates. -

219 -

220 A value of Qt::Horizontal or Qt::Vertical means that the widget -

221 can grow horizontally or vertically (i.e., the horizontal or -

222 vertical policy is \l Expanding or \l MinimumExpanding), whereas -

223 Qt::Horizontal | Qt::Vertical means that it can grow in both -

224 dimensions. -

225 -

226 \sa horizontalPolicy(), verticalPolicy() -

227 */ -

228 -

229 /*! -

230 \since 4.3 -

231 -

232 Returns the control type associated with the widget for which -

233 this size policy applies. -

234 */ -

235 QSizePolicy::ControlType QSizePolicy::controlType() const -

236 { -

237

return QSizePolicy::ControlType(1 << bits.ctype);

never executed: return QSizePolicy::ControlType(1 << bits.ctype);

238 } -

239 -

240 -

241 /*! -

242 \since 4.3 -

243 -

244 Sets the control type associated with the widget for which this -

245 size policy applies to \a type. -

246 -

247 The control type specifies the type of the widget for which this -

248 size policy applies. It is used by some styles, notably -

249 QMacStyle, to insert proper spacing between widgets. For example, -

250 the \macos Aqua guidelines specify that push buttons should be -

251 separated by 12 pixels, whereas vertically stacked radio buttons -

252 only require 6 pixels. -

253 -

254 \sa QStyle::layoutSpacing() -

255 */ -

256 void QSizePolicy::setControlType(ControlType type) -

257 { -

258 /* -

259 The control type is a flag type, with values 0x1, 0x2, 0x4, 0x8, 0x10, -

260 etc. In memory, we pack it onto the available bits (CTSize) in -

261 setControlType(), and unpack it here. -

262 -

263 Example: -

264 -

265 0x00000001 maps to 0 -

266 0x00000002 maps to 1 -

267 0x00000004 maps to 2 -

268 0x00000008 maps to 3 -

269 etc. -

270 */ -

271 -

272 int i = 0; -

273 while (true) { -

274

if (type & (0x1 << i)) {

type & (0x1 << i)	Description
TRUE	never evaluated
FALSE	never evaluated

275 bits.ctype = i; -

276

return;

never executed: return;

277 } -

278 ++i; -

279

}

never executed: end of block

280

}

never executed: end of block

281 -

282 /*! -

283 \fn void QSizePolicy::setHeightForWidth(bool dependent) -

284 -

285 Sets the flag determining whether the widget's preferred height -

286 depends on its width, to \a dependent. -

287 -

288 \sa hasHeightForWidth(), setWidthForHeight() -

289 */ -

290 -

291 /*! -

292 \fn bool QSizePolicy::hasHeightForWidth() const -

293 -

294 Returns \c true if the widget's preferred height depends on its -

295 width; otherwise returns \c false. -

296 -

297 \sa setHeightForWidth() -

298 */ -

299 -

300 /*! -

301 \fn void QSizePolicy::setWidthForHeight(bool dependent) -

302 -

303 Sets the flag determining whether the widget's width -

304 depends on its height, to \a dependent. -

305 -

306 This is only supported for QGraphicsLayout's subclasses. -

307 It is not possible to have a layout with both height-for-width -

308 and width-for-height constraints at the same time. -

309 -

310 \sa hasWidthForHeight(), setHeightForWidth() -

311 */ -

312 -

313 /*! -

314 \fn bool QSizePolicy::hasWidthForHeight() const -

315 -

316 Returns \c true if the widget's width depends on its -

317 height; otherwise returns \c false. -

318 -

319 \sa setWidthForHeight() -

320 */ -

321 -

322 /*! -

323 \fn bool QSizePolicy::operator==(const QSizePolicy &other) const -

324 -

325 Returns \c true if this policy is equal to \a other; otherwise -

326 returns \c false. -

327 -

328 \sa operator!=() -

329 */ -

330 -

331 /*! -

332 \fn bool QSizePolicy::operator!=(const QSizePolicy &other) const -

333 -

334 Returns \c true if this policy is different from \a other; otherwise -

335 returns \c false. -

336 -

337 \sa operator==() -

338 */ -

339 -

340 /*! -

341 \fn uint qHash(QSizePolicy key, uint seed = 0) -

342 \since 5.6 -

343 \relates QSizePolicy -

344 -

345 Returns the hash value for \a key, using -

346 \a seed to seed the calculation. -

347 */ -

348 -

349 /*! -

350 \fn int QSizePolicy::horizontalStretch() const -

351 -

352 Returns the horizontal stretch factor of the size policy. -

353 -

354 \sa setHorizontalStretch(), verticalStretch(), horizontalPolicy() -

355 */ -

356 -

357 /*! -

358 \fn int QSizePolicy::verticalStretch() const -

359 -

360 Returns the vertical stretch factor of the size policy. -

361 -

362 \sa setVerticalStretch(), horizontalStretch(), verticalPolicy() -

363 */ -

364 -

365 /*! -

366 \fn void QSizePolicy::setHorizontalStretch(int stretchFactor) -

367 -

368 Sets the horizontal stretch factor of the size policy to the given \a -

369 stretchFactor. \a stretchFactor must be in the range [0,255]. -

370 -

371 When two widgets are adjacent to each other in a horizontal layout, -

372 setting the horizontal stretch factor of the widget on the left to 2 -

373 and the factor of widget on the right to 1 will ensure that the widget -

374 on the left will always be twice the size of the one on the right. -

375 -

376 \sa horizontalStretch(), setVerticalStretch(), setHorizontalPolicy() -

377 */ -

378 -

379 /*! -

380 \fn void QSizePolicy::setVerticalStretch(int stretchFactor) -

381 -

382 Sets the vertical stretch factor of the size policy to the given -

383 \a stretchFactor. \a stretchFactor must be in the range [0,255]. -

384 -

385 When two widgets are adjacent to each other in a vertical layout, -

386 setting the vertical stretch factor of the widget on the top to 2 -

387 and the factor of widget on the bottom to 1 will ensure that -

388 the widget on the top will always be twice the size of the one -

389 on the bottom. -

390 -

391 \sa verticalStretch(), setHorizontalStretch(), setVerticalPolicy() -

392 */ -

393 -

394 /*! -

395 \fn void QSizePolicy::transpose() -

396 -

397 Swaps the horizontal and vertical policies and stretches. -

398 */ -

399 -

400 /*! -

401 \fn void QSizePolicy::retainSizeWhenHidden() const -

402 \since 5.2 -

403 -

404 Returns whether the layout should retain the widget's size when it is hidden. -

405 This is \c false by default. -

406 -

407 \sa setRetainSizeWhenHidden() -

408 */ -

409 -

410 /*! -

411 \fn void QSizePolicy::setRetainSizeWhenHidden(bool retainSize) -

412 \since 5.2 -

413 -

414 Sets whether a layout should retain the widget's size when it is hidden. -

415 If \a retainSize is \c true, the layout will not be changed by hiding the widget. -

416 -

417 \sa retainSizeWhenHidden() -

418 */ -

419 -

420 /*! -

421 \enum QSizePolicy::ControlType -

422 \since 4.3 -

423 -

424 This enum specifies the different types of widgets in terms of -

425 layout interaction: -

426 -

427 \value DefaultType The default type, when none is specified. -

428 \value ButtonBox A QDialogButtonBox instance. -

429 \value CheckBox A QCheckBox instance. -

430 \value ComboBox A QComboBox instance. -

431 \value Frame A QFrame instance. -

432 \value GroupBox A QGroupBox instance. -

433 \value Label A QLabel instance. -

434 \value Line A QFrame instance with QFrame::HLine or QFrame::VLine. -

435 \value LineEdit A QLineEdit instance. -

436 \value PushButton A QPushButton instance. -

437 \value RadioButton A QRadioButton instance. -

438 \value Slider A QAbstractSlider instance. -

439 \value SpinBox A QAbstractSpinBox instance. -

440 \value TabWidget A QTabWidget instance. -

441 \value ToolButton A QToolButton instance. -

442 -

443 \sa setControlType(), controlType() -

444 */ -

445 -

446 /*! -

447 Returns a QVariant storing this QSizePolicy. -

448 */ -

449 QSizePolicy::operator QVariant() const -

450 { -

451

return QVariant(QVariant::SizePolicy, this);

never executed: return QVariant(QVariant::SizePolicy, this);

452 } -

453 -

454 #ifndef QT_NO_DATASTREAM -

455 -

456 /*! -

457 \relates QSizePolicy -

458 \since 4.2 -

459 -

460 Writes the size \a policy to the data stream \a stream. -

461 -

462 \sa{Serializing Qt Data Types}{Format of the QDataStream operators} -

463 */ -

464 QDataStream &operator<<(QDataStream &stream, const QSizePolicy &policy) -

465 { -

466 // The order here is for historical reasons. (compatibility with Qt4) -

467 quint32 data = (policy.bits.horPolicy | // [0, 3] -

468 policy.bits.verPolicy << 4 | // [4, 7] -

469 policy.bits.hfw << 8 | // [8] -

470 policy.bits.ctype << 9 | // [9, 13] -

471 policy.bits.wfh << 14 | // [14] -

472 policy.bits.retainSizeWhenHidden << 15 | // [15] -

473 policy.bits.verStretch << 16 | // [16, 23] -

474 policy.bits.horStretch << 24); // [24, 31] -

475

return stream << data;

never executed: return stream << data;

476 } -

477 -

478 #define VALUE_OF_BITS(data, bitstart, bitcount) ((data >> bitstart) & ((1 << bitcount) -1)) -

479 -

480 /*! -

481 \relates QSizePolicy -

482 \since 4.2 -

483 -

484 Reads the size \a policy from the data stream \a stream. -

485 -

486 \sa{Serializing Qt Data Types}{Format of the QDataStream operators} -

487 */ -

488 QDataStream &operator>>(QDataStream &stream, QSizePolicy &policy) -

489 { -

490 quint32 data; -

491 stream >> data; -

492 policy.bits.horPolicy = VALUE_OF_BITS(data, 0, 4); -

493 policy.bits.verPolicy = VALUE_OF_BITS(data, 4, 4); -

494 policy.bits.hfw = VALUE_OF_BITS(data, 8, 1); -

495 policy.bits.ctype = VALUE_OF_BITS(data, 9, 5); -

496 policy.bits.wfh = VALUE_OF_BITS(data, 14, 1); -

497 policy.bits.retainSizeWhenHidden = VALUE_OF_BITS(data, 15, 1); -

498 policy.bits.verStretch = VALUE_OF_BITS(data, 16, 8); -

499 policy.bits.horStretch = VALUE_OF_BITS(data, 24, 8); -

500

return stream;

never executed: return stream;

501 } -

502 #endif // QT_NO_DATASTREAM -

503 -

504 #ifndef QT_NO_DEBUG_STREAM -

505 QDebug operator<<(QDebug dbg, const QSizePolicy &p) -

506 { -

507 QDebugStateSaver saver(dbg); -

508 dbg.nospace() << "QSizePolicy(horizontalPolicy = " << p.horizontalPolicy() -

509 << ", verticalPolicy = " << p.verticalPolicy() << ')'; -

510

return dbg;

never executed: return dbg;

511 } -

512 #endif -

513 -

514 QT_END_NAMESPACE -

515 -

516 #include "moc_qsizepolicy.cpp" -

Source code

Switch to Preprocessed file

Generated by Squish Coco Non-Commercial 4.3.0-BETA-master-30-08-2018-4cb69e9