Move the documentation for the classes to their modules.

All documented classes under src/widgets should now be
under the QtWidgets module in the documentation. The
QtPrintSupport classes should now be under the QtPrintSupport
module in the documentation.

Change-Id: I236b15443b8b93a61578a1d10f52b64dba938f29
Reviewed-on: http://codereview.qt-project.org/5520
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
This commit is contained in:
Casper van Donderen 2011-09-20 23:22:36 +02:00 committed by Qt by Nokia
parent 7f57f29125
commit e86df8cc4b
168 changed files with 361 additions and 62 deletions

View File

@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
relating to accessibility. relating to accessibility.
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
Accessible applications can be used by people who are not able to Accessible applications can be used by people who are not able to
use applications by conventional means. use applications by conventional means.
@ -708,6 +708,7 @@ void QAccessible::updateAccessibility(QObject *o, int who, Event reason)
about accessible objects. about accessible objects.
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
Accessibility tools (also called AT Clients), such as screen readers Accessibility tools (also called AT Clients), such as screen readers
or braille displays, require high-level information about or braille displays, require high-level information about
@ -1158,6 +1159,7 @@ QVector<QPair<QAccessibleInterface*, QAccessible::Relation> > QAccessibleInterfa
\ingroup accessibility \ingroup accessibility
\ingroup events \ingroup events
\inmodule QtWidgets
*/ */
/*! /*!

View File

@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE
accessibility back-ends. accessibility back-ends.
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
Qt supports Microsoft Active Accessibility (MSAA), Mac OS X Qt supports Microsoft Active Accessibility (MSAA), Mac OS X
Accessibility, and the Unix/X11 AT-SPI standard. By subclassing Accessibility, and the Unix/X11 AT-SPI standard. By subclassing
@ -102,6 +103,7 @@ QT_BEGIN_NAMESPACE
\ingroup plugins \ingroup plugins
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
Writing an accessibility bridge plugin is achieved by subclassing Writing an accessibility bridge plugin is achieved by subclassing
this base class, reimplementing the pure virtual functions keys() this base class, reimplementing the pure virtual functions keys()

View File

@ -94,6 +94,7 @@ QList<QByteArray> QAccessibleObjectPrivate::actionList() const
QAccessibleInterface for QObjects. QAccessibleInterface for QObjects.
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
This class is mainly provided for convenience. All subclasses of This class is mainly provided for convenience. All subclasses of
the QAccessibleInterface that provide implementations of non-widget objects the QAccessibleInterface that provide implementations of non-widget objects

View File

@ -60,6 +60,7 @@ class QPrintDialogPrivate : public QAbstractPrintDialogPrivate
print dialogs used to configure printers. print dialogs used to configure printers.
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
This class implements getter and setter functions that are used to This class implements getter and setter functions that are used to
customize settings shown in print dialogs, but it is not used directly. customize settings shown in print dialogs, but it is not used directly.
@ -369,6 +370,7 @@ void QAbstractPrintDialogPrivate::setPrinter(QPrinter *newPrinter)
\ingroup standard-dialogs \ingroup standard-dialogs
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
The dialog allows users to change document-related settings, such The dialog allows users to change document-related settings, such
as the paper size and orientation, type of print (color or as the paper size and orientation, type of print (color or

View File

@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE
\ingroup standard-dialogs \ingroup standard-dialogs
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
On Windows and Mac OS X the page setup dialog is implemented using On Windows and Mac OS X the page setup dialog is implemented using
the native page setup dialogs. the native page setup dialogs.

View File

@ -651,6 +651,7 @@ void QPrintPreviewDialogPrivate::_q_zoomFactorChanged()
\ingroup standard-dialogs \ingroup standard-dialogs
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
Using QPrintPreviewDialog in your existing application is Using QPrintPreviewDialog in your existing application is
straightforward: straightforward:

View File

@ -244,6 +244,7 @@ void QPrinterPrivate::addToManualSetList(QPrintEngine::PrintEnginePropertyKey ke
\brief The QPrinter class is a paint device that paints on a printer. \brief The QPrinter class is a paint device that paints on a printer.
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
This device represents a series of pages of printed output, and is This device represents a series of pages of printed output, and is
@ -2075,6 +2076,7 @@ QPrinter::PrintRange QPrinter::printRange() const
\reentrant \reentrant
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
\brief The QPrintEngine class defines an interface for how QPrinter \brief The QPrintEngine class defines an interface for how QPrinter
interacts with a given printing subsystem. interacts with a given printing subsystem.

View File

@ -45,6 +45,7 @@ QPrinterInfoPrivate QPrinterInfoPrivate::shared_null;
existing printers. existing printers.
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
Use the static functions to generate a list of QPrinterInfo Use the static functions to generate a list of QPrinterInfo
objects. Each QPrinterInfo object in the list represents a single objects. Each QPrinterInfo object in the list represents a single

View File

@ -457,6 +457,7 @@ void QPrintPreviewWidgetPrivate::setZoomFactor(qreal _zoomFactor)
previewing page layouts for printer output. previewing page layouts for printer output.
\ingroup printing \ingroup printing
\inmodule QtPrintSupport
QPrintPreviewDialog uses a QPrintPreviewWidget internally, and the QPrintPreviewDialog uses a QPrintPreviewWidget internally, and the
purpose of QPrintPreviewWidget is to make it possible to embed the purpose of QPrintPreviewWidget is to make it possible to embed the

View File

@ -157,6 +157,7 @@ public:
\brief The QAccessibleWidget class implements the QAccessibleInterface for QWidgets. \brief The QAccessibleWidget class implements the QAccessibleInterface for QWidgets.
\ingroup accessibility \ingroup accessibility
\inmodule QtWidgets
This class is convenient to use as a base class for custom This class is convenient to use as a base class for custom
implementations of QAccessibleInterfaces that provide information implementations of QAccessibleInterfaces that provide information

View File

@ -1683,6 +1683,7 @@ static const Qt::WindowFlags DefaultWindowFlags =
\brief The QColorDialog class provides a dialog widget for specifying colors. \brief The QColorDialog class provides a dialog widget for specifying colors.
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
The color dialog's function is to allow users to choose colors. The color dialog's function is to allow users to choose colors.
For example, you might use this in a drawing program to allow the For example, you might use this in a drawing program to allow the

View File

@ -87,7 +87,7 @@ QT_BEGIN_NAMESPACE
\ingroup dialog-classes \ingroup dialog-classes
\ingroup abstractwidgets \ingroup abstractwidgets
\inmodule QtWidgets
A dialog window is a top-level window mostly used for short-term A dialog window is a top-level window mostly used for short-term
tasks and brief communications with the user. QDialogs may be tasks and brief communications with the user. QDialogs may be

View File

@ -151,6 +151,7 @@ QSize QErrorMessageTextView::sizeHint() const
\brief The QErrorMessage class provides an error message display dialog. \brief The QErrorMessage class provides an error message display dialog.
\ingroup standard-dialog \ingroup standard-dialog
\inmodule QtWidgets
An error message widget consists of a text label and a checkbox. The An error message widget consists of a text label and a checkbox. The
checkbox lets the user control whether the same error message will be checkbox lets the user control whether the same error message will be

View File

@ -96,7 +96,7 @@ Q_WIDGETS_EXPORT _qt_filedialog_save_filename_hook qt_filedialog_save_filename_h
\class QFileDialog \class QFileDialog
\brief The QFileDialog class provides a dialog that allow users to select files or directories. \brief The QFileDialog class provides a dialog that allow users to select files or directories.
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
The QFileDialog class enables a user to traverse the file system in The QFileDialog class enables a user to traverse the file system in
order to select one or many files or a directory. order to select one or many files or a directory.

View File

@ -74,6 +74,7 @@ QT_BEGIN_NAMESPACE
\brief The QFileSystemModel class provides a data model for the local filesystem. \brief The QFileSystemModel class provides a data model for the local filesystem.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
This class provides access to the local filesystem, providing functions This class provides access to the local filesystem, providing functions
for renaming and removing files and directories, and for creating new for renaming and removing files and directories, and for creating new

View File

@ -117,6 +117,7 @@ static const Qt::WindowFlags DefaultWindowFlags =
/*! /*!
\class QFontDialog \class QFontDialog
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
\brief The QFontDialog class provides a dialog widget for selecting a font. \brief The QFontDialog class provides a dialog widget for selecting a font.

View File

@ -437,7 +437,7 @@ void QInputDialogPrivate::_q_currentRowChanged(const QModelIndex &newIndex,
\brief The QInputDialog class provides a simple convenience dialog to get a \brief The QInputDialog class provides a simple convenience dialog to get a
single value from the user. single value from the user.
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
The input value can be a string, a number or an item from a list. A label The input value can be a string, a number or an item from a list. A label
must be set to tell the user what they should enter. must be set to tell the user what they should enter.

View File

@ -492,7 +492,7 @@ void QMessageBoxPrivate::_q_buttonClicked(QAbstractButton *button)
the user or for asking the user a question and receiving an answer. the user or for asking the user a question and receiving an answer.
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
A message box displays a primary \l{QMessageBox::text}{text} to A message box displays a primary \l{QMessageBox::text}{text} to
alert the user to a situation, an \l{QMessageBox::informativeText} alert the user to a situation, an \l{QMessageBox::informativeText}

View File

@ -218,6 +218,7 @@ void QProgressDialogPrivate::_q_disconnectOnClose()
\class QProgressDialog \class QProgressDialog
\brief The QProgressDialog class provides feedback on the progress of a slow operation. \brief The QProgressDialog class provides feedback on the progress of a slow operation.
\ingroup standard-dialogs \ingroup standard-dialogs
\inmodule QtWidgets
A progress dialog is used to give the user an indication of how long A progress dialog is used to give the user an indication of how long

View File

@ -1785,6 +1785,8 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *)
\since 4.3 \since 4.3
\brief The QWizard class provides a framework for wizards. \brief The QWizard class provides a framework for wizards.
\inmodule QtWidgets
A wizard (also called an assistant on Mac OS X) is a special type A wizard (also called an assistant on Mac OS X) is a special type
of input dialog that consists of a sequence of pages. A wizard's of input dialog that consists of a sequence of pages. A wizard's
purpose is to guide the user through a process step by step. purpose is to guide the user through a process step by step.
@ -3340,6 +3342,8 @@ int QWizard::nextId() const
\since 4.3 \since 4.3
\brief The QWizardPage class is the base class for wizard pages. \brief The QWizardPage class is the base class for wizard pages.
\inmodule QtWidgets
QWizard represents a wizard. Each page is a QWizardPage. When QWizard represents a wizard. Each page is a QWizardPage. When
you create your own wizards, you can use QWizardPage directly, you create your own wizards, you can use QWizardPage directly,
or you can subclass it for more control. or you can subclass it for more control.

View File

@ -46,6 +46,7 @@
\since 4.6 \since 4.6
\ingroup multimedia \ingroup multimedia
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
Effects alter the appearance of elements by hooking into the rendering Effects alter the appearance of elements by hooking into the rendering
pipeline and operating between the source (e.g., a QGraphicsPixmapItem) pipeline and operating between the source (e.g., a QGraphicsPixmapItem)
@ -592,6 +593,7 @@ void QGraphicsEffect::sourceChanged(ChangeFlags flags)
\class QGraphicsColorizeEffect \class QGraphicsColorizeEffect
\brief The QGraphicsColorizeEffect class provides a colorize effect. \brief The QGraphicsColorizeEffect class provides a colorize effect.
\since 4.6 \since 4.6
\inmodule QtWidgets
A colorize effect renders the source with a tint of its color(). The color A colorize effect renders the source with a tint of its color(). The color
can be modified using the setColor() function. can be modified using the setColor() function.
@ -717,6 +719,7 @@ void QGraphicsColorizeEffect::draw(QPainter *painter)
\class QGraphicsBlurEffect \class QGraphicsBlurEffect
\brief The QGraphicsBlurEffect class provides a blur effect. \brief The QGraphicsBlurEffect class provides a blur effect.
\since 4.6 \since 4.6
\inmodule QtWidgets
A blur effect blurs the source. This effect is useful for reducing details, A blur effect blurs the source. This effect is useful for reducing details,
such as when the source loses focus and you want to draw attention to other such as when the source loses focus and you want to draw attention to other
@ -876,6 +879,7 @@ void QGraphicsBlurEffect::draw(QPainter *painter)
\class QGraphicsDropShadowEffect \class QGraphicsDropShadowEffect
\brief The QGraphicsDropShadowEffect class provides a drop shadow effect. \brief The QGraphicsDropShadowEffect class provides a drop shadow effect.
\since 4.6 \since 4.6
\inmodule QtWidgets
A drop shadow effect renders the source with a drop shadow. The color of A drop shadow effect renders the source with a drop shadow. The color of
the drop shadow can be modified using the setColor() function. The drop the drop shadow can be modified using the setColor() function. The drop
@ -1072,6 +1076,7 @@ void QGraphicsDropShadowEffect::draw(QPainter *painter)
\class QGraphicsOpacityEffect \class QGraphicsOpacityEffect
\brief The QGraphicsOpacityEffect class provides an opacity effect. \brief The QGraphicsOpacityEffect class provides an opacity effect.
\since 4.6 \since 4.6
\inmodule QtWidgets
An opacity effect renders the source with an opacity. This effect is useful An opacity effect renders the source with an opacity. This effect is useful
for making the source semi-transparent, similar to a fade-in/fade-out for making the source semi-transparent, similar to a fade-in/fade-out

View File

@ -47,6 +47,7 @@
\ingroup appearance \ingroup appearance
\ingroup geomanagement \ingroup geomanagement
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The anchor layout allows developers to specify how widgets should be placed relative to The anchor layout allows developers to specify how widgets should be placed relative to
each other, and to the layout itself. The specification is made by adding anchors to the each other, and to the layout itself. The specification is made by adding anchors to the
@ -125,6 +126,7 @@
\ingroup appearance \ingroup appearance
\ingroup geomanagement \ingroup geomanagement
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The graphics anchor provides an API that enables you to query and manipulate the The graphics anchor provides an API that enables you to query and manipulate the
properties an anchor has. When an anchor is added to the layout with properties an anchor has. When an anchor is added to the layout with

View File

@ -46,6 +46,7 @@
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The most common way to use QGraphicsGridLayout is to construct an object The most common way to use QGraphicsGridLayout is to construct an object
on the heap with no parent, add widgets and layouts by calling addItem(), on the heap with no parent, add widgets and layouts by calling addItem(),

View File

@ -46,6 +46,7 @@
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
It provides a light-weight foundation for writing your own custom items. It provides a light-weight foundation for writing your own custom items.
This includes defining the item's geometry, collision detection, its This includes defining the item's geometry, collision detection, its
@ -7621,6 +7622,7 @@ static void qt_graphicsItem_highlightSelected(
require signals, slots and properties. require signals, slots and properties.
\since 4.6 \since 4.6
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The class extends a QGraphicsItem with QObject's signal/slot and property mechanisms. The class extends a QGraphicsItem with QObject's signal/slot and property mechanisms.
It maps many of QGraphicsItem's basic setters and getters to properties and adds notification It maps many of QGraphicsItem's basic setters and getters to properties and adds notification
@ -8052,6 +8054,7 @@ void QGraphicsItemPrivate::resetHeight()
all path items. all path items.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
This class does not fully implement an item by itself; in particular, it This class does not fully implement an item by itself; in particular, it
does not implement boundingRect() and paint(), which are inherited by does not implement boundingRect() and paint(), which are inherited by
@ -8191,6 +8194,7 @@ QPainterPath QAbstractGraphicsShapeItem::opaqueArea() const
can add to a QGraphicsScene. can add to a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's path, pass a QPainterPath to QGraphicsPathItem's To set the item's path, pass a QPainterPath to QGraphicsPathItem's
constructor, or call the setPath() function. The path() function constructor, or call the setPath() function. The path() function
@ -8393,6 +8397,7 @@ QVariant QGraphicsPathItem::extension(const QVariant &variant) const
can add to a QGraphicsScene. can add to a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's rectangle, pass a QRectF to QGraphicsRectItem's To set the item's rectangle, pass a QRectF to QGraphicsRectItem's
constructor, or call the setRect() function. The rect() function constructor, or call the setRect() function. The rect() function
@ -8637,6 +8642,7 @@ QVariant QGraphicsRectItem::extension(const QVariant &variant) const
can add to a QGraphicsScene. can add to a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsEllipseItem respresents an ellipse with a fill and an outline, QGraphicsEllipseItem respresents an ellipse with a fill and an outline,
and you can also use it for ellipse segments (see startAngle(), and you can also use it for ellipse segments (see startAngle(),
@ -8953,6 +8959,7 @@ QVariant QGraphicsEllipseItem::extension(const QVariant &variant) const
can add to a QGraphicsScene. can add to a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's polygon, pass a QPolygonF to To set the item's polygon, pass a QPolygonF to
QGraphicsPolygonItem's constructor, or call the setPolygon() QGraphicsPolygonItem's constructor, or call the setPolygon()
@ -9186,6 +9193,7 @@ QVariant QGraphicsPolygonItem::extension(const QVariant &variant) const
QGraphicsScene. QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's line, pass a QLineF to QGraphicsLineItem's To set the item's line, pass a QLineF to QGraphicsLineItem's
constructor, or call the setLine() function. The line() function constructor, or call the setLine() function. The line() function
@ -9449,6 +9457,7 @@ QVariant QGraphicsLineItem::extension(const QVariant &variant) const
a QGraphicsScene. a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's pixmap, pass a QPixmap to QGraphicsPixmapItem's To set the item's pixmap, pass a QPixmap to QGraphicsPixmapItem's
constructor, or call the setPixmap() function. The pixmap() constructor, or call the setPixmap() function. The pixmap()
@ -9816,6 +9825,7 @@ QVariant QGraphicsPixmapItem::extension(const QVariant &variant) const
a QGraphicsScene to display formatted text. a QGraphicsScene to display formatted text.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
If you only need to show plain text in an item, consider using QGraphicsSimpleTextItem If you only need to show plain text in an item, consider using QGraphicsSimpleTextItem
instead. instead.
@ -10734,6 +10744,7 @@ void QGraphicsSimpleTextItemPrivate::updateBoundingRect()
that you can add to a QGraphicsScene. that you can add to a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
To set the item's text, you can either pass a QString to To set the item's text, you can either pass a QString to
QGraphicsSimpleTextItem's constructor, or call setText() to change the QGraphicsSimpleTextItem's constructor, or call setText() to change the
@ -10969,6 +10980,7 @@ QVariant QGraphicsSimpleTextItem::extension(const QVariant &variant) const
a group of items as a single item. a group of items as a single item.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
A QGraphicsItemGroup is a special type of compound item that A QGraphicsItemGroup is a special type of compound item that
treats itself and all its children as one item (i.e., all events treats itself and all its children as one item (i.e., all events

View File

@ -45,6 +45,7 @@
support for QGraphicsItem. support for QGraphicsItem.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
\deprecated \deprecated
The QGraphicsItemAnimation class animates a QGraphicsItem. You can The QGraphicsItemAnimation class animates a QGraphicsItem. You can

View File

@ -58,6 +58,7 @@ QT_BEGIN_NAMESPACE
in Graphics View. in Graphics View.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsLayout is an abstract class that defines a virtual API for QGraphicsLayout is an abstract class that defines a virtual API for
arranging QGraphicsWidget children and other QGraphicsLayoutItem objects arranging QGraphicsWidget children and other QGraphicsLayoutItem objects

View File

@ -320,6 +320,7 @@ bool QGraphicsLayoutItemPrivate::hasWidthForHeight() const
items to be managed by layouts. items to be managed by layouts.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsLayoutItem is an abstract class that defines a set of virtual QGraphicsLayoutItem is an abstract class that defines a set of virtual
functions describing sizes, size policies, and size hints for any object functions describing sizes, size policies, and size hints for any object

View File

@ -45,6 +45,7 @@
layout for managing widgets in Graphics View. layout for managing widgets in Graphics View.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The default orientation for a linear layout is Qt::Horizontal. You can The default orientation for a linear layout is Qt::Horizontal. You can
choose a vertical orientation either by calling setOrientation(), or by choose a vertical orientation either by calling setOrientation(), or by

View File

@ -71,6 +71,7 @@ QT_BEGIN_NAMESPACE
a QWidget in a QGraphicsScene. a QWidget in a QGraphicsScene.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsProxyWidget embeds QWidget-based widgets, for example, a QGraphicsProxyWidget embeds QWidget-based widgets, for example, a
QPushButton, QFontComboBox, or even QFileDialog, into QPushButton, QFontComboBox, or even QFileDialog, into

View File

@ -45,7 +45,7 @@
number of 2D graphical items. number of 2D graphical items.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
The class serves as a container for QGraphicsItems. It is used together The class serves as a container for QGraphicsItems. It is used together
with QGraphicsView for visualizing graphical items, such as lines, with QGraphicsView for visualizing graphical items, such as lines,

View File

@ -45,6 +45,7 @@
graphics view related events. graphics view related events.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
When a QGraphicsView receives Qt mouse, keyboard, and drag and When a QGraphicsView receives Qt mouse, keyboard, and drag and
drop events (QMouseEvent, QKeyEvent, QDragEvent, etc.), it drop events (QMouseEvent, QKeyEvent, QDragEvent, etc.), it
@ -86,6 +87,7 @@
in the graphics view framework. in the graphics view framework.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
When a QGraphicsView receives a QMouseEvent, it translates it to a When a QGraphicsView receives a QMouseEvent, it translates it to a
QGraphicsSceneMouseEvent. The event is then forwarded to the QGraphicsSceneMouseEvent. The event is then forwarded to the
@ -112,6 +114,7 @@
graphics view framework. graphics view framework.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
\l{QWheelEvent}{QWheelEvent}s received by a QGraphicsView are translated \l{QWheelEvent}{QWheelEvent}s received by a QGraphicsView are translated
into QGraphicsSceneWheelEvents; it translates the QWheelEvent::globalPos() into QGraphicsSceneWheelEvents; it translates the QWheelEvent::globalPos()
@ -128,6 +131,7 @@
menu events in the graphics view framework. menu events in the graphics view framework.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
A QContextMenuEvent received by a QGraphicsView is translated A QContextMenuEvent received by a QGraphicsView is translated
into a QGraphicsSceneContextMenuEvent. The into a QGraphicsSceneContextMenuEvent. The
@ -159,6 +163,7 @@
in the graphics view framework. in the graphics view framework.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
When a QGraphicsView receives a QHoverEvent event, it translates When a QGraphicsView receives a QHoverEvent event, it translates
it into QGraphicsSceneHoverEvent. The event is then forwarded to it into QGraphicsSceneHoverEvent. The event is then forwarded to
@ -174,6 +179,7 @@
tooltip is requested. tooltip is requested.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
When a QGraphicsView receives a QEvent of type When a QGraphicsView receives a QEvent of type
QEvent::ToolTip, it creates a QGraphicsSceneHelpEvent, which is QEvent::ToolTip, it creates a QGraphicsSceneHelpEvent, which is
@ -198,6 +204,7 @@
drag and drop in the graphics view framework. drag and drop in the graphics view framework.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsView inherits the drag and drop functionality provided QGraphicsView inherits the drag and drop functionality provided
by QWidget. When it receives a drag and drop event, it translates by QWidget. When it receives a drag and drop event, it translates
@ -222,6 +229,7 @@
resizing in the graphics view framework. resizing in the graphics view framework.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
A QGraphicsWidget sends itself a QGraphicsSceneResizeEvent immediately A QGraphicsWidget sends itself a QGraphicsSceneResizeEvent immediately
when its geometry changes. when its geometry changes.
@ -238,6 +246,7 @@
moving in the graphics view framework. moving in the graphics view framework.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
A QGraphicsWidget sends itself a QGraphicsSceneMoveEvent immediately when A QGraphicsWidget sends itself a QGraphicsSceneMoveEvent immediately when
its local position changes. The delivery is implemented as part of its local position changes. The delivery is implemented as part of

View File

@ -45,6 +45,7 @@
advanced transformations on QGraphicsItems. advanced transformations on QGraphicsItems.
\since 4.6 \since 4.6
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
As an alternative to QGraphicsItem::transform, QGraphicsTransform lets you As an alternative to QGraphicsItem::transform, QGraphicsTransform lets you
create and control advanced transformations that can be configured create and control advanced transformations that can be configured
@ -177,6 +178,7 @@ void QGraphicsTransform::update()
\class QGraphicsScale \class QGraphicsScale
\brief The QGraphicsScale class provides a scale transformation. \brief The QGraphicsScale class provides a scale transformation.
\since 4.6 \since 4.6
\inmodule QtWidgets
QGraphicsScene provides certain parameters to help control how the scale QGraphicsScene provides certain parameters to help control how the scale
should be applied. should be applied.
@ -381,6 +383,7 @@ void QGraphicsScale::applyTo(QMatrix4x4 *matrix) const
\brief The QGraphicsRotation class provides a rotation transformation around \brief The QGraphicsRotation class provides a rotation transformation around
a given axis. a given axis.
\since 4.6 \since 4.6
\inmodule QtWidgets
You can provide the desired axis by assigning a QVector3D to the axis property You can provide the desired axis by assigning a QVector3D to the axis property
or by passing a member if Qt::Axis to the setAxis convenience function. or by passing a member if Qt::Axis to the setAxis convenience function.

View File

@ -49,7 +49,7 @@ static const int QGRAPHICSVIEW_PREALLOC_STYLE_OPTIONS = 503; // largest prime <
contents of a QGraphicsScene. contents of a QGraphicsScene.
\since 4.2 \since 4.2
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsView visualizes the contents of a QGraphicsScene in a scrollable QGraphicsView visualizes the contents of a QGraphicsScene in a scrollable
viewport. To create a scene with geometrical items, see QGraphicsScene's viewport. To create a scene with geometrical items, see QGraphicsScene's

View File

@ -75,6 +75,7 @@ QT_BEGIN_NAMESPACE
items in a QGraphicsScene. items in a QGraphicsScene.
\since 4.4 \since 4.4
\ingroup graphicsview-api \ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsWidget is an extended base item that provides extra functionality QGraphicsWidget is an extended base item that provides extra functionality
over QGraphicsItem. It is similar to QWidget in many ways: over QGraphicsItem. It is similar to QWidget in many ways:

View File

@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE
data items from a model. data items from a model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QAbstractItemDelegate provides the interface and common functionality A QAbstractItemDelegate provides the interface and common functionality
for delegates in the model/view architecture. Delegates display for delegates in the model/view architecture. Delegates display

View File

@ -237,7 +237,7 @@ void QAbstractItemViewPrivate::_q_scrollerStateChanged()
item view classes. item view classes.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QAbstractItemView class is the base class for every standard view QAbstractItemView class is the base class for every standard view
that uses a QAbstractItemModel. QAbstractItemView is an abstract that uses a QAbstractItemModel. QAbstractItemView is an abstract

View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\brief The QAbstractProxyModel class provides a base class for proxy item \brief The QAbstractProxyModel class provides a base class for proxy item
models that can do sorting, filtering or other data processing tasks. models that can do sorting, filtering or other data processing tasks.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
This class defines the standard interface that proxy models must use to be This class defines the standard interface that proxy models must use to be
able to interoperate correctly with other model/view components. It is not able to interoperate correctly with other model/view components. It is not

View File

@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE
\brief The QColumnView class provides a model/view implementation of a column view. \brief The QColumnView class provides a model/view implementation of a column view.
\ingroup model-view \ingroup model-view
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
QColumnView displays a model in a number of QListViews, one for each QColumnView displays a model in a number of QListViews, one for each
hierarchy in the tree. This is sometimes referred to as a cascading list. hierarchy in the tree. This is sometimes referred to as a cascading list.

View File

@ -258,6 +258,7 @@ void QDataWidgetMapperPrivate::_q_modelDestroyed()
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
QDataWidgetMapper can be used to create data-aware widgets by mapping QDataWidgetMapper can be used to create data-aware widgets by mapping
them to sections of an item model. A section is a column of a model them to sections of an item model. A section is a column of a model

View File

@ -189,6 +189,7 @@ void QDirModelPrivate::invalidate()
\brief The QDirModel class provides a data model for the local filesystem. \brief The QDirModel class provides a data model for the local filesystem.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
The usage of QDirModel is not recommended anymore. The The usage of QDirModel is not recommended anymore. The
QFileSystemModel class is a more performant alternative. QFileSystemModel class is a more performant alternative.

View File

@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QFileIconProvider \class QFileIconProvider
\inmodule QtWidgets
\brief The QFileIconProvider class provides file icons for the QDirModel and the QFileSystemModel classes. \brief The QFileIconProvider class provides file icons for the QDirModel and the QFileSystemModel classes.
*/ */

