diff options
| author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 15:28:31 +0100 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 23:16:25 +0100 |
| commit | 95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch) | |
| tree | 9f6fa892ee78f584224320a195f03419c0fdbc21 /src/gui | |
| parent | 15e136d4e116c1513c106dfbb75e1953a7f3463c (diff) | |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: I519bf9c29b14092e3ab6067612f42bf749eeedf5
Reviewed-by: Shane Kearns <shane.kearns@accenture.com>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Diffstat (limited to 'src/gui')
39 files changed, 676 insertions, 676 deletions
diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp index b7e9275669..aa47616161 100644 --- a/src/gui/accessible/qaccessible.cpp +++ b/src/gui/accessible/qaccessible.cpp @@ -77,10 +77,10 @@ QT_BEGIN_NAMESPACE braille displays. Clients and servers communicate in the following way: \list - \o \e{AT Servers} notify the clients about events through calls to the + \li \e{AT Servers} notify the clients about events through calls to the updateAccessibility() function. - \o \e{AT Clients} request information about the objects in the server. + \li \e{AT Clients} request information about the objects in the server. The QAccessibleInterface class is the core interface, and encapsulates this information in a pure virtual API. Implementations of the interface are provided by Qt through the queryAccessibleInterface() API. @@ -748,12 +748,12 @@ QAccessibleInterface *QAccessibleEvent::accessibleInterface() const The AT client uses three basic concepts to acquire information about any accessible object in an application: \list - \i \e Properties The client can read information about + \li \e Properties The client can read information about accessible objects. In some cases the client can also modify these properties; such as text in a line edit. - \i \e Actions The client can invoke actions like pressing a button + \li \e Actions The client can invoke actions like pressing a button or . - \i \e{Relationships and Navigation} The client can traverse from one + \li \e{Relationships and Navigation} The client can traverse from one accessible object to another, using the relationships between objects. \endlist diff --git a/src/gui/accessible/qaccessible2.cpp b/src/gui/accessible/qaccessible2.cpp index db3028b371..d3dafb8820 100644 --- a/src/gui/accessible/qaccessible2.cpp +++ b/src/gui/accessible/qaccessible2.cpp @@ -371,14 +371,14 @@ QT_BEGIN_NAMESPACE In general you should use one of the predefined action names, unless describing an action that does not fit these: \table - \header \o Action name \o Description - \row \o \l checkAction() \o checks the item (checkbox, radio button, ...) - \row \o \l decreaseAction() \o decrease the value of the accessible (e.g. spinbox) - \row \o \l increaseAction() \o increase the value of the accessible (e.g. spinbox) - \row \o \l pressAction() \o press or click or activate the accessible (should correspont to clicking the object with the mouse) - \row \o \l setFocusAction() \o set the focus to this accessible - \row \o \l showMenuAction() \o show a context menu, corresponds to right-clicks - \row \o \l uncheckAction() \o uncheck the item (checkbox, radio button, ...) + \header \li Action name \li Description + \row \li \l checkAction() \li checks the item (checkbox, radio button, ...) + \row \li \l decreaseAction() \li decrease the value of the accessible (e.g. spinbox) + \row \li \l increaseAction() \li increase the value of the accessible (e.g. spinbox) + \row \li \l pressAction() \li press or click or activate the accessible (should correspont to clicking the object with the mouse) + \row \li \l setFocusAction() \li set the focus to this accessible + \row \li \l showMenuAction() \li show a context menu, corresponds to right-clicks + \row \li \l uncheckAction() \li uncheck the item (checkbox, radio button, ...) \endtable In order to invoke the action, \l doAction() is called with an action name. diff --git a/src/gui/image/qimage.cpp b/src/gui/image/qimage.cpp index 5b23dbf4dc..6ce08d93cc 100644 --- a/src/gui/image/qimage.cpp +++ b/src/gui/image/qimage.cpp @@ -327,17 +327,17 @@ bool QImageData::checkForAlphaPixels() const formats: \table - \header \o Format \o Description \o Qt's support - \row \o BMP \o Windows Bitmap \o Read/write - \row \o GIF \o Graphic Interchange Format (optional) \o Read - \row \o JPG \o Joint Photographic Experts Group \o Read/write - \row \o JPEG \o Joint Photographic Experts Group \o Read/write - \row \o PNG \o Portable Network Graphics \o Read/write - \row \o PBM \o Portable Bitmap \o Read - \row \o PGM \o Portable Graymap \o Read - \row \o PPM \o Portable Pixmap \o Read/write - \row \o XBM \o X11 Bitmap \o Read/write - \row \o XPM \o X11 Pixmap \o Read/write + \header \li Format \li Description \li Qt's support + \row \li BMP \li Windows Bitmap \li Read/write + \row \li GIF \li Graphic Interchange Format (optional) \li Read + \row \li JPG \li Joint Photographic Experts Group \li Read/write + \row \li JPEG \li Joint Photographic Experts Group \li Read/write + \row \li PNG \li Portable Network Graphics \li Read/write + \row \li PBM \li Portable Bitmap \li Read + \row \li PGM \li Portable Graymap \li Read + \row \li PPM \li Portable Pixmap \li Read/write + \row \li XBM \li X11 Bitmap \li Read/write + \row \li XPM \li X11 Pixmap \li Read/write \endtable \section1 Image Information @@ -347,11 +347,11 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o \o Available Functions + \li \li Available Functions \row - \o Geometry - \o + \li Geometry + \li The size(), width(), height(), dotsPerMeterX(), and dotsPerMeterY() functions provide information about the image size @@ -365,8 +365,8 @@ bool QImageData::checkForAlphaPixels() const setOffset() function. \row - \o Colors - \o + \li Colors + \li The color of a pixel can be retrieved by passing its coordinates to the pixel() function. The pixel() function returns the color @@ -392,8 +392,8 @@ bool QImageData::checkForAlphaPixels() const sections. \row - \o Text - \o + \li Text + \li The text() function returns the image text associated with the given text key. An image's text keys can be retrieved using the @@ -401,8 +401,8 @@ bool QImageData::checkForAlphaPixels() const image's text. \row - \o Low-level information - \o + \li Low-level information + \li The depth() function returns the depth of the image. The supported depths are 1 (monochrome), 8, 16, 24 and 32 bits. The @@ -434,10 +434,10 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o {2,1}32-bit + \li {2,1}32-bit \row - \o \inlineimage qimage-32bit_scaled.png - \o + \li \inlineimage qimage-32bit_scaled.png + \li \snippet doc/src/snippets/code/src_gui_image_qimage.cpp 0 \endtable @@ -455,10 +455,10 @@ bool QImageData::checkForAlphaPixels() const \table \header - \o {2,1} 8-bit + \li {2,1} 8-bit \row - \o \inlineimage qimage-8bit_scaled.png - \o + \li \inlineimage qimage-8bit_scaled.png + \li \snippet doc/src/snippets/code/src_gui_image_qimage.cpp 1 \endtable @@ -529,28 +529,28 @@ bool QImageData::checkForAlphaPixels() const in-place: \table - \header \o Function \o Description + \header \li Function \li Description \row - \o setDotsPerMeterX() - \o Defines the aspect ratio by setting the number of pixels that fit + \li setDotsPerMeterX() + \li Defines the aspect ratio by setting the number of pixels that fit horizontally in a physical meter. \row - \o setDotsPerMeterY() - \o Defines the aspect ratio by setting the number of pixels that fit + \li setDotsPerMeterY() + \li Defines the aspect ratio by setting the number of pixels that fit vertically in a physical meter. \row - \o fill() - \o Fills the entire image with the given pixel value. + \li fill() + \li Fills the entire image with the given pixel value. \row - \o invertPixels() - \o Inverts all pixel values in the image using the given InvertMode value. + \li invertPixels() + \li Inverts all pixel values in the image using the given InvertMode value. \row - \o setColorTable() - \o Sets the color table used to translate color indexes. Only + \li setColorTable() + \li Sets the color table used to translate color indexes. Only monochrome and 8-bit formats. \row - \o setColorCount() - \o Resizes the color table. Only monochrome and 8-bit formats. + \li setColorCount() + \li Resizes the color table. Only monochrome and 8-bit formats. \endtable @@ -3794,11 +3794,11 @@ bool QImage::isGrayscale() const \image qimage-scaling.png \list - \i If \a aspectRatioMode is Qt::IgnoreAspectRatio, the image + \li If \a aspectRatioMode is Qt::IgnoreAspectRatio, the image is scaled to \a size. - \i If \a aspectRatioMode is Qt::KeepAspectRatio, the image is + \li If \a aspectRatioMode is Qt::KeepAspectRatio, the image is scaled to a rectangle as large as possible inside \a size, preserving the aspect ratio. - \i If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, + \li If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, the image is scaled to a rectangle as small as possible outside \a size, preserving the aspect ratio. \endlist diff --git a/src/gui/image/qimagereader.cpp b/src/gui/image/qimagereader.cpp index 4a9a9b00f4..870784f638 100644 --- a/src/gui/image/qimagereader.cpp +++ b/src/gui/image/qimagereader.cpp @@ -703,22 +703,22 @@ QByteArray QImageReader::format() const \list - \o Image plugins are queried first, based on either the optional format + \li Image plugins are queried first, based on either the optional format string, or the file name suffix (if the source device is a file). No content detection is done at this stage. QImageReader will choose the first plugin that supports reading for this format. - \o If no plugin supports the image format, Qt's built-in handlers are + \li If no plugin supports the image format, Qt's built-in handlers are checked based on either the optional format string, or the file name suffix. - \o If no capable plugins or built-in handlers are found, each plugin is + \li If no capable plugins or built-in handlers are found, each plugin is tested by inspecting the content of the data stream. - \o If no plugins could detect the image format based on data contents, + \li If no plugins could detect the image format based on data contents, each built-in image handler is tested by inspecting the contents. - \o Finally, if all above approaches fail, QImageReader will report failure + \li Finally, if all above approaches fail, QImageReader will report failure when trying to read the image. \endlist @@ -1423,18 +1423,18 @@ QByteArray QImageReader::imageFormat(QIODevice *device) By default, Qt can read the following formats: \table - \header \o Format \o Description - \row \o BMP \o Windows Bitmap - \row \o GIF \o Graphic Interchange Format (optional) - \row \o JPG \o Joint Photographic Experts Group - \row \o JPEG \o Joint Photographic Experts Group - \row \o PNG \o Portable Network Graphics - \row \o PBM \o Portable Bitmap - \row \o PGM \o Portable Graymap - \row \o PPM \o Portable Pixmap - \row \o XBM \o X11 Bitmap - \row \o XPM \o X11 Pixmap - \row \o SVG \o Scalable Vector Graphics + \header \li Format \li Description + \row \li BMP \li Windows Bitmap + \row \li GIF \li Graphic Interchange Format (optional) + \row \li JPG \li Joint Photographic Experts Group + \row \li JPEG \li Joint Photographic Experts Group + \row \li PNG \li Portable Network Graphics + \row \li PBM \li Portable Bitmap + \row \li PGM \li Portable Graymap + \row \li PPM \li Portable Pixmap + \row \li XBM \li X11 Bitmap + \row \li XPM \li X11 Pixmap + \row \li SVG \li Scalable Vector Graphics \endtable Reading and writing SVG files is supported through Qt's diff --git a/src/gui/image/qimagewriter.cpp b/src/gui/image/qimagewriter.cpp index 966017452c..8395f9d216 100644 --- a/src/gui/image/qimagewriter.cpp +++ b/src/gui/image/qimagewriter.cpp @@ -653,14 +653,14 @@ bool QImageWriter::supportsOption(QImageIOHandler::ImageOption option) const By default, Qt can write the following formats: \table - \header \o Format \o Description - \row \o BMP \o Windows Bitmap - \row \o JPG \o Joint Photographic Experts Group - \row \o JPEG \o Joint Photographic Experts Group - \row \o PNG \o Portable Network Graphics - \row \o PPM \o Portable Pixmap - \row \o XBM \o X11 Bitmap - \row \o XPM \o X11 Pixmap + \header \li Format \li Description + \row \li BMP \li Windows Bitmap + \row \li JPG \li Joint Photographic Experts Group + \row \li JPEG \li Joint Photographic Experts Group + \row \li PNG \li Portable Network Graphics + \row \li PPM \li Portable Pixmap + \row \li XBM \li X11 Bitmap + \row \li XPM \li X11 Pixmap \endtable Reading and writing SVG files is supported through Qt's diff --git a/src/gui/image/qpixmap.cpp b/src/gui/image/qpixmap.cpp index e8c1304b74..504f583baf 100644 --- a/src/gui/image/qpixmap.cpp +++ b/src/gui/image/qpixmap.cpp @@ -1052,11 +1052,11 @@ bool QPixmap::convertFromImage(const QImage &image, Qt::ImageConversionFlags fla \image qimage-scaling.png \list - \i If \a aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap + \li If \a aspectRatioMode is Qt::IgnoreAspectRatio, the pixmap is scaled to \a size. - \i If \a aspectRatioMode is Qt::KeepAspectRatio, the pixmap is + \li If \a aspectRatioMode is Qt::KeepAspectRatio, the pixmap is scaled to a rectangle as large as possible inside \a size, preserving the aspect ratio. - \i If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, + \li If \a aspectRatioMode is Qt::KeepAspectRatioByExpanding, the pixmap is scaled to a rectangle as small as possible outside \a size, preserving the aspect ratio. \endlist @@ -1273,17 +1273,17 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) formats: \table - \header \o Format \o Description \o Qt's support - \row \o BMP \o Windows Bitmap \o Read/write - \row \o GIF \o Graphic Interchange Format (optional) \o Read - \row \o JPG \o Joint Photographic Experts Group \o Read/write - \row \o JPEG \o Joint Photographic Experts Group \o Read/write - \row \o PNG \o Portable Network Graphics \o Read/write - \row \o PBM \o Portable Bitmap \o Read - \row \o PGM \o Portable Graymap \o Read - \row \o PPM \o Portable Pixmap \o Read/write - \row \o XBM \o X11 Bitmap \o Read/write - \row \o XPM \o X11 Pixmap \o Read/write + \header \li Format \li Description \li Qt's support + \row \li BMP \li Windows Bitmap \li Read/write + \row \li GIF \li Graphic Interchange Format (optional) \li Read + \row \li JPG \li Joint Photographic Experts Group \li Read/write + \row \li JPEG \li Joint Photographic Experts Group \li Read/write + \row \li PNG \li Portable Network Graphics \li Read/write + \row \li PBM \li Portable Bitmap \li Read + \row \li PGM \li Portable Graymap \li Read + \row \li PPM \li Portable Pixmap \li Read/write + \row \li XBM \li X11 Bitmap \li Read/write + \row \li XPM \li X11 Pixmap \li Read/write \endtable \section1 Pixmap Information @@ -1293,17 +1293,17 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) \table \header - \o \o Available Functions + \li \li Available Functions \row - \o Geometry - \o + \li Geometry + \li The size(), width() and height() functions provide information about the pixmap's size. The rect() function returns the image's enclosing rectangle. \row - \o Alpha component - \o + \li Alpha component + \li The hasAlphaChannel() returns true if the pixmap has a format that respects the alpha channel, otherwise returns false. The hasAlpha(), @@ -1318,8 +1318,8 @@ QPixmap QPixmap::transformed(const QMatrix &matrix, Qt::TransformationMode mode) QBitmap) for the pixmap based on a given color. \row - \o Low-level information - \o + \li Low-level information + \li The depth() function returns the depth of the pixmap. The defaultDepth() function returns the default depth, i.e. the depth diff --git a/src/gui/kernel/qclipboard.cpp b/src/gui/kernel/qclipboard.cpp index 8e881aabc7..27179cf141 100644 --- a/src/gui/kernel/qclipboard.cpp +++ b/src/gui/kernel/qclipboard.cpp @@ -86,18 +86,18 @@ QT_BEGIN_NAMESPACE \list - \i The X11 Window System has the concept of a separate selection + \li The X11 Window System has the concept of a separate selection and clipboard. When text is selected, it is immediately available as the global mouse selection. The global mouse selection may later be copied to the clipboard. By convention, the middle mouse button is used to paste the global mouse selection. - \i X11 also has the concept of ownership; if you change the + \li X11 also has the concept of ownership; if you change the selection within a window, X11 will only notify the owner and the previous owner of the change, i.e. it will not notify all applications that the selection or clipboard data changed. - \i Lastly, the X11 clipboard is event driven, i.e. the clipboard + \li Lastly, the X11 clipboard is event driven, i.e. the clipboard will not function properly if the event loop is not running. Similarly, it is recommended that the contents of the clipboard are stored or retrieved in direct response to user-input events, @@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE store or retrieve the clipboard contents in response to timer or non-user-input events. - \i Since there is no standard way to copy and paste files between + \li Since there is no standard way to copy and paste files between applications on X11, various MIME types and conventions are currently in use. For instance, Nautilus expects files to be supplied with a \c{x-special/gnome-copied-files} MIME type with data beginning with @@ -123,12 +123,12 @@ QT_BEGIN_NAMESPACE \list - \i Windows and Mac OS X do not support the global mouse + \li Windows and Mac OS X do not support the global mouse selection; they only supports the global clipboard, i.e. they only add text to the clipboard when an explicit copy or cut is made. - \i Windows and Mac OS X does not have the concept of ownership; + \li Windows and Mac OS X does not have the concept of ownership; the clipboard is a fully global resource so all applications are notified of changes. diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp index 77eb1e1e9c..f16e5c85de 100644 --- a/src/gui/kernel/qcursor.cpp +++ b/src/gui/kernel/qcursor.cpp @@ -85,7 +85,7 @@ QT_BEGIN_NAMESPACE To set or get the position of the mouse cursor use the static methods QCursor::pos() and QCursor::setPos(). - \bold{Note:} It is possible to create a QCursor before + \b{Note:} It is possible to create a QCursor before QGuiApplication, but it is not useful except as a place-holder for a real QCursor created after QGuiApplication. Attempting to use a QCursor that was created before QGuiApplication will result in a @@ -104,50 +104,50 @@ QT_BEGIN_NAMESPACE theme, while others will use an internal bitmap cursor. \table - \header \o Shape \o Qt::CursorShape Value \o Cursor Name - \o Shape \o Qt::CursorShape Value \o Cursor Name - \row \o \inlineimage cursor-arrow.png - \o Qt::ArrowCursor \o \c left_ptr - \o \inlineimage cursor-sizev.png - \o Qt::SizeVerCursor \o \c size_ver - \row \o \inlineimage cursor-uparrow.png - \o Qt::UpArrowCursor \o \c up_arrow - \o \inlineimage cursor-sizeh.png - \o Qt::SizeHorCursor \o \c size_hor - \row \o \inlineimage cursor-cross.png - \o Qt::CrossCursor \o \c cross - \o \inlineimage cursor-sizeb.png - \o Qt::SizeBDiagCursor \o \c size_bdiag - \row \o \inlineimage cursor-ibeam.png - \o Qt::IBeamCursor \o \c ibeam - \o \inlineimage cursor-sizef.png - \o Qt::SizeFDiagCursor \o \c size_fdiag - \row \o \inlineimage cursor-wait.png - \o Qt::WaitCursor \o \c wait - \o \inlineimage cursor-sizeall.png - \o Qt::SizeAllCursor \o \c size_all - \row \o \inlineimage cursor-busy.png - \o Qt::BusyCursor \o \c left_ptr_watch - \o \inlineimage cursor-vsplit.png - \o Qt::SplitVCursor \o \c split_v - \row \o \inlineimage cursor-forbidden.png - \o Qt::ForbiddenCursor \o \c forbidden - \o \inlineimage cursor-hsplit.png - \o Qt::SplitHCursor \o \c split_h - \row \o \inlineimage cursor-hand.png - \o Qt::PointingHandCursor \o \c pointing_hand - \o \inlineimage cursor-openhand.png - \o Qt::OpenHandCursor \o \c openhand - \row \o \inlineimage cursor-whatsthis.png - \o Qt::WhatsThisCursor \o \c whats_this - \o \inlineimage cursor-closedhand.png - \o Qt::ClosedHandCursor \o \c closedhand - \row \o - \o Qt::DragMoveCursor \o \c dnd-move or \c move - \o - \o Qt::DragCopyCursor \o \c dnd-copy or \c copy - \row \o - \o Qt::DragLinkCursor \o \c dnd-link or \c link + \header \li Shape \li Qt::CursorShape Value \li Cursor Name + \li Shape \li Qt::CursorShape Value \li Cursor Name + \row \li \inlineimage cursor-arrow.png + \li Qt::ArrowCursor \li \c left_ptr + \li \inlineimage cursor-sizev.png + \li Qt::SizeVerCursor \li \c size_ver + \row \li \inlineimage cursor-uparrow.png + \li Qt::UpArrowCursor \li \c up_arrow + \li \inlineimage cursor-sizeh.png + \li Qt::SizeHorCursor \li \c size_hor + \row \li \inlineimage cursor-cross.png + \li Qt::CrossCursor \li \c cross + \li \inlineimage cursor-sizeb.png + \li Qt::SizeBDiagCursor \li \c size_bdiag + \row \li \inlineimage cursor-ibeam.png + \li Qt::IBeamCursor \li \c ibeam + \li \inlineimage cursor-sizef.png + \li Qt::SizeFDiagCursor \li \c size_fdiag + \row \li \inlineimage cursor-wait.png + \li Qt::WaitCursor \li \c wait + \li \inlineimage cursor-sizeall.png + \li Qt::SizeAllCursor \li \c size_all + \row \li \inlineimage cursor-busy.png + \li Qt::BusyCursor \li \c left_ptr_watch + \li \inlineimage cursor-vsplit.png + \li Qt::SplitVCursor \li \c split_v + \row \li \inlineimage cursor-forbidden.png + \li Qt::ForbiddenCursor \li \c forbidden + \li \inlineimage cursor-hsplit.png + \li Qt::SplitHCursor \li \c split_h + \row \li \inlineimage cursor-hand.png + \li Qt::PointingHandCursor \li \c pointing_hand + \li \inlineimage cursor-openhand.png + \li Qt::OpenHandCursor \li \c openhand + \row \li \inlineimage cursor-whatsthis.png + \li Qt::WhatsThisCursor \li \c whats_this + \li \inlineimage cursor-closedhand.png + \li Qt::ClosedHandCursor \li \c closedhand + \row \li + \li Qt::DragMoveCursor \li \c dnd-move or \c move + \li + \li Qt::DragCopyCursor \li \c dnd-copy or \c copy + \row \li + \li Qt::DragLinkCursor \li \c dnd-link or \c link \endtable \sa QWidget, {fowler}{GUI Design Handbook: Cursors} @@ -346,10 +346,10 @@ QCursor::QCursor(const QPixmap &pixmap, int hotX, int hotY) The cursor \a bitmap (B) and \a mask (M) bits are combined like this: \list - \o B=1 and M=1 gives black. - \o B=0 and M=1 gives white. - \o B=0 and M=0 gives transparent. - \o B=1 and M=0 gives an XOR'd result under Windows, undefined + \li B=1 and M=1 gives black. + \li B=0 and M=1 gives white. + \li B=0 and M=0 gives transparent. + \li B=1 and M=0 gives an XOR'd result under Windows, undefined results on all other platforms. \endlist diff --git a/src/gui/kernel/qdrag.cpp b/src/gui/kernel/qdrag.cpp index ead0805bd1..40015c8706 100644 --- a/src/gui/kernel/qdrag.cpp +++ b/src/gui/kernel/qdrag.cpp @@ -176,7 +176,7 @@ QPixmap QDrag::pixmap() const Sets the position of the hot spot relative to the top-left corner of the pixmap used to the point specified by \a hotspot. - \bold{Note:} on X11, the pixmap may not be able to keep up with the mouse + \b{Note:} on X11, the pixmap may not be able to keep up with the mouse movements if the hot spot causes the pixmap to be displayed directly under the cursor. */ @@ -224,7 +224,7 @@ QObject *QDrag::target() const from are specified in \a supportedActions. The default proposed action will be selected among the allowed actions in the following order: Move, Copy and Link. - \bold{Note:} On Linux and Mac OS X, the drag and drop operation + \b{Note:} On Linux and Mac OS X, the drag and drop operation can take some time, but this function does not block the event loop. Other events are still delivered to the application while the operation is performed. On Windows, the Qt event loop is @@ -246,7 +246,7 @@ Qt::DropAction QDrag::exec(Qt::DropActions supportedActions) The \a defaultDropAction determines which action will be proposed when the user performs a drag without using modifier keys. - \bold{Note:} On Linux and Mac OS X, the drag and drop operation + \b{Note:} On Linux and Mac OS X, the drag and drop operation can take some time, but this function does not block the event loop. Other events are still delivered to the application while the operation is performed. On Windows, the Qt event loop is @@ -285,13 +285,13 @@ Qt::DropAction QDrag::exec(Qt::DropActions supportedActions, Qt::DropAction defa /*! \obsolete - \bold{Note:} It is recommended to use exec() instead of this function. + \b{Note:} It is recommended to use exec() instead of this function. Starts the drag and drop operation and returns a value indicating the requested drop action when it is completed. The drop actions that the user can choose from are specified in \a request. Qt::CopyAction is always allowed. - \bold{Note:} Although the drag and drop operation can take some time, this function + \b{Note:} Although the drag and drop operation can take some time, this function does not block the event loop. Other events are still delivered to the application while the operation is performed. diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index e902cbf7e2..60e754b289 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -377,9 +377,9 @@ QMouseEvent::~QMouseEvent() you will get the following QEvent::MouseMove events: \list 1 - \o A::MouseMove - \o B::MouseMove - \o C::MouseMove + \li A::MouseMove + \li B::MouseMove + \li C::MouseMove \endlist You will get the same events for QEvent::HoverMove, except that the event @@ -390,9 +390,9 @@ QMouseEvent::~QMouseEvent() In this case the events will occur in the following way: \list 1 - \o A::HoverMove - \o A::HoverMove, B::HoverMove - \o A::HoverMove, B::HoverMove, C::HoverMove + \li A::HoverMove + \li A::HoverMove, B::HoverMove + \li A::HoverMove, B::HoverMove, C::HoverMove \endlist */ @@ -1483,20 +1483,20 @@ QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos) step process: \list 1 - \o \bold{Starting to Compose} + \li \b{Starting to Compose} When the user presses the first key on a keyboard, an input context is created. This input context will contain a string of the typed characters. - \o \bold{Composing} + \li \b{Composing} With every new key pressed, the input method will try to create a matching string for the text typed so far called preedit string. While the input context is active, the user can only move the cursor inside the string belonging to this input context. - \o \bold{Completing} + \li \b{Completing} At some point, the user will activate a user interface component (perhaps using a particular key) where they can choose from a @@ -1539,10 +1539,10 @@ QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos) following steps: \list 1 - \o If the widget has selected text, the selected text should get + \li If the widget has selected text, the selected text should get removed. - \o Remove the text starting at replacementStart() with length + \li Remove the text starting at replacementStart() with length replacementLength() and replace it by the commitString(). If replacementLength() is 0, replacementStart() gives the insertion position for the commitString(). @@ -1556,7 +1556,7 @@ QContextMenuEvent::QContextMenuEvent(Reason reason, const QPoint &pos) If the widget implements undo/redo, this operation gets added to the undo stack. - \o If there is no current preedit string, insert the + \li If there is no current preedit string, insert the preeditString() at the current cursor position; otherwise replace the previous preeditString with the one received from this event. @@ -2060,7 +2060,7 @@ QTabletEvent::~QTabletEvent() Returns the z position of the device. Typically this is represented by a wheel on a 4D Mouse. If the device does not support a Z-axis, this value is - always zero. This is \bold not the same as pressure. + always zero. This is \b not the same as pressure. \sa pressure() */ @@ -2576,11 +2576,11 @@ QHelpEvent::~QHelpEvent() \table 100% \row - \o + \li \snippet doc/src/snippets/qstatustipevent/main.cpp 1 \dots \snippet doc/src/snippets/qstatustipevent/main.cpp 3 - \o + \li \image qstatustipevent-widget.png Widget with status tip. \endtable @@ -2589,12 +2589,12 @@ QHelpEvent::~QHelpEvent() \table 100% \row - \o + \li \snippet doc/src/snippets/qstatustipevent/main.cpp 0 \snippet doc/src/snippets/qstatustipevent/main.cpp 2 \dots \snippet doc/src/snippets/qstatustipevent/main.cpp 3 - \o + \li \image qstatustipevent-action.png Action with status tip. \endtable @@ -3405,10 +3405,10 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent() \list - \i When the first touch point is detected, the destination widget is determined firstly by the + \li When the first touch point is detected, the destination widget is determined firstly by the location on screen and secondly by the propagation rules. - \i When additional touch points are detected, Qt first looks to see if there are any active + \li When additional touch points are detected, Qt first looks to see if there are any active touch points on any ancestor or descendent of the widget under the new touch point. If there are, the new touch point is grouped with the first, and the new touch point will be sent in a single QTouchEvent to the widget that handled the first touch point. (The widget under the new @@ -3430,19 +3430,19 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent() \list - \i As mentioned above, enabling touch events means multiple widgets can be receiving touch + \li As mentioned above, enabling touch events means multiple widgets can be receiving touch events simultaneously. Combined with the default QWidget::event() handling for QTouchEvents, this gives you great flexibility in designing touch user interfaces. Be aware of the implications. For example, it is possible that the user is moving a QSlider with one finger and pressing a QPushButton with another. The signals emitted by these widgets will be interleaved. - \i Recursion into the event loop using one of the exec() methods (e.g., QDialog::exec() or + \li Recursion into the event loop using one of the exec() methods (e.g., QDialog::exec() or QMenu::exec()) in a QTouchEvent event handler is not supported. Since there are multiple event recipients, recursion may cause problems, including but not limited to lost events and unexpected infinite recursion. - \i QTouchEvents are not affected by a \l{QWidget::grabMouse()}{mouse grab} or an + \li QTouchEvents are not affected by a \l{QWidget::grabMouse()}{mouse grab} or an \l{QApplication::activePopupWidget()}{active pop-up widget}. The behavior of QTouchEvents is undefined when opening a pop-up or grabbing the mouse while there are more than one active touch points. diff --git a/src/gui/kernel/qguiapplication.cpp b/src/gui/kernel/qguiapplication.cpp index 09d4e98c3c..be82005a54 100644 --- a/src/gui/kernel/qguiapplication.cpp +++ b/src/gui/kernel/qguiapplication.cpp @@ -195,7 +195,7 @@ static inline void clearFontUnlocked() application's initialization and finalization. In addition, QGuiApplication handles most of the system-wide and application-wide settings. - For any GUI application using Qt, there is precisely \bold one QGuiApplication + For any GUI application using Qt, there is precisely \b one QGuiApplication object no matter whether the application has 0, 1, 2 or more windows at any given time. For non-GUI Qt applications, use QCoreApplication instead, as it does not depend on the \l QtGui library. @@ -205,30 +205,30 @@ static inline void clearFontUnlocked() QGuiApplication's main areas of responsibility are: \list - \o It initializes the application with the user's desktop settings, + \li It initializes the application with the user's desktop settings, such as palette(), font() and styleHints(). It keeps track of these properties in case the user changes the desktop globally, for example, through some kind of control panel. - \o It performs event handling, meaning that it receives events + \li It performs event handling, meaning that it receives events from the underlying window system and dispatches them to the relevant widgets. You can send your own events to windows by using sendEvent() and postEvent(). - \o It parses common command line arguments and sets its internal + \li It parses common command line arguments and sets its internal state accordingly. See the \l{QGuiApplication::QGuiApplication()} {constructor documentation} below for more details. - \o It provides localization of strings that are visible to the + \li It provides localization of strings that are visible to the user via translate(). - \o It provides some magical objects like the clipboard(). + \li It provides some magical objects like the clipboard(). - \o It knows about the application's windows. You can ask which + \li It knows about the application's windows. You can ask which window is at a certain position using topLevelAt(), get a list of topLevelWindows(), etc. - \o It manages the application's mouse cursor handling, see + \li It manages the application's mouse cursor handling, see setOverrideCursor() \endlist @@ -240,11 +240,11 @@ static inline void clearFontUnlocked() \table \header - \o{2,1} Groups of functions + \li{2,1} Groups of functions \row - \o System settings - \o desktopSettingsAware(), + \li System settings + \li desktopSettingsAware(), setDesktopSettingsAware(), styleHints(), palette(), @@ -253,8 +253,8 @@ static inline void clearFontUnlocked() setFont(). \row - \o Event handling - \o exec(), + \li Event handling + \li exec(), processEvents(), exit(), quit(). @@ -266,22 +266,22 @@ static inline void clearFontUnlocked() notify(). \row - \o Windows - \o allWindows(), + \li Windows + \li allWindows(), topLevelWindows(), focusWindow(), clipboard(), topLevelAt(). \row - \o Advanced cursor handling - \o overrideCursor(), + \li Advanced cursor handling + \li overrideCursor(), setOverrideCursor(), restoreOverrideCursor(). \row - \o Miscellaneous - \o startingUp(), + \li Miscellaneous + \li startingUp(), closingDown(), type(). \endtable @@ -309,9 +309,9 @@ static inline void clearFontUnlocked() All Qt programs automatically support the following command line options: \list - \o -reverse, sets the application's layout direction to + \li -reverse, sets the application's layout direction to Qt::RightToLeft - \o -qmljsdebugger=, activates the QML/JS debugger with a specified port. + \li -qmljsdebugger=, activates the QML/JS debugger with a specified port. The value must be of format port:1234[,block], where block is optional and will make the application wait until a debugger connects to it. \endlist diff --git a/src/gui/kernel/qkeysequence.cpp b/src/gui/kernel/qkeysequence.cpp index 7053f01196..153b2b5c2d 100644 --- a/src/gui/kernel/qkeysequence.cpp +++ b/src/gui/kernel/qkeysequence.cpp @@ -164,14 +164,14 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni three different ways: \list - \o For standard shortcuts, a \l{QKeySequence::StandardKey}{standard key} + \li For standard shortcuts, a \l{QKeySequence::StandardKey}{standard key} can be used to request the platform-specific key sequence associated with each shortcut. - \o For custom shortcuts, human-readable strings such as "Ctrl+X" can + \li For custom shortcuts, human-readable strings such as "Ctrl+X" can be used, and these can be translated into the appropriate shortcuts for users of different languages. Translations are made in the "QShortcut" context. - \o For hard-coded shortcuts, integer key codes can be specified with + \li For hard-coded shortcuts, integer key codes can be specified with a combination of values defined by the Qt::Key and Qt::Modifier enum values. Each key code consists of a single Qt::Key value and zero or more modifiers, such as Qt::SHIFT, Qt::CTRL, Qt::ALT and Qt::META. @@ -206,7 +206,7 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni code point of the character; for example, 'A' gives the same key sequence as Qt::Key_A. - \bold{Note:} On Mac OS X, references to "Ctrl", Qt::CTRL, Qt::Control + \b{Note:} On Mac OS X, references to "Ctrl", Qt::CTRL, Qt::Control and Qt::ControlModifier correspond to the \key Command keys on the Macintosh keyboard, and references to "Meta", Qt::META, Qt::Meta and Qt::MetaModifier correspond to the \key Control keys. Developers on @@ -225,72 +225,72 @@ void Q_GUI_EXPORT qt_set_sequence_auto_mnemonic(bool b) { qt_sequence_no_mnemoni corresponds to the \key Control keys. \table - \header \i StandardKey \i Windows \i Mac OS X \i KDE \i GNOME - \row \i HelpContents \i F1 \i Ctrl+? \i F1 \i F1 - \row \i WhatsThis \i Shift+F1 \i Shift+F1 \i Shift+F1 \i Shift+F1 - \row \i Open \i Ctrl+O \i Ctrl+O \i Ctrl+O \i Ctrl+O - \row \i Close \i Ctrl+F4, Ctrl+W \i Ctrl+W, Ctrl+F4 \i Ctrl+W \i Ctrl+W - \row \i Save \i Ctrl+S \i Ctrl+S \i Ctrl+S \i Ctrl+S - \row \i Quit \i \i Ctrl+Q \i Qtrl+Q \i Qtrl+Q - \row \i SaveAs \i \i Ctrl+Shift+S \i \i Ctrl+Shift+S - \row \i New \i Ctrl+N \i Ctrl+N \i Ctrl+N \i Ctrl+N - \row \i Delete \i Del \i Del, Meta+D \i Del, Ctrl+D \i Del, Ctrl+D - \row \i Cut \i Ctrl+X, Shift+Del \i Ctrl+X \i Ctrl+X, F20, Shift+Del \i Ctrl+X, F20, Shift+Del - \row \i Copy \i Ctrl+C, Ctrl+Ins \i Ctrl+C \i Ctrl+C, F16, Ctrl+Ins \i Ctrl+C, F16, Ctrl+Ins - \row \i Paste \i Ctrl+V, Shift+Ins \i Ctrl+V \i Ctrl+V, F18, Shift+Ins \i Ctrl+V, F18, Shift+Ins - \row \i Preferences \i \i Ctrl+, \i \i - \row \i Undo \i Ctrl+Z, Alt+Backspace \i Ctrl+Z \i Ctrl+Z, F14 \i Ctrl+Z, F14 - \row \i Redo \i Ctrl+Y, Shift+Ctrl+Z, Alt+Shift+Backspace \i Ctrl+Shift+Z \i Ctrl+Shift+Z \i Ctrl+Shift+Z - \row \i Back \i Alt+Left, Backspace \i Ctrl+[ \i Alt+Left \i Alt+Left - \row \i Forward \i Alt+Right, Shift+Backspace \i Ctrl+] \i Alt+Right \i Alt+Right - \row \i Refresh \i F5 \i F5 \i F5 \i Ctrl+R, F5 - \row \i ZoomIn \i Ctrl+Plus \i Ctrl+Plus \i Ctrl+Plus \i Ctrl+Plus - \row \i ZoomOut \i Ctrl+Minus \i Ctrl+Minus \i Ctrl+Minus \i Ctrl+Minus - \row \i Print \i Ctrl+P \i Ctrl+P \i Ctrl+P \i Ctrl+P - \row \i AddTab \i Ctrl+T \i Ctrl+T \i Ctrl+Shift+N, Ctrl+T \i Ctrl+T - \row \i NextChild \i Ctrl+Tab, Forward, Ctrl+F6 \i Ctrl+}, Forward, Ctrl+Tab \i Ctrl+Tab, Forward, Ctrl+Comma \i Ctrl+Tab, Forward - \row \i PreviousChild \i Ctrl+Shift+Tab, Back, Ctrl+Shift+F6 \i Ctrl+{, Back, Ctrl+Shift+Tab \i Ctrl+Shift+Tab, Back, Ctrl+Period \i Ctrl+Shift+Tab, Back - \row \i Find \i Ctrl+F \i Ctrl+F \i Ctrl+F \i Ctrl+F - \row \i FindNext \i F3, Ctrl+G \i Ctrl+G \i F3 \i Ctrl+G, F3 - \row \i FindPrevious \i Shift+F3, Ctrl+Shift+G \i Ctrl+Shift+G \i Shift+F3 \i Ctrl+Shift+G, Shift+F3 - \row \i Replace \i Ctrl+H \i (none) \i Ctrl+R \i Ctrl+H - \row \i SelectAll \i Ctrl+A \i Ctrl+A \i Ctrl+A \i Ctrl+A - \row \i Bold \i Ctrl+B \i Ctrl+B \i Ctrl+B \i Ctrl+B - \row \i Italic \i Ctrl+I \i Ctrl+I \i Ctrl+I \i Ctrl+I - \row \i Underline \i Ctrl+U \i Ctrl+U \i Ctrl+U \i Ctrl+U - \row \i MoveToNextChar \i Right \i Right \i Right \i Right - \row \i MoveToPreviousChar \i Left \i Left \i Left \i Left - \row \i MoveToNextWord \i Ctrl+Right \i Alt+Right \i Ctrl+Right \i Ctrl+Right - \row \i MoveToPreviousWord \i Ctrl+Left \i Alt+Left \i Ctrl+Left \i Ctrl+Left - \row \i MoveToNextLine \i Down \i Down \i Down \i Down - \row \i MoveToPreviousLine \i Up \i Up \i Up \i Up - \row \i MoveToNextPage \i PgDown \i PgDown, Alt+PgDown, Meta+Down, Meta+PgDown\i PgDown \i PgDown - \row \i MoveToPreviousPage \i PgUp \i PgUp, Alt+PgUp, Meta+Up, Meta+PgUp \i PgUp \i PgUp - \row \i MoveToStartOfLine \i Home \i Ctrl+Left, Meta+Left \i Home \i Home - \row \i MoveToEndOfLine \i End \i Ctrl+Right, Meta+Right \i End \i End - \row \i MoveToStartOfBlock \i (none) \i Alt+Up, Meta+A \i (none) \i (none) - \row \i MoveToEndOfBlock \i (none) \i Alt+Down, Meta+E \i (none) \i (none) - \row \i MoveToStartOfDocument\i Ctrl+Home \i Ctrl+Up, Home \i Ctrl+Home \i Ctrl+Home - \row \i MoveToEndOfDocument \i Ctrl+End \i Ctrl+Down, End \i Ctrl+End \i Ctrl+End - \row \i SelectNextChar \i Shift+Right \i Shift+Right \i Shift+Right \i Shift+Right - \row \i SelectPreviousChar \i Shift+Left \i Shift+Left \i Shift+Left \i Shift+Left - \row \i SelectNextWord \i Ctrl+Shift+Right \i Alt+Shift+Right \i Ctrl+Shift+Right \i Ctrl+Shift+Right - \row \i SelectPreviousWord \i Ctrl+Shift+Left \i Alt+Shift+Left \i Ctrl+Shift+Left \i Ctrl+Shift+Left - \row \i SelectNextLine \i Shift+Down \i Shift+Down \i Shift+Down \i Shift+Down - \row \i SelectPreviousLine \i Shift+Up \i Shift+Up \i Shift+Up \i Shift+Up - \row \i SelectNextPage \i Shift+PgDown \i Shift+PgDown \i Shift+PgDown \i Shift+PgDown - \row \i SelectPreviousPage \i Shift+PgUp \i Shift+PgUp \i Shift+PgUp \i Shift+PgUp - \row \i SelectStartOfLine \i Shift+Home \i Ctrl+Shift+Left \i Shift+Home \i Shift+Home - \row \i SelectEndOfLine \i Shift+End \i Ctrl+Shift+Right \i Shift+End \i Shift+End - \row \i SelectStartOfBlock \i (none) \i Alt+Shift+Up, Meta+Shift+A \i (none) \i (none) - \row \i SelectEndOfBlock \i (none) \i Alt+Shift+Down, Meta+Shift+E \i (none) \i (none) - \row \i SelectStartOfDocument\i Ctrl+Shift+Home \i Ctrl+Shift+Up, Shift+Home \i Ctrl+Shift+Home\i Ctrl+Shift+Home - \row \i SelectEndOfDocument \i Ctrl+Shift+End \i Ctrl+Shift+Down, Shift+End \i Ctrl+Shift+End \i Ctrl+Shift+End - \row \i DeleteStartOfWord \i Ctrl+Backspace \i Alt+Backspace \i Ctrl+Backspace \i Ctrl+Backspace - \row \i DeleteEndOfWord \i Ctrl+Del \i (none) \i Ctrl+Del \i Ctrl+Del - \row \i DeleteEndOfLine \i (none) \i (none) \i Ctrl+K \i Ctrl+K - \row \i InsertParagraphSeparator \i Enter \i Enter \i Enter \i Enter - \row \i InsertLineSeparator \i Shift+Enter \i Meta+Enter \i Shift+Enter \i Shift+Enter + \header \li StandardKey \li Windows \li Mac OS X \li KDE \li GNOME + \row \li HelpContents \li F1 \li Ctrl+? \li F1 \li F1 + \row \li WhatsThis \li Shift+F1 \li Shift+F1 \li Shift+F1 \li Shift+F1 + \row \li Open \li Ctrl+O \li Ctrl+O \li Ctrl+O \li Ctrl+O + \row \li Close \li Ctrl+F4, Ctrl+W \li Ctrl+W, Ctrl+F4 \li Ctrl+W \li Ctrl+W + \row \li Save \li Ctrl+S \li Ctrl+S \li Ctrl+S \li Ctrl+S + \row \li Quit \li \li Ctrl+Q \li Qtrl+Q \li Qtrl+Q + \row \li SaveAs \li \li Ctrl+Shift+S \li \li Ctrl+Shift+S + \row \li New \li Ctrl+N \li Ctrl+N \li Ctrl+N \li Ctrl+N + \row \li Delete \li Del \li Del, Meta+D \li Del, Ctrl+D \li Del, Ctrl+D + \row \li Cut \li Ctrl+X, Shift+Del \li Ctrl+X \li Ctrl+X, F20, Shift+Del \li Ctrl+X, F20, Shift+Del + \row \li Copy \li Ctrl+C, Ctrl+Ins \li Ctrl+C \li Ctrl+C, F16, Ctrl+Ins \li Ctrl+C, F16, Ctrl+Ins + \row \li Paste \li Ctrl+V, Shift+Ins \li Ctrl+V \li Ctrl+V, F18, Shift+Ins \li Ctrl+V, F18, Shift+Ins + \row \li Preferences \li \li Ctrl+, \li \li + \row \li Undo \li Ctrl+Z, Alt+Backspace \li Ctrl+Z \li Ctrl+Z, F14 \li Ctrl+Z, F14 + \row \li Redo \li Ctrl+Y, Shift+Ctrl+Z, Alt+Shift+Backspace \li Ctrl+Shift+Z \li Ctrl+Shift+Z \li Ctrl+Shift+Z + \row \li Back \li Alt+Left, Backspace \li Ctrl+[ \li Alt+Left \li Alt+Left + \row \li Forward \li Alt+Right, Shift+Backspace \li Ctrl+] \li Alt+Right \li Alt+Right + \row \li Refresh \li F5 \li F5 \li F5 \li Ctrl+R, F5 + \row \li ZoomIn \li Ctrl+Plus \li Ctrl+Plus \li Ctrl+Plus \li Ctrl+Plus + \row \li ZoomOut \li Ctrl+Minus \li Ctrl+Minus \li Ctrl+Minus \li Ctrl+Minus + \row \li Print \li Ctrl+P \li Ctrl+P \li Ctrl+P \li Ctrl+P + \row \li AddTab \li Ctrl+T \li Ctrl+T \li Ctrl+Shift+N, Ctrl+T \li Ctrl+T + \row \li NextChild \li Ctrl+Tab, Forward, Ctrl+F6 \li Ctrl+}, Forward, Ctrl+Tab \li Ctrl+Tab, Forward, Ctrl+Comma \li Ctrl+Tab, Forward + \row \li PreviousChild \li Ctrl+Shift+Tab, Back, Ctrl+Shift+F6 \li Ctrl+{, Back, Ctrl+Shift+Tab \li Ctrl+Shift+Tab, Back, Ctrl+Period \li Ctrl+Shift+Tab, Back + \row \li Find \li Ctrl+F \li Ctrl+F \li Ctrl+F \li Ctrl+F + \row \li FindNext \li F3, Ctrl+G \li Ctrl+G \li F3 \li Ctrl+G, F3 + \row \li FindPrevious \li Shift+F3, Ctrl+Shift+G \li Ctrl+Shift+G \li Shift+F3 \li Ctrl+Shift+G, Shift+F3 + \row \li Replace \li Ctrl+H \li (none) \li Ctrl+R \li Ctrl+H + \row \li SelectAll \li Ctrl+A \li Ctrl+A \li Ctrl+A \li Ctrl+A + \row \li Bold \li Ctrl+B \li Ctrl+B \li Ctrl+B \li Ctrl+B + \row \li Italic \li Ctrl+I \li Ctrl+I \li Ctrl+I \li Ctrl+I + \row \li Underline \li Ctrl+U \li Ctrl+U \li Ctrl+U \li Ctrl+U + \row \li MoveToNextChar \li Right \li Right \li Right \li Right + \row \li MoveToPreviousChar \li Left \li Left \li Left \li Left + \row \li MoveToNextWord \li Ctrl+Right \li Alt+Right \li Ctrl+Right \li Ctrl+Right + \row \li MoveToPreviousWord \li Ctrl+Left \li Alt+Left \li Ctrl+Left \li Ctrl+Left + \row \li MoveToNextLine \li Down \li Down \li Down \li Down + \row \li MoveToPreviousLine \li Up \li Up \li Up \li Up + \row \li MoveToNextPage \li PgDown \li PgDown, Alt+PgDown, Meta+Down, Meta+PgDown\li PgDown \li PgDown + \row \li MoveToPreviousPage \li PgUp \li PgUp, Alt+PgUp, Meta+Up, Meta+PgUp \li PgUp \li PgUp + \row \li MoveToStartOfLine \li Home \li Ctrl+Left, Meta+Left \li Home \li Home + \row \li MoveToEndOfLine \li End \li Ctrl+Right, Meta+Right \li End \li End + \row \li MoveToStartOfBlock \li (none) \li Alt+Up, Meta+A \li (none) \li (none) + \row \li MoveToEndOfBlock \li (none) \li Alt+Down, Meta+E \li (none) \li (none) + \row \li MoveToStartOfDocument\li Ctrl+Home \li Ctrl+Up, Home \li Ctrl+Home \li Ctrl+Home + \row \li MoveToEndOfDocument \li Ctrl+End \li Ctrl+Down, End \li Ctrl+End \li Ctrl+End + \row \li SelectNextChar \li Shift+Right \li Shift+Right \li Shift+Right \li Shift+Right + \row \li SelectPreviousChar \li Shift+Left \li Shift+Left \li Shift+Left \li Shift+Left + \row \li SelectNextWord \li Ctrl+Shift+Right \li Alt+Shift+Right \li Ctrl+Shift+Right \li Ctrl+Shift+Right + \row \li SelectPreviousWord \li Ctrl+Shift+Left \li Alt+Shift+Left \li Ctrl+Shift+Left \li Ctrl+Shift+Left + \row \li SelectNextLine \li Shift+Down \li Shift+Down \li Shift+Down \li Shift+Down + \row \li SelectPreviousLine \li Shift+Up \li Shift+Up \li Shift+Up \li Shift+Up + \row \li SelectNextPage \li Shift+PgDown \li Shift+PgDown \li Shift+PgDown \li Shift+PgDown + \row \li SelectPreviousPage \li Shift+PgUp \li Shift+PgUp \li Shift+PgUp \li Shift+PgUp + \row \li SelectStartOfLine \li Shift+Home \li Ctrl+Shift+Left \li Shift+Home \li Shift+Home + \row \li SelectEndOfLine \li Shift+End \li Ctrl+Shift+Right \li Shift+End \li Shift+End + \row \li SelectStartOfBlock \li (none) \li Alt+Shift+Up, Meta+Shift+A \li (none) \li (none) + \row \li SelectEndOfBlock \li (none) \li Alt+Shift+Down, Meta+Shift+E \li (none) \li (none) + \row \li SelectStartOfDocument\li Ctrl+Shift+Home \li Ctrl+Shift+Up, Shift+Home \li Ctrl+Shift+Home\li Ctrl+Shift+Home + \row \li SelectEndOfDocument \li Ctrl+Shift+End \li Ctrl+Shift+Down, Shift+End \li Ctrl+Shift+End \li Ctrl+Shift+End + \row \li DeleteStartOfWord \li Ctrl+Backspace \li Alt+Backspace \li Ctrl+Backspace \li Ctrl+Backspace + \row \li DeleteEndOfWord \li Ctrl+Del \li (none) \li Ctrl+Del \li Ctrl+Del + \row \li DeleteEndOfLine \li (none) \li (none) \li Ctrl+K \li Ctrl+K + \row \li InsertParagraphSeparator \li Enter \li Enter \li Enter \li Enter + \row \li InsertLineSeparator \li Shift+Enter \li Meta+Enter \li Shift+Enter \li Shift+Enter \endtable Note that, since the key sequences used for the standard shortcuts differ diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index 6d3d1c9580..8ee62ce8d9 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -342,9 +342,9 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) The color groups: \list - \i The Active group is used for the window that has keyboard focus. - \i The Inactive group is used for other windows. - \i The Disabled group is used for widgets (not windows) that are + \li The Active group is used for the window that has keyboard focus. + \li The Inactive group is used for other windows. + \li The Disabled group is used for widgets (not windows) that are disabled for some reason. \endlist diff --git a/src/gui/kernel/qplatformnativeinterface_qpa.cpp b/src/gui/kernel/qplatformnativeinterface_qpa.cpp index 7237849011..f87a2956a3 100644 --- a/src/gui/kernel/qplatformnativeinterface_qpa.cpp +++ b/src/gui/kernel/qplatformnativeinterface_qpa.cpp @@ -132,7 +132,7 @@ void QPlatformNativeInterface::setWindowProperty(QPlatformWindow *window, const The event filter function set here is called for all messages received from the platform if they are given type \eventType. - It is \i not called for messages that are not meant for Qt objects. + It is \e not called for messages that are not meant for Qt objects. The type of event is specific to the platform plugin chosen at run-time. diff --git a/src/gui/math3d/qgenericmatrix.cpp b/src/gui/math3d/qgenericmatrix.cpp index 113b767e9f..08ed0ae40f 100644 --- a/src/gui/math3d/qgenericmatrix.cpp +++ b/src/gui/math3d/qgenericmatrix.cpp @@ -53,9 +53,9 @@ QT_BEGIN_NAMESPACE The QGenericMatrix template has three parameters: \table - \row \i N \i Number of columns. - \row \i M \i Number of rows. - \row \i T \i Element type that is visible to users of the class. + \row \li N \li Number of columns. + \row \li M \li Number of rows. + \row \li T \li Element type that is visible to users of the class. \endtable \sa QMatrix4x4 diff --git a/src/gui/math3d/qmatrix4x4.cpp b/src/gui/math3d/qmatrix4x4.cpp index 068b2e36f7..0eb3506779 100644 --- a/src/gui/math3d/qmatrix4x4.cpp +++ b/src/gui/math3d/qmatrix4x4.cpp @@ -62,11 +62,11 @@ QT_BEGIN_NAMESPACE Internally the data is stored as column-major format, so as to be optimal for passing to OpenGL functions, which expect column-major data. - When using these functions be aware that they return data in \bold{column-major} + When using these functions be aware that they return data in \b{column-major} format: \list - \o data() - \o constData() + \li data() + \li constData() \endlist \sa QVector3D, QGenericMatrix diff --git a/src/gui/math3d/qvector2d.cpp b/src/gui/math3d/qvector2d.cpp index 897fa356d3..3c3581f3f4 100644 --- a/src/gui/math3d/qvector2d.cpp +++ b/src/gui/math3d/qvector2d.cpp @@ -60,7 +60,7 @@ QT_BEGIN_NAMESPACE The QVector2D class can also be used to represent vertices in 2D space. We therefore do not need to provide a separate vertex class. - \bold{Note:} By design values in the QVector2D instance are stored as \c float. + \b{Note:} By design values in the QVector2D instance are stored as \c float. This means that on platforms where the \c qreal arguments to QVector2D functions are represented by \c double values, it is possible to lose precision. diff --git a/src/gui/math3d/qvector3d.cpp b/src/gui/math3d/qvector3d.cpp index 5251f9c015..adf3da4010 100644 --- a/src/gui/math3d/qvector3d.cpp +++ b/src/gui/math3d/qvector3d.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE The QVector3D class can also be used to represent vertices in 3D space. We therefore do not need to provide a separate vertex class. - \bold{Note:} By design values in the QVector3D instance are stored as \c float. + \b{Note:} By design values in the QVector3D instance are stored as \c float. This means that on platforms where the \c qreal arguments to QVector3D functions are represented by \c double values, it is possible to lose precision. diff --git a/src/gui/math3d/qvector4d.cpp b/src/gui/math3d/qvector4d.cpp index e7ee46b88b..6b29221d92 100644 --- a/src/gui/math3d/qvector4d.cpp +++ b/src/gui/math3d/qvector4d.cpp @@ -59,7 +59,7 @@ QT_BEGIN_NAMESPACE The QVector4D class can also be used to represent vertices in 4D space. We therefore do not need to provide a separate vertex class. - \bold{Note:} By design values in the QVector4D instance are stored as \c float. + \b{Note:} By design values in the QVector4D instance are stored as \c float. This means that on platforms where the \c qreal arguments to QVector4D functions are represented by \c double values, it is possible to lose precision. diff --git a/src/gui/opengl/qopenglframebufferobject.cpp b/src/gui/opengl/qopenglframebufferobject.cpp index aa4941706a..cc5750490d 100644 --- a/src/gui/opengl/qopenglframebufferobject.cpp +++ b/src/gui/opengl/qopenglframebufferobject.cpp @@ -83,10 +83,10 @@ QT_BEGIN_NAMESPACE A framebuffer object has several characteristics: \list - \i \link setSamples() Number of samples per pixels.\endlink - \i \link setAttachment() Depth and/or stencil attachments.\endlink - \i \link setTextureTarget() Texture target.\endlink - \i \link setInternalTextureFormat() Internal texture format.\endlink + \li \link setSamples() Number of samples per pixels.\endlink + \li \link setAttachment() Depth and/or stencil attachments.\endlink + \li \link setTextureTarget() Texture target.\endlink + \li \link setInternalTextureFormat() Internal texture format.\endlink \endlist Note that the desired attachments or number of samples per pixels might not @@ -657,7 +657,7 @@ void QOpenGLFramebufferObjectPrivate::initAttachments(QOpenGLContext *ctx, QOpen generates a 2D OpenGL texture (using the \c{GL_TEXTURE_2D} target), which is used as the internal rendering target. - \bold{It is important to have a current OpenGL context when creating a + \b{It is important to have a current OpenGL context when creating a QOpenGLFramebufferObject, otherwise initialization will fail.} When using a QPainter to paint to a QOpenGLFramebufferObject you should take diff --git a/src/gui/painting/qbrush.cpp b/src/gui/painting/qbrush.cpp index 6850eac59e..fe9b370189 100644 --- a/src/gui/painting/qbrush.cpp +++ b/src/gui/painting/qbrush.cpp @@ -309,15 +309,15 @@ struct QBrushDataPointerDeleter otherwise false. A brush is considered opaque if: \list - \o The alpha component of the color() is 255. - \o Its texture() does not have an alpha channel and is not a QBitmap. - \o The colors in the gradient() all have an alpha component that is 255. + \li The alpha component of the color() is 255. + \li Its texture() does not have an alpha channel and is not a QBitmap. + \li The colors in the gradient() all have an alpha component that is 255. \endlist \table 100% \row - \o \inlineimage brush-outline.png Outlines - \o + \li \inlineimage brush-outline.png Outlines + \li To specify the style and color of lines and outlines, use the QPainter's \l {QPen}{pen} combined with Qt::PenStyle and @@ -826,10 +826,10 @@ Q_GUI_EXPORT bool qt_isExtendedRadialGradient(const QBrush &brush) is considered opaque if: \list - \i The alpha component of the color() is 255. - \i Its texture() does not have an alpha channel and is not a QBitmap. - \i The colors in the gradient() all have an alpha component that is 255. - \i It is an extended radial gradient. + \li The alpha component of the color() is 255. + \li Its texture() does not have an alpha channel and is not a QBitmap. + \li The colors in the gradient() all have an alpha component that is 255. + \li It is an extended radial gradient. \endlist */ @@ -1178,12 +1178,12 @@ QDataStream &operator>>(QDataStream &s, QBrush &b) Qt currently supports three types of gradient fills: \list - \o \e Linear gradients interpolate colors between start and end points. - \o \e Simple radial gradients interpolate colors between a focal point + \li \e Linear gradients interpolate colors between start and end points. + \li \e Simple radial gradients interpolate colors between a focal point and end points on a circle surrounding it. - \o \e Extended radial gradients interpolate colors between a center and + \li \e Extended radial gradients interpolate colors between a center and a focal circle. - \o \e Conical gradients interpolate colors around a center point. + \li \e Conical gradients interpolate colors around a center point. \endlist A gradient's type can be retrieved using the type() function. @@ -1191,13 +1191,13 @@ QDataStream &operator>>(QDataStream &s, QBrush &b) \table \header - \o QLinearGradient - \o QRadialGradient - \o QConicalGradient + \li QLinearGradient + \li QRadialGradient + \li QConicalGradient \row - \o \inlineimage qgradient-linear.png - \o \inlineimage qgradient-radial.png - \o \inlineimage qgradient-conical.png + \li \inlineimage qgradient-linear.png + \li \inlineimage qgradient-radial.png + \li \inlineimage qgradient-conical.png \endtable The colors in a gradient are defined using stop points of the @@ -1232,13 +1232,13 @@ QDataStream &operator>>(QDataStream &s, QBrush &b) \table \row - \o \inlineimage qradialgradient-pad.png - \o \inlineimage qradialgradient-repeat.png - \o \inlineimage qradialgradient-reflect.png + \li \inlineimage qradialgradient-pad.png + \li \inlineimage qradialgradient-repeat.png + \li \inlineimage qradialgradient-reflect.png \row - \o \l {QGradient::PadSpread}{PadSpread} - \o \l {QGradient::RepeatSpread}{RepeatSpread} - \o \l {QGradient::ReflectSpread}{ReflectSpread} + \li \l {QGradient::PadSpread}{PadSpread} + \li \l {QGradient::RepeatSpread}{RepeatSpread} + \li \l {QGradient::ReflectSpread}{ReflectSpread} \endtable Note that the setSpread() function only has effect for linear and @@ -1537,13 +1537,13 @@ bool QGradient::operator==(const QGradient &gradient) const \table \row - \o \inlineimage qlineargradient-pad.png - \o \inlineimage qlineargradient-reflect.png - \o \inlineimage qlineargradient-repeat.png + \li \inlineimage qlineargradient-pad.png + \li \inlineimage qlineargradient-reflect.png + \li \inlineimage qlineargradient-repeat.png \row - \o \l {QGradient::PadSpread}{PadSpread} (default) - \o \l {QGradient::ReflectSpread}{ReflectSpread} - \o \l {QGradient::RepeatSpread}{RepeatSpread} + \li \l {QGradient::PadSpread}{PadSpread} (default) + \li \l {QGradient::ReflectSpread}{ReflectSpread} + \li \l {QGradient::RepeatSpread}{RepeatSpread} \endtable The colors in a gradient is defined using stop points of the @@ -1723,13 +1723,13 @@ void QLinearGradient::setFinalStop(const QPointF &stop) \table \row - \o \inlineimage qradialgradient-pad.png - \o \inlineimage qradialgradient-reflect.png - \o \inlineimage qradialgradient-repeat.png + \li \inlineimage qradialgradient-pad.png + \li \inlineimage qradialgradient-reflect.png + \li \inlineimage qradialgradient-repeat.png \row - \o \l {QGradient::PadSpread}{PadSpread} (default) - \o \l {QGradient::ReflectSpread}{ReflectSpread} - \o \l {QGradient::RepeatSpread}{RepeatSpread} + \li \l {QGradient::PadSpread}{PadSpread} (default) + \li \l {QGradient::ReflectSpread}{ReflectSpread} + \li \l {QGradient::RepeatSpread}{RepeatSpread} \endtable The colors in a gradient is defined using stop points of the diff --git a/src/gui/painting/qcolor.cpp b/src/gui/painting/qcolor.cpp index 96491918cd..f531565fb9 100644 --- a/src/gui/painting/qcolor.cpp +++ b/src/gui/painting/qcolor.cpp @@ -69,11 +69,11 @@ QT_BEGIN_NAMESPACE \table \header - \o RGB \o HSV \o CMYK + \li RGB \li HSV \li CMYK \row - \o \inlineimage qcolor-rgb.png - \o \inlineimage qcolor-hsv.png - \o \inlineimage qcolor-cmyk.png + \li \inlineimage qcolor-rgb.png + \li \inlineimage qcolor-hsv.png + \li \inlineimage qcolor-cmyk.png \endtable The QColor constructor creates the color based on RGB values. To @@ -194,20 +194,20 @@ QT_BEGIN_NAMESPACE HSV, like RGB, has three components: \list - \o H, for hue, is in the range 0 to 359 if the color is chromatic (not + \li H, for hue, is in the range 0 to 359 if the color is chromatic (not gray), or meaningless if it is gray. It represents degrees on the color wheel familiar to most people. Red is 0 (degrees), green is 120, and blue is 240. \inlineimage qcolor-hue.png - \o S, for saturation, is in the range 0 to 255, and the bigger it is, + \li S, for saturation, is in the range 0 to 255, and the bigger it is, the stronger the color is. Grayish colors have saturation near 0; very strong colors have saturation near 255. \inlineimage qcolor-saturation.png - \o V, for value, is in the range 0 to 255 and represents lightness or + \li V, for value, is in the range 0 to 255 and represents lightness or brightness of the color. 0 is black; 255 is as far from black as possible. @@ -498,16 +498,16 @@ QString QColor::name() const of these formats: \list - \i #RGB (each of R, G, and B is a single hex digit) - \i #RRGGBB - \i #RRRGGGBBB - \i #RRRRGGGGBBBB - \i A name from the list of colors defined in the list of \l{SVG color keyword names} + \li #RGB (each of R, G, and B is a single hex digit) + \li #RRGGBB + \li #RRRGGGBBB + \li #RRRRGGGGBBBB + \li A name from the list of colors defined in the list of \l{SVG color keyword names} provided by the World Wide Web Consortium; for example, "steelblue" or "gainsboro". These color names work on all platforms. Note that these color names are \e not the same as defined by the Qt::GlobalColor enums, e.g. "green" and Qt::green does not refer to the same color. - \i \c transparent - representing the absence of a color. + \li \c transparent - representing the absence of a color. \endlist The color is invalid if \a name cannot be parsed. diff --git a/src/gui/painting/qmatrix.cpp b/src/gui/painting/qmatrix.cpp index 6b5eb14f5f..ced2e4548c 100644 --- a/src/gui/painting/qmatrix.cpp +++ b/src/gui/painting/qmatrix.cpp @@ -111,8 +111,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qmatrix-simpletransformation.png - \o + \li \inlineimage qmatrix-simpletransformation.png + \li \snippet doc/src/snippets/matrix/matrix.cpp 0 \endtable @@ -123,8 +123,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qmatrix-combinedtransformation.png - \o + \li \inlineimage qmatrix-combinedtransformation.png + \li \snippet doc/src/snippets/matrix/matrix.cpp 1 \endtable @@ -171,8 +171,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qmatrix-combinedtransformation.png - \o + \li \inlineimage qmatrix-combinedtransformation.png + \li \snippet doc/src/snippets/matrix/matrix.cpp 2 \endtable diff --git a/src/gui/painting/qpainter.cpp b/src/gui/painting/qpainter.cpp index 43429abe8a..0f5468df4e 100644 --- a/src/gui/painting/qpainter.cpp +++ b/src/gui/painting/qpainter.cpp @@ -984,41 +984,41 @@ void QPainterPrivate::updateState(QPainterState *newState) \list - \o font() is the font used for drawing text. If the painter + \li font() is the font used for drawing text. If the painter isActive(), you can retrieve information about the currently set font, and its metrics, using the fontInfo() and fontMetrics() functions respectively. - \o brush() defines the color or pattern that is used for filling + \li brush() defines the color or pattern that is used for filling shapes. - \o pen() defines the color or stipple that is used for drawing + \li pen() defines the color or stipple that is used for drawing lines or boundaries. - \o backgroundMode() defines whether there is a background() or + \li backgroundMode() defines whether there is a background() or not, i.e it is either Qt::OpaqueMode or Qt::TransparentMode. - \o background() only applies when backgroundMode() is \l + \li background() only applies when backgroundMode() is \l Qt::OpaqueMode and pen() is a stipple. In that case, it describes the color of the background pixels in the stipple. - \o brushOrigin() defines the origin of the tiled brushes, normally + \li brushOrigin() defines the origin of the tiled brushes, normally the origin of widget's background. - \o viewport(), window(), worldTransform() make up the painter's coordinate + \li viewport(), window(), worldTransform() make up the painter's coordinate transformation system. For more information, see the \l {Coordinate Transformations} section and the \l {Coordinate System} documentation. - \o hasClipping() tells whether the painter clips at all. (The paint + \li hasClipping() tells whether the painter clips at all. (The paint device clips, too.) If the painter clips, it clips to clipRegion(). - \o layoutDirection() defines the layout direction used by the + \li layoutDirection() defines the layout direction used by the painter when drawing text. - \o worldMatrixEnabled() tells whether world transformation is enabled. + \li worldMatrixEnabled() tells whether world transformation is enabled. - \o viewTransformEnabled() tells whether view transformation is + \li viewTransformEnabled() tells whether view transformation is enabled. \endlist @@ -1052,9 +1052,9 @@ void QPainterPrivate::updateState(QPainterState *newState) \table 100% \row - \o \inlineimage qpainter-basicdrawing.png - \o - \bold {Basic Drawing Example} + \li \inlineimage qpainter-basicdrawing.png + \li + \b {Basic Drawing Example} The \l {painting/basicdrawing}{Basic Drawing} example shows how to display basic graphics primitives in a variety of styles using the @@ -1068,8 +1068,8 @@ void QPainterPrivate::updateState(QPainterState *newState) \table 100% \row - \o - \bold {Painter Paths example} + \li + \b {Painter Paths example} The QPainterPath class provides a container for painting operations, enabling graphical shapes to be constructed and @@ -1078,7 +1078,7 @@ void QPainterPrivate::updateState(QPainterState *newState) The \l {painting/painterpaths}{Painter Paths} example shows how painter paths can be used to build complex shapes for rendering. - \o \inlineimage qpainter-painterpaths.png + \li \inlineimage qpainter-painterpaths.png \endtable QPainter also provides the fillPath() function which fills the @@ -1096,13 +1096,13 @@ void QPainterPrivate::updateState(QPainterState *newState) \table \header - \o \l {painting/deform}{Vector Deformation} - \o \l {painting/gradients}{Gradients} - \o \l {painting/pathstroke}{Path Stroking} + \li \l {painting/deform}{Vector Deformation} + \li \l {painting/gradients}{Gradients} + \li \l {painting/pathstroke}{Path Stroking} \row - \o \inlineimage qpainter-vectordeformation.png - \o \inlineimage qpainter-gradients.png - \o \inlineimage qpainter-pathstroking.png + \li \inlineimage qpainter-vectordeformation.png + \li \inlineimage qpainter-gradients.png + \li \inlineimage qpainter-pathstroking.png \endtable @@ -1136,9 +1136,9 @@ void QPainterPrivate::updateState(QPainterState *newState) \table 100% \row - \o \inlineimage qpainter-concentriccircles.png - \o - \bold {Concentric Circles Example} + \li \inlineimage qpainter-concentriccircles.png + \li + \b {Concentric Circles Example} The \l {painting/concentriccircles}{Concentric Circles} example shows the improved rendering quality that can be obtained using @@ -1176,12 +1176,12 @@ void QPainterPrivate::updateState(QPainterState *newState) \table \header - \o nop \o rotate() \o scale() \o translate() + \li nop \li rotate() \li scale() \li translate() \row - \o \inlineimage qpainter-clock.png - \o \inlineimage qpainter-rotation.png - \o \inlineimage qpainter-scale.png - \o \inlineimage qpainter-translation.png + \li \inlineimage qpainter-clock.png + \li \inlineimage qpainter-rotation.png + \li \inlineimage qpainter-scale.png + \li \inlineimage qpainter-translation.png \endtable The most commonly used transformations are scaling, rotation, @@ -1200,15 +1200,15 @@ void QPainterPrivate::updateState(QPainterState *newState) \table 100% \row - \o - \bold {Affine Transformations Example} + \li + \b {Affine Transformations Example} The \l {painting/affine}{Affine Transformations} example shows Qt's ability to perform affine transformations on painting operations. The demo also allows the user to experiment with the transformation operations and see the results immediately. - \o \inlineimage qpainter-affinetransformations.png + \li \inlineimage qpainter-affinetransformations.png \endtable All the tranformation operations operate on the transformation @@ -1282,10 +1282,10 @@ void QPainterPrivate::updateState(QPainterState *newState) \table 100% \row - \o \inlineimage qpainter-compositiondemo.png + \li \inlineimage qpainter-compositiondemo.png - \o - \bold {Composition Modes Example} + \li + \b {Composition Modes Example} The \l {painting/composition}{Composition Modes} example, available in Qt's examples directory, allows you to experiment with the various @@ -1333,14 +1333,14 @@ void QPainterPrivate::updateState(QPainterState *newState) \list - \o Raster - This backend implements all rendering in pure software + \li Raster - This backend implements all rendering in pure software and is always used to render into QImages. For optimal performance only use the format types QImage::Format_ARGB32_Premultiplied, QImage::Format_RGB32 or QImage::Format_RGB16. Any other format, including QImage::Format_ARGB32, has significantly worse performance. This engine is used by default for QWidget and QPixmap. - \o OpenGL 2.0 (ES) - This backend is the primary backend for + \li OpenGL 2.0 (ES) - This backend is the primary backend for hardware accelerated graphics. It can be run on desktop machines and embedded devices supporting the OpenGL 2.0 or OpenGL/ES 2.0 specification. This includes most graphics chips produced in the @@ -1348,7 +1348,7 @@ void QPainterPrivate::updateState(QPainterState *newState) onto a QOpenGLWidget or by passing \c {-graphicssystem opengl} on the command line when the underlying system supports it. - \o OpenVG - This backend implements the Khronos standard for 2D + \li OpenVG - This backend implements the Khronos standard for 2D and Vector Graphics. It is primarily for embedded devices with hardware support for OpenVG. The engine can be enabled by passing \c {-graphicssystem openvg} on the command line when @@ -1360,26 +1360,26 @@ void QPainterPrivate::updateState(QPainterState *newState) \list - \o Simple transformations, meaning translation and scaling, pluss + \li Simple transformations, meaning translation and scaling, pluss 0, 90, 180, 270 degree rotations. - \o \c drawPixmap() in combination with simple transformations and + \li \c drawPixmap() in combination with simple transformations and opacity with non-smooth transformation mode (\c QPainter::SmoothPixmapTransform not enabled as a render hint). - \o Rectangle fills with solid color, two-color linear gradients + \li Rectangle fills with solid color, two-color linear gradients and simple transforms. - \o Rectangular clipping with simple transformations and intersect + \li Rectangular clipping with simple transformations and intersect clip. - \o Composition Modes \c QPainter::CompositionMode_Source and + \li Composition Modes \c QPainter::CompositionMode_Source and QPainter::CompositionMode_SourceOver - \o Rounded rectangle filling using solid color and two-color + \li Rounded rectangle filling using solid color and two-color linear gradients fills. - \o 3x3 patched pixmaps, via qDrawBorderPixmap. + \li 3x3 patched pixmaps, via qDrawBorderPixmap. \endlist @@ -1963,14 +1963,14 @@ QPaintEngine *QPainter::paintEngine() const 2 engine: \list - \i blending is disabled - \i the depth, stencil and scissor tests are disabled - \i the active texture unit is reset to 0 - \i the depth mask, depth function and the clear depth are reset to their + \li blending is disabled + \li the depth, stencil and scissor tests are disabled + \li the active texture unit is reset to 0 + \li the depth mask, depth function and the clear depth are reset to their default values - \i the stencil mask, stencil operation and stencil function are reset to + \li the stencil mask, stencil operation and stencil function are reset to their default values - \i the current color is reset to solid white + \li the current color is reset to solid white \endlist If, for example, the OpenGL polygon mode is changed by the user inside a @@ -2885,10 +2885,10 @@ void QPainter::setClipRegion(const QRegion &r, Qt::ClipOperation op) The following functions can transform the coordinate system without using a QMatrix: \list - \i translate() - \i scale() - \i shear() - \i rotate() + \li translate() + \li scale() + \li shear() + \li rotate() \endlist They operate on the painter's worldMatrix() and are implemented like this: @@ -3360,8 +3360,8 @@ void QPainter::fillPath(const QPainterPath &path, const QBrush &brush) \table 100% \row - \o \inlineimage qpainter-path.png - \o + \li \inlineimage qpainter-path.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 5 \endtable @@ -3405,8 +3405,8 @@ void QPainter::drawPath(const QPainterPath &path) \table 100% \row - \o \inlineimage qpainter-line.png - \o + \li \inlineimage qpainter-line.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 6 \endtable @@ -3452,8 +3452,8 @@ void QPainter::drawPath(const QPainterPath &path) \table 100% \row - \o \inlineimage qpainter-rectangle.png - \o + \li \inlineimage qpainter-rectangle.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 7 \endtable @@ -4121,8 +4121,8 @@ const QFont &QPainter::font() const \table 100% \row - \o \inlineimage qpainter-roundrect.png - \o + \li \inlineimage qpainter-roundrect.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 8 \endtable @@ -4221,8 +4221,8 @@ void QPainter::drawRoundRect(const QRectF &r, int xRnd, int yRnd) \table 100% \row - \o \inlineimage qpainter-ellipse.png - \o + \li \inlineimage qpainter-ellipse.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 9 \endtable @@ -4347,8 +4347,8 @@ void QPainter::drawEllipse(const QRect &r) \table 100% \row - \o \inlineimage qpainter-arc.png - \o + \li \inlineimage qpainter-arc.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 10 \endtable @@ -4411,8 +4411,8 @@ void QPainter::drawArc(const QRectF &r, int a, int alen) \table 100% \row - \o \inlineimage qpainter-pie.png - \o + \li \inlineimage qpainter-pie.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 11 \endtable @@ -4480,8 +4480,8 @@ void QPainter::drawPie(const QRectF &r, int a, int alen) \table 100% \row - \o \inlineimage qpainter-chord.png - \o + \li \inlineimage qpainter-chord.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 12 \endtable @@ -4696,7 +4696,7 @@ void QPainter::drawLines(const QPoint *pointPairs, int lineCount) \table 100% \row - \o + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 13 \endtable @@ -4802,8 +4802,8 @@ void QPainter::drawPolyline(const QPoint *points, int pointCount) \table 100% \row - \o \inlineimage qpainter-polygon.png - \o + \li \inlineimage qpainter-polygon.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 14 \endtable @@ -4915,8 +4915,8 @@ void QPainter::drawPolygon(const QPoint *points, int pointCount, Qt::FillRule fi \table 100% \row - \o \inlineimage qpainter-polygon.png - \o + \li \inlineimage qpainter-polygon.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 15 \endtable @@ -5039,7 +5039,7 @@ static inline QPointF roundInDeviceCoordinates(const QPointF &p, const QTransfor \table 100% \row - \o + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 16 \endtable @@ -5952,8 +5952,8 @@ void QPainter::drawText(const QRect &r, int flags, const QString &str, QRect *br \table 100% \row - \o \inlineimage qpainter-text.png - \o + \li \inlineimage qpainter-text.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 17 \endtable @@ -5962,20 +5962,20 @@ void QPainter::drawText(const QRect &r, int flags, const QString &str, QRect *br OR of the following flags: \list - \o Qt::AlignLeft - \o Qt::AlignRight - \o Qt::AlignHCenter - \o Qt::AlignJustify - \o Qt::AlignTop - \o Qt::AlignBottom - \o Qt::AlignVCenter - \o Qt::AlignCenter - \o Qt::TextDontClip - \o Qt::TextSingleLine - \o Qt::TextExpandTabs - \o Qt::TextShowMnemonic - \o Qt::TextWordWrap - \o Qt::TextIncludeTrailingSpaces + \li Qt::AlignLeft + \li Qt::AlignRight + \li Qt::AlignHCenter + \li Qt::AlignJustify + \li Qt::AlignTop + \li Qt::AlignBottom + \li Qt::AlignVCenter + \li Qt::AlignCenter + \li Qt::TextDontClip + \li Qt::TextSingleLine + \li Qt::TextExpandTabs + \li Qt::TextShowMnemonic + \li Qt::TextWordWrap + \li Qt::TextIncludeTrailingSpaces \endlist \sa Qt::AlignmentFlag, Qt::TextFlag, boundingRect(), layoutDirection() @@ -6044,18 +6044,18 @@ void QPainter::drawText(const QRectF &r, int flags, const QString &str, QRectF * the following flags: \list - \o Qt::AlignLeft - \o Qt::AlignRight - \o Qt::AlignHCenter - \o Qt::AlignJustify - \o Qt::AlignTop - \o Qt::AlignBottom - \o Qt::AlignVCenter - \o Qt::AlignCenter - \o Qt::TextSingleLine - \o Qt::TextExpandTabs - \o Qt::TextShowMnemonic - \o Qt::TextWordWrap + \li Qt::AlignLeft + \li Qt::AlignRight + \li Qt::AlignHCenter + \li Qt::AlignJustify + \li Qt::AlignTop + \li Qt::AlignBottom + \li Qt::AlignVCenter + \li Qt::AlignCenter + \li Qt::TextSingleLine + \li Qt::TextExpandTabs + \li Qt::TextShowMnemonic + \li Qt::TextWordWrap \endlist By default, QPainter draws text anti-aliased. @@ -6472,18 +6472,18 @@ void QPainter::drawTextItem(const QPointF &p, const QTextItem &_ti) The \a flags argument is a bitwise OR of the following flags: \list - \o Qt::AlignLeft - \o Qt::AlignRight - \o Qt::AlignHCenter - \o Qt::AlignTop - \o Qt::AlignBottom - \o Qt::AlignVCenter - \o Qt::AlignCenter - \o Qt::TextSingleLine - \o Qt::TextExpandTabs - \o Qt::TextShowMnemonic - \o Qt::TextWordWrap - \o Qt::TextIncludeTrailingSpaces + \li Qt::AlignLeft + \li Qt::AlignRight + \li Qt::AlignHCenter + \li Qt::AlignTop + \li Qt::AlignBottom + \li Qt::AlignVCenter + \li Qt::AlignCenter + \li Qt::TextSingleLine + \li Qt::TextExpandTabs + \li Qt::TextShowMnemonic + \li Qt::TextWordWrap + \li Qt::TextIncludeTrailingSpaces \endlist If several of the horizontal or several of the vertical alignment flags are set, the resulting alignment is undefined. @@ -6691,7 +6691,7 @@ void QPainter::drawTiledPixmap(const QRectF &r, const QPixmap &pixmap, const QPo \table 100% \row - \o + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 18 \endtable @@ -7675,7 +7675,7 @@ void QPainterState::init(QPainter *p) { \table 100% \row - \o + \li \snippet doc/src/snippets/code/src_gui_painting_qpainter.cpp 20 \endtable @@ -7791,21 +7791,21 @@ void QPainterState::init(QPainter *p) { \target GetFunction \table - \header \o Property Flag \o Current Property Value - \row \o QPaintEngine::DirtyBackground \o backgroundBrush() - \row \o QPaintEngine::DirtyBackgroundMode \o backgroundMode() - \row \o QPaintEngine::DirtyBrush \o brush() - \row \o QPaintEngine::DirtyBrushOrigin \o brushOrigin() - \row \o QPaintEngine::DirtyClipRegion \e or QPaintEngine::DirtyClipPath - \o clipOperation() - \row \o QPaintEngine::DirtyClipPath \o clipPath() - \row \o QPaintEngine::DirtyClipRegion \o clipRegion() - \row \o QPaintEngine::DirtyCompositionMode \o compositionMode() - \row \o QPaintEngine::DirtyFont \o font() - \row \o QPaintEngine::DirtyTransform \o transform() - \row \o QPaintEngine::DirtyClipEnabled \o isClipEnabled() - \row \o QPaintEngine::DirtyPen \o pen() - \row \o QPaintEngine::DirtyHints \o renderHints() + \header \li Property Flag \li Current Property Value + \row \li QPaintEngine::DirtyBackground \li backgroundBrush() + \row \li QPaintEngine::DirtyBackgroundMode \li backgroundMode() + \row \li QPaintEngine::DirtyBrush \li brush() + \row \li QPaintEngine::DirtyBrushOrigin \li brushOrigin() + \row \li QPaintEngine::DirtyClipRegion \e or QPaintEngine::DirtyClipPath + \li clipOperation() + \row \li QPaintEngine::DirtyClipPath \li clipPath() + \row \li QPaintEngine::DirtyClipRegion \li clipRegion() + \row \li QPaintEngine::DirtyCompositionMode \li compositionMode() + \row \li QPaintEngine::DirtyFont \li font() + \row \li QPaintEngine::DirtyTransform \li transform() + \row \li QPaintEngine::DirtyClipEnabled \li isClipEnabled() + \row \li QPaintEngine::DirtyPen \li pen() + \row \li QPaintEngine::DirtyHints \li renderHints() \endtable The QPaintEngineState class also provide the painter() function diff --git a/src/gui/painting/qpainterpath.cpp b/src/gui/painting/qpainterpath.cpp index 25dd134401..eb67709318 100644 --- a/src/gui/painting/qpainterpath.cpp +++ b/src/gui/painting/qpainterpath.cpp @@ -227,8 +227,8 @@ static void qt_debug_path(const QPainterPath &path) \table 100% \row - \o \inlineimage qpainterpath-construction.png - \o + \li \inlineimage qpainterpath-construction.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 0 \endtable @@ -241,11 +241,11 @@ static void qt_debug_path(const QPainterPath &path) \table \header - \o Qt::OddEvenFill - \o Qt::WindingFill + \li Qt::OddEvenFill + \li Qt::WindingFill \row - \o \inlineimage qt-fillrule-oddeven.png - \o \inlineimage qt-fillrule-winding.png + \li \inlineimage qt-fillrule-oddeven.png + \li \inlineimage qt-fillrule-winding.png \endtable See the Qt::FillRule documentation for the definition of the @@ -316,11 +316,11 @@ static void qt_debug_path(const QPainterPath &path) \table \header - \o \l {painting/painterpaths}{Painter Paths Example} - \o \l {painting/deform}{Vector Deformation Example} + \li \l {painting/painterpaths}{Painter Paths Example} + \li \l {painting/deform}{Vector Deformation Example} \row - \o \inlineimage qpainterpath-example.png - \o \inlineimage qpainterpath-demo.png + \li \inlineimage qpainterpath-example.png + \li \inlineimage qpainterpath-demo.png \endtable \sa QPainterPathStroker, QPainter, QRegion, {Painter Paths Example} @@ -731,8 +731,8 @@ void QPainterPath::lineTo(const QPointF &p) \table 100% \row - \o \inlineimage qpainterpath-cubicto.png - \o + \li \inlineimage qpainterpath-cubicto.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 1 \endtable @@ -858,8 +858,8 @@ void QPainterPath::quadTo(const QPointF &c, const QPointF &e) \table 100% \row - \o \inlineimage qpainterpath-arcto.png - \o + \li \inlineimage qpainterpath-arcto.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 2 \endtable @@ -970,8 +970,8 @@ QPointF QPainterPath::currentPosition() const \table 100% \row - \o \inlineimage qpainterpath-addrectangle.png - \o + \li \inlineimage qpainterpath-addrectangle.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 3 \endtable @@ -1017,8 +1017,8 @@ void QPainterPath::addRect(const QRectF &r) \table 100% \row - \o \inlineimage qpainterpath-addpolygon.png - \o + \li \inlineimage qpainterpath-addpolygon.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 4 \endtable @@ -1053,8 +1053,8 @@ void QPainterPath::addPolygon(const QPolygonF &polygon) \table 100% \row - \o \inlineimage qpainterpath-addellipse.png - \o + \li \inlineimage qpainterpath-addellipse.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 5 \endtable @@ -1105,8 +1105,8 @@ void QPainterPath::addEllipse(const QRectF &boundingRect) \table 100% \row - \o \inlineimage qpainterpath-addtext.png - \o + \li \inlineimage qpainterpath-addtext.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpainterpath.cpp 6 \endtable @@ -1281,11 +1281,11 @@ Qt::FillRule QPainterPath::fillRule() const \table \header - \o Qt::OddEvenFill (default) - \o Qt::WindingFill + \li Qt::OddEvenFill (default) + \li Qt::WindingFill \row - \o \inlineimage qt-fillrule-oddeven.png - \o \inlineimage qt-fillrule-winding.png + \li \inlineimage qt-fillrule-oddeven.png + \li \inlineimage qt-fillrule-winding.png \endtable \sa fillRule() @@ -2457,10 +2457,10 @@ void qt_path_stroke_cubic_to(qfixed c1x, qfixed c1y, functions: \list - \o setWidth() - \o setCapStyle() - \o setJoinStyle() - \o setDashPattern() + \li setWidth() + \li setCapStyle() + \li setJoinStyle() + \li setDashPattern() \endlist The setDashPattern() function accepts both a Qt::PenStyle object diff --git a/src/gui/painting/qpen.cpp b/src/gui/painting/qpen.cpp index 8d05eb56ff..77f0edc52f 100644 --- a/src/gui/painting/qpen.cpp +++ b/src/gui/painting/qpen.cpp @@ -104,21 +104,21 @@ typedef QPenPrivate QPenData; \table \row - \o \inlineimage qpen-solid.png - \o \inlineimage qpen-dash.png - \o \inlineimage qpen-dot.png + \li \inlineimage qpen-solid.png + \li \inlineimage qpen-dash.png + \li \inlineimage qpen-dot.png \row - \o Qt::SolidLine - \o Qt::DashLine - \o Qt::DotLine + \li Qt::SolidLine + \li Qt::DashLine + \li Qt::DotLine \row - \o \inlineimage qpen-dashdot.png - \o \inlineimage qpen-dashdotdot.png - \o \inlineimage qpen-custom.png + \li \inlineimage qpen-dashdot.png + \li \inlineimage qpen-dashdotdot.png + \li \inlineimage qpen-custom.png \row - \o Qt::DashDotLine - \o Qt::DashDotDotLine - \o Qt::CustomDashLine + \li Qt::DashDotLine + \li Qt::DashDotDotLine + \li Qt::CustomDashLine \endtable Simply use the setStyle() function to convert the pen style to @@ -153,13 +153,13 @@ typedef QPenPrivate QPenData; \table \row - \o \inlineimage qpen-square.png - \o \inlineimage qpen-flat.png - \o \inlineimage qpen-roundcap.png + \li \inlineimage qpen-square.png + \li \inlineimage qpen-flat.png + \li \inlineimage qpen-roundcap.png \row - \o Qt::SquareCap - \o Qt::FlatCap - \o Qt::RoundCap + \li Qt::SquareCap + \li Qt::FlatCap + \li Qt::RoundCap \endtable The Qt::SquareCap style is a square line end that covers the end @@ -183,13 +183,13 @@ typedef QPenPrivate QPenData; \table \row - \o \inlineimage qpen-bevel.png - \o \inlineimage qpen-miter.png - \o \inlineimage qpen-roundjoin.png + \li \inlineimage qpen-bevel.png + \li \inlineimage qpen-miter.png + \li \inlineimage qpen-roundjoin.png \row - \o Qt::BevelJoin - \o Qt::MiterJoin - \o Qt::RoundJoin + \li Qt::BevelJoin + \li Qt::MiterJoin + \li Qt::RoundJoin \endtable The Qt::BevelJoin style fills the triangular notch between the two @@ -213,8 +213,8 @@ typedef QPenPrivate QPenData; \table 100% \row - \o \inlineimage qpen-demo.png - \o \bold {\l {painting/pathstroke}{The Path Stroking Example}} + \li \inlineimage qpen-demo.png + \li \b {\l {painting/pathstroke}{The Path Stroking Example}} The Path Stroking example shows Qt's built-in dash patterns and shows how custom patterns can be used to extend the range of available @@ -474,8 +474,8 @@ QVector<qreal> QPen::dashPattern() const \table 100% \row - \o \inlineimage qpen-custom.png - \o + \li \inlineimage qpen-custom.png + \li \snippet doc/src/snippets/code/src_gui_painting_qpen.cpp 3 \endtable @@ -527,8 +527,8 @@ qreal QPen::dashOffset() const to specify the dash pattern. \table - \row \o \inlineimage qpen-dashpattern.png - \o For example, a pattern where each stroke is four units long, followed by a gap + \row \li \inlineimage qpen-dashpattern.png + \li For example, a pattern where each stroke is four units long, followed by a gap of two units, will begin with the stroke when drawn as a line. However, if the dash offset is set to 4.0, any line drawn will begin with the gap. diff --git a/src/gui/painting/qregion.cpp b/src/gui/painting/qregion.cpp index 48b0c00014..ebca1edddc 100644 --- a/src/gui/painting/qregion.cpp +++ b/src/gui/painting/qregion.cpp @@ -894,11 +894,11 @@ QRegion QRegion::intersect(const QRect &r) const The rectangles \e must be optimally Y-X sorted and follow these restrictions: \list - \o The rectangles must not intersect. - \o All rectangles with a given top coordinate must have the same height. - \o No two rectangles may abut horizontally (they should be combined + \li The rectangles must not intersect. + \li All rectangles with a given top coordinate must have the same height. + \li No two rectangles may abut horizontally (they should be combined into a single wider rectangle in that case). - \o The rectangles must be sorted in ascending order, with Y as the major + \li The rectangles must be sorted in ascending order, with Y as the major sort key and X as the minor sort key. \endlist \omit diff --git a/src/gui/painting/qtransform.cpp b/src/gui/painting/qtransform.cpp index 363dd26bbf..e5c41efc15 100644 --- a/src/gui/painting/qtransform.cpp +++ b/src/gui/painting/qtransform.cpp @@ -156,8 +156,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qtransform-simpletransformation.png - \o + \li \inlineimage qtransform-simpletransformation.png + \li \snippet doc/src/snippets/transform/main.cpp 0 \endtable @@ -168,8 +168,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qtransform-combinedtransformation.png - \o + \li \inlineimage qtransform-combinedtransformation.png + \li \snippet doc/src/snippets/transform/main.cpp 1 \endtable @@ -218,8 +218,8 @@ QT_BEGIN_NAMESPACE \table 100% \row - \o \inlineimage qtransform-combinedtransformation2.png - \o + \li \inlineimage qtransform-combinedtransformation2.png + \li \snippet doc/src/snippets/transform/main.cpp 2 \endtable diff --git a/src/gui/text/qabstracttextdocumentlayout.cpp b/src/gui/text/qabstracttextdocumentlayout.cpp index 86de48b1dc..589c0f701f 100644 --- a/src/gui/text/qabstracttextdocumentlayout.cpp +++ b/src/gui/text/qabstracttextdocumentlayout.cpp @@ -100,14 +100,14 @@ QT_BEGIN_NAMESPACE custom text object into a document: \list - \o Choose an \a objectType. The \a objectType is an integer with a + \li Choose an \a objectType. The \a objectType is an integer with a value greater or equal to QTextFormat::UserObject. - \o Create a QTextCharFormat object and set the object type to the + \li Create a QTextCharFormat object and set the object type to the chosen type using the setObjectType() function. - \o Implement the QTextObjectInterface class. - \o Call QAbstractTextDocumentLayout::registerHandler() with an instance of your + \li Implement the QTextObjectInterface class. + \li Call QAbstractTextDocumentLayout::registerHandler() with an instance of your QTextObjectInterface subclass to register your object type. - \o Insert QChar::ObjectReplacementCharacter with the aforementioned + \li Insert QChar::ObjectReplacementCharacter with the aforementioned QTextCharFormat of the chosen object type into the document. As mentioned, the functions of QTextObjectInterface \l{QTextObjectInterface::}{intrinsicSize()} and @@ -269,17 +269,17 @@ QT_BEGIN_NAMESPACE implementation of this function would have to do the following: \list - \o Determine the list of changed \l{QTextBlock}(s) using the parameters + \li Determine the list of changed \l{QTextBlock}(s) using the parameters provided. - \o Each QTextBlock object's corresponding QTextLayout object needs to + \li Each QTextBlock object's corresponding QTextLayout object needs to be processed. You can access the \l{QTextBlock}'s layout using the QTextBlock::layout() function. This processing should take the document's page size into consideration. - \o If the total number of pages changed, the pageCountChanged() signal + \li If the total number of pages changed, the pageCountChanged() signal should be emitted. - \o If the total size changed, the documentSizeChanged() signal should + \li If the total size changed, the documentSizeChanged() signal should be emitted. - \o The update() signal should be emitted to schedule a repaint of areas + \li The update() signal should be emitted to schedule a repaint of areas in the layout that require repainting. \endlist diff --git a/src/gui/text/qfont.cpp b/src/gui/text/qfont.cpp index 3515c7dc3c..c68452d55a 100644 --- a/src/gui/text/qfont.cpp +++ b/src/gui/text/qfont.cpp @@ -419,14 +419,14 @@ QFontEngineData::~QFontEngineData() \target fontmatching The font matching algorithm works as follows: \list 1 - \o The specified font family is searched for. - \o If not found, the styleHint() is used to select a replacement + \li The specified font family is searched for. + \li If not found, the styleHint() is used to select a replacement family. - \o Each replacement font family is searched for. - \o If none of these are found or there was no styleHint(), "helvetica" + \li Each replacement font family is searched for. + \li If none of these are found or there was no styleHint(), "helvetica" will be searched for. - \o If "helvetica" isn't found Qt will try the lastResortFamily(). - \o If the lastResortFamily() isn't found Qt will try the + \li If "helvetica" isn't found Qt will try the lastResortFamily(). + \li If the lastResortFamily() isn't found Qt will try the lastResortFont() which will always return a name of some kind. \endlist @@ -440,10 +440,10 @@ QFontEngineData::~QFontEngineData() Once a font is found, the remaining attributes are matched in order of priority: \list 1 - \o fixedPitch() - \o pointSize() (see below) - \o weight() - \o style() + \li fixedPitch() + \li pointSize() (see below) + \li weight() + \li style() \endlist If you have a font which matches on family, even if none of the @@ -861,35 +861,35 @@ int QFont::pointSize() const \table \header - \o - \o PreferDefaultHinting - \o PreferNoHinting - \o PreferVerticalHinting - \o PreferFullHinting + \li + \li PreferDefaultHinting + \li PreferNoHinting + \li PreferVerticalHinting + \li PreferFullHinting \row - \o Windows Vista (w/o Platform Update) and earlier - \o Full hinting - \o Full hinting - \o Full hinting - \o Full hinting + \li Windows Vista (w/o Platform Update) and earlier + \li Full hinting + \li Full hinting + \li Full hinting + \li Full hinting \row - \o Windows 7 and Windows Vista (w/Platform Update) and DirectWrite enabled in Qt - \o Full hinting - \o Vertical hinting - \o Vertical hinting - \o Full hinting + \li Windows 7 and Windows Vista (w/Platform Update) and DirectWrite enabled in Qt + \li Full hinting + \li Vertical hinting + \li Vertical hinting + \li Full hinting \row - \o FreeType - \o Operating System setting - \o No hinting - \o Vertical hinting (light) - \o Full hinting + \li FreeType + \li Operating System setting + \li No hinting + \li Vertical hinting (light) + \li Full hinting \row - \o Cocoa on Mac OS X - \o No hinting - \o No hinting - \o No hinting - \o No hinting + \li Cocoa on Mac OS X + \li No hinting + \li No hinting + \li No hinting + \li No hinting \endtable \note Please be aware that altering the hinting preference on Windows is available through @@ -2277,7 +2277,7 @@ QDataStream &operator>>(QDataStream &s, QFont &font) There are three ways to create a QFontInfo object. \list 1 - \o Calling the QFontInfo constructor with a QFont creates a font + \li Calling the QFontInfo constructor with a QFont creates a font info object for a screen-compatible font, i.e. the font cannot be a printer font. If the font is changed later, the font info object is \e not updated. @@ -2286,12 +2286,12 @@ QDataStream &operator>>(QDataStream &s, QFont &font) inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied.) - \o QWidget::fontInfo() returns the font info for a widget's font. + \li QWidget::fontInfo() returns the font info for a widget's font. This is equivalent to calling QFontInfo(widget->font()). If the widget's font is changed later, the font info object is \e not updated. - \o QPainter::fontInfo() returns the font info for a painter's + \li QPainter::fontInfo() returns the font info for a painter's current font. If the painter's font is changed later, the font info object is \e not updated. \endlist diff --git a/src/gui/text/qfontdatabase.cpp b/src/gui/text/qfontdatabase.cpp index 7fa486e1ee..468d029cf2 100644 --- a/src/gui/text/qfontdatabase.cpp +++ b/src/gui/text/qfontdatabase.cpp @@ -2244,7 +2244,7 @@ int QFontDatabase::addApplicationFont(const QString &fileName) Currently only TrueType fonts and TrueType font collections are supported. - \bold{Note:} Adding application fonts on Unix/X11 platforms without fontconfig is + \b{Note:} Adding application fonts on Unix/X11 platforms without fontconfig is currently not supported. \sa addApplicationFont(), applicationFontFamilies(), removeApplicationFont() diff --git a/src/gui/text/qfontmetrics.cpp b/src/gui/text/qfontmetrics.cpp index 283494e316..7209fbdfc3 100644 --- a/src/gui/text/qfontmetrics.cpp +++ b/src/gui/text/qfontmetrics.cpp @@ -76,7 +76,7 @@ extern void qt_format_text(const QFont& font, const QRectF &_r, QFontMetrics object: \list 1 - \o Calling the QFontMetrics constructor with a QFont creates a + \li Calling the QFontMetrics constructor with a QFont creates a font metrics object for a screen-compatible font, i.e. the font cannot be a printer font. If the font is changed later, the font metrics object is \e not updated. @@ -85,12 +85,12 @@ extern void qt_format_text(const QFont& font, const QRectF &_r, inaccurate. Printer fonts are not always accessible so the nearest screen font is used if a printer font is supplied.) - \o QWidget::fontMetrics() returns the font metrics for a widget's + \li QWidget::fontMetrics() returns the font metrics for a widget's font. This is equivalent to QFontMetrics(widget->font()). If the widget's font is changed later, the font metrics object is \e not updated. - \o QPainter::fontMetrics() returns the font metrics for a + \li QPainter::fontMetrics() returns the font metrics for a painter's current font. If the painter's font is changed later, the font metrics object is \e not updated. \endlist @@ -713,20 +713,20 @@ QRect QFontMetrics::boundingRect(QChar ch) const The \a flags argument is the bitwise OR of the following flags: \list - \o Qt::AlignLeft aligns to the left border, except for + \li Qt::AlignLeft aligns to the left border, except for Arabic and Hebrew where it aligns to the right. - \o Qt::AlignRight aligns to the right border, except for + \li Qt::AlignRight aligns to the right border, except for Arabic and Hebrew where it aligns to the left. - \o Qt::AlignJustify produces justified text. - \o Qt::AlignHCenter aligns horizontally centered. - \o Qt::AlignTop aligns to the top border. - \o Qt::AlignBottom aligns to the bottom border. - \o Qt::AlignVCenter aligns vertically centered - \o Qt::AlignCenter (== \c{Qt::AlignHCenter | Qt::AlignVCenter}) - \o Qt::TextSingleLine ignores newline characters in the text. - \o Qt::TextExpandTabs expands tabs (see below) - \o Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. - \o Qt::TextWordWrap breaks the text to fit the rectangle. + \li Qt::AlignJustify produces justified text. + \li Qt::AlignHCenter aligns horizontally centered. + \li Qt::AlignTop aligns to the top border. + \li Qt::AlignBottom aligns to the bottom border. + \li Qt::AlignVCenter aligns vertically centered + \li Qt::AlignCenter (== \c{Qt::AlignHCenter | Qt::AlignVCenter}) + \li Qt::TextSingleLine ignores newline characters in the text. + \li Qt::TextExpandTabs expands tabs (see below) + \li Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. + \li Qt::TextWordWrap breaks the text to fit the rectangle. \endlist Qt::Horizontal alignment defaults to Qt::AlignLeft and vertical @@ -780,10 +780,10 @@ QRect QFontMetrics::boundingRect(const QRect &rect, int flags, const QString &te The \a flags argument is the bitwise OR of the following flags: \list - \o Qt::TextSingleLine ignores newline characters. - \o Qt::TextExpandTabs expands tabs (see below) - \o Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. - \o Qt::TextWordBreak breaks the text to fit the rectangle. + \li Qt::TextSingleLine ignores newline characters. + \li Qt::TextExpandTabs expands tabs (see below) + \li Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. + \li Qt::TextWordBreak breaks the text to fit the rectangle. \endlist If Qt::TextExpandTabs is set in \a flags, then: if \a tabArray is @@ -1490,20 +1490,20 @@ QRectF QFontMetricsF::boundingRect(QChar ch) const The \a flags argument is the bitwise OR of the following flags: \list - \o Qt::AlignLeft aligns to the left border, except for + \li Qt::AlignLeft aligns to the left border, except for Arabic and Hebrew where it aligns to the right. - \o Qt::AlignRight aligns to the right border, except for + \li Qt::AlignRight aligns to the right border, except for Arabic and Hebrew where it aligns to the left. - \o Qt::AlignJustify produces justified text. - \o Qt::AlignHCenter aligns horizontally centered. - \o Qt::AlignTop aligns to the top border. - \o Qt::AlignBottom aligns to the bottom border. - \o Qt::AlignVCenter aligns vertically centered - \o Qt::AlignCenter (== \c{Qt::AlignHCenter | Qt::AlignVCenter}) - \o Qt::TextSingleLine ignores newline characters in the text. - \o Qt::TextExpandTabs expands tabs (see below) - \o Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. - \o Qt::TextWordWrap breaks the text to fit the rectangle. + \li Qt::AlignJustify produces justified text. + \li Qt::AlignHCenter aligns horizontally centered. + \li Qt::AlignTop aligns to the top border. + \li Qt::AlignBottom aligns to the bottom border. + \li Qt::AlignVCenter aligns vertically centered + \li Qt::AlignCenter (== \c{Qt::AlignHCenter | Qt::AlignVCenter}) + \li Qt::TextSingleLine ignores newline characters in the text. + \li Qt::TextExpandTabs expands tabs (see below) + \li Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. + \li Qt::TextWordWrap breaks the text to fit the rectangle. \endlist Qt::Horizontal alignment defaults to Qt::AlignLeft and vertical @@ -1517,9 +1517,9 @@ QRectF QFontMetricsF::boundingRect(QChar ch) const If Qt::TextExpandTabs is set in \a flags, the following behavior is used to interpret tab characters in the text: \list - \o If \a tabArray is non-null, it specifies a 0-terminated sequence of + \li If \a tabArray is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs in the text. - \o If \a tabStops is non-zero, it is used as the tab spacing (in pixels). + \li If \a tabStops is non-zero, it is used as the tab spacing (in pixels). \endlist Note that the bounding rectangle may extend to the left of (0, 0), @@ -1559,10 +1559,10 @@ QRectF QFontMetricsF::boundingRect(const QRectF &rect, int flags, const QString& The \a flags argument is the bitwise OR of the following flags: \list - \o Qt::TextSingleLine ignores newline characters. - \o Qt::TextExpandTabs expands tabs (see below) - \o Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. - \o Qt::TextWordBreak breaks the text to fit the rectangle. + \li Qt::TextSingleLine ignores newline characters. + \li Qt::TextExpandTabs expands tabs (see below) + \li Qt::TextShowMnemonic interprets "&x" as \underline{x}; i.e., underlined. + \li Qt::TextWordBreak breaks the text to fit the rectangle. \endlist These flags are defined in \l{Qt::TextFlags}. @@ -1570,9 +1570,9 @@ QRectF QFontMetricsF::boundingRect(const QRectF &rect, int flags, const QString& If Qt::TextExpandTabs is set in \a flags, the following behavior is used to interpret tab characters in the text: \list - \o If \a tabArray is non-null, it specifies a 0-terminated sequence of + \li If \a tabArray is non-null, it specifies a 0-terminated sequence of pixel-positions for tabs in the text. - \o If \a tabStops is non-zero, it is used as the tab spacing (in pixels). + \li If \a tabStops is non-zero, it is used as the tab spacing (in pixels). \endlist Newline characters are processed as line breaks. diff --git a/src/gui/text/qrawfont.cpp b/src/gui/text/qrawfont.cpp index 79793d5845..9fbeef4685 100644 --- a/src/gui/text/qrawfont.cpp +++ b/src/gui/text/qrawfont.cpp @@ -86,13 +86,13 @@ QT_BEGIN_NAMESPACE QRawFont can be constructed in a number of ways: \list - \o It can be constructed by calling QTextLayout::glyphs() or QTextFragment::glyphs(). The + \li It can be constructed by calling QTextLayout::glyphs() or QTextFragment::glyphs(). The returned QGlyphs objects will contain QRawFont objects which represent the actual fonts used to render each portion of the text. - \o It can be constructed by passing a QFont object to QRawFont::fromFont(). The function + \li It can be constructed by passing a QFont object to QRawFont::fromFont(). The function will return a QRawFont object representing the font that will be selected as response to the QFont query and the selected writing system. - \o It can be constructed by passing a file name or QByteArray directly to the QRawFont + \li It can be constructed by passing a file name or QByteArray directly to the QRawFont constructor, or by calling loadFromFile() or loadFromData(). In this case, the font will not be registered in QFontDatabase, and it will not be available as part of regular font selection. diff --git a/src/gui/text/qtextcursor.cpp b/src/gui/text/qtextcursor.cpp index ddf2fb080e..0dd0d99d2a 100644 --- a/src/gui/text/qtextcursor.cpp +++ b/src/gui/text/qtextcursor.cpp @@ -950,15 +950,15 @@ QTextLayout *QTextCursorPrivate::blockLayout(QTextBlock &block) const{ document with the cursor: \list - \i Lists are ordered sequences of block elements that are decorated with + \li Lists are ordered sequences of block elements that are decorated with bullet points or symbols. These are inserted in a specified format with insertList(). - \i Tables are inserted with the insertTable() function, and can be + \li Tables are inserted with the insertTable() function, and can be given an optional format. These contain an array of cells that can be traversed using the cursor. - \i Inline images are inserted with insertImage(). The image to be + \li Inline images are inserted with insertImage(). The image to be used can be specified in an image format, or by name. - \i Frames are inserted by calling insertFrame() with a specified format. + \li Frames are inserted by calling insertFrame() with a specified format. \endlist Actions can be grouped (i.e. treated as a single action for @@ -1621,7 +1621,7 @@ void QTextCursor::selectedTableCells(int *firstRow, int *numRows, int *firstColu /*! Clears the current selection by setting the anchor to the cursor position. - Note that it does \bold{not} delete the text of the selection. + Note that it does \b{not} delete the text of the selection. \sa removeSelectedText() hasSelection() */ diff --git a/src/gui/text/qtextdocument.cpp b/src/gui/text/qtextdocument.cpp index 1fad064b5c..a8991d5428 100644 --- a/src/gui/text/qtextdocument.cpp +++ b/src/gui/text/qtextdocument.cpp @@ -261,14 +261,14 @@ QTextCodec *Qt::codecForHtml(const QByteArray &ba) system. The following are the undo/redo operations of a QTextDocument: \list - \o Insertion or removal of characters. A sequence of insertions or removals + \li Insertion or removal of characters. A sequence of insertions or removals within the same text block are regarded as a single undo/redo operation. - \o Insertion or removal of text blocks. Sequences of insertion or removals + \li Insertion or removal of text blocks. Sequences of insertion or removals in a single operation (e.g., by selecting and then deleting text) are regarded as a single undo/redo operation. - \o Text character format changes. - \o Text block format changes. - \o Text block group format changes. + \li Text character format changes. + \li Text block format changes. + \li Text block group format changes. \endlist \sa QTextCursor, QTextEdit, \link richtext.html Rich Text Processing\endlink , {Text Object Example} @@ -887,7 +887,7 @@ QChar QTextDocument::characterAt(int pos) const The style sheet needs to be compliant to CSS 2.1 syntax. - \bold{Note:} Changing the default style sheet does not have any effect to the existing content + \b{Note:} Changing the default style sheet does not have any effect to the existing content of the document. \sa {Supported HTML Subset} @@ -1169,7 +1169,7 @@ void QTextDocument::setPlainText(const QString &text) The HTML formatting is respected as much as possible; for example, "<b>bold</b> text" will produce text where the first word has a font - weight that gives it a bold appearance: "\bold{bold} text". + weight that gives it a bold appearance: "\b{bold} text". \note It is the responsibility of the caller to make sure that the text is correctly decoded when a QString containing HTML is created diff --git a/src/gui/text/qtextdocumentwriter.cpp b/src/gui/text/qtextdocumentwriter.cpp index d43a61866d..b0bbeb7a47 100644 --- a/src/gui/text/qtextdocumentwriter.cpp +++ b/src/gui/text/qtextdocumentwriter.cpp @@ -345,10 +345,10 @@ QTextCodec *QTextDocumentWriter::codec() const By default, Qt can write the following formats: \table - \header \o Format \o Description - \row \o plaintext \o Plain text - \row \o HTML \o HyperText Markup Language - \row \o ODF \o OpenDocument Format + \header \li Format \li Description + \row \li plaintext \li Plain text + \row \li HTML \li HyperText Markup Language + \row \li ODF \li OpenDocument Format \endtable \sa setFormat() diff --git a/src/gui/text/qtextlist.cpp b/src/gui/text/qtextlist.cpp index 5a642e90ef..c3c71bc021 100644 --- a/src/gui/text/qtextlist.cpp +++ b/src/gui/text/qtextlist.cpp @@ -107,7 +107,7 @@ public: Returns true if the list has no items; otherwise returns false. - \bold{Note:} Empty lists are automatically deleted by the QTextDocument that owns + \b{Note:} Empty lists are automatically deleted by the QTextDocument that owns them. \sa count() diff --git a/src/gui/text/qtexttable.cpp b/src/gui/text/qtexttable.cpp index 12af933fd0..65bc8fde1e 100644 --- a/src/gui/text/qtexttable.cpp +++ b/src/gui/text/qtexttable.cpp @@ -541,22 +541,22 @@ void QTextTablePrivate::update() const \table 80% \row - \o \inlineimage texttable-split.png Original Table - \o Suppose we have a 2x3 table of names and addresses. To merge both + \li \inlineimage texttable-split.png Original Table + \li Suppose we have a 2x3 table of names and addresses. To merge both columns in the first row we invoke mergeCells() with \a row = 0, \a column = 0, \a numRows = 1 and \a numColumns = 2. \snippet doc/src/snippets/textdocument-texttable/main.cpp 0 \row - \o \inlineimage texttable-merge.png - \o This gives us the following table. To split the first row of the table + \li \inlineimage texttable-merge.png + \li This gives us the following table. To split the first row of the table back into two cells, we invoke the splitCell() function with \a numRows and \a numCols = 1. \snippet doc/src/snippets/textdocument-texttable/main.cpp 1 \row - \o \inlineimage texttable-split.png Split Table - \o This results in the original table. + \li \inlineimage texttable-split.png Split Table + \li This results in the original table. \endtable \sa QTextTableFormat diff --git a/src/gui/util/qvalidator.cpp b/src/gui/util/qvalidator.cpp index 02552f5a53..ce16785d1d 100644 --- a/src/gui/util/qvalidator.cpp +++ b/src/gui/util/qvalidator.cpp @@ -82,18 +82,18 @@ QT_BEGIN_NAMESPACE \list - \i For a line edit that accepts integers from 10 to 1000 inclusive, + \li For a line edit that accepts integers from 10 to 1000 inclusive, 42 and 123 are \l Acceptable, the empty string and 5 are \l Intermediate, and "asdf" and 1114 is \l Invalid. - \i For an editable combobox that accepts URLs, any well-formed URL + \li For an editable combobox that accepts URLs, any well-formed URL is \l Acceptable, "http://example.com/," is \l Intermediate (it might be a cut and paste action that accidentally took in a comma at the end), the empty string is \l Intermediate (the user might select and delete all of the text in preparation for entering a new URL) and "http:///./" is \l Invalid. - \i For a spin box that accepts lengths, "11cm" and "1in" are \l + \li For a spin box that accepts lengths, "11cm" and "1in" are \l Acceptable, "11" and the empty string are \l Intermediate, and "http://example.com" and "hour" are \l Invalid. @@ -801,13 +801,13 @@ QDoubleValidator::Notation QDoubleValidator::notation() const When QRegExpValidator determines whether a string is \l Acceptable or not, the regexp is treated as if it begins with the start of string - assertion (\bold{^}) and ends with the end of string assertion - (\bold{$}); the match is against the entire input string, or from + assertion (\b{^}) and ends with the end of string assertion + (\b{$}); the match is against the entire input string, or from the given position if a start position greater than zero is given. If a string is a prefix of an \l Acceptable string, it is considered \l Intermediate. For example, "" and "A" are \l Intermediate for the - regexp \bold{[A-Z][0-9]} (whereas "_" would be \l Invalid). + regexp \b{[A-Z][0-9]} (whereas "_" would be \l Invalid). For a brief introduction to Qt's regexp engine, see \l QRegExp. @@ -837,7 +837,7 @@ QRegExpValidator::QRegExpValidator(QObject *parent) accepts all strings that match the regular expression \a rx. The match is made against the entire string; e.g. if the regexp is - \bold{[A-Fa-f0-9]+} it will be treated as \bold{^[A-Fa-f0-9]+$}. + \b{[A-Fa-f0-9]+} it will be treated as \b{^[A-Fa-f0-9]+$}. */ QRegExpValidator::QRegExpValidator(const QRegExp& rx, QObject *parent) @@ -862,7 +862,7 @@ QRegExpValidator::~QRegExpValidator() The \a pos parameter is set to the length of the \a input parameter. - For example, if the regular expression is \bold{\\w\\d\\d} + For example, if the regular expression is \b{\\w\\d\\d} (word-character, digit, digit) then "A57" is \l Acceptable, "E5" is \l Intermediate, and "+9" is \l Invalid. |