diff options
| author | Casper van Donderen <casper.vandonderen@nokia.com> | 2011-09-20 23:22:36 +0200 |
|---|---|---|
| committer | Qt by Nokia <qt-info@nokia.com> | 2011-10-03 09:56:09 +0200 |
| commit | e86df8cc4b6a522fac909687d48b269c7f5108b6 (patch) | |
| tree | 3b3157049b3dabe3432052415237bf1c1765c89b /src/widgets | |
| parent | 7f57f2912569cb6e728cc14afae71923f83ad663 (diff) | |
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>
Diffstat (limited to 'src/widgets')
158 files changed, 315 insertions, 61 deletions
diff --git a/src/widgets/accessible/qaccessiblewidget.cpp b/src/widgets/accessible/qaccessiblewidget.cpp index c1a4d1b32f..930e28002c 100644 --- a/src/widgets/accessible/qaccessiblewidget.cpp +++ b/src/widgets/accessible/qaccessiblewidget.cpp @@ -157,6 +157,7 @@ public: \brief The QAccessibleWidget class implements the QAccessibleInterface for QWidgets. \ingroup accessibility + \inmodule QtWidgets This class is convenient to use as a base class for custom implementations of QAccessibleInterfaces that provide information diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp index ce3e54f1f3..027470f779 100644 --- a/src/widgets/dialogs/qcolordialog.cpp +++ b/src/widgets/dialogs/qcolordialog.cpp @@ -1683,6 +1683,7 @@ static const Qt::WindowFlags DefaultWindowFlags = \brief The QColorDialog class provides a dialog widget for specifying colors. \ingroup standard-dialogs + \inmodule QtWidgets 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 diff --git a/src/widgets/dialogs/qdialog.cpp b/src/widgets/dialogs/qdialog.cpp index 41b34a1065..03c5316c04 100644 --- a/src/widgets/dialogs/qdialog.cpp +++ b/src/widgets/dialogs/qdialog.cpp @@ -87,7 +87,7 @@ QT_BEGIN_NAMESPACE \ingroup dialog-classes \ingroup abstractwidgets - + \inmodule QtWidgets A dialog window is a top-level window mostly used for short-term tasks and brief communications with the user. QDialogs may be diff --git a/src/widgets/dialogs/qerrormessage.cpp b/src/widgets/dialogs/qerrormessage.cpp index 890e6ca6b7..e87551cd80 100644 --- a/src/widgets/dialogs/qerrormessage.cpp +++ b/src/widgets/dialogs/qerrormessage.cpp @@ -151,6 +151,7 @@ QSize QErrorMessageTextView::sizeHint() const \brief The QErrorMessage class provides an error message display dialog. \ingroup standard-dialog + \inmodule QtWidgets 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 diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp index 3c2e134c9b..2a402f5691 100644 --- a/src/widgets/dialogs/qfiledialog.cpp +++ b/src/widgets/dialogs/qfiledialog.cpp @@ -96,7 +96,7 @@ Q_WIDGETS_EXPORT _qt_filedialog_save_filename_hook qt_filedialog_save_filename_h \class QFileDialog \brief The QFileDialog class provides a dialog that allow users to select files or directories. \ingroup standard-dialogs - + \inmodule QtWidgets The QFileDialog class enables a user to traverse the file system in order to select one or many files or a directory. diff --git a/src/widgets/dialogs/qfilesystemmodel.cpp b/src/widgets/dialogs/qfilesystemmodel.cpp index 82de3f724b..9de79e0e81 100644 --- a/src/widgets/dialogs/qfilesystemmodel.cpp +++ b/src/widgets/dialogs/qfilesystemmodel.cpp @@ -74,6 +74,7 @@ QT_BEGIN_NAMESPACE \brief The QFileSystemModel class provides a data model for the local filesystem. \ingroup model-view + \inmodule QtWidgets This class provides access to the local filesystem, providing functions for renaming and removing files and directories, and for creating new diff --git a/src/widgets/dialogs/qfontdialog.cpp b/src/widgets/dialogs/qfontdialog.cpp index df49fee9bb..62338d8a3e 100644 --- a/src/widgets/dialogs/qfontdialog.cpp +++ b/src/widgets/dialogs/qfontdialog.cpp @@ -117,6 +117,7 @@ static const Qt::WindowFlags DefaultWindowFlags = /*! \class QFontDialog \ingroup standard-dialogs + \inmodule QtWidgets \brief The QFontDialog class provides a dialog widget for selecting a font. diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp index 5ca947ccbd..1c52282ad5 100644 --- a/src/widgets/dialogs/qinputdialog.cpp +++ b/src/widgets/dialogs/qinputdialog.cpp @@ -437,7 +437,7 @@ void QInputDialogPrivate::_q_currentRowChanged(const QModelIndex &newIndex, \brief The QInputDialog class provides a simple convenience dialog to get a single value from the user. \ingroup standard-dialogs - + \inmodule QtWidgets 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. diff --git a/src/widgets/dialogs/qmessagebox.cpp b/src/widgets/dialogs/qmessagebox.cpp index 8b6073d6d1..96b8e46570 100644 --- a/src/widgets/dialogs/qmessagebox.cpp +++ b/src/widgets/dialogs/qmessagebox.cpp @@ -492,7 +492,7 @@ void QMessageBoxPrivate::_q_buttonClicked(QAbstractButton *button) the user or for asking the user a question and receiving an answer. \ingroup standard-dialogs - + \inmodule QtWidgets A message box displays a primary \l{QMessageBox::text}{text} to alert the user to a situation, an \l{QMessageBox::informativeText} diff --git a/src/widgets/dialogs/qprogressdialog.cpp b/src/widgets/dialogs/qprogressdialog.cpp index 8701dc10fb..4e31abf3e4 100644 --- a/src/widgets/dialogs/qprogressdialog.cpp +++ b/src/widgets/dialogs/qprogressdialog.cpp @@ -218,6 +218,7 @@ void QProgressDialogPrivate::_q_disconnectOnClose() \class QProgressDialog \brief The QProgressDialog class provides feedback on the progress of a slow operation. \ingroup standard-dialogs + \inmodule QtWidgets A progress dialog is used to give the user an indication of how long diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index 83bdaa0e55..81e23fbb18 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -1785,6 +1785,8 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) \since 4.3 \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 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. @@ -3340,6 +3342,8 @@ int QWizard::nextId() const \since 4.3 \brief The QWizardPage class is the base class for wizard pages. + \inmodule QtWidgets + QWizard represents a wizard. Each page is a QWizardPage. When you create your own wizards, you can use QWizardPage directly, or you can subclass it for more control. diff --git a/src/widgets/effects/qgraphicseffect.cpp b/src/widgets/effects/qgraphicseffect.cpp index 5df29cd297..45f31d8062 100644 --- a/src/widgets/effects/qgraphicseffect.cpp +++ b/src/widgets/effects/qgraphicseffect.cpp @@ -46,6 +46,7 @@ \since 4.6 \ingroup multimedia \ingroup graphicsview-api + \inmodule QtWidgets Effects alter the appearance of elements by hooking into the rendering pipeline and operating between the source (e.g., a QGraphicsPixmapItem) @@ -592,6 +593,7 @@ void QGraphicsEffect::sourceChanged(ChangeFlags flags) \class QGraphicsColorizeEffect \brief The QGraphicsColorizeEffect class provides a colorize effect. \since 4.6 + \inmodule QtWidgets A colorize effect renders the source with a tint of its color(). The color can be modified using the setColor() function. @@ -717,6 +719,7 @@ void QGraphicsColorizeEffect::draw(QPainter *painter) \class QGraphicsBlurEffect \brief The QGraphicsBlurEffect class provides a blur effect. \since 4.6 + \inmodule QtWidgets 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 @@ -876,6 +879,7 @@ void QGraphicsBlurEffect::draw(QPainter *painter) \class QGraphicsDropShadowEffect \brief The QGraphicsDropShadowEffect class provides a drop shadow effect. \since 4.6 + \inmodule QtWidgets 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 @@ -1072,6 +1076,7 @@ void QGraphicsDropShadowEffect::draw(QPainter *painter) \class QGraphicsOpacityEffect \brief The QGraphicsOpacityEffect class provides an opacity effect. \since 4.6 + \inmodule QtWidgets 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 diff --git a/src/widgets/graphicsview/qgraphicsanchorlayout.cpp b/src/widgets/graphicsview/qgraphicsanchorlayout.cpp index 08c5972534..3bd83ae6c4 100644 --- a/src/widgets/graphicsview/qgraphicsanchorlayout.cpp +++ b/src/widgets/graphicsview/qgraphicsanchorlayout.cpp @@ -47,6 +47,7 @@ \ingroup appearance \ingroup geomanagement \ingroup graphicsview-api + \inmodule QtWidgets 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 @@ -125,6 +126,7 @@ \ingroup appearance \ingroup geomanagement \ingroup graphicsview-api + \inmodule QtWidgets 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 diff --git a/src/widgets/graphicsview/qgraphicsgridlayout.cpp b/src/widgets/graphicsview/qgraphicsgridlayout.cpp index 2fbfc5dda9..dd4102fdb9 100644 --- a/src/widgets/graphicsview/qgraphicsgridlayout.cpp +++ b/src/widgets/graphicsview/qgraphicsgridlayout.cpp @@ -46,6 +46,7 @@ \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets 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(), diff --git a/src/widgets/graphicsview/qgraphicsitem.cpp b/src/widgets/graphicsview/qgraphicsitem.cpp index 180643d339..07af928243 100644 --- a/src/widgets/graphicsview/qgraphicsitem.cpp +++ b/src/widgets/graphicsview/qgraphicsitem.cpp @@ -46,6 +46,7 @@ \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets It provides a light-weight foundation for writing your own custom items. This includes defining the item's geometry, collision detection, its @@ -7621,6 +7622,7 @@ static void qt_graphicsItem_highlightSelected( require signals, slots and properties. \since 4.6 \ingroup graphicsview-api + \inmodule QtWidgets 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 @@ -8052,6 +8054,7 @@ void QGraphicsItemPrivate::resetHeight() all path items. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets This class does not fully implement an item by itself; in particular, it does not implement boundingRect() and paint(), which are inherited by @@ -8191,6 +8194,7 @@ QPainterPath QAbstractGraphicsShapeItem::opaqueArea() const can add to a QGraphicsScene. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's path, pass a QPainterPath to QGraphicsPathItem's 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. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's rectangle, pass a QRectF to QGraphicsRectItem's 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. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsEllipseItem respresents an ellipse with a fill and an outline, 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. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's polygon, pass a QPolygonF to QGraphicsPolygonItem's constructor, or call the setPolygon() @@ -9186,6 +9193,7 @@ QVariant QGraphicsPolygonItem::extension(const QVariant &variant) const QGraphicsScene. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's line, pass a QLineF to QGraphicsLineItem's constructor, or call the setLine() function. The line() function @@ -9449,6 +9457,7 @@ QVariant QGraphicsLineItem::extension(const QVariant &variant) const a QGraphicsScene. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's pixmap, pass a QPixmap to QGraphicsPixmapItem's 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. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets If you only need to show plain text in an item, consider using QGraphicsSimpleTextItem instead. @@ -10734,6 +10744,7 @@ void QGraphicsSimpleTextItemPrivate::updateBoundingRect() that you can add to a QGraphicsScene. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets To set the item's text, you can either pass a QString to 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. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets A QGraphicsItemGroup is a special type of compound item that treats itself and all its children as one item (i.e., all events diff --git a/src/widgets/graphicsview/qgraphicsitemanimation.cpp b/src/widgets/graphicsview/qgraphicsitemanimation.cpp index 104e21cf41..a0b7ea4002 100644 --- a/src/widgets/graphicsview/qgraphicsitemanimation.cpp +++ b/src/widgets/graphicsview/qgraphicsitemanimation.cpp @@ -45,6 +45,7 @@ support for QGraphicsItem. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets \deprecated The QGraphicsItemAnimation class animates a QGraphicsItem. You can diff --git a/src/widgets/graphicsview/qgraphicslayout.cpp b/src/widgets/graphicsview/qgraphicslayout.cpp index 76d2d040c7..0f463334cc 100644 --- a/src/widgets/graphicsview/qgraphicslayout.cpp +++ b/src/widgets/graphicsview/qgraphicslayout.cpp @@ -58,6 +58,7 @@ QT_BEGIN_NAMESPACE in Graphics View. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsLayout is an abstract class that defines a virtual API for arranging QGraphicsWidget children and other QGraphicsLayoutItem objects diff --git a/src/widgets/graphicsview/qgraphicslayoutitem.cpp b/src/widgets/graphicsview/qgraphicslayoutitem.cpp index 0631df80dd..5eaf0a516e 100644 --- a/src/widgets/graphicsview/qgraphicslayoutitem.cpp +++ b/src/widgets/graphicsview/qgraphicslayoutitem.cpp @@ -320,6 +320,7 @@ bool QGraphicsLayoutItemPrivate::hasWidthForHeight() const items to be managed by layouts. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsLayoutItem is an abstract class that defines a set of virtual functions describing sizes, size policies, and size hints for any object diff --git a/src/widgets/graphicsview/qgraphicslinearlayout.cpp b/src/widgets/graphicsview/qgraphicslinearlayout.cpp index 2a5d5a510e..ee0db09df0 100644 --- a/src/widgets/graphicsview/qgraphicslinearlayout.cpp +++ b/src/widgets/graphicsview/qgraphicslinearlayout.cpp @@ -45,6 +45,7 @@ layout for managing widgets in Graphics View. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets The default orientation for a linear layout is Qt::Horizontal. You can choose a vertical orientation either by calling setOrientation(), or by diff --git a/src/widgets/graphicsview/qgraphicsproxywidget.cpp b/src/widgets/graphicsview/qgraphicsproxywidget.cpp index cb8e2259f4..1b03879804 100644 --- a/src/widgets/graphicsview/qgraphicsproxywidget.cpp +++ b/src/widgets/graphicsview/qgraphicsproxywidget.cpp @@ -71,6 +71,7 @@ QT_BEGIN_NAMESPACE a QWidget in a QGraphicsScene. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsProxyWidget embeds QWidget-based widgets, for example, a QPushButton, QFontComboBox, or even QFileDialog, into diff --git a/src/widgets/graphicsview/qgraphicsscene.cpp b/src/widgets/graphicsview/qgraphicsscene.cpp index 76e60f9409..8e9c095f8c 100644 --- a/src/widgets/graphicsview/qgraphicsscene.cpp +++ b/src/widgets/graphicsview/qgraphicsscene.cpp @@ -45,7 +45,7 @@ number of 2D graphical items. \since 4.2 \ingroup graphicsview-api - + \inmodule QtWidgets The class serves as a container for QGraphicsItems. It is used together with QGraphicsView for visualizing graphical items, such as lines, diff --git a/src/widgets/graphicsview/qgraphicssceneevent.cpp b/src/widgets/graphicsview/qgraphicssceneevent.cpp index 97e5ff40c1..4927b6933f 100644 --- a/src/widgets/graphicsview/qgraphicssceneevent.cpp +++ b/src/widgets/graphicsview/qgraphicssceneevent.cpp @@ -45,6 +45,7 @@ graphics view related events. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets When a QGraphicsView receives Qt mouse, keyboard, and drag and drop events (QMouseEvent, QKeyEvent, QDragEvent, etc.), it @@ -86,6 +87,7 @@ in the graphics view framework. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets When a QGraphicsView receives a QMouseEvent, it translates it to a QGraphicsSceneMouseEvent. The event is then forwarded to the @@ -112,6 +114,7 @@ graphics view framework. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets \l{QWheelEvent}{QWheelEvent}s received by a QGraphicsView are translated into QGraphicsSceneWheelEvents; it translates the QWheelEvent::globalPos() @@ -128,6 +131,7 @@ menu events in the graphics view framework. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets A QContextMenuEvent received by a QGraphicsView is translated into a QGraphicsSceneContextMenuEvent. The @@ -159,6 +163,7 @@ in the graphics view framework. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets When a QGraphicsView receives a QHoverEvent event, it translates it into QGraphicsSceneHoverEvent. The event is then forwarded to @@ -174,6 +179,7 @@ tooltip is requested. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets When a QGraphicsView receives a QEvent of type QEvent::ToolTip, it creates a QGraphicsSceneHelpEvent, which is @@ -198,6 +204,7 @@ drag and drop in the graphics view framework. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsView inherits the drag and drop functionality provided by QWidget. When it receives a drag and drop event, it translates @@ -222,6 +229,7 @@ resizing in the graphics view framework. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets A QGraphicsWidget sends itself a QGraphicsSceneResizeEvent immediately when its geometry changes. @@ -238,6 +246,7 @@ moving in the graphics view framework. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets A QGraphicsWidget sends itself a QGraphicsSceneMoveEvent immediately when its local position changes. The delivery is implemented as part of diff --git a/src/widgets/graphicsview/qgraphicstransform.cpp b/src/widgets/graphicsview/qgraphicstransform.cpp index fa56427f36..c0cc571bd4 100644 --- a/src/widgets/graphicsview/qgraphicstransform.cpp +++ b/src/widgets/graphicsview/qgraphicstransform.cpp @@ -45,6 +45,7 @@ advanced transformations on QGraphicsItems. \since 4.6 \ingroup graphicsview-api + \inmodule QtWidgets As an alternative to QGraphicsItem::transform, QGraphicsTransform lets you create and control advanced transformations that can be configured @@ -177,6 +178,7 @@ void QGraphicsTransform::update() \class QGraphicsScale \brief The QGraphicsScale class provides a scale transformation. \since 4.6 + \inmodule QtWidgets QGraphicsScene provides certain parameters to help control how the scale should be applied. @@ -381,6 +383,7 @@ void QGraphicsScale::applyTo(QMatrix4x4 *matrix) const \brief The QGraphicsRotation class provides a rotation transformation around a given axis. \since 4.6 + \inmodule QtWidgets 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. diff --git a/src/widgets/graphicsview/qgraphicsview.cpp b/src/widgets/graphicsview/qgraphicsview.cpp index 279dfce1ff..2ebd4ecc63 100644 --- a/src/widgets/graphicsview/qgraphicsview.cpp +++ b/src/widgets/graphicsview/qgraphicsview.cpp @@ -49,7 +49,7 @@ static const int QGRAPHICSVIEW_PREALLOC_STYLE_OPTIONS = 503; // largest prime < contents of a QGraphicsScene. \since 4.2 \ingroup graphicsview-api - + \inmodule QtWidgets QGraphicsView visualizes the contents of a QGraphicsScene in a scrollable viewport. To create a scene with geometrical items, see QGraphicsScene's diff --git a/src/widgets/graphicsview/qgraphicswidget.cpp b/src/widgets/graphicsview/qgraphicswidget.cpp index b50ae9a4ec..8beb006788 100644 --- a/src/widgets/graphicsview/qgraphicswidget.cpp +++ b/src/widgets/graphicsview/qgraphicswidget.cpp @@ -75,6 +75,7 @@ QT_BEGIN_NAMESPACE items in a QGraphicsScene. \since 4.4 \ingroup graphicsview-api + \inmodule QtWidgets QGraphicsWidget is an extended base item that provides extra functionality over QGraphicsItem. It is similar to QWidget in many ways: diff --git a/src/widgets/itemviews/qabstractitemdelegate.cpp b/src/widgets/itemviews/qabstractitemdelegate.cpp index 34d3a25623..bdc5d69f56 100644 --- a/src/widgets/itemviews/qabstractitemdelegate.cpp +++ b/src/widgets/itemviews/qabstractitemdelegate.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE data items from a model. \ingroup model-view - + \inmodule QtWidgets A QAbstractItemDelegate provides the interface and common functionality for delegates in the model/view architecture. Delegates display diff --git a/src/widgets/itemviews/qabstractitemview.cpp b/src/widgets/itemviews/qabstractitemview.cpp index d6fbb7c953..115dd24e2f 100644 --- a/src/widgets/itemviews/qabstractitemview.cpp +++ b/src/widgets/itemviews/qabstractitemview.cpp @@ -237,7 +237,7 @@ void QAbstractItemViewPrivate::_q_scrollerStateChanged() item view classes. \ingroup model-view - + \inmodule QtWidgets QAbstractItemView class is the base class for every standard view that uses a QAbstractItemModel. QAbstractItemView is an abstract diff --git a/src/widgets/itemviews/qabstractproxymodel.cpp b/src/widgets/itemviews/qabstractproxymodel.cpp index 48c84acb56..47810d6cc7 100644 --- a/src/widgets/itemviews/qabstractproxymodel.cpp +++ b/src/widgets/itemviews/qabstractproxymodel.cpp @@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractProxyModel class provides a base class for proxy item models that can do sorting, filtering or other data processing tasks. \ingroup model-view + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qcolumnview.cpp b/src/widgets/itemviews/qcolumnview.cpp index 2be03a0fe8..3b4bcae847 100644 --- a/src/widgets/itemviews/qcolumnview.cpp +++ b/src/widgets/itemviews/qcolumnview.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE \brief The QColumnView class provides a model/view implementation of a column view. \ingroup model-view \ingroup advanced - + \inmodule QtWidgets 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. diff --git a/src/widgets/itemviews/qdatawidgetmapper.cpp b/src/widgets/itemviews/qdatawidgetmapper.cpp index 7d328fcce5..8f5203936d 100644 --- a/src/widgets/itemviews/qdatawidgetmapper.cpp +++ b/src/widgets/itemviews/qdatawidgetmapper.cpp @@ -258,6 +258,7 @@ void QDataWidgetMapperPrivate::_q_modelDestroyed() \since 4.2 \ingroup model-view \ingroup advanced + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qdirmodel.cpp b/src/widgets/itemviews/qdirmodel.cpp index fd9f0f748a..c80662414a 100644 --- a/src/widgets/itemviews/qdirmodel.cpp +++ b/src/widgets/itemviews/qdirmodel.cpp @@ -189,6 +189,7 @@ void QDirModelPrivate::invalidate() \brief The QDirModel class provides a data model for the local filesystem. \ingroup model-view + \inmodule QtWidgets The usage of QDirModel is not recommended anymore. The QFileSystemModel class is a more performant alternative. diff --git a/src/widgets/itemviews/qfileiconprovider.cpp b/src/widgets/itemviews/qfileiconprovider.cpp index 84081c5439..d4dd9e8ff6 100644 --- a/src/widgets/itemviews/qfileiconprovider.cpp +++ b/src/widgets/itemviews/qfileiconprovider.cpp @@ -73,6 +73,8 @@ QT_BEGIN_NAMESPACE /*! \class QFileIconProvider + \inmodule QtWidgets + \brief The QFileIconProvider class provides file icons for the QDirModel and the QFileSystemModel classes. */ diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp index 8b3c6e80f7..aee39a5ea1 100644 --- a/src/widgets/itemviews/qheaderview.cpp +++ b/src/widgets/itemviews/qheaderview.cpp @@ -88,7 +88,7 @@ QDataStream &operator>>(QDataStream &in, QHeaderViewPrivate::SectionSpan &span) item views. \ingroup model-view - + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qidentityproxymodel.cpp b/src/widgets/itemviews/qidentityproxymodel.cpp index ee36b8319f..5893d1ba38 100644 --- a/src/widgets/itemviews/qidentityproxymodel.cpp +++ b/src/widgets/itemviews/qidentityproxymodel.cpp @@ -94,6 +94,7 @@ class QIdentityProxyModelPrivate : public QAbstractProxyModelPrivate \brief The QIdentityProxyModel class proxies its source model unmodified \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. This is similar in concept to an identity matrix where A.I = A. diff --git a/src/widgets/itemviews/qitemdelegate.cpp b/src/widgets/itemviews/qitemdelegate.cpp index a2da62ac83..72f358ce68 100644 --- a/src/widgets/itemviews/qitemdelegate.cpp +++ b/src/widgets/itemviews/qitemdelegate.cpp @@ -186,7 +186,7 @@ QSizeF QItemDelegatePrivate::doTextLayout(int lineWidth) const data items from a model. \ingroup model-view - + \inmodule QtWidgets QItemDelegate can be used to provide custom display features and editor widgets for item views based on QAbstractItemView subclasses. Using a diff --git a/src/widgets/itemviews/qitemeditorfactory.cpp b/src/widgets/itemviews/qitemeditorfactory.cpp index cc9d1399bf..7ff3622ec4 100644 --- a/src/widgets/itemviews/qitemeditorfactory.cpp +++ b/src/widgets/itemviews/qitemeditorfactory.cpp @@ -79,6 +79,7 @@ public: in views and delegates. \since 4.2 \ingroup model-view + \inmodule QtWidgets When editing data in an item view, editors are created and 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. \since 4.2 \ingroup model-view + \inmodule QtWidgets QItemEditorCreatorBase objects are specialized widget factories that provide editor widgets for one particular QVariant data type. They @@ -396,6 +398,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory) \since 4.2 \ingroup model-view + \inmodule QtWidgets QItemEditorCreator is a convenience template class. It uses the template class to create editors for QItemEditorFactory. @@ -446,6 +449,7 @@ void QItemEditorFactory::setDefaultFactory(QItemEditorFactory *factory) \since 4.2 \ingroup model-view + \inmodule QtWidgets This convenience template class makes it possible to register widgets without having to subclass QItemEditorCreatorBase. diff --git a/src/widgets/itemviews/qitemselectionmodel.cpp b/src/widgets/itemviews/qitemselectionmodel.cpp index 0d0b5b1d42..423a5802c2 100644 --- a/src/widgets/itemviews/qitemselectionmodel.cpp +++ b/src/widgets/itemviews/qitemselectionmodel.cpp @@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE range of selected items in a model. \ingroup model-view + \inmodule QtWidgets A QItemSelectionRange contains information about a range of 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. \ingroup model-view + \inmodule QtWidgets A QItemSelection describes the items in a model that have been 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. \ingroup model-view + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qlistview.cpp b/src/widgets/itemviews/qlistview.cpp index 0b1c2d5673..ee20d8880b 100644 --- a/src/widgets/itemviews/qlistview.cpp +++ b/src/widgets/itemviews/qlistview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \ingroup model-view \ingroup advanced - + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp index 63badec3be..a4aaa6b4b6 100644 --- a/src/widgets/itemviews/qlistwidget.cpp +++ b/src/widgets/itemviews/qlistwidget.cpp @@ -461,6 +461,7 @@ Qt::DropActions QListModel::supportedDropActions() const QListWidget item view class. \ingroup model-view + \inmodule QtWidgets A QListWidgetItem represents a single item in a QListWidget. Each item can 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. \ingroup model-view - + \inmodule QtWidgets 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 diff --git a/src/widgets/itemviews/qproxymodel.cpp b/src/widgets/itemviews/qproxymodel.cpp index 7042f7d0a6..bc76bf1623 100644 --- a/src/widgets/itemviews/qproxymodel.cpp +++ b/src/widgets/itemviews/qproxymodel.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE passed between another model and a view. \ingroup model-view + \inmodule QtWidgets If you want to do filtering and sorting, see QSortFilterProxyModel. diff --git a/src/widgets/itemviews/qsortfilterproxymodel.cpp b/src/widgets/itemviews/qsortfilterproxymodel.cpp index b749286abe..4810d6e0fe 100644 --- a/src/widgets/itemviews/qsortfilterproxymodel.cpp +++ b/src/widgets/itemviews/qsortfilterproxymodel.cpp @@ -1360,6 +1360,7 @@ void QSortFilterProxyModelPrivate::_q_sourceColumnsRemoved( filtering data passed between another model and a view. \ingroup model-view + \inmodule QtWidgets QSortFilterProxyModel can be used for sorting items, filtering out items, or both. The model transforms the structure of a source model by mapping diff --git a/src/widgets/itemviews/qstandarditemmodel.cpp b/src/widgets/itemviews/qstandarditemmodel.cpp index 1bd5e8861c..293420beb7 100644 --- a/src/widgets/itemviews/qstandarditemmodel.cpp +++ b/src/widgets/itemviews/qstandarditemmodel.cpp @@ -614,6 +614,7 @@ void QStandardItemModelPrivate::columnsRemoved(QStandardItem *parent, QStandardItemModel class. \since 4.2 \ingroup model-view + \inmodule QtWidgets Items usually contain text, icons, or checkboxes. @@ -1951,6 +1952,7 @@ QDataStream &operator<<(QDataStream &out, const QStandardItem &item) \class QStandardItemModel \brief The QStandardItemModel class provides a generic model for storing custom data. \ingroup model-view + \inmodule QtWidgets QStandardItemModel can be used as a repository for standard Qt data types. It is one of the \l {Model/View Classes} and is part diff --git a/src/widgets/itemviews/qstringlistmodel.cpp b/src/widgets/itemviews/qstringlistmodel.cpp index 367decc7d8..9faaca0dd4 100644 --- a/src/widgets/itemviews/qstringlistmodel.cpp +++ b/src/widgets/itemviews/qstringlistmodel.cpp @@ -54,7 +54,7 @@ QT_BEGIN_NAMESPACE \brief The QStringListModel class provides a model that supplies strings to views. \ingroup model-view - + \inmodule QtWidgets QStringListModel is an editable model that can be used for simple cases where you need to display a number of strings in a view diff --git a/src/widgets/itemviews/qstyleditemdelegate.cpp b/src/widgets/itemviews/qstyleditemdelegate.cpp index 931d870acb..35d8d3d85b 100644 --- a/src/widgets/itemviews/qstyleditemdelegate.cpp +++ b/src/widgets/itemviews/qstyleditemdelegate.cpp @@ -112,6 +112,7 @@ public: data items from a model. \ingroup model-view + \inmodule QtWidgets \since 4.4 diff --git a/src/widgets/itemviews/qtableview.cpp b/src/widgets/itemviews/qtableview.cpp index 48731dbbe4..54aeddc78f 100644 --- a/src/widgets/itemviews/qtableview.cpp +++ b/src/widgets/itemviews/qtableview.cpp @@ -937,7 +937,7 @@ void QTableViewPrivate::drawCell(QPainter *painter, const QStyleOptionViewItemV4 \ingroup model-view \ingroup advanced - + \inmodule QtWidgets A QTableView implements a table view that displays items from a model. This class is used to provide standard tables that were diff --git a/src/widgets/itemviews/qtablewidget.cpp b/src/widgets/itemviews/qtablewidget.cpp index 3496327be1..6485fa503d 100644 --- a/src/widgets/itemviews/qtablewidget.cpp +++ b/src/widgets/itemviews/qtablewidget.cpp @@ -857,6 +857,7 @@ Qt::DropActions QTableModel::supportedDropActions() const selection in a model without using model indexes and a selection model. \ingroup model-view + \inmodule QtWidgets The QTableWidgetSelectionRange class stores the top left and bottom right rows and columns of a selection range in a table. The @@ -965,6 +966,7 @@ QTableWidgetSelectionRange::~QTableWidgetSelectionRange() QTableWidget class. \ingroup model-view + \inmodule QtWidgets Table items are used to hold pieces of information for table widgets. 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. \ingroup model-view - + \inmodule QtWidgets Table widgets provide standard table display facilities for applications. The items in a QTableWidget are provided by QTableWidgetItem. diff --git a/src/widgets/itemviews/qtreeview.cpp b/src/widgets/itemviews/qtreeview.cpp index 5ff4f94c5a..25cb29ffd2 100644 --- a/src/widgets/itemviews/qtreeview.cpp +++ b/src/widgets/itemviews/qtreeview.cpp @@ -67,7 +67,7 @@ QT_BEGIN_NAMESPACE \ingroup model-view \ingroup advanced - + \inmodule QtWidgets A QTreeView implements a tree representation of items from a model. This class is used to provide standard hierarchical lists that diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp index 5571732254..8c32e0ce87 100644 --- a/src/widgets/itemviews/qtreewidget.cpp +++ b/src/widgets/itemviews/qtreewidget.cpp @@ -75,6 +75,7 @@ public: \brief The QTreeModel class manages the items stored in a tree view. \ingroup model-view + \inmodule QtWidgets */ @@ -883,6 +884,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) QTreeWidget convenience class. \ingroup model-view + \inmodule QtWidgets 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 @@ -2337,7 +2339,7 @@ void QTreeWidgetPrivate::_q_dataChanged(const QModelIndex &topLeft, tree model. \ingroup model-view - + \inmodule QtWidgets The QTreeWidget class is a convenience class that provides a standard tree widget with a classic item-based interface similar to that used by diff --git a/src/widgets/itemviews/qtreewidgetitemiterator.cpp b/src/widgets/itemviews/qtreewidgetitemiterator.cpp index 579c5acdf6..f538917a09 100644 --- a/src/widgets/itemviews/qtreewidgetitemiterator.cpp +++ b/src/widgets/itemviews/qtreewidgetitemiterator.cpp @@ -51,6 +51,8 @@ QT_BEGIN_NAMESPACE /*! \class QTreeWidgetItemIterator \ingroup model-view + \inmodule QtWidgets + \brief The QTreeWidgetItemIterator class provides a way to iterate over the items in a QTreeWidget instance. diff --git a/src/widgets/kernel/qaction.cpp b/src/widgets/kernel/qaction.cpp index a65869a903..61be508d39 100644 --- a/src/widgets/kernel/qaction.cpp +++ b/src/widgets/kernel/qaction.cpp @@ -196,7 +196,7 @@ void QActionPrivate::setShortcutEnabled(bool enable, QShortcutMap &map) action that can be inserted into widgets. \ingroup mainwindow-classes - + \inmodule QtWidgets \omit * parent and widget are different diff --git a/src/widgets/kernel/qactiongroup.cpp b/src/widgets/kernel/qactiongroup.cpp index 25ff59947c..0397883009 100644 --- a/src/widgets/kernel/qactiongroup.cpp +++ b/src/widgets/kernel/qactiongroup.cpp @@ -106,6 +106,7 @@ void QActionGroupPrivate::_q_actionHovered() \brief The QActionGroup class groups actions together. \ingroup mainwindow-classes + \inmodule QtWidgets In some situations it is useful to group QAction objects together. For example, if you have a \gui{Left Align} action, a \gui{Right diff --git a/src/widgets/kernel/qapplication.cpp b/src/widgets/kernel/qapplication.cpp index b87c0c9d8a..07035e927f 100644 --- a/src/widgets/kernel/qapplication.cpp +++ b/src/widgets/kernel/qapplication.cpp @@ -205,6 +205,8 @@ QApplicationPrivate::~QApplicationPrivate() \brief The QApplication class manages the GUI application's control flow and main settings. + \inmodule QtWidgets + QApplication contains the main event loop, where all events from the window system and other sources are processed and dispatched. It also handles the application's initialization, finalization, and provides session @@ -4198,6 +4200,8 @@ bool QApplicationPrivate::notify_helper(QObject *receiver, QEvent * e) \class QSessionManager \brief The QSessionManager class provides access to the session manager. + \inmodule QtWidgets + 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, each of which has a particular state. The state of an application contains diff --git a/src/widgets/kernel/qboxlayout.cpp b/src/widgets/kernel/qboxlayout.cpp index dd69f3a7be..059c59fa1c 100644 --- a/src/widgets/kernel/qboxlayout.cpp +++ b/src/widgets/kernel/qboxlayout.cpp @@ -452,6 +452,7 @@ void QBoxLayoutPrivate::calcHfw(int w) vertically. \ingroup geomanagement + \inmodule QtWidgets QBoxLayout takes the space it gets (from its parent layout or from 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. \ingroup geomanagement + \inmodule QtWidgets This class is used to construct horizontal box layout objects. See QBoxLayout for details. @@ -1293,6 +1295,7 @@ QHBoxLayout::~QHBoxLayout() \brief The QVBoxLayout class lines up widgets vertically. \ingroup geomanagement + \inmodule QtWidgets This class is used to construct vertical box layout objects. See QBoxLayout for details. diff --git a/src/widgets/kernel/qdesktopwidget.qdoc b/src/widgets/kernel/qdesktopwidget.qdoc index f71155e117..4d63e2f466 100644 --- a/src/widgets/kernel/qdesktopwidget.qdoc +++ b/src/widgets/kernel/qdesktopwidget.qdoc @@ -31,6 +31,7 @@ \ingroup advanced \ingroup desktop + \inmodule QtWidgets Systems with more than one graphics card and monitor can manage the physical screen space available either as multiple desktops, or as a diff --git a/src/widgets/kernel/qformlayout.cpp b/src/widgets/kernel/qformlayout.cpp index 5c43acfe0a..6430472462 100644 --- a/src/widgets/kernel/qformlayout.cpp +++ b/src/widgets/kernel/qformlayout.cpp @@ -1007,7 +1007,7 @@ QStyle* QFormLayoutPrivate::getStyle() const \brief The QFormLayout class manages forms of input widgets and their associated labels. \ingroup geomanagement - + \inmodule QtWidgets QFormLayout is a convenience layout class that lays out its children in a two-column form. The left column consists of labels diff --git a/src/widgets/kernel/qgesture.cpp b/src/widgets/kernel/qgesture.cpp index 92f4c9cfc6..12a0eaf45a 100644 --- a/src/widgets/kernel/qgesture.cpp +++ b/src/widgets/kernel/qgesture.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE \class QGesture \since 4.6 \ingroup gestures + \inmodule QtWidgets \brief The QGesture class represents a gesture, containing properties that describe the corresponding user input. @@ -220,6 +221,7 @@ QGesture::GestureCancelPolicy QGesture::gestureCancelPolicy() const \since 4.6 \brief The QPanGesture class describes a panning gesture made by the user. \ingroup gestures + \inmodule QtWidgets \image pangesture.png @@ -336,6 +338,7 @@ void QPanGesture::setAcceleration(qreal value) \brief The QPinchGesture class describes a pinch gesture made by the user. \ingroup touch \ingroup gestures + \inmodule QtWidgets 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 @@ -600,6 +603,7 @@ void QPinchGesture::setRotationAngle(qreal value) \since 4.6 \brief The QSwipeGesture class describes a swipe gesture made by the user. \ingroup gestures + \inmodule QtWidgets \image swipegesture.png @@ -706,6 +710,7 @@ void QSwipeGesture::setSwipeAngle(qreal value) \since 4.6 \brief The QTapGesture class describes a tap gesture made by the user. \ingroup gestures + \inmodule QtWidgets For an overview of gesture handling in Qt and information on using gestures 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) gesture made by the user. \ingroup gestures + \inmodule QtWidgets For an overview of gesture handling in Qt and information on using gestures in your applications, see the \l{Gestures Programming} document. @@ -807,6 +813,7 @@ int QTapAndHoldGesturePrivate::Timeout = 700; // in ms \since 4.6 \ingroup events \ingroup gestures + \inmodule QtWidgets \brief The QGestureEvent class provides the description of triggered gestures. diff --git a/src/widgets/kernel/qgesturerecognizer.cpp b/src/widgets/kernel/qgesturerecognizer.cpp index 887617569d..98f8b0a758 100644 --- a/src/widgets/kernel/qgesturerecognizer.cpp +++ b/src/widgets/kernel/qgesturerecognizer.cpp @@ -53,6 +53,7 @@ QT_BEGIN_NAMESPACE \since 4.6 \brief The QGestureRecognizer class provides the infrastructure for gesture recognition. \ingroup gestures + \inmodule QtWidgets Gesture recognizers are responsible for creating and managing QGesture objects and monitoring input events sent to QWidget and QGraphicsObject subclasses. diff --git a/src/widgets/kernel/qgridlayout.cpp b/src/widgets/kernel/qgridlayout.cpp index 3fafb62444..9168346e30 100644 --- a/src/widgets/kernel/qgridlayout.cpp +++ b/src/widgets/kernel/qgridlayout.cpp @@ -980,7 +980,7 @@ QRect QGridLayoutPrivate::cellRect(int row, int col) const \brief The QGridLayout class lays out widgets in a grid. \ingroup geomanagement - + \inmodule QtWidgets QGridLayout takes the space made available to it (by its parent layout or by the parentWidget()), divides it up into rows and diff --git a/src/widgets/kernel/qguiplatformplugin.cpp b/src/widgets/kernel/qguiplatformplugin.cpp index 708859d811..09a364c150 100644 --- a/src/widgets/kernel/qguiplatformplugin.cpp +++ b/src/widgets/kernel/qguiplatformplugin.cpp @@ -116,8 +116,8 @@ QGuiPlatformPlugin *qt_guiPlatformPlugin() 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. - But full platform that are built on top of Qt may provide a plugin so 3rd party Qt application - running in the platform are integrated. + But full platforms that are built on top of Qt may provide a plugin so 3rd party Qt applications + running on the platform are integrated. */ /* diff --git a/src/widgets/kernel/qicon.cpp b/src/widgets/kernel/qicon.cpp index 73f8a2a360..e1ba8d4306 100644 --- a/src/widgets/kernel/qicon.cpp +++ b/src/widgets/kernel/qicon.cpp @@ -467,7 +467,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loaderV2, \ingroup painting \ingroup shared - + \inmodule QtWidgets A QIcon can generate smaller, larger, active, and disabled pixmaps from the set of pixmaps it is given. Such pixmaps are used by Qt diff --git a/src/widgets/kernel/qiconengine.cpp b/src/widgets/kernel/qiconengine.cpp index 8d71e4055a..52e8cfd384 100644 --- a/src/widgets/kernel/qiconengine.cpp +++ b/src/widgets/kernel/qiconengine.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \brief The QIconEngine class provides an abstract base class for QIcon renderers. \ingroup painting + \inmodule QtWidgets \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. \ingroup painting + \inmodule QtWidgets + \since 4.3 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 \since 4.5 + \inmodule QtWidgets + This struct represents arguments to virtual_hook() function when \a id parameter is QIconEngineV2::AvailableSizesHook. diff --git a/src/widgets/kernel/qiconengineplugin.cpp b/src/widgets/kernel/qiconengineplugin.cpp index e1389ae726..2775fb201d 100644 --- a/src/widgets/kernel/qiconengineplugin.cpp +++ b/src/widgets/kernel/qiconengineplugin.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \brief The QIconEnginePlugin class provides an abstract base for custom QIconEngine plugins. \ingroup plugins + \inmodule QtWidgets \bold {Use QIconEnginePluginV2 instead.} @@ -109,6 +110,8 @@ QIconEnginePlugin::~QIconEnginePlugin() \brief The QIconEnginePluginV2 class provides an abstract base for custom QIconEngineV2 plugins. \ingroup plugins + \inmodule QtWidgets + \since 4.3 Icon engine plugins produces \l{QIconEngine}s for \l{QIcon}s; an diff --git a/src/widgets/kernel/qinputcontext.cpp b/src/widgets/kernel/qinputcontext.cpp index 05ed9369f6..7724773478 100644 --- a/src/widgets/kernel/qinputcontext.cpp +++ b/src/widgets/kernel/qinputcontext.cpp @@ -78,6 +78,7 @@ QT_BEGIN_NAMESPACE \brief The QInputContext class abstracts the input method dependent data and composing state. \ingroup i18n + \inmodule QtWidgets An input method is responsible for inputting complex text that cannot be inputted via simple keymap. It converts a sequence of input diff --git a/src/widgets/kernel/qlayout.cpp b/src/widgets/kernel/qlayout.cpp index 68c1dd9c67..ebf9cf6cae 100644 --- a/src/widgets/kernel/qlayout.cpp +++ b/src/widgets/kernel/qlayout.cpp @@ -76,6 +76,7 @@ static int menuBarHeightForWidth(QWidget *menubar, int w) \brief The QLayout class is the base class of geometry managers. \ingroup geomanagement + \inmodule QtWidgets This is an abstract base class inherited by the concrete classes QBoxLayout, QGridLayout, QFormLayout, and QStackedLayout. diff --git a/src/widgets/kernel/qlayoutitem.cpp b/src/widgets/kernel/qlayoutitem.cpp index e3857454ad..5fcda5dfea 100644 --- a/src/widgets/kernel/qlayoutitem.cpp +++ b/src/widgets/kernel/qlayoutitem.cpp @@ -88,6 +88,7 @@ QSizePolicy::operator QVariant() const QLayout manipulates. \ingroup geomanagement + \inmodule QtWidgets This is used by custom layouts. @@ -118,6 +119,8 @@ QSizePolicy::operator QVariant() const \ingroup geomanagement \brief The QSpacerItem class provides blank space in a layout. + \inmodule QtWidgets + Normally, you don't need to use this class directly. Qt's built-in layout managers provide the following functions for manipulating empty space in layouts: @@ -145,6 +148,8 @@ QSizePolicy::operator QVariant() const \ingroup geomanagement \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 built-in layout managers provide the following functions for manipulating widgets in layouts: diff --git a/src/widgets/kernel/qsizepolicy.qdoc b/src/widgets/kernel/qsizepolicy.qdoc index f3e5e9f5e8..e4d1cc137c 100644 --- a/src/widgets/kernel/qsizepolicy.qdoc +++ b/src/widgets/kernel/qsizepolicy.qdoc @@ -31,6 +31,7 @@ and vertical resizing policy. \ingroup geomanagement + \inmodule QtWidgets 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 diff --git a/src/widgets/kernel/qsound.cpp b/src/widgets/kernel/qsound.cpp index 255ff5d86d..c6ab9809fb 100644 --- a/src/widgets/kernel/qsound.cpp +++ b/src/widgets/kernel/qsound.cpp @@ -106,7 +106,7 @@ public: \brief The QSound class provides access to the platform audio facilities. \ingroup multimedia - + \inmodule QtWidgets Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most diff --git a/src/widgets/kernel/qstackedlayout.cpp b/src/widgets/kernel/qstackedlayout.cpp index c75f430fb8..950db2178c 100644 --- a/src/widgets/kernel/qstackedlayout.cpp +++ b/src/widgets/kernel/qstackedlayout.cpp @@ -65,6 +65,7 @@ public: only one widget is visible at a time. \ingroup geomanagement + \inmodule QtWidgets QStackedLayout can be used to create a user interface similar to the one provided by QTabWidget. There is also a convenience diff --git a/src/widgets/kernel/qtooltip.cpp b/src/widgets/kernel/qtooltip.cpp index f880243a7e..fb1b67922d 100644 --- a/src/widgets/kernel/qtooltip.cpp +++ b/src/widgets/kernel/qtooltip.cpp @@ -73,7 +73,7 @@ QT_BEGIN_NAMESPACE widget. \ingroup helpsystem - + \inmodule QtWidgets The tip is a short piece of text reminding the user of the widget's function. It is drawn immediately below the given diff --git a/src/widgets/kernel/qwhatsthis.cpp b/src/widgets/kernel/qwhatsthis.cpp index 2032b4add7..11b4f0cd84 100644 --- a/src/widgets/kernel/qwhatsthis.cpp +++ b/src/widgets/kernel/qwhatsthis.cpp @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE widget, i.e. answering the question "What's This?". \ingroup helpsystem - + \inmodule QtWidgets "What's This?" help is part of an application's online help system, and provides users with information about the diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp index 981defeb07..af5e2ef065 100644 --- a/src/widgets/kernel/qwidget.cpp +++ b/src/widgets/kernel/qwidget.cpp @@ -511,6 +511,7 @@ void QWidget::setAutoFillBackground(bool enabled) \brief The QWidget class is the base class of all user interface objects. \ingroup basicwidgets + \inmodule QtWidgets 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 diff --git a/src/widgets/kernel/qwidgetaction.cpp b/src/widgets/kernel/qwidgetaction.cpp index 03acb7836b..a2c2477922 100644 --- a/src/widgets/kernel/qwidgetaction.cpp +++ b/src/widgets/kernel/qwidgetaction.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE as toolbars. \ingroup mainwindow-classes + \inmodule QtWidgets Most actions in an application are represented as items in menus or buttons in toolbars. However sometimes more complex widgets are diff --git a/src/widgets/platforms/mac/qmime_mac.cpp b/src/widgets/platforms/mac/qmime_mac.cpp index f2611585fa..a9843b7e87 100644 --- a/src/widgets/platforms/mac/qmime_mac.cpp +++ b/src/widgets/platforms/mac/qmime_mac.cpp @@ -134,6 +134,7 @@ CFStringRef qt_mac_mime_typeUTI = CFSTR("com.pasteboard.trolltech.marker"); \since 4.2 \ingroup draganddrop + \inmodule QtWidgets Qt's drag and drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol. On diff --git a/src/widgets/platforms/win/qmime_win.cpp b/src/widgets/platforms/win/qmime_win.cpp index c974d53163..b07214da82 100644 --- a/src/widgets/platforms/win/qmime_win.cpp +++ b/src/widgets/platforms/win/qmime_win.cpp @@ -220,6 +220,7 @@ Q_GLOBAL_STATIC(QWindowsMimeList, theMimeList); \class QWindowsMime \brief The QWindowsMime class maps open-standard MIME to Window Clipboard formats. \ingroup draganddrop + \inmodule QtWidgets Qt's drag-and-drop and clipboard facilities use the MIME standard. On X11, this maps trivially to the Xdnd protocol, but on Windows diff --git a/src/widgets/platforms/x11/qx11embed_x11.cpp b/src/widgets/platforms/x11/qx11embed_x11.cpp index 1fa658d0df..3213b97629 100644 --- a/src/widgets/platforms/x11/qx11embed_x11.cpp +++ b/src/widgets/platforms/x11/qx11embed_x11.cpp @@ -77,6 +77,7 @@ QT_BEGIN_NAMESPACE /*! \class QX11EmbedWidget \ingroup advanced + \inmodule QtWidgets \brief The QX11EmbedWidget class provides an XEmbed client widget. @@ -132,6 +133,7 @@ QT_BEGIN_NAMESPACE /*! \class QX11EmbedContainer \ingroup advanced + \inmodule QtWidgets \brief The QX11EmbedContainer class provides an XEmbed container widget. diff --git a/src/widgets/platforms/x11/qx11info_x11.cpp b/src/widgets/platforms/x11/qx11info_x11.cpp index f359b610e1..88092b3bac 100644 --- a/src/widgets/platforms/x11/qx11info_x11.cpp +++ b/src/widgets/platforms/x11/qx11info_x11.cpp @@ -52,6 +52,7 @@ QT_BEGIN_NAMESPACE configuration. \ingroup shared + \inmodule QtWidgets The class provides two APIs: a set of non-static functions that provide information about a specific widget or pixmap, and a set diff --git a/src/widgets/s60framework/qs60mainapplication.cpp b/src/widgets/s60framework/qs60mainapplication.cpp index 9217ba80be..6be08957fe 100644 --- a/src/widgets/s60framework/qs60mainapplication.cpp +++ b/src/widgets/s60framework/qs60mainapplication.cpp @@ -67,6 +67,8 @@ CApaApplication *newS60Application() \since 4.6 \brief The QS60MainApplication class provides support for migration from S60. + \inmodule QtWidgets + \warning This class is provided only to get access to S60 specific functionality in the application framework classes. It is not portable. We strongly recommend against using it in new applications. diff --git a/src/widgets/s60framework/qs60mainappui.cpp b/src/widgets/s60framework/qs60mainappui.cpp index 05e538e65a..5759bc68f6 100644 --- a/src/widgets/s60framework/qs60mainappui.cpp +++ b/src/widgets/s60framework/qs60mainappui.cpp @@ -71,6 +71,8 @@ QT_BEGIN_NAMESPACE \since 4.6 \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 functionality in the application framework classes. It is not portable. We strongly recommend against using it in new applications. diff --git a/src/widgets/s60framework/qs60maindocument.cpp b/src/widgets/s60framework/qs60maindocument.cpp index eb1d87c9dc..20f9c4de75 100644 --- a/src/widgets/s60framework/qs60maindocument.cpp +++ b/src/widgets/s60framework/qs60maindocument.cpp @@ -54,6 +54,8 @@ QT_BEGIN_NAMESPACE \since 4.6 \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 functionality in the application framework classes. It is not portable. We strongly recommend against using it in new applications. diff --git a/src/widgets/statemachine/qkeyeventtransition.cpp b/src/widgets/statemachine/qkeyeventtransition.cpp index 3a4292628e..b1ff2e33b2 100644 --- a/src/widgets/statemachine/qkeyeventtransition.cpp +++ b/src/widgets/statemachine/qkeyeventtransition.cpp @@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE \since 4.6 \ingroup statemachine + \inmodule QtWidgets QKeyEventTransition is part of \l{The State Machine Framework}. diff --git a/src/widgets/statemachine/qmouseeventtransition.cpp b/src/widgets/statemachine/qmouseeventtransition.cpp index 9440a25f37..416529bddd 100644 --- a/src/widgets/statemachine/qmouseeventtransition.cpp +++ b/src/widgets/statemachine/qmouseeventtransition.cpp @@ -57,6 +57,7 @@ QT_BEGIN_NAMESPACE \since 4.6 \ingroup statemachine + \inmodule QtWidgets QMouseEventTransition is part of \l{The State Machine Framework}. diff --git a/src/widgets/styles/qcdestyle.cpp b/src/widgets/styles/qcdestyle.cpp index bb97b8a8a1..426ab19007 100644 --- a/src/widgets/styles/qcdestyle.cpp +++ b/src/widgets/styles/qcdestyle.cpp @@ -73,6 +73,7 @@ QT_BEGIN_NAMESPACE \brief The QCDEStyle class provides a CDE look and feel. \ingroup appearance + \inmodule QtWidgets This style provides a slightly improved Motif look similar to some versions of the Common Desktop Environment (CDE). The main diff --git a/src/widgets/styles/qcleanlooksstyle.cpp b/src/widgets/styles/qcleanlooksstyle.cpp index 7ddac81be8..567efa8851 100644 --- a/src/widgets/styles/qcleanlooksstyle.cpp +++ b/src/widgets/styles/qcleanlooksstyle.cpp @@ -593,6 +593,8 @@ static void qt_cleanlooks_draw_mdibutton(QPainter *painter, const QStyleOptionTi Clearlooks style available in GNOME. \since 4.2 + \inmodule QtWidgets + The Cleanlooks style provides a look and feel for widgets that closely resembles the Clearlooks style, introduced by Richard Stellingwerff and Daniel Borgmann. diff --git a/src/widgets/styles/qcommonstyle.cpp b/src/widgets/styles/qcommonstyle.cpp index 8dcbb3105d..31311a50f4 100644 --- a/src/widgets/styles/qcommonstyle.cpp +++ b/src/widgets/styles/qcommonstyle.cpp @@ -96,6 +96,7 @@ QT_BEGIN_NAMESPACE \brief The QCommonStyle class encapsulates the common Look and Feel of a GUI. \ingroup appearance + \inmodule QtWidgets 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 diff --git a/src/widgets/styles/qdrawutil.cpp b/src/widgets/styles/qdrawutil.cpp index 94cec208d0..5cd7bae658 100644 --- a/src/widgets/styles/qdrawutil.cpp +++ b/src/widgets/styles/qdrawutil.cpp @@ -747,8 +747,12 @@ void qDrawPlainRect(QPainter *p, const QRect &r, const QColor &c, \class QTileRules \since 4.6 - Holds the rules used to draw a pixmap or image split into nine segments, - similar to \l{http://www.w3.org/TR/css3-background/}{CSS3 border-images}. + \inmodule QtWidgets + + \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 */ diff --git a/src/widgets/styles/qgtkstyle.cpp b/src/widgets/styles/qgtkstyle.cpp index 32e04928da..da39c95a58 100644 --- a/src/widgets/styles/qgtkstyle.cpp +++ b/src/widgets/styles/qgtkstyle.cpp @@ -170,6 +170,8 @@ static GdkColor fromQColor(const QColor &color) \brief The QGtkStyle class provides a widget style rendered by GTK+ \since 4.5 + \inmodule QtWidgets + The QGtkStyle style provides a look and feel that integrates well into GTK-based desktop environments such as the XFCe and GNOME. diff --git a/src/widgets/styles/qmacstyle.qdoc b/src/widgets/styles/qmacstyle.qdoc index e6cb79cc53..709332aa1d 100644 --- a/src/widgets/styles/qmacstyle.qdoc +++ b/src/widgets/styles/qmacstyle.qdoc @@ -31,6 +31,7 @@ \brief The QMacStyle class provides a Mac OS X style using the Apple Appearance Manager. \ingroup appearance + \inmodule QtWidgets This class is implemented as a wrapper to the HITheme APIs, allowing applications to be styled according to the current diff --git a/src/widgets/styles/qmotifstyle.cpp b/src/widgets/styles/qmotifstyle.cpp index c24ff4ff59..c1c1ffccd5 100644 --- a/src/widgets/styles/qmotifstyle.cpp +++ b/src/widgets/styles/qmotifstyle.cpp @@ -94,6 +94,7 @@ static const int motifCheckMarkSpace = 16; \brief The QMotifStyle class provides Motif look and feel. \ingroup appearance + \inmodule QtWidgets This class implements the Motif look and feel. It closely resembles the original Motif look as defined by the Open Group, diff --git a/src/widgets/styles/qplastiquestyle.cpp b/src/widgets/styles/qplastiquestyle.cpp index efff1a5bbe..278ec2b9cb 100644 --- a/src/widgets/styles/qplastiquestyle.cpp +++ b/src/widgets/styles/qplastiquestyle.cpp @@ -1019,6 +1019,8 @@ QPlastiqueStylePrivate::~QPlastiqueStylePrivate() \brief The QPlastiqueStyle class provides a widget style similar to the Plastik style available in KDE. + \inmodule QtWidgets + The Plastique style provides a default look and feel for widgets on X11 that closely resembles the Plastik style, introduced by Sandro Giessl in KDE 3.2. diff --git a/src/widgets/styles/qproxystyle.cpp b/src/widgets/styles/qproxystyle.cpp index 476a758992..b41e85f31c 100644 --- a/src/widgets/styles/qproxystyle.cpp +++ b/src/widgets/styles/qproxystyle.cpp @@ -58,6 +58,8 @@ QT_BEGIN_NAMESPACE \since 4.6 + \inmodule QtWidgets + A QProxyStyle wraps a QStyle (usually the default system style) for the purpose of dynamically overriding painting or other specific style behavior. diff --git a/src/widgets/styles/qs60style.cpp b/src/widgets/styles/qs60style.cpp index 634cf00536..df20265c1e 100644 --- a/src/widgets/styles/qs60style.cpp +++ b/src/widgets/styles/qs60style.cpp @@ -979,6 +979,7 @@ QPixmap QS60StylePrivate::placeHolderTexture() \brief The QS60Style class provides a look and feel suitable for applications on S60. \since 4.6 \ingroup appearance + \inmodule QtWidgets \sa QMacStyle, QWindowsStyle, QWindowsXPStyle, QWindowsVistaStyle, QPlastiqueStyle, QCleanlooksStyle, QMotifStyle */ diff --git a/src/widgets/styles/qstyle.cpp b/src/widgets/styles/qstyle.cpp index c6e4b488c1..32fe0ce923 100644 --- a/src/widgets/styles/qstyle.cpp +++ b/src/widgets/styles/qstyle.cpp @@ -86,6 +86,7 @@ static int unpackControlTypes(QSizePolicy::ControlTypes controls, QSizePolicy::C \brief The QStyle class is an abstract base class that encapsulates the look and feel of a GUI. \ingroup appearance + \inmodule QtWidgets Qt contains a set of QStyle subclasses that emulate the styles of the different platforms supported by Qt (QWindowsStyle, diff --git a/src/widgets/styles/qstylefactory.cpp b/src/widgets/styles/qstylefactory.cpp index 83b67484b8..8c1b9cb7e1 100644 --- a/src/widgets/styles/qstylefactory.cpp +++ b/src/widgets/styles/qstylefactory.cpp @@ -91,6 +91,7 @@ Q_GLOBAL_STATIC_WITH_ARGS(QFactoryLoader, loader, \brief The QStyleFactory class creates QStyle objects. \ingroup appearance + \inmodule QtWidgets The QStyle class is an abstract base class that encapsulates the look and feel of a GUI. QStyleFactory creates a QStyle object diff --git a/src/widgets/styles/qstyleoption.cpp b/src/widgets/styles/qstyleoption.cpp index 90cfd427ed..01e3f0e384 100644 --- a/src/widgets/styles/qstyleoption.cpp +++ b/src/widgets/styles/qstyleoption.cpp @@ -55,6 +55,7 @@ QT_BEGIN_NAMESPACE \brief The QStyleOption class stores the parameters used by QStyle functions. \ingroup appearance + \inmodule QtWidgets QStyleOption and its subclasses contain all the information that QStyle functions need to draw a graphical element. @@ -367,6 +368,8 @@ QStyleOption &QStyleOption::operator=(const QStyleOption &other) \brief The QStyleOptionFocusRect class is used to describe the parameters for drawing a focus rectangle with QStyle. + \inmodule QtWidgets + For performance reasons, the access to the member variables is direct (i.e., using the \c . or \c -> operator). This low-level feel makes the structures straightforward to use and emphasizes that @@ -449,6 +452,8 @@ QStyleOptionFocusRect::QStyleOptionFocusRect(int version) \brief The QStyleOptionFrame class is used to describe the parameters for drawing a frame. + \inmodule QtWidgets + QStyleOptionFrame is used for drawing several built-in Qt widgets, including QFrame, QGroupBox, QLineEdit, and QMenu. Note that to describe the parameters necessary for drawing a frame in Qt 4.1 or @@ -556,6 +561,7 @@ QStyleOptionFrame::QStyleOptionFrame(int version) parameters necessary for drawing a frame in Qt 4.1 or above. \since 4.1 + \inmodule QtWidgets QStyleOptionFrameV2 inherits QStyleOptionFrame which is used for drawing several built-in Qt widgets, including QFrame, QGroupBox, @@ -689,6 +695,7 @@ QStyleOptionFrameV2 &QStyleOptionFrameV2::operator=(const QStyleOptionFrame &oth parameters necessary for drawing a frame in Qt 4.1 or above. \since 4.5 + \inmodule QtWidgets QStyleOptionFrameV3 inherits QStyleOptionFrameV2 @@ -793,6 +800,7 @@ QStyleOptionFrameV3 &QStyleOptionFrameV3::operator=(const QStyleOptionFrame &oth \brief The QStyleOptionViewItemV2 class is used to describe the parameters necessary for drawing a frame in Qt 4.2 or above. \since 4.2 + \inmodule QtWidgets QStyleOptionViewItemV2 inherits QStyleOptionViewItem. @@ -914,6 +922,7 @@ QStyleOptionViewItemV2 &QStyleOptionViewItemV2::operator=(const QStyleOptionView \brief The QStyleOptionViewItemV3 class is used to describe the parameters necessary for drawing a frame in Qt 4.3 or above. \since 4.3 + \inmodule QtWidgets QStyleOptionViewItemV3 inherits QStyleOptionViewItem. @@ -1000,6 +1009,7 @@ QStyleOptionViewItemV3::QStyleOptionViewItemV3(int version) \brief The QStyleOptionViewItemV4 class is used to describe the parameters necessary for drawing a frame in Qt 4.4 or above. \since 4.4 + \inmodule QtWidgets QStyleOptionViewItemV4 inherits QStyleOptionViewItemV3. @@ -1160,6 +1170,7 @@ QStyleOptionViewItemV4::QStyleOptionViewItemV4(int version) drawing a group box. \since 4.1 + \inmodule QtWidgets QStyleOptionButton contains all the information that QStyle functions need the various graphical elements of a group box. @@ -1295,6 +1306,8 @@ QStyleOptionGroupBox::QStyleOptionGroupBox(int version) \brief The QStyleOptionHeader class is used to describe the parameters for drawing a header. + \inmodule QtWidgets + QStyleOptionHeader contains all the information that QStyle functions need to draw the item views' header pane, header sort arrow, and header label. @@ -1480,6 +1493,8 @@ QStyleOptionHeader::QStyleOptionHeader(int version) \brief The QStyleOptionButton class is used to describe the parameters for drawing buttons. + \inmodule QtWidgets + QStyleOptionButton contains all the information that QStyle functions need to draw graphical elements like QPushButton, QCheckBox, and QRadioButton. @@ -1604,6 +1619,7 @@ QStyleOptionButton::QStyleOptionButton(int version) parameters for drawing a toolbar. \since 4.1 + \inmodule QtWidgets QStyleOptionToolBar contains all the information that QStyle functions need to draw QToolBar. @@ -1789,6 +1805,8 @@ QStyleOptionToolBar::QStyleOptionToolBar(int version) \brief The QStyleOptionTab class is used to describe the parameters for drawing a tab bar. + \inmodule QtWidgets + The QStyleOptionTab class is used for drawing several built-in Qt widgets including \l QTabBar and the panel for \l QTabWidget. Note that to describe the parameters necessary for drawing a frame in @@ -1979,6 +1997,7 @@ QStyleOptionTab::QStyleOptionTab(int version) parameters necessary for drawing a tabs in Qt 4.1 or above. \since 4.1 + \inmodule QtWidgets An instance of the QStyleOptionTabV2 class has \l{QStyleOption::type} {type} \l SO_Tab and @@ -2101,6 +2120,7 @@ QStyleOptionTabV2 &QStyleOptionTabV2::operator=(const QStyleOptionTab &other) parameters necessary for drawing a tabs in Qt 4.5 or above. \since 4.5 + \inmodule QtWidgets An instance of the QStyleOptionTabV3 class has \l{QStyleOption::type} {type} \l SO_Tab and @@ -2250,6 +2270,8 @@ QStyleOptionTabV3 &QStyleOptionTabV3::operator=(const QStyleOptionTab &other) \brief The QStyleOptionProgressBar class is used to describe the parameters necessary for drawing a progress bar. + \inmodule QtWidgets + Since Qt 4.1, Qt uses the QStyleOptionProgressBarV2 subclass for drawing QProgressBar. @@ -2397,6 +2419,7 @@ QStyleOptionProgressBar::QStyleOptionProgressBar(int version) parameters necessary for drawing a progress bar in Qt 4.1 or above. \since 4.1 + \inmodule QtWidgets An instance of this class has \l{QStyleOption::type} {type} SO_ProgressBar and \l{QStyleOption::version} {version} 2. @@ -2565,6 +2588,8 @@ QStyleOptionProgressBarV2 &QStyleOptionProgressBarV2::operator=(const QStyleOpti \brief The QStyleOptionMenuItem class is used to describe the parameter necessary for drawing a menu item. + \inmodule QtWidgets + QStyleOptionMenuItem contains all the information that QStyle functions need to draw the menu items from \l QMenu. It is also used for drawing other menu-related widgets. @@ -2763,6 +2788,8 @@ QStyleOptionMenuItem::QStyleOptionMenuItem(int version) \brief The QStyleOptionComplex class is used to hold parameters that are common to all complex controls. + \inmodule QtWidgets + This class is not used on its own. Instead it is used to derive other complex control options, for example QStyleOptionSlider and QStyleOptionSpinBox. @@ -2852,6 +2879,8 @@ QStyleOptionComplex::QStyleOptionComplex(int version, int type) \brief The QStyleOptionSlider class is used to describe the parameters needed for drawing a slider. + \inmodule QtWidgets + QStyleOptionSlider contains all the information that QStyle functions need to draw QSlider and QScrollBar. @@ -3049,6 +3078,8 @@ QStyleOptionSlider::QStyleOptionSlider(int version) \brief The QStyleOptionSpinBox class is used to describe the parameters necessary for drawing a spin box. + \inmodule QtWidgets + QStyleOptionSpinBox contains all the information that QStyle functions need to draw QSpinBox and QDateTimeEdit. @@ -3152,6 +3183,8 @@ QStyleOptionSpinBox::QStyleOptionSpinBox(int version) \brief The QStyleOptionQ3ListViewItem class is used to describe an item drawn in a Q3ListView. + \inmodule QtWidgets + This class is used for drawing the compatibility Q3ListView's items. \bold {It is not recommended for new classes}. @@ -3287,6 +3320,8 @@ QStyleOptionQ3ListViewItem::QStyleOptionQ3ListViewItem(int version) \brief The QStyleOptionQ3ListView class is used to describe the parameters for drawing a Q3ListView. + \inmodule QtWidgets + This class is used for drawing the compatibility Q3ListView. \bold {It is not recommended for new classes}. @@ -3431,6 +3466,8 @@ QStyleOptionQ3ListView::QStyleOptionQ3ListView(int version) \brief The QStyleOptionQ3DockWindow class is used to describe the parameters for drawing various parts of a Q3DockWindow. + \inmodule QtWidgets + This class is used for drawing the old Q3DockWindow and its parts. \bold {It is not recommended for new classes}. @@ -3522,6 +3559,8 @@ QStyleOptionQ3DockWindow::QStyleOptionQ3DockWindow(int version) \brief The QStyleOptionDockWidget class is used to describe the parameters for drawing a dock widget. + \inmodule QtWidgets + QStyleOptionDockWidget contains all the information that QStyle functions need to draw graphical elements like QDockWidget. @@ -3653,6 +3692,8 @@ QStyleOptionDockWidgetV2::QStyleOptionDockWidgetV2(int version) \brief The QStyleOptionToolButton class is used to describe the parameters for drawing a tool button. + \inmodule QtWidgets + QStyleOptionToolButton contains all the information that QStyle functions need to draw QToolButton. @@ -3815,6 +3856,8 @@ QStyleOptionToolButton::QStyleOptionToolButton(int version) \brief The QStyleOptionComboBox class is used to describe the parameter for drawing a combobox. + \inmodule QtWidgets + QStyleOptionButton contains all the information that QStyle functions need to draw QComboBox. @@ -3941,6 +3984,8 @@ QStyleOptionComboBox::QStyleOptionComboBox(int version) \brief The QStyleOptionToolBox class is used to describe the parameters needed for drawing a tool box. + \inmodule QtWidgets + QStyleOptionToolBox contains all the information that QStyle functions need to draw QToolBox. @@ -4030,6 +4075,8 @@ QStyleOptionToolBox::QStyleOptionToolBox(int version) \brief The QStyleOptionToolBoxV2 class is used to describe the parameters necessary for drawing a frame in Qt 4.3 or above. \since 4.3 + \inmodule QtWidgets + QStyleOptionToolBoxV2 inherits QStyleOptionToolBox which is used for drawing the tabs in a QToolBox. @@ -4168,6 +4215,8 @@ QStyleOptionToolBoxV2 &QStyleOptionToolBoxV2::operator=(const QStyleOptionToolBo \brief The QStyleOptionRubberBand class is used to describe the parameters needed for drawing a rubber band. + \inmodule QtWidgets + QStyleOptionRubberBand contains all the information that QStyle functions need to draw QRubberBand. @@ -4257,6 +4306,8 @@ QStyleOptionRubberBand::QStyleOptionRubberBand(int version) \brief The QStyleOptionTitleBar class is used to describe the parameters for drawing a title bar. + \inmodule QtWidgets + QStyleOptionTitleBar contains all the information that QStyle functions need to draw the title bar of a QMdiSubWindow. @@ -4366,6 +4417,8 @@ QStyleOptionTitleBar::QStyleOptionTitleBar(int version) \brief The QStyleOptionViewItem class is used to describe the parameters used to draw an item in a view widget. + \inmodule QtWidgets + QStyleOptionViewItem contains all the information that QStyle functions need to draw the items for Qt's model/view classes. @@ -4547,6 +4600,8 @@ QStyleOptionViewItem::QStyleOptionViewItem(int version) \brief The QStyleOptionTabWidgetFrame class is used to describe the parameters for drawing the frame around a tab widget. + \inmodule QtWidgets + QStyleOptionTabWidgetFrame contains all the information that QStyle functions need to draw the frame around QTabWidget. @@ -4664,6 +4719,8 @@ QStyleOptionTabWidgetFrame::QStyleOptionTabWidgetFrame(int version) \brief The QStyleOptionTabWidgetFrameV2 class is used to describe the parameters for drawing the frame around a tab widget. + \inmodule QtWidgets + QStyleOptionTabWidgetFrameV2 contains all the information that QStyle functions need to draw the frame around QTabWidget. @@ -4787,6 +4844,8 @@ QStyleOptionTabWidgetFrameV2 &QStyleOptionTabWidgetFrameV2::operator=(const QSty the base of a tab bar, i.e. the part that the tab bar usually overlaps with. + \inmodule QtWidgets + QStyleOptionTabBarBase contains all the information that QStyle functions need to draw the tab bar base. Note that this is only drawn for a standalone QTabBar (one that isn't part of a @@ -4886,6 +4945,7 @@ QStyleOptionTabBarBase::QStyleOptionTabBarBase(int version) the base of a tab bar, i.e. the part that the tab bar usually overlaps with. \since 4.5 + \inmodule QtWidgets QStyleOptionTabBarBase contains all the information that QStyle functions need to draw the tab bar base. @@ -4978,6 +5038,7 @@ QStyleOptionTabBarBaseV2::QStyleOptionTabBarBaseV2(int version) \brief The QStyleOptionSizeGrip class is used to describe the parameter for drawing a size grip. \since 4.2 + \inmodule QtWidgets QStyleOptionButton contains all the information that QStyle functions need to draw QSizeGrip. @@ -5059,6 +5120,7 @@ QStyleOptionSizeGrip::QStyleOptionSizeGrip(int version) the parameters needed to draw a QGraphicsItem. \since 4.2 \ingroup graphicsview-api + \inmodule QtWidgets For performance reasons, the access to the member variables is direct (i.e., using the \c . or \c -> operator). This low-level feel @@ -5197,6 +5259,7 @@ qreal QStyleOptionGraphicsItem::levelOfDetailFromTransform(const QTransform &wor than basic data types. \ingroup appearance + \inmodule QtWidgets QStyleHintReturn and its subclasses are used to pass information from a style back to the querying widget. This is most useful @@ -5294,6 +5357,7 @@ QStyleHintReturn::~QStyleHintReturn() \brief The QStyleHintReturnMask class provides style hints that return a QRegion. \ingroup appearance + \inmodule QtWidgets \omit ### --Sam @@ -5350,6 +5414,7 @@ QStyleHintReturnMask::QStyleHintReturnMask() : QStyleHintReturn(Version, Type) \brief The QStyleHintReturnVariant class provides style hints that return a QVariant. \since 4.3 \ingroup appearance + \inmodule QtWidgets */ /*! diff --git a/src/widgets/styles/qstylepainter.cpp b/src/widgets/styles/qstylepainter.cpp index 180499d791..3dc3f9dce7 100644 --- a/src/widgets/styles/qstylepainter.cpp +++ b/src/widgets/styles/qstylepainter.cpp @@ -51,6 +51,7 @@ QT_BEGIN_NAMESPACE \ingroup appearance \ingroup painting + \inmodule QtWidgets QStylePainter extends QPainter with a set of high-level \c draw...() functions implemented on top of QStyle's API. The diff --git a/src/widgets/styles/qstyleplugin.cpp b/src/widgets/styles/qstyleplugin.cpp index bb345c4bf1..836f388c23 100644 --- a/src/widgets/styles/qstyleplugin.cpp +++ b/src/widgets/styles/qstyleplugin.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \brief The QStylePlugin class provides an abstract base for custom QStyle plugins. \ingroup plugins + \inmodule QtWidgets QStylePlugin is a simple plugin interface that makes it easy to create custom styles that can be loaded dynamically into diff --git a/src/widgets/styles/qwindowsstyle.cpp b/src/widgets/styles/qwindowsstyle.cpp index 7b2fbd6306..7e10b41c70 100644 --- a/src/widgets/styles/qwindowsstyle.cpp +++ b/src/widgets/styles/qwindowsstyle.cpp @@ -247,6 +247,7 @@ bool QWindowsStyle::eventFilter(QObject *o, QEvent *e) \brief The QWindowsStyle class provides a Microsoft Windows-like look and feel. \ingroup appearance + \inmodule QtWidgets This style is Qt's default GUI style on Windows. diff --git a/src/widgets/styles/qwindowsvistastyle.cpp b/src/widgets/styles/qwindowsvistastyle.cpp index 55e83f79fa..025055c14b 100644 --- a/src/widgets/styles/qwindowsvistastyle.cpp +++ b/src/widgets/styles/qwindowsvistastyle.cpp @@ -146,6 +146,7 @@ bool QWindowsVistaStylePrivate::useVista() \brief The QWindowsVistaStyle class provides a look and feel suitable for applications on Microsoft Windows Vista. \since 4.3 \ingroup appearance + \inmodule QtWidgets \warning This style is only available on the Windows Vista platform because it makes use of Windows Vista's style engine. diff --git a/src/widgets/styles/qwindowsxpstyle.cpp b/src/widgets/styles/qwindowsxpstyle.cpp index d36de417ad..57f9ca42e6 100644 --- a/src/widgets/styles/qwindowsxpstyle.cpp +++ b/src/widgets/styles/qwindowsxpstyle.cpp @@ -1110,6 +1110,7 @@ void QWindowsXPStylePrivate::drawBackgroundThruNativeBuffer(XPThemeData &themeDa \brief The QWindowsXPStyle class provides a Microsoft Windows XP-like look and feel. \ingroup appearance + \inmodule QtWidgets \warning This style is only available on the Windows XP platform because it makes use of Windows XP's style engine. diff --git a/src/widgets/symbian/qsymbianevent.cpp b/src/widgets/symbian/qsymbianevent.cpp index f6b2185405..a4e8e01297 100644 --- a/src/widgets/symbian/qsymbianevent.cpp +++ b/src/widgets/symbian/qsymbianevent.cpp @@ -50,6 +50,7 @@ QT_BEGIN_NAMESPACE \class QSymbianEvent \brief The QSymbianEvent class contains a Symbian event of any type. \since 4.6 + \inmodule QtWidgets The class is used as a generic container type for all types of Symbian events. diff --git a/src/widgets/to_be_moved/qshortcut.cpp b/src/widgets/to_be_moved/qshortcut.cpp index 0694ec85d8..041bde30b1 100644 --- a/src/widgets/to_be_moved/qshortcut.cpp +++ b/src/widgets/to_be_moved/qshortcut.cpp @@ -63,7 +63,7 @@ QT_BEGIN_NAMESPACE \brief The QShortcut class is used to create keyboard shortcuts. \ingroup events - + \inmodule QtWidgets The QShortcut class provides a way of connecting keyboard shortcuts to Qt's \l{signals and slots} mechanism, so that diff --git a/src/widgets/util/qcolormap.qdoc b/src/widgets/util/qcolormap.qdoc index 99b97a54b4..88deabcfd6 100644 --- a/src/widgets/util/qcolormap.qdoc +++ b/src/widgets/util/qcolormap.qdoc @@ -28,6 +28,7 @@ /*! \class QColormap \ingroup painting + \inmodule QtWidgets \brief The QColormap class maps device independent QColors to device dependent pixel values. diff --git a/src/widgets/util/qcompleter.cpp b/src/widgets/util/qcompleter.cpp index d1ec03f1e4..39b7faf57f 100644 --- a/src/widgets/util/qcompleter.cpp +++ b/src/widgets/util/qcompleter.cpp @@ -44,6 +44,8 @@ \brief The QCompleter class provides completions based on an item model. \since 4.2 + \inmodule QtWidgets + You can use QCompleter to provide auto completions in any Qt widget, such as QLineEdit and QComboBox. When the user starts typing a word, QCompleter suggests possible ways of diff --git a/src/widgets/util/qscroller.cpp b/src/widgets/util/qscroller.cpp index 7ad726228d..2ab19c40ab 100644 --- a/src/widgets/util/qscroller.cpp +++ b/src/widgets/util/qscroller.cpp @@ -238,6 +238,8 @@ private: \brief The QScroller class enables kinetic scrolling for any scrolling widget or graphics item. \since 4.8 + \inmodule QtWidgets + With kinetic scrolling, the user can push the widget in a given direction and it will continue to scroll in this direction until it is stopped either by the user or by friction. Aspects of inertia, friction diff --git a/src/widgets/util/qscrollerproperties.cpp b/src/widgets/util/qscrollerproperties.cpp index 5e2459a37e..dda83c2b33 100644 --- a/src/widgets/util/qscrollerproperties.cpp +++ b/src/widgets/util/qscrollerproperties.cpp @@ -93,6 +93,8 @@ QScrollerPropertiesPrivate *QScrollerPropertiesPrivate::defaults() \brief The QScrollerProperties class stores the settings for a QScroller. \since 4.8 + \inmodule QtWidgets + The QScrollerProperties class stores the parameters used by QScroller. The default settings are platform dependent so that Qt emulates the diff --git a/src/widgets/util/qsystemtrayicon.cpp b/src/widgets/util/qsystemtrayicon.cpp index f6eeaa02b2..3ca5d459a7 100644 --- a/src/widgets/util/qsystemtrayicon.cpp +++ b/src/widgets/util/qsystemtrayicon.cpp @@ -66,6 +66,7 @@ QT_BEGIN_NAMESPACE \brief The QSystemTrayIcon class provides an icon for an application in the system tray. \since 4.2 \ingroup desktop + \inmodule QtWidgets Modern operating systems usually provide a special area on the desktop, called the \e{system tray} or \e{notification area}, where long-running diff --git a/src/widgets/util/qundogroup.cpp b/src/widgets/util/qundogroup.cpp index 4f83e3a815..44c00afe98 100644 --- a/src/widgets/util/qundogroup.cpp +++ b/src/widgets/util/qundogroup.cpp @@ -61,6 +61,7 @@ public: \class QUndoGroup \brief The QUndoGroup class is a group of QUndoStack objects. \since 4.2 + \inmodule QtWidgets For an overview of the Qt's undo framework, see the \link qundo.html overview\endlink. diff --git a/src/widgets/util/qundostack.cpp b/src/widgets/util/qundostack.cpp index 59e73e6ad2..9841a09ce6 100644 --- a/src/widgets/util/qundostack.cpp +++ b/src/widgets/util/qundostack.cpp @@ -53,6 +53,8 @@ QT_BEGIN_NAMESPACE \brief The QUndoCommand class is the base class of all commands stored on a QUndoStack. \since 4.2 + \inmodule QtWidgets + For an overview of Qt's Undo Framework, see the \l{Overview of Qt's Undo Framework}{overview document}. @@ -321,6 +323,8 @@ const QUndoCommand *QUndoCommand::child(int index) const \brief The QUndoStack class is a stack of QUndoCommand objects. \since 4.2 + \inmodule QtWidgets + For an overview of Qt's Undo Framework, see the \l{Overview of Qt's Undo Framework}{overview document}. diff --git a/src/widgets/util/qundoview.cpp b/src/widgets/util/qundoview.cpp index 820fcaf2de..c95e89f76e 100644 --- a/src/widgets/util/qundoview.cpp +++ b/src/widgets/util/qundoview.cpp @@ -255,6 +255,7 @@ QIcon QUndoModel::cleanIcon() const \since 4.2 \ingroup advanced + \inmodule QtWidgets QUndoView is a QListView which displays the list of commands pushed on an undo stack. The most recently executed command is always selected. Selecting a different command diff --git a/src/widgets/widgets/qabstractbutton.cpp b/src/widgets/widgets/qabstractbutton.cpp index de0b2b0330..ae5b06024a 100644 --- a/src/widgets/widgets/qabstractbutton.cpp +++ b/src/widgets/widgets/qabstractbutton.cpp @@ -66,6 +66,7 @@ Q_WIDGETS_EXPORT extern bool qt_tab_all_widgets; button widgets, providing functionality common to buttons. \ingroup abstractwidgets + \inmodule QtWidgets This class implements an \e abstract button. Subclasses of this class handle user actions, and specify how the button diff --git a/src/widgets/widgets/qabstractscrollarea.cpp b/src/widgets/widgets/qabstractscrollarea.cpp index 6081bc8a55..801160d080 100644 --- a/src/widgets/widgets/qabstractscrollarea.cpp +++ b/src/widgets/widgets/qabstractscrollarea.cpp @@ -77,6 +77,7 @@ QT_BEGIN_NAMESPACE on-demand scroll bars. \ingroup abstractwidgets + \inmodule QtWidgets QAbstractScrollArea is a low-level abstraction of a scrolling area. The area provides a central widget called the viewport, in diff --git a/src/widgets/widgets/qabstractslider.cpp b/src/widgets/widgets/qabstractslider.cpp index c86146e83e..694db0e125 100644 --- a/src/widgets/widgets/qabstractslider.cpp +++ b/src/widgets/widgets/qabstractslider.cpp @@ -56,6 +56,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractSlider class provides an integer value within a range. \ingroup abstractwidgets + \inmodule QtWidgets The class is designed as a common super class for widgets like QScrollBar, QSlider and QDial. diff --git a/src/widgets/widgets/qabstractspinbox.cpp b/src/widgets/widgets/qabstractspinbox.cpp index 4372ae3341..95027afb86 100644 --- a/src/widgets/widgets/qabstractspinbox.cpp +++ b/src/widgets/widgets/qabstractspinbox.cpp @@ -85,6 +85,7 @@ QT_BEGIN_NAMESPACE display values. \ingroup abstractwidgets + \inmodule QtWidgets The class is designed as a common super class for widgets like QSpinBox, QDoubleSpinBox and QDateTimeEdit diff --git a/src/widgets/widgets/qbuttongroup.cpp b/src/widgets/widgets/qbuttongroup.cpp index 1caa33f2f7..101488a359 100644 --- a/src/widgets/widgets/qbuttongroup.cpp +++ b/src/widgets/widgets/qbuttongroup.cpp @@ -48,6 +48,7 @@ \ingroup organizers \ingroup geomanagement + \inmodule QtWidgets QButtonGroup provides an abstract container into which button widgets can be placed. It does not provide a visual representation of this container diff --git a/src/widgets/widgets/qcalendarwidget.cpp b/src/widgets/widgets/qcalendarwidget.cpp index 4a0020efb5..f16a594953 100644 --- a/src/widgets/widgets/qcalendarwidget.cpp +++ b/src/widgets/widgets/qcalendarwidget.cpp @@ -1962,6 +1962,7 @@ void QCalendarWidgetPrivate::_q_editingFinished() \since 4.2 \ingroup advanced + \inmodule QtWidgets \image cleanlooks-calendarwidget.png diff --git a/src/widgets/widgets/qcheckbox.cpp b/src/widgets/widgets/qcheckbox.cpp index 639bfb4513..cd49747f8c 100644 --- a/src/widgets/widgets/qcheckbox.cpp +++ b/src/widgets/widgets/qcheckbox.cpp @@ -73,7 +73,7 @@ public: \brief The QCheckBox widget provides a checkbox with a text label. \ingroup basicwidgets - + \inmodule QtWidgets A QCheckBox is an option button that can be switched on (checked) or off (unchecked). Checkboxes are typically used to represent features in an diff --git a/src/widgets/widgets/qcombobox.cpp b/src/widgets/widgets/qcombobox.cpp index a29c8abe2c..2764833b48 100644 --- a/src/widgets/widgets/qcombobox.cpp +++ b/src/widgets/widgets/qcombobox.cpp @@ -863,7 +863,7 @@ QComboBox::QComboBox(QComboBoxPrivate &dd, QWidget *parent) \brief The QComboBox widget is a combined button and popup list. \ingroup basicwidgets - + \inmodule QtWidgets A QComboBox provides a means of presenting a list of options to the user in a way that takes up the minimum amount of screen space. diff --git a/src/widgets/widgets/qcommandlinkbutton.cpp b/src/widgets/widgets/qcommandlinkbutton.cpp index 257459a96f..afd14f63c5 100644 --- a/src/widgets/widgets/qcommandlinkbutton.cpp +++ b/src/widgets/widgets/qcommandlinkbutton.cpp @@ -58,7 +58,7 @@ QT_BEGIN_NAMESPACE \brief The QCommandLinkButton widget provides a Vista style command link button. \ingroup basicwidgets - + \inmodule QtWidgets The command link is a new control that was introduced by Windows Vista. It's intended use is similar to that of a radio button in that it is used to choose diff --git a/src/widgets/widgets/qdatetimeedit.cpp b/src/widgets/widgets/qdatetimeedit.cpp index d9ff8a6bad..02d62c87cc 100644 --- a/src/widgets/widgets/qdatetimeedit.cpp +++ b/src/widgets/widgets/qdatetimeedit.cpp @@ -75,7 +75,7 @@ QT_BEGIN_NAMESPACE \brief The QDateTimeEdit class provides a widget for editing dates and times. \ingroup basicwidgets - + \inmodule QtWidgets QDateTimeEdit allows the user to edit dates by using the keyboard or the arrow keys to increase and decrease date and time values. The @@ -1513,7 +1513,7 @@ void QDateTimeEdit::mousePressEvent(QMouseEvent *event) the QDateTimeEdit widget. \ingroup basicwidgets - + \inmodule QtWidgets Many of the properties and functions provided by QTimeEdit are implemented in QDateTimeEdit. The following properties are most relevant to users of this @@ -1568,7 +1568,7 @@ QTimeEdit::QTimeEdit(const QTime &time, QWidget *parent) the QDateTimeEdit widget. \ingroup basicwidgets - + \inmodule QtWidgets Many of the properties and functions provided by QDateEdit are implemented in QDateTimeEdit. The following properties are most relevant to users of this diff --git a/src/widgets/widgets/qdial.cpp b/src/widgets/widgets/qdial.cpp index e79583c87c..bc77faf993 100644 --- a/src/widgets/widgets/qdial.cpp +++ b/src/widgets/widgets/qdial.cpp @@ -179,7 +179,7 @@ int QDialPrivate::valueFromPoint(const QPoint &p) const \brief The QDial class provides a rounded range control (like a speedometer or potentiometer). \ingroup basicwidgets - + \inmodule QtWidgets QDial is used when the user needs to control a value within a program-definable range, and the range either wraps around diff --git a/src/widgets/widgets/qdialogbuttonbox.cpp b/src/widgets/widgets/qdialogbuttonbox.cpp index 64fd3caa1e..8085369a3f 100644 --- a/src/widgets/widgets/qdialogbuttonbox.cpp +++ b/src/widgets/widgets/qdialogbuttonbox.cpp @@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE layout that is appropriate to the current widget style. \ingroup dialog-classes - + \inmodule QtWidgets Dialogs and message boxes typically present buttons in a layout that conforms to the interface guidelines for that platform. Invariably, diff --git a/src/widgets/widgets/qdockwidget.cpp b/src/widgets/widgets/qdockwidget.cpp index 53e007aea5..5fcc474d6e 100644 --- a/src/widgets/widgets/qdockwidget.cpp +++ b/src/widgets/widgets/qdockwidget.cpp @@ -1068,6 +1068,7 @@ void QDockWidgetPrivate::setWindowState(bool floating, bool unplug, const QRect desktop. \ingroup mainwindow-classes + \inmodule QtWidgets QDockWidget provides the concept of dock widgets, also know as tool palettes or utility windows. Dock windows are secondary diff --git a/src/widgets/widgets/qfocusframe.cpp b/src/widgets/widgets/qfocusframe.cpp index b41a71ab54..86187c2c4a 100644 --- a/src/widgets/widgets/qfocusframe.cpp +++ b/src/widgets/widgets/qfocusframe.cpp @@ -127,7 +127,7 @@ void QFocusFrame::initStyleOption(QStyleOption *option) const outside of a widget's normal paintable area. \ingroup basicwidgets - + \inmodule QtWidgets Normally an application will not need to create its own QFocusFrame as QStyle will handle this detail for diff --git a/src/widgets/widgets/qfontcombobox.cpp b/src/widgets/widgets/qfontcombobox.cpp index bd53410f31..9090230029 100644 --- a/src/widgets/widgets/qfontcombobox.cpp +++ b/src/widgets/widgets/qfontcombobox.cpp @@ -282,6 +282,7 @@ void QFontComboBoxPrivate::_q_currentChanged(const QString &text) \since 4.2 \ingroup basicwidgets + \inmodule QtWidgets The combobox is populated with an alphabetized list of font family names, such as Arial, Helvetica, and Times New Roman. diff --git a/src/widgets/widgets/qframe.cpp b/src/widgets/widgets/qframe.cpp index 83261c4875..e017513541 100644 --- a/src/widgets/widgets/qframe.cpp +++ b/src/widgets/widgets/qframe.cpp @@ -73,7 +73,7 @@ inline void QFramePrivate::init() \brief The QFrame class is the base class of widgets that can have a frame. \ingroup abstractwidgets - + \inmodule QtWidgets QMenu uses this to "raise" the menu above the surrounding screen. QProgressBar has a "sunken" look. QLabel has a flat look. diff --git a/src/widgets/widgets/qgroupbox.cpp b/src/widgets/widgets/qgroupbox.cpp index b9bf1ecc9d..56204188e8 100644 --- a/src/widgets/widgets/qgroupbox.cpp +++ b/src/widgets/widgets/qgroupbox.cpp @@ -147,6 +147,7 @@ void QGroupBoxPrivate::click() \ingroup organizers \ingroup geomanagement + \inmodule QtWidgets A group box provides a frame, a title and a keyboard shortcut, and displays various other widgets inside itself. The title is on top, diff --git a/src/widgets/widgets/qlabel.cpp b/src/widgets/widgets/qlabel.cpp index 09bdc68511..2f0f43fbf4 100644 --- a/src/widgets/widgets/qlabel.cpp +++ b/src/widgets/widgets/qlabel.cpp @@ -66,6 +66,7 @@ QT_BEGIN_NAMESPACE \brief The QLabel widget provides a text or image display. \ingroup basicwidgets + \inmodule QtWidgets QLabel is used for displaying text or an image. No user interaction functionality is provided. The visual appearance of diff --git a/src/widgets/widgets/qlcdnumber.cpp b/src/widgets/widgets/qlcdnumber.cpp index a591339ea4..1b5fbe3417 100644 --- a/src/widgets/widgets/qlcdnumber.cpp +++ b/src/widgets/widgets/qlcdnumber.cpp @@ -74,7 +74,7 @@ public: \brief The QLCDNumber widget displays a number with LCD-like digits. \ingroup basicwidgets - + \inmodule QtWidgets It can display a number in just about any size. It can display decimal, hexadecimal, octal or binary numbers. It is easy to diff --git a/src/widgets/widgets/qlineedit.cpp b/src/widgets/widgets/qlineedit.cpp index 55b5cd81eb..9706707f20 100644 --- a/src/widgets/widgets/qlineedit.cpp +++ b/src/widgets/widgets/qlineedit.cpp @@ -131,7 +131,7 @@ void QLineEdit::initStyleOption(QStyleOptionFrame *option) const \brief The QLineEdit widget is a one-line text editor. \ingroup basicwidgets - + \inmodule QtWidgets A line edit allows the user to enter and edit a single line of plain text with a useful collection of editing functions, diff --git a/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm b/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm index 5bb7a3bbf2..8e64e3bbe0 100644 --- a/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm +++ b/src/widgets/widgets/qmaccocoaviewcontainer_mac.mm @@ -52,6 +52,7 @@ Cocoa views (i.e., NSView subclasses) and insert them into Qt hierarchies. \ingroup advanced + \inmodule QtWidgets While Qt offers a lot of classes for writing your application, Apple's Cocoa framework offers lots of functionality that is not currently in Qt or diff --git a/src/widgets/widgets/qmacnativewidget_mac.mm b/src/widgets/widgets/qmacnativewidget_mac.mm index b3c00d3cc6..08f78158ee 100644 --- a/src/widgets/widgets/qmacnativewidget_mac.mm +++ b/src/widgets/widgets/qmacnativewidget_mac.mm @@ -51,6 +51,7 @@ or Cocoa hierarchies depending on how Qt was configured. \ingroup advanced + \inmodule QtWidgets On Mac OS X, there is a difference between a window and view; normally expressed as widgets in Qt. Qt makes assumptions about its diff --git a/src/widgets/widgets/qmainwindow.cpp b/src/widgets/widgets/qmainwindow.cpp index a53055424a..238b8d57c3 100644 --- a/src/widgets/widgets/qmainwindow.cpp +++ b/src/widgets/widgets/qmainwindow.cpp @@ -209,7 +209,7 @@ void QMainWindowPrivate::init() \brief The QMainWindow class provides a main application window. \ingroup mainwindow-classes - + \inmodule QtWidgets \tableofcontents diff --git a/src/widgets/widgets/qmdiarea.cpp b/src/widgets/widgets/qmdiarea.cpp index 2fe9706edf..f66c71315a 100644 --- a/src/widgets/widgets/qmdiarea.cpp +++ b/src/widgets/widgets/qmdiarea.cpp @@ -44,7 +44,7 @@ \brief The QMdiArea widget provides an area in which MDI windows are displayed. \since 4.3 \ingroup mainwindow-classes - + \inmodule QtWidgets QMdiArea functions, essentially, like a window manager for MDI windows. For instance, it draws the windows it manages on itself diff --git a/src/widgets/widgets/qmdisubwindow.cpp b/src/widgets/widgets/qmdisubwindow.cpp index 5cbd6208cf..7fd2bd2a58 100644 --- a/src/widgets/widgets/qmdisubwindow.cpp +++ b/src/widgets/widgets/qmdisubwindow.cpp @@ -45,7 +45,7 @@ QMdiArea. \since 4.3 \ingroup mainwindow-classes - + \inmodule QtWidgets QMdiSubWindow represents a top-level window in a QMdiArea, and consists of a title bar with window decorations, an internal widget, and diff --git a/src/widgets/widgets/qmenu.cpp b/src/widgets/widgets/qmenu.cpp index 67dbd7e265..43fff6a8cf 100644 --- a/src/widgets/widgets/qmenu.cpp +++ b/src/widgets/widgets/qmenu.cpp @@ -1218,7 +1218,7 @@ void QMenu::initStyleOption(QStyleOptionMenuItem *option, const QAction *action) \ingroup mainwindow-classes \ingroup basicwidgets - + \inmodule QtWidgets A menu widget is a selection menu. It can be either a pull-down menu in a menu bar or a standalone context menu. Pull-down menus diff --git a/src/widgets/widgets/qmenubar.cpp b/src/widgets/widgets/qmenubar.cpp index 2f424b0893..6faf8f94ca 100644 --- a/src/widgets/widgets/qmenubar.cpp +++ b/src/widgets/widgets/qmenubar.cpp @@ -576,6 +576,7 @@ void QMenuBar::initStyleOption(QStyleOptionMenuItem *option, const QAction *acti \brief The QMenuBar class provides a horizontal menu bar. \ingroup mainwindow-classes + \inmodule QtWidgets A menu bar consists of a list of pull-down menu items. You add menu items with addMenu(). For example, asuming that \c menubar diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index ec9d251a91..8a6ac67989 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -111,6 +111,7 @@ public: \brief The QPlainTextDocumentLayout class implements a plain text layout for QTextDocument \ingroup richtext-processing + \inmodule QtWidgets A QPlainTextDocumentLayout is required for text documents that can be display or edited in a QPlainTextEdit. See @@ -1018,7 +1019,7 @@ void QPlainTextEditPrivate::ensureViewportLayouted() plain text. \ingroup richtext-processing - + \inmodule QtWidgets \tableofcontents diff --git a/src/widgets/widgets/qprogressbar.cpp b/src/widgets/widgets/qprogressbar.cpp index dd92bda993..1ae55c50bc 100644 --- a/src/widgets/widgets/qprogressbar.cpp +++ b/src/widgets/widgets/qprogressbar.cpp @@ -172,7 +172,7 @@ bool QProgressBarPrivate::repaintRequired() const \brief The QProgressBar widget provides a horizontal or vertical progress bar. \ingroup basicwidgets - + \inmodule QtWidgets A progress bar is used to give the user an indication of the progress of an operation and to reassure them that the application diff --git a/src/widgets/widgets/qpushbutton.cpp b/src/widgets/widgets/qpushbutton.cpp index 0094a5a95b..e3993167ef 100644 --- a/src/widgets/widgets/qpushbutton.cpp +++ b/src/widgets/widgets/qpushbutton.cpp @@ -78,7 +78,7 @@ QT_BEGIN_NAMESPACE \brief The QPushButton widget provides a command button. \ingroup basicwidgets - + \inmodule QtWidgets The push button, or command button, is perhaps the most commonly used widget in any graphical user interface. Push (click) a button diff --git a/src/widgets/widgets/qradiobutton.cpp b/src/widgets/widgets/qradiobutton.cpp index 778a71dce9..b9567a0a11 100644 --- a/src/widgets/widgets/qradiobutton.cpp +++ b/src/widgets/widgets/qradiobutton.cpp @@ -80,7 +80,7 @@ void QRadioButtonPrivate::init() \brief The QRadioButton widget provides a radio button with a text label. \ingroup basicwidgets - + \inmodule QtWidgets A QRadioButton is an option button that can be switched on (checked) or off (unchecked). Radio buttons typically present the user with a "one diff --git a/src/widgets/widgets/qrubberband.cpp b/src/widgets/widgets/qrubberband.cpp index e288835609..d0ea05f5cd 100644 --- a/src/widgets/widgets/qrubberband.cpp +++ b/src/widgets/widgets/qrubberband.cpp @@ -98,6 +98,8 @@ void QRubberBand::initStyleOption(QStyleOptionRubberBand *option) const \brief The QRubberBand class provides a rectangle or line that can indicate a selection or a boundary. + \inmodule QtWidgets + A rubber band is often used to show a new bounding area (as in a QSplitter or a QDockWidget that is undocking). Historically this has been implemented using a QPainter and XOR, but this approach diff --git a/src/widgets/widgets/qscrollarea.cpp b/src/widgets/widgets/qscrollarea.cpp index 5d03c07472..48c179a9ab 100644 --- a/src/widgets/widgets/qscrollarea.cpp +++ b/src/widgets/widgets/qscrollarea.cpp @@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE another widget. \ingroup basicwidgets - + \inmodule QtWidgets A scroll area is used to display the contents of a child widget within a frame. If the widget exceeds the size of the frame, the diff --git a/src/widgets/widgets/qscrollbar.cpp b/src/widgets/widgets/qscrollbar.cpp index b21d22e5f0..b8cd81c6a7 100644 --- a/src/widgets/widgets/qscrollbar.cpp +++ b/src/widgets/widgets/qscrollbar.cpp @@ -64,6 +64,7 @@ QT_BEGIN_NAMESPACE \brief The QScrollBar widget provides a vertical or horizontal scroll bar. \ingroup basicwidgets + \inmodule QtWidgets A scroll bar is a control that enables the user to access parts of a document that is larger than the widget used to display it. It provides diff --git a/src/widgets/widgets/qsizegrip.cpp b/src/widgets/widgets/qsizegrip.cpp index c5fe442ece..d4cfce984d 100644 --- a/src/widgets/widgets/qsizegrip.cpp +++ b/src/widgets/widgets/qsizegrip.cpp @@ -172,6 +172,7 @@ Qt::Corner QSizeGripPrivate::corner() const \ingroup mainwindow-classes \ingroup basicwidgets + \inmodule QtWidgets This widget works like the standard Windows resize handle. In the X11 version this resize handle generally works differently from diff --git a/src/widgets/widgets/qslider.cpp b/src/widgets/widgets/qslider.cpp index 7aa91e829f..9dd73f8c96 100644 --- a/src/widgets/widgets/qslider.cpp +++ b/src/widgets/widgets/qslider.cpp @@ -203,7 +203,7 @@ QStyle::SubControl QSliderPrivate::newHoverControl(const QPoint &pos) \brief The QSlider widget provides a vertical or horizontal slider. \ingroup basicwidgets - + \inmodule QtWidgets The slider is the classic widget for controlling a bounded value. It lets the user move a slider handle along a horizontal or vertical diff --git a/src/widgets/widgets/qspinbox.cpp b/src/widgets/widgets/qspinbox.cpp index 15a932ad31..47cc8bbcf3 100644 --- a/src/widgets/widgets/qspinbox.cpp +++ b/src/widgets/widgets/qspinbox.cpp @@ -111,7 +111,7 @@ public: \brief The QSpinBox class provides a spin box widget. \ingroup basicwidgets - + \inmodule QtWidgets QSpinBox is designed to handle integers and discrete sets of values (e.g., month names); use QDoubleSpinBox for floating point @@ -501,7 +501,7 @@ void QSpinBox::fixup(QString &input) const takes doubles. \ingroup basicwidgets - + \inmodule QtWidgets QDoubleSpinBox allows the user to choose a value by clicking the up and down buttons or by pressing Up or Down on the keyboard to diff --git a/src/widgets/widgets/qsplashscreen.cpp b/src/widgets/widgets/qsplashscreen.cpp index e051878db9..7140487463 100644 --- a/src/widgets/widgets/qsplashscreen.cpp +++ b/src/widgets/widgets/qsplashscreen.cpp @@ -71,6 +71,8 @@ public: \brief The QSplashScreen widget provides a splash screen that can be shown during application startup. + \inmodule QtWidgets + A splash screen is a widget that is usually displayed when an application is being started. Splash screens are often used for applications that have long start up times (e.g. database or diff --git a/src/widgets/widgets/qsplitter.cpp b/src/widgets/widgets/qsplitter.cpp index 864bf0debe..b725ee039a 100644 --- a/src/widgets/widgets/qsplitter.cpp +++ b/src/widgets/widgets/qsplitter.cpp @@ -71,6 +71,7 @@ QT_BEGIN_NAMESPACE \brief The QSplitterHandle class provides handle functionality of the splitter. \ingroup organizers + \inmodule QtWidgets QSplitterHandle is typically what people think about when they think about a splitter. It is the handle that is used to resize the widgets. @@ -876,6 +877,7 @@ QSplitterLayoutStruct *QSplitterPrivate::insertWidget(int index, QWidget *w) \brief The QSplitter class implements a splitter widget. \ingroup organizers + \inmodule QtWidgets A splitter lets the user control the size of child widgets by dragging the diff --git a/src/widgets/widgets/qstackedwidget.cpp b/src/widgets/widgets/qstackedwidget.cpp index c4bf79a1c4..4e9349e348 100644 --- a/src/widgets/widgets/qstackedwidget.cpp +++ b/src/widgets/widgets/qstackedwidget.cpp @@ -107,7 +107,7 @@ public: \ingroup organizers \ingroup geomanagement - + \inmodule QtWidgets QStackedWidget can be used to create a user interface similar to the one provided by QTabWidget. It is a convenience layout widget diff --git a/src/widgets/widgets/qstatusbar.cpp b/src/widgets/widgets/qstatusbar.cpp index b45666b724..295d509444 100644 --- a/src/widgets/widgets/qstatusbar.cpp +++ b/src/widgets/widgets/qstatusbar.cpp @@ -160,7 +160,7 @@ QRect QStatusBarPrivate::messageRect() const \ingroup mainwindow-classes \ingroup helpsystem - + \inmodule QtWidgets Each status indicator falls into one of three categories: diff --git a/src/widgets/widgets/qtabbar.cpp b/src/widgets/widgets/qtabbar.cpp index def724983b..b20df0b4e9 100644 --- a/src/widgets/widgets/qtabbar.cpp +++ b/src/widgets/widgets/qtabbar.cpp @@ -208,7 +208,7 @@ void QTabBar::initStyleOption(QStyleOptionTab *option, int tabIndex) const \brief The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs. \ingroup basicwidgets - + \inmodule QtWidgets QTabBar is straightforward to use; it draws the tabs using one of the predefined \link QTabBar::Shape shapes\endlink, and emits a diff --git a/src/widgets/widgets/qtabwidget.cpp b/src/widgets/widgets/qtabwidget.cpp index 0eeb6b35bd..a01316145e 100644 --- a/src/widgets/widgets/qtabwidget.cpp +++ b/src/widgets/widgets/qtabwidget.cpp @@ -64,7 +64,7 @@ QT_BEGIN_NAMESPACE \ingroup organizers \ingroup basicwidgets - + \inmodule QtWidgets A tab widget provides a tab bar (see QTabBar) and a "page area" that is used to display pages related to each tab. By default, the diff --git a/src/widgets/widgets/qtextbrowser.cpp b/src/widgets/widgets/qtextbrowser.cpp index f1cdc25def..e8fad6cebc 100644 --- a/src/widgets/widgets/qtextbrowser.cpp +++ b/src/widgets/widgets/qtextbrowser.cpp @@ -581,6 +581,7 @@ void QTextBrowserPrivate::restoreHistoryEntry(const HistoryEntry entry) \brief The QTextBrowser class provides a rich text browser with hypertext navigation. \ingroup richtext-processing + \inmodule QtWidgets This class extends QTextEdit (in read-only mode), adding some navigation functionality so that users can follow links in hypertext documents. diff --git a/src/widgets/widgets/qtextedit.cpp b/src/widgets/widgets/qtextedit.cpp index 46a263e0ae..f345cb2f7c 100644 --- a/src/widgets/widgets/qtextedit.cpp +++ b/src/widgets/widgets/qtextedit.cpp @@ -338,7 +338,7 @@ void QTextEditPrivate::_q_ensureVisible(const QRectF &_rect) both plain and rich text. \ingroup richtext-processing - + \inmodule QtWidgets \tableofcontents @@ -1923,6 +1923,8 @@ void QTextEdit::setAcceptRichText(bool accept) /*! \class QTextEdit::ExtraSelection \since 4.2 + \inmodule QtWidgets + \brief The QTextEdit::ExtraSelection structure provides a way of specifying a character format for a given selection in a document */ diff --git a/src/widgets/widgets/qtoolbar.cpp b/src/widgets/widgets/qtoolbar.cpp index b2e1ce8e67..6fc4dc90f8 100644 --- a/src/widgets/widgets/qtoolbar.cpp +++ b/src/widgets/widgets/qtoolbar.cpp @@ -420,7 +420,7 @@ void QToolBarPrivate::plug(const QRect &r) set of controls. \ingroup mainwindow-classes - + \inmodule QtWidgets Toolbar buttons are added by adding \e actions, using addAction() or insertAction(). Groups of buttons can be separated using diff --git a/src/widgets/widgets/qtoolbox.cpp b/src/widgets/widgets/qtoolbox.cpp index e8bbccec04..a0bd1708fe 100644 --- a/src/widgets/widgets/qtoolbox.cpp +++ b/src/widgets/widgets/qtoolbox.cpp @@ -254,6 +254,7 @@ void QToolBoxButton::paintEvent(QPaintEvent *) \ingroup basicwidgets + \inmodule QtWidgets A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. diff --git a/src/widgets/widgets/qtoolbutton.cpp b/src/widgets/widgets/qtoolbutton.cpp index 67f251036c..ba0db96272 100644 --- a/src/widgets/widgets/qtoolbutton.cpp +++ b/src/widgets/widgets/qtoolbutton.cpp @@ -113,7 +113,7 @@ bool QToolButtonPrivate::hasMenu() const commands or options, usually used inside a QToolBar. \ingroup basicwidgets - + \inmodule QtWidgets A tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command diff --git a/src/widgets/widgets/qworkspace.cpp b/src/widgets/widgets/qworkspace.cpp index 53de90984b..0d74635881 100644 --- a/src/widgets/widgets/qworkspace.cpp +++ b/src/widgets/widgets/qworkspace.cpp @@ -835,6 +835,8 @@ QSize QWorkspaceTitleBar::sizeHint() const \brief The QWorkspace widget provides a workspace window that can be used in an MDI application. + \inmodule QtWidgets + This class is deprecated. Use QMdiArea instead. Multiple Document Interface (MDI) applications are typically |