View File

@ -88,7 +88,7 @@ QDataStream &operator>>(QDataStream &in, QHeaderViewPrivate::SectionSpan &span)
item views. item views.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QHeaderView displays the headers used in item views such as the A QHeaderView displays the headers used in item views such as the
QTableView and QTreeView classes. It takes the place of Qt3's \c QHeader QTableView and QTreeView classes. It takes the place of Qt3's \c QHeader

View File

@ -94,6 +94,7 @@ class QIdentityProxyModelPrivate : public QAbstractProxyModelPrivate
\brief The QIdentityProxyModel class proxies its source model unmodified \brief The QIdentityProxyModel class proxies its source model unmodified
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QIdentityProxyModel can be used to forward the structure of a source model exactly, with no sorting, filtering or other transformation. QIdentityProxyModel can be used to forward the structure of a source model exactly, with no sorting, filtering or other transformation.
This is similar in concept to an identity matrix where A.I = A. This is similar in concept to an identity matrix where A.I = A.

View File

@ -186,7 +186,7 @@ QSizeF QItemDelegatePrivate::doTextLayout(int lineWidth) const
data items from a model. data items from a model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QItemDelegate can be used to provide custom display features and editor QItemDelegate can be used to provide custom display features and editor
widgets for item views based on QAbstractItemView subclasses. Using a widgets for item views based on QAbstractItemView subclasses. Using a

