1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
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#ifndef QDATAWIDGETMAPPER_H
41#define QDATAWIDGETMAPPER_H
42
43#include <QtWidgets/qtwidgetsglobal.h>
44#include "QtCore/qobject.h"
45
46QT_REQUIRE_CONFIG(datawidgetmapper);
47
48QT_BEGIN_NAMESPACE
49
50class QAbstractItemDelegate;
51class QAbstractItemModel;
52class QModelIndex;
53class QDataWidgetMapperPrivate;
54
55class Q_WIDGETS_EXPORT QDataWidgetMapper: public QObject
56{
57 Q_OBJECT
58
59 Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)
60 Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation)
61 Q_PROPERTY(SubmitPolicy submitPolicy READ submitPolicy WRITE setSubmitPolicy)
62
63public:
64 explicit QDataWidgetMapper(QObject *parent = nullptr);
65 ~QDataWidgetMapper();
66
67 void setModel(QAbstractItemModel *model);
68 QAbstractItemModel *model() const;
69
70 void setItemDelegate(QAbstractItemDelegate *delegate);
71 QAbstractItemDelegate *itemDelegate() const;
72
73 void setRootIndex(const QModelIndex &index);
74 QModelIndex rootIndex() const;
75
76 void setOrientation(Qt::Orientation aOrientation);
77 Qt::Orientation orientation() const;
78
79 enum SubmitPolicy { AutoSubmit, ManualSubmit };
80 Q_ENUM(SubmitPolicy)
81 void setSubmitPolicy(SubmitPolicy policy);
82 SubmitPolicy submitPolicy() const;
83
84 void addMapping(QWidget *widget, int section);
85 void addMapping(QWidget *widget, int section, const QByteArray &propertyName);
86 void removeMapping(QWidget *widget);
87 int mappedSection(QWidget *widget) const;
88 QByteArray mappedPropertyName(QWidget *widget) const;
89 QWidget *mappedWidgetAt(int section) const;
90 void clearMapping();
91
92 int currentIndex() const;
93
94public Q_SLOTS:
95 void revert();
96 bool submit();
97
98 void toFirst();
99 void toLast();
100 void toNext();
101 void toPrevious();
102 virtual void setCurrentIndex(int index);
103 void setCurrentModelIndex(const QModelIndex &index);
104
105Q_SIGNALS:
106 void currentIndexChanged(int index);
107
108private:
109 Q_DECLARE_PRIVATE(QDataWidgetMapper)
110 Q_DISABLE_COPY(QDataWidgetMapper)
111 Q_PRIVATE_SLOT(d_func(),
112 void _q_dataChanged(const QModelIndex &, const QModelIndex &,
113 const QList<int> &))
114 Q_PRIVATE_SLOT(d_func(), void _q_commitData(QWidget *))
115 Q_PRIVATE_SLOT(d_func(), void _q_closeEditor(QWidget *, QAbstractItemDelegate::EndEditHint))
116 Q_PRIVATE_SLOT(d_func(), void _q_modelDestroyed())
117};
118
119QT_END_NAMESPACE
120
121#endif
122