diff options
Diffstat (limited to 'examples/widgets/doc/src')
| -rw-r--r-- | examples/widgets/doc/src/addressbook.qdoc | 43 | ||||
| -rw-r--r-- | examples/widgets/doc/src/basiclayouts.qdoc | 6 | ||||
| -rw-r--r-- | examples/widgets/doc/src/calendarwidget.qdoc | 10 | ||||
| -rw-r--r-- | examples/widgets/doc/src/collidingmice-example.qdoc | 10 | ||||
| -rw-r--r-- | examples/widgets/doc/src/dragdroprobot.qdoc | 2 | ||||
| -rw-r--r-- | examples/widgets/doc/src/elasticnodes.qdoc | 9 | ||||
| -rw-r--r-- | examples/widgets/doc/src/painterpaths.qdoc | 11 | ||||
| -rw-r--r-- | examples/widgets/doc/src/tablet.qdoc | 13 |
8 files changed, 49 insertions, 55 deletions
diff --git a/examples/widgets/doc/src/addressbook.qdoc b/examples/widgets/doc/src/addressbook.qdoc index b9bcae21aa..1fa0bfa9d4 100644 --- a/examples/widgets/doc/src/addressbook.qdoc +++ b/examples/widgets/doc/src/addressbook.qdoc @@ -60,8 +60,8 @@ the address book. \c TableModel is a subclass of QAbstractTableModel that provides - the standard model/view API to access data. It also holds a - QList of \l{QPair}s corresponding to the contacts added. + the standard model/view API to access data. It holds a list of + added contacts. However, this data is not all visible in a single tab. Instead, QTableView is used to provide 9 different views of the same data, according to the alphabet groups. @@ -80,7 +80,7 @@ \section1 TableModel Class Definition The \c TableModel class provides standard API to access data in - its QList of \l{QPair}s by subclassing QAbstractTableModel. The + its list of contacts by subclassing QAbstractTableModel. The basic functions that must be implemented in order to do so are: \c rowCount(), \c columnCount(), \c data(), \c headerData(). For TableModel to be editable, it has to provide implementations @@ -90,15 +90,14 @@ \snippet itemviews/addressbook/tablemodel.h 0 Two constructors are used, a default constructor which uses - \c TableModel's own \c {QList<QPair<QString, QString>>} and one - that takes \c {QList<QPair<QString, QString>} 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 We implement the two constructors as defined in the header file. - The second constructor initializes the list of pairs in the + The second constructor initializes the list of contacts in the model, with the parameter value. \snippet itemviews/addressbook/tablemodel.cpp 0 @@ -117,7 +116,7 @@ The \c data() function returns either a \b Name or \b {Address}, based on the contents of the model index supplied. The row number stored in the model index is used to - reference an item in the list of pairs. Selection is handled + reference an item in the list of contacts. Selection is handled by the QItemSelectionModel, which will be explained with \c AddressWidget. @@ -164,12 +163,11 @@ use the editing features of the QTableView object, we enable them here so that we can reuse the model in other programs. - The last function in \c {TableModel}, \c getList() returns the - QList<QPair<QString, QString>> 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. + The last function in \c {TableModel}, \c getContacts() returns the + 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. \snippet itemviews/addressbook/tablemodel.cpp 8 @@ -222,11 +220,12 @@ The QItemSelectionModel class provides a \l{QItemSelectionModel::selectionChanged()}{selectionChanged} signal that is connected to \c{AddressWidget}'s - \c selectionChanged() signal. This signal to signal connection - is necessary to enable the \uicontrol{Edit Entry...} and - \uicontrol{Remove Entry} actions in \c MainWindow's Tools menu. This - connection is further explained in \c MainWindow's - implementation. + \c selectionChanged() signal. We also connect + QTabWidget::currentChanged() signal to the lambda expression which + emits \c{AddressWidget}'s \c selectionChanged() as well. These + connections are necessary to enable the \uicontrol{Edit Entry...} and + \uicontrol{Remove Entry} actions in \c MainWindow's Tools menu. + It is further explained in \c MainWindow's implementation. Each table view in the address book is added as a tab to the QTabWidget with the relevant label, obtained from the QStringList @@ -250,7 +249,7 @@ Basic validation is done in the second \c addEntry() function to prevent duplicate entries in the address book. As mentioned with \c TableModel, this is part of the reason why we require the - getter method \c getList(). + getter method \c getContacts(). \snippet itemviews/addressbook/addresswidget.cpp 3 @@ -292,7 +291,7 @@ The \c writeToFile() function is used to save a file containing all the contacts in the address book. The file is saved in a - custom \c{.dat} format. The contents of the QList of \l{QPair}s + custom \c{.dat} format. The contents of the list of contacts are written to \c file using QDataStream. If the file cannot be opened, a QMessageBox is displayed with the related error message. @@ -301,7 +300,7 @@ The \c readFromFile() function loads a file containing all the contacts in the address book, previously saved using \c writeToFile(). QDataStream is used to read the contents of a - \c{.dat} file into a list of pairs and each of these is added + \c{.dat} file into a list of contacts and each of these is added using \c addEntry(). \snippet itemviews/addressbook/addresswidget.cpp 7 diff --git a/examples/widgets/doc/src/basiclayouts.qdoc b/examples/widgets/doc/src/basiclayouts.qdoc index 01bcaa8c1a..e9d7cea21b 100644 --- a/examples/widgets/doc/src/basiclayouts.qdoc +++ b/examples/widgets/doc/src/basiclayouts.qdoc @@ -67,11 +67,11 @@ In the constructor, we first use the \c createMenu() function to create and populate a menu bar and the \c createHorizontalGroupBox() function to create a group box containing four buttons with a - horizontal layout. Next we use the \c createGridGroupBox() function + horizontal layout. Next, we use the \c createGridGroupBox() function to create a group box containing several line edits and a small text editor which are displayed in a grid layout. Finally, we use the \c createFormGroupBox() function to create a group box with - three labels and three input fields: a line edit, a combo box and + three labels and three input fields: a line edit, a combo box, and a spin box. \snippet layouts/basiclayouts/dialog.cpp 1 @@ -111,7 +111,7 @@ \snippet layouts/basiclayouts/dialog.cpp 4 We use the QBoxLayout::addWidget() function to add the widgets to - the end of layout. Each widget will get at least its minimum size + the end of the layout. Each widget will get at least its minimum size and at most its maximum size. It is possible to specify a stretch factor in the \l {QBoxLayout::addWidget()}{addWidget()} function, and any excess space is shared according to these stretch diff --git a/examples/widgets/doc/src/calendarwidget.qdoc b/examples/widgets/doc/src/calendarwidget.qdoc index eaf8f547da..c04fab1fc7 100644 --- a/examples/widgets/doc/src/calendarwidget.qdoc +++ b/examples/widgets/doc/src/calendarwidget.qdoc @@ -110,8 +110,8 @@ size hints of its contents widgets. To ensure that the window isn't automatically resized every time - we change a property of the QCalendarWidget (e.g., hiding the - navigation bar, trhe vertical header, or the grid), we set the + we change a property of the QCalendarWidget (for example, hiding the + navigation bar, the vertical header, or the grid), we set the minimum height of row 0 and the minimum width of column 0 to the initial size of the QCalendarWidget. @@ -126,8 +126,8 @@ the formatting specified by the user. The \c createGeneralOptionsGroupBox() function is somewhat large - and several widgets are set up the same way; we look at parts of - its implementation here and skip the rest: + and several widgets are set up in the same way. We will look at + parts of its implementation here and skip the rest: \snippet widgets/calendarwidget/window.cpp 10 \dots @@ -146,7 +146,7 @@ \snippet widgets/calendarwidget/window.cpp 11 \dots - After creating the widgets, we connect the signals and slots. We + After having created the widgets, we connect the signals and slots. We connect the comboboxes to private slots of \c Window or to public slots provided by QComboBox. diff --git a/examples/widgets/doc/src/collidingmice-example.qdoc b/examples/widgets/doc/src/collidingmice-example.qdoc index 02417ba521..535057bb6a 100644 --- a/examples/widgets/doc/src/collidingmice-example.qdoc +++ b/examples/widgets/doc/src/collidingmice-example.qdoc @@ -80,8 +80,7 @@ \snippet graphicsview/collidingmice/mouse.cpp 0 To calculate the various components of the mouse's color, we use - the global qrand() function which is a thread-safe version of the - standard C++ rand() function. + \l QRandomGenerator. Then we call the \l {QGraphicsItem::setRotation()}{setRotation()} function inherited from QGraphicsItem. Items live in their own local @@ -178,12 +177,7 @@ \snippet graphicsview/collidingmice/main.cpp 0 - First, we create an application object and call the global - qsrand() function to specify the seed used to generate a new - random number sequence of pseudo random integers with the - previously mentioned qrand() function. - - Then it is time to create the scene: + First, we create an application object and create the scene: \snippet graphicsview/collidingmice/main.cpp 1 diff --git a/examples/widgets/doc/src/dragdroprobot.qdoc b/examples/widgets/doc/src/dragdroprobot.qdoc index ac221ec5f9..f74b898e1b 100644 --- a/examples/widgets/doc/src/dragdroprobot.qdoc +++ b/examples/widgets/doc/src/dragdroprobot.qdoc @@ -257,7 +257,7 @@ \snippet graphicsview/dragdroprobot/coloritem.cpp 0 \c ColorItem's constructor assigns an opaque random color to its color - member by making use of qrand(). For improved usability, it assigns a + member by making use of \l QRandomGenerator. For improved usability, it assigns a tooltip that provides a useful hint to the user, and it also sets a suitable cursor. This ensures that the cursor will chance to Qt::OpenHandCursor when the mouse pointer hovers over the item. diff --git a/examples/widgets/doc/src/elasticnodes.qdoc b/examples/widgets/doc/src/elasticnodes.qdoc index 09ac891b24..65e1195121 100644 --- a/examples/widgets/doc/src/elasticnodes.qdoc +++ b/examples/widgets/doc/src/elasticnodes.qdoc @@ -424,9 +424,8 @@ \section1 The main() Function In contrast to the complexity of the rest of this example, the \c main() - function is very simple: We create a QApplication instance, seed the - randomizer using qsrand(), and then create and show an instance of \c - GraphWidget. Because all nodes in the grid are moved initially, the \c - GraphWidget timer will start immediately after control has returned to the - event loop. + function is very simple: We create a QApplication instance, then create and + show an instance of \c GraphWidget. Because all nodes in the grid are moved + initially, the \c GraphWidget timer will start immediately after control + has returned to the event loop. */ diff --git a/examples/widgets/doc/src/painterpaths.qdoc b/examples/widgets/doc/src/painterpaths.qdoc index 2cc5ff410a..bd821ac1bf 100644 --- a/examples/widgets/doc/src/painterpaths.qdoc +++ b/examples/widgets/doc/src/painterpaths.qdoc @@ -98,14 +98,9 @@ \section1 Window Class Implementation - In the implementation of the \c Window class we first declare the - constant \c Pi with six significant figures: - - \snippet painting/painterpaths/window.cpp 0 - - In the constructor, we then define the various painter paths and - create corresponding \c RenderArea widgets which will render the - graphical shapes: + In the \c Window constructor, we define the various painter paths + and create corresponding \c RenderArea widgets which will render + the graphical shapes: \snippet painting/painterpaths/window.cpp 1 diff --git a/examples/widgets/doc/src/tablet.qdoc b/examples/widgets/doc/src/tablet.qdoc index 88fdefa68f..2b11020c07 100644 --- a/examples/widgets/doc/src/tablet.qdoc +++ b/examples/widgets/doc/src/tablet.qdoc @@ -206,8 +206,7 @@ \snippet widgets/tablet/tabletcanvas.cpp 0 - In the constructor we initialize our class variables. We need - to draw the background of our pixmap, as the default is gray. + In the constructor we initialize most of our class variables. Here is the implementation of \c saveImage(): @@ -247,7 +246,15 @@ \snippet widgets/tablet/tabletcanvas.cpp 4 - We simply draw the pixmap to the top left of the widget. + The first time Qt calls paintEvent(), m_pixmap is default-constructed, so + QPixmap::isNull() returns \c true. Now that we know which screen we will be + rendering to, we can create a pixmap with the appropriate resolution. + The size of the pixmap with which we fill the window depends on the screen + resolution, as the example does not support zoom; and it may be that one + screen is \l {High DPI Displays}{high DPI} while another is not. We need to + draw the background too, as the default is gray. + + After that, we simply draw the pixmap to the top left of the widget. Here is the implementation of \c paintPixmap(): |