/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

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

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

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

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#ifndef QFORMLAYOUT_H

#define QFORMLAYOUT_H

#include <QtGui/QLayout>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Gui)

class QFormLayoutPrivate;

class Q_GUI_EXPORT QFormLayout : public QLayout

{

    Q_OBJECT

    Q_ENUMS(FormStyle FieldGrowthPolicy RowWrapPolicy ItemRole)

    Q_DECLARE_PRIVATE(QFormLayout)

    Q_PROPERTY(FieldGrowthPolicy fieldGrowthPolicy READ fieldGrowthPolicy WRITE setFieldGrowthPolicy RESET resetFieldGrowthPolicy)

    Q_PROPERTY(RowWrapPolicy rowWrapPolicy READ rowWrapPolicy WRITE setRowWrapPolicy RESET resetRowWrapPolicy)

    Q_PROPERTY(Qt::Alignment labelAlignment READ labelAlignment WRITE setLabelAlignment RESET resetLabelAlignment)

    Q_PROPERTY(Qt::Alignment formAlignment READ formAlignment WRITE setFormAlignment RESET resetFormAlignment)

    Q_PROPERTY(int horizontalSpacing READ horizontalSpacing WRITE setHorizontalSpacing)

    Q_PROPERTY(int verticalSpacing READ verticalSpacing WRITE setVerticalSpacing)

public:

    enum FieldGrowthPolicy {

        FieldsStayAtSizeHint,

        ExpandingFieldsGrow,

        AllNonFixedFieldsGrow

    };

    enum RowWrapPolicy {

        DontWrapRows,

        WrapLongRows,

        WrapAllRows

    };

    enum ItemRole {

        LabelRole = 0,

        FieldRole = 1,

        SpanningRole = 2

    };

    explicit QFormLayout(QWidget *parent = 0);

    ~QFormLayout();

    void setFieldGrowthPolicy(FieldGrowthPolicy policy);

    FieldGrowthPolicy fieldGrowthPolicy() const;

    void setRowWrapPolicy(RowWrapPolicy policy);

    RowWrapPolicy rowWrapPolicy() const;

    void setLabelAlignment(Qt::Alignment alignment);

    Qt::Alignment labelAlignment() const;

    void setFormAlignment(Qt::Alignment alignment);

    Qt::Alignment formAlignment() const;

    void setHorizontalSpacing(int spacing);

    int horizontalSpacing() const;

    void setVerticalSpacing(int spacing);

    int verticalSpacing() const;

    int spacing() const;

    void setSpacing(int);

    void addRow(QWidget *label, QWidget *field);

    void addRow(QWidget *label, QLayout *field);

    void addRow(const QString &labelText, QWidget *field);

    void addRow(const QString &labelText, QLayout *field);

    void addRow(QWidget *widget);

    void addRow(QLayout *layout);

    void insertRow(int row, QWidget *label, QWidget *field);

    void insertRow(int row, QWidget *label, QLayout *field);

    void insertRow(int row, const QString &labelText, QWidget *field);

    void insertRow(int row, const QString &labelText, QLayout *field);

    void insertRow(int row, QWidget *widget);

    void insertRow(int row, QLayout *layout);

    void setItem(int row, ItemRole role, QLayoutItem *item);

    void setWidget(int row, ItemRole role, QWidget *widget);

    void setLayout(int row, ItemRole role, QLayout *layout);

    QLayoutItem *itemAt(int row, ItemRole role) const;

    void getItemPosition(int index, int *rowPtr, ItemRole *rolePtr) const;

    void getWidgetPosition(QWidget *widget, int *rowPtr, ItemRole *rolePtr) const;

    void getLayoutPosition(QLayout *layout, int *rowPtr, ItemRole *rolePtr) const;

    QWidget *labelForField(QWidget *field) const;

    QWidget *labelForField(QLayout *field) const;

    // reimplemented from QLayout

    void addItem(QLayoutItem *item);

    QLayoutItem *itemAt(int index) const;

    QLayoutItem *takeAt(int index);

    void setGeometry(const QRect &rect);

    QSize minimumSize() const;

    QSize sizeHint() const;

    void invalidate();

    bool hasHeightForWidth() const;

    int heightForWidth(int width) const;

    Qt::Orientations expandingDirections() const;

    int count() const;

    int rowCount() const;

#if 0

	void dump() const;

#endif

private:

    void resetFieldGrowthPolicy();

    void resetRowWrapPolicy();

    void resetLabelAlignment();

    void resetFormAlignment();

};

QT_END_NAMESPACE

QT_END_HEADER

#endif