diff options
Diffstat (limited to 'doc/src/examples')
63 files changed, 479 insertions, 479 deletions
diff --git a/doc/src/examples/addressbook.qdoc b/doc/src/examples/addressbook.qdoc index 02820307e6..51712d49d3 100644 --- a/doc/src/examples/addressbook.qdoc +++ b/doc/src/examples/addressbook.qdoc @@ -107,15 +107,15 @@ dimensions of the model. Whereas, \c rowCount()'s value will vary depending on the number of contacts added to the address book, \c columnCount()'s value is always 2 because we only need space - for the \bold Name and \bold Address columns. + for the \b Name and \b Address columns. \note The \c Q_UNUSED() macro prevents the compiler from generating warnings regarding unused parameters. \snippet itemviews/addressbook/tablemodel.cpp 1 - The \c data() function returns either a \bold Name or - \bold {Address}, based on the contents of the model index + 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 by the QItemSelectionModel, which will be explained with @@ -124,7 +124,7 @@ \snippet itemviews/addressbook/tablemodel.cpp 2 The \c headerData() function displays the table's header, - \bold Name and \bold Address. If you require numbered entries + \b Name and \b Address. If you require numbered entries for your address book, you can use a vertical header which we have hidden in this example (see the \c AddressWidget implementation). @@ -372,8 +372,8 @@ menus and actions necessary to manipulate the address book. \table - \row \o \inlineimage addressbook-filemenu.png - \o \inlineimage addressbook-toolsmenu.png + \row \li \inlineimage addressbook-filemenu.png + \li \inlineimage addressbook-toolsmenu.png \endtable \snippet itemviews/addressbook/mainwindow.h 0 diff --git a/doc/src/examples/affine.qdoc b/doc/src/examples/affine.qdoc index df85576e84..c01031190a 100644 --- a/doc/src/examples/affine.qdoc +++ b/doc/src/examples/affine.qdoc @@ -39,10 +39,10 @@ in the following ways: \list - \o Dragging the red circle in the centre of each drawing moves it to a new position. - \o Dragging the displaced red circle causes the current drawing to be rotated about the + \li Dragging the red circle in the centre of each drawing moves it to a new position. + \li Dragging the displaced red circle causes the current drawing to be rotated about the central circle. Rotation can also be controlled with the \key Rotate slider. - \o Scaling is controlled with the \key Scale slider. - \o Each drawing can be sheared with the \key Shear slider. + \li Scaling is controlled with the \key Scale slider. + \li Each drawing can be sheared with the \key Shear slider. \endlist */ diff --git a/doc/src/examples/arrowpad.qdoc b/doc/src/examples/arrowpad.qdoc index ee35aa59ae..79bf94c510 100644 --- a/doc/src/examples/arrowpad.qdoc +++ b/doc/src/examples/arrowpad.qdoc @@ -142,18 +142,18 @@ Now, enter the following translations: \list - \o \c ArrowPad + \li \c ArrowPad \list - \o \&Up - \&Haut - \o \&Left - \&Gauche - \o \&Right - \&Droite - \o \&Down - \&Bas + \li \&Up - \&Haut + \li \&Left - \&Gauche + \li \&Right - \&Droite + \li \&Down - \&Bas \endlist - \o \c MainWindow + \li \c MainWindow \list - \o E\&xit - \&Quitter - \o Ctrl+Q - Ctrl+Q - \o \&File - \&Fichier + \li E\&xit - \&Quitter + \li Ctrl+Q - Ctrl+Q + \li \&File - \&Fichier \endlist \endlist @@ -164,18 +164,18 @@ Save the file and do the same for Dutch working with \c arrowpad_nl.ts: \list - \o \c ArrowPad + \li \c ArrowPad \list - \o \&Up - \&Omhoog - \o \&Left - \&Links - \o \&Right - \&Rechts - \o \&Down - Omlaa\&g + \li \&Up - \&Omhoog + \li \&Left - \&Links + \li \&Right - \&Rechts + \li \&Down - Omlaa\&g \endlist - \o \c MainWindow + \li \c MainWindow \list - \o E\&xit - \&Afsluiten - \o Ctrl+Q - Ctrl+A - \o File - \&Bestand + \li E\&xit - \&Afsluiten + \li Ctrl+Q - Ctrl+A + \li File - \&Bestand \endlist \endlist diff --git a/doc/src/examples/basicdrawing.qdoc b/doc/src/examples/basicdrawing.qdoc index 3920811e30..501b791bc1 100644 --- a/doc/src/examples/basicdrawing.qdoc +++ b/doc/src/examples/basicdrawing.qdoc @@ -53,9 +53,9 @@ The Basic Drawing example consists of two classes: \list - \o \c RenderArea is a custom widget that renders multiple + \li \c RenderArea is a custom widget that renders multiple copies of the currently active shape. - \o \c Window is the application's main window displaying a + \li \c Window is the application's main window displaying a \c RenderArea widget in addition to several parameter widgets. \endlist @@ -415,19 +415,19 @@ the associated QPainter drawing function: \list - \o QPainter::drawLine(), - \o QPainter::drawPoints(), - \o QPainter::drawPolyline(), - \o QPainter::drawPolygon(), - \o QPainter::drawRect(), - \o QPainter::drawRoundedRect(), - \o QPainter::drawEllipse(), - \o QPainter::drawArc(), - \o QPainter::drawChord(), - \o QPainter::drawPie(), - \o QPainter::drawPath(), - \o QPainter::drawText() or - \o QPainter::drawPixmap() + \li QPainter::drawLine(), + \li QPainter::drawPoints(), + \li QPainter::drawPolyline(), + \li QPainter::drawPolygon(), + \li QPainter::drawRect(), + \li QPainter::drawRoundedRect(), + \li QPainter::drawEllipse(), + \li QPainter::drawArc(), + \li QPainter::drawChord(), + \li QPainter::drawPie(), + \li QPainter::drawPath(), + \li QPainter::drawText() or + \li QPainter::drawPixmap() \endlist Before we started rendering, we saved the current painter state diff --git a/doc/src/examples/basicgraphicslayouts.qdoc b/doc/src/examples/basicgraphicslayouts.qdoc index c1703c3430..b7023cf9ca 100644 --- a/doc/src/examples/basicgraphicslayouts.qdoc +++ b/doc/src/examples/basicgraphicslayouts.qdoc @@ -57,9 +57,9 @@ We repeat the process: \list - \o create a new \c LayoutItem, - \o add the item \c linear, and - \o provide a stretch factor. + \li create a new \c LayoutItem, + \li add the item \c linear, and + \li provide a stretch factor. \endlist \snippet examples/graphicsview/basicgraphicslayouts/window.cpp 1 diff --git a/doc/src/examples/blockingfortuneclient.qdoc b/doc/src/examples/blockingfortuneclient.qdoc index 34add534d4..6c3be78859 100644 --- a/doc/src/examples/blockingfortuneclient.qdoc +++ b/doc/src/examples/blockingfortuneclient.qdoc @@ -38,14 +38,14 @@ \list - \o \e{The asynchronous (non-blocking) approach.} Operations are scheduled + \li \e{The asynchronous (non-blocking) approach.} Operations are scheduled and performed when control returns to Qt's event loop. When the operation is finished, QTcpSocket emits a signal. For example, QTcpSocket::connectToHost() returns immediately, and when the connection has been established, QTcpSocket emits \l{QTcpSocket::connected()}{connected()}. - \o \e{The synchronous (blocking) approach.} In non-GUI and multithreaded + \li \e{The synchronous (blocking) approach.} In non-GUI and multithreaded applications, you can call the \c waitFor...() functions (e.g., QTcpSocket::waitForConnected()) to suspend the calling thread until the operation has completed, instead of connecting to signals. diff --git a/doc/src/examples/boxes.qdoc b/doc/src/examples/boxes.qdoc index f2ca92477a..aa34a61bc3 100644 --- a/doc/src/examples/boxes.qdoc +++ b/doc/src/examples/boxes.qdoc @@ -37,11 +37,11 @@ Elements in the demo can be controlled using the mouse in the following ways: \list - \o Dragging the mouse while pressing the left mouse button rotates the + \li Dragging the mouse while pressing the left mouse button rotates the box in the center. - \o Dragging the mouse while pressing the right mouse button rotates the + \li Dragging the mouse while pressing the right mouse button rotates the satellite boxes. - \o Scrolling the mouse wheel zooms in and out of the scene. + \li Scrolling the mouse wheel zooms in and out of the scene. \endlist The options pane can be used to fine-tune various parameters in the demo, diff --git a/doc/src/examples/cachedtable.qdoc b/doc/src/examples/cachedtable.qdoc index d6b0aa5013..c9945a0efb 100644 --- a/doc/src/examples/cachedtable.qdoc +++ b/doc/src/examples/cachedtable.qdoc @@ -66,9 +66,9 @@ in additon to the model and the editor's buttons. \table 100% - \header \o Connecting to a Database + \header \li Connecting to a Database \row - \o + \li Before we can use the \c TableEditor class, we must create a connection to the database containing the table we want to edit: @@ -187,8 +187,8 @@ \table 100% \row - \o - \bold {See also:} + \li + \b {See also:} A complete list of Qt's SQL \l {Database Classes}, and the \l {Model/View Programming} documentation. diff --git a/doc/src/examples/calculator.qdoc b/doc/src/examples/calculator.qdoc index eb3ccedc35..8eddfa8c4e 100644 --- a/doc/src/examples/calculator.qdoc +++ b/doc/src/examples/calculator.qdoc @@ -38,9 +38,9 @@ The example consists of two classes: \list - \o \c Calculator is the calculator widget, with all the + \li \c Calculator is the calculator widget, with all the calculator functionality. - \o \c Button is the widget used for each of the calculator + \li \c Button is the widget used for each of the calculator button. It derives from QToolButton. \endlist @@ -85,18 +85,18 @@ display (a QLineEdit), encode the state of the calculator: \list - \o \c sumInMemory contains the value stored in the calculator's memory + \li \c sumInMemory contains the value stored in the calculator's memory (using \gui{MS}, \gui{M+}, or \gui{MC}). - \o \c sumSoFar stores the value accumulated so far. When the user + \li \c sumSoFar stores the value accumulated so far. When the user clicks \gui{=}, \c sumSoFar is recomputed and shown on the display. \gui{Clear All} resets \c sumSoFar to zero. - \o \c factorSoFar stores a temporary value when doing + \li \c factorSoFar stores a temporary value when doing multiplications and divisions. - \o \c pendingAdditiveOperator stores the last additive operator + \li \c pendingAdditiveOperator stores the last additive operator clicked by the user. - \o \c pendingMultiplicativeOperator stores the last multiplicative operator + \li \c pendingMultiplicativeOperator stores the last multiplicative operator clicked by the user. - \o \c waitingForOperand is \c true when the calculator is + \li \c waitingForOperand is \c true when the calculator is expecting the user to start typing an operand. \endlist @@ -109,16 +109,16 @@ the user enters a mathematical expression. \table - \header \o User Input \o Display \o Sum so Far \o Add. Op. \o Factor so Far \o Mult. Op. \o Waiting for Operand? - \row \o \o 0 \o 0 \o \o \o \o \c true - \row \o \gui{1} \o 1 \o 0 \o \o \o \o \c false - \row \o \gui{1 +} \o 1 \o 1 \o \gui{+} \o \o \o \c true - \row \o \gui{1 + 2} \o 2 \o 1 \o \gui{+} \o \o \o \c false - \row \o \gui{1 + 2 \unicode{247}} \o 2 \o 1 \o \gui{+} \o 2 \o \gui{\unicode{247}} \o \c true - \row \o \gui{1 + 2 \unicode{247} 3} \o 3 \o 1 \o \gui{+} \o 2 \o \gui{\unicode{247}} \o \c false - \row \o \gui{1 + 2 \unicode{247} 3 -} \o 1.66667 \o 1.66667 \o \gui{-} \o \o \o \c true - \row \o \gui{1 + 2 \unicode{247} 3 - 4} \o 4 \o 1.66667 \o \gui{-} \o \o \o \c false - \row \o \gui{1 + 2 \unicode{247} 3 - 4 =} \o -2.33333 \o 0 \o \o \o \o \c true + \header \li User Input \li Display \li Sum so Far \li Add. Op. \li Factor so Far \li Mult. Op. \li Waiting for Operand? + \row \li \li 0 \li 0 \li \li \li \li \c true + \row \li \gui{1} \li 1 \li 0 \li \li \li \li \c false + \row \li \gui{1 +} \li 1 \li 1 \li \gui{+} \li \li \li \c true + \row \li \gui{1 + 2} \li 2 \li 1 \li \gui{+} \li \li \li \c false + \row \li \gui{1 + 2 \unicode{247}} \li 2 \li 1 \li \gui{+} \li 2 \li \gui{\unicode{247}} \li \c true + \row \li \gui{1 + 2 \unicode{247} 3} \li 3 \li 1 \li \gui{+} \li 2 \li \gui{\unicode{247}} \li \c false + \row \li \gui{1 + 2 \unicode{247} 3 -} \li 1.66667 \li 1.66667 \li \gui{-} \li \li \li \c true + \row \li \gui{1 + 2 \unicode{247} 3 - 4} \li 4 \li 1.66667 \li \gui{-} \li \li \li \c false + \row \li \gui{1 + 2 \unicode{247} 3 - 4 =} \li -2.33333 \li 0 \li \li \li \li \c true \endtable Unary operators, such as \gui Sqrt, require no special handling; @@ -356,8 +356,8 @@ base class (QToolButton) but modify it in the following ways: \list - \o We add 20 to the \l{QSize::height()}{height} component of the size hint. - \o We make the \l{QSize::width()}{width} component of the size + \li We add 20 to the \l{QSize::height()}{height} component of the size hint. + \li We make the \l{QSize::width()}{width} component of the size hint at least as much as the \l{QSize::width()}{height}. \endlist diff --git a/doc/src/examples/calendar.qdoc b/doc/src/examples/calendar.qdoc index d06bed7c6f..aea9805669 100644 --- a/doc/src/examples/calendar.qdoc +++ b/doc/src/examples/calendar.qdoc @@ -37,10 +37,10 @@ Specifically, the example demonstrates the following: \list - \o Use of a text editor with a text document - \o Insertion of tables and frames into a document - \o Navigation within a table - \o Insert text in different styles + \li Use of a text editor with a text document + \li Insertion of tables and frames into a document + \li Navigation within a table + \li Insert text in different styles \endlist The rich text editor used to display the document is used within a main window diff --git a/doc/src/examples/calendarwidget.qdoc b/doc/src/examples/calendarwidget.qdoc index 7ef99bfc65..0dd20b1491 100644 --- a/doc/src/examples/calendarwidget.qdoc +++ b/doc/src/examples/calendarwidget.qdoc @@ -51,28 +51,28 @@ below. \table - \header \o Property - \o Description - \row \o \l{QCalendarWidget::}{selectedDate} - \o The currently selected date. - \row \o \l{QCalendarWidget::}{minimumDate} - \o The earliest date that can be selected. - \row \o \l{QCalendarWidget::}{maximumDate} - \o The latest date that can be selected. - \row \o \l{QCalendarWidget::}{firstDayOfWeek} - \o The day that is displayed as the first day of the week + \header \li Property + \li Description + \row \li \l{QCalendarWidget::}{selectedDate} + \li The currently selected date. + \row \li \l{QCalendarWidget::}{minimumDate} + \li The earliest date that can be selected. + \row \li \l{QCalendarWidget::}{maximumDate} + \li The latest date that can be selected. + \row \li \l{QCalendarWidget::}{firstDayOfWeek} + \li The day that is displayed as the first day of the week (usually Sunday or Monday). - \row \o \l{QCalendarWidget::}{gridVisible} - \o Whether the grid should be shown. - \row \o \l{QCalendarWidget::}{selectionMode} - \o Whether the user can select a date or not. - \row \o \l{QCalendarWidget::}{horizontalHeaderFormat} - \o The format of the day names in the horizontal header + \row \li \l{QCalendarWidget::}{gridVisible} + \li Whether the grid should be shown. + \row \li \l{QCalendarWidget::}{selectionMode} + \li Whether the user can select a date or not. + \row \li \l{QCalendarWidget::}{horizontalHeaderFormat} + \li The format of the day names in the horizontal header (e.g., "M", "Mon", or "Monday"). - \row \o \l{QCalendarWidget::}{verticalHeaderFormat} - \o The format of the vertical header. - \row \o \l{QCalendarWidget::}{navigationBarVisible} - \o Whether the navigation bar at the top of the calendar + \row \li \l{QCalendarWidget::}{verticalHeaderFormat} + \li The format of the vertical header. + \row \li \l{QCalendarWidget::}{navigationBarVisible} + \li Whether the navigation bar at the top of the calendar widget is shown. \endtable diff --git a/doc/src/examples/charactermap.qdoc b/doc/src/examples/charactermap.qdoc index 33652118ef..5fbcae1fad 100644 --- a/doc/src/examples/charactermap.qdoc +++ b/doc/src/examples/charactermap.qdoc @@ -43,9 +43,9 @@ that may be unavailable or difficult to locate on their keyboards. The example consists of the following classes: \list -\i \c CharacterWidget displays the available characters in the current +\li \c CharacterWidget displays the available characters in the current font and style. -\i \c MainWindow provides a standard main window that contains font and +\li \c MainWindow provides a standard main window that contains font and style information, a view onto the characters, a line edit, and a push button for submitting text to the clipboard. \endlist diff --git a/doc/src/examples/chart.qdoc b/doc/src/examples/chart.qdoc index 565b1c6c7d..947eddf1c9 100644 --- a/doc/src/examples/chart.qdoc +++ b/doc/src/examples/chart.qdoc @@ -37,7 +37,7 @@ relying on the flexibility of the model/view architecture to handle custom editing and selection features. - \bold{Note that you only need to create a new view class if your data requires a + \b{Note that you only need to create a new view class if your data requires a specialized representation.} You should first consider using a standard QListView, QTableView, or QTreeView with a custom QItemDelegate subclass if you need to represent data in a special way. @@ -61,10 +61,10 @@ We interpret the data in the following way: \list - \o Column 0 contains data in two different roles: + \li Column 0 contains data in two different roles: The \l{Qt::ItemDataRole}{DisplayRole} contains a label, and the \l{Qt::ItemDataRole}{DecorationRole} contains the color of the pie slice. - \o Column 1 contains a quantity which we will convert to the angular extent of + \li Column 1 contains a quantity which we will convert to the angular extent of the slice. \endlist diff --git a/doc/src/examples/classwizard.qdoc b/doc/src/examples/classwizard.qdoc index 0fad22e56a..8f84193f2e 100644 --- a/doc/src/examples/classwizard.qdoc +++ b/doc/src/examples/classwizard.qdoc @@ -44,10 +44,10 @@ The Class Wizard example consists of the following classes: \list - \o \c ClassWizard inherits QWizard and provides a + \li \c ClassWizard inherits QWizard and provides a three-step wizard that generates the skeleton of a C++ class based on the user's input. - \o \c IntroPage, \c ClassInfoPage, \c CodeStylePage, \c + \li \c IntroPage, \c ClassInfoPage, \c CodeStylePage, \c OutputFilesPage, and \c ConclusionPage are QWizardPage subclasses that implement the wizard pages. \endlist @@ -61,17 +61,17 @@ five pages: \list - \o The first page is an introduction page, telling the user what + \li The first page is an introduction page, telling the user what the wizard is going to do. - \o The second page asks for a class name and a base class, and + \li The second page asks for a class name and a base class, and allows the user to specify whether the class should have a \c Q_OBJECT macro and what constructors it should provide. - \o The third page allows the user to set some options related to the code + \li The third page allows the user to set some options related to the code style, such as the macro used to protect the header file from multiple inclusion (e.g., \c MYDIALOG_H). - \o The fourth page allows the user to specify the names of the + \li The fourth page allows the user to specify the names of the output files. - \o The fifth page is a conclusion page. + \li The fifth page is a conclusion page. \endlist Although the program is just an example, if you press \gui Finish diff --git a/doc/src/examples/coloreditorfactory.qdoc b/doc/src/examples/coloreditorfactory.qdoc index 741db7e387..1806446fb7 100644 --- a/doc/src/examples/coloreditorfactory.qdoc +++ b/doc/src/examples/coloreditorfactory.qdoc @@ -134,16 +134,16 @@ Possible suggestions are: \list - \o If the editor widget has no user property defined, the delegate + \li If the editor widget has no user property defined, the delegate asks the factory for the property name, which it in turn asks the item editor creator for. In this case, you can use the QItemEditorCreator class, which takes the property name to use for editing as a constructor argument. - \o If the editor requires other constructors or other + \li If the editor requires other constructors or other initialization than provided by QItemEditorCreatorBase, you must reimplement QItemEditorCreatorBase::createWidget(). - \o You could also subclass QItemEditorFactory if you only want + \li You could also subclass QItemEditorFactory if you only want to provide editors for certain kinds of data or use another method of creating the editors than using creator bases. \endlist diff --git a/doc/src/examples/completer.qdoc b/doc/src/examples/completer.qdoc index 767efe8ef1..df832de4d6 100644 --- a/doc/src/examples/completer.qdoc +++ b/doc/src/examples/completer.qdoc @@ -77,8 +77,8 @@ The screenshots below illustrate this difference: \table - \row \o \inlineimage completer-example-qdirmodel.png - \o \inlineimage completer-example-dirmodel.png + \row \li \inlineimage completer-example-qdirmodel.png + \li \inlineimage completer-example-dirmodel.png \endtable The Qt::EditRole, which QCompleter uses to look for matches, is left diff --git a/doc/src/examples/composition.qdoc b/doc/src/examples/composition.qdoc index 1da41dbfef..6aca01d255 100644 --- a/doc/src/examples/composition.qdoc +++ b/doc/src/examples/composition.qdoc @@ -33,10 +33,10 @@ \image composition-demo.png - The two most common forms of composition are \bold{Source} and \bold{SourceOver}. - \bold{Source} is used to draw opaque objects onto a paint device. In this mode, + The two most common forms of composition are \b{Source} and \b{SourceOver}. + \b{Source} is used to draw opaque objects onto a paint device. In this mode, each pixel in the source replaces the corresponding pixel in the destination. - In \bold{SourceOver} composition mode, the source object is transparent and is + In \b{SourceOver} composition mode, the source object is transparent and is drawn on top of the destination. In addition to these standard modes, Qt defines the complete set of composition modes diff --git a/doc/src/examples/concentriccircles.qdoc b/doc/src/examples/concentriccircles.qdoc index 73b4937049..22b0be8fb8 100644 --- a/doc/src/examples/concentriccircles.qdoc +++ b/doc/src/examples/concentriccircles.qdoc @@ -59,9 +59,9 @@ The example consists of two classes: \list - \o \c CircleWidget is a custom widget which renders several animated + \li \c CircleWidget is a custom widget which renders several animated concentric circles. - \o \c Window is the application's main window displaying four \c + \li \c Window is the application's main window displaying four \c {CircleWidget}s drawn using different combinations of precision and aliasing. \endlist diff --git a/doc/src/examples/cube.qdoc b/doc/src/examples/cube.qdoc index 3c41856254..ec40be0f45 100644 --- a/doc/src/examples/cube.qdoc +++ b/doc/src/examples/cube.qdoc @@ -61,9 +61,9 @@ The example consist of two classes: \list - \o \c MainWidget extends QGLWidget and contains OpenGL ES 2.0 + \li \c MainWidget extends QGLWidget and contains OpenGL ES 2.0 initialization and drawing and mouse and timer event handling - \o \c GeometryEngine handles polygon geometries. Transfers polygon geometry + \li \c GeometryEngine handles polygon geometries. Transfers polygon geometry to vertex buffer objects and draws geometries from vertex buffer objects. \endlist diff --git a/doc/src/examples/customsortfiltermodel.qdoc b/doc/src/examples/customsortfiltermodel.qdoc index ac9fbb93a3..61230a7b9a 100644 --- a/doc/src/examples/customsortfiltermodel.qdoc +++ b/doc/src/examples/customsortfiltermodel.qdoc @@ -48,10 +48,10 @@ \list - \o The \c MySortFilterProxyModel class provides a custom proxy + \li The \c MySortFilterProxyModel class provides a custom proxy model. - \o The \c Window class provides the main application window, + \li The \c Window class provides the main application window, using the custom proxy model to sort and filter a standard item model. diff --git a/doc/src/examples/dbscreen.qdoc b/doc/src/examples/dbscreen.qdoc index 7d9cea5519..bfecb9a3cb 100644 --- a/doc/src/examples/dbscreen.qdoc +++ b/doc/src/examples/dbscreen.qdoc @@ -36,13 +36,13 @@ to writing and implementing this graphics driver: \list 1 - \o \l {Step 1: Creating a Custom Graphics Driver} + \li \l {Step 1: Creating a Custom Graphics Driver} {Creating a Custom Graphics Driver} - \o \l {Step 2: Implementing the Back Buffer} + \li \l {Step 2: Implementing the Back Buffer} {Implementing the Back Buffer} - \o \l {Step 3: Creating the Driver Plugin} + \li \l {Step 3: Creating the Driver Plugin} {Creating the Driver Plugin} \endlist @@ -71,11 +71,11 @@ functions belonging to QScreen: \list - \o \l{QScreen::initDevice()}{initDevice()}, - \o \l{QScreen::shutdownDevice()}{shutdownDevice()}, - \o \l{QScreen::blit()}{blit()}, - \o \l{QScreen::solidFill()}{solidFill()}, and - \o \l{QScreen::exposeRegion()}{exposeRegion()}. + \li \l{QScreen::initDevice()}{initDevice()}, + \li \l{QScreen::shutdownDevice()}{shutdownDevice()}, + \li \l{QScreen::blit()}{blit()}, + \li \l{QScreen::solidFill()}{solidFill()}, and + \li \l{QScreen::exposeRegion()}{exposeRegion()}. \endlist \snippet examples/qws/dbscreen/dbscreen.h 0 @@ -89,10 +89,10 @@ The graphics driver must carry out three main functions: \list 1 - \o Allocate the back buffer on startup and deallocate it on shutdown. - \o Draw to the back buffer instead of directly to the screen + \li Allocate the back buffer on startup and deallocate it on shutdown. + \li Draw to the back buffer instead of directly to the screen (which is what QLinuxFbScreen does). - \o Copy the back buffer to the screen whenever a screen update is + \li Copy the back buffer to the screen whenever a screen update is done. \endlist @@ -165,9 +165,9 @@ There are only two functions to reimplement: \list - \o \l{QScreenDriverPlugin::create()}{create()} - creates a driver + \li \l{QScreenDriverPlugin::create()}{create()} - creates a driver matching the given key - \o \l{QScreenDriverPlugin::create()}{keys()} - returns a list of + \li \l{QScreenDriverPlugin::create()}{keys()} - returns a list of valid keys representing the drivers supported by the plugin \endlist diff --git a/doc/src/examples/diagramscene.qdoc b/doc/src/examples/diagramscene.qdoc index 9f2a8f8b76..ac9ca2f294 100644 --- a/doc/src/examples/diagramscene.qdoc +++ b/doc/src/examples/diagramscene.qdoc @@ -55,28 +55,28 @@ In particular we show how to: \list - \o Create custom graphics items. - \o Handle mouse events and movement of items. - \o Implement a graphics scene that can manage our custom items. - \o Custom painting of items. - \o Create a movable and editable text item. + \li Create custom graphics items. + \li Handle mouse events and movement of items. + \li Implement a graphics scene that can manage our custom items. + \li Custom painting of items. + \li Create a movable and editable text item. \endlist The example consists of the following classes: \list - \o \c MainWindow creates the widgets and display + \li \c MainWindow creates the widgets and display them in a QMainWindow. It also manages the interaction between the widgets and the graphics scene, view and items. - \o \c DiagramItem inherits QGraphicsPolygonItem and + \li \c DiagramItem inherits QGraphicsPolygonItem and represents a flowchart shape. - \o \c TextDiagramItem inherits QGraphicsTextItem and + \li \c TextDiagramItem inherits QGraphicsTextItem and represents text items in the diagram. The class adds support for moving the item with the mouse, which is not supported by QGraphicsTextItem. - \o \c Arrow inherits QGraphicsLineItem and is an arrow + \li \c Arrow inherits QGraphicsLineItem and is an arrow that connect two DiagramItems. - \o \c DiagramScene inherits QGraphicsDiagramScene and + \li \c DiagramScene inherits QGraphicsDiagramScene and provides support for \c DiagramItem, \c Arrow and \c DiagramTextItem (In addition to the support already handled by QGraphicsScene). diff --git a/doc/src/examples/drilldown.qdoc b/doc/src/examples/drilldown.qdoc index 1e7b8c01d6..7f195d5261 100644 --- a/doc/src/examples/drilldown.qdoc +++ b/doc/src/examples/drilldown.qdoc @@ -45,13 +45,13 @@ The example consists of three classes: \list - \o \c ImageItem is a custom graphics item class used to + \li \c ImageItem is a custom graphics item class used to display the office images. - \o \c View is the main application widget allowing the user to + \li \c View is the main application widget allowing the user to browse through the various locations. - \o \c InformationWindow displays the requested information, + \li \c InformationWindow displays the requested information, allowing the users to alter it and submit their changes to the database. \endlist diff --git a/doc/src/examples/dropsite.qdoc b/doc/src/examples/dropsite.qdoc index 024d191b74..77b40986aa 100644 --- a/doc/src/examples/dropsite.qdoc +++ b/doc/src/examples/dropsite.qdoc @@ -53,10 +53,10 @@ reimplementations of four \l{QWidget} event handlers: \list 1 - \o \l{QWidget::dragEnterEvent()}{dragEnterEvent()} - \o \l{QWidget::dragMoveEvent()}{dragMoveEvent()} - \o \l{QWidget::dragLeaveEvent()}{dragLeaveEvent()} - \o \l{QWidget::dropEvent()}{dropEvent()} + \li \l{QWidget::dragEnterEvent()}{dragEnterEvent()} + \li \l{QWidget::dragMoveEvent()}{dragMoveEvent()} + \li \l{QWidget::dragLeaveEvent()}{dragLeaveEvent()} + \li \l{QWidget::dropEvent()}{dropEvent()} \endlist These event handlers are further explained in the implementation of the @@ -108,17 +108,17 @@ \snippet draganddrop/dropsite/droparea.cpp dropEvent() function part2 \list - \o If \c mimeData contains an image, we display it in \c DropArea with + \li If \c mimeData contains an image, we display it in \c DropArea with \l{QLabel::setPixmap()}{setPixmap()}. - \o If \c mimeData contains HTML, we display it with + \li If \c mimeData contains HTML, we display it with \l{QLabel::setText()}{setText()} and set \c{DropArea}'s text format as Qt::RichText. - \o If \c mimeData contains plain text, we display it with + \li If \c mimeData contains plain text, we display it with \l{QLabel::setText()}{setText()} and set \c{DropArea}'s text format as Qt::PlainText. In the event that \c mimeData contains URLs, we iterate through the list of URLs to display them on individual lines. - \o If \c mimeData contains other types of objects, we set + \li If \c mimeData contains other types of objects, we set \c{DropArea}'s text, with \l{QLabel::setText()}{setText()} to "Cannot display data" to inform the user. \endlist diff --git a/doc/src/examples/editabletreemodel.qdoc b/doc/src/examples/editabletreemodel.qdoc index 306295842e..958080ad58 100644 --- a/doc/src/examples/editabletreemodel.qdoc +++ b/doc/src/examples/editabletreemodel.qdoc @@ -82,8 +82,8 @@ \target Relations-between-internal-items \table - \row \o \inlineimage itemviews-editabletreemodel-items.png - \o \bold{Relations between internal items} + \row \li \inlineimage itemviews-editabletreemodel-items.png + \li \b{Relations between internal items} When designing a data structure for use with a custom model, it is useful to expose each item's parent via a function like @@ -99,10 +99,10 @@ \l{TreeItem::parent}{parent()} and \l{TreeItem::child}{child()} functions. - In the example shown, two top-level items, \bold{A} and - \bold{B}, can be obtained from the root item by calling its child() + In the example shown, two top-level items, \b{A} and + \b{B}, can be obtained from the root item by calling its child() function, and each of these items return the root node from their - parent() functions, though this is only shown for item \bold{A}. + parent() functions, though this is only shown for item \b{A}. \endtable Each \c TreeItem stores data for each column in the row it represents @@ -126,23 +126,23 @@ horizontal header titles. \table - \row \o \inlineimage itemviews-editabletreemodel-model.png - \o \bold{Accessing data via the model} + \row \li \inlineimage itemviews-editabletreemodel-model.png + \li \b{Accessing data via the model} In the case shown in the diagram, the piece of information represented - by \bold{a} can be obtained using the standard model/view API: + by \b{a} can be obtained using the standard model/view API: \snippet doc/src/snippets/code/doc_src_examples_editabletreemodel.cpp 0 Since each items holds pieces of data for each column in a given row, there can be many model indexes that map to the same \c TreeItem object. - For example, the information represented by \bold{b} can be obtained + For example, the information represented by \b{b} can be obtained using the following code: \snippet doc/src/snippets/code/doc_src_examples_editabletreemodel.cpp 1 The same underlying \c TreeItem would be accessed to obtain information - for the other model indexes in the same row as \bold{b}. + for the other model indexes in the same row as \b{b}. \endtable In the model class, \c TreeModel, we relate \c TreeItem objects to @@ -166,20 +166,20 @@ that the model does not attempt to access items that have been deleted. \table - \row \o \bold{Storing information in the underlying data structure} + \row \li \b{Storing information in the underlying data structure} Several pieces of data are stored as QVariant objects in the \c itemData member of each \c TreeItem instance The diagram shows how pieces of information, - represented by the labels \bold{a}, \bold{b} and \bold{c} in the - previous two diagrams, are stored in items \bold{A}, \bold{B} and - \bold{C} in the underlying data structure. Note that pieces of + represented by the labels \b{a}, \b{b} and \b{c} in the + previous two diagrams, are stored in items \b{A}, \b{B} and + \b{C} in the underlying data structure. Note that pieces of information from the same row in the model are all obtained from the same item. Each element in a list corresponds to a piece of information exposed by each column in a given row in the model. - \o \inlineimage itemviews-editabletreemodel-values.png + \li \inlineimage itemviews-editabletreemodel-values.png \endtable Since the \c TreeModel implementation has been designed for use with @@ -202,8 +202,8 @@ \target Relating-items-using-model-indexes \table \row - \o \inlineimage itemviews-editabletreemodel-indexes.png - \o \bold{Relating items using model indexes} + \li \inlineimage itemviews-editabletreemodel-indexes.png + \li \b{Relating items using model indexes} As with the \l{itemviews/simpletreemodel}{Simple Tree Model} example, the \c TreeModel needs to be able to take a model index, find the @@ -215,13 +215,13 @@ an item supplied by the caller, using the items shown in a \l{Relations-between-internal-items}{previous diagram}. - A pointer to item \bold{C} is obtained from the corresponding model index + A pointer to item \b{C} is obtained from the corresponding model index using the \l{QModelIndex::internalPointer()} function. The pointer was stored internally in the index when it was created. Since the child contains a pointer to its parent, we use its \l{TreeItem::parent}{parent()} - function to obtain a pointer to item \bold{B}. The parent model index is + function to obtain a pointer to item \b{B}. The parent model index is created using the QAbstractItemModel::createIndex() function, passing - the pointer to item \bold{B} as the internal pointer. + the pointer to item \b{B} as the internal pointer. \endtable \section1 TreeItem Class Definition diff --git a/doc/src/examples/elasticnodes.qdoc b/doc/src/examples/elasticnodes.qdoc index 51a0a6048a..bd25008f60 100644 --- a/doc/src/examples/elasticnodes.qdoc +++ b/doc/src/examples/elasticnodes.qdoc @@ -54,9 +54,9 @@ The \c Node class serves three purposes: \list - \o Painting a yellow gradient "ball" in two states: sunken and raised. - \o Managing connections to other nodes. - \o Calculating forces pulling and pushing the nodes in the grid. + \li Painting a yellow gradient "ball" in two states: sunken and raised. + \li Managing connections to other nodes. + \li Calculating forces pulling and pushing the nodes in the grid. \endlist Let's start by looking at the \c Node class declaration. diff --git a/doc/src/examples/fortuneclient.qdoc b/doc/src/examples/fortuneclient.qdoc index f2c6fa02d9..d997fc077e 100644 --- a/doc/src/examples/fortuneclient.qdoc +++ b/doc/src/examples/fortuneclient.qdoc @@ -47,14 +47,14 @@ \list - \o \e{The asynchronous (non-blocking) approach.} Operations are scheduled + \li \e{The asynchronous (non-blocking) approach.} Operations are scheduled and performed when control returns to Qt's event loop. When the operation is finished, QTcpSocket emits a signal. For example, QTcpSocket::connectToHost() returns immediately, and when the connection has been established, QTcpSocket emits \l{QTcpSocket::connected()}{connected()}. - \o \e{The synchronous (blocking) approach.} In non-GUI and multithreaded + \li \e{The synchronous (blocking) approach.} In non-GUI and multithreaded applications, you can call the \c waitFor...() functions (e.g., QTcpSocket::waitForConnected()) to suspend the calling thread until the operation has completed, instead of connecting to signals. @@ -107,11 +107,11 @@ one of two things can happen: \list - \o \e{The connection is established.} In this case, the server will send us a + \li \e{The connection is established.} In this case, the server will send us a fortune. QTcpSocket will emit \l{QTcpSocket::readyRead()}{readyRead()} every time it receives a block of data. - \o \e{An error occurs.} We need to inform the user if the connection + \li \e{An error occurs.} We need to inform the user if the connection failed or was broken. In this case, QTcpSocket will emit \l{QTcpSocket::error()}{error()}, and \c Client::displayError() will be called. diff --git a/doc/src/examples/fridgemagnets.qdoc b/doc/src/examples/fridgemagnets.qdoc index b2bd440707..7b7218bba2 100644 --- a/doc/src/examples/fridgemagnets.qdoc +++ b/doc/src/examples/fridgemagnets.qdoc @@ -39,9 +39,9 @@ the words on the magnets. The example consists of two classes: \list - \o \c DragLabel is a custom widget representing one + \li \c DragLabel is a custom widget representing one single fridge magnet. - \o \c DragWidget provides the main application window. + \li \c DragWidget provides the main application window. \endlist We will first take a look at the \c DragLabel class, then we will diff --git a/doc/src/examples/gradients.qdoc b/doc/src/examples/gradients.qdoc index 75876fdf2c..75f78b56ea 100644 --- a/doc/src/examples/gradients.qdoc +++ b/doc/src/examples/gradients.qdoc @@ -37,10 +37,10 @@ There are three types of gradients: \list - \o \bold{Linear} gradients interpolate colors between start and end points. - \o \bold{Radial} gradients interpolate colors between a focal point and the + \li \b{Linear} gradients interpolate colors between start and end points. + \li \b{Radial} gradients interpolate colors between a focal point and the points on a circle surrounding it. - \o \bold{Conical} gradients interpolate colors around a center point. + \li \b{Conical} gradients interpolate colors around a center point. \endlist The panel on the right contains a color table editor that defines diff --git a/doc/src/examples/hellogl.qdoc b/doc/src/examples/hellogl.qdoc index a0b6fc6c06..f6f8591ad0 100644 --- a/doc/src/examples/hellogl.qdoc +++ b/doc/src/examples/hellogl.qdoc @@ -285,12 +285,12 @@ by reimplementing the following functions: \list - \o QGLWidget::initializeGL() sets up resources needed by the OpenGL implementation + \li QGLWidget::initializeGL() sets up resources needed by the OpenGL implementation to render the scene. - \o QGLWidget::resizeGL() resizes the viewport so that the rendered scene fits onto + \li QGLWidget::resizeGL() resizes the viewport so that the rendered scene fits onto the widget, and sets up a projection matrix to map 3D coordinates to 2D viewport coordinates. - \o QGLWidget::paintGL() performs painting operations using OpenGL calls. + \li QGLWidget::paintGL() performs painting operations using OpenGL calls. \endlist Since QGLWidget is a subclass of QWidget, it can also be used diff --git a/doc/src/examples/icons.qdoc b/doc/src/examples/icons.qdoc index be7b0dd46c..9e7dda7c89 100644 --- a/doc/src/examples/icons.qdoc +++ b/doc/src/examples/icons.qdoc @@ -47,24 +47,24 @@ of the icon. Qt currently defines four modes: \table - \header \o Mode \o Description + \header \li Mode \li Description \row - \o QIcon::Normal - \o Display the pixmap when the user is not interacting with the + \li QIcon::Normal + \li Display the pixmap when the user is not interacting with the icon, but the functionality represented by the icon is available. \row - \o QIcon::Active - \o Display the pixmap when the functionality represented by the + \li QIcon::Active + \li Display the pixmap when the functionality represented by the icon is available and the user is interacting with the icon, for example, moving the mouse over it or clicking it. \row - \o QIcon::Disabled - \o Display the pixmap when the functionality represented by + \li QIcon::Disabled + \li Display the pixmap when the functionality represented by the icon is not available. \row - \o QIcon::Selected - \o Display the pixmap when the icon is selected. + \li QIcon::Selected + \li Display the pixmap when the icon is selected. \endtable QIcon's states are QIcon::On and QIcon::Off, which will display @@ -148,16 +148,16 @@ search algorithm described in the table below: \table 100% - \header \o{2,1} Requested Pixmap \o {8,1} Preferred Alternatives (mode/state) - \header \o Mode \o State \o 1 \o 2 \o 3 \o 4 \o 5 \o 6 \o 7 \o 8 - \row \o{1,2} Normal \o Off \o \bold N0 \o A0 \o N1 \o A1 \o D0 \o S0 \o D1 \o S1 - \row \o On \o N1 \o \bold A1 \o N0 \o A0 \o D1 \o S1 \o D0 \o S0 - \row \o{1,2} Active \o Off \o A0 \o \bold N0 \o A1 \o N1 \o D0 \o S0 \o D1 \o S1 - \row \o On \o \bold A1 \o N1 \o A0 \o N0 \o D1 \o S1 \o D0 \o S0 - \row \o{1,2} Disabled \o Off \o D0 \o \bold {N0'} \o A0' \o D1 \o N1' \o A1' \o S0' \o S1' - \row \o On \o D1 \o N1' \o \bold {A1'} \o D0 \o N0' \o A0' \o S1' \o S0' - \row \o{1,2} Selected \o Off \o S0 \o \bold {N0''} \o A0'' \o S1 \o N1'' \o A1'' \o D0'' \o D1'' - \row \o On \o S1 \o N1'' \o \bold {A1''} \o S0 \o N0'' \o A0'' \o D1'' \o D0'' + \header \li{2,1} Requested Pixmap \li {8,1} Preferred Alternatives (mode/state) + \header \li Mode \li State \li 1 \li 2 \li 3 \li 4 \li 5 \li 6 \li 7 \li 8 + \row \li{1,2} Normal \li Off \li \b N0 \li A0 \li N1 \li A1 \li D0 \li S0 \li D1 \li S1 + \row \li On \li N1 \li \b A1 \li N0 \li A0 \li D1 \li S1 \li D0 \li S0 + \row \li{1,2} Active \li Off \li A0 \li \b N0 \li A1 \li N1 \li D0 \li S0 \li D1 \li S1 + \row \li On \li \b A1 \li N1 \li A0 \li N0 \li D1 \li S1 \li D0 \li S0 + \row \li{1,2} Disabled \li Off \li D0 \li \b {N0'} \li A0' \li D1 \li N1' \li A1' \li S0' \li S1' + \row \li On \li D1 \li N1' \li \b {A1'} \li D0 \li N0' \li A0' \li S1' \li S0' + \row \li{1,2} Selected \li Off \li S0 \li \b {N0''} \li A0'' \li S1 \li N1'' \li A1'' \li D0'' \li D1'' + \row \li On \li S1 \li N1'' \li \b {A1''} \li S0 \li N0'' \li A0'' \li D1'' \li D0'' \endtable In the table, "0" and "1" stand for Off" and "On", respectively. @@ -176,8 +176,8 @@ \table \row - \o \inlineimage icons_monkey.png Screenshot of the Monkey Files - \o \inlineimage icons_monkey_mess.png Screenshot of the Monkey Files + \li \inlineimage icons_monkey.png Screenshot of the Monkey Files + \li \inlineimage icons_monkey_mess.png Screenshot of the Monkey Files \endtable For any given mode/state combination, it is possible to specify @@ -193,25 +193,25 @@ \table \row - \o - \o \inlineimage icons_qt_extended_8x8.png Qt Extended icon at 8 x 8 - \o \inlineimage icons_qt_extended_16x16.png Qt Extended icon at 16 x 16 - \o \inlineimage icons_qt_extended_17x17.png Qt Extended icon at 17 x 17 + \li + \li \inlineimage icons_qt_extended_8x8.png Qt Extended icon at 8 x 8 + \li \inlineimage icons_qt_extended_16x16.png Qt Extended icon at 16 x 16 + \li \inlineimage icons_qt_extended_17x17.png Qt Extended icon at 17 x 17 \row - \o - \o 8 x 8 - \o \bold {16 x 16} - \o 17 x 17 + \li + \li 8 x 8 + \li \b {16 x 16} + \li 17 x 17 \row - \o \inlineimage icons_qt_extended_32x32.png Qt Extended icon at 32 x 32 - \o \inlineimage icons_qt_extended_33x33.png Qt Extended icon at 33 x 33 - \o \inlineimage icons_qt_extended_48x48.png Qt Extended icon at 48 x 48 - \o \inlineimage icons_qt_extended_64x64.png Qt Extended icon at 64 x 64 + \li \inlineimage icons_qt_extended_32x32.png Qt Extended icon at 32 x 32 + \li \inlineimage icons_qt_extended_33x33.png Qt Extended icon at 33 x 33 + \li \inlineimage icons_qt_extended_48x48.png Qt Extended icon at 48 x 48 + \li \inlineimage icons_qt_extended_64x64.png Qt Extended icon at 64 x 64 \row - \o \bold {32 x 32} - \o 33 x 33 - \o \bold {48 x 48} - \o 64 x 64 + \li \b {32 x 32} + \li 33 x 33 + \li \b {48 x 48} + \li 64 x 64 \endtable For sizes up to 16 x 16, QIcon uses \c qt_extended_16x16.png and @@ -224,13 +224,13 @@ The Icons example consists of four classes: \list - \o \c MainWindow inherits QMainWindow and is the main application + \li \c MainWindow inherits QMainWindow and is the main application window. - \o \c IconPreviewArea is a custom widget that displays all + \li \c IconPreviewArea is a custom widget that displays all combinations of states and modes for a given icon. - \o \c IconSizeSpinBox is a subclass of QSpinBox that lets the + \li \c IconSizeSpinBox is a subclass of QSpinBox that lets the user enter icon sizes (e.g., "48 x 48"). - \o \c ImageDelegate is a subclass of QItemDelegate that provides + \li \c ImageDelegate is a subclass of QItemDelegate that provides comboboxes for letting the user set the mode and state associated with an image. \endlist @@ -332,13 +332,13 @@ constructor, and declare several private slots: \list - \o The \c about() slot simply provides information about the example. - \o The \c changeStyle() slot changes the application's GUI style and + \li The \c about() slot simply provides information about the example. + \li The \c changeStyle() slot changes the application's GUI style and adjust the style dependent size options. - \o The \c changeSize() slot changes the size of the preview area's icon. - \o The \c changeIcon() slot updates the set of pixmaps available to the + \li The \c changeSize() slot changes the size of the preview area's icon. + \li The \c changeIcon() slot updates the set of pixmaps available to the icon displayed in the preview area. - \o The \c addImage() slot allows the user to load a new image into the + \li The \c addImage() slot allows the user to load a new image into the application. \endlist diff --git a/doc/src/examples/imagecomposition.qdoc b/doc/src/examples/imagecomposition.qdoc index edefcface4..d7700858a0 100644 --- a/doc/src/examples/imagecomposition.qdoc +++ b/doc/src/examples/imagecomposition.qdoc @@ -86,11 +86,11 @@ We connect the following signals to their corresponding slots: \list - \o \c{sourceButton}'s \l{QPushButton::clicked()}{clicked()} signal is + \li \c{sourceButton}'s \l{QPushButton::clicked()}{clicked()} signal is connected to \c chooseSource(), - \o \c{operatorComboBox}'s \l{QComboBox::activated()}{activated()} + \li \c{operatorComboBox}'s \l{QComboBox::activated()}{activated()} signal is connected to \c recalculateResult(), and - \o \c{destinationButton}'s \l{QToolButton::clicked()}{clicked()} signal + \li \c{destinationButton}'s \l{QToolButton::clicked()}{clicked()} signal is connected to \c chooseDestination(). \endlist diff --git a/doc/src/examples/imageviewer.qdoc b/doc/src/examples/imageviewer.qdoc index 18cdccb5ed..638c0c3fb4 100644 --- a/doc/src/examples/imageviewer.qdoc +++ b/doc/src/examples/imageviewer.qdoc @@ -49,18 +49,18 @@ to: \list - \o \gui{Open...} - Open an image file - \o \gui{Print...} - Print an image - \o \gui{Exit} - Exit the application + \li \gui{Open...} - Open an image file + \li \gui{Print...} - Print an image + \li \gui{Exit} - Exit the application \endlist Once an image is loaded, the \gui View menu allows the users to: \list - \o \gui{Zoom In} - Scale the image up by 25% - \o \gui{Zoom Out} - Scale the image down by 25% - \o \gui{Normal Size} - Show the image at its original size - \o \gui{Fit to Window} - Stretch the image to occupy the entire window + \li \gui{Zoom In} - Scale the image up by 25% + \li \gui{Zoom Out} - Scale the image down by 25% + \li \gui{Normal Size} - Show the image at its original size + \li \gui{Fit to Window} - Stretch the image to occupy the entire window \endlist In addition the \gui Help menu provides the users with information @@ -202,9 +202,9 @@ \table \row - \o \inlineimage imageviewer-original_size.png - \o \inlineimage imageviewer-zoom_in_1.png - \o \inlineimage imageviewer-zoom_in_2.png + \li \inlineimage imageviewer-original_size.png + \li \inlineimage imageviewer-zoom_in_1.png + \li \inlineimage imageviewer-zoom_in_2.png \endtable \snippet examples/widgets/imageviewer/imageviewer.cpp 11 @@ -246,9 +246,9 @@ \table \row - \o \inlineimage imageviewer-original_size.png - \o \inlineimage imageviewer-fit_to_window_1.png - \o \inlineimage imageviewer-fit_to_window_2.png + \li \inlineimage imageviewer-original_size.png + \li \inlineimage imageviewer-fit_to_window_1.png + \li \inlineimage imageviewer-fit_to_window_2.png \endtable If the slot is called to turn off the option, the diff --git a/doc/src/examples/licensewizard.qdoc b/doc/src/examples/licensewizard.qdoc index 92e51dec3b..3a325100a7 100644 --- a/doc/src/examples/licensewizard.qdoc +++ b/doc/src/examples/licensewizard.qdoc @@ -50,10 +50,10 @@ The example consists of the following classes: \list - \o \c LicenseWizard inherits QWizard and implements a non-linear + \li \c LicenseWizard inherits QWizard and implements a non-linear five-page wizard that leads the user through the process of choosing a license agreement. - \o \c IntroPage, \c EvaluatePage, \c RegisterPage, \c + \li \c IntroPage, \c EvaluatePage, \c RegisterPage, \c DetailsPage, and \c ConclusionPage are QWizardPage subclasses that implement the wizard pages. \endlist @@ -71,12 +71,12 @@ The enum defines the IDs associated with the various pages: \table - \header \o Class name \o Enum value \o Page ID - \row \o \c IntroPage \o \c Page_Intro \o 0 - \row \o \c EvaluatePage \o \c Page_Evaluate \o 1 - \row \o \c RegisterPage \o \c Page_Register \o 2 - \row \o \c DetailsPage \o \c Page_Details \o 3 - \row \o \c ConclusionPage \o \c Page_Conclusion \o 4 + \header \li Class name \li Enum value \li Page ID + \row \li \c IntroPage \li \c Page_Intro \li 0 + \row \li \c EvaluatePage \li \c Page_Evaluate \li 1 + \row \li \c RegisterPage \li \c Page_Register \li 2 + \row \li \c DetailsPage \li \c Page_Details \li 3 + \row \li \c ConclusionPage \li \c Page_Conclusion \li 4 \endtable For this example, the IDs are arbitrary. The only constraints are @@ -206,11 +206,11 @@ QWidget::setVisible(): \list - \o If the page is shown, we set the \l{QWizard::}{CustomButton1} button's + \li If the page is shown, we set the \l{QWizard::}{CustomButton1} button's text to \gui{\underline{P}rint}, we enable the \l{QWizard::}{HaveCustomButton1} option, and we connect the QWizard's \l{QWizard::}{customButtonClicked()} signal to our \c printButtonClicked() slot. - \o If the page is hidden, we disable the \l{QWizard::}{HaveCustomButton1} + \li If the page is hidden, we disable the \l{QWizard::}{HaveCustomButton1} option and disconnect the \c printButtonClicked() slot. \endlist diff --git a/doc/src/examples/maemovibration.qdoc b/doc/src/examples/maemovibration.qdoc index 855793cf75..78bb7f5334 100644 --- a/doc/src/examples/maemovibration.qdoc +++ b/doc/src/examples/maemovibration.qdoc @@ -47,11 +47,11 @@ The code makes use of two classes: \list - \o \c MceVibrator connects to the MCE service and can start a certain + \li \c MceVibrator connects to the MCE service and can start a certain vibrator pattern. It also is responsible to parse the configuration file. - \o \c ButtonWidget provides a button for each pattern. Pressing the button + \li \c ButtonWidget provides a button for each pattern. Pressing the button activates the pattern in question. \endlist @@ -68,10 +68,10 @@ are available to us. \list - \o \c mceInterface is our D-Bus handle to the MCE service. We use it to + \li \c mceInterface is our D-Bus handle to the MCE service. We use it to invoke methods on the MCE request object. - \o \c lastPatternName contains the pattern that was activated last time. We + \li \c lastPatternName contains the pattern that was activated last time. We have to keep track of this, because the last pattern has to be deactivated before activating a new pattern. \endlist diff --git a/doc/src/examples/mandelbrot.qdoc b/doc/src/examples/mandelbrot.qdoc index 23e51ba637..a560766bdd 100644 --- a/doc/src/examples/mandelbrot.qdoc +++ b/doc/src/examples/mandelbrot.qdoc @@ -66,9 +66,9 @@ \table \row - \o \inlineimage mandelbrot_zoom1.png - \o \inlineimage mandelbrot_zoom2.png - \o \inlineimage mandelbrot_zoom3.png + \li \inlineimage mandelbrot_zoom1.png + \li \inlineimage mandelbrot_zoom2.png + \li \inlineimage mandelbrot_zoom3.png \endtable Similarly, when the user scrolls, the previous pixmap is scrolled @@ -77,17 +77,17 @@ \table \row - \o \inlineimage mandelbrot_scroll1.png - \o \inlineimage mandelbrot_scroll2.png - \o \inlineimage mandelbrot_scroll3.png + \li \inlineimage mandelbrot_scroll1.png + \li \inlineimage mandelbrot_scroll2.png + \li \inlineimage mandelbrot_scroll3.png \endtable The application consists of two classes: \list - \o \c RenderThread is a QThread subclass that renders + \li \c RenderThread is a QThread subclass that renders the Mandelbrot set. - \o \c MandelbrotWidget is a QWidget subclass that shows the + \li \c MandelbrotWidget is a QWidget subclass that shows the Mandelbrot set on screen and lets the user zoom and scroll. \endlist diff --git a/doc/src/examples/mousecalibration.qdoc b/doc/src/examples/mousecalibration.qdoc index b42d95956e..39b9140f28 100644 --- a/doc/src/examples/mousecalibration.qdoc +++ b/doc/src/examples/mousecalibration.qdoc @@ -39,8 +39,8 @@ The example consists of two classes in addition to the main program: \list - \o \c Calibration is a dialog widget that retrieves the device coordinates. - \o \c ScribbleWidget is a minimal drawing program used to let the user + \li \c Calibration is a dialog widget that retrieves the device coordinates. + \li \c ScribbleWidget is a minimal drawing program used to let the user test the new mouse settings. \endlist diff --git a/doc/src/examples/moveblocks.qdoc b/doc/src/examples/moveblocks.qdoc index d3332be834..38551abd28 100644 --- a/doc/src/examples/moveblocks.qdoc +++ b/doc/src/examples/moveblocks.qdoc @@ -40,14 +40,14 @@ The example consists of the following classes: \list - \o \c StateSwitcher inherits QState and can add + \li \c StateSwitcher inherits QState and can add \c {StateSwitchTransition}s to other states. When entered, it will randomly transition to one of these states. - \o \c StateSwitchTransition is a custom transition that + \li \c StateSwitchTransition is a custom transition that triggers on \c{StateSwitchEvent}s. - \o \c StateSwitchEvent is a QEvent that triggers \c{StateSwitchTransition}s. - \o \c QGraphicsRectWidget is a QGraphicsWidget that simply + \li \c StateSwitchEvent is a QEvent that triggers \c{StateSwitchTransition}s. + \li \c QGraphicsRectWidget is a QGraphicsWidget that simply paints its background in a solid \l{Qt::}{blue} color. \endlist diff --git a/doc/src/examples/orderform.qdoc b/doc/src/examples/orderform.qdoc index de967ecebd..94e4914444 100644 --- a/doc/src/examples/orderform.qdoc +++ b/doc/src/examples/orderform.qdoc @@ -161,21 +161,21 @@ \table \row - \o {1, 8} frame with \e{referenceFrameFormat} + \li {1, 8} frame with \e{referenceFrameFormat} \row - \o block \o \c{A company} + \li block \li \c{A company} \row - \o block + \li block \row - \o block \o \c{321 City Street} + \li block \li \c{321 City Street} \row - \o block + \li block \row - \o block \o \c{Industry Park} + \li block \li \c{Industry Park} \row - \o block + \li block \row - \o block \o \c{Another country} + \li block \li \c{Another country} \endtable This is accomplished with the following code: @@ -196,11 +196,11 @@ \table \row - \o block \o \c{Donald} + \li block \li \c{Donald} \row - \o block \o \c{47338 Park Avenue} + \li block \li \c{47338 Park Avenue} \row - \o block \o \c{Big City} + \li block \li \c{Big City} \endtable For spacing purposes, we invoke \l{QTextCursor::insertBlock()} @@ -221,21 +221,21 @@ \table \row - \o block + \li block \row - \o block + \li block \row - \o block \o \c{Date: 25 May 2007} + \li block \li \c{Date: 25 May 2007} \row - \o block + \li block \row - \o {1, 4} frame with \e{bodyFrameFormat} + \li {1, 4} frame with \e{bodyFrameFormat} \row - \o block \o \c{I would like to place an order for the following items:} + \li block \li \c{I would like to place an order for the following items:} \row - \o block + \li block \row - \o block + \li block \endtable A QTextTableFormat object, \c orderTableFormat, is used to hold the type @@ -257,27 +257,27 @@ \table \row - \o {1, 11} \c{orderTable} with \e{orderTableFormat} + \li {1, 11} \c{orderTable} with \e{orderTableFormat} \row - \o block \o \c{Product} + \li block \li \c{Product} \row - \o block \o \c{Quantity} + \li block \li \c{Quantity} \row - \o block \o \c{T-shirt} + \li block \li \c{T-shirt} \row - \o block \o \c{4} + \li block \li \c{4} \row - \o block \o \c{Badge} + \li block \li \c{Badge} \row - \o block \o \c{3} + \li block \li \c{3} \row - \o block \o \c{Reference book} + \li block \li \c{Reference book} \row - \o block \o \c{2} + \li block \li \c{2} \row - \o block \o \c{Coffee cup} + \li block \li \c{Coffee cup} \row - \o block \o \c{5} + \li block \li \c{5} \endtable The \c cursor is then moved back to \c{topFrame}'s @@ -296,19 +296,19 @@ \table \row - \o block + \li block \row - \o block\o \c{Please update my...} + \li block\li \c{Please update my...} \row - \o {1, 5} block + \li {1, 5} block \row - \o {1, 4} \c{offersTable} + \li {1, 4} \c{offersTable} \row - \o block \o \c{I want to receive...} + \li block \li \c{I want to receive...} \row - \o block \o \c{I do not want to receive...} + \li block \li \c{I do not want to receive...} \row - \o block \o \c{X} + \li block \li \c{X} \endtable The \c cursor is moved to insert "Sincerely" along with the customer's @@ -321,17 +321,17 @@ \table \row - \o block + \li block \row - \o {1, 5} block\o \c{Sincerely,} + \li {1, 5} block\li \c{Sincerely,} \row - \o block + \li block \row - \o block + \li block \row - \o block + \li block \row - \o block \o \c{Donald} + \li block \li \c{Donald} \endtable The \c createSample() function is used for illustration purposes, to create diff --git a/doc/src/examples/overpainting.qdoc b/doc/src/examples/overpainting.qdoc index 74f9f0a872..d20ee64698 100644 --- a/doc/src/examples/overpainting.qdoc +++ b/doc/src/examples/overpainting.qdoc @@ -214,30 +214,30 @@ calls, using the following approach: \list - \o Reimplement QGLWidget::initializeGL(), but only perform minimal + \li Reimplement QGLWidget::initializeGL(), but only perform minimal initialization. QPainter will perform its own initialization routines, modifying the matrix and property stacks, so it is better to defer certain initialization tasks until just before you render the 3D scene. - \o Reimplement QGLWidget::resizeGL() as in the pure 3D case. - \o Reimplement QWidget::paintEvent() to draw both 2D and 3D graphics. + \li Reimplement QGLWidget::resizeGL() as in the pure 3D case. + \li Reimplement QWidget::paintEvent() to draw both 2D and 3D graphics. \endlist The \l{QWidget::paintEvent()}{paintEvent()} implementation performs the following tasks: \list - \o Push the current OpenGL modelview matrix onto a stack. - \o Perform initialization tasks usually done in the + \li Push the current OpenGL modelview matrix onto a stack. + \li Perform initialization tasks usually done in the \l{QGLWidget::initializeGL()}{initializeGL()} function. - \o Perform code that would normally be located in the widget's + \li Perform code that would normally be located in the widget's \l{QGLWidget::resizeGL()}{resizeGL()} function to set the correct perspective transformation and set up the viewport. - \o Render the scene using OpenGL calls. - \o Pop the OpenGL modelview matrix off the stack. - \o Construct a QPainter object. - \o Initialize it for use on the widget with the QPainter::begin() function. - \o Draw primitives using QPainter's member functions. - \o Call QPainter::end() to finish painting. + \li Render the scene using OpenGL calls. + \li Pop the OpenGL modelview matrix off the stack. + \li Construct a QPainter object. + \li Initialize it for use on the widget with the QPainter::begin() function. + \li Draw primitives using QPainter's member functions. + \li Call QPainter::end() to finish painting. \endlist */ diff --git a/doc/src/examples/padnavigator.qdoc b/doc/src/examples/padnavigator.qdoc index 52d80adcb7..840c16b0c9 100644 --- a/doc/src/examples/padnavigator.qdoc +++ b/doc/src/examples/padnavigator.qdoc @@ -81,11 +81,11 @@ The private data members are: \list - \o \c pix: The optional pixmap that is drawn on top of the rectangle. - \o \c fillRect: Corresponds to the \c fill property. - \o \c color: The configurable gradient color fill of the rectangle. - \o \c bounds: The bounds of the rectangle. - \o \c gradient: A precalculated gradient used to fill the rectangle. + \li \c pix: The optional pixmap that is drawn on top of the rectangle. + \li \c fillRect: Corresponds to the \c fill property. + \li \c color: The configurable gradient color fill of the rectangle. + \li \c bounds: The bounds of the rectangle. + \li \c gradient: A precalculated gradient used to fill the rectangle. \endlist We will now review the \c RoundRectItem implementation. Let's start by @@ -320,13 +320,13 @@ QGraphicsRotation object for each of these. \list - \o \c flipRotation: Rotates the grid around its Qt::YAxis. This rotation is + \li \c flipRotation: Rotates the grid around its Qt::YAxis. This rotation is animated from 0 to 180, and eventually back, when enter is pressed on the keyboard, flipping the pad around. - \o \c xRotation: Rotates the grid around its Qt::XAxis. This is used to + \li \c xRotation: Rotates the grid around its Qt::XAxis. This is used to tilt the pad vertically corresponding to which item is currently selected. This way, the selected item is always kept in front. - \o \c yRotation: Rotates the grid around its Qt::YAxis. This is used to + \li \c yRotation: Rotates the grid around its Qt::YAxis. This is used to tilt the pad horizontally corresponding to which item is selected. This way, the selected item is always kept in front. \endlist @@ -391,11 +391,11 @@ values when flipped back: \list - \o \c smoothFlipRotation: Animates the main 180 degree rotation of the pad. - \o \c smoothFlipScale: Scales the pad out and then in again while the pad is rotating. - \o \c smoothFlipXRotation: Animates the selection item's X-tilt to 0 and back. - \o \c smoothFlipYRotation: Animates the selection item's Y-tilt to 0 and back. - \o \c flipAnimation: A parallel animation group that ensures all the above animations are run in parallel. + \li \c smoothFlipRotation: Animates the main 180 degree rotation of the pad. + \li \c smoothFlipScale: Scales the pad out and then in again while the pad is rotating. + \li \c smoothFlipXRotation: Animates the selection item's X-tilt to 0 and back. + \li \c smoothFlipYRotation: Animates the selection item's Y-tilt to 0 and back. + \li \c flipAnimation: A parallel animation group that ensures all the above animations are run in parallel. \endlist All animations are given a 500 millisecond duration and an @@ -433,10 +433,10 @@ states: \list - \o \c splashState: The initial state where the splash item is visible. - \o \c frontState: The base state where the splash is gone and we can see + \li \c splashState: The initial state where the splash item is visible. + \li \c frontState: The base state where the splash is gone and we can see the front side of the pad, and navigate the selection item. - \o \c backState: The flipped state where the \c backItem is visible, and we + \li \c backState: The flipped state where the \c backItem is visible, and we can interact with the QGraphicsProxyWidget-embedded form. \endlist @@ -531,18 +531,18 @@ The view toggles a few necessary properties: \list - \o It disables its scroll bars - this application has no use for scroll bars. - \o It assigns a minimum size. This is necessary to avoid numerical errors + \li It disables its scroll bars - this application has no use for scroll bars. + \li It assigns a minimum size. This is necessary to avoid numerical errors in our fit-in-view \c resizeEvent() implementation. - \o It sets \l{QGraphicsView::FullViewportUpdate}{FullViewportUpdate}, to + \li It sets \l{QGraphicsView::FullViewportUpdate}{FullViewportUpdate}, to ensure QGraphicsView doesn't spend time figuring out precisely what needs to be redrawn. This application is very simple - if anything changes, everything is updated. - \o It enables background caching - this makes no performance difference + \li It enables background caching - this makes no performance difference with OpenGL, but without OpenGL it avoids unnecessary re-scaling of the background pixmap. - \o It sets render hints that increase rendering quality. - \o If OpenGL is supported, a QGLWidget viewport is assigned to the view. + \li It sets render hints that increase rendering quality. + \li If OpenGL is supported, a QGLWidget viewport is assigned to the view. \endlist Finally, we start the state engine. diff --git a/doc/src/examples/painterpaths.qdoc b/doc/src/examples/painterpaths.qdoc index 868c4f5283..1bee28f029 100644 --- a/doc/src/examples/painterpaths.qdoc +++ b/doc/src/examples/painterpaths.qdoc @@ -48,9 +48,9 @@ The example consists of two classes: \list - \o The \c RenderArea class which is a custom widget displaying + \li The \c RenderArea class which is a custom widget displaying a single painter path. - \o The \c Window class which is the applications main window + \li The \c Window class which is the applications main window displaying several \c RenderArea widgets, and allowing the user to manipulate the painter paths' filling, pen, color and rotation angle. diff --git a/doc/src/examples/pixelator.qdoc b/doc/src/examples/pixelator.qdoc index 8eec198aba..6dff9e1b87 100644 --- a/doc/src/examples/pixelator.qdoc +++ b/doc/src/examples/pixelator.qdoc @@ -44,9 +44,9 @@ of standard views. To do this, we implement the following components: \list - \i A model which represents each pixel in an image as an item of data, where each + \li A model which represents each pixel in an image as an item of data, where each item contains a value for the brightness of the corresponding pixel. - \i A custom delegate that uses the information supplied by the model to represent + \li A custom delegate that uses the information supplied by the model to represent each pixel as a black circle on a white background, where the radius of the circle corresponds to the darkness of the pixel. \endlist diff --git a/doc/src/examples/plugandpaint.qdoc b/doc/src/examples/plugandpaint.qdoc index 118afa6a02..ee3f6fefe9 100644 --- a/doc/src/examples/plugandpaint.qdoc +++ b/doc/src/examples/plugandpaint.qdoc @@ -55,13 +55,13 @@ Plug & Paint consists of the following classes: \list - \o \c MainWindow is a QMainWindow subclass that provides the menu + \li \c MainWindow is a QMainWindow subclass that provides the menu system and that contains a \c PaintArea as the central widget. - \o \c PaintArea is a QWidget that allows the user to draw using a + \li \c PaintArea is a QWidget that allows the user to draw using a brush and to insert shapes. - \o \c PluginDialog is a dialog that shows information about the + \li \c PluginDialog is a dialog that shows information about the plugins detected by the application. - \o \c BrushInterface, \c ShapeInterface, and \c FilterInterface are + \li \c BrushInterface, \c ShapeInterface, and \c FilterInterface are abstract base classes that can be implemented by plugins to provide custom brushes, shapes, and image filters. \endlist @@ -321,10 +321,10 @@ plugin: \list 1 - \o Declare a plugin class. - \o Implement the interfaces provided by the plugin. - \o Export the plugin using the Q_EXPORT_PLUGIN2() macro. - \o Build the plugin using an adequate \c .pro file. + \li Declare a plugin class. + \li Implement the interfaces provided by the plugin. + \li Export the plugin using the Q_EXPORT_PLUGIN2() macro. + \li Build the plugin using an adequate \c .pro file. \endlist \section1 Declaration of the Plugin Class @@ -377,15 +377,15 @@ Then comes the brush-dependent part of the code: \list - \o If the brush is \gui{Pencil}, we just call + \li If the brush is \gui{Pencil}, we just call QPainter::drawLine() with the current QPen. - \o If the brush is \gui{Air Brush}, we start by setting the + \li If the brush is \gui{Air Brush}, we start by setting the painter's QBrush to Qt::Dense6Pattern to obtain a dotted pattern. Then we draw a circle filled with that QBrush several times, resulting in a thick line. - \o If the brush is \gui{Random Letters}, we draw a random letter + \li If the brush is \gui{Random Letters}, we draw a random letter at the new cursor position. Most of the code is for setting the font to be bold and larger than the default font and for computing an appropriate bounding rect. diff --git a/doc/src/examples/rogue.qdoc b/doc/src/examples/rogue.qdoc index 38c871c7db..44e371c667 100644 --- a/doc/src/examples/rogue.qdoc +++ b/doc/src/examples/rogue.qdoc @@ -64,10 +64,10 @@ The example consists of two classes: \list - \o \c Window draws the text display of the game and sets + \li \c Window draws the text display of the game and sets up the state machine. The window also has a status bar above the area in which the rouge moves. - \o \c MovementTransition is a transition that carries out + \li \c MovementTransition is a transition that carries out a single move of the rogue. \endlist diff --git a/doc/src/examples/screenshot.qdoc b/doc/src/examples/screenshot.qdoc index e99fe6cc19..7ee7ddb9c7 100644 --- a/doc/src/examples/screenshot.qdoc +++ b/doc/src/examples/screenshot.qdoc @@ -41,9 +41,9 @@ desktop. They are provided with a couple of options: \list - \o Delaying the screenshot, giving them time to rearrange + \li Delaying the screenshot, giving them time to rearrange their desktop. - \o Hiding the application's window while the screenshot is taken. + \li Hiding the application's window while the screenshot is taken. \endlist In addition the application allows the users to save their @@ -63,10 +63,10 @@ to facilitate the options: \list - \o The \c newScreenshot() slot prepares a new screenshot. - \o The \c saveScreenshot() slot saves the last screenshot. - \o The \c shootScreen() slot takes the screenshot. - \o The \c updateCheckBox() slot enables or disables the + \li The \c newScreenshot() slot prepares a new screenshot. + \li The \c saveScreenshot() slot saves the last screenshot. + \li The \c shootScreen() slot takes the screenshot. + \li The \c updateCheckBox() slot enables or disables the \gui {Hide This Window} option. \endlist diff --git a/doc/src/examples/scribble.qdoc b/doc/src/examples/scribble.qdoc index d9386843a5..5d801bf9cc 100644 --- a/doc/src/examples/scribble.qdoc +++ b/doc/src/examples/scribble.qdoc @@ -55,9 +55,9 @@ The example consists of two classes: \list - \o \c ScribbleArea is a custom widget that displays a QImage and + \li \c ScribbleArea is a custom widget that displays a QImage and allows to the user to draw on it. - \o \c MainWindow provides a menu above the \c ScribbleArea. + \li \c MainWindow provides a menu above the \c ScribbleArea. \endlist We will start by reviewing the \c ScribbleArea class. Then we will @@ -85,14 +85,14 @@ We also need the following private variables: \list - \o \c modified is \c true if there are unsaved + \li \c modified is \c true if there are unsaved changes to the image displayed in the scribble area. - \o \c scribbling is \c true while the user is pressing + \li \c scribbling is \c true while the user is pressing the left mouse button within the scribble area. - \o \c penWidth and \c penColor hold the currently + \li \c penWidth and \c penColor hold the currently set width and color for the pen used in the application. - \o \c image stores the image drawn by the user. - \o \c lastPoint holds the position of the cursor at the last + \li \c image stores the image drawn by the user. + \li \c lastPoint holds the position of the cursor at the last mouse press or mouse move event. \endlist @@ -176,18 +176,18 @@ good reasons for this: \list - \o The window system requires us to be able to redraw the widget + \li The window system requires us to be able to redraw the widget \e{at any time}. For example, if the window is minimized and restored, the window system might have forgotten the contents of the widget and send us a paint event. In other words, we can't rely on the window system to remember our image. - \o Qt normally doesn't allow us to paint outside of \c + \li Qt normally doesn't allow us to paint outside of \c paintEvent(). In particular, we can't paint from the mouse event handlers. (This behavior can be changed using the Qt::WA_PaintOnScreen widget attribute, though.) - \o If initialized properly, a QImage is guaranteed to use 8-bit + \li If initialized properly, a QImage is guaranteed to use 8-bit for each color channel (red, green, blue, and alpha), whereas a QWidget might have a lower color depth, depending on the monitor configuration. This means that if we load a 24-bit or diff --git a/doc/src/examples/simpletreemodel.qdoc b/doc/src/examples/simpletreemodel.qdoc index 36e0632eb2..ed584a3307 100644 --- a/doc/src/examples/simpletreemodel.qdoc +++ b/doc/src/examples/simpletreemodel.qdoc @@ -59,8 +59,8 @@ \target SimpleTreeModelStructure \table - \row \i \inlineimage treemodel-structure.png - \i \bold{Simple Tree Model Structure} + \row \li \inlineimage treemodel-structure.png + \li \b{Simple Tree Model Structure} The data is stored internally in the model using \c TreeItem objects that are linked together in a pointer-based tree structure. Generally, each @@ -101,14 +101,14 @@ structure. The functions provide the following features: \list - \o The \c appendChildItem() is used to add data when the model is first + \li The \c appendChildItem() is used to add data when the model is first constructed and is not used during normal use. - \o The \c child() and \c childCount() functions allow the model to obtain + \li The \c child() and \c childCount() functions allow the model to obtain information about any child items. - \o Information about the number of columns associated with the item is + \li Information about the number of columns associated with the item is provided by \c columnCount(), and the data in each column can be obtained with the data() function. - \o The \c row() and \c parent() functions are used to obtain the item's + \li The \c row() and \c parent() functions are used to obtain the item's row number and parent item. \endlist @@ -320,10 +320,10 @@ We process the text file with the following two rules: \list - \o For each pair of strings on each line, create an item (or node) + \li For each pair of strings on each line, create an item (or node) in a tree structure, and place each string in a column of data in the item. - \o When the first string on a line is indented with respect to the + \li When the first string on a line is indented with respect to the first string on the previous line, make the item a child of the previous item created. \endlist diff --git a/doc/src/examples/sipdialog.qdoc b/doc/src/examples/sipdialog.qdoc index 2b51af4fdc..b5f18cb4be 100644 --- a/doc/src/examples/sipdialog.qdoc +++ b/doc/src/examples/sipdialog.qdoc @@ -34,8 +34,8 @@ the Windows Mobile SIP (Software Input Panel) and reacts to it. \table - \row \o \inlineimage sipdialog-closed.png - \o \inlineimage sipdialog-opened.png + \row \li \inlineimage sipdialog-closed.png + \li \inlineimage sipdialog-opened.png \endtable Sometimes it is necessary for a dialog to take the SIP into account, @@ -90,10 +90,10 @@ The following signals are connected to their respective slots: \list - \o \c{button}'s \l{QPushButton::pressed()}{pressed()} signal to + \li \c{button}'s \l{QPushButton::pressed()}{pressed()} signal to \l{QApplication}'s \l{QApplication::closeAllWindows()} {closeAllWindows()} slot, - \o \l{QDesktopWidget}'s \l{QDesktopWidget::workAreaResized()} + \li \l{QDesktopWidget}'s \l{QDesktopWidget::workAreaResized()} {workAreaResized()} signal to \c{dialog}'s \c desktopResized() slot. \endlist diff --git a/doc/src/examples/sliders.qdoc b/doc/src/examples/sliders.qdoc index e71986bfc9..49d41a9d18 100644 --- a/doc/src/examples/sliders.qdoc +++ b/doc/src/examples/sliders.qdoc @@ -46,10 +46,10 @@ \list - \o \c SlidersGroup is a custom widget. It combines a QSlider, a + \li \c SlidersGroup is a custom widget. It combines a QSlider, a QScrollBar and a QDial. - \o \c Window is the main widget combining a QGroupBox and a + \li \c Window is the main widget combining a QGroupBox and a QStackedWidget. In this example, the QStackedWidget provides a stack of two \c SlidersGroup widgets. The QGroupBox contain several widgets that control the behavior of the slider-like @@ -122,10 +122,10 @@ slider-like widgets: \table - \header \o \o{2,1} QSlider \o{2,1} QScrollBar \o{2,1} QDial - \header \o \o Normal \o Inverted \o Normal \o Inverted \o Normal \o Inverted - \row \o Qt::Horizontal \o Left to right \o Right to left \o Left to right \o Right to left \o Clockwise \o Counterclockwise - \row \o Qt::Vertical \o Bottom to top \o Top to bottom \o Top to bottom \o Bottom to top \o Clockwise \o Counterclockwise + \header \li \li{2,1} QSlider \li{2,1} QScrollBar \li{2,1} QDial + \header \li \li Normal \li Inverted \li Normal \li Inverted \li Normal \li Inverted + \row \li Qt::Horizontal \li Left to right \li Right to left \li Left to right \li Right to left \li Clockwise \li Counterclockwise + \row \li Qt::Vertical \li Bottom to top \li Top to bottom \li Top to bottom \li Bottom to top \li Clockwise \li Counterclockwise \endtable It is common to invert the appearance of a vertical QSlider. A diff --git a/doc/src/examples/stardelegate.qdoc b/doc/src/examples/stardelegate.qdoc index 01507eaf82..c9cc1f40cf 100644 --- a/doc/src/examples/stardelegate.qdoc +++ b/doc/src/examples/stardelegate.qdoc @@ -58,15 +58,15 @@ The example consists of the following classes: \list - \o \c StarRating is the custom data type. It stores a rating + \li \c StarRating is the custom data type. It stores a rating expressed as stars, such as "2 out of 5 stars" or "5 out of 6 stars". - \o \c StarDelegate inherits QItemDelegate and provides support + \li \c StarDelegate inherits QItemDelegate and provides support for \c StarRating (in addition to the data types already handled by QItemDelegate). - \o \c StarEditor inherits QWidget and is used by \c StarDelegate + \li \c StarEditor inherits QWidget and is used by \c StarDelegate to let the user edit a star rating using the mouse. \endlist @@ -281,7 +281,7 @@ editor are: \list - \o It is possible to open editors programmatically by calling + \li It is possible to open editors programmatically by calling QAbstractItemView::edit(), instead of relying on edit triggers. This could be use to support other edit triggers than those offered by the QAbstractItemView::EditTrigger enum. @@ -289,7 +289,7 @@ item with the mouse might make sense as a way to pop up an editor. - \o By reimplementing QAbstractItemDelegate::editorEvent(), it is + \li By reimplementing QAbstractItemDelegate::editorEvent(), it is possible to implement the editor directly in the delegate, instead of creating a separate QWidget subclass. \endlist diff --git a/doc/src/examples/styles.qdoc b/doc/src/examples/styles.qdoc index 91fd1d54d7..d1f5091a4b 100644 --- a/doc/src/examples/styles.qdoc +++ b/doc/src/examples/styles.qdoc @@ -56,9 +56,9 @@ The example consists of the following classes: \list - \o \c NorwegianWoodStyle inherits from QMotifStyle and implements + \li \c NorwegianWoodStyle inherits from QMotifStyle and implements the Norwegian Wood style. - \o \c WidgetGallery is a \c QDialog subclass that shows the most + \li \c WidgetGallery is a \c QDialog subclass that shows the most common widgets and allows the user to switch style dynamically. \endlist @@ -91,16 +91,16 @@ resources}. \table - \row \o \inlineimage widgets/styles/images/woodbackground.png + \row \li \inlineimage widgets/styles/images/woodbackground.png - \o \bold{woodbackground.png} + \li \b{woodbackground.png} This texture is used as the background of most widgets. The wood pattern is horizontal. - \row \o \inlineimage widgets/styles/images/woodbutton.png + \row \li \inlineimage widgets/styles/images/woodbutton.png - \o \bold{woodbutton.png} + \li \b{woodbutton.png} This texture is used for filling push buttons and comboboxes. The wood pattern is vertical and more reddish @@ -261,17 +261,17 @@ them based on the state of the button: \list - \o If the button is a \l{QPushButton::flat}{flat button}, we use + \li If the button is a \l{QPushButton::flat}{flat button}, we use the \l{QPalette::Background}{Background} brush. We set \c darker to \c true if the button is \l{QAbstractButton::down}{down} or \l{QAbstractButton::checked}{checked}. - \o If the button is currently held down by the user or in the + \li If the button is currently held down by the user or in the \l{QAbstractButton::checked}{checked} state, we use the \l{QPalette::Mid}{Mid} component of the palette. We set \c darker to \c true if the button is \l{QAbstractButton::checked}{checked}. - \o Otherwise, we use the \l{QPalette::Button}{Button} component + \li Otherwise, we use the \l{QPalette::Button}{Button} component of the palette. \endlist diff --git a/doc/src/examples/svgalib.qdoc b/doc/src/examples/svgalib.qdoc index cac14a7469..f25a3e21a8 100644 --- a/doc/src/examples/svgalib.qdoc +++ b/doc/src/examples/svgalib.qdoc @@ -49,13 +49,13 @@ approach: \list 1 - \o \l {Step 1: Creating a Custom Graphics Driver} + \li \l {Step 1: Creating a Custom Graphics Driver} {Creating a Custom Graphics Driver} - \o \l {Step 2: Implementing a Custom Raster Paint Engine} + \li \l {Step 2: Implementing a Custom Raster Paint Engine} {Implementing a Custom Paint Engine} - \o \l {Step 3: Making the Widgets Aware of the Custom Paint + \li \l {Step 3: Making the Widgets Aware of the Custom Paint Engine}{Making the Widgets Aware of the Custom Paint Engine} \endlist @@ -69,8 +69,8 @@ \snippet doc/src/snippets/code/doc_src_examples_svgalib.qdoc 0 \table - \header \o SVGAlib - \row \o + \header \li SVGAlib + \row \li Instead of interfacing the graphics hardware directly, this example relies on \l {http://www.svgalib.org}{SVGAlib} being @@ -212,9 +212,9 @@ respectively. \table - \header \o Private Header Files + \header \li Private Header Files \row - \o + \li Note the \c include statement used by this class. The files prefixed with \c private/ are private headers file within @@ -285,9 +285,9 @@ adjustments of the graphics driver. \list - \o \l {Implementing a Custom Paint Device} - \o \l {Implementing a Custom Window Surface} - \o \l {Adjusting the Graphics Driver} + \li \l {Implementing a Custom Paint Device} + \li \l {Implementing a Custom Window Surface} + \li \l {Adjusting the Graphics Driver} \endlist \section2 Implementing a Custom Paint Device diff --git a/doc/src/examples/syntaxhighlighter.qdoc b/doc/src/examples/syntaxhighlighter.qdoc index d86719ab19..597a1a2bf3 100644 --- a/doc/src/examples/syntaxhighlighter.qdoc +++ b/doc/src/examples/syntaxhighlighter.qdoc @@ -40,9 +40,9 @@ The example consists of two classes: \list - \o The \c Highlighter class defines and applies the + \li The \c Highlighter class defines and applies the highlighting rules. - \o The \c MainWindow widget is the application's main window. + \li The \c MainWindow widget is the application's main window. \endlist We will first review the \c Highlighter class to see how you can diff --git a/doc/src/examples/tablet.qdoc b/doc/src/examples/tablet.qdoc index 249b593e9b..57fa7d5eca 100644 --- a/doc/src/examples/tablet.qdoc +++ b/doc/src/examples/tablet.qdoc @@ -61,15 +61,15 @@ The example consists of the following: \list - \o The \c MainWindow class inherits QMainWindow and creates + \li The \c MainWindow class inherits QMainWindow and creates the examples menus and connect their slots and signals. - \o The \c TabletCanvas class inherits QWidget and + \li The \c TabletCanvas class inherits QWidget and receives tablet events. It uses the events to paint on a offscreen pixmap, which it draws onto itself. - \o The \c TabletApplication class inherits QApplication. This + \li The \c TabletApplication class inherits QApplication. This class handles tablet events that are not sent to \c tabletEvent(). We will look at this later. - \o The \c main() function creates a \c MainWindow and shows it + \li The \c main() function creates a \c MainWindow and shows it as a top level window. \endlist diff --git a/doc/src/examples/tetrix.qdoc b/doc/src/examples/tetrix.qdoc index 1eb92a2a4a..fca5229ad8 100644 --- a/doc/src/examples/tetrix.qdoc +++ b/doc/src/examples/tetrix.qdoc @@ -53,11 +53,11 @@ This example shows how a simple game can be created using only three classes: \list - \o The \c TetrixWindow class is used to display the player's score, number of + \li The \c TetrixWindow class is used to display the player's score, number of lives, and information about the next piece to appear. - \o The \c TetrixBoard class contains the game logic, handles keyboard input, and + \li The \c TetrixBoard class contains the game logic, handles keyboard input, and displays the pieces on the playing area. - \o The \c TetrixPiece class contains information about each piece. + \li The \c TetrixPiece class contains information about each piece. \endlist In this approach, the \c TetrixBoard class is the most complex class, since it diff --git a/doc/src/examples/textfinder.qdoc b/doc/src/examples/textfinder.qdoc index 17c52c2208..8f1ed5d340 100644 --- a/doc/src/examples/textfinder.qdoc +++ b/doc/src/examples/textfinder.qdoc @@ -37,16 +37,16 @@ resource and is loaded into the display at startup. \table - \row \o \inlineimage textfinder-example-find.png - \o \inlineimage textfinder-example-find2.png + \row \li \inlineimage textfinder-example-find.png + \li \inlineimage textfinder-example-find2.png \endtable \section1 Setting Up The Resource File The resources required for Text Finder are: \list - \o \e{textfinder.ui} - the user interface file created in QtDesigner - \o \e{input.txt} - a text file containing some text to be displayed + \li \e{textfinder.ui} - the user interface file created in QtDesigner + \li \e{input.txt} - a text file containing some text to be displayed in the QTextEdit \endlist diff --git a/doc/src/examples/tooltips.qdoc b/doc/src/examples/tooltips.qdoc index d506268bd8..cfa1884097 100644 --- a/doc/src/examples/tooltips.qdoc +++ b/doc/src/examples/tooltips.qdoc @@ -53,8 +53,8 @@ The Tooltips example consists of two classes: \list - \o \c ShapeItem is a custom widget representing one single shape item. - \o \c SortingBox inherits from QWidget and is the application's main + \li \c ShapeItem is a custom widget representing one single shape item. + \li \c SortingBox inherits from QWidget and is the application's main widget. \endlist diff --git a/doc/src/examples/transformations.qdoc b/doc/src/examples/transformations.qdoc index 9a23c6c8e6..8bca26eb77 100644 --- a/doc/src/examples/transformations.qdoc +++ b/doc/src/examples/transformations.qdoc @@ -42,9 +42,9 @@ The example consists of two classes and a global enum: \list - \o The \c RenderArea class controls the rendering of a given shape. - \o The \c Window class is the application's main window. - \o The \c Operation enum describes the various transformation + \li The \c RenderArea class controls the rendering of a given shape. + \li The \c Window class is the application's main window. + \li The \c Operation enum describes the various transformation operations available in the application. \endlist diff --git a/doc/src/examples/trollprint.qdoc b/doc/src/examples/trollprint.qdoc index 4127348b39..63566bdc21 100644 --- a/doc/src/examples/trollprint.qdoc +++ b/doc/src/examples/trollprint.qdoc @@ -200,11 +200,11 @@ editor and follow these steps: \list - \o Uncomment the two lines that create a QLabel with the text + \li Uncomment the two lines that create a QLabel with the text "\<b\>TROLL PRINT\</b\>" in \c printpanel.cpp. - \o Word-tidying: Replace "2-sided" by "Two-sided" in \c printpanel.cpp. - \o Replace "1.0" with "1.1" everywhere it occurs in \c mainwindow.cpp. - \o Update the copyright year to 1999-2000 in \c mainwindow.cpp. + \li Word-tidying: Replace "2-sided" by "Two-sided" in \c printpanel.cpp. + \li Replace "1.0" with "1.1" everywhere it occurs in \c mainwindow.cpp. + \li Update the copyright year to 1999-2000 in \c mainwindow.cpp. \endlist (Of course the version number and copyright year would be consts or @@ -214,25 +214,25 @@ Linguist}. The following items are of special interest: \list - \o \c MainWindow + \li \c MainWindow \list - \o Troll Print 1.0 - marked "(obs.)", obsolete - \o About Troll Print 1.0 - marked "(obs.)", obsolete - \o Troll Print 1.0. Copyright 1999 Software, Inc. - + \li Troll Print 1.0 - marked "(obs.)", obsolete + \li About Troll Print 1.0 - marked "(obs.)", obsolete + \li Troll Print 1.0. Copyright 1999 Software, Inc. - marked obsolete - \o Troll Print 1.1 - automatically translated as + \li Troll Print 1.1 - automatically translated as "Troll Imprimir 1.1" - \o About Troll Print 1.1 - automatically translated as + \li About Troll Print 1.1 - automatically translated as "Troll Imprimir 1.1" - \o Troll Print 1.1. Copyright 1999-2000 Software, + \li Troll Print 1.1. Copyright 1999-2000 Software, Inc. - automatically translated as "Troll Imprimir 1.1. Copyright 1999-2000 Software, Inc." \endlist - \o \c PrintPanel + \li \c PrintPanel \list - \o 2-sided - marked "(obs.)", obsolete - \o \<b\>TROLL PRINT\</b\> - unmarked, i.e. untranslated - \o Two-sided - unmarked, i.e. untranslated. + \li 2-sided - marked "(obs.)", obsolete + \li \<b\>TROLL PRINT\</b\> - unmarked, i.e. untranslated + \li Two-sided - unmarked, i.e. untranslated. \endlist \endlist diff --git a/doc/src/examples/undoframework.qdoc b/doc/src/examples/undoframework.qdoc index 36e43f2ed8..0bc2efd025 100644 --- a/doc/src/examples/undoframework.qdoc +++ b/doc/src/examples/undoframework.qdoc @@ -61,18 +61,18 @@ The example consists of the following classes: \list - \o \c MainWindow is the main window and arranges the + \li \c MainWindow is the main window and arranges the example's widgets. It creates the commands based on user input and keeps them on the command stack. - \o \c AddCommand adds an item to the scene. - \o \c DeleteCommand deletes an item from the scene. - \o \c MoveCommand when an item is moved the MoveCommand keeps record + \li \c AddCommand adds an item to the scene. + \li \c DeleteCommand deletes an item from the scene. + \li \c MoveCommand when an item is moved the MoveCommand keeps record of the start and stop positions of the move, and it moves the item according to these when \c redo() and \c undo() is called. - \o \c DiagramScene inherits QGraphicsScene and + \li \c DiagramScene inherits QGraphicsScene and emits signals for the \c MoveComands when an item is moved. - \o \c DiagramItem inherits QGraphicsPolygonItem and represents + \li \c DiagramItem inherits QGraphicsPolygonItem and represents an item in the diagram. \endlist diff --git a/doc/src/examples/wiggly.qdoc b/doc/src/examples/wiggly.qdoc index 739f14d623..677e8b08ca 100644 --- a/doc/src/examples/wiggly.qdoc +++ b/doc/src/examples/wiggly.qdoc @@ -48,10 +48,10 @@ The example consists of two classes: \list - \o \c WigglyWidget is the custom widget displaying the text + \li \c WigglyWidget is the custom widget displaying the text in a wiggly line. - \o \c Dialog is the dialog widget allowing the user to enter a + \li \c Dialog is the dialog widget allowing the user to enter a text. It combines a \c WigglyWidget and a \c QLineEdit. \endlist diff --git a/doc/src/examples/windowflags.qdoc b/doc/src/examples/windowflags.qdoc index e39e4eddc7..09dc45c27f 100644 --- a/doc/src/examples/windowflags.qdoc +++ b/doc/src/examples/windowflags.qdoc @@ -46,10 +46,10 @@ The example consists of two classes: \list - \o \c ControllerWindow is the main application widget that allows + \li \c ControllerWindow is the main application widget that allows the user to choose among the available window flags, and displays the effect on a separate preview window. - \o \c PreviewWindow is a custom widget displaying the name of + \li \c PreviewWindow is a custom widget displaying the name of its currently set window flags in a read-only text editor. \endlist |