View File

@ -79,6 +79,7 @@ public:
in views and delegates. in views and delegates.
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
When editing data in an item view, editors are created and When editing data in an item view, editors are created and
displayed by a delegate. QItemDelegate, which is the delegate by displayed by a delegate. QItemDelegate, which is the delegate by
@ -324,6 +325,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory)
must be subclassed when implementing new item editor creators. must be subclassed when implementing new item editor creators.
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QItemEditorCreatorBase objects are specialized widget factories that QItemEditorCreatorBase objects are specialized widget factories that
provide editor widgets for one particular QVariant data type. They provide editor widgets for one particular QVariant data type. They
@ -396,6 +398,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory)
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QItemEditorCreator is a convenience template class. It uses QItemEditorCreator is a convenience template class. It uses
the template class to create editors for QItemEditorFactory. the template class to create editors for QItemEditorFactory.
@ -446,6 +449,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory)
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
This convenience template class makes it possible to register widgets without This convenience template class makes it possible to register widgets without
having to subclass QItemEditorCreatorBase. having to subclass QItemEditorCreatorBase.

View File

@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE
range of selected items in a model. range of selected items in a model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QItemSelectionRange contains information about a range of A QItemSelectionRange contains information about a range of
selected items in a model. A range of items is a contiguous array selected items in a model. A range of items is a contiguous array
@ -330,6 +331,7 @@ QModelIndexList QItemSelectionRange::indexes() const
\brief The QItemSelection class manages information about selected items in a model. \brief The QItemSelection class manages information about selected items in a model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QItemSelection describes the items in a model that have been A QItemSelection describes the items in a model that have been
selected by the user. A QItemSelection is basically a list of selected by the user. A QItemSelection is basically a list of
@ -911,6 +913,7 @@ void QItemSelectionModelPrivate::_q_layoutChanged()
\brief The QItemSelectionModel class keeps track of a view's selected items. \brief The QItemSelectionModel class keeps track of a view's selected items.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QItemSelectionModel keeps track of the selected items in a view, or A QItemSelectionModel keeps track of the selected items in a view, or
in several views onto the same model. It also keeps track of the in several views onto the same model. It also keeps track of the

View File

@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
\ingroup model-view \ingroup model-view
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
A QListView presents items stored in a model, either as a simple A QListView presents items stored in a model, either as a simple
non-hierarchical list, or as a collection of icons. This class is used non-hierarchical list, or as a collection of icons. This class is used

View File

@ -461,6 +461,7 @@ Qt::DropActions QListModel::supportedDropActions() const
QListWidget item view class. QListWidget item view class.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
A QListWidgetItem represents a single item in a QListWidget. Each item can A QListWidgetItem represents a single item in a QListWidget. Each item can
hold several pieces of information, and will display them appropriately. hold several pieces of information, and will display them appropriately.
@ -1140,7 +1141,7 @@ void QListWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft,
\brief The QListWidget class provides an item-based list widget. \brief The QListWidget class provides an item-based list widget.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QListWidget is a convenience class that provides a list view similar to the QListWidget is a convenience class that provides a list view similar to the
one supplied by QListView, but with a classic item-based interface for one supplied by QListView, but with a classic item-based interface for

View File

@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
passed between another model and a view. passed between another model and a view.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
If you want to do filtering and sorting, see QSortFilterProxyModel. If you want to do filtering and sorting, see QSortFilterProxyModel.

View File

@ -1360,6 +1360,7 @@ void QSortFilterProxyModelPrivate::_q_sourceColumnsRemoved(
filtering data passed between another model and a view. filtering data passed between another model and a view.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QSortFilterProxyModel can be used for sorting items, filtering out items, QSortFilterProxyModel can be used for sorting items, filtering out items,
or both. The model transforms the structure of a source model by mapping or both. The model transforms the structure of a source model by mapping

View File

@ -614,6 +614,7 @@ void QStandardItemModelPrivate::columnsRemoved(QStandardItem *parent,
QStandardItemModel class. QStandardItemModel class.
\since 4.2 \since 4.2
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
Items usually contain text, icons, or checkboxes. Items usually contain text, icons, or checkboxes.
@ -1951,6 +1952,7 @@ QDataStream &operator<<(QDataStream &out, const QStandardItem &item)
\class QStandardItemModel \class QStandardItemModel
\brief The QStandardItemModel class provides a generic model for storing custom data. \brief The QStandardItemModel class provides a generic model for storing custom data.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QStandardItemModel can be used as a repository for standard Qt QStandardItemModel can be used as a repository for standard Qt
data types. It is one of the \l {Model/View Classes} and is part data types. It is one of the \l {Model/View Classes} and is part

View File

@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE
\brief The QStringListModel class provides a model that supplies strings to views. \brief The QStringListModel class provides a model that supplies strings to views.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
QStringListModel is an editable model that can be used for simple QStringListModel is an editable model that can be used for simple
cases where you need to display a number of strings in a view cases where you need to display a number of strings in a view

View File

@ -112,6 +112,7 @@ public:
data items from a model. data items from a model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
\since 4.4 \since 4.4

View File

@ -937,7 +937,7 @@ void QTableViewPrivate::drawCell(QPainter *painter, const QStyleOptionViewItemV4
\ingroup model-view \ingroup model-view
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
A QTableView implements a table view that displays items from a A QTableView implements a table view that displays items from a
model. This class is used to provide standard tables that were model. This class is used to provide standard tables that were

View File

@ -857,6 +857,7 @@ Qt::DropActions QTableModel::supportedDropActions() const
selection in a model without using model indexes and a selection model. selection in a model without using model indexes and a selection model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
The QTableWidgetSelectionRange class stores the top left and bottom The QTableWidgetSelectionRange class stores the top left and bottom
right rows and columns of a selection range in a table. The right rows and columns of a selection range in a table. The
@ -965,6 +966,7 @@ QTableWidgetSelectionRange::~QTableWidgetSelectionRange()
QTableWidget class. QTableWidget class.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
Table items are used to hold pieces of information for table widgets. Table items are used to hold pieces of information for table widgets.
Items usually contain text, icons, or checkboxes Items usually contain text, icons, or checkboxes
@ -1490,7 +1492,7 @@ QTableWidgetItem &QTableWidgetItem::operator=(const QTableWidgetItem &other)
\brief The QTableWidget class provides an item-based table view with a default model. \brief The QTableWidget class provides an item-based table view with a default model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
Table widgets provide standard table display facilities for applications. Table widgets provide standard table display facilities for applications.
The items in a QTableWidget are provided by QTableWidgetItem. The items in a QTableWidget are provided by QTableWidgetItem.

View File

@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE
\ingroup model-view \ingroup model-view
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
A QTreeView implements a tree representation of items from a A QTreeView implements a tree representation of items from a
model. This class is used to provide standard hierarchical lists that model. This class is used to provide standard hierarchical lists that

View File

@ -75,6 +75,7 @@ public:
\brief The QTreeModel class manages the items stored in a tree view. \brief The QTreeModel class manages the items stored in a tree view.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
*/ */
@ -883,6 +884,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev)
QTreeWidget convenience class. QTreeWidget convenience class.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
Tree widget items are used to hold rows of information for tree widgets. Tree widget items are used to hold rows of information for tree widgets.
Rows usually contain several columns of data, each of which can contain Rows usually contain several columns of data, each of which can contain
@ -2337,7 +2339,7 @@ void QTreeWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft,
tree model. tree model.
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
The QTreeWidget class is a convenience class that provides a standard The QTreeWidget class is a convenience class that provides a standard
tree widget with a classic item-based interface similar to that used by tree widget with a classic item-based interface similar to that used by

View File

@ -51,6 +51,8 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QTreeWidgetItemIterator \class QTreeWidgetItemIterator
\ingroup model-view \ingroup model-view
\inmodule QtWidgets
\brief The QTreeWidgetItemIterator class provides a way to iterate over the \brief The QTreeWidgetItemIterator class provides a way to iterate over the
items in a QTreeWidget instance. items in a QTreeWidget instance.

View File

@ -196,7 +196,7 @@ void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map)
action that can be inserted into widgets. action that can be inserted into widgets.
\ingroup mainwindow-classes \ingroup mainwindow-classes
\inmodule QtWidgets
\omit \omit
* parent and widget are different * parent and widget are different

View File

@ -106,6 +106,7 @@ void QActionGroupPrivate::_q_actionHovered()
\brief The QActionGroup class groups actions together. \brief The QActionGroup class groups actions together.
\ingroup mainwindow-classes \ingroup mainwindow-classes
\inmodule QtWidgets
In some situations it is useful to group QAction objects together. In some situations it is useful to group QAction objects together.
For example, if you have a \gui{Left Align} action, a \gui{Right For example, if you have a \gui{Left Align} action, a \gui{Right

View File

@ -205,6 +205,8 @@ QApplicationPrivate::~QApplicationPrivate()
\brief The QApplication class manages the GUI application's control \brief The QApplication class manages the GUI application's control
flow and main settings. flow and main settings.
\inmodule QtWidgets
QApplication contains the main event loop, where all events from the window QApplication contains the main event loop, where all events from the window
system and other sources are processed and dispatched. It also handles the system and other sources are processed and dispatched. It also handles the
application's initialization, finalization, and provides session application's initialization, finalization, and provides session
@ -4198,6 +4200,8 @@ bool QApplicationPrivate::notify_helper(QObject *receiver, QEvent * e)
\class QSessionManager \class QSessionManager
\brief The QSessionManager class provides access to the session manager. \brief The QSessionManager class provides access to the session manager.
\inmodule QtWidgets
A session manager in a desktop environment (in which Qt GUI applications A session manager in a desktop environment (in which Qt GUI applications
live) keeps track of a session, which is a group of running applications, live) keeps track of a session, which is a group of running applications,
each of which has a particular state. The state of an application contains each of which has a particular state. The state of an application contains

View File

@ -452,6 +452,7 @@ void QBoxLayoutPrivate::calcHfw(int w)
vertically. vertically.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
QBoxLayout takes the space it gets (from its parent layout or from QBoxLayout takes the space it gets (from its parent layout or from
the parentWidget()), divides it up into a row of boxes, and makes the parentWidget()), divides it up into a row of boxes, and makes
@ -1231,6 +1232,7 @@ QBoxLayout::Direction QBoxLayout::direction() const
\brief The QHBoxLayout class lines up widgets horizontally. \brief The QHBoxLayout class lines up widgets horizontally.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
This class is used to construct horizontal box layout objects. See This class is used to construct horizontal box layout objects. See
QBoxLayout for details. QBoxLayout for details.
@ -1293,6 +1295,7 @@ QHBoxLayout::~QHBoxLayout()
\brief The QVBoxLayout class lines up widgets vertically. \brief The QVBoxLayout class lines up widgets vertically.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
This class is used to construct vertical box layout objects. See This class is used to construct vertical box layout objects. See
QBoxLayout for details. QBoxLayout for details.

View File

@ -31,6 +31,7 @@
\ingroup advanced \ingroup advanced
\ingroup desktop \ingroup desktop
\inmodule QtWidgets
Systems with more than one graphics card and monitor can manage the Systems with more than one graphics card and monitor can manage the
physical screen space available either as multiple desktops, or as a physical screen space available either as multiple desktops, or as a

View File

@ -1007,7 +1007,7 @@ QStyle* QFormLayoutPrivate::getStyle() const
\brief The QFormLayout class manages forms of input widgets and their associated labels. \brief The QFormLayout class manages forms of input widgets and their associated labels.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
QFormLayout is a convenience layout class that lays out its QFormLayout is a convenience layout class that lays out its
children in a two-column form. The left column consists of labels children in a two-column form. The left column consists of labels

View File

@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
\class QGesture \class QGesture
\since 4.6 \since 4.6
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
\brief The QGesture class represents a gesture, containing properties that \brief The QGesture class represents a gesture, containing properties that
describe the corresponding user input. describe the corresponding user input.
@ -220,6 +221,7 @@ QGesture::GestureCancelPolicy QGesture::gestureCancelPolicy() const
\since 4.6 \since 4.6
\brief The QPanGesture class describes a panning gesture made by the user. \brief The QPanGesture class describes a panning gesture made by the user.
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
\image pangesture.png \image pangesture.png
@ -336,6 +338,7 @@ void QPanGesture::setAcceleration(qreal value)
\brief The QPinchGesture class describes a pinch gesture made by the user. \brief The QPinchGesture class describes a pinch gesture made by the user.
\ingroup touch \ingroup touch
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
A pinch gesture is a form of touch user input in which the user typically A pinch gesture is a form of touch user input in which the user typically
touches two points on the input device with a thumb and finger, before moving touches two points on the input device with a thumb and finger, before moving
@ -600,6 +603,7 @@ void QPinchGesture::setRotationAngle(qreal value)
\since 4.6 \since 4.6
\brief The QSwipeGesture class describes a swipe gesture made by the user. \brief The QSwipeGesture class describes a swipe gesture made by the user.
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
\image swipegesture.png \image swipegesture.png
@ -706,6 +710,7 @@ void QSwipeGesture::setSwipeAngle(qreal value)
\since 4.6 \since 4.6
\brief The QTapGesture class describes a tap gesture made by the user. \brief The QTapGesture class describes a tap gesture made by the user.
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
For an overview of gesture handling in Qt and information on using gestures For an overview of gesture handling in Qt and information on using gestures
in your applications, see the \l{Gestures Programming} document. in your applications, see the \l{Gestures Programming} document.
@ -742,6 +747,7 @@ void QTapGesture::setPosition(const QPointF &value)
\brief The QTapAndHoldGesture class describes a tap-and-hold (aka LongTap) \brief The QTapAndHoldGesture class describes a tap-and-hold (aka LongTap)
gesture made by the user. gesture made by the user.
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
For an overview of gesture handling in Qt and information on using gestures For an overview of gesture handling in Qt and information on using gestures
in your applications, see the \l{Gestures Programming} document. in your applications, see the \l{Gestures Programming} document.
@ -807,6 +813,7 @@ int QTapAndHoldGesturePrivate::Timeout = 700; // in ms
\since 4.6 \since 4.6
\ingroup events \ingroup events
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
\brief The QGestureEvent class provides the description of triggered gestures. \brief The QGestureEvent class provides the description of triggered gestures.

View File

@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\brief The QGestureRecognizer class provides the infrastructure for gesture recognition. \brief The QGestureRecognizer class provides the infrastructure for gesture recognition.
\ingroup gestures \ingroup gestures
\inmodule QtWidgets
Gesture recognizers are responsible for creating and managing QGesture objects and Gesture recognizers are responsible for creating and managing QGesture objects and
monitoring input events sent to QWidget and QGraphicsObject subclasses. monitoring input events sent to QWidget and QGraphicsObject subclasses.

View File

@ -980,7 +980,7 @@ QRect QGridLayoutPrivate::cellRect(int row, int col) const
\brief The QGridLayout class lays out widgets in a grid. \brief The QGridLayout class lays out widgets in a grid.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
QGridLayout takes the space made available to it (by its parent QGridLayout takes the space made available to it (by its parent
layout or by the parentWidget()), divides it up into rows and layout or by the parentWidget()), divides it up into rows and

View File

@ -116,8 +116,8 @@ QGuiPlatformPlugin *qt_guiPlatformPlugin()
QGuiPlatformPlugin can be used to integrate Qt applications in a platform built on top of Qt. QGuiPlatformPlugin can be used to integrate Qt applications in a platform built on top of Qt.
The application developer should not know or use the plugin, it is only used by Qt internaly. The application developer should not know or use the plugin, it is only used by Qt internaly.
But full platform that are built on top of Qt may provide a plugin so 3rd party Qt application But full platforms that are built on top of Qt may provide a plugin so 3rd party Qt applications
running in the platform are integrated. running on the platform are integrated.
*/ */
/* /*

View File

@ -467,7 +467,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loaderV2,
\ingroup painting \ingroup painting
\ingroup shared \ingroup shared
\inmodule QtWidgets
A QIcon can generate smaller, larger, active, and disabled pixmaps A QIcon can generate smaller, larger, active, and disabled pixmaps
from the set of pixmaps it is given. Such pixmaps are used by Qt from the set of pixmaps it is given. Such pixmaps are used by Qt

View File

@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE
\brief The QIconEngine class provides an abstract base class for QIcon renderers. \brief The QIconEngine class provides an abstract base class for QIcon renderers.
\ingroup painting \ingroup painting
\inmodule QtWidgets
\bold {Use QIconEngineV2 instead.} \bold {Use QIconEngineV2 instead.}
@ -145,6 +146,8 @@ void QIconEngine::addFile(const QString &/*fileName*/, const QSize &/*size*/, QI
\brief The QIconEngineV2 class provides an abstract base class for QIcon renderers. \brief The QIconEngineV2 class provides an abstract base class for QIcon renderers.
\ingroup painting \ingroup painting
\inmodule QtWidgets
\since 4.3 \since 4.3
An icon engine renders \l{QIcon}s. With icon engines, you can An icon engine renders \l{QIcon}s. With icon engines, you can
@ -194,6 +197,8 @@ void QIconEngine::addFile(const QString &/*fileName*/, const QSize &/*size*/, QI
\class QIconEngineV2::AvailableSizesArgument \class QIconEngineV2::AvailableSizesArgument
\since 4.5 \since 4.5
\inmodule QtWidgets
This struct represents arguments to virtual_hook() function when This struct represents arguments to virtual_hook() function when
\a id parameter is QIconEngineV2::AvailableSizesHook. \a id parameter is QIconEngineV2::AvailableSizesHook.

View File

@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE
\brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins. \brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins.
\ingroup plugins \ingroup plugins
\inmodule QtWidgets
\bold {Use QIconEnginePluginV2 instead.} \bold {Use QIconEnginePluginV2 instead.}
@ -109,6 +110,8 @@ QIconEnginePlugin::~QIconEnginePlugin()
\brief The QIconEnginePluginV2 class provides an abstract base for custom QIconEngineV2 plugins. \brief The QIconEnginePluginV2 class provides an abstract base for custom QIconEngineV2 plugins.
\ingroup plugins \ingroup plugins
\inmodule QtWidgets
\since 4.3 \since 4.3
Icon engine plugins produces \l{QIconEngine}s for \l{QIcon}s; an Icon engine plugins produces \l{QIconEngine}s for \l{QIcon}s; an

View File

@ -78,6 +78,7 @@ QT_BEGIN_NAMESPACE
\brief The QInputContext class abstracts the input method dependent data and composing state. \brief The QInputContext class abstracts the input method dependent data and composing state.
\ingroup i18n \ingroup i18n
\inmodule QtWidgets
An input method is responsible for inputting complex text that cannot An input method is responsible for inputting complex text that cannot
be inputted via simple keymap. It converts a sequence of input be inputted via simple keymap. It converts a sequence of input

View File

@ -76,6 +76,7 @@ static int menuBarHeightForWidth(QWidget *menubar, int w)
\brief The QLayout class is the base class of geometry managers. \brief The QLayout class is the base class of geometry managers.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
This is an abstract base class inherited by the concrete classes This is an abstract base class inherited by the concrete classes
QBoxLayout, QGridLayout, QFormLayout, and QStackedLayout. QBoxLayout, QGridLayout, QFormLayout, and QStackedLayout.

View File

@ -88,6 +88,7 @@ QSizePolicy::operator QVariant() const
QLayout manipulates. QLayout manipulates.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
This is used by custom layouts. This is used by custom layouts.
@ -118,6 +119,8 @@ QSizePolicy::operator QVariant() const
\ingroup geomanagement \ingroup geomanagement
\brief The QSpacerItem class provides blank space in a layout. \brief The QSpacerItem class provides blank space in a layout.
\inmodule QtWidgets
Normally, you don't need to use this class directly. Qt's Normally, you don't need to use this class directly. Qt's
built-in layout managers provide the following functions for built-in layout managers provide the following functions for
manipulating empty space in layouts: manipulating empty space in layouts:
@ -145,6 +148,8 @@ QSizePolicy::operator QVariant() const
\ingroup geomanagement \ingroup geomanagement
\brief The QWidgetItem class is a layout item that represents a widget. \brief The QWidgetItem class is a layout item that represents a widget.
\inmodule QtWidgets
Normally, you don't need to use this class directly. Qt's Normally, you don't need to use this class directly. Qt's
built-in layout managers provide the following functions for built-in layout managers provide the following functions for
manipulating widgets in layouts: manipulating widgets in layouts:

View File

@ -31,6 +31,7 @@
and vertical resizing policy. and vertical resizing policy.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
The size policy of a widget is an expression of its willingness to The size policy of a widget is an expression of its willingness to
be resized in various ways, and affects how the widget is treated be resized in various ways, and affects how the widget is treated

View File

@ -106,7 +106,7 @@ public:
\brief The QSound class provides access to the platform audio facilities. \brief The QSound class provides access to the platform audio facilities.
\ingroup multimedia \ingroup multimedia
\inmodule QtWidgets
Qt provides the most commonly required audio operation in GUI Qt provides the most commonly required audio operation in GUI
applications: asynchronously playing a sound file. This is most applications: asynchronously playing a sound file. This is most

View File

@ -65,6 +65,7 @@ public:
only one widget is visible at a time. only one widget is visible at a time.
\ingroup geomanagement \ingroup geomanagement
\inmodule QtWidgets
QStackedLayout can be used to create a user interface similar to QStackedLayout can be used to create a user interface similar to
the one provided by QTabWidget. There is also a convenience the one provided by QTabWidget. There is also a convenience

View File

@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE
widget. widget.
\ingroup helpsystem \ingroup helpsystem
\inmodule QtWidgets
The tip is a short piece of text reminding the user of the The tip is a short piece of text reminding the user of the
widget's function. It is drawn immediately below the given widget's function. It is drawn immediately below the given

View File

@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE
widget, i.e. answering the question "What's This?". widget, i.e. answering the question "What's This?".
\ingroup helpsystem \ingroup helpsystem
\inmodule QtWidgets
"What's This?" help is part of an application's online help "What's This?" help is part of an application's online help
system, and provides users with information about the system, and provides users with information about the

View File

@ -511,6 +511,7 @@ void QWidget::setAutoFillBackground(bool enabled)
\brief The QWidget class is the base class of all user interface objects. \brief The QWidget class is the base class of all user interface objects.
\ingroup basicwidgets \ingroup basicwidgets
\inmodule QtWidgets
The widget is the atom of the user interface: it receives mouse, keyboard 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 and other events from the window system, and paints a representation of

View File

@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE
as toolbars. as toolbars.
\ingroup mainwindow-classes \ingroup mainwindow-classes
\inmodule QtWidgets
Most actions in an application are represented as items in menus or Most actions in an application are represented as items in menus or
buttons in toolbars. However sometimes more complex widgets are buttons in toolbars. However sometimes more complex widgets are

View File

@ -134,6 +134,7 @@ CFStringRef qt_mac_mime_typeUTI = CFSTR("com.pasteboard.trolltech.marker");
\since 4.2 \since 4.2
\ingroup draganddrop \ingroup draganddrop
\inmodule QtWidgets
Qt's drag and drop and clipboard facilities use the MIME Qt's drag and drop and clipboard facilities use the MIME
standard. On X11, this maps trivially to the Xdnd protocol. On standard. On X11, this maps trivially to the Xdnd protocol. On

View File

@ -220,6 +220,7 @@ Q_GLOBAL_STATIC(QWindowsMimeList, theMimeList);
\class QWindowsMime \class QWindowsMime
\brief The QWindowsMime class maps open-standard MIME to Window Clipboard formats. \brief The QWindowsMime class maps open-standard MIME to Window Clipboard formats.
\ingroup draganddrop \ingroup draganddrop
\inmodule QtWidgets
Qt's drag-and-drop and clipboard facilities use the MIME standard. Qt's drag-and-drop and clipboard facilities use the MIME standard.
On X11, this maps trivially to the Xdnd protocol, but on Windows On X11, this maps trivially to the Xdnd protocol, but on Windows

View File

@ -77,6 +77,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QX11EmbedWidget \class QX11EmbedWidget
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
\brief The QX11EmbedWidget class provides an XEmbed client widget. \brief The QX11EmbedWidget class provides an XEmbed client widget.
@ -132,6 +133,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QX11EmbedContainer \class QX11EmbedContainer
\ingroup advanced \ingroup advanced
\inmodule QtWidgets
\brief The QX11EmbedContainer class provides an XEmbed container \brief The QX11EmbedContainer class provides an XEmbed container
widget. widget.

View File

@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE
configuration. configuration.
\ingroup shared \ingroup shared
\inmodule QtWidgets
The class provides two APIs: a set of non-static functions that The class provides two APIs: a set of non-static functions that
provide information about a specific widget or pixmap, and a set provide information about a specific widget or pixmap, and a set

View File

@ -67,6 +67,8 @@ CApaApplication *newS60Application()
\since 4.6 \since 4.6
\brief The QS60MainApplication class provides support for migration from S60. \brief The QS60MainApplication class provides support for migration from S60.
\inmodule QtWidgets
\warning This class is provided only to get access to S60 specific \warning This class is provided only to get access to S60 specific
functionality in the application framework classes. It is not functionality in the application framework classes. It is not
portable. We strongly recommend against using it in new applications. portable. We strongly recommend against using it in new applications.

View File

@ -71,6 +71,8 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\brief The QS60MainAppUi class is a helper class for S60 migration. \brief The QS60MainAppUi class is a helper class for S60 migration.
\inmodule QtWidgets
\warning This class is provided only to get access to S60 specific \warning This class is provided only to get access to S60 specific
functionality in the application framework classes. It is not functionality in the application framework classes. It is not
portable. We strongly recommend against using it in new applications. portable. We strongly recommend against using it in new applications.

View File

@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\brief The QS60MainDocument class is a helper class for S60 migration. \brief The QS60MainDocument class is a helper class for S60 migration.
\inmodule QtWidgets
\warning This class is provided only to get access to S60 specific \warning This class is provided only to get access to S60 specific
functionality in the application framework classes. It is not functionality in the application framework classes. It is not
portable. We strongly recommend against using it in new applications. portable. We strongly recommend against using it in new applications.

View File

@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\ingroup statemachine \ingroup statemachine
\inmodule QtWidgets
QKeyEventTransition is part of \l{The State Machine Framework}. QKeyEventTransition is part of \l{The State Machine Framework}.

View File

@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\ingroup statemachine \ingroup statemachine
\inmodule QtWidgets
QMouseEventTransition is part of \l{The State Machine Framework}. QMouseEventTransition is part of \l{The State Machine Framework}.

View File

@ -73,6 +73,7 @@ QT_BEGIN_NAMESPACE
\brief The QCDEStyle class provides a CDE look and feel. \brief The QCDEStyle class provides a CDE look and feel.
\ingroup appearance \ingroup appearance
\inmodule QtWidgets
This style provides a slightly improved Motif look similar to some This style provides a slightly improved Motif look similar to some
versions of the Common Desktop Environment (CDE). The main versions of the Common Desktop Environment (CDE). The main

View File

@ -593,6 +593,8 @@ static void qt_cleanlooks_draw_mdibutton(QPainter *painter, const QStyleOptionTi
Clearlooks style available in GNOME. Clearlooks style available in GNOME.
\since 4.2 \since 4.2
\inmodule QtWidgets
The Cleanlooks style provides a look and feel for widgets The Cleanlooks style provides a look and feel for widgets
that closely resembles the Clearlooks style, introduced by Richard that closely resembles the Clearlooks style, introduced by Richard
Stellingwerff and Daniel Borgmann. Stellingwerff and Daniel Borgmann.

View File

@ -96,6 +96,7 @@ QT_BEGIN_NAMESPACE
\brief The QCommonStyle class encapsulates the common Look and Feel of a GUI. \brief The QCommonStyle class encapsulates the common Look and Feel of a GUI.
\ingroup appearance \ingroup appearance
\inmodule QtWidgets
This abstract class implements some of the widget's look and feel This abstract class implements some of the widget's look and feel
that is common to all GUI styles provided and shipped as part of that is common to all GUI styles provided and shipped as part of

View File

@ -747,8 +747,12 @@ void qDrawPlainRect(QPainter *p, const QRect &r, const QColor &c,
\class QTileRules \class QTileRules
\since 4.6 \since 4.6
Holds the rules used to draw a pixmap or image split into nine segments, \inmodule QtWidgets
similar to \l{http://www.w3.org/TR/css3-background/}{CSS3 border-images}.
\brief The QTileRules class provides the rules used to draw a
pixmap or image split into nine segments.
Spliiting is similar to \l{http://www.w3.org/TR/css3-background/}{CSS3 border-images}.
\sa Qt::TileRule, QMargins \sa Qt::TileRule, QMargins
*/ */

View File

@ -170,6 +170,8 @@ static GdkColor fromQColor(const QColor &color)
\brief The QGtkStyle class provides a widget style rendered by GTK+ \brief The QGtkStyle class provides a widget style rendered by GTK+
\since 4.5 \since 4.5
\inmodule QtWidgets
The QGtkStyle style provides a look and feel that integrates well The QGtkStyle style provides a look and feel that integrates well
into GTK-based desktop environments such as the XFCe and GNOME. into GTK-based desktop environments such as the XFCe and GNOME.

View File

@ -31,6 +31,7 @@
\brief The QMacStyle class provides a Mac OS X style using the Apple Appearance Manager. \brief The QMacStyle class provides a Mac OS X style using the Apple Appearance Manager.
\ingroup appearance \ingroup appearance
\inmodule QtWidgets
This class is implemented as a wrapper to the HITheme This class is implemented as a wrapper to the HITheme
APIs, allowing applications to be styled according to the current APIs, allowing applications to be styled according to the current

View File

@ -94,6 +94,7 @@ static const int motifCheckMarkSpace = 16;
\brief The QMotifStyle class provides Motif look and feel. \brief The QMotifStyle class provides Motif look and feel.
\ingroup appearance \ingroup appearance
\inmodule QtWidgets
This class implements the Motif look and feel. It closely This class implements the Motif look and feel. It closely
resembles the original Motif look as defined by the Open Group, resembles the original Motif look as defined by the Open Group,

View File

@ -1019,6 +1019,8 @@ QPlastiqueStylePrivate::~QPlastiqueStylePrivate()
\brief The QPlastiqueStyle class provides a widget style similar to the \brief The QPlastiqueStyle class provides a widget style similar to the
Plastik style available in KDE. Plastik style available in KDE.
\inmodule QtWidgets
The Plastique style provides a default look and feel for widgets on X11 The Plastique style provides a default look and feel for widgets on X11
that closely resembles the Plastik style, introduced by Sandro Giessl in that closely resembles the Plastik style, introduced by Sandro Giessl in
KDE 3.2. KDE 3.2.

View File

@ -58,6 +58,8 @@ QT_BEGIN_NAMESPACE
\since 4.6 \since 4.6
\inmodule QtWidgets
A QProxyStyle wraps a QStyle (usually the default system style) for the A QProxyStyle wraps a QStyle (usually the default system style) for the
purpose of dynamically overriding painting or other specific style behavior. purpose of dynamically overriding painting or other specific style behavior.

View File

@ -979,6 +979,7 @@ QPixmap QS60StylePrivate::placeHolderTexture()
\brief The QS60Style class provides a look and feel suitable for applications on S60. \brief The QS60Style class provides a look and feel suitable for applications on S60.
\since 4.6 \since 4.6
\ingroup appearance \ingroup appearance
\inmodule QtWidgets
\sa QMacStyle, QWindowsStyle, QWindowsXPStyle, QWindowsVistaStyle, QPlastiqueStyle, QCleanlooksStyle, QMotifStyle \sa QMacStyle, QWindowsStyle, QWindowsXPStyle, QWindowsVistaStyle, QPlastiqueStyle, QCleanlooksStyle, QMotifStyle
*/ */

Some files were not shown because too many files have changed in this diff Show More