Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
layoutdecoration.qdoc
Go to the documentation of this file.
1// Copyright (C) 2016 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
3
4// ### FIXME Qt 7: std::pair in QDesignerLayoutDecorationExtension (QTBUG-115841)
5
6/*!
7 \class QDesignerLayoutDecorationExtension
8 \brief The QDesignerLayoutDecorationExtension class provides an extension to a layout in \QD.
9 \inmodule QtDesigner
10 \internal
11*/
12
13/*!
14 \enum QDesignerLayoutDecorationExtension::InsertMode
15
16 This enum describes the modes that are used to insert items into a layout.
17
18 \value InsertWidgetMode Widgets are inserted into empty cells in a layout.
19 \value InsertRowMode Whole rows are inserted into a vertical or grid layout.
20 \value InsertColumnMode Whole columns are inserted into a horizontal or grid layout.
21*/
22
23/*!
24 \fn virtual QDesignerLayoutDecorationExtension::~QDesignerLayoutDecorationExtension()
25
26 Destroys the extension.
27*/
28
29/*!
30 \fn virtual QList<QWidget*> QDesignerLayoutDecorationExtension::widgets(QLayout *layout) const
31
32 Returns the widgets that are managed by the given \a layout.
33
34 \sa insertWidget(), removeWidget()
35*/
36
37/*!
38 \fn QRect QDesignerLayoutDecorationExtension::itemInfo(int index) const
39
40 Returns the rectangle covered by the item at the given \a index in the layout.
41*/
42
43/*!
44 \fn int QDesignerLayoutDecorationExtension::indexOf(QWidget *widget) const
45
46 Returns the index of the specified \a widget in the layout.
47*/
48
49/*!
50 \fn int QDesignerLayoutDecorationExtension::indexOf(QLayoutItem *item) const
51
52 Returns the index of the specified layout \a item.
53*/
54
55/*!
56 \fn QDesignerLayoutDecorationExtension::InsertMode QDesignerLayoutDecorationExtension::currentInsertMode() const
57
58 Returns the current insertion mode.
59*/
60
61/*!
62 \fn int QDesignerLayoutDecorationExtension::currentIndex() const
63
64 Returns the current index in the layout.
65*/
66
67/*!
68 \fn QPair<int, int> QDesignerLayoutDecorationExtension::currentCell() const
69
70 Returns a pair containing the row and column of the current cell in the layout.
71*/
72
73/*!
74 \fn void QDesignerLayoutDecorationExtension::insertWidget(QWidget *widget, const QPair<int, int> &cell)
75
76 Inserts the given \a widget into the specified \a cell in the layout.
77
78 \sa removeWidget()
79*/
80
81/*!
82 \fn void QDesignerLayoutDecorationExtension::removeWidget(QWidget *widget)
83
84 Removes the specified \a widget from the layout.
85
86 \sa insertWidget()
87*/
88
89/*!
90 \fn void QDesignerLayoutDecorationExtension::insertRow(int row)
91
92 Inserts a new row into the form at the position specified by \a row.
93*/
94
95/*!
96 \fn void QDesignerLayoutDecorationExtension::insertColumn(int column)
97
98 Inserts a new column into the form at the position specified by \a column.
99*/
100
101/*!
102 \fn void QDesignerLayoutDecorationExtension::simplify()
103
104 Simplifies the layout by removing unnecessary empty rows and columns, and by changing the
105 number of rows or columns spanned by widgets.
106*/
107
108/*!
109 \fn int QDesignerLayoutDecorationExtension::findItemAt(const QPoint &position) const
110
111 Returns the index of the item in the layout that covers the given \a position.
112*/
113
114/*!
115 \fn int QDesignerLayoutDecorationExtension::findItemAt(int row, int column) const
116
117 Returns the item in the layout that occupies the specified \a row and \a column in the layout.
118
119 Currently, this only applies to grid layouts.
120*/
121
122/*!
123 \fn void QDesignerLayoutDecorationExtension::adjustIndicator(const QPoint &position, int index)
124
125 Adjusts the indicator for the item specified by \a index so that
126 it lies at the given \a position on the form.
127*/