katie/src/designer/sdk/layoutdecoration.qdoc
Ivailo Monev bfbc380756 initial import
Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
2015-12-10 05:06:13 +02:00

149 lines
4.6 KiB
Text

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see http://www.qt.io/terms-conditions. For further
** information use the contact form at http://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class QDesignerLayoutDecorationExtension
\brief The QDesignerLayoutDecorationExtension class provides an extension to a layout in \QD.
\inmodule QtDesigner
\internal
*/
/*!
\enum QDesignerLayoutDecorationExtension::InsertMode
This enum describes the modes that are used to insert items into a layout.
\value InsertWidgetMode Widgets are inserted into empty cells in a layout.
\value InsertRowMode Whole rows are inserted into a vertical or grid layout.
\value InsertColumnMode Whole columns are inserted into a horizontal or grid layout.
*/
/*!
\fn virtual QDesignerLayoutDecorationExtension::~QDesignerLayoutDecorationExtension()
Destroys the extension.
*/
/*!
\fn virtual QList<QWidget*> QDesignerLayoutDecorationExtension::widgets(QLayout *layout) const
Returns the widgets that are managed by the given \a layout.
\sa insertWidget(), removeWidget()
*/
/*!
\fn QRect QDesignerLayoutDecorationExtension::itemInfo(int index) const
Returns the rectangle covered by the item at the given \a index in the layout.
*/
/*!
\fn int QDesignerLayoutDecorationExtension::indexOf(QWidget *widget) const
Returns the index of the specified \a widget in the layout.
*/
/*!
\fn int QDesignerLayoutDecorationExtension::indexOf(QLayoutItem *item) const
Returns the index of the specified layout \a item.
*/
/*!
\fn QDesignerLayoutDecorationExtension::InsertMode QDesignerLayoutDecorationExtension::currentInsertMode() const
Returns the current insertion mode.
*/
/*!
\fn int QDesignerLayoutDecorationExtension::currentIndex() const
Returns the current index in the layout.
*/
/*!
\fn QPair<int, int> QDesignerLayoutDecorationExtension::currentCell() const
Returns a pair containing the row and column of the current cell in the layout.
*/
/*!
\fn void QDesignerLayoutDecorationExtension::insertWidget(QWidget *widget, const QPair<int, int> &cell)
Inserts the given \a widget into the specified \a cell in the layout.
\sa removeWidget()
*/
/*!
\fn void QDesignerLayoutDecorationExtension::removeWidget(QWidget *widget)
Removes the specified \a widget from the layout.
\sa insertWidget()
*/
/*!
\fn void QDesignerLayoutDecorationExtension::insertRow(int row)
Inserts a new row into the form at the position specified by \a row.
*/
/*!
\fn void QDesignerLayoutDecorationExtension::insertColumn(int column)
Inserts a new column into the form at the position specified by \a column.
*/
/*!
\fn void QDesignerLayoutDecorationExtension::simplify()
Simplifies the layout by removing unnecessary empty rows and columns, and by changing the
number of rows or columns spanned by widgets.
*/
/*!
\fn int QDesignerLayoutDecorationExtension::findItemAt(const QPoint &position) const
Returns the index of the item in the layout that covers the given \a position.
*/
/*!
\fn int QDesignerLayoutDecorationExtension::findItemAt(int row, int column) const
Returns the item in the layout that occupies the specified \a row and \a column in the layout.
Currently, this only applies to grid layouts.
*/
/*!
\fn void QDesignerLayoutDecorationExtension::adjustIndicator(const QPoint &position, int index)
Adjusts the indicator for the item specified by \a index so that
it lies at the given \a position on the form.
*/