![]() |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qnetworkfile_p.h>
Public Slots | |
void | open () |
void | close () override |
![]() | |
void | deleteLater () |
\threadsafe | |
Signals | |
void | finished (bool ok) |
void | headerRead (QHttpHeaders::WellKnownHeader, const QByteArray &value) |
void | networkError (QNetworkReply::NetworkError error, const QString &message) |
![]() | |
void | readyRead () |
This signal is emitted once every time new data is available for reading from the device's current read channel. | |
void | channelReadyRead (int channel) |
void | bytesWritten (qint64 bytes) |
This signal is emitted every time a payload of data has been written to the device's current write channel. | |
void | channelBytesWritten (int channel, qint64 bytes) |
void | aboutToClose () |
This signal is emitted when the device is about to close. | |
void | readChannelFinished () |
![]() | |
void | destroyed (QObject *=nullptr) |
This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
This signal is emitted after the object's name has been changed. | |
Public Member Functions | |
QNetworkFile () | |
QNetworkFile (const QString &name) | |
QFILE_MAYBE_NODISCARD bool | open (OpenMode flags) override |
Opens the file using mode flags, returning true if successful; otherwise returns false . | |
QFILE_MAYBE_NODISCARD bool | open (OpenMode flags, Permissions permissions) |
QFILE_MAYBE_NODISCARD bool | open (FILE *f, OpenMode ioFlags, FileHandleFlags handleFlags=DontCloseHandle) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file handle fh in the given mode. | |
QFILE_MAYBE_NODISCARD bool | open (int fd, OpenMode ioFlags, FileHandleFlags handleFlags=DontCloseHandle) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file descriptor fd in the given mode. | |
![]() | |
QFile () | |
Constructs a QFile object. | |
QFILE_MAYBE_EXPLICIT | QFile (const QString &name) |
QFile (QObject *parent) | |
Constructs a new file object with the given parent. | |
QFile (const QString &name, QObject *parent) | |
Constructs a new file object with the given parent to represent the file with the specified name. | |
~QFile () | |
Destroys the file object, closing it if necessary. | |
QString | fileName () const override |
Returns the name of the file as set by setFileName(), rename(), or by the QFile constructors. | |
void | setFileName (const QString &name) |
Sets the name of the file. | |
bool | exists () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns true if the file specified by fileName() exists; otherwise returns false . | |
QString | symLinkTarget () const |
bool | remove () |
Removes the file specified by fileName(). | |
bool | moveToTrash () |
bool | rename (const QString &newName) |
Renames the file currently specified by fileName() to newName. | |
bool | link (const QString &newName) |
Creates a link named linkName that points to the file currently specified by fileName(). | |
QFILE_MAYBE_NODISCARD bool | open (OpenMode flags) override |
Opens the file using mode flags, returning true if successful; otherwise returns false . | |
QFILE_MAYBE_NODISCARD bool | open (OpenMode flags, Permissions permissions) |
QFILE_MAYBE_NODISCARD bool | open (FILE *f, OpenMode ioFlags, FileHandleFlags handleFlags=DontCloseHandle) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file handle fh in the given mode. | |
QFILE_MAYBE_NODISCARD bool | open (int fd, OpenMode ioFlags, FileHandleFlags handleFlags=DontCloseHandle) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file descriptor fd in the given mode. | |
qint64 | size () const override |
\reimp | |
bool | resize (qint64 sz) override |
\reimp | |
Permissions | permissions () const override |
\reimp | |
bool | setPermissions (Permissions permissionSpec) override |
Sets the permissions for the file to the permissions specified. | |
![]() | |
~QFileDevice () | |
Destroys the file device, closing it if necessary. | |
FileError | error () const |
Returns the file error status. | |
void | unsetError () |
Sets the file's error to QFileDevice::NoError. | |
void | close () override |
Calls QFileDevice::flush() and closes the file. | |
bool | isSequential () const override |
Returns true if the file can only be manipulated sequentially; otherwise returns false . | |
int | handle () const |
Returns the file handle of the file. | |
qint64 | pos () const override |
\reimp | |
bool | seek (qint64 offset) override |
For random-access devices, this function sets the current position to pos, returning true on success, or false if an error occurred. | |
bool | atEnd () const override |
Returns true if the end of the file has been reached; otherwise returns false. | |
bool | flush () |
Flushes any buffered data to the file. | |
qint64 | size () const override |
Returns the size of the file. | |
uchar * | map (qint64 offset, qint64 size, MemoryMapFlags flags=NoOptions) |
Maps size bytes of the file into memory starting at offset. | |
bool | unmap (uchar *address) |
Unmaps the memory address. | |
QDateTime | fileTime (QFileDevice::FileTime time) const |
bool | setFileTime (const QDateTime &newDate, QFileDevice::FileTime fileTime) |
![]() | |
QIODevice () | |
Constructs a QIODevice object. | |
QIODevice (QObject *parent) | |
Constructs a QIODevice object with the given parent. | |
virtual | ~QIODevice () |
The destructor is virtual, and QIODevice is an abstract base class. | |
QIODeviceBase::OpenMode | openMode () const |
Returns the mode in which the device has been opened; i.e. | |
void | setTextModeEnabled (bool enabled) |
If enabled is true, this function sets the \l Text flag on the device; otherwise the \l Text flag is removed. | |
bool | isTextModeEnabled () const |
Returns true if the \l Text flag is enabled; otherwise returns false . | |
bool | isOpen () const |
Returns true if the device is open; otherwise returns false . | |
bool | isReadable () const |
Returns true if data can be read from the device; otherwise returns false. | |
bool | isWritable () const |
Returns true if data can be written to the device; otherwise returns false. | |
int | readChannelCount () const |
int | writeChannelCount () const |
int | currentReadChannel () const |
void | setCurrentReadChannel (int channel) |
int | currentWriteChannel () const |
void | setCurrentWriteChannel (int channel) |
virtual bool | open (QIODeviceBase::OpenMode mode) |
Opens the device and sets its OpenMode to mode. | |
virtual bool | reset () |
Seeks to the start of input for random-access devices. | |
virtual qint64 | bytesAvailable () const |
Returns the number of bytes that are available for reading. | |
virtual qint64 | bytesToWrite () const |
For buffered devices, this function returns the number of bytes waiting to be written. | |
qint64 | read (char *data, qint64 maxlen) |
Reads at most maxSize bytes from the device into data, and returns the number of bytes read. | |
QByteArray | read (qint64 maxlen) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Reads at most maxSize bytes from the device, and returns the data read as a QByteArray. | |
QByteArray | readAll () |
Reads all remaining data from the device, and returns it as a byte array. | |
qint64 | readLine (char *data, qint64 maxlen) |
This function reads a line of ASCII characters from the device, up to a maximum of maxSize - 1 bytes, stores the characters in data, and returns the number of bytes read. | |
QByteArray | readLine (qint64 maxlen=0) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Reads a line from the device, but no more than maxSize characters, and returns the result as a byte array. | |
bool | readLineInto (QByteArray *result, qint64 maxlen=0) |
QByteArrayView | readLineInto (QSpan< char > buffer) |
QByteArrayView | readLineInto (QSpan< uchar > buffer) |
QByteArrayView | readLineInto (QSpan< std::byte > buffer) |
Reads a line from this device into buffer, and returns the subset of buffer that contains the data read. | |
virtual bool | canReadLine () const |
Returns true if a complete line of data can be read from the device; otherwise returns false . | |
void | startTransaction () |
void | commitTransaction () |
void | rollbackTransaction () |
bool | isTransactionStarted () const |
qint64 | write (const char *data, qint64 len) |
Writes at most maxSize bytes of data from data to the device. | |
qint64 | write (const char *data) |
qint64 | write (const QByteArray &data) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Writes the content of data to the device. | |
qint64 | peek (char *data, qint64 maxlen) |
QByteArray | peek (qint64 maxlen) |
qint64 | skip (qint64 maxSize) |
virtual bool | waitForReadyRead (int msecs) |
Blocks until new data is available for reading and the readyRead() signal has been emitted, or until msecs milliseconds have passed. | |
virtual bool | waitForBytesWritten (int msecs) |
For buffered devices, this function waits until a payload of buffered written data has been written to the device and the bytesWritten() signal has been emitted, or until msecs milliseconds have passed. | |
void | ungetChar (char c) |
Puts the character c back into the device, and decrements the current position unless the position is 0. | |
bool | putChar (char c) |
Writes the character c to the device. | |
bool | getChar (char *c) |
Reads one character from the device and stores it in c. | |
QString | errorString () const |
Returns a human-readable description of the last device error that occurred. | |
![]() | |
Q_INVOKABLE | QObject (QObject *parent=nullptr) |
Constructs an object with parent object parent. | |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. | |
virtual bool | event (QEvent *event) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
Filters events if this object has been installed as an event filter for the watched object. | |
QString | objectName () const |
Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
Sets the object's name to name. | |
void | setObjectName (QAnyStringView name) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBindable< QString > | bindableObjectName () |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false . | |
bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false . | |
bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false . | |
bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false . | |
bool | blockSignals (bool b) noexcept |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
QThread * | thread () const |
Returns the thread in which the object lives. | |
bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
void | killTimer (Qt::TimerId id) |
template<typename T> | |
T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
template<typename T> | |
QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
template<typename T> | |
T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T> | |
QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const QObjectList & | children () const |
Returns a list of child objects. | |
void | setParent (QObject *parent) |
Makes the object a child of parent. | |
void | installEventFilter (QObject *filterObj) |
Installs an event filter filterObj on this object. | |
void | removeEventFilter (QObject *obj) |
Removes an event filter object obj from this object. | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
void | dumpObjectTree () const |
Dumps a tree of children to the debug output. | |
void | dumpObjectInfo () const |
Dumps information about signal connections, etc. | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. | |
bool | setProperty (const char *name, QVariant &&value) |
QVariant | property (const char *name) const |
Returns the value of the object's name property. | |
QList< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () const |
Returns a pointer to the parent object. | |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false . | |
Additional Inherited Members | |
![]() | |
enum | FileError { NoError = 0 , ReadError = 1 , WriteError = 2 , FatalError = 3 , ResourceError = 4 , OpenError = 5 , AbortError = 6 , TimeOutError = 7 , UnspecifiedError = 8 , RemoveError = 9 , RenameError = 10 , PositionError = 11 , ResizeError = 12 , PermissionsError = 13 , CopyError = 14 } |
This enum describes the errors that may be returned by the error() function. More... | |
enum | FileTime { FileAccessTime , FileBirthTime , FileMetadataChangeTime , FileModificationTime } |
enum | Permission { ReadOwner = 0x4000 , WriteOwner = 0x2000 , ExeOwner = 0x1000 , ReadUser = 0x0400 , WriteUser = 0x0200 , ExeUser = 0x0100 , ReadGroup = 0x0040 , WriteGroup = 0x0020 , ExeGroup = 0x0010 , ReadOther = 0x0004 , WriteOther = 0x0002 , ExeOther = 0x0001 } |
This enum is used by the permission() function to report the permissions and ownership of a file. More... | |
enum | FileHandleFlag { AutoCloseHandle = 0x0001 , DontCloseHandle = 0 } |
This enum is used when opening a file to specify additional options which only apply to files and not to a generic QIODevice. More... | |
enum | MemoryMapFlag { NoOptions = 0 , MapPrivateOption = 0x0001 } |
![]() | |
enum | OpenModeFlag { NotOpen = 0x0000 , ReadOnly = 0x0001 , WriteOnly = 0x0002 , ReadWrite = ReadOnly | WriteOnly , Append = 0x0004 , Truncate = 0x0008 , Text = 0x0010 , Unbuffered = 0x0020 , NewOnly = 0x0040 , ExistingOnly = 0x0080 } |
This enum is used with QIODevice::open() to describe the mode in which a device is opened. More... | |
![]() | |
static QByteArray | encodeName (const QString &fileName) |
Converts fileName to an 8-bit encoding that you can use in native APIs. | |
static QString | decodeName (const QByteArray &localFileName) |
This does the reverse of QFile::encodeName() using localFileName. | |
static QString | decodeName (const char *localFileName) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the Unicode version of the given localFileName. | |
static bool | exists (const QString &fileName) |
Returns true if the file specified by fileName exists; otherwise returns false . | |
static QString | symLinkTarget (const QString &fileName) |
static bool | remove (const QString &fileName) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Removes the file specified by the fileName given. | |
static bool | supportsMoveToTrash () Q_DECL_PURE_FUNCTION |
static bool | moveToTrash (const QString &fileName, QString *pathInTrash=nullptr) |
static bool | rename (const QString &oldName, const QString &newName) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renames the file oldName to newName. | |
static bool | link (const QString &fileName, const QString &newName) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Creates a link named linkName that points to the file fileName. | |
static bool | resize (const QString &filename, qint64 sz) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets fileName to size (in bytes) sz. | |
static Permissions | permissions (const QString &filename) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the complete OR-ed together combination of QFile::Permission for fileName. | |
static bool | setPermissions (const QString &filename, Permissions permissionSpec) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the permissions for fileName file to permissions. | |
![]() | |
static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
\threadsafe | |
static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1, typename Func2> | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1, typename Func2> | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
\threadsafe | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static bool | disconnect (const QMetaObject::Connection &) |
Disconnect a connection. | |
template<typename Func1, typename Func2> | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
template<typename Func1> | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
![]() | |
QFile (QFilePrivate &dd, QObject *parent=nullptr) | |
![]() | |
QFileDevice () | |
\macro QT_USE_NODISCARD_FILE_OPEN \macro QT_NO_USE_NODISCARD_FILE_OPEN | |
QFileDevice (QObject *parent) | |
QFileDevice (QFileDevicePrivate &dd, QObject *parent=nullptr) | |
qint64 | readData (char *data, qint64 maxlen) override |
\reimp | |
qint64 | writeData (const char *data, qint64 len) override |
\reimp | |
qint64 | readLineData (char *data, qint64 maxlen) override |
\reimp | |
![]() | |
QIODevice (QIODevicePrivate &dd, QObject *parent=nullptr) | |
virtual qint64 | skipData (qint64 maxSize) |
void | setOpenMode (QIODeviceBase::OpenMode openMode) |
Sets the OpenMode of the device to openMode. | |
void | setErrorString (const QString &errorString) |
Sets the human readable description of the last device error that occurred to str. | |
![]() | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. | |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
virtual void | childEvent (QChildEvent *event) |
This event handler can be reimplemented in a subclass to receive child events. | |
virtual void | customEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive custom events. | |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
![]() | |
~QIODeviceBase ()=default | |
![]() | |
QScopedPointer< QObjectData > | d_ptr |
![]() | |
QString | objectName |
the name of this object | |
![]() | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) | |
Definition at line 24 of file qnetworkfile_p.h.
QT_BEGIN_NAMESPACE QNetworkFile::QNetworkFile | ( | ) |
Definition at line 16 of file qnetworkfile.cpp.
QNetworkFile::QNetworkFile | ( | const QString & | name | ) |
Definition at line 21 of file qnetworkfile.cpp.
|
overrideslot |
Definition at line 52 of file qnetworkfile.cpp.
|
signal |
|
signal |
|
signal |
|
slot |
Definition at line 26 of file qnetworkfile.cpp.
bool QFile::open | ( | FILE * | fh, |
OpenMode | mode, | ||
FileHandleFlags | handleFlags = DontCloseHandle ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file handle fh in the given mode.
handleFlags may be used to specify additional options. Returns true
if successful; otherwise returns false
.
Example:
When a QFile is opened using this function, behaviour of close() is controlled by the AutoCloseHandle flag. If AutoCloseHandle is specified, and this function succeeds, then calling close() closes the adopted handle. Otherwise, close() does not actually close the file, but only flushes it.
{Warning:} \list 1
stdin
, stdout
, or stderr
, you may not be able to seek(). size() returns 0
in those cases. See QIODevice::isSequential() for more information. {Note for the Windows Platform}
fh must be opened in binary mode (i.e., the mode string must contain 'b', as in "rb" or "wb") when accessing files and other random-access devices. Qt will translate the end-of-line characters if you pass QIODevice::Text to mode. Sequential devices, such as stdin and stdout, are unaffected by this limitation.
You need to enable support for console applications in order to use the stdin, stdout and stderr streams at the console. To do this, add the following declaration to your application's project file:
bool QFile::open | ( | int | fd, |
OpenMode | mode, | ||
FileHandleFlags | handleFlags = DontCloseHandle ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Opens the existing file descriptor fd in the given mode.
handleFlags may be used to specify additional options. Returns true
if successful; otherwise returns false
.
When a QFile is opened using this function, behaviour of close() is controlled by the AutoCloseHandle flag. If AutoCloseHandle is specified, and this function succeeds, then calling close() closes the adopted handle. Otherwise, close() does not actually close the file, but only flushes it.
stdin
), 1 (stdout
), or 2 (stderr
), you may not be able to seek(). In those cases, size() returns 0
. See QIODevice::isSequential() for more information.
|
override |
Opens the file using mode flags, returning true
if successful; otherwise returns false
.
The flags for mode must include \l QIODeviceBase::ReadOnly, \l WriteOnly, or \l ReadWrite. It may also have additional flags, such as \l Text and \l Unbuffered.
QFILE_MAYBE_NODISCARD bool QFile::open | ( | OpenMode | flags, |
Permissions | permissions ) |