QWizard: deprecate visitedPages and add visitedIds instead

As per the ### Qt 6 comment. A method visitedPages should, following
the convention of the other QWizard APIs, return a list of QWizardPage
pointers. Since the method returns a list of IDs, visitedIds is the
correct name.

[ChangeLog][QtWidgets][QWizard] visitedPages has been deprecated, use
visitedIds instead.

Change-Id: Ifdb94adf093be14cb48c84cb40818c55ff5189a0
Reviewed-by: Jan Arve Sæther <jan-arve.saether@qt.io>
This commit is contained in:
Volker Hilsheimer 2020-02-25 15:30:16 +01:00
parent cb390719c6
commit 31b06a0437
3 changed files with 30 additions and 17 deletions

View File

@ -2384,12 +2384,22 @@ bool QWizard::hasVisitedPage(int theid) const
\sa hasVisitedPage()
*/
QList<int> QWizard::visitedPages() const
QList<int> QWizard::visitedIds() const
{
Q_D(const QWizard);
return d->history;
}
/*!
\obsolete Use visitedIds() instead
*/
#if QT_DEPRECATED_SINCE(5, 15)
QList<int> QWizard::visitedPages() const
{
return visitedIds();
}
#endif
/*!
Returns the list of page IDs.
\since 4.5

View File

@ -128,7 +128,10 @@ public:
void removePage(int id);
QWizardPage *page(int id) const;
bool hasVisitedPage(int id) const;
QList<int> visitedPages() const; // ### Qt 6: visitedIds()?
#if QT_DEPRECATED_SINCE(5, 15)
QList<int> visitedPages() const;
#endif
QList<int> visitedIds() const;
QList<int> pageIds() const;
void setStartId(int id);
int startId() const;

View File

@ -585,7 +585,7 @@ void tst_QWizard::addPage()
#define CHECK_VISITED(wizard, list) \
do { \
QList<int> myList = list; \
QCOMPARE((wizard).visitedPages(), myList); \
QCOMPARE((wizard).visitedIds(), myList); \
Q_FOREACH(int id, myList) \
QVERIFY((wizard).hasVisitedPage(id)); \
} while (0)
@ -2292,7 +2292,7 @@ void tst_QWizard::removePage()
wizard.restart();
QCOMPARE(wizard.pageIds().size(), 4);
QCOMPARE(wizard.visitedPages().size(), 1);
QCOMPARE(wizard.visitedIds().size(), 1);
QCOMPARE(spy.count(), 0);
// Removing a non-existent page
@ -2330,14 +2330,14 @@ void tst_QWizard::removePage()
wizard.setPage(2, page2); // restore
wizard.restart();
wizard.next();
QCOMPARE(wizard.visitedPages().size(), 2);
QCOMPARE(wizard.visitedIds().size(), 2);
QCOMPARE(wizard.currentPage(), page1);
QCOMPARE(spy.count(), 0);
wizard.removePage(2);
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 2);
QCOMPARE(wizard.visitedPages().size(), 2);
QCOMPARE(wizard.visitedIds().size(), 2);
QVERIFY(!wizard.pageIds().contains(2));
QCOMPARE(wizard.currentPage(), page1);
@ -2346,14 +2346,14 @@ void tst_QWizard::removePage()
wizard.restart();
wizard.next();
QCOMPARE(spy.count(), 0);
QCOMPARE(wizard.visitedPages().size(), 2);
QCOMPARE(wizard.visitedIds().size(), 2);
QCOMPARE(wizard.currentPage(), page1);
wizard.removePage(0);
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 0);
QCOMPARE(wizard.visitedPages().size(), 1);
QVERIFY(!wizard.visitedPages().contains(0));
QCOMPARE(wizard.visitedIds().size(), 1);
QVERIFY(!wizard.visitedIds().contains(0));
QVERIFY(!wizard.pageIds().contains(0));
QCOMPARE(wizard.currentPage(), page1);
@ -2362,14 +2362,14 @@ void tst_QWizard::removePage()
wizard.restart();
wizard.next();
QCOMPARE(spy.count(), 0);
QCOMPARE(wizard.visitedPages().size(), 2);
QCOMPARE(wizard.visitedIds().size(), 2);
QCOMPARE(wizard.currentPage(), page1);
wizard.removePage(1);
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 1);
QCOMPARE(wizard.visitedPages().size(), 1);
QVERIFY(!wizard.visitedPages().contains(1));
QCOMPARE(wizard.visitedIds().size(), 1);
QVERIFY(!wizard.visitedIds().contains(1));
QVERIFY(!wizard.pageIds().contains(1));
QCOMPARE(wizard.currentPage(), page0);
@ -2378,8 +2378,8 @@ void tst_QWizard::removePage()
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 0);
QCOMPARE(wizard.visitedPages().size(), 1);
QVERIFY(!wizard.visitedPages().contains(0));
QCOMPARE(wizard.visitedIds().size(), 1);
QVERIFY(!wizard.visitedIds().contains(0));
QCOMPARE(wizard.pageIds().size(), 2);
QVERIFY(!wizard.pageIds().contains(0));
QCOMPARE(wizard.currentPage(), page2);
@ -2388,8 +2388,8 @@ void tst_QWizard::removePage()
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 2);
QCOMPARE(wizard.visitedPages().size(), 1);
QVERIFY(!wizard.visitedPages().contains(2));
QCOMPARE(wizard.visitedIds().size(), 1);
QVERIFY(!wizard.visitedIds().contains(2));
QCOMPARE(wizard.pageIds().size(), 1);
QVERIFY(!wizard.pageIds().contains(2));
QCOMPARE(wizard.currentPage(), page3);
@ -2398,7 +2398,7 @@ void tst_QWizard::removePage()
QCOMPARE(spy.count(), 1);
arguments = spy.takeFirst();
QCOMPARE(arguments.at(0).toInt(), 3);
QVERIFY(wizard.visitedPages().empty());
QVERIFY(wizard.visitedIds().empty());
QVERIFY(wizard.pageIds().empty());
QCOMPARE(wizard.currentPage(), nullptr);
}