path: root/doc/src/gui
diff options
authorCasper van Donderen <>2012-03-01 15:28:31 +0100
committerQt by Nokia <>2012-03-02 23:16:25 +0100
commit95d83cb1b68cc4a415d5d80859b4e74472ad7112 (patch)
tree9f6fa892ee78f584224320a195f03419c0fdbc21 /doc/src/gui
parent15e136d4e116c1513c106dfbb75e1953a7f3463c (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 <> Reviewed-by: Lars Knoll <>
Diffstat (limited to 'doc/src/gui')
2 files changed, 99 insertions, 99 deletions
diff --git a/doc/src/gui/coordsys.qdoc b/doc/src/gui/coordsys.qdoc
index ae1506ddd8..655dbf7cf3 100644
--- a/doc/src/gui/coordsys.qdoc
+++ b/doc/src/gui/coordsys.qdoc
@@ -67,11 +67,11 @@
- \o \inlineimage coordinatesystem-rect.png
- \o \inlineimage coordinatesystem-line.png
+ \li \inlineimage coordinatesystem-rect.png
+ \li \inlineimage coordinatesystem-line.png
- \o QRect(1, 2, 6, 4)
- \o QLine(2, 7, 6, 1)
+ \li QRect(1, 2, 6, 4)
+ \li QLine(2, 7, 6, 1)
\section2 Aliased Painting
@@ -92,14 +92,14 @@
- \o \inlineimage coordinatesystem-rect-raster.png
- \o \inlineimage coordinatesystem-line-raster.png
+ \li \inlineimage coordinatesystem-rect-raster.png
+ \li \inlineimage coordinatesystem-line-raster.png
- \o
+ \li
\snippet doc/src/snippets/code/doc_src_coordsys.cpp 0
- \o
+ \li
\snippet doc/src/snippets/code/doc_src_coordsys.cpp 1
@@ -112,19 +112,19 @@
- \o {3,1} QRectF
+ \li {3,1} QRectF
- \o \inlineimage qrect-diagram-zero.png
- \o \inlineimage qrectf-diagram-one.png
+ \li \inlineimage qrect-diagram-zero.png
+ \li \inlineimage qrectf-diagram-one.png
- \o Logical representation
- \o One pixel wide pen
+ \li Logical representation
+ \li One pixel wide pen
- \o \inlineimage qrectf-diagram-two.png
- \o \inlineimage qrectf-diagram-three.png
+ \li \inlineimage qrectf-diagram-two.png
+ \li \inlineimage qrectf-diagram-three.png
- \o Two pixel wide pen
- \o Three pixel wide pen
+ \li Two pixel wide pen
+ \li Three pixel wide pen
Note that for historical reasons the return value of the
@@ -158,14 +158,14 @@
- \o \inlineimage coordinatesystem-rect-antialias.png
- \o \inlineimage coordinatesystem-line-antialias.png
+ \li \inlineimage coordinatesystem-rect-antialias.png
+ \li \inlineimage coordinatesystem-line-antialias.png
- \o
+ \li
\snippet doc/src/snippets/code/doc_src_coordsys.cpp 2
- \o
+ \li
\snippet doc/src/snippets/code/doc_src_coordsys.cpp 3
@@ -183,15 +183,15 @@
- \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
- \o nop
- \o \l {QPainter::rotate()}{rotate()}
- \o \l {QPainter::scale()}{scale()}
- \o \l {QPainter::translate()}{translate()}
+ \li nop
+ \li \l {QPainter::rotate()}{rotate()}
+ \li \l {QPainter::scale()}{scale()}
+ \li \l {QPainter::translate()}{translate()}
You can also twist the coordinate system around the origin using
@@ -218,10 +218,10 @@
\table 100%
- \o {2,1} Analog Clock Example
+ \li {2,1} Analog Clock Example
- \o \inlineimage coordinatesystem-analogclock.png
- \o
+ \li \inlineimage coordinatesystem-analogclock.png
+ \li
The Analog Clock example shows how to draw the contents of a
custom widget using QPainter's transformation matrix.
@@ -236,7 +236,7 @@
- \o {2,1}
+ \li {2,1}
\snippet examples/widgets/analogclock/analogclock.cpp 9
@@ -368,23 +368,23 @@
QPaintDevice, and QPaintEngine classes:
- \header \o Class \o Description
+ \header \li Class \li Description
- \o QPainter
- \o
+ \li QPainter
+ \li
The QPainter class performs low-level painting on widgets and
other paint devices. QPainter can operate on any object that
inherits the QPaintDevice class, using the same code.
- \o QPaintDevice
- \o
+ \li QPaintDevice
+ \li
The QPaintDevice class is the base class of objects that can be
painted. Qt provides several devices: QWidget, QImage, QPixmap,
QPrinter and QPicture, and other devices can also be defined by
subclassing QPaintDevice.
- \o QPaintEngine
- \o
+ \li QPaintEngine
+ \li
The QPaintEngine class provides an abstract definition of how
QPainter draws to a given device on a given platform. Qt 4
provides several premade implementations of QPaintEngine for the
@@ -397,10 +397,10 @@
using the QTransform class:
- \header \o Class \o Description
+ \header \li Class \li Description
- \o QTransform
- \o
+ \li QTransform
+ \li
A 3 x 3 transformation matrix. Use QTransform to rotate, shear,
scale, or translate the coordinate system.
@@ -411,45 +411,45 @@
name is suffixed with an \c F.
- \header \o Class \o Description
+ \header \li Class \li Description
- \o \l{QPoint}(\l{QPointF}{F})
- \o
+ \li \l{QPoint}(\l{QPointF}{F})
+ \li
A single 2D point in the coordinate system. Most functions in Qt
that deal with points can accept either a QPoint, a QPointF, two
\c{int}s, or two \c{qreal}s.
- \o \l{QSize}(\l{QSizeF}{F})
- \o
+ \li \l{QSize}(\l{QSizeF}{F})
+ \li
A single 2D vector. Internally, QPoint and QSize are the same, but
a point is not the same as a size, so both classes exist. Again,
most functions accept either QSizeF, a QSize, two \c{int}s, or two
- \o \l{QRect}(\l{QRectF}{F})
- \o
+ \li \l{QRect}(\l{QRectF}{F})
+ \li
A 2D rectangle. Most functions accept either a QRectF, a QRect,
four \c{int}s, or four \c {qreal}s.
- \o \l{QLine}(\l{QLineF}{F})
- \o
+ \li \l{QLine}(\l{QLineF}{F})
+ \li
A 2D finite-length line, characterized by a start point and an end
- \o \l{QPolygon}(\l{QPolygonF}{F})
- \o
+ \li \l{QPolygon}(\l{QPolygonF}{F})
+ \li
A 2D polygon. A polygon is a vector of \c{QPoint(F)}s. If the
first and last points are the same, the polygon is closed.
- \o QPainterPath
- \o
+ \li QPainterPath
+ \li
A vectorial specification of a 2D shape. Painter paths are the
ultimate painting primitive, in the sense that any shape
(rectange, ellipse, spline) or combination of shapes can be
expressed as a path. A path specifies both an outline and an area.
- \o QRegion
- \o
+ \li QRegion
+ \li
An area in a paint device, expressed as a list of
\l{QRect}s. In general, we recommend using the vectorial
QPainterPath class instead of QRegion for specifying areas,
diff --git a/doc/src/gui/paintsystem.qdoc b/doc/src/gui/paintsystem.qdoc
index f9670ff5d8..4b33e4fed3 100644
--- a/doc/src/gui/paintsystem.qdoc
+++ b/doc/src/gui/paintsystem.qdoc
@@ -74,13 +74,13 @@
\section1 Topics
- \o \l{Classes for Painting}
- \o \l{Paint Devices and Backends}
- \o \l{Drawing and Filling}
- \o \l{Coordinate System}
- \o \l{Reading and Writing Image Files}
- \o \l{Styling}
- \o \l{Printing with Qt}
+ \li \l{Classes for Painting}
+ \li \l{Paint Devices and Backends}
+ \li \l{Drawing and Filling}
+ \li \l{Coordinate System}
+ \li \l{Reading and Writing Image Files}
+ \li \l{Styling}
+ \li \l{Printing with Qt}
\section1 Classes for Painting
@@ -115,14 +115,14 @@
\image paintsystem-devices.png
\table 100%
- \row \o \bold Widget
+ \row \li \b Widget
The QWidget class is the base class of all user interface
objects. The widget is the atom of the user interface: it receives
mouse, keyboard and other events from the window system, and
paints a representation of itself on the screen.
- \row \o \bold Image
+ \row \li \b Image
The QImage class provides a hardware-independent image
representation which is designed and optimized for I/O, and for
@@ -136,7 +136,7 @@
painting can be performed in another thread than the current GUI
- \row \o \bold Pixmap
+ \row \li \b Pixmap
The QPixmap class is an off-screen image representation which is
designed and optimized for showing images on screen. Unlike
@@ -156,7 +156,7 @@
constructing QRegion objects, and for setting masks for pixmaps
and widgets.
- \row \o \bold {OpenGL Widget}
+ \row \li \b {OpenGL Widget}
As mentioned previously, Qt provides the QtOpenGL module offering
classes that makes it easy to use OpenGL in Qt applications. For
@@ -169,7 +169,7 @@
most drawing operations, such as transformations and pixmap
- \row \o \bold {Pixel Buffer}
+ \row \li \b {Pixel Buffer}
The QtOpenGL module also provides the QGLPixelBuffer class which
inherits QPaintDevice directly.
@@ -178,7 +178,7 @@
pbuffer is normally done using full hardware acceleration which
can be significantly faster than rendering into a QPixmap.
- \row \o \bold {Framebuffer Object}
+ \row \li \b {Framebuffer Object}
The QtOpenGL module also provides the QGLFramebufferObject class
which inherits QPaintDevice directly.
@@ -188,7 +188,7 @@
offer several advantages over pixel buffers for this purpose.
These are described in the QGLFramebufferObject class documentation.
- \row \o \bold {Picture}
+ \row \li \b {Picture}
The QPicture class is a paint device that records and replays
QPainter commands. A picture serializes painter commands to an IO
@@ -200,7 +200,7 @@
Qt provides the QPicture::load() and QPicture::save() functions
as well as streaming operators for loading and saving pictures.
- \row \o \bold {Printer}
+ \row \li \b {Printer}
The QPrinter class is a paint device that paints on a printer. On
Windows or Mac OS X, QPrinter uses the built-in printer
@@ -218,7 +218,7 @@
to QPrinter::PdfFormat, QPrinter will generate its output as a PDF
- \row \o \bold {Custom Backends}
+ \row \li \b {Custom Backends}
Support for a new backend can be implemented by deriving from the
QPaintDevice class and reimplementing the virtual
@@ -238,17 +238,17 @@
- \o Windows
- \o Software Rasterizer
+ \li Windows
+ \li Software Rasterizer
- \o X11
- \o X11
+ \li X11
+ \li X11
- \o Mac OS X
- \o CoreGraphics
+ \li Mac OS X
+ \li CoreGraphics
- \o Embedded
- \o Software Rasterizer
+ \li Embedded
+ \li Software Rasterizer
Passing a command line parameter to the application, such as,
@@ -289,8 +289,8 @@
\table 100%
- \o \image paintsystem-painterpath.png
- \o \bold QPainterPath
+ \li \image paintsystem-painterpath.png
+ \li \b QPainterPath
A painter path is an object composed of lines and curves. For
example, a rectangle is composed by lines and an ellipse is
@@ -333,8 +333,8 @@
pixels, and the benefits of anti-aliased painting.
\table 100%
- \row \o
- \bold {Anti-Aliased Painting}
+ \row \li
+ \b {Anti-Aliased Painting}
When drawing, the pixel rendering is controlled by the
QPainter::Antialiasing render hint. The QPainter::RenderHint enum
@@ -345,7 +345,7 @@
antialias edges of primitives if possible, i.e. smoothing the
edges by using different color intensities.
- \o \image paintsystem-antialiasing.png
+ \li \image paintsystem-antialiasing.png
@@ -376,8 +376,8 @@
\table 100%
- \o \image paintsystem-fancygradient.png
- \o \bold QGradient
+ \li \image paintsystem-fancygradient.png
+ \li \b QGradient
The QGradient class is used in combination with QBrush to specify
gradient fills.
@@ -416,14 +416,14 @@
\table 100%
- \o \bold QMovie
+ \li \b QMovie
QMovie is a convenience class for displaying animations, using the
QImageReader class internally. Once created, the QMovie class
provides various functions for both running and controlling the
given animation.
- \o \image paintsystem-movie.png
+ \li \image paintsystem-movie.png
The QImageReader and QImageWriter classes rely on the
@@ -450,8 +450,8 @@
\table 100%
- \o \image paintsystem-svg.png
- \o \bold {SVG Rendering}
+ \li \image paintsystem-svg.png
+ \li \b {SVG Rendering}
Scalable Vector Graphics (SVG) is a language for describing two-dimensional
graphics and graphical applications in XML. SVG 1.1 is a W3C Recommendation
@@ -513,10 +513,10 @@
Most functions for drawing style elements take four arguments:
- \o an enum value specifying which graphical element to draw
- \o a QStyleOption object specifying how and where to render that element
- \o a QPainter object that should be used to draw the element
- \o a QWidget object on which the drawing is performed (optional)
+ \li an enum value specifying which graphical element to draw
+ \li a QStyleOption object specifying how and where to render that element
+ \li a QPainter object that should be used to draw the element
+ \li a QWidget object on which the drawing is performed (optional)
The style gets all the information it needs to render the
@@ -538,8 +538,8 @@
\table 100%
- \o \inlineimage paintsystem-icon.png
- \o \bold QIcon
+ \li \inlineimage paintsystem-icon.png
+ \li \b QIcon
The QIcon class provides scalable icons in different modes and states.