1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Ensure deprecated APIs in Gui are documented as such

Browse Source 
Fixes: QTBUG-94521
Fixes: QTBUG-95310
Change-Id: I3d0418a3f7dca191a9068cc22627fe4deb7c53c5
(cherry picked from commit 111115bf8862b7cd1197c2ef8a4b475c882776d4)
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Nico Vertriest 2021-06-01 11:38:06 +02:00
parent 610a375710
commit de0c62421a
10 changed files with 70 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/gui/image/qbitmap.cpp
View File

@ -114,19 +114,19 @@ QBitmap::QBitmap()
\sa clear()
*/
QBitmap::QBitmap(int w, int h)
: QPixmap(QSize(w, h), QPlatformPixmap::BitmapType)
{
}
/*!
\deprecated Use fromPixmap instead.
Constructs a bitmap with the given \a size. The pixels in the
bitmap are uninitialized.
\sa clear()
*/
QBitmap::QBitmap(const QSize &size)
: QPixmap(size, QPlatformPixmap::BitmapType)
{
@ -149,7 +149,6 @@ QBitmap::QBitmap(const QSize &size)
\sa QPixmap::isNull(), QImageReader::imageFormat()
*/
QBitmap::QBitmap(const QString& fileName, const char *format)
: QPixmap(QSize(0, 0), QPlatformPixmap::BitmapType)
{
@ -277,7 +276,7 @@ QBitmap QBitmap::fromPixmap(const QPixmap &pixmap)
#if QT_DEPRECATED_SINCE(6, 0)
/*!
\obsolete Use fromPixmap instead.
\deprecated Use fromPixmap instead.
Constructs a bitmap that is a copy of the given \a pixmap.
If the pixmap has a depth greater than 1, the resulting bitmap
@ -285,14 +284,13 @@ QBitmap QBitmap::fromPixmap(const QPixmap &pixmap)
\sa QPixmap::depth(), fromImage(), fromData()
*/
QBitmap::QBitmap(const QPixmap &pixmap)
{
*this = QBitmap::fromPixmap(pixmap);
}
/*!
\obsolete Use fromPixmap instead.
\deprecated Use fromPixmap instead.
\overload
Assigns the given \a pixmap to this bitmap and returns a reference
@ -303,7 +301,6 @@ QBitmap::QBitmap(const QPixmap &pixmap)
\sa QPixmap::depth()
*/
QBitmap &QBitmap::operator=(const QPixmap &pixmap)
{
*this = QBitmap::fromPixmap(pixmap);

5
src/gui/image/qicon.cpp
View File

@ -876,7 +876,7 @@ QPixmap QIcon::pixmap(const QSize &size, qreal devicePixelRatio, Mode mode, Stat
#if QT_DEPRECATED_SINCE(6, 0)
/*!
\since 5.1
\deprecated
\deprecated Use pixmap(size, devicePixelRatio, mode, state) instead.
Returns a pixmap with the requested \a window \a size, \a mode, and \a
state, generating one if necessary.
@ -885,8 +885,6 @@ QPixmap QIcon::pixmap(const QSize &size, qreal devicePixelRatio, Mode mode, Stat
a high-dpi display the pixmap can be larger. In that case it will have
a devicePixelRatio larger than 1.
\obsolete Use the overload which takes qreal devicePixelRatio instead.
\sa actualSize(), paint()
*/
@ -926,6 +924,7 @@ QSize QIcon::actualSize(const QSize &size, Mode mode, State state) const
#if QT_DEPRECATED_SINCE(6, 0)
/*!
\since 5.1
\deprecated Use actualSize(size) instead.
Returns the actual size of the icon for the requested \a window \a size, \a
mode, and \a state.

55
src/gui/kernel/qevent.cpp
View File

@ -98,46 +98,55 @@ QEnterEvent::~QEnterEvent()
/*!
\fn QPoint QEnterEvent::globalPos() const
\deprecated Use globalPosition() instead.
Returns the global position of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn int QEnterEvent::globalX() const
\deprecated Use globalPosition().x() instead.
Returns the global position on the X-axis of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn int QEnterEvent::globalY() const
\deprecated Use globalPosition().y() instead.
Returns the global position on the Y-axis of the mouse cursor \e{at the time of the event}.
*/
/*!
\fn QPointF QEnterEvent::localPos() const
\deprecated Use position() instead.
Returns the mouse cursor's position relative to the receiving widget.
*/
/*!
\fn QPoint QEnterEvent::pos() const
\deprecated Use position().toPoint() instead.
Returns the position of the mouse cursor relative to the receiving widget.
*/
/*!
\fn QPointF QEnterEvent::screenPos() const
\deprecated Use globalPosition() instead.
Returns the position of the mouse cursor relative to the receiving screen.
*/
/*!
\fn QPointF QEnterEvent::windowPos() const
\deprecated Use scenePosition() instead.
Returns the position of the mouse cursor relative to the receiving window.
*/
/*!
\fn int QEnterEvent::x() const
\deprecated Use position().x() instead.
Returns the x position of the mouse cursor relative to the receiving widget.
*/
/*!
\fn int QEnterEvent::y() const
\deprecated Use position().y() instead.
Returns the y position of the mouse cursor relative to the receiving widget.
*/
@ -629,7 +638,6 @@ bool QSinglePointEvent::isEndEvent() const
\endcode
*/
/*!
\class QMouseEvent
\ingroup events
@ -778,7 +786,7 @@ QMouseEvent::~QMouseEvent()
/*!
\since 5.3
\deprecated in 6.0: use pointingDevice()
\deprecated Use pointingDevice() instead.
Returns information about the mouse event source.
@ -817,6 +825,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn QPointF QMouseEvent::localPos() const
\deprecated Use position() instead.
\since 5.0
@ -844,6 +853,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn QPointF QMouseEvent::windowPos() const
\deprecated Use scenePosition() instead.
\since 5.0
@ -859,6 +869,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn QPointF QMouseEvent::screenPos() const
\deprecated Use globalPosition() instead.
\since 5.0
@ -883,6 +894,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn QPoint QMouseEvent::globalPos() const
\deprecated Use globalPosition().toPoint() instead.
Returns the global position of the mouse cursor \e{at the time
of the event}. This is important on asynchronous window systems
@ -896,6 +908,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn int QMouseEvent::x() const
\deprecated Use position().x() instead.
Returns the x position of the mouse cursor, relative to the
widget that received the event.
@ -905,6 +918,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn int QMouseEvent::y() const
\deprecated Use position().y() instead.
Returns the y position of the mouse cursor, relative to the
widget that received the event.
@ -914,6 +928,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn int QMouseEvent::globalX() const
\deprecated Use globalPosition().x() instead.
Returns the global x position of the mouse cursor at the time of
the event.
@ -923,6 +938,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn int QMouseEvent::globalY() const
\deprecated Use globalPosition().y() instead.
Returns the global y position of the mouse cursor at the time of
the event.
@ -980,6 +996,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn QPoint QHoverEvent::pos() const
\deprecated Use position().toPoint() instead.
Returns the position of the mouse cursor, relative to the widget
that received the event.
@ -1005,6 +1022,7 @@ Qt::MouseEventFlags QMouseEvent::flags() const
/*!
\fn const QPointF &QHoverEvent::posF() const
\deprecated Use position() instead.
Returns the position of the mouse cursor, relative to the widget
that received the event.
@ -1096,7 +1114,7 @@ QHoverEvent::~QHoverEvent()
/*!
\fn Qt::MouseEventSource QWheelEvent::source() const
\since 5.5
\deprecated in 6.0: use pointingDevice()
\deprecated Use pointingDevice() instead.
Returns information about the wheel event source.
@ -1225,7 +1243,7 @@ bool QWheelEvent::isEndEvent() const
\li scrolling is about to begin, but the distance did not yet change (Qt::ScrollBegin),
\li or scrolling has ended and the distance did not change anymore (Qt::ScrollEnd).
\endlist
\note On X11 this value is driver specific and unreliable, use angleDelta() instead
\note On X11 this value is driver-specific and unreliable, use angleDelta() instead.
*/
/*!
@ -1774,6 +1792,7 @@ QPlatformSurfaceEvent::~QPlatformSurfaceEvent()
/*!
\fn const QRegion &QExposeEvent::region() const
\deprecated Use QPaintEvent instead.
Returns the window area that has been exposed. The region is given in local coordinates.
*/
@ -2610,6 +2629,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn QPoint QTabletEvent::pos() const
\deprecated Use position().toPoint() instead.
Returns the position of the device, relative to the widget that
received the event.
@ -2622,6 +2642,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn int QTabletEvent::x() const
\deprecated Use position().x() instead.
Returns the x position of the device, relative to the widget that
received the event.
@ -2631,6 +2652,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn int QTabletEvent::y() const
\deprecated Use position().y() instead.
Returns the y position of the device, relative to the widget that
received the event.
@ -2652,6 +2674,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn QPoint QTabletEvent::globalPos() const
\deprecated Use globalPosition().toPoint() instead.
Returns the global position of the device \e{at the time of the
event}. This is important on asynchronous windows systems like X11;
@ -2664,6 +2687,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn int QTabletEvent::globalX() const
\deprecated Use globalPosition().x() instead.
Returns the global x position of the mouse pointer at the time of
the event.
@ -2673,6 +2697,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn int QTabletEvent::globalY() const
\deprecated Use globalPosition().y() instead.
Returns the global y position of the tablet device at the time of
the event.
@ -2682,6 +2707,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn qint64 QTabletEvent::uniqueId() const
\deprecated Use pointingDevice().uniqueId() instead.
Returns a unique ID for the current device, making it possible
to differentiate between multiple devices being used at the same
@ -2705,6 +2731,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn const QPointF &QTabletEvent::posF() const
\deprecated Use position() instead.
Returns the position of the device, relative to the widget that
received the event.
@ -2717,7 +2744,7 @@ QTabletEvent::~QTabletEvent()
/*!
\fn const QPointF &QTabletEvent::globalPosF() const
\deprecated Use globalPosition() instead.
Returns the global position of the device \e{at the time of the
event}. This is important on asynchronous windows systems like X11;
whenever you move your widgets around in response to mouse events,
@ -2816,6 +2843,7 @@ QNativeGestureEvent::~QNativeGestureEvent() = default;
/*!
\fn QPoint QNativeGestureEvent::globalPos() const
\since 5.2
\deprecated Use globalPosition().toPoint() instead.
Returns the position of the gesture as a QPointF in screen coordinates
*/
@ -2823,6 +2851,7 @@ QNativeGestureEvent::~QNativeGestureEvent() = default;
/*!
\fn QPoint QNativeGestureEvent::pos() const
\since 5.2
\deprecated Use position().toPoint() instead.
Returns the position of the mouse cursor, relative to the widget
or item that received the event.
@ -2831,6 +2860,7 @@ QNativeGestureEvent::~QNativeGestureEvent() = default;
/*!
\fn QPointF QNativeGestureEvent::localPos() const
\since 5.2
\deprecated Use position() instead.
Returns the position of the gesture as a QPointF, relative to the
widget or item that received the event.
@ -2839,6 +2869,7 @@ QNativeGestureEvent::~QNativeGestureEvent() = default;
/*!
\fn QPointF QNativeGestureEvent::screenPos() const
\since 5.2
\deprecated Use globalPosition() instead.
Returns the position of the gesture as a QPointF in screen coordinates.
*/
@ -2846,6 +2877,7 @@ QNativeGestureEvent::~QNativeGestureEvent() = default;
/*!
\fn QPointF QNativeGestureEvent::windowPos() const
\since 5.2
\deprecated Use scenePosition() instead.
Returns the position of the gesture as a QPointF, relative to the
window that received the event.
@ -3023,24 +3055,28 @@ void QDropEvent::setDropAction(Qt::DropAction action)
/*!
\fn QPoint QDropEvent::pos() const
\deprecated Use position().toPoint() instead.
Returns the position where the drop was made.
*/
/*!
\fn const QPointF& QDropEvent::posF() const
\deprecated Use position() instead.
Returns the position where the drop was made.
*/
/*!
\fn Qt::MouseButtons QDropEvent::mouseButtons() const
\deprecated Use buttons() instead.
Returns the mouse buttons that are pressed..
*/
/*!
\fn Qt::KeyboardModifiers QDropEvent::keyboardModifiers() const
\deprecated Use modifiers() instead.
Returns the modifier keys that are pressed.
*/
@ -4383,6 +4419,8 @@ QWindowStateChangeEvent::~QWindowStateChangeEvent()
*/
/*!
\deprecated Use another constructor.
Constructs a QTouchEvent with the given \a eventType, \a device,
\a touchPoints, and current keyboard \a modifiers at the time of the event.
*/
@ -4401,9 +4439,7 @@ QTouchEvent::QTouchEvent(QEvent::Type eventType,
}
/*!
\obsolete
Try to use another constructor, because \a touchPointStates
can be calculated from the given \a touchPoints.
\deprecated Use another constructor.
Constructs a QTouchEvent with the given \a eventType, \a device, and
\a touchPoints. The \a touchPointStates and \a modifiers are the current
@ -4466,8 +4502,7 @@ bool QTouchEvent::isEndEvent() const
*/
/*! \fn const QList<QEventPoint> &QTouchEvent::touchPoints() const
\obsolete
Deprecated since Qt 6.0. Use points() instead.
\deprecated Use points() instead.
Returns a reference to the list of touch points contained in the touch event.

15
src/gui/kernel/qeventpoint.cpp
View File

@ -142,8 +142,7 @@ bool QEventPoint::operator==(const QEventPoint &other) const noexcept
QEventPoint::~QEventPoint() = default;
/*! \fn QPointF QEventPoint::pos() const
\obsolete
Deprecated since Qt 6.0. Use position() instead.
\deprecated Use position() instead.
Returns the position of this point, relative to the widget
or item that received the event.
@ -443,10 +442,8 @@ bool QEventPoint::isAccepted() const
/*!
\obsolete
\fn QPointF QEventPoint::normalizedPos() const
Deprecated since Qt 6.0. Use normalizedPosition() instead.
\deprecated Use normalizedPosition() instead.
*/
/*!
@ -470,8 +467,7 @@ QPointF QEventPoint::normalizedPosition() const
}
/*!
\obsolete
Deprecated since Qt 6.0. Use globalPressPosition() instead.
\deprecated Use globalPressPosition() instead.
Returns the normalized press position of this point.
*/
@ -487,8 +483,7 @@ QPointF QEventPoint::startNormalizedPos() const
}
/*!
\obsolete
Deprecated since Qt 6.0. Use globalLastPosition() instead.
\deprecated Use globalLastPosition() instead.
Returns the normalized position of this point from the previous press or
move event.
@ -496,7 +491,7 @@ QPointF QEventPoint::startNormalizedPos() const
The coordinates are normalized to QInputDevice::availableVirtualGeometry(),
i.e. \c (0, 0) is the top-left corner and \c (1, 1) is the bottom-right corner.
\sa normalizedPos(), startNormalizedPos()
\sa normalizedPosition(), globalPressPosition()
*/
QPointF QEventPoint::lastNormalizedPos() const
{

4
src/gui/kernel/qguiapplication.cpp
View File

@ -3302,7 +3302,7 @@ QClipboard * QGuiApplication::clipboard()
/*!
\since 5.4
\fn void QGuiApplication::paletteChanged(const QPalette &palette)
\obsolete
\deprecated Handle QEvent::ApplicationPaletteChange instead.
This signal is emitted when the \a palette of the application changes. Use
QEvent::ApplicationPaletteChanged instead.
@ -3413,7 +3413,7 @@ void QGuiApplicationPrivate::applyWindowGeometrySpecificationTo(QWindow *window)
/*!
\since 5.11
\fn void QGuiApplication::fontChanged(const QFont &font)
\obsolete
\deprecated Handle QEvent::ApplicationFontChange instead.
This signal is emitted when the \a font of the application changes. Use
QEvent::ApplicationFontChanged instead.

8
src/gui/math3d/qmatrix4x4.cpp
View File

@ -633,7 +633,7 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor)
\fn QVector3D operator*(const QVector3D& vector, const QMatrix4x4& matrix)
\relates QMatrix4x4
\obsolete Convert the QVector3D to a QVector4D first, then multiply.
\deprecated Convert the QVector3D to a QVector4D first, then multiply.
Returns the result of transforming \a vector according to \a matrix,
with the matrix applied post-vector. The vector is transformed as a point.
@ -643,7 +643,7 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor)
\fn QVector3D operator*(const QMatrix4x4& matrix, const QVector3D& vector)
\relates QMatrix4x4
\obsolete Use QMatrix4x4::map() or QMatrix4x4::mapVector() instead.
\deprecated Use QMatrix4x4::map() or QMatrix4x4::mapVector() instead.
Returns the result of transforming \a vector according to \a matrix,
with the matrix applied pre-vector. The vector is transformed as a
@ -696,7 +696,7 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor)
\fn QPoint operator*(const QMatrix4x4& matrix, const QPoint& point)
\relates QMatrix4x4
\obsolete Use QMatrix4x4::map() instead.
\deprecated Use QMatrix4x4::map() instead.
Returns the result of transforming \a point according to \a matrix,
with the matrix applied pre-point.
@ -706,7 +706,7 @@ QMatrix4x4& QMatrix4x4::operator/=(float divisor)
\fn QPointF operator*(const QMatrix4x4& matrix, const QPointF& point)
\relates QMatrix4x4
\obsolete Use QMatrix4x4::map() instead.
\deprecated Use QMatrix4x4::map() instead.
Returns the result of transforming \a point according to \a matrix,
with the matrix applied pre-point.

7
src/gui/text/qfont.cpp
View File

@ -702,7 +702,6 @@ QFont::QFont()
}
/*!
\obsolete
Constructs a font object with the specified \a family, \a
pointSize, \a weight and \a italic settings.
@ -1193,7 +1192,7 @@ QFont::Weight QFont::weight() const
#if QT_DEPRECATED_SINCE(6, 0)
/*!
\obsolete Use setWeight() instead.
\deprecated Use setWeight() instead.
Sets the weight of the font to \a legacyWeight using the legacy font
weight scale of Qt 5 and previous versions.
@ -1205,7 +1204,7 @@ QFont::Weight QFont::weight() const
\note If styleName() is set, this value may be ignored for font selection.
\sa setWeight(), weight(), legacyWeight(), QFontInfo
\sa setWeight(), weight(), QFontInfo
*/
void QFont::setLegacyWeight(int legacyWeight)
{
@ -1213,7 +1212,7 @@ void QFont::setLegacyWeight(int legacyWeight)
}
/*!
\obsolete Use weight() instead.
\deprecated Use weight() instead.
Returns the weight of the font converted to the non-standard font
weight scale used in Qt 5 and earlier versions.

1
src/gui/text/qfont.h
View File

@ -167,6 +167,7 @@ public:
Q_ENUM(ResolveProperties)
QFont();
QFont(const QString &family, int pointSize = -1, int weight = -1, bool italic = false);
explicit QFont(const QStringList &families, int pointSize = -1, int weight = -1, bool italic = false);
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)

2
src/gui/text/qfontdatabase.cpp
View File

@ -1239,7 +1239,7 @@ QString QFontDatabase::styleString(const QFontInfo &fontInfo)
/*!
\fn QFontDatabase::QFontDatabase()
\obsolete Call the class methods as static functions instead.
\deprecated Call the class methods as static functions instead.
Creates a font database object.
*/

6
src/gui/text/qtextformat.cpp
View File

@ -1373,7 +1373,7 @@ bool QTextFormat::operator==(const QTextFormat &rhs) const
The font used can be set by supplying a font to the setFont() function, and
each aspect of its appearance can be adjusted to give the desired effect.
setFontFamily() and setFontPointSize() define the font's family (e.g. Times)
setFontFamilies() and setFontPointSize() define the font's family (e.g. Times)
and printed size; setFontWeight() and setFontItalic() provide control over
the style of the font. setFontUnderline(), setFontOverline(),
setFontStrikeOut(), and setFontFixedPitch() provide additional effects for
@ -1457,7 +1457,7 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt)
/*!
\fn void QTextCharFormat::setFontFamily(const QString &family)
\obsolete Use setFontFamilies() instead.
\deprecated Use setFontFamilies() instead.
Sets the text format's font \a family.
@ -1467,7 +1467,7 @@ QTextCharFormat::QTextCharFormat(const QTextFormat &fmt)
/*!
\fn QString QTextCharFormat::fontFamily() const
\obsolete Use fontFamilies() instead.
\deprecated Use fontFamilies() instead.
Returns the text format's font family.