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

Doc: Improve QTemporaryFile::open() descriptions

Browse Source 
Explain the behavior of open() in detail, including the edge
cases (reopening a file). Fix links to QIODeviceBase::OpenMode
flags. Use explicit links to make linking more robust. Use
the same parameter name 'mode' as in the base class.

Pick-to: 6.8
Task-number: QTBUG-131484
Change-Id: I5d01b3bb48a7a439b93c144e6d38482607de8d33
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
(cherry picked from commit adaf1fb107ceb7003313ceb67605f986b74763b1)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Kai Köhne 2024-12-05 16:25:23 +01:00 committed by Qt Cherry-pick Bot
parent b70e61788f
commit 604dcc714a
1 changed files with 30 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
src/corelib/io/qtemporaryfile.cpp
View File

@ -736,14 +736,21 @@ QTemporaryFile::~QTemporaryFile()
}
/*!
\fn bool QTemporaryFile::open()
\fn bool QTemporaryFile::open()
A QTemporaryFile will always be opened in QIODevice::ReadWrite mode,
this allows easy access to the data in the file. This function will
return true upon success and will set the fileName() to the unique
filename used.
Opens a unique temporary file in the file system in
\l QIODeviceBase::ReadWrite mode.
Returns \c true if the file was successfully opened, or was already open.
Otherwise returns \c false.
\sa fileName(), QT_USE_NODISCARD_FILE_OPEN
If called for the first time, open() will create a unique file name
based on \l fileTemplate(). The file is guaranteed to have been created
by this function (that is, it has never existed before).
If a file is reopened after calling \l close(), the same file will be
opened again.
\sa setFileTemplate(), QT_USE_NODISCARD_FILE_OPEN
*/
/*!
@ -964,18 +971,28 @@ QTemporaryFile *QTemporaryFile::createNativeFile(QFile &file)
}
/*!
\reimp
\reimp
Creates a unique file name for the temporary file, and opens it. You can
get the unique name later by calling fileName(). The file is guaranteed to
have been created by this function (i.e., it has never existed before).
Opens a unique temporary file in the file system with \a mode flags.
Returns \c true if the file was successfully opened, or was already open.
Otherwise returns \c false.
If called for the first time, open() will create a unique file name
based on \l fileTemplate(), and open it with \a mode flags.
The file is guaranteed to have been created by this function (that is,
it has never existed before).
If a file is reopened after calling \l close(), the same file will be
opened again with \a mode flags.
\sa setFileTemplate(), QT_USE_NODISCARD_FILE_OPEN
*/
bool QTemporaryFile::open(OpenMode flags)
bool QTemporaryFile::open(OpenMode mode)
{
Q_D(QTemporaryFile);
auto tef = static_cast<QTemporaryFileEngine *>(d->fileEngine.get());
if (tef && tef->isReallyOpen()) {
setOpenMode(flags);
setOpenMode(mode);
return true;
}
@ -986,7 +1003,7 @@ bool QTemporaryFile::open(OpenMode flags)
// d->engine();
d->resetFileEngine();
if (QFile::open(flags)) {
if (QFile::open(mode)) {
tef = static_cast<QTemporaryFileEngine *>(d->fileEngine.get());
if (tef->isUnnamedFile())
d->fileName.clear();