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

Doc: Reorder QFile overview

Browse Source 
Move the paragraphs dealing with encodeName()/decodeName() and Unix
special files to 'Platform Specific Issues'.

Change-Id: I076191e041ef238556aab28b5ad5d51974f8f7ff
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
(cherry picked from commit 8b0818235d512c9085ce0fd0ea2490f1653a6c36)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Kai Köhne 2022-12-21 15:39:15 +01:00 committed by Qt Cherry-pick Bot
parent 086b41349a
commit be6cd144d3
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/corelib/io/qfile.cpp
View File

@ -150,6 +150,15 @@ QAbstractFileEngine *QFilePrivate::engine() const
data and operator>>() to read it back. See the class data and operator>>() to read it back. See the class
documentation for details. documentation for details.
\section1 Signals
Unlike other QIODevice implementations, such as QTcpSocket, QFile does not
emit the aboutToClose(), bytesWritten(), or readyRead() signals. This
implementation detail means that QFile is not suitable for reading and
writing certain types of files, such as device files on Unix platforms.
\section1 Platform Specific Issues
\l{Input/Output and Networking}{Qt APIs related to I/O} use UTF-16 based \l{Input/Output and Networking}{Qt APIs related to I/O} use UTF-16 based
QStrings to represent file paths. Standard C++ APIs (\c <cstdio> or QStrings to represent file paths. Standard C++ APIs (\c <cstdio> or
\c <iostream>) or platform-specific APIs however often need a 8-bit encoded \c <iostream>) or platform-specific APIs however often need a 8-bit encoded
@ -167,15 +176,6 @@ QAbstractFileEngine *QFilePrivate::engine() const
\snippet file/file.cpp 3 \snippet file/file.cpp 3
\section1 Signals
Unlike other QIODevice implementations, such as QTcpSocket, QFile does not
emit the aboutToClose(), bytesWritten(), or readyRead() signals. This
implementation detail means that QFile is not suitable for reading and
writing certain types of files, such as device files on Unix platforms.
\section1 Platform Specific Issues
File permissions are handled differently on Unix-like systems and File permissions are handled differently on Unix-like systems and
Windows. In a non \l{QIODevice::isWritable()}{writable} Windows. In a non \l{QIODevice::isWritable()}{writable}
directory on Unix-like systems, files cannot be created. This is not always directory on Unix-like systems, files cannot be created. This is not always