diff options
Diffstat (limited to 'src/widgets/graphicsview')
| -rw-r--r-- | src/widgets/graphicsview/qgraphicsanchorlayout_p.cpp | 8 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicsitem.cpp | 78 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicsitem_p.h | 4 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicslayout.cpp | 6 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicslayoutitem.cpp | 6 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicsscene.cpp | 46 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicsview.cpp | 4 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgraphicswidget.cpp | 16 | ||||
| -rw-r--r-- | src/widgets/graphicsview/qgridlayoutengine.cpp | 6 |
9 files changed, 87 insertions, 87 deletions
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 { |