diff options
Diffstat (limited to 'examples/widgets/doc/src/addressbook.qdoc')
| -rw-r--r-- | examples/widgets/doc/src/addressbook.qdoc | 57 |
1 files changed, 16 insertions, 41 deletions
diff --git a/examples/widgets/doc/src/addressbook.qdoc b/examples/widgets/doc/src/addressbook.qdoc index e5e7fe5c2c..8f2512298b 100644 --- a/examples/widgets/doc/src/addressbook.qdoc +++ b/examples/widgets/doc/src/addressbook.qdoc @@ -1,33 +1,10 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://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 https://www.qt.io/terms-conditions. For further -** information use the contact form at https://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: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \example itemviews/addressbook - \title Address Book Example + \title Address Book + \examplecategory {User Interface Components} \ingroup examples-itemviews \brief The address book example shows how to use proxy models to display different views onto data from a single model. @@ -48,7 +25,7 @@ \c AddDialog. The \c MainWindow class uses \c AddressWidget as its central widget and provides \uicontrol File and \uicontrol Tools menus. - \image addressbook-classes.png Diagram for Address Book Example + \image addressbook-classes.png Diagram for Address Book example The \c AddressWidget class is a QTabWidget subclass that is used to manipulate the 10 tabs displayed in the example: the 9 @@ -68,7 +45,7 @@ QSortFilterProxyModel is the class responsible for filtering the contacts for each group of contacts. Each proxy model uses - a QRegExp to filter out contacts that do not belong in the + a QRegularExpression to filter out contacts that do not belong in the corresponding alphabetical group. The \c AddDialog class is used to obtain information from the user for the address book. This QDialog subclass is instantiated by \c NewAddressTab to @@ -90,8 +67,8 @@ \snippet itemviews/addressbook/tablemodel.h 0 Two constructors are used, a default constructor which uses - \c TableModel's own \c {QVector<Contact>} and one that takes - \c {QVector<Contact>} as an argument, for convenience. + \c TableModel's own \c {QList<Contact>} and one that takes + \c {QList<Contact>} as an argument, for convenience. \section1 TableModel Class Implementation @@ -161,7 +138,7 @@ them here so that we can reuse the model in other programs. The last function in \c {TableModel}, \c getContacts() returns the - QVector<Contact> object that holds all the contacts in the address + QList<Contact> object that holds all the contacts in the address book. We use this function later to obtain the list of contacts to check for existing entries, write the contacts to a file and read them back. Further explanation is given with \c AddressWidget. @@ -199,7 +176,7 @@ group tabs, table views and proxy models in \c AddressWidget. Each proxy model in turn is set to filter contact names according to the relevant alphabet group using a - \l{Qt::CaseInsensitive}{case-insensitive} QRegExp object. The + case-insensitive QRegularExpression object. The table views are also sorted in ascending order using the corresponding proxy model's \l{QSortFilterProxyModel::}{sort()} function. @@ -405,17 +382,15 @@ respective slots, we also connect \c AddressWidget's \c selectionChanged() signal to its \c updateActions() slot. - The \c openFile() function allows the user to choose a file with - the \l{QFileDialog::getOpenFileName()}{open file dialog}. The chosen - file has to be a custom \c{.dat} file that contains address book - contacts. This function is a slot connected to \c openAct in the - \uicontrol File menu. + The \c openFile() function opens a custom \c{addressbook.dat} file that + contains address book contacts. This function is a slot connected to + \c openAct in the \uicontrol File menu. \snippet itemviews/addressbook/mainwindow.cpp 2 - The \c saveFile() function allows the user to save a file with - the \l{QFileDialog::getSaveFileName()}{save file dialog}. This function - is a slot connected to \c saveAct in the \uicontrol File menu. + The \c saveFile() function saves a custom \c{addressbook.dat} file that + will contain the address book contacts. This function is a slot connected + to \c saveAct in the \uicontrol File menu. \snippet itemviews/addressbook/mainwindow.cpp 3 |