diff options
Diffstat (limited to 'src/widgets')
85 files changed, 425 insertions, 425 deletions
diff --git a/src/widgets/dialogs/qcolordialog.cpp b/src/widgets/dialogs/qcolordialog.cpp index 82f70f323b..d20725fc89 100644 --- a/src/widgets/dialogs/qcolordialog.cpp +++ b/src/widgets/dialogs/qcolordialog.cpp @@ -1889,7 +1889,7 @@ void QColorDialog::setOption(ColorDialogOption option, bool on) /*! \since 4.5 - Returns true if the given \a option is enabled; otherwise, returns + Returns \c true if the given \a option is enabled; otherwise, returns false. \sa options, setOption() diff --git a/src/widgets/dialogs/qdialog.cpp b/src/widgets/dialogs/qdialog.cpp index e1097dd1bb..af352e45c6 100644 --- a/src/widgets/dialogs/qdialog.cpp +++ b/src/widgets/dialogs/qdialog.cpp @@ -1041,7 +1041,7 @@ QSize QDialog::minimumSizeHint() const \property QDialog::modal \brief whether show() should pop up the dialog as modal or modeless - By default, this property is false and show() pops up the dialog + By default, this property is \c false and show() pops up the dialog as modeless. Setting his property to true is equivalent to setting QWidget::windowModality to Qt::ApplicationModal. diff --git a/src/widgets/dialogs/qfiledialog.cpp b/src/widgets/dialogs/qfiledialog.cpp index 62cec34b2b..b688dfb0a4 100644 --- a/src/widgets/dialogs/qfiledialog.cpp +++ b/src/widgets/dialogs/qfiledialog.cpp @@ -490,7 +490,7 @@ QByteArray QFileDialog::saveState() const Typically this is used in conjunction with QSettings to restore the size from a past session. - Returns false if there are errors + Returns \c false if there are errors */ bool QFileDialog::restoreState(const QByteArray &state) { @@ -751,7 +751,7 @@ void QFileDialog::setOption(Option option, bool on) /*! \since 4.5 - Returns true if the given \a option is enabled; otherwise, returns + Returns \c true if the given \a option is enabled; otherwise, returns false. \sa options, setOption() @@ -1287,7 +1287,7 @@ void QFileDialog::setNameFilter(const QString &filter) \brief This property holds whether the filter details is shown or not. \since 4.4 - When this property is true (the default), the filter details are shown + When this property is \c true (the default), the filter details are shown in the combo box. When the property is set to false, these are hidden. Use setOption(HideNameFilterDetails, !\e enabled) or @@ -3567,7 +3567,7 @@ void QFileDialogPrivate::_q_nativeEnterDirectory(const QUrl &directory) For the list and tree view watch keys to goto parent and back in the history - returns true if handled + returns \c true if handled */ bool QFileDialogPrivate::itemViewKeyboardEvent(QKeyEvent *event) { diff --git a/src/widgets/dialogs/qfilesystemmodel.cpp b/src/widgets/dialogs/qfilesystemmodel.cpp index c86c7ff931..6330d529fb 100644 --- a/src/widgets/dialogs/qfilesystemmodel.cpp +++ b/src/widgets/dialogs/qfilesystemmodel.cpp @@ -482,8 +482,8 @@ void QFileSystemModel::timerEvent(QTimerEvent *event) } /*! - Returns true if the model item \a index represents a directory; - otherwise returns false. + Returns \c true if the model item \a index represents a directory; + otherwise returns \c false. */ bool QFileSystemModel::isDir(const QModelIndex &index) const { @@ -1531,7 +1531,7 @@ QDir::Filters QFileSystemModel::filter() const This is only relevant on Windows. - By default, this property is true. + By default, this property is \c true. */ void QFileSystemModel::setResolveSymlinks(bool enable) { @@ -1558,7 +1558,7 @@ bool QFileSystemModel::resolveSymlinks() const If this property is set to false, the directory model will allow renaming, copying and deleting of files and directories. - This property is true by default + This property is \c true by default */ void QFileSystemModel::setReadOnly(bool enable) { @@ -1576,7 +1576,7 @@ bool QFileSystemModel::isReadOnly() const \property QFileSystemModel::nameFilterDisables \brief Whether files that don't pass the name filter are hidden or disabled - This property is true by default + This property is \c true by default */ void QFileSystemModel::setNameFilterDisables(bool enable) { @@ -1971,7 +1971,7 @@ void QFileSystemModelPrivate::init() /*! \internal - Returns false if node doesn't pass the filters otherwise true + Returns \c false if node doesn't pass the filters otherwise true QDir::Modified is not supported QDir::Drives is not supported @@ -2020,7 +2020,7 @@ bool QFileSystemModelPrivate::filtersAcceptsNode(const QFileSystemNode *node) co /* \internal - Returns true if node passes the name filters and should be visible. + Returns \c true if node passes the name filters and should be visible. */ bool QFileSystemModelPrivate::passNameFilters(const QFileSystemNode *node) const { diff --git a/src/widgets/dialogs/qfontdialog.cpp b/src/widgets/dialogs/qfontdialog.cpp index b989ea7c86..d908a683a9 100644 --- a/src/widgets/dialogs/qfontdialog.cpp +++ b/src/widgets/dialogs/qfontdialog.cpp @@ -885,7 +885,7 @@ void QFontDialog::setOption(FontDialogOption option, bool on) } /*! - Returns true if the given \a option is enabled; otherwise, returns + Returns \c true if the given \a option is enabled; otherwise, returns false. \sa options, setOption() diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp index c1f8deb4eb..4eec2eb3e2 100644 --- a/src/widgets/dialogs/qinputdialog.cpp +++ b/src/widgets/dialogs/qinputdialog.cpp @@ -629,7 +629,7 @@ void QInputDialog::setOption(InputDialogOption option, bool on) } /*! - Returns true if the given \a option is enabled; otherwise, returns + Returns \c true if the given \a option is enabled; otherwise, returns false. \sa options, setOption() diff --git a/src/widgets/dialogs/qwizard.cpp b/src/widgets/dialogs/qwizard.cpp index 02d4d1ca27..02ad5a3be5 100644 --- a/src/widgets/dialogs/qwizard.cpp +++ b/src/widgets/dialogs/qwizard.cpp @@ -1963,7 +1963,7 @@ void QWizardAntiFlickerWidget::paintEvent(QPaintEvent *) Another way is to reimplement validateCurrentPage() (or QWizardPage::validatePage()) to perform some last-minute validation (and show an error message if the user has entered - incomplete or invalid information). If the function returns true, + incomplete or invalid information). If the function returns \c true, the next page is shown (or the wizard finishes); otherwise, the current page stays up. @@ -2331,8 +2331,8 @@ QWizardPage *QWizard::page(int theid) const /*! \fn bool QWizard::hasVisitedPage(int id) const - Returns true if the page history contains page \a id; otherwise, - returns false. + Returns \c true if the page history contains page \a id; otherwise, + returns \c false. Pressing \uicontrol Back marks the current page as "unvisited" again. @@ -2544,7 +2544,7 @@ void QWizard::setOption(WizardOption option, bool on) } /*! - Returns true if the given \a option is enabled; otherwise, returns + Returns \c true if the given \a option is enabled; otherwise, returns false. \sa options, setOption(), setWizardStyle() @@ -3276,7 +3276,7 @@ void QWizard::cleanupPage(int theid) /*! This virtual function is called by QWizard when the user clicks \uicontrol Next or \uicontrol Finish to perform some last-minute validation. - If it returns true, the next page is shown (or the wizard + If it returns \c true, the next page is shown (or the wizard finishes); otherwise, the current page stays up. The default implementation calls QWizardPage::validatePage() on @@ -3363,7 +3363,7 @@ int QWizard::nextId() const \endlist Normally, the \uicontrol Next button and the \uicontrol Finish button of a - wizard are mutually exclusive. If isFinalPage() returns true, \uicontrol + wizard are mutually exclusive. If isFinalPage() returns \c true, \uicontrol Finish is available; otherwise, \uicontrol Next is available. By default, isFinalPage() is true only when nextId() returns -1. If you want to show \uicontrol Next and \uicontrol Final simultaneously for a @@ -3566,10 +3566,10 @@ void QWizardPage::cleanupPage() /*! This virtual function is called by QWizard::validateCurrentPage() when the user clicks \uicontrol Next or \uicontrol Finish to perform some - last-minute validation. If it returns true, the next page is shown + last-minute validation. If it returns \c true, the next page is shown (or the wizard finishes); otherwise, the current page stays up. - The default implementation returns true. + The default implementation returns \c true. When possible, it is usually better style to disable the \uicontrol Next or \uicontrol Finish button (by specifying \l{mandatory fields} or @@ -3587,8 +3587,8 @@ bool QWizardPage::validatePage() the \uicontrol Next or \uicontrol Finish button should be enabled or disabled. - The default implementation returns true if all \l{mandatory - fields} are filled; otherwise, it returns false. + The default implementation returns \c true if all \l{mandatory + fields} are filled; otherwise, it returns \c false. If you reimplement this function, make sure to emit completeChanged(), from the rest of your implementation, whenever the value of isComplete() @@ -3634,12 +3634,12 @@ bool QWizardPage::isComplete() const /*! Explicitly sets this page to be final if \a finalPage is true. - After calling setFinalPage(true), isFinalPage() returns true and the \uicontrol + After calling setFinalPage(true), isFinalPage() returns \c true and the \uicontrol Finish button is visible (and enabled if isComplete() returns true). - After calling setFinalPage(false), isFinalPage() returns true if - nextId() returns -1; otherwise, it returns false. + After calling setFinalPage(false), isFinalPage() returns \c true if + nextId() returns -1; otherwise, it returns \c false. \sa isComplete(), QWizard::HaveFinishButtonOnEarlyPages */ @@ -3656,8 +3656,8 @@ void QWizardPage::setFinalPage(bool finalPage) This function is called by QWizard to determine whether the \uicontrol Finish button should be shown for this page or not. - By default, it returns true if there is no next page - (i.e., nextId() returns -1); otherwise, it returns false. + By default, it returns \c true if there is no next page + (i.e., nextId() returns -1); otherwise, it returns \c false. By explicitly calling setFinalPage(true), you can let the user perform an "early finish". @@ -3703,7 +3703,7 @@ void QWizardPage::setCommitPage(bool commitPage) } /*! - Returns true if this page is a commit page; otherwise returns false. + Returns \c true if this page is a commit page; otherwise returns \c false. \sa setCommitPage() */ diff --git a/src/widgets/doc/src/graphicsview.qdoc b/src/widgets/doc/src/graphicsview.qdoc index cc81d51a8f..148b4ea47d 100644 --- a/src/widgets/doc/src/graphicsview.qdoc +++ b/src/widgets/doc/src/graphicsview.qdoc @@ -222,7 +222,7 @@ transformations for you. This makes it very easy to implement custom items. For example, if you receive a mouse press or a drag enter event, the event position is given in item coordinates. The - QGraphicsItem::contains() virtual function, which returns true if a + QGraphicsItem::contains() virtual function, which returns \c true if a certain point is inside your item, and false otherwise, takes a point argument in item coordinates. Similarly, an item's bounding rect and shape are in item coordinates. diff --git a/src/widgets/doc/src/model-view-programming.qdoc b/src/widgets/doc/src/model-view-programming.qdoc index d0d925e74a..3d3b6da819 100644 --- a/src/widgets/doc/src/model-view-programming.qdoc +++ b/src/widgets/doc/src/model-view-programming.qdoc @@ -2279,7 +2279,7 @@ \section2 Performance optimization for large amounts of data The \l{QAbstractItemModel::}{canFetchMore()} function checks if the parent - has more data available and returns true or false accordingly. The + has more data available and returns \c true or false accordingly. The \l{QAbstractItemModel::}{fetchMore()} function fetches data based on the parent specified. Both these functions can be combined, for example, in a database query involving incremental data to populate a QAbstractItemModel. diff --git a/src/widgets/effects/qgraphicseffect.cpp b/src/widgets/effects/qgraphicseffect.cpp index 420392c0fb..390c4e96e5 100644 --- a/src/widgets/effects/qgraphicseffect.cpp +++ b/src/widgets/effects/qgraphicseffect.cpp @@ -267,12 +267,12 @@ void QGraphicsEffectSource::update() } /*! - Returns true if the source effectively is a pixmap, e.g., a + Returns \c true if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem. This function is useful for optimization purposes. For instance, there's no point in drawing the source in device coordinates to avoid pixmap scaling - if this function returns true - the source pixmap will be scaled anyways. + if this function returns \c true - the source pixmap will be scaled anyways. */ bool QGraphicsEffectSource::isPixmap() const { @@ -280,12 +280,12 @@ bool QGraphicsEffectSource::isPixmap() const } /*! - Returns true if the source effectively is a pixmap, e.g., a + Returns \c true if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem. This function is useful for optimization purposes. For instance, there's no point in drawing the source in device coordinates to avoid pixmap scaling - if this function returns true - the source pixmap will be scaled anyways. + if this function returns \c true - the source pixmap will be scaled anyways. */ bool QGraphicsEffect::sourceIsPixmap() const { diff --git a/src/widgets/graphicsview/qgraphicsanchorlayout_p.cpp b/src/widgets/graphicsview/qgraphicsanchorlayout_p.cpp index 93fb968d69..27a75655a0 100644 --- a/src/widgets/graphicsview/qgraphicsanchorlayout_p.cpp +++ b/src/widgets/graphicsview/qgraphicsanchorlayout_p.cpp @@ -819,7 +819,7 @@ static AnchorData *createSequence(Graph<AnchorVertex, AnchorData> *graph, 3. Done When creating the parallel anchors, the algorithm might identify unfeasible situations. In this - case the simplification process stops and returns false. Otherwise returns true. + case the simplification process stops and returns \c false. Otherwise returns \c true. */ bool QGraphicsAnchorLayoutPrivate::simplifyGraph(Orientation orientation) { @@ -1014,7 +1014,7 @@ bool QGraphicsAnchorLayoutPrivate::simplifyVertices(Orientation orientation) /*! \internal - One iteration of the simplification algorithm. Returns true if another iteration is needed. + One iteration of the simplification algorithm. Returns \c true if another iteration is needed. The algorithm walks the graph in depth-first order, and only collects vertices that has two edges connected to it. If the vertex does not have two edges or if it is a layout edge, it @@ -2967,8 +2967,8 @@ bool QGraphicsAnchorLayoutPrivate::solvePreferred(const QList<QSimplexConstraint /*! \internal - Returns true if there are no arrangement that satisfies all constraints. - Otherwise returns false. + Returns \c true if there are no arrangement that satisfies all constraints. + Otherwise returns \c false. \sa addAnchor() */ diff --git a/src/widgets/graphicsview/qgraphicsitem.cpp b/src/widgets/graphicsview/qgraphicsitem.cpp index 47c05d4a46..7cab132a2e 100644 --- a/src/widgets/graphicsview/qgraphicsitem.cpp +++ b/src/widgets/graphicsview/qgraphicsitem.cpp @@ -403,7 +403,7 @@ contained focus handling. Only one panel can be active at a time (see QGraphicsItem::isActive()). When no panel is active, QGraphicsScene activates all non-panel items. Window items (i.e., - QGraphicsItem::isWindow() returns true) are panels. This flag was + QGraphicsItem::isWindow() returns \c true) are panels. This flag was introduced in Qt 4.6. \omitvalue ItemIsFocusScope \omit Internal only (for now). \endomit @@ -1709,8 +1709,8 @@ QList<QGraphicsItem *> QGraphicsItem::childItems() const /*! \since 4.4 - Returns true if this item is a widget (i.e., QGraphicsWidget); otherwise, - returns false. + Returns \c true if this item is a widget (i.e., QGraphicsWidget); otherwise, + returns \c false. */ bool QGraphicsItem::isWidget() const { @@ -1719,7 +1719,7 @@ bool QGraphicsItem::isWidget() const /*! \since 4.4 - Returns true if the item is a QGraphicsWidget window, otherwise returns + Returns \c true if the item is a QGraphicsWidget window, otherwise returns false. \sa QGraphicsWidget::windowFlags() @@ -1731,7 +1731,7 @@ bool QGraphicsItem::isWindow() const /*! \since 4.6 - Returns true if the item is a panel; otherwise returns false. + Returns \c true if the item is a panel; otherwise returns \c false. \sa QGraphicsItem::panel(), ItemIsPanel */ @@ -2021,11 +2021,11 @@ void QGraphicsItem::setPanelModality(PanelModality panelModality) /*! \since 4.6 - Returns true if this item is blocked by a modal panel, false otherwise. If \a blockingPanel is + Returns \c true if this item is blocked by a modal panel, false otherwise. If \a blockingPanel is non-zero, \a blockingPanel will be set to the modal panel that is blocking this item. If this item is not blocked, \a blockingPanel will not be set by this function. - This function always returns false for items not in a scene. + This function always returns \c false for items not in a scene. \sa panelModality(), setPanelModality(), PanelModality */ @@ -2156,7 +2156,7 @@ void QGraphicsItem::setCursor(const QCursor &cursor) } /*! - Returns true if this item has a cursor set; otherwise, false is returned. + Returns \c true if this item has a cursor set; otherwise, false is returned. By default, items don't have any cursor set. cursor() will return a standard pointing arrow cursor. @@ -2192,7 +2192,7 @@ void QGraphicsItem::unsetCursor() #endif // QT_NO_CURSOR /*! - Returns true if the item is visible; otherwise, false is returned. + Returns \c true if the item is visible; otherwise, false is returned. Note that the item's general visibility is unrelated to whether or not it is actually being visualized by a QGraphicsView. @@ -2206,7 +2206,7 @@ bool QGraphicsItem::isVisible() const /*! \since 4.4 - Returns true if the item is visible to \a parent; otherwise, false is + Returns \c true if the item is visible to \a parent; otherwise, false is returned. \a parent can be 0, in which case this function will return whether the item is visible to the scene or not. @@ -2448,7 +2448,7 @@ void QGraphicsItem::setVisible(bool visible) */ /*! - Returns true if the item is enabled; otherwise, false is returned. + Returns \c true if the item is enabled; otherwise, false is returned. \sa setEnabled() */ @@ -2552,7 +2552,7 @@ void QGraphicsItem::setEnabled(bool enabled) } /*! - Returns true if this item is selected; otherwise, false is returned. + Returns \c true if this item is selected; otherwise, false is returned. Items that are in a group inherit the group's selected state. @@ -2888,8 +2888,8 @@ QRectF QGraphicsItemPrivate::sceneEffectiveBoundingRect() const } /*! - Returns true if this item can accept drag and drop events; otherwise, - returns false. By default, items do not accept drag and drop events; items + Returns \c true if this item can accept drag and drop events; otherwise, + returns \c false. By default, items do not accept drag and drop events; items are transparent to drag and drop. \sa setAcceptDrops() @@ -2956,8 +2956,8 @@ void QGraphicsItem::setAcceptedMouseButtons(Qt::MouseButtons buttons) /*! \since 4.4 - Returns true if an item accepts hover events - (QGraphicsSceneHoverEvent); otherwise, returns false. By default, + Returns \c true if an item accepts hover events + (QGraphicsSceneHoverEvent); otherwise, returns \c false. By default, items do not accept hover events. \sa setAcceptedMouseButtons() @@ -3025,8 +3025,8 @@ void QGraphicsItem::setAcceptHoverEvents(bool enabled) /*! \since 4.6 - Returns true if an item accepts \l{QTouchEvent}{touch events}; - otherwise, returns false. By default, items do not accept touch events. + Returns \c true if an item accepts \l{QTouchEvent}{touch events}; + otherwise, returns \c false. By default, items do not accept touch events. \sa setAcceptTouchEvents() */ @@ -3056,7 +3056,7 @@ void QGraphicsItem::setAcceptTouchEvents(bool enabled) /*! \since 4.6 - Returns true if this item filters child events (i.e., all events + Returns \c true if this item filters child events (i.e., all events intended for any of its children are instead sent to this item); otherwise, false is returned. @@ -3092,7 +3092,7 @@ void QGraphicsItem::setFiltersChildEvents(bool enabled) /*! \obsolete - Returns true if this item handles child events (i.e., all events + Returns \c true if this item handles child events (i.e., all events intended for any of its children are instead sent to this item); otherwise, false is returned. @@ -3141,7 +3141,7 @@ void QGraphicsItem::setHandlesChildEvents(bool enabled) } /*! \since 4.6 - Returns true if this item is active; otherwise returns false. + Returns \c true if this item is active; otherwise returns \c false. An item can only be active if the scene is active. An item is active if it is, or is a descendent of, an active panel. Items in non-active @@ -3203,8 +3203,8 @@ void QGraphicsItem::setActive(bool active) } /*! - Returns true if this item is active, and it or its \l{focusProxy()}{focus - proxy} has keyboard input focus; otherwise, returns false. + Returns \c true if this item is active, and it or its \l{focusProxy()}{focus + proxy} has keyboard input focus; otherwise, returns \c false. \sa focusItem(), setFocus(), QGraphicsScene::setFocusItem(), isActive() */ @@ -4839,7 +4839,7 @@ QPainterPath QGraphicsItem::shape() const } /*! - Returns true if this item is clipped. An item is clipped if it has either + Returns \c true if this item is clipped. An item is clipped if it has either set the \l ItemClipsToShape flag, or if it or any of its ancestors has set the \l ItemClipsChildrenToShape flag. @@ -4922,7 +4922,7 @@ QPainterPath QGraphicsItem::clipPath() const } /*! - Returns true if this item contains \a point, which is in local + Returns \c true if this item contains \a point, which is in local coordinates; otherwise, false is returned. It is most often called from QGraphicsView to determine what item is under the cursor, and for that reason, the implementation of this function should be as light-weight as @@ -4940,8 +4940,8 @@ bool QGraphicsItem::contains(const QPointF &point) const /*! - Returns true if this item collides with \a other; otherwise - returns false. + Returns \c true if this item collides with \a other; otherwise + returns \c false. The \a mode is applied to \a other, and the resulting shape or bounding rectangle is then compared to this item's shape. The @@ -4997,7 +4997,7 @@ bool QGraphicsItem::collidesWithItem(const QGraphicsItem *other, Qt::ItemSelecti } /*! - Returns true if this item collides with \a path. + Returns \c true if this item collides with \a path. The collision is determined by \a mode. The default value for \a mode is Qt::IntersectsItemShape; \a path collides with this item if it either @@ -5067,7 +5067,7 @@ QList<QGraphicsItem *> QGraphicsItem::collidingItems(Qt::ItemSelectionMode mode) Item obscurity helper function. - Returns true if the subrect \a rect of \a item's bounding rect is obscured + Returns \c true if the subrect \a rect of \a item's bounding rect is obscured by \a other (i.e., \a other's opaque area covers \a item's \a rect completely. \a other is assumed to already be "on top of" \a item wrt. stacking order. @@ -5083,7 +5083,7 @@ static bool qt_QGraphicsItem_isObscured(const QGraphicsItem *item, \overload \since 4.3 - Returns true if \a rect is completely obscured by the opaque shape of any + Returns \c true if \a rect is completely obscured by the opaque shape of any of colliding items above it (i.e., with a higher Z value than this item). \sa opaqueArea() @@ -5115,7 +5115,7 @@ bool QGraphicsItem::isObscured(const QRectF &rect) const */ /*! - Returns true if this item's bounding rect is completely obscured by the + Returns \c true if this item's bounding rect is completely obscured by the opaque shape of \a item. The base implementation maps \a item's opaqueArea() to this item's @@ -5317,7 +5317,7 @@ void QGraphicsItem::setBoundingRegionGranularity(qreal granularity) /*! \internal - Returns true if we can discard an update request; otherwise false. + Returns \c true if we can discard an update request; otherwise false. */ bool QGraphicsItemPrivate::discardUpdateRequest(bool ignoreVisibleBit, bool ignoreDirtyBit, bool ignoreOpacity) const @@ -5646,7 +5646,7 @@ bool QGraphicsItemPrivate::isProxyWidget() const As a side effect of the item being repainted, other items that overlap the area \a rect may also be repainted. - If the item is invisible (i.e., isVisible() returns false), this function + If the item is invisible (i.e., isVisible() returns \c false), this function does nothing. \sa paint(), boundingRect() @@ -6404,7 +6404,7 @@ QPainterPath QGraphicsItem::mapFromScene(const QPainterPath &path) const } /*! - Returns true if this item is an ancestor of \a child (i.e., if this item + Returns \c true if this item is an ancestor of \a child (i.e., if this item is \a child's parent, or one of \a child's parent's ancestors). \sa parentItem() @@ -6458,7 +6458,7 @@ QGraphicsItem *QGraphicsItem::commonAncestorItem(const QGraphicsItem *other) con /*! \since 4,4 - Returns true if this item is currently under the mouse cursor in one of + Returns \c true if this item is currently under the mouse cursor in one of the views; otherwise, false is returned. \sa QGraphicsScene::views(), QCursor::pos() @@ -6627,7 +6627,7 @@ bool QGraphicsItem::sceneEventFilter(QGraphicsItem *watched, QEvent *event) mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent(), and mouseDoubleClickEvent(). - Returns true if the event was recognized and handled; otherwise, (e.g., if + Returns \c true if the event was recognized and handled; otherwise, (e.g., if the event type was not recognized,) false is returned. \a event is the intercepted event. @@ -7944,7 +7944,7 @@ void QGraphicsItemPrivate::resetHeight() This property is declared in QGraphicsItem. - By default, this property is true. + By default, this property is \c true. \sa QGraphicsItem::isEnabled(), QGraphicsItem::setEnabled() */ @@ -7963,7 +7963,7 @@ void QGraphicsItemPrivate::resetHeight() This property is declared in QGraphicsItem. - By default, this property is true. + By default, this property is \c true. \sa QGraphicsItem::isVisible(), QGraphicsItem::setVisible() */ @@ -10510,7 +10510,7 @@ void QGraphicsTextItem::setTabChangesFocus(bool b) /*! \since 4.5 - Returns true if the \uicontrol Tab key will cause the widget to change focus; + Returns \c true if the \uicontrol Tab key will cause the widget to change focus; otherwise, false is returned. By default, this behavior is disabled, and this function will return false. diff --git a/src/widgets/graphicsview/qgraphicsitem_p.h b/src/widgets/graphicsview/qgraphicsitem_p.h index d80df7c4ad..3968d89a13 100644 --- a/src/widgets/graphicsview/qgraphicsitem_p.h +++ b/src/widgets/graphicsview/qgraphicsitem_p.h @@ -720,7 +720,7 @@ public: #endif //QT_NO_GRAPHICSEFFECT /*! - Returns true if \a item1 is on top of \a item2. + Returns \c true if \a item1 is on top of \a item2. The items don't need to be siblings. \internal @@ -774,7 +774,7 @@ inline bool qt_closestItemFirst(const QGraphicsItem *item1, const QGraphicsItem } /*! - Returns true if \a item2 is on top of \a item1. + Returns \c true if \a item2 is on top of \a item1. The items don't need to be siblings. \internal diff --git a/src/widgets/graphicsview/qgraphicslayout.cpp b/src/widgets/graphicsview/qgraphicslayout.cpp index f7c89cf376..f2ff1fa562 100644 --- a/src/widgets/graphicsview/qgraphicslayout.cpp +++ b/src/widgets/graphicsview/qgraphicslayout.cpp @@ -291,8 +291,8 @@ void QGraphicsLayout::activate() } /*! - Returns true if the layout is currently being activated; otherwise, - returns false. If the layout is being activated, this means that it is + Returns \c true if the layout is currently being activated; otherwise, + returns \c false. If the layout is being activated, this means that it is currently in the process of rearranging its items (i.e., the activate() function has been called, and has not yet returned). @@ -515,7 +515,7 @@ void QGraphicsLayout::setInstantInvalidatePropagation(bool enable) \since 4.8 \sa setInstantInvalidatePropagation() - returns true if the complete widget/layout hierarchy is rearranged in one go. + returns \c true if the complete widget/layout hierarchy is rearranged in one go. */ bool QGraphicsLayout::instantInvalidatePropagation() { diff --git a/src/widgets/graphicsview/qgraphicslayoutitem.cpp b/src/widgets/graphicsview/qgraphicslayoutitem.cpp index 78b75e08d1..2eaac6a57e 100644 --- a/src/widgets/graphicsview/qgraphicslayoutitem.cpp +++ b/src/widgets/graphicsview/qgraphicslayoutitem.cpp @@ -374,7 +374,7 @@ bool QGraphicsLayoutItemPrivate::hasWidthForHeight() const parentLayoutItem() function returns a pointer to the item's layoutItem parent. If the item's parent is 0 or if the parent does not inherit from QGraphicsItem, the parentLayoutItem() function then returns 0. - isLayout() returns true if the QGraphicsLayoutItem subclass is itself a + isLayout() returns \c true if the QGraphicsLayoutItem subclass is itself a layout, or false otherwise. Qt uses QGraphicsLayoutItem to provide layout functionality in the @@ -853,9 +853,9 @@ void QGraphicsLayoutItem::setParentLayoutItem(QGraphicsLayoutItem *parent) } /*! - Returns true if this QGraphicsLayoutItem is a layout (e.g., is inherited + Returns \c true if this QGraphicsLayoutItem is a layout (e.g., is inherited by an object that arranges other QGraphicsLayoutItem objects); otherwise - returns false. + returns \c false. \sa QGraphicsLayout */ diff --git a/src/widgets/graphicsview/qgraphicsscene.cpp b/src/widgets/graphicsview/qgraphicsscene.cpp index 394c24d671..ad7a82518e 100644 --- a/src/widgets/graphicsview/qgraphicsscene.cpp +++ b/src/widgets/graphicsview/qgraphicsscene.cpp @@ -1215,9 +1215,9 @@ bool QGraphicsScenePrivate::filterEvent(QGraphicsItem *item, QEvent *event) \internal This is the final dispatch point for any events from the scene to the - item. It filters the event first - if the filter returns true, the event + item. It filters the event first - if the filter returns \c true, the event is considered to have been eaten by the filter, and is therefore stopped - (the default filter returns false). Then/otherwise, if the item is + (the default filter returns \c false). Then/otherwise, if the item is enabled, the event is sent; otherwise it is stopped. */ bool QGraphicsScenePrivate::sendEvent(QGraphicsItem *item, QEvent *event) @@ -1988,7 +1988,7 @@ QList<QGraphicsItem *> QGraphicsScene::items(Qt::SortOrder order) const \brief Returns all visible items that, depending on \a mode, are either inside or intersect with the rectangle defined by \a x, \a y, \a w and \a h, in a list sorted using \a order. In this case, "visible" defines items for which: - isVisible() returns true, effectiveOpacity() returns a value greater than 0.0 + isVisible() returns \c true, effectiveOpacity() returns a value greater than 0.0 (which is fully transparent) and the parent item does not clip it. \a deviceTransform is the transformation that applies to the view, and needs to @@ -2001,7 +2001,7 @@ QList<QGraphicsItem *> QGraphicsScene::items(Qt::SortOrder order) const \brief Returns all visible items that, depending on \a mode, are at the specified \a pos in a list sorted using \a order. In this case, "visible" defines items for which: - isVisible() returns true, effectiveOpacity() returns a value greater than 0.0 + isVisible() returns \c true, effectiveOpacity() returns a value greater than 0.0 (which is fully transparent) and the parent item does not clip it. The default value for \a mode is Qt::IntersectsItemShape; all items whose @@ -2027,7 +2027,7 @@ QList<QGraphicsItem *> QGraphicsScene::items(const QPointF &pos, Qt::ItemSelecti \brief Returns all visible items that, depending on \a mode, are either inside or intersect with the specified \a rect, in a list sorted using \a order. In this case, "visible" defines items for which: - isVisible() returns true, effectiveOpacity() returns a value greater than 0.0 + isVisible() returns \c true, effectiveOpacity() returns a value greater than 0.0 (which is fully transparent) and the parent item does not clip it. The default value for \a mode is Qt::IntersectsItemShape; all items whose @@ -2053,7 +2053,7 @@ QList<QGraphicsItem *> QGraphicsScene::items(const QRectF &rect, Qt::ItemSelecti \brief Returns all visible items that, depending on \a mode, are either inside or intersect with the specified \a polygon, in a list sorted using \a order. In this case, "visible" defines items for which: - isVisible() returns true, effectiveOpacity() returns a value greater than 0.0 + isVisible() returns \c true, effectiveOpacity() returns a value greater than 0.0 (which is fully transparent) and the parent item does not clip it. The default value for \a mode is Qt::IntersectsItemShape; all items whose @@ -2079,7 +2079,7 @@ QList<QGraphicsItem *> QGraphicsScene::items(const QPolygonF &polygon, Qt::ItemS \brief Returns all visible items that, depending on \a mode, are either inside or intersect with the specified \a path, in a list sorted using \a order. In this case, "visible" defines items for which: - isVisible() returns true, effectiveOpacity() returns a value greater than 0.0 + isVisible() returns \c true, effectiveOpacity() returns a value greater than 0.0 (which is fully transparent) and the parent item does not clip it. The default value for \a mode is Qt::IntersectsItemShape; all items whose @@ -2626,7 +2626,7 @@ void QGraphicsScene::addItem(QGraphicsItem *item) Note that the item's geometry is provided in item coordinates, and its position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2658,7 +2658,7 @@ QGraphicsEllipseItem *QGraphicsScene::addEllipse(const QRectF &rect, const QPen Note that the item's geometry is provided in item coordinates, and its position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2689,7 +2689,7 @@ QGraphicsLineItem *QGraphicsScene::addLine(const QLineF &line, const QPen &pen) Note that the item's geometry is provided in item coordinates, and its position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2712,7 +2712,7 @@ QGraphicsPathItem *QGraphicsScene::addPath(const QPainterPath &path, const QPen Note that the item's geometry is provided in item coordinates, and its position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2734,7 +2734,7 @@ QGraphicsPixmapItem *QGraphicsScene::addPixmap(const QPixmap &pixmap) Note that the item's geometry is provided in item coordinates, and its position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2761,7 +2761,7 @@ QGraphicsPolygonItem *QGraphicsScene::addPolygon(const QPolygonF &polygon, 100) is added, its top-left corner will be at (50, 50) relative to the origin in the items coordinate system. - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2792,7 +2792,7 @@ QGraphicsRectItem *QGraphicsScene::addRect(const QRectF &rect, const QPen &pen, The item's position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2814,7 +2814,7 @@ QGraphicsTextItem *QGraphicsScene::addText(const QString &text, const QFont &fon The item's position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2836,7 +2836,7 @@ QGraphicsSimpleTextItem *QGraphicsScene::addSimpleText(const QString &text, cons The item's position is initialized to (0, 0). - If the item is visible (i.e., QGraphicsItem::isVisible() returns true), + If the item is visible (i.e., QGraphicsItem::isVisible() returns \c true), QGraphicsScene will emit changed() once control goes back to the event loop. @@ -2923,7 +2923,7 @@ QGraphicsItem *QGraphicsScene::focusItem() const focusitem. If item is not 0, and the scene does not currently have focus (i.e., - hasFocus() returns false), this function will call setFocus() + hasFocus() returns \c false), this function will call setFocus() automatically. \sa focusItem(), hasFocus(), setFocus() @@ -2938,7 +2938,7 @@ void QGraphicsScene::setFocusItem(QGraphicsItem *item, Qt::FocusReason focusReas } /*! - Returns true if the scene has focus; otherwise returns false. If the scene + Returns \c true if the scene has focus; otherwise returns \c false. If the scene has focus, it will will forward key events from QKeyEvent to any item that has focus. @@ -2998,7 +2998,7 @@ void QGraphicsScene::clearFocus() unchanged when the user clicks into the scene background or on an item that does not accept focus. Otherwise, focus will be cleared. - By default, this property is false. + By default, this property is \c false. Focus changes in response to a mouse press. You can reimplement mousePressEvent() in a subclass of QGraphicsScene to toggle this property @@ -4311,7 +4311,7 @@ static void _q_paintIntoCache(QPixmap *pix, QGraphicsItem *item, const QRegion & } // Copied from qpaintengine_vg.cpp -// Returns true for 90, 180, and 270 degree rotations. +// Returns \c true for 90, 180, and 270 degree rotations. static inline bool transformIsSimple(const QTransform& transform) { QTransform::TransformationType type = transform.type(); @@ -5330,7 +5330,7 @@ void QGraphicsScene::drawItems(QPainter *painter, \since 4.4 Finds a new widget to give the keyboard focus to, as appropriate for Tab - and Shift+Tab, and returns true if it can find a new widget, or false if + and Shift+Tab, and returns \c true if it can find a new widget, or false if it cannot. If \a next is true, this function searches forward; if \a next is false, it searches backward. @@ -5603,8 +5603,8 @@ void QGraphicsScene::setPalette(const QPalette &palette) /*! \since 4.6 - Returns true if the scene is active (e.g., it's viewed by - at least one QGraphicsView that is active); otherwise returns false. + Returns \c true if the scene is active (e.g., it's viewed by + at least one QGraphicsView that is active); otherwise returns \c false. \sa QGraphicsItem::isActive(), QWidget::isActiveWindow() */ diff --git a/src/widgets/graphicsview/qgraphicsview.cpp b/src/widgets/graphicsview/qgraphicsview.cpp index a39c084798..86648c4f26 100644 --- a/src/widgets/graphicsview/qgraphicsview.cpp +++ b/src/widgets/graphicsview/qgraphicsview.cpp @@ -1661,7 +1661,7 @@ void QGraphicsView::invalidateScene(const QRectF &rect, QGraphicsScene::SceneLay view will not allow interaction, and any mouse or key events are ignored (i.e., it will act as a read-only view). - By default, this property is true. + By default, this property is \c true. */ bool QGraphicsView::isInteractive() const { @@ -3825,7 +3825,7 @@ QTransform QGraphicsView::viewportTransform() const /*! \since 4.6 - Returns true if the view is transformed (i.e., a non-identity transform + Returns \c true if the view is transformed (i.e., a non-identity transform has been assigned, or the scrollbars are adjusted). \sa setTransform(), horizontalScrollBar(), verticalScrollBar() diff --git a/src/widgets/graphicsview/qgraphicswidget.cpp b/src/widgets/graphicsview/qgraphicswidget.cpp index 3d902d9227..4abb5e39e5 100644 --- a/src/widgets/graphicsview/qgraphicswidget.cpp +++ b/src/widgets/graphicsview/qgraphicswidget.cpp @@ -1043,7 +1043,7 @@ void QGraphicsWidget::setPalette(const QPalette &palette) In addition, Windows are always filled with QPalette::Window, unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set. - By default, this property is false. + By default, this property is \c false. \sa Qt::WA_OpaquePaintEvent, Qt::WA_NoSystemBackground, */ @@ -1239,8 +1239,8 @@ bool QGraphicsWidget::sceneEvent(QEvent *event) You can reimplement this handler in a subclass of QGraphicsWidget to provide your own custom window frame interaction support. - Returns true if \a event has been recognized and processed; otherwise, - returns false. + Returns \c true if \a event has been recognized and processed; otherwise, + returns \c false. \sa event() */ @@ -1524,7 +1524,7 @@ void QGraphicsWidget::focusInEvent(QFocusEvent *event) /*! Finds a new widget to give the keyboard focus to, as appropriate for Tab - and Shift+Tab, and returns true if it can find a new widget; returns false + and Shift+Tab, and returns \c true if it can find a new widget; returns \c false otherwise. If \a next is true, this function searches forward; if \a next is false, it searches backward. @@ -1782,7 +1782,7 @@ void QGraphicsWidget::setWindowFlags(Qt::WindowFlags wFlags) } /*! - Returns true if this widget's window is in the active window, or if the + Returns \c true if this widget's window is in the active window, or if the widget does not have a window but is in an active scene (i.e., a scene that currently has focus). @@ -2193,8 +2193,8 @@ void QGraphicsWidget::setAttribute(Qt::WidgetAttribute attribute, bool on) } /*! - Returns true if \a attribute is enabled for this widget; otherwise, - returns false. + Returns \c true if \a attribute is enabled for this widget; otherwise, + returns \c false. \sa setAttribute() */ @@ -2364,7 +2364,7 @@ QPainterPath QGraphicsWidget::shape() const /*! Call this function to close the widget. - Returns true if the widget was closed; otherwise returns false. + Returns \c true if the widget was closed; otherwise returns \c false. This slot will first send a QCloseEvent to the widget, which may or may not accept the event. If the event was ignored, nothing happens. If the event was accepted, it will hide() the widget. diff --git a/src/widgets/graphicsview/qgridlayoutengine.cpp b/src/widgets/graphicsview/qgridlayoutengine.cpp index f741962264..a1affdb55e 100644 --- a/src/widgets/graphicsview/qgridlayoutengine.cpp +++ b/src/widgets/graphicsview/qgridlayoutengine.cpp @@ -570,7 +570,7 @@ QSizePolicy::Policy QGridLayoutItem::sizePolicy(Qt::Orientation orientation) con } /* - returns true if the size policy returns true for either hasHeightForWidth() + returns \c true if the size policy returns \c true for either hasHeightForWidth() or hasWidthForHeight() */ bool QGridLayoutItem::hasDynamicConstraint() const @@ -1657,7 +1657,7 @@ void QGridLayoutEngine::ensureColumnAndRowData(QGridLayoutRowData *rowData, QGri } /** - returns false if the layout has contradicting constraints (i.e. some items with a horizontal + returns \c false if the layout has contradicting constraints (i.e. some items with a horizontal constraint and other items with a vertical constraint) */ bool QGridLayoutEngine::ensureDynamicConstraint() const @@ -1691,7 +1691,7 @@ bool QGridLayoutEngine::hasDynamicConstraint() const } /* - * return value is only valid if hasConstraint() returns true + * return value is only valid if hasConstraint() returns \c true */ Qt::Orientation QGridLayoutEngine::constraintOrientation() const { diff --git a/src/widgets/itemviews/qabstractitemdelegate.cpp b/src/widgets/itemviews/qabstractitemdelegate.cpp index 7786a74cc6..16a6e2ca38 100644 --- a/src/widgets/itemviews/qabstractitemdelegate.cpp +++ b/src/widgets/itemviews/qabstractitemdelegate.cpp @@ -316,7 +316,7 @@ void QAbstractItemDelegate::updateEditorGeometry(QWidget *, to open a context menu when the right mouse button is pressed on an item. - The base implementation returns false (indicating that it has not + The base implementation returns \c false (indicating that it has not handled the event). */ bool QAbstractItemDelegate::editorEvent(QEvent *, @@ -354,7 +354,7 @@ QString QAbstractItemDelegate::elidedText(const QFontMetrics &fontMetrics, int w \a view \a option and the \a index that corresponds to the item where the event occurs. - Returns true if the delegate can handle the event; otherwise returns false. + Returns \c true if the delegate can handle the event; otherwise returns \c false. A return value of true indicates that the data obtained using the index had the required role. diff --git a/src/widgets/itemviews/qabstractitemview.cpp b/src/widgets/itemviews/qabstractitemview.cpp index f4a98d2575..35ba1ed74e 100644 --- a/src/widgets/itemviews/qabstractitemview.cpp +++ b/src/widgets/itemviews/qabstractitemview.cpp @@ -566,8 +566,8 @@ void QAbstractItemViewPrivate::_q_scrollerStateChanged() /*! \fn bool QAbstractItemView::isIndexHidden(const QModelIndex &index) const - Returns true if the item referred to by the given \a index is hidden in the view, - otherwise returns false. + Returns \c true if the item referred to by the given \a index is hidden in the view, + otherwise returns \c false. Hiding is a view specific feature. For example in TableView a column can be marked as hidden or a row in the TreeView. @@ -1495,11 +1495,11 @@ Qt::DropAction QAbstractItemView::defaultDropAction() const \property QAbstractItemView::alternatingRowColors \brief whether to draw the background using alternating colors - If this property is true, the item background will be drawn using + If this property is \c true, the item background will be drawn using QPalette::Base and QPalette::AlternateBase; otherwise the background will be drawn using the QPalette::Base color. - By default, this property is false. + By default, this property is \c false. */ void QAbstractItemView::setAlternatingRowColors(bool enable) { @@ -2061,7 +2061,7 @@ void QAbstractItemView::dropEvent(QDropEvent *event) else // place at row, col in drop index - If it returns true a drop can be done, and dropRow, dropCol and dropIndex reflects the position of the drop. + If it returns \c true a drop can be done, and dropRow, dropCol and dropIndex reflects the position of the drop. \internal */ bool QAbstractItemViewPrivate::dropOn(QDropEvent *event, int *dropRow, int *dropCol, QModelIndex *dropIndex) @@ -2547,8 +2547,8 @@ QModelIndexList QAbstractItemView::selectedIndexes() const /*! Starts editing the item at \a index, creating an editor if - necessary, and returns true if the view's \l{State} is now - EditingState; otherwise returns false. + necessary, and returns \c true if the view's \l{State} is now + EditingState; otherwise returns \c false. The action that caused the editing process is described by \a trigger, and the associated event is specified by \a event. diff --git a/src/widgets/itemviews/qdatawidgetmapper.cpp b/src/widgets/itemviews/qdatawidgetmapper.cpp index e5b7e810fb..76d01dbb2b 100644 --- a/src/widgets/itemviews/qdatawidgetmapper.cpp +++ b/src/widgets/itemviews/qdatawidgetmapper.cpp @@ -610,7 +610,7 @@ void QDataWidgetMapper::revert() value from the widget and sets it in the model. Finally, the model's \l {QAbstractItemModel::}{submit()} method is invoked. - Returns true if all the values were submitted, otherwise false. + Returns \c true if all the values were submitted, otherwise false. Note: For database models, QSqlQueryModel::lastError() can be used to retrieve the last error. diff --git a/src/widgets/itemviews/qdirmodel.cpp b/src/widgets/itemviews/qdirmodel.cpp index e1ba0ede57..1e51f4e073 100644 --- a/src/widgets/itemviews/qdirmodel.cpp +++ b/src/widgets/itemviews/qdirmodel.cpp @@ -395,8 +395,8 @@ QVariant QDirModel::data(const QModelIndex &index, int role) const /*! Sets the data for the model item \a index with the given \a role to - the data referenced by the \a value. Returns true if successful; - otherwise returns false. + the data referenced by the \a value. Returns \c true if successful; + otherwise returns \c false. \sa Qt::ItemDataRole */ @@ -456,8 +456,8 @@ QVariant QDirModel::headerData(int section, Qt::Orientation orientation, int rol } /*! - Returns true if the \a parent model item has children; otherwise - returns false. + Returns \c true if the \a parent model item has children; otherwise + returns \c false. */ bool QDirModel::hasChildren(const QModelIndex &parent) const @@ -566,7 +566,7 @@ QMimeData *QDirModel::mimeData(const QModelIndexList &indexes) const the given \a action over the row in the model specified by the \a row and \a column and by the \a parent index. - Returns true if the drop was successful, and false otherwise. + Returns \c true if the drop was successful, and false otherwise. \sa supportedDropActions() */ @@ -771,7 +771,7 @@ bool QDirModel::resolveSymlinks() const If this property is set to false, the directory model will allow renaming, copying and deleting of files and directories. - This property is true by default + This property is \c true by default */ void QDirModel::setReadOnly(bool enable) @@ -796,7 +796,7 @@ bool QDirModel::isReadOnly() const Otherwise the directory model will report that an item has children if the item is a directory. - This property is false by default + This property is \c false by default */ void QDirModel::setLazyChildCount(bool enable) @@ -966,8 +966,8 @@ QModelIndex QDirModel::index(const QString &path, int column) const } /*! - Returns true if the model item \a index represents a directory; - otherwise returns false. + Returns \c true if the model item \a index represents a directory; + otherwise returns \c false. */ bool QDirModel::isDir(const QModelIndex &index) const diff --git a/src/widgets/itemviews/qheaderview.cpp b/src/widgets/itemviews/qheaderview.cpp index 239cc84a0a..123594637a 100644 --- a/src/widgets/itemviews/qheaderview.cpp +++ b/src/widgets/itemviews/qheaderview.cpp @@ -294,7 +294,7 @@ static const int maxSizeSection = 1048575; // since section size is in a bitfiel \property QHeaderView::highlightSections \brief whether the sections containing selected items are highlighted - By default, this property is false. + By default, this property is \c false. */ /*! @@ -982,8 +982,8 @@ void QHeaderView::resizeSections(QHeaderView::ResizeMode mode) */ /*! - Returns true if the section specified by \a logicalIndex is explicitly - hidden from the user; otherwise returns false. + Returns \c true if the section specified by \a logicalIndex is explicitly + hidden from the user; otherwise returns \c false. \sa hideSection(), showSection(), setSectionHidden(), hiddenSectionCount() */ @@ -1139,7 +1139,7 @@ void QHeaderView::setSectionsMovable(bool movable) /*! \since 5.0 - Returns true if the header can be moved by the user; otherwise returns + Returns \c true if the header can be moved by the user; otherwise returns false. \sa setSectionsMovable() @@ -1189,7 +1189,7 @@ void QHeaderView::setSectionsClickable(bool clickable) /*! \since 5.0 - Returns true if the header is clickable; otherwise returns false. A + Returns \c true if the header is clickable; otherwise returns \c false. A clickable header could be set up to allow the user to change the representation of the data in the view related to the header. @@ -1395,7 +1395,7 @@ int QHeaderView::stretchSectionCount() const \property QHeaderView::showSortIndicator \brief whether the sort indicator is shown - By default, this property is false. + By default, this property is \c false. \sa setSectionsClickable() */ @@ -1681,7 +1681,7 @@ void QHeaderView::doItemsLayout() } /*! - Returns true if sections in the header has been moved; otherwise returns + Returns \c true if sections in the header has been moved; otherwise returns false; \sa moveSection() @@ -1695,7 +1695,7 @@ bool QHeaderView::sectionsMoved() const /*! \since 4.1 - Returns true if sections in the header has been hidden; otherwise returns + Returns \c true if sections in the header has been hidden; otherwise returns false; \sa setSectionHidden() diff --git a/src/widgets/itemviews/qitemdelegate.cpp b/src/widgets/itemviews/qitemdelegate.cpp index 3e34568a12..0b654a7485 100644 --- a/src/widgets/itemviews/qitemdelegate.cpp +++ b/src/widgets/itemviews/qitemdelegate.cpp @@ -1146,8 +1146,8 @@ QRect QItemDelegate::textRectangle(QPainter * /*painter*/, const QRect &rect, /*! \fn bool QItemDelegate::eventFilter(QObject *editor, QEvent *event) - Returns true if the given \a editor is a valid QWidget and the - given \a event is handled; otherwise returns false. The following + Returns \c true if the given \a editor is a valid QWidget and the + given \a event is handled; otherwise returns \c false. The following key press events are handled by default: \list diff --git a/src/widgets/itemviews/qlistview.cpp b/src/widgets/itemviews/qlistview.cpp index 331748eedc..e5a8647f87 100644 --- a/src/widgets/itemviews/qlistview.cpp +++ b/src/widgets/itemviews/qlistview.cpp @@ -251,7 +251,7 @@ QListView::Movement QListView::movement() const \brief which direction the items layout should flow. If this property is \l LeftToRight, the items will be laid out left - to right. If the \l isWrapping property is true, the layout will wrap + to right. If the \l isWrapping property is \c true, the layout will wrap when it reaches the right side of the visible area. If this property is \l TopToBottom, the items will be laid out from the top of the visible area, wrapping when it reaches the bottom. @@ -288,7 +288,7 @@ QListView::Flow QListView::flow() const Setting this property when the view is visible will cause the items to be laid out again. - By default, this property is false. + By default, this property is \c false. \sa viewMode */ @@ -527,7 +527,7 @@ void QListView::clearPropertyFlags() } /*! - Returns true if the \a row is hidden; otherwise returns false. + Returns \c true if the \a row is hidden; otherwise returns \c false. */ bool QListView::isRowHidden(int row) const { @@ -1529,7 +1529,7 @@ int QListView::modelColumn() const in the view have the same size. This enables the view to do some optimizations for performance purposes. - By default, this property is false. + By default, this property is \c false. */ void QListView::setUniformItemSizes(bool enable) { @@ -1548,9 +1548,9 @@ bool QListView::uniformItemSizes() const \brief the item text word-wrapping policy \since 4.2 - If this property is true then the item text is wrapped where + If this property is \c true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. - This property is false by default. + This property is \c false by default. Please note that even if wrapping is enabled, the cell will not be expanded to make room for the text. It will print ellipsis for @@ -1577,7 +1577,7 @@ bool QListView::wordWrap() const \brief if the selection rectangle should be visible \since 4.3 - If this property is true then the selection rectangle is visible; + If this property is \c true then the selection rectangle is visible; otherwise it will be hidden. \note The selection rectangle will only be visible if the selection mode @@ -1585,7 +1585,7 @@ bool QListView::wordWrap() const draw a selection rectangle if the selection mode is QAbstractItemView::SingleSelection. - By default, this property is false. + By default, this property is \c false. */ void QListView::setSelectionRectVisible(bool show) { @@ -2013,7 +2013,7 @@ void QListModeViewBase::dragMoveEvent(QDragMoveEvent *event) else // place at row, col in drop index - If it returns true a drop can be done, and dropRow, dropCol and dropIndex reflects the position of the drop. + If it returns \c true a drop can be done, and dropRow, dropCol and dropIndex reflects the position of the drop. \internal */ bool QListModeViewBase::dropOn(QDropEvent *event, int *dropRow, int *dropCol, QModelIndex *dropIndex) diff --git a/src/widgets/itemviews/qlistwidget.cpp b/src/widgets/itemviews/qlistwidget.cpp index 27abfb8eb4..aa1dbf1de3 100644 --- a/src/widgets/itemviews/qlistwidget.cpp +++ b/src/widgets/itemviews/qlistwidget.cpp @@ -555,7 +555,7 @@ Qt::DropActions QListModel::supportedDropActions() const \fn bool QListWidgetItem::isSelected() const \since 4.2 - Returns true if the item is selected; otherwise returns false. + Returns \c true if the item is selected; otherwise returns \c false. \sa setSelected() */ @@ -573,7 +573,7 @@ Qt::DropActions QListModel::supportedDropActions() const \fn bool QListWidgetItem::isHidden() const \since 4.2 - Returns true if the item is hidden; otherwise returns false. + Returns \c true if the item is hidden; otherwise returns \c false. \sa setHidden() */ @@ -725,8 +725,8 @@ QVariant QListWidgetItem::data(int role) const } /*! - Returns true if this item's text is less then \a other item's text; - otherwise returns false. + Returns \c true if this item's text is less then \a other item's text; + otherwise returns \c false. */ bool QListWidgetItem::operator<(const QListWidgetItem &other) const { @@ -1555,7 +1555,7 @@ void QListWidget::sortItems(Qt::SortOrder order) \property QListWidget::sortingEnabled \brief whether sorting is enabled - If this property is true, sorting is enabled for the list; if the property + If this property is \c true, sorting is enabled for the list; if the property is false, sorting is not enabled. The default value is false. @@ -1648,7 +1648,7 @@ void QListWidget::setItemWidget(QListWidgetItem *item, QWidget *widget) } /*! - Returns true if \a item is selected; otherwise returns false. + Returns \c true if \a item is selected; otherwise returns \c false. \obsolete @@ -1717,7 +1717,7 @@ QList<QListWidgetItem*> QListWidget::findItems(const QString &text, Qt::MatchFla } /*! - Returns true if the \a item is explicitly hidden; otherwise returns false. + Returns \c true if the \a item is explicitly hidden; otherwise returns \c false. \obsolete @@ -1792,8 +1792,8 @@ QMimeData *QListWidget::mimeData(const QList<QListWidgetItem*>) const #ifndef QT_NO_DRAGANDDROP /*! Handles \a data supplied by an external drag and drop operation that ended - with the given \a action in the given \a index. Returns true if \a data and - \a action can be handled by the model; otherwise returns false. + with the given \a action in the given \a index. Returns \c true if \a data and + \a action can be handled by the model; otherwise returns \c false. \sa supportedDropActions() */ diff --git a/src/widgets/itemviews/qstyleditemdelegate.cpp b/src/widgets/itemviews/qstyleditemdelegate.cpp index c1fa9fe28e..c2aa630918 100644 --- a/src/widgets/itemviews/qstyleditemdelegate.cpp +++ b/src/widgets/itemviews/qstyleditemdelegate.cpp @@ -615,8 +615,8 @@ void QStyledItemDelegate::setItemEditorFactory(QItemEditorFactory *factory) /*! \fn bool QStyledItemDelegate::eventFilter(QObject *editor, QEvent *event) - Returns true if the given \a editor is a valid QWidget and the - given \a event is handled; otherwise returns false. The following + Returns \c true if the given \a editor is a valid QWidget and the + given \a event is handled; otherwise returns \c false. The following key press events are handled by default: \list diff --git a/src/widgets/itemviews/qtableview.cpp b/src/widgets/itemviews/qtableview.cpp index 871ad656ea..34e881571e 100644 --- a/src/widgets/itemviews/qtableview.cpp +++ b/src/widgets/itemviews/qtableview.cpp @@ -747,9 +747,9 @@ int QTableViewPrivate::sectionSpanSize(const QHeaderView *header, int logical, i /*! \internal - Returns true if the section at logical index \a logical is part of the span + Returns \c true if the section at logical index \a logical is part of the span starting at logical index \a spanLogical and spanning \a span sections; - otherwise, returns false. + otherwise, returns \c false. */ bool QTableViewPrivate::spanContainsSection(const QHeaderView *header, int logical, int spanLogical, int span) const { @@ -2482,7 +2482,7 @@ int QTableView::columnWidth(int column) const } /*! - Returns true if the given \a row is hidden; otherwise returns false. + Returns \c true if the given \a row is hidden; otherwise returns \c false. \sa isColumnHidden() */ @@ -2506,7 +2506,7 @@ void QTableView::setRowHidden(int row, bool hide) } /*! - Returns true if the given \a column is hidden; otherwise returns false. + Returns \c true if the given \a column is hidden; otherwise returns \c false. \sa isRowHidden() */ @@ -2535,8 +2535,8 @@ void QTableView::setColumnHidden(int column, bool hide) \property QTableView::sortingEnabled \brief whether sorting is enabled - If this property is true, sorting is enabled for the table. If - this property is false, sorting is not enabled. The default value + If this property is \c true, sorting is enabled for the table. If + this property is \c false, sorting is not enabled. The default value is false. \note. Setting the property to true with setSortingEnabled() @@ -2585,8 +2585,8 @@ bool QTableView::isSortingEnabled() const \property QTableView::showGrid \brief whether the grid is shown - If this property is true a grid is drawn for the table; if the - property is false, no grid is drawn. The default value is true. + If this property is \c true a grid is drawn for the table; if the + property is \c false, no grid is drawn. The default value is true. */ bool QTableView::showGrid() const { @@ -2629,9 +2629,9 @@ void QTableView::setGridStyle(Qt::PenStyle style) \brief the item text word-wrapping policy \since 4.3 - If this property is true then the item text is wrapped where + If this property is \c true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. - This property is true by default. + This property is \c true by default. Note that even of wrapping is enabled, the cell will not be expanded to fit all text. Ellipsis will be inserted according to @@ -2659,11 +2659,11 @@ bool QTableView::wordWrap() const \brief whether the button in the top-left corner is enabled \since 4.3 - If this property is true then button in the top-left corner + If this property is \c true then button in the top-left corner of the table view is enabled. Clicking on this button will select all the cells in the table view. - This property is true by default. + This property is \c true by default. */ void QTableView::setCornerButtonEnabled(bool enable) { diff --git a/src/widgets/itemviews/qtablewidget.cpp b/src/widgets/itemviews/qtablewidget.cpp index f15124605f..43b6b62cc1 100644 --- a/src/widgets/itemviews/qtablewidget.cpp +++ b/src/widgets/itemviews/qtablewidget.cpp @@ -1041,7 +1041,7 @@ QTableWidgetSelectionRange::~QTableWidgetSelectionRange() \fn bool QTableWidgetItem::isSelected() const \since 4.2 - Returns true if the item is selected, otherwise returns false. + Returns \c true if the item is selected, otherwise returns \c false. \sa setSelected() */ @@ -1395,7 +1395,7 @@ QVariant QTableWidgetItem::data(int role) const } /*! - Returns true if the item is less than the \a other item; otherwise returns + Returns \c true if the item is less than the \a other item; otherwise returns false. */ bool QTableWidgetItem::operator<(const QTableWidgetItem &other) const @@ -2280,7 +2280,7 @@ void QTableWidget::setCellWidget(int row, int column, QWidget *widget) } /*! - Returns true if the \a item is selected, otherwise returns false. + Returns \c true if the \a item is selected, otherwise returns \c false. \obsolete @@ -2567,8 +2567,8 @@ QMimeData *QTableWidget::mimeData(const QList<QTableWidgetItem*>) const /*! Handles the \a data supplied by a drag and drop operation that ended with the given \a action in the given \a row and \a column. - Returns true if the data and action can be handled by the model; - otherwise returns false. + Returns \c true if the data and action can be handled by the model; + otherwise returns \c false. \sa supportedDropActions() */ diff --git a/src/widgets/itemviews/qtreeview.cpp b/src/widgets/itemviews/qtreeview.cpp index 76e15faf2a..22cd9abc73 100644 --- a/src/widgets/itemviews/qtreeview.cpp +++ b/src/widgets/itemviews/qtreeview.cpp @@ -397,7 +397,7 @@ void QTreeView::setIndentation(int i) false, these controls are not shown for top-level items. This can be used to make a single level tree structure appear like a simple list of items. - By default, this property is true. + By default, this property is \c true. */ bool QTreeView::rootIsDecorated() const { @@ -425,7 +425,7 @@ void QTreeView::setRootIsDecorated(bool show) The height is obtained from the first item in the view. It is updated when the data changes on that item. - By default, this property is false. + By default, this property is \c false. */ bool QTreeView::uniformRowHeights() const { @@ -446,7 +446,7 @@ void QTreeView::setUniformRowHeights(bool uniform) This property holds whether the user can expand and collapse items interactively. - By default, this property is true. + By default, this property is \c true. */ bool QTreeView::itemsExpandable() const @@ -527,7 +527,7 @@ int QTreeView::columnAt(int x) const } /*! - Returns true if the \a column is hidden; otherwise returns false. + Returns \c true if the \a column is hidden; otherwise returns \c false. \sa hideColumn(), isRowHidden() */ @@ -555,7 +555,7 @@ void QTreeView::setColumnHidden(int column, bool hide) \brief whether the header is shown or not. \since 4.4 - If this property is true, the header is not shown otherwise it is. + If this property is \c true, the header is not shown otherwise it is. The default value is false. \sa header() @@ -573,8 +573,8 @@ void QTreeView::setHeaderHidden(bool hide) } /*! - Returns true if the item in the given \a row of the \a parent is hidden; - otherwise returns false. + Returns \c true if the item in the given \a row of the \a parent is hidden; + otherwise returns \c false. \sa setRowHidden(), isColumnHidden() */ @@ -612,8 +612,8 @@ void QTreeView::setRowHidden(int row, const QModelIndex &parent, bool hide) /*! \since 4.3 - Returns true if the item in first column in the given \a row - of the \a parent is spanning all the columns; otherwise returns false. + Returns \c true if the item in first column in the given \a row + of the \a parent is spanning all the columns; otherwise returns \c false. \sa setFirstColumnSpanned() */ @@ -810,7 +810,7 @@ void QTreeView::collapse(const QModelIndex &index) /*! \fn bool QTreeView::isExpanded(const QModelIndex &index) const - Returns true if the model item \a index is expanded; otherwise returns + Returns \c true if the model item \a index is expanded; otherwise returns false. \sa expand(), expanded(), setExpanded() @@ -840,7 +840,7 @@ void QTreeView::setExpanded(const QModelIndex &index, bool expanded) \property QTreeView::sortingEnabled \brief whether sorting is enabled - If this property is true, sorting is enabled for the tree; if the property + If this property is \c true, sorting is enabled for the tree; if the property is false, sorting is not enabled. The default value is false. \note In order to avoid performance issues, it is recommended that @@ -880,12 +880,12 @@ bool QTreeView::isSortingEnabled() const \property QTreeView::animated \brief whether animations are enabled - If this property is true the treeview will animate expansion - and collapsing of branches. If this property is false, the treeview + If this property is \c true the treeview will animate expansion + and collapsing of branches. If this property is \c false, the treeview will expand or collapse branches immediately without showing the animation. - By default, this property is false. + By default, this property is \c false. */ void QTreeView::setAnimated(bool animate) @@ -905,7 +905,7 @@ bool QTreeView::isAnimated() const \property QTreeView::allColumnsShowFocus \brief whether items should show keyboard focus using all columns - If this property is true all columns will show focus, otherwise only + If this property is \c true all columns will show focus, otherwise only one column will show focus. The default is false. @@ -931,9 +931,9 @@ bool QTreeView::allColumnsShowFocus() const \brief the item text word-wrapping policy \since 4.3 - If this property is true then the item text is wrapped where + If this property is \c true then the item text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. - This property is false by default. + This property is \c false by default. Note that even if wrapping is enabled, the cell will not be expanded to fit all text. Ellipsis will be inserted according to diff --git a/src/widgets/itemviews/qtreewidget.cpp b/src/widgets/itemviews/qtreewidget.cpp index f098236d5c..e75f602e90 100644 --- a/src/widgets/itemviews/qtreewidget.cpp +++ b/src/widgets/itemviews/qtreewidget.cpp @@ -103,7 +103,7 @@ public: \fn bool QTreeWidgetItem::isDisabled() const \since 4.3 - Returns true if the item is disabled; otherwise returns false. + Returns \c true if the item is disabled; otherwise returns \c false. \sa setFlags() */ @@ -380,7 +380,7 @@ QVariant QTreeModel::data(const QModelIndex &index, int role) const Sets the data for the item specified by the \a index and \a role to that referred to by the \a value. - Returns true if successful; otherwise returns false. + Returns \c true if successful; otherwise returns \c false. */ bool QTreeModel::setData(const QModelIndex &index, const QVariant &value, int role) @@ -537,7 +537,7 @@ QVariant QTreeModel::headerData(int section, Qt::Orientation orientation, int ro Sets the header data for the item specified by the header \a section, \a orientation and data \a role to the given \a value. - Returns true if successful; otherwise returns false. + Returns \c true if successful; otherwise returns \c false. */ bool QTreeModel::setHeaderData(int section, Qt::Orientation orientation, @@ -681,7 +681,7 @@ void QTreeModel::ensureSorted(int column, Qt::SortOrder order, /*! \internal - Returns true if the value of the \a left item is + Returns \c true if the value of the \a left item is less than the value of the \a right item. Used by the sorting functions. @@ -696,7 +696,7 @@ bool QTreeModel::itemLessThan(const QPair<QTreeWidgetItem*,int> &left, /*! \internal - Returns true if the value of the \a left item is + Returns \c true if the value of the \a left item is greater than the value of the \a right item. Used by the sorting functions. @@ -1001,7 +1001,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) \fn bool QTreeWidgetItem::isSelected() const \since 4.2 - Returns true if the item is selected, otherwise returns false. + Returns \c true if the item is selected, otherwise returns \c false. \sa setSelected() */ @@ -1019,7 +1019,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) \fn bool QTreeWidgetItem::isHidden() const \since 4.2 - Returns true if the item is hidden, otherwise returns false. + Returns \c true if the item is hidden, otherwise returns \c false. \sa setHidden() */ @@ -1038,7 +1038,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) \fn bool QTreeWidgetItem::isExpanded() const \since 4.2 - Returns true if the item is expanded, otherwise returns false. + Returns \c true if the item is expanded, otherwise returns \c false. \sa setExpanded() */ @@ -1057,7 +1057,7 @@ void QTreeModel::timerEvent(QTimerEvent *ev) \fn bool QTreeWidgetItem::isFirstColumnSpanned() const \since 4.3 - Returns true if the item is spanning all the columns in a row; otherwise returns false. + Returns \c true if the item is spanning all the columns in a row; otherwise returns \c false. \sa setFirstColumnSpanned() */ @@ -1800,8 +1800,8 @@ QVariant QTreeWidgetItem::data(int column, int role) const } /*! - Returns true if the text in the item is less than the text in the - \a other item, otherwise returns false. + Returns \c true if the text in the item is less than the text in the + \a other item, otherwise returns \c false. */ bool QTreeWidgetItem::operator<(const QTreeWidgetItem &other) const @@ -2979,7 +2979,7 @@ void QTreeWidget::setItemWidget(QTreeWidgetItem *item, int column, QWidget *widg } /*! - Returns true if the \a item is selected; otherwise returns false. + Returns \c true if the \a item is selected; otherwise returns \c false. \sa itemSelectionChanged() @@ -3055,7 +3055,7 @@ QList<QTreeWidgetItem*> QTreeWidget::findItems(const QString &text, Qt::MatchFla } /*! - Returns true if the \a item is explicitly hidden, otherwise returns false. + Returns \c true if the \a item is explicitly hidden, otherwise returns \c false. \obsolete @@ -3093,7 +3093,7 @@ void QTreeWidget::setItemHidden(const QTreeWidgetItem *item, bool hide) } /*! - Returns true if the given \a item is open; otherwise returns false. + Returns \c true if the given \a item is open; otherwise returns \c false. \sa itemExpanded() @@ -3128,8 +3128,8 @@ void QTreeWidget::setItemExpanded(const QTreeWidgetItem *item, bool expand) /*! \since 4.3 - Returns true if the given \a item is set to show only one section over all columns; - otherwise returns false. + Returns \c true if the given \a item is set to show only one section over all columns; + otherwise returns \c false. \sa setFirstItemColumnSpanned() */ @@ -3294,9 +3294,9 @@ QMimeData *QTreeWidget::mimeData(const QList<QTreeWidgetItem*> items) const Handles the \a data supplied by a drag and drop operation that ended with the given \a action in the \a index in the given \a parent item. - The default implementation returns true if the drop was + The default implementation returns \c true if the drop was successfully handled by decoding the mime data and inserting it - into the model; otherwise it returns false. + into the model; otherwise it returns \c false. \sa supportedDropActions() */ diff --git a/src/widgets/kernel/qaction.cpp b/src/widgets/kernel/qaction.cpp index 267d787116..3e76699aca 100644 --- a/src/widgets/kernel/qaction.cpp +++ b/src/widgets/kernel/qaction.cpp @@ -706,8 +706,8 @@ void QAction::setSeparator(bool b) } /*! - Returns true if this action is a separator action; otherwise it - returns false. + Returns \c true if this action is a separator action; otherwise it + returns \c false. \sa QAction::setSeparator() */ @@ -931,7 +931,7 @@ QAction::Priority QAction::priority() const in a word processor, a Bold toolbar button may be either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. - By default, this property is false. + By default, this property is \c false. In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and @@ -1024,7 +1024,7 @@ bool QAction::isChecked() const action is disabled, it is not possible to trigger it through its shortcut. - By default, this property is true (actions are enabled). + By default, this property is \c true (actions are enabled). \sa text */ @@ -1061,7 +1061,7 @@ bool QAction::isEnabled() const Actions which are not visible are \e not grayed out; they do not appear at all. - By default, this property is true (actions are visible). + By default, this property is \c true (actions are visible). */ void QAction::setVisible(bool b) { @@ -1137,8 +1137,8 @@ QAction::setData(const QVariant &data) /*! Updates the relevant status bar for the \a widget specified by sending a - QStatusTipEvent to its parent widget. Returns true if an event was sent; - otherwise returns false. + QStatusTipEvent to its parent widget. Returns \c true if an event was sent; + otherwise returns \c false. If a null widget is specified, the event is sent to the action's parent. diff --git a/src/widgets/kernel/qapplication.cpp b/src/widgets/kernel/qapplication.cpp index 565960f8d5..70c63086a3 100644 --- a/src/widgets/kernel/qapplication.cpp +++ b/src/widgets/kernel/qapplication.cpp @@ -2238,7 +2238,7 @@ Q_WIDGETS_EXPORT bool qt_tryModalHelper(QWidget *widget, QWidget **rettop) } /*! \internal - Returns true if \a widget is blocked by a modal window. + Returns \c true if \a widget is blocked by a modal window. */ bool QApplicationPrivate::isBlockedByModal(QWidget *widget) { @@ -2367,7 +2367,7 @@ bool QApplicationPrivate::isWindowBlocked(QWindow *window, QWindow **blockingWin /*!\internal - Called from qapplication_\e{platform}.cpp, returns true + Called from qapplication_\e{platform}.cpp, returns \c true if the widget should accept the event. */ bool QApplicationPrivate::tryModalHelper(QWidget *widget, QWidget **rettop) @@ -3539,7 +3539,7 @@ void QApplication::setKeypadNavigationEnabled(bool enable) } /*! - Returns true if Qt is set to use keypad navigation; otherwise returns + Returns \c true if Qt is set to use keypad navigation; otherwise returns false. The default value is false. This feature is available in Qt for Embedded Linux, and Windows CE only. @@ -3686,7 +3686,7 @@ int QApplication::keyboardInputInterval() /*! \fn bool QApplication::isEffectEnabled(Qt::UIEffect effect) - Returns true if \a effect is enabled; otherwise returns false. + Returns \c true if \a effect is enabled; otherwise returns \c false. By default, Qt will try to use the desktop settings. To prevent this, call setDesktopSettingsAware(false). diff --git a/src/widgets/kernel/qboxlayout.cpp b/src/widgets/kernel/qboxlayout.cpp index 67621ade23..157fa55d2e 100644 --- a/src/widgets/kernel/qboxlayout.cpp +++ b/src/widgets/kernel/qboxlayout.cpp @@ -52,8 +52,8 @@ QT_BEGIN_NAMESPACE /* - Returns true if the \a widget can be added to the \a layout; - otherwise returns false. + Returns \c true if the \a widget can be added to the \a layout; + otherwise returns \c false. */ static bool checkWidget(QLayout *layout, QWidget *widget) { @@ -1112,7 +1112,7 @@ void QBoxLayout::addStrut(int size) /*! Sets the stretch factor for \a widget to \a stretch and returns true if \a widget is found in this layout (not including child - layouts); otherwise returns false. + layouts); otherwise returns \c false. \sa setAlignment() */ @@ -1136,8 +1136,8 @@ bool QBoxLayout::setStretchFactor(QWidget *widget, int stretch) \overload Sets the stretch factor for the layout \a layout to \a stretch and - returns true if \a layout is found in this layout (not including - child layouts); otherwise returns false. + returns \c true if \a layout is found in this layout (not including + child layouts); otherwise returns \c false. */ bool QBoxLayout::setStretchFactor(QLayout *layout, int stretch) { diff --git a/src/widgets/kernel/qgesture.cpp b/src/widgets/kernel/qgesture.cpp index 4baeae9021..f475642f78 100644 --- a/src/widgets/kernel/qgesture.cpp +++ b/src/widgets/kernel/qgesture.cpp @@ -987,7 +987,7 @@ void QGestureEvent::ignore(QGesture *gesture) } /*! - Returns true if the \a gesture is accepted; otherwise returns false. + Returns \c true if the \a gesture is accepted; otherwise returns \c false. */ bool QGestureEvent::isAccepted(QGesture *gesture) const { @@ -1044,8 +1044,8 @@ void QGestureEvent::ignore(Qt::GestureType gestureType) } /*! - Returns true if the gesture of type \a gestureType is accepted; otherwise - returns false. + Returns \c true if the gesture of type \a gestureType is accepted; otherwise + returns \c false. */ bool QGestureEvent::isAccepted(Qt::GestureType gestureType) const { @@ -1114,7 +1114,7 @@ QPointF QGestureEvent::mapToGraphicsScene(const QPointF &gesturePoint) const /*! \fn bool QGestureEvent::isAccepted() const - Returns true is the event has been accepted; otherwise returns false. + Returns \c true is the event has been accepted; otherwise returns \c false. \sa QEvent::accepted */ diff --git a/src/widgets/kernel/qgridlayout.cpp b/src/widgets/kernel/qgridlayout.cpp index 7da2104971..5434c40f97 100644 --- a/src/widgets/kernel/qgridlayout.cpp +++ b/src/widgets/kernel/qgridlayout.cpp @@ -1431,8 +1431,8 @@ void QGridLayout::addItem(QLayoutItem *item, int row, int column, int rowSpan, i } /* - Returns true if the widget \a w can be added to the layout \a l; - otherwise returns false. + Returns \c true if the widget \a w can be added to the layout \a l; + otherwise returns \c false. */ static bool checkWidget(QLayout *l, QWidget *w) { diff --git a/src/widgets/kernel/qlayout.cpp b/src/widgets/kernel/qlayout.cpp index b79a6fe6c7..cd2891d829 100644 --- a/src/widgets/kernel/qlayout.cpp +++ b/src/widgets/kernel/qlayout.cpp @@ -234,7 +234,7 @@ void QLayout::addWidget(QWidget *w) /*! Sets the alignment for widget \a w to \a alignment and returns true if \a w is found in this layout (not including child - layouts); otherwise returns false. + layouts); otherwise returns \c false. */ bool QLayout::setAlignment(QWidget *w, Qt::Alignment alignment) { @@ -256,8 +256,8 @@ bool QLayout::setAlignment(QWidget *w, Qt::Alignment alignment) \overload Sets the alignment for the layout \a l to \a alignment and - returns true if \a l is found in this layout (not including child - layouts); otherwise returns false. + returns \c true if \a l is found in this layout (not including child + layouts); otherwise returns \c false. */ bool QLayout::setAlignment(QLayout *l, Qt::Alignment alignment) { @@ -1386,7 +1386,7 @@ void QLayout::setEnabled(bool enable) } /*! - Returns true if the layout is enabled; otherwise returns false. + Returns \c true if the layout is enabled; otherwise returns \c false. \sa setEnabled() */ diff --git a/src/widgets/kernel/qlayoutitem.cpp b/src/widgets/kernel/qlayoutitem.cpp index a99ea77ce2..259af8a5e8 100644 --- a/src/widgets/kernel/qlayoutitem.cpp +++ b/src/widgets/kernel/qlayoutitem.cpp @@ -366,8 +366,8 @@ QWidget *QWidgetItem::widget() } /*! - Returns true if this layout's preferred height depends on its - width; otherwise returns false. The default implementation returns + Returns \c true if this layout's preferred height depends on its + width; otherwise returns \c false. The default implementation returns false. Reimplement this function in layout managers that support height @@ -668,7 +668,7 @@ QSize QWidgetItem::sizeHint() const } /*! - Returns true. + Returns \c true. */ bool QSpacerItem::isEmpty() const { @@ -676,7 +676,7 @@ bool QSpacerItem::isEmpty() const } /*! - Returns true if the widget is hidden; otherwise returns false. + Returns \c true if the widget is hidden; otherwise returns \c false. \sa QWidget::isHidden() */ diff --git a/src/widgets/kernel/qshortcut.cpp b/src/widgets/kernel/qshortcut.cpp index 678e6f25d1..f7f7cf1039 100644 --- a/src/widgets/kernel/qshortcut.cpp +++ b/src/widgets/kernel/qshortcut.cpp @@ -72,7 +72,7 @@ static bool correctActionContext(Qt::ShortcutContext context, QAction *a, QWidge /*! \internal - Returns true if the widget \a w is a logical sub window of the current + Returns \c true if the widget \a w is a logical sub window of the current top-level widget. */ bool qWidgetShortcutContextMatcher(QObject *object, Qt::ShortcutContext context) @@ -517,7 +517,7 @@ QKeySequence QShortcut::key() const If the application is in \c WhatsThis mode the shortcut will not emit the signals, but will show the "What's This?" text instead. - By default, this property is true. + By default, this property is \c true. \sa whatsThis */ diff --git a/src/widgets/kernel/qsizepolicy.qdoc b/src/widgets/kernel/qsizepolicy.qdoc index 2c088113e1..1c99131bc4 100644 --- a/src/widgets/kernel/qsizepolicy.qdoc +++ b/src/widgets/kernel/qsizepolicy.qdoc @@ -243,8 +243,8 @@ /*! \fn bool QSizePolicy::hasHeightForWidth() const - Returns true if the widget's preferred height depends on its - width; otherwise returns false. + Returns \c true if the widget's preferred height depends on its + width; otherwise returns \c false. \sa setHeightForWidth() */ @@ -265,8 +265,8 @@ /*! \fn bool QSizePolicy::hasWidthForHeight() const - Returns true if the widget's width depends on its - height; otherwise returns false. + Returns \c true if the widget's width depends on its + height; otherwise returns \c false. \sa setWidthForHeight() */ @@ -274,8 +274,8 @@ /*! \fn bool QSizePolicy::operator==(const QSizePolicy &other) const - Returns true if this policy is equal to \a other; otherwise - returns false. + Returns \c true if this policy is equal to \a other; otherwise + returns \c false. \sa operator!=() */ @@ -283,8 +283,8 @@ /*! \fn bool QSizePolicy::operator!=(const QSizePolicy &other) const - Returns true if this policy is different from \a other; otherwise - returns false. + Returns \c true if this policy is different from \a other; otherwise + returns \c false. \sa operator==() */ diff --git a/src/widgets/kernel/qtooltip.cpp b/src/widgets/kernel/qtooltip.cpp index 8399f94976..c898f56015 100644 --- a/src/widgets/kernel/qtooltip.cpp +++ b/src/widgets/kernel/qtooltip.cpp @@ -107,7 +107,7 @@ QT_BEGIN_NAMESPACE The default tool tip color and font can be customized with setPalette() and setFont(). When a tooltip is currently on - display, isVisible() returns true and text() the currently visible + display, isVisible() returns \c true and text() the currently visible text. \note Tool tips use the inactive color group of QPalette, because tool @@ -526,7 +526,7 @@ void QToolTip::showText(const QPoint &pos, const QString &text, QWidget *w) /*! \since 4.4 - Returns true if this tooltip is currently shown. + Returns \c true if this tooltip is currently shown. \sa showText() */ diff --git a/src/widgets/kernel/qwhatsthis.cpp b/src/widgets/kernel/qwhatsthis.cpp index 661317d21a..d5c249c074 100644 --- a/src/widgets/kernel/qwhatsthis.cpp +++ b/src/widgets/kernel/qwhatsthis.cpp @@ -542,8 +542,8 @@ void QWhatsThis::enterWhatsThisMode() } /*! - Returns true if the user interface is in "What's This?" mode; - otherwise returns false. + Returns \c true if the user interface is in "What's This?" mode; + otherwise returns \c false. \sa enterWhatsThisMode() */ diff --git a/src/widgets/kernel/qwidget.cpp b/src/widgets/kernel/qwidget.cpp index 02d95d2fa5..f439edcf2e 100644 --- a/src/widgets/kernel/qwidget.cpp +++ b/src/widgets/kernel/qwidget.cpp @@ -369,7 +369,7 @@ void QWidgetPrivate::updateWidgetTransform() QPointer<QWidget> QWidgetPrivate::editingWidget; /*! - Returns true if this widget currently has edit focus; otherwise false. + Returns \c true if this widget currently has edit focus; otherwise false. This feature is only available in Qt for Embedded Linux. @@ -445,7 +445,7 @@ void QWidget::setEditFocus(bool on) \l{Qt Style Sheets}. When a widget has a style sheet with a valid background or a border-image, this property is automatically disabled. - By default, this property is false. + By default, this property is \c false. \sa Qt::WA_OpaquePaintEvent, Qt::WA_NoSystemBackground, {QWidget#Transparency and Double Buffering}{Transparency and Double Buffering} @@ -1634,7 +1634,7 @@ void QWidgetPrivate::deleteExtra() } /* - Returns true if there are widgets above this which overlap with + Returns \c true if there are widgets above this which overlap with \a rect, which is in parent's coordinate system (same as crect). */ @@ -2583,8 +2583,8 @@ void QWidgetPrivate::inheritStyle() /*! \fn bool QWidget::isWindow() const - Returns true if the widget is an independent window, otherwise - returns false. + Returns \c true if the widget is an independent window, otherwise + returns \c false. A window is a widget that isn't visually the child of any other widget and that usually has a frame and a @@ -2610,7 +2610,7 @@ void QWidgetPrivate::inheritStyle() This property only makes sense for windows. A modal widget prevents widgets in all other windows from getting any input. - By default, this property is false. + By default, this property is \c false. \sa isWindow(), windowModality, QDialog */ @@ -2647,8 +2647,8 @@ void QWidget::setWindowModality(Qt::WindowModality windowModality) /*! \fn bool QWidget::underMouse() const - Returns true if the widget is under the mouse cursor; otherwise - returns false. + Returns \c true if the widget is under the mouse cursor; otherwise + returns \c false. This value is not updated properly during drag and drop operations. @@ -2662,7 +2662,7 @@ void QWidget::setWindowModality(Qt::WindowModality windowModality) This property is only relevant for windows. - By default, this property is false. + By default, this property is \c false. \sa showMinimized(), visible, show(), hide(), showNormal(), maximized */ @@ -2702,7 +2702,7 @@ void QWidget::showMinimized() from any other resize). This is expected to improve as window manager protocols evolve. - By default, this property is false. + By default, this property is \c false. \sa windowState(), showMaximized(), visible, show(), hide(), showNormal(), minimized */ @@ -2744,7 +2744,7 @@ void QWidget::overrideWindowState(Qt::WindowStates newstate) combination of Qt::WindowState: Qt::WindowMinimized, Qt::WindowMaximized, Qt::WindowFullScreen, and Qt::WindowActive. - If the window is not visible (i.e. isVisible() returns false), the + If the window is not visible (i.e. isVisible() returns \c false), the window state will take effect when show() is called. For visible windows, the change is immediate. For example, to toggle between full-screen and normal mode, use the following code: @@ -2775,7 +2775,7 @@ void QWidget::overrideWindowState(Qt::WindowStates newstate) A widget in full screen mode occupies the whole screen area and does not display window decorations, such as a title bar. - By default, this property is false. + By default, this property is \c false. \sa windowState(), minimized, maximized */ @@ -2891,8 +2891,8 @@ void QWidget::showNormal() } /*! - Returns true if this widget would become enabled if \a ancestor is - enabled; otherwise returns false. + Returns \c true if this widget would become enabled if \a ancestor is + enabled; otherwise returns \c false. @@ -3052,7 +3052,7 @@ QList<QAction*> QWidget::actions() const explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled. - By default, this property is true. + By default, this property is \c true. \sa isEnabledTo(), QKeyEvent, QMouseEvent, changeEvent() */ @@ -3135,7 +3135,7 @@ void QWidgetPrivate::setEnabled_helper(bool enable) \warning Do not modify this property in a drag and drop event handler. - By default, this property is false. + By default, this property is \c false. \sa {Drag and Drop} */ @@ -5513,7 +5513,7 @@ void QWidget::unsetLocale() contain a "[*]" placeholder, which indicates where the '*' should appear. Normally, it should appear right after the file name (e.g., "document1.txt[*] - Text Editor"). If the \l - windowModified property is false (the default), the placeholder + windowModified property is \c false (the default), the placeholder is simply removed. On some desktop platforms (including Windows and Unix), the application name @@ -5879,7 +5879,7 @@ QWidget * QWidget::focusProxy() const \brief whether this widget (or its focus proxy) has the keyboard input focus - By default, this property is false. + By default, this property is \c false. \note Obtaining the value of this property for a widget is effectively equivalent to checking whether QApplication::focusWidget() refers to the widget. @@ -6132,7 +6132,7 @@ void QWidget::clearFocus() \fn bool QWidget::focusNextChild() Finds a new widget to give the keyboard focus to, as appropriate - for \uicontrol Tab, and returns true if it can find a new widget, or + for \uicontrol Tab, and returns \c true if it can find a new widget, or false if it can't. \sa focusPreviousChild() @@ -6142,7 +6142,7 @@ void QWidget::clearFocus() \fn bool QWidget::focusPreviousChild() Finds a new widget to give the keyboard focus to, as appropriate - for \uicontrol Shift+Tab, and returns true if it can find a new widget, + for \uicontrol Shift+Tab, and returns \c true if it can find a new widget, or false if it can't. \sa focusNextChild() @@ -6150,7 +6150,7 @@ void QWidget::clearFocus() /*! Finds a new widget to give the keyboard focus to, as appropriate - for Tab and Shift+Tab, and returns true if it can find a new + for Tab and Shift+Tab, and returns \c true if it can find a new widget, or false if it can't. If \a next is true, this function searches forward, if \a next @@ -6257,10 +6257,10 @@ QWidget *QWidget::previousInFocusChain() const keyboard focus (The window may still have focus if it has no widgets or none of its widgets accepts keyboard focus). - When popup windows are visible, this property is true for both the + When popup windows are visible, this property is \c true for both the active window \e and for the popup. - By default, this property is false. + By default, this property is \c false. \sa activateWindow(), QApplication::activeWindow() */ @@ -6640,8 +6640,8 @@ QByteArray QWidget::saveGeometry() const \since 4.2 Restores the geometry and state top-level widgets stored in the - byte array \a geometry. Returns true on success; otherwise - returns false. + byte array \a geometry. Returns \c true on success; otherwise + returns \c false. If the restored geometry is off-screen, it will be modified to be inside the available screen geometry. @@ -6965,7 +6965,7 @@ void QWidget::setFocusPolicy(Qt::FocusPolicy policy) calling update() and repaint() has no effect if updates are disabled. - By default, this property is true. + By default, this property is \c true. setUpdatesEnabled() is normally used to disable updates for a short period of time, for instance to avoid screen flicker during @@ -7261,7 +7261,7 @@ void QWidgetPrivate::hide_helper() /*! \fn bool QWidget::isHidden() const - Returns true if the widget is hidden, otherwise returns false. + Returns \c true if the widget is hidden, otherwise returns \c false. A hidden widget will only become visible when show() is called on it. It will not be automatically shown when the parent is shown. @@ -7567,8 +7567,8 @@ bool QWidgetPrivate::close_helper(CloseMode mode) /*! - Closes this widget. Returns true if the widget was closed; - otherwise returns false. + Closes this widget. Returns \c true if the widget was closed; + otherwise returns \c false. First it sends the widget a QCloseEvent. The widget is \l{hide()}{hidden} if it \l{QCloseEvent::accept()}{accepts} @@ -7636,8 +7636,8 @@ bool QWidget::close() /*! - Returns true if this widget would become visible if \a ancestor is - shown; otherwise returns false. + Returns \c true if this widget would become visible if \a ancestor is + shown; otherwise returns \c false. The true case occurs if neither the widget itself nor any parent up to but excluding \a ancestor has been explicitly hidden. @@ -7827,9 +7827,9 @@ QSize QWidget::minimumSizeHint() const /*! - Returns true if this widget is a parent, (or grandparent and so on + Returns \c true if this widget is a parent, (or grandparent and so on to any level), of the given \a child, and both widgets are within - the same window; otherwise returns false. + the same window; otherwise returns \c false. */ bool QWidget::isAncestorOf(const QWidget *child) const @@ -7884,8 +7884,8 @@ inline void setDisabledStyle(QWidget *w, bool setStyle) handlers such as mousePressEvent(); otherwise it will discard the event. - This function returns true if the event was recognized, otherwise - it returns false. If the recognized event was accepted (see \l + This function returns \c true if the event was recognized, otherwise + it returns \c false. If the recognized event was accepted (see \l QEvent::accepted), any further processing such as event propagation to the parent widget stops. @@ -9349,7 +9349,7 @@ int QWidget::heightForWidth(int w) const /*! \since 5.0 - Returns true if the widget's preferred height depends on its width; otherwise returns false. + Returns \c true if the widget's preferred height depends on its width; otherwise returns \c false. */ bool QWidget::hasHeightForWidth() const { @@ -10324,8 +10324,8 @@ void QWidget::setAttribute(Qt::WidgetAttribute attribute, bool on) /*! \fn bool QWidget::testAttribute(Qt::WidgetAttribute attribute) const - Returns true if attribute \a attribute is set on this widget; - otherwise returns false. + Returns \c true if attribute \a attribute is set on this widget; + otherwise returns \c false. \sa setAttribute() */ @@ -10888,7 +10888,7 @@ QRect QWidgetPrivate::frameStrut() const Changes the focus from the current focusWidget to a widget in the \a direction. - Returns true, if there was a widget in that direction + Returns \c true, if there was a widget in that direction */ bool QWidgetPrivate::navigateToDirection(Direction direction) { @@ -11249,7 +11249,7 @@ void QWidget::ungrabGesture(Qt::GestureType gesture) button is released. \note Only visible widgets can grab mouse input. If isVisible() - returns false for a widget, that widget cannot call grabMouse(). + returns \c false for a widget, that widget cannot call grabMouse(). \note \b{(Mac OS X developers)} For \e Cocoa, calling grabMouse() on a widget only works when the mouse is inside the diff --git a/src/widgets/kernel/qwidget_p.h b/src/widgets/kernel/qwidget_p.h index 88aff2b65d..cc740034fc 100644 --- a/src/widgets/kernel/qwidget_p.h +++ b/src/widgets/kernel/qwidget_p.h @@ -274,7 +274,7 @@ struct QWExtra { /*! \internal - Returns true if \a p or any of its parents enable the + Returns \c true if \a p or any of its parents enable the Qt::BypassGraphicsProxyWidget window flag. Used in QWidget::show() and QWidget::setParent() to determine whether it's necessary to embed the widget into a QGraphicsProxyWidget or not. diff --git a/src/widgets/styles/qstylepainter.cpp b/src/widgets/styles/qstylepainter.cpp index 5c2c44b45b..bc1fe748a8 100644 --- a/src/widgets/styles/qstylepainter.cpp +++ b/src/widgets/styles/qstylepainter.cpp @@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE \fn bool QStylePainter::begin(QWidget *widget) Begin painting operations on the specified \a widget. - Returns true if the painter is ready to use; otherwise returns false. + Returns \c true if the painter is ready to use; otherwise returns \c false. This is automatically called by the constructor that takes a QWidget. */ diff --git a/src/widgets/styles/qstylesheetstyle.cpp b/src/widgets/styles/qstylesheetstyle.cpp index 85520d3c40..417e092e11 100644 --- a/src/widgets/styles/qstylesheetstyle.cpp +++ b/src/widgets/styles/qstylesheetstyle.cpp @@ -2379,7 +2379,7 @@ static QWidget *containerWidget(const QWidget *w) } /** \internal - returns true if the widget can NOT be styled directly + returns \c true if the widget can NOT be styled directly */ static bool unstylable(const QWidget *w) { @@ -5840,7 +5840,7 @@ void QStyleSheetStyle::clearWidgetFont(QWidget* w) const // Polish palette that should be used for a particular widget, with particular states // (eg. :focus, :hover, ...) // this is called by widgets that paint themself in their paint event -// Returns true if there is a new palette in pal. +// Returns \c true if there is a new palette in pal. bool QStyleSheetStyle::styleSheetPalette(const QWidget* w, const QStyleOption* opt, QPalette* pal) { if (!w || !opt || !pal) diff --git a/src/widgets/styles/qwindowsstyle.cpp b/src/widgets/styles/qwindowsstyle.cpp index b153d05885..dde705f9b9 100644 --- a/src/widgets/styles/qwindowsstyle.cpp +++ b/src/widgets/styles/qwindowsstyle.cpp @@ -130,7 +130,7 @@ QWindowsStylePrivate::QWindowsStylePrivate() #endif } -// Returns true if the toplevel parent of \a widget has seen the Alt-key +// Returns \c true if the toplevel parent of \a widget has seen the Alt-key bool QWindowsStylePrivate::hasSeenAlt(const QWidget *widget) const { widget = widget->window(); diff --git a/src/widgets/styles/qwindowsvistastyle.cpp b/src/widgets/styles/qwindowsvistastyle.cpp index 22458eb96f..2f36944b5e 100644 --- a/src/widgets/styles/qwindowsvistastyle.cpp +++ b/src/widgets/styles/qwindowsvistastyle.cpp @@ -2502,7 +2502,7 @@ bool QWindowsVistaStylePrivate::transitionsEnabled() const } /*! \internal - Returns true if all the necessary theme engine symbols were + Returns \c true if all the necessary theme engine symbols were resolved. */ bool QWindowsVistaStylePrivate::resolveSymbols() diff --git a/src/widgets/styles/qwindowsxpstyle.cpp b/src/widgets/styles/qwindowsxpstyle.cpp index 506a148d2f..63ed3ef7c8 100644 --- a/src/widgets/styles/qwindowsxpstyle.cpp +++ b/src/widgets/styles/qwindowsxpstyle.cpp @@ -169,7 +169,7 @@ static inline HDC hdcForWidgetBackingStore(const QWidget *widget) // Theme data helper ------------------------------------------------------------------------------ /* \internal - Returns true if the themedata is valid for use. + Returns \c true if the themedata is valid for use. */ bool XPThemeData::isValid() { @@ -399,7 +399,7 @@ const QPixmap *QWindowsXPStylePrivate::tabBody(QWidget *) } /*! \internal - Returns true if all the necessary theme engine symbols were + Returns \c true if all the necessary theme engine symbols were resolved. */ bool QWindowsXPStylePrivate::resolveSymbols() @@ -501,7 +501,7 @@ HBITMAP QWindowsXPStylePrivate::buffer(int w, int h) } /*! \internal - Returns true if the part contains any transparency at all. This does + Returns \c true if the part contains any transparency at all. This does not indicate what kind of transparency we're dealing with. It can be - Alpha transparency - Masked transparency @@ -572,7 +572,7 @@ void QWindowsXPStylePrivate::setTransparency(QWidget *widget, XPThemeData &theme } /*! \internal - Returns true if the native doublebuffer contains pixels with + Returns \c true if the native doublebuffer contains pixels with varying alpha value. */ bool QWindowsXPStylePrivate::hasAlphaChannel(const QRect &rect) diff --git a/src/widgets/util/qcompleter.cpp b/src/widgets/util/qcompleter.cpp index 97e6a04992..ab3c640421 100644 --- a/src/widgets/util/qcompleter.cpp +++ b/src/widgets/util/qcompleter.cpp @@ -1469,8 +1469,8 @@ void QCompleter::complete(const QRect& rect) } /*! - Sets the current row to the \a row specified. Returns true if successful; - otherwise returns false. + Sets the current row to the \a row specified. Returns \c true if successful; + otherwise returns \c false. This function may be used along with currentCompletion() to iterate through all the possible completions. diff --git a/src/widgets/util/qscroller.cpp b/src/widgets/util/qscroller.cpp index 0a58711b92..235cbc7865 100644 --- a/src/widgets/util/qscroller.cpp +++ b/src/widgets/util/qscroller.cpp @@ -1429,7 +1429,7 @@ void QScrollerPrivate::createScrollingSegments(const QPointF &v, /*! \internal Prepares scrolling by sending a QScrollPrepareEvent to the receiver widget. - Returns true if the scrolling was accepted and a target was returned. + Returns \c true if the scrolling was accepted and a target was returned. */ bool QScrollerPrivate::prepareScrolling(const QPointF &position) { diff --git a/src/widgets/util/qscrollerproperties.cpp b/src/widgets/util/qscrollerproperties.cpp index cebb054a53..66b1c284c1 100644 --- a/src/widgets/util/qscrollerproperties.cpp +++ b/src/widgets/util/qscrollerproperties.cpp @@ -139,7 +139,7 @@ QScrollerProperties::~QScrollerProperties() } /*! - Returns true if these scroller properties are equal to \a sp; otherwise returns false. + Returns \c true if these scroller properties are equal to \a sp; otherwise returns \c false. */ bool QScrollerProperties::operator==(const QScrollerProperties &sp) const { @@ -147,7 +147,7 @@ bool QScrollerProperties::operator==(const QScrollerProperties &sp) const } /*! - Returns true if these scroller properties are different from \a sp; otherwise returns false. + Returns \c true if these scroller properties are different from \a sp; otherwise returns \c false. */ bool QScrollerProperties::operator!=(const QScrollerProperties &sp) const { diff --git a/src/widgets/util/qsystemtrayicon.cpp b/src/widgets/util/qsystemtrayicon.cpp index f74d88f6a0..08b24a8200 100644 --- a/src/widgets/util/qsystemtrayicon.cpp +++ b/src/widgets/util/qsystemtrayicon.cpp @@ -337,7 +337,7 @@ bool QSystemTrayIcon::event(QEvent *e) /*! - Returns true if the system tray is available; otherwise returns false. + Returns \c true if the system tray is available; otherwise returns \c false. If the system tray is currently unavailable but becomes available later, QSystemTrayIcon will automatically add an entry in the system tray if it @@ -350,7 +350,7 @@ bool QSystemTrayIcon::isSystemTrayAvailable() } /*! - Returns true if the system tray supports balloon messages; otherwise returns false. + Returns \c true if the system tray supports balloon messages; otherwise returns \c false. \sa showMessage() */ diff --git a/src/widgets/util/qundogroup.cpp b/src/widgets/util/qundogroup.cpp index 57563c434b..a2b256b4ce 100644 --- a/src/widgets/util/qundogroup.cpp +++ b/src/widgets/util/qundogroup.cpp @@ -294,7 +294,7 @@ void QUndoGroup::redo() Returns the value of the active stack's QUndoStack::canUndo(). If none of the stacks are active, or if the group is empty, this function - returns false. + returns \c false. \sa canRedo(), setActiveStack() */ @@ -309,7 +309,7 @@ bool QUndoGroup::canUndo() const Returns the value of the active stack's QUndoStack::canRedo(). If none of the stacks are active, or if the group is empty, this function - returns false. + returns \c false. \sa canUndo(), setActiveStack() */ @@ -354,7 +354,7 @@ QString QUndoGroup::redoText() const Returns the value of the active stack's QUndoStack::isClean(). If none of the stacks are active, or if the group is empty, this function - returns true. + returns \c true. \sa setActiveStack() */ diff --git a/src/widgets/util/qundostack.cpp b/src/widgets/util/qundostack.cpp index 46730ef7bd..2ca482be96 100644 --- a/src/widgets/util/qundostack.cpp +++ b/src/widgets/util/qundostack.cpp @@ -169,10 +169,10 @@ int QUndoCommand::id() const } /*! - Attempts to merge this command with \a command. Returns true on - success; otherwise returns false. + Attempts to merge this command with \a command. Returns \c true on + success; otherwise returns \c false. - If this function returns true, calling this command's redo() must have the same + If this function returns \c true, calling this command's redo() must have the same effect as redoing both this command and \a command. Similarly, calling this command's undo() must have the same effect as undoing \a command and this command. @@ -180,7 +180,7 @@ int QUndoCommand::id() const QUndoStack will only try to merge two commands if they have the same id, and the id is not -1. - The default implementation returns false. + The default implementation returns \c false. \snippet code/src_gui_util_qundostack.cpp 3 @@ -461,7 +461,7 @@ void QUndoStackPrivate::setIndex(int idx, bool clean) If the number of commands on the stack exceedes the undo limit, deletes commands from the bottom of the stack. - Returns true if commands were deleted. + Returns \c true if commands were deleted. */ bool QUndoStackPrivate::checkUndoLimit() @@ -565,7 +565,7 @@ void QUndoStack::clear() If \a cmd's id is not -1, and if the id is the same as that of the most recently executed command, QUndoStack will attempt to merge the two commands by calling QUndoCommand::mergeWith() on the most recently executed - command. If QUndoCommand::mergeWith() returns true, \a cmd is deleted. + command. If QUndoCommand::mergeWith() returns \c true, \a cmd is deleted. In all other cases \a cmd is simply pushed on the stack. @@ -650,7 +650,7 @@ void QUndoStack::setClean() } /*! - If the stack is in the clean state, returns true; otherwise returns false. + If the stack is in the clean state, returns \c true; otherwise returns \c false. \sa setClean(), cleanIndex() */ @@ -789,9 +789,9 @@ void QUndoStack::setIndex(int idx) } /*! - Returns true if there is a command available for undo; otherwise returns false. + Returns \c true if there is a command available for undo; otherwise returns \c false. - This function returns false if the stack is empty, or if the bottom command + This function returns \c false if the stack is empty, or if the bottom command on the stack has already been undone. Synonymous with index() == 0. @@ -808,9 +808,9 @@ bool QUndoStack::canUndo() const } /*! - Returns true if there is a command available for redo; otherwise returns false. + Returns \c true if there is a command available for redo; otherwise returns \c false. - This function returns false if the stack is empty or if the top command + This function returns \c false if the stack is empty or if the top command on the stack has already been redone. Synonymous with index() == count(). diff --git a/src/widgets/widgets/qabstractbutton.cpp b/src/widgets/widgets/qabstractbutton.cpp index cdadde5cc1..acec526512 100644 --- a/src/widgets/widgets/qabstractbutton.cpp +++ b/src/widgets/widgets/qabstractbutton.cpp @@ -795,7 +795,7 @@ bool QAbstractButton::isChecked() const \property QAbstractButton::down \brief whether the button is pressed down - If this property is true, the button is pressed down. The signals + If this property is \c true, the button is pressed down. The signals pressed() and clicked() are not emitted if you set this property to true. The default is false. */ @@ -1038,8 +1038,8 @@ void QAbstractButton::nextCheckState() } /*! -Returns true if \a pos is inside the clickable button rectangle; -otherwise returns false. +Returns \c true if \a pos is inside the clickable button rectangle; +otherwise returns \c false. By default, the clickable area is the entire widget. Subclasses may reimplement this function to provide support for clickable diff --git a/src/widgets/widgets/qabstractscrollarea.cpp b/src/widgets/widgets/qabstractscrollarea.cpp index e7827055fb..d8ee923f7a 100644 --- a/src/widgets/widgets/qabstractscrollarea.cpp +++ b/src/widgets/widgets/qabstractscrollarea.cpp @@ -1146,8 +1146,8 @@ bool QAbstractScrollArea::event(QEvent *e) It handles the \a event specified, and can be called by subclasses to provide reasonable default behavior. - Returns true to indicate to the event system that the event has been - handled, and needs no further processing; otherwise returns false to + Returns \c true to indicate to the event system that the event has been + handled, and needs no further processing; otherwise returns \c false to indicate that the event should be propagated further. You can reimplement this function in a subclass, but we recommend diff --git a/src/widgets/widgets/qabstractslider.cpp b/src/widgets/widgets/qabstractslider.cpp index 8c3dedb84f..40d8c6b417 100644 --- a/src/widgets/widgets/qabstractslider.cpp +++ b/src/widgets/widgets/qabstractslider.cpp @@ -549,7 +549,7 @@ void QAbstractSlider::setValue(int value) \property QAbstractSlider::invertedAppearance \brief whether or not a slider shows its values inverted. - If this property is false (the default), the minimum and maximum will + If this property is \c false (the default), the minimum and maximum will be shown in its classic position for the inherited widget. If the value is true, the minimum and maximum appear at their opposite location. @@ -577,7 +577,7 @@ void QAbstractSlider::setInvertedAppearance(bool invert) \property QAbstractSlider::invertedControls \brief whether or not the slider inverts its wheel and key events. - If this property is false, scrolling the mouse wheel "up" and using keys + If this property is \c false, scrolling the mouse wheel "up" and using keys like page up will increase the slider's value towards its maximum. Otherwise pressing page up will move value towards the slider's minimum. */ diff --git a/src/widgets/widgets/qabstractspinbox.cpp b/src/widgets/widgets/qabstractspinbox.cpp index 0355578327..25369a01b6 100644 --- a/src/widgets/widgets/qabstractspinbox.cpp +++ b/src/widgets/widgets/qabstractspinbox.cpp @@ -1408,7 +1408,7 @@ void QAbstractSpinBoxPrivate::updateEditFieldGeometry() } /*! \internal - Returns true if a specialValueText has been set and the current value is minimum. + Returns \c true if a specialValueText has been set and the current value is minimum. */ bool QAbstractSpinBoxPrivate::specialValue() const diff --git a/src/widgets/widgets/qbuttongroup.cpp b/src/widgets/widgets/qbuttongroup.cpp index c484b154fd..1385ef590e 100644 --- a/src/widgets/widgets/qbuttongroup.cpp +++ b/src/widgets/widgets/qbuttongroup.cpp @@ -103,7 +103,7 @@ \property QButtonGroup::exclusive \brief whether the button group is exclusive - If this property is true, then only one button in the group can be checked + If this property is \c true, then only one button in the group can be checked at any given time. The user can click on any button to check it, and that button will replace the existing one as the checked button in the group. @@ -111,7 +111,7 @@ by clicking on it; instead, another button in the group must be clicked to set the new checked button for that group. - By default, this property is true. + By default, this property is \c true. */ /*! diff --git a/src/widgets/widgets/qcalendarwidget.cpp b/src/widgets/widgets/qcalendarwidget.cpp index 82c5a29497..8755f99288 100644 --- a/src/widgets/widgets/qcalendarwidget.cpp +++ b/src/widgets/widgets/qcalendarwidget.cpp @@ -2954,7 +2954,7 @@ void QCalendarWidget::updateCells() \since 4.3 - When this property is true (the default), the next month, + When this property is \c true (the default), the next month, previous month, month selection, year selection controls are shown on top. diff --git a/src/widgets/widgets/qcombobox.cpp b/src/widgets/widgets/qcombobox.cpp index 90310308c3..37a14d3eb3 100644 --- a/src/widgets/widgets/qcombobox.cpp +++ b/src/widgets/widgets/qcombobox.cpp @@ -1379,7 +1379,7 @@ int QComboBox::maxCount() const Use setCompleter() instead. - By default, this property is true. + By default, this property is \c true. \sa editable */ @@ -1473,7 +1473,7 @@ void QComboBox::setAutoCompletionCaseSensitivity(Qt::CaseSensitivity sensitivity Note that it is always possible to programmatically insert duplicate items into the combobox. - By default, this property is false (duplicates are not allowed). + By default, this property is \c false (duplicates are not allowed). */ bool QComboBox::duplicatesEnabled() const { @@ -1632,7 +1632,7 @@ void QComboBox::setIconSize(const QSize &size) \property QComboBox::editable \brief whether the combo box can be edited by the user - By default, this property is false. The effect of editing depends + By default, this property is \c false. The effect of editing depends on the insert policy. \sa InsertPolicy diff --git a/src/widgets/widgets/qdial.cpp b/src/widgets/widgets/qdial.cpp index b415b5254a..632e548e6f 100644 --- a/src/widgets/widgets/qdial.cpp +++ b/src/widgets/widgets/qdial.cpp @@ -369,7 +369,7 @@ void QDial::setWrapping(bool enable) into the space at the bottom of the dial, it will be clamped to the closest end of the valid range of values. - By default this property is false. + By default this property is \c false. */ bool QDial::wrapping() const @@ -450,7 +450,7 @@ void QDial::setNotchesVisible(bool visible) \property QDial::notchesVisible \brief whether the notches are shown - If the property is true, a series of notches are drawn around the dial + If the property is \c true, a series of notches are drawn around the dial to indicate the range of values available; otherwise no notches are shown. diff --git a/src/widgets/widgets/qdialogbuttonbox.cpp b/src/widgets/widgets/qdialogbuttonbox.cpp index 226969cdd1..9789c453f3 100644 --- a/src/widgets/widgets/qdialogbuttonbox.cpp +++ b/src/widgets/widgets/qdialogbuttonbox.cpp @@ -1075,7 +1075,7 @@ void QDialogButtonBoxPrivate::_q_handleButtonDestroyed() \property QDialogButtonBox::centerButtons \brief whether the buttons in the button box are centered - By default, this property is false. This behavior is appopriate + By default, this property is \c false. This behavior is appopriate for most types of dialogs. A notable exception is message boxes on most platforms (e.g. Windows), where the button box is centered horizontally. diff --git a/src/widgets/widgets/qdockwidget.cpp b/src/widgets/widgets/qdockwidget.cpp index 45e3f1b10b..a9b21cbc81 100644 --- a/src/widgets/widgets/qdockwidget.cpp +++ b/src/widgets/widgets/qdockwidget.cpp @@ -1247,7 +1247,7 @@ QDockWidget::DockWidgetFeatures QDockWidget::features() const window "on top" of its parent QMainWindow, instead of being docked in the QMainWindow. - By default, this property is true. + By default, this property is \c true. \sa isWindow() */ @@ -1301,8 +1301,8 @@ Qt::DockWidgetAreas QDockWidget::allowedAreas() const /*! \fn bool QDockWidget::isAreaAllowed(Qt::DockWidgetArea area) const - Returns true if this dock widget can be placed in the given \a area; - otherwise returns false. + Returns \c true if this dock widget can be placed in the given \a area; + otherwise returns \c false. */ /*! \reimp */ diff --git a/src/widgets/widgets/qgroupbox.cpp b/src/widgets/widgets/qgroupbox.cpp index d82f151165..14d434ec28 100644 --- a/src/widgets/widgets/qgroupbox.cpp +++ b/src/widgets/widgets/qgroupbox.cpp @@ -543,7 +543,7 @@ void QGroupBox::setFlat(bool b) \property QGroupBox::checkable \brief whether the group box has a checkbox in its title - If this property is true, the group box displays its title using + If this property is \c true, the group box displays its title using a checkbox in place of an ordinary label. If the checkbox is checked, the group box's children are enabled; otherwise, they are disabled and inaccessible. diff --git a/src/widgets/widgets/qlabel.cpp b/src/widgets/widgets/qlabel.cpp index 7f2a7684eb..919d7090e0 100644 --- a/src/widgets/widgets/qlabel.cpp +++ b/src/widgets/widgets/qlabel.cpp @@ -460,7 +460,7 @@ Qt::Alignment QLabel::alignment() const \property QLabel::wordWrap \brief the label's word-wrapping policy - If this property is true then label text is wrapped where + If this property is \c true then label text is wrapped where necessary at word-breaks; otherwise it is not wrapped at all. By default, word wrap is disabled. @@ -749,10 +749,10 @@ void QLabel::setSelection(int start, int length) \property QLabel::hasSelectedText \brief whether there is any text selected - hasSelectedText() returns true if some or all of the text has been - selected by the user; otherwise returns false. + hasSelectedText() returns \c true if some or all of the text has been + selected by the user; otherwise returns \c false. - By default, this property is false. + By default, this property is \c false. \sa selectedText() diff --git a/src/widgets/widgets/qlcdnumber.cpp b/src/widgets/widgets/qlcdnumber.cpp index 5104171fb1..11a456bc47 100644 --- a/src/widgets/widgets/qlcdnumber.cpp +++ b/src/widgets/widgets/qlcdnumber.cpp @@ -468,8 +468,8 @@ int QLCDNumber::digitCount() const /*! \overload - Returns true if \a num is too big to be displayed in its entirety; - otherwise returns false. + Returns \c true if \a num is too big to be displayed in its entirety; + otherwise returns \c false. \sa display(), digitCount(), smallDecimalPoint() */ @@ -484,8 +484,8 @@ bool QLCDNumber::checkOverflow(int num) const /*! - Returns true if \a num is too big to be displayed in its entirety; - otherwise returns false. + Returns \c true if \a num is too big to be displayed in its entirety; + otherwise returns \c false. \sa display(), digitCount(), smallDecimalPoint() */ diff --git a/src/widgets/widgets/qlineedit.cpp b/src/widgets/widgets/qlineedit.cpp index adf70fde66..d3c37ab612 100644 --- a/src/widgets/widgets/qlineedit.cpp +++ b/src/widgets/widgets/qlineedit.cpp @@ -908,7 +908,7 @@ void QLineEdit::end(bool mark) do not start out knowing what the default should be (perhaps it depends on other fields on the form). Start the line edit without the best default, and when the default is known, if modified() - returns false (the user hasn't entered any text), insert the + returns \c false (the user hasn't entered any text), insert the default value. Calling setText() resets the modified flag to false. @@ -930,10 +930,10 @@ void QLineEdit::setModified(bool modified) \property QLineEdit::hasSelectedText \brief whether there is any text selected - hasSelectedText() returns true if some or all of the text has been - selected by the user; otherwise returns false. + hasSelectedText() returns \c true if some or all of the text has been + selected by the user; otherwise returns \c false. - By default, this property is false. + By default, this property is \c false. \sa selectedText() */ @@ -1011,7 +1011,7 @@ void QLineEdit::setSelection(int start, int length) Undo becomes available once the user has modified the text in the line edit. - By default, this property is false. + By default, this property is \c false. */ bool QLineEdit::isUndoAvailable() const @@ -1027,7 +1027,7 @@ bool QLineEdit::isUndoAvailable() const Redo becomes available once the user has performed one or more undo operations on text in the line edit. - By default, this property is false. + By default, this property is \c false. */ bool QLineEdit::isRedoAvailable() const @@ -1089,7 +1089,7 @@ void QLineEdit::setCursorMoveStyle(Qt::CursorMoveStyle style) \brief whether the input satisfies the inputMask and the validator. - By default, this property is true. + By default, this property is \c true. \sa setInputMask(), setValidator() */ @@ -1320,7 +1320,7 @@ void QLineEdit::redo() QLineEdit does not show a cursor in read-only mode. - By default, this property is false. + By default, this property is \c false. \sa setEnabled() */ diff --git a/src/widgets/widgets/qmainwindow.cpp b/src/widgets/widgets/qmainwindow.cpp index 0df83189ba..0638981a9c 100644 --- a/src/widgets/widgets/qmainwindow.cpp +++ b/src/widgets/widgets/qmainwindow.cpp @@ -904,8 +904,8 @@ void QMainWindow::setAnimated(bool enabled) \brief whether docks can be nested \since 4.2 - If this property is false, dock areas can only contain a single row - (horizontal or vertical) of dock widgets. If this property is true, + If this property is \c false, dock areas can only contain a single row + (horizontal or vertical) of dock widgets. If this property is \c true, the area occupied by a dock widget can be split in either direction to contain more dock widgets. @@ -1092,8 +1092,8 @@ void QMainWindow::addDockWidget(Qt::DockWidgetArea area, QDockWidget *dockwidget /*! Restores the state of \a dockwidget if it is created after the call - to restoreState(). Returns true if the state was restored; otherwise - returns false. + to restoreState(). Returns \c true if the state was restored; otherwise + returns \c false. \sa restoreState(), saveState() */ diff --git a/src/widgets/widgets/qmdiarea.cpp b/src/widgets/widgets/qmdiarea.cpp index fd94dadac6..5c1d7a6c05 100644 --- a/src/widgets/widgets/qmdiarea.cpp +++ b/src/widgets/widgets/qmdiarea.cpp @@ -2090,7 +2090,7 @@ void QMdiArea::setOption(AreaOption option, bool on) } /*! - Returns true if \a option is enabled; otherwise returns false. + Returns \c true if \a option is enabled; otherwise returns \c false. \sa AreaOption, setOption() */ diff --git a/src/widgets/widgets/qmdisubwindow.cpp b/src/widgets/widgets/qmdisubwindow.cpp index 63d14f2301..b80eb069e2 100644 --- a/src/widgets/widgets/qmdisubwindow.cpp +++ b/src/widgets/widgets/qmdisubwindow.cpp @@ -2383,7 +2383,7 @@ QWidget *QMdiSubWindow::maximizedSystemMenuIconWidget() const } /*! - Returns true if this window is shaded; otherwise returns false. + Returns \c true if this window is shaded; otherwise returns \c false. A window is shaded if it is collapsed so that only the title bar is visible. @@ -2414,7 +2414,7 @@ void QMdiSubWindow::setOption(SubWindowOption option, bool on) } /*! - Returns true if \a option is enabled; otherwise returns false. + Returns \c true if \a option is enabled; otherwise returns \c false. \sa SubWindowOption, setOption() */ diff --git a/src/widgets/widgets/qmenu.cpp b/src/widgets/widgets/qmenu.cpp index c305748c7d..3a4fd449c8 100644 --- a/src/widgets/widgets/qmenu.cpp +++ b/src/widgets/widgets/qmenu.cpp @@ -1649,7 +1649,7 @@ QAction *QMenu::defaultAction() const This "torn-off" copy lives in a separate window. It contains the same menu items as the original menu, with the exception of the tear-off handle. - By default, this property is false. + By default, this property is \c false. */ void QMenu::setTearOffEnabled(bool b) { @@ -1673,7 +1673,7 @@ bool QMenu::isTearOffEnabled() const /*! When a menu is torn off a second menu is shown to display the menu contents in a new window. When the menu is in this mode and the menu - is visible returns true; otherwise false. + is visible returns \c true; otherwise false. \sa hideTearOffMenu(), isTearOffEnabled() */ @@ -1721,7 +1721,7 @@ QAction *QMenu::activeAction() const /*! \since 4.2 - Returns true if there are no visible actions inserted into the menu, false + Returns \c true if there are no visible actions inserted into the menu, false otherwise. \sa QWidget::actions() @@ -3164,7 +3164,7 @@ QPlatformMenu *QMenu::platformMenu() should be visually collapsed to a single one. Separators at the beginning or the end of the menu are also hidden. - By default, this property is true. + By default, this property is \c true. */ bool QMenu::separatorsCollapsible() const { @@ -3197,7 +3197,7 @@ void QMenu::setSeparatorsCollapsible(bool collapse) This property specifies whether action menu entries show their tooltip. - By default, this property is false. + By default, this property is \c false. */ bool QMenu::toolTipsVisible() const { diff --git a/src/widgets/widgets/qmenubar.cpp b/src/widgets/widgets/qmenubar.cpp index a7cad28df3..9c1e2f0516 100644 --- a/src/widgets/widgets/qmenubar.cpp +++ b/src/widgets/widgets/qmenubar.cpp @@ -1810,7 +1810,7 @@ QWidget *QMenuBar::cornerWidget(Qt::Corner corner) const This property specifies whether or not the menubar should be used as a native menubar on platforms that support it. The currently supported platforms are Mac OS X and Windows CE. On these platforms - if this property is true, the menubar is used in the native menubar and is not in the window of + if this property is \c true, the menubar is used in the native menubar and is not in the window of its parent, if false the menubar remains in the window. On other platforms the value of this attribute has no effect. diff --git a/src/widgets/widgets/qplaintextedit.cpp b/src/widgets/widgets/qplaintextedit.cpp index 5a8da45a88..90f2e47cd3 100644 --- a/src/widgets/widgets/qplaintextedit.cpp +++ b/src/widgets/widgets/qplaintextedit.cpp @@ -1211,7 +1211,7 @@ void QPlainTextEditPrivate::ensureViewportLayouted() Users are only able to undo or redo actions if this property is true, and if there is an action that can be undone (or redone). - By default, this property is true. + By default, this property is \c true. */ /*! @@ -2332,11 +2332,11 @@ QRect QPlainTextEdit::cursorRect() const As with many text editors, the plain text editor widget can be configured to insert or overwrite existing text with new text entered by the user. - If this property is true, existing text is overwritten, character-for-character + If this property is \c true, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text. - By default, this property is false (new text does not overwrite existing text). + By default, this property is \c false (new text does not overwrite existing text). */ bool QPlainTextEdit::overwriteMode() const @@ -2435,7 +2435,7 @@ QMimeData *QPlainTextEdit::createMimeDataFromSelection() const } /*! - This function returns true if the contents of the MIME data object, specified + This function returns \c true if the contents of the MIME data object, specified by \a source, can be decoded and inserted into the document. It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag. @@ -2747,8 +2747,8 @@ void QPlainTextEdit::setCenterOnScroll(bool enabled) /*! Finds the next occurrence of the string, \a exp, using the given - \a options. Returns true if \a exp was found and changes the - cursor to select the match; otherwise returns false. + \a options. Returns \c true if \a exp was found and changes the + cursor to select the match; otherwise returns \c false. */ bool QPlainTextEdit::find(const QString &exp, QTextDocument::FindFlags options) { diff --git a/src/widgets/widgets/qprogressbar.cpp b/src/widgets/widgets/qprogressbar.cpp index e317933e4d..123cb5bd6e 100644 --- a/src/widgets/widgets/qprogressbar.cpp +++ b/src/widgets/widgets/qprogressbar.cpp @@ -533,7 +533,7 @@ Qt::Orientation QProgressBar::orientation() const \property QProgressBar::invertedAppearance \brief whether or not a progress bar shows its progress inverted - If this property is false, the progress bar grows in the other + If this property is \c false, the progress bar grows in the other direction (e.g. from right to left). By default, the progress bar is not inverted. diff --git a/src/widgets/widgets/qsplitter.cpp b/src/widgets/widgets/qsplitter.cpp index 1f3646ea6e..f58881af0d 100644 --- a/src/widgets/widgets/qsplitter.cpp +++ b/src/widgets/widgets/qsplitter.cpp @@ -158,8 +158,8 @@ Qt::Orientation QSplitterHandle::orientation() const /*! - Returns true if widgets are resized dynamically (opaquely), otherwise - returns false. This value is controlled by the QSplitter. + Returns \c true if widgets are resized dynamically (opaquely), otherwise + returns \c false. This value is controlled by the QSplitter. \sa QSplitter::opaqueResize() @@ -1070,7 +1070,7 @@ void QSplitter::setCollapsible(int index, bool collapse) } /*! - Returns true if the widget at \a index is collapsible, otherwise returns false. + Returns \c true if the widget at \a index is collapsible, otherwise returns \c false. */ bool QSplitter::isCollapsible(int index) const { @@ -1616,7 +1616,7 @@ QByteArray QSplitter::saveState() const /*! Restores the splitter's layout to the \a state specified. - Returns true if the state is restored; otherwise returns false. + Returns \c true if the state is restored; otherwise returns \c false. Typically this is used in conjunction with QSettings to restore the size from a past session. Here is an example: diff --git a/src/widgets/widgets/qtabbar.cpp b/src/widgets/widgets/qtabbar.cpp index 94c85ff92b..094e9af0de 100644 --- a/src/widgets/widgets/qtabbar.cpp +++ b/src/widgets/widgets/qtabbar.cpp @@ -930,8 +930,8 @@ void QTabBar::removeTab(int index) /*! - Returns true if the tab at position \a index is enabled; otherwise - returns false. + Returns \c true if the tab at position \a index is enabled; otherwise + returns \c false. */ bool QTabBar::isTabEnabled(int index) const { @@ -2219,7 +2219,7 @@ void QTabBar::setExpanding(bool enabled) \since 4.5 - By default, this property is false; + By default, this property is \c false; */ bool QTabBar::isMovable() const diff --git a/src/widgets/widgets/qtabwidget.cpp b/src/widgets/widgets/qtabwidget.cpp index 9d14c01490..8c15b3e58e 100644 --- a/src/widgets/widgets/qtabwidget.cpp +++ b/src/widgets/widgets/qtabwidget.cpp @@ -523,7 +523,7 @@ QIcon QTabWidget::tabIcon(int index) const } /*! - Returns true if the page at position \a index is enabled; otherwise returns false. + Returns \c true if the page at position \a index is enabled; otherwise returns \c false. \sa setTabEnabled(), QWidget::isEnabled() */ @@ -1020,7 +1020,7 @@ void QTabWidget::setTabsClosable(bool closeable) \since 4.5 - By default, this property is false; + By default, this property is \c false; */ bool QTabWidget::isMovable() const diff --git a/src/widgets/widgets/qtextbrowser.cpp b/src/widgets/widgets/qtextbrowser.cpp index e05da51207..273a5dabeb 100644 --- a/src/widgets/widgets/qtextbrowser.cpp +++ b/src/widgets/widgets/qtextbrowser.cpp @@ -643,14 +643,14 @@ void QTextBrowserPrivate::restoreHistoryEntry(const HistoryEntry entry) \property QTextBrowser::readOnly \brief whether the text browser is read-only - By default, this property is true. + By default, this property is \c true. */ /*! \property QTextBrowser::undoRedoEnabled \brief whether the text browser supports undo/redo operations - By default, this property is false. + By default, this property is \c false. */ void QTextBrowserPrivate::init() @@ -1103,7 +1103,7 @@ QVariant QTextBrowser::loadResource(int /*type*/, const QUrl &name) /*! \since 4.2 - Returns true if the text browser can go backward in the document history + Returns \c true if the text browser can go backward in the document history using backward(). \sa backwardAvailable(), backward() @@ -1117,7 +1117,7 @@ bool QTextBrowser::isBackwardAvailable() const /*! \since 4.2 - Returns true if the text browser can go forward in the document history + Returns \c true if the text browser can go forward in the document history using forward(). \sa forwardAvailable(), forward() diff --git a/src/widgets/widgets/qtextedit.cpp b/src/widgets/widgets/qtextedit.cpp index 4e0c682493..0f61eb487f 100644 --- a/src/widgets/widgets/qtextedit.cpp +++ b/src/widgets/widgets/qtextedit.cpp @@ -664,7 +664,7 @@ int QTextEdit::fontWeight() const } /*! - Returns true if the font of the current format is underlined; otherwise returns + Returns \c true if the font of the current format is underlined; otherwise returns false. \sa setFontUnderline() @@ -676,7 +676,7 @@ bool QTextEdit::fontUnderline() const } /*! - Returns true if the font of the current format is italic; otherwise returns + Returns \c true if the font of the current format is italic; otherwise returns false. \sa setFontItalic() @@ -1906,11 +1906,11 @@ QString QTextEdit::anchorAt(const QPoint& pos) const As with many text editors, the text editor widget can be configured to insert or overwrite existing text with new text entered by the user. - If this property is true, existing text is overwritten, character-for-character + If this property is \c true, existing text is overwritten, character-for-character by new text; otherwise, text is inserted at the cursor position, displacing existing text. - By default, this property is false (new text does not overwrite existing text). + By default, this property is \c false (new text does not overwrite existing text). */ bool QTextEdit::overwriteMode() const @@ -2054,7 +2054,7 @@ QMimeData *QTextEdit::createMimeDataFromSelection() const } /*! - This function returns true if the contents of the MIME data object, specified + This function returns \c true if the contents of the MIME data object, specified by \a source, can be decoded and inserted into the document. It is called for example when during a drag operation the mouse enters this widget and it is necessary to determine whether it is possible to accept the drag and drop @@ -2445,8 +2445,8 @@ void QTextEdit::setWordWrapMode(QTextOption::WrapMode mode) /*! Finds the next occurrence of the string, \a exp, using the given - \a options. Returns true if \a exp was found and changes the - cursor to select the match; otherwise returns false. + \a options. Returns \c true if \a exp was found and changes the + cursor to select the match; otherwise returns \c false. */ bool QTextEdit::find(const QString &exp, QTextDocument::FindFlags options) { diff --git a/src/widgets/widgets/qtoolbar.cpp b/src/widgets/widgets/qtoolbar.cpp index 0c2dd20d77..5f80bbb1ca 100644 --- a/src/widgets/widgets/qtoolbar.cpp +++ b/src/widgets/widgets/qtoolbar.cpp @@ -446,8 +446,8 @@ void QToolBarPrivate::plug(const QRect &r) /*! \fn bool QToolBar::isAreaAllowed(Qt::ToolBarArea area) const - Returns true if this toolbar is dockable in the given \a area; - otherwise returns false. + Returns \c true if this toolbar is dockable in the given \a area; + otherwise returns \c false. */ /*! @@ -585,7 +585,7 @@ QToolBar::~QToolBar() \brief whether the user can move the toolbar within the toolbar area, or between toolbar areas. - By default, this property is true. + By default, this property is \c true. This property only makes sense if the toolbar is in a QMainWindow. @@ -631,7 +631,7 @@ void QToolBar::setFloatable(bool floatable) \property QToolBar::floating \brief whether the toolbar is an independent window. - By default, this property is true. + By default, this property is \c true. \sa QWidget::isWindow() */ diff --git a/src/widgets/widgets/qtoolbox.cpp b/src/widgets/widgets/qtoolbox.cpp index 1264a5b6f2..e29fa18e35 100644 --- a/src/widgets/widgets/qtoolbox.cpp +++ b/src/widgets/widgets/qtoolbox.cpp @@ -646,7 +646,7 @@ void QToolBox::setItemToolTip(int index, const QString &toolTip) #endif // QT_NO_TOOLTIP /*! - Returns true if the item at position \a index is enabled; otherwise returns false. + Returns \c true if the item at position \a index is enabled; otherwise returns \c false. */ bool QToolBox::isItemEnabled(int index) const diff --git a/src/widgets/widgets/qwidgetlinecontrol.cpp b/src/widgets/widgets/qwidgetlinecontrol.cpp index 6a41144cc1..b16477246f 100644 --- a/src/widgets/widgets/qwidgetlinecontrol.cpp +++ b/src/widgets/widgets/qwidgetlinecontrol.cpp @@ -416,7 +416,7 @@ QRect QWidgetLineControl::cursorRect() const Fixes the current text so that it is valid given any set validators. - Returns true if the text was changed. Otherwise returns false. + Returns \c true if the text was changed. Otherwise returns \c false. */ bool QWidgetLineControl::fixup() // this function assumes that validate currently returns != Acceptable { @@ -1090,10 +1090,10 @@ bool QWidgetLineControl::isValidInput(QChar key, QChar mask) const /*! \internal - Returns true if the given text \a str is valid for any + Returns \c true if the given text \a str is valid for any validator or input mask set for the line control. - Otherwise returns false + Otherwise returns \c false */ bool QWidgetLineControl::hasAcceptableInput(const QString &str) const { |