QUtiMimeConverter: document as public and fix \since

It's a new public API, so don't document it as internal. Fix the \since
to 6.5 - it's an old class under a new name, and make a small language
improvement in related documentation.

Change-Id: I57bfa868f19aa293c01d6a1f8bbbff1bebe7541a
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
Reviewed-by: Kai Köhne <kai.koehne@qt.io>
(cherry picked from commit b36f126668f5d7c0ac58f2d058861680df176ca2)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Volker Hilsheimer 2023-01-21 11:04:35 +01:00 committed by Qt Cherry-pick Bot
parent 708a48a0b0
commit 66b21ce676
2 changed files with 7 additions and 8 deletions

View File

@ -376,11 +376,10 @@
Cocoa Drag Manager. On X11, XDND uses MIME, so no translation is necessary. Cocoa Drag Manager. On X11, XDND uses MIME, so no translation is necessary.
The Qt API is the same regardless of the platform. On Windows, MIME-aware The Qt API is the same regardless of the platform. On Windows, MIME-aware
applications can communicate by using clipboard format names that are MIME applications can communicate by using clipboard format names that are MIME
types. Already some Windows applications use MIME naming conventions for types. Some Windows applications already use MIME naming conventions for
their clipboard formats. their clipboard formats.
Custom classes for translating proprietary clipboard formats can be Custom classes for translating proprietary clipboard formats can be
registered by reimplementing QWindowsMimeConverter on Windows or registered by reimplementing QWindowsMimeConverter on Windows or
QUtiMimeConverter on \macos. QUtiMimeConverter on \macos.
*/ */

View File

@ -36,11 +36,10 @@ using namespace Qt::StringLiterals;
/*! /*!
\class QUtiMimeConverter \class QUtiMimeConverter
\internal
\brief The QUtiMimeConverter class converts between a MIME type and a \brief The QUtiMimeConverter class converts between a MIME type and a
\l{https://developer.apple.com/documentation/uniformtypeidentifiers} \l{https://developer.apple.com/documentation/uniformtypeidentifiers}
{Uniform Type Identifier (UTI)} format. {Uniform Type Identifier (UTI)} format.
\since 4.2 \since 6.5
\ingroup draganddrop \ingroup draganddrop
\inmodule QtGui \inmodule QtGui
@ -82,6 +81,7 @@ using namespace Qt::StringLiterals;
*/ */
/*! /*!
\internal
Constructs a new conversion object of type \a scope, adding it to the Constructs a new conversion object of type \a scope, adding it to the
globally accessed list of available converters. globally accessed list of available converters.
*/ */
@ -126,7 +126,7 @@ int QUtiMimeConverter::count(const QMimeData *mimeData) const
*/ */
/*! /*!
\fn QString QUtiMimeConverter::mimeForUti(QString uti) \fn QString QUtiMimeConverter::mimeForUti(const QString &uti) const
Returns the MIME type used for Mac UTI \a uti, or an empty string if Returns the MIME type used for Mac UTI \a uti, or an empty string if
this converter does not support converting from \a uti. this converter does not support converting from \a uti.
@ -135,7 +135,7 @@ int QUtiMimeConverter::count(const QMimeData *mimeData) const
*/ */
/*! /*!
\fn QString QUtiMimeConverter::utiForMime(const QString &mime) \fn QString QUtiMimeConverter::utiForMime(const QString &mime) const
Returns the Mac UTI used for MIME type \a mime, or an empty string if Returns the Mac UTI used for MIME type \a mime, or an empty string if
this converter does not support converting from \a mime. this converter does not support converting from \a mime.
@ -145,7 +145,7 @@ int QUtiMimeConverter::count(const QMimeData *mimeData) const
/*! /*!
\fn QVariant QUtiMimeConverter::convertToMime(const QString &mime, \fn QVariant QUtiMimeConverter::convertToMime(const QString &mime,
const QList<QByteArray> &data, const QString &uti) const QList<QByteArray> &data, const QString &uti) const
Returns \a data converted from Mac UTI \a uti to MIME type \a mime. Returns \a data converted from Mac UTI \a uti to MIME type \a mime.
@ -157,7 +157,7 @@ int QUtiMimeConverter::count(const QMimeData *mimeData) const
/*! /*!
\fn QList<QByteArray> QUtiMimeConverter::convertFromMime(const QString &mime, \fn QList<QByteArray> QUtiMimeConverter::convertFromMime(const QString &mime,
const QVariant &data, const QString & uti) const QVariant &data, const QString & uti) const
Returns \a data converted from MIME type \a mime to Mac UTI \a uti. Returns \a data converted from MIME type \a mime to Mac UTI \a uti.