Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
QFileSystemEngine Class Reference

#include <qfilesystemengine_p.h>

+ Collaboration diagram for QFileSystemEngine:

Public Types

using TriStateResult = QAbstractFileEngine::TriStateResult
 

Static Public Member Functions

static bool isCaseSensitive (const QFileSystemEntry &entry, QFileSystemMetaData &data)
 
static QFileSystemEntry getLinkTarget (const QFileSystemEntry &link, QFileSystemMetaData &data)
 
static QFileSystemEntry getRawLinkPath (const QFileSystemEntry &link, QFileSystemMetaData &data)
 
static QFileSystemEntry getJunctionTarget (const QFileSystemEntry &link, QFileSystemMetaData &data)
 
static QFileSystemEntry canonicalName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
 
static QFileSystemEntry absoluteName (const QFileSystemEntry &entry)
 
static QByteArray id (const QFileSystemEntry &entry)
 
static QString resolveUserName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
 
static QString resolveGroupName (const QFileSystemEntry &entry, QFileSystemMetaData &data)
 
static QString bundleName (const QFileSystemEntry &)
 
static bool fillMetaData (const QFileSystemEntry &entry, QFileSystemMetaData &data, QFileSystemMetaData::MetaDataFlags what)
 
static QString homePath ()
 
static QString rootPath ()
 
static QString tempPath ()
 
static bool createDirectory (const QFileSystemEntry &entry, bool createParents, std::optional< QFile::Permissions > permissions=std::nullopt)
 
static bool mkdir (const QFileSystemEntry &entry, std::optional< QFile::Permissions > permissions=std::nullopt)
 
static bool mkpath (const QFileSystemEntry &entry, std::optional< QFile::Permissions > permissions=std::nullopt)
 
static bool removeDirectory (const QFileSystemEntry &entry, bool removeEmptyParents)
 
static bool rmdir (const QFileSystemEntry &entry)
 
static bool rmpath (const QFileSystemEntry &entry)
 
static bool createLink (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
 
static bool copyFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
 
static bool supportsMoveFileToTrash ()
 
static bool moveFileToTrash (const QFileSystemEntry &source, QFileSystemEntry &newLocation, QSystemError &error)
 
static bool renameFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
 
static bool renameOverwriteFile (const QFileSystemEntry &source, const QFileSystemEntry &target, QSystemError &error)
 
static bool removeFile (const QFileSystemEntry &entry, QSystemError &error)
 
static bool setPermissions (const QFileSystemEntry &entry, QFile::Permissions permissions, QSystemError &error)
 
static bool setFileTime (const QFileSystemEntry &entry, const QDateTime &newDate, QFile::FileTime whatTime, QSystemError &error)
 
static bool setCurrentPath (const QFileSystemEntry &entry)
 
static QFileSystemEntry currentPath ()
 
static std::unique_ptr< QAbstractFileEngine > createLegacyEngine (QFileSystemEntry &entry, QFileSystemMetaData &data)
 

Detailed Description

QFileSystemEngine offers OS-independent API for native system library methods, which work with files on physical disk drives; using such methods directly is faster than using a custom file engine (see QAbstractFileEngine and its sub-classes). Typically, you need a custom file engine when working with virtual file systems (for example QResource). Various Qt classes, for example QDir, QFile, and QFileInfo, can handle both types of files by detecting the file path scheme, for example, file:///, :/someresource (QResource).

See also
QAbstractFileEngine, QAbstractFileEngineHandler, QFSFileEngine, QResourceFileEngine

Definition at line 60 of file qfilesystemengine_p.h.

Member Typedef Documentation

◆ TriStateResult

using QFileSystemEngine::TriStateResult = QAbstractFileEngine::TriStateResult

Definition at line 63 of file qfilesystemengine_p.h.

Member Function Documentation

◆ absoluteName()

QFileSystemEntry QFileSystemEngine::absoluteName ( const QFileSystemEntry & entry)
static

Definition at line 732 of file qfilesystemengine_unix.cpp.

◆ bundleName()

static QString QFileSystemEngine::bundleName ( const QFileSystemEntry & )
inlinestatic

Definition at line 85 of file qfilesystemengine_p.h.

◆ canonicalName()

QFileSystemEntry QFileSystemEngine::canonicalName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 692 of file qfilesystemengine_unix.cpp.

◆ copyFile()

bool QFileSystemEngine::copyFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1658 of file qfilesystemengine_unix.cpp.

◆ createDirectory()

static bool QFileSystemEngine::createDirectory ( const QFileSystemEntry & entry,
bool createParents,
std::optional< QFile::Permissions > permissions = std::nullopt )
inlinestatic

Definition at line 119 of file qfilesystemengine_p.h.

◆ createLegacyEngine()

std::unique_ptr< QAbstractFileEngine > QFileSystemEngine::createLegacyEngine ( QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Resolves the entry (see QDir::searchPaths) and returns an engine for it, but never a QFSFileEngine.

Returns a file engine that can be used to access the entry. Returns 0 if QFileSystemEngine API should be used to query and interact with the file system object.

Definition at line 178 of file qfilesystemengine.cpp.

◆ createLink()

bool QFileSystemEngine::createLink ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1272 of file qfilesystemengine_unix.cpp.

◆ currentPath()

QFileSystemEntry QFileSystemEngine::currentPath ( )
static

Definition at line 1856 of file qfilesystemengine_unix.cpp.

◆ fillMetaData()

bool QFileSystemEngine::fillMetaData ( const QFileSystemEntry & entry,
QFileSystemMetaData & data,
QFileSystemMetaData::MetaDataFlags what )
static

Definition at line 376 of file qfilesystemengine_unix.cpp.

◆ getJunctionTarget()

QFileSystemEntry QFileSystemEngine::getJunctionTarget ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 223 of file qfilesystemengine.cpp.

◆ getLinkTarget()

QFileSystemEntry QFileSystemEngine::getLinkTarget ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 623 of file qfilesystemengine_unix.cpp.

◆ getRawLinkPath()

QFileSystemEntry QFileSystemEngine::getRawLinkPath ( const QFileSystemEntry & link,
QFileSystemMetaData & data )
static

Definition at line 682 of file qfilesystemengine_unix.cpp.

◆ homePath()

QString QFileSystemEngine::homePath ( )
static

Definition at line 1816 of file qfilesystemengine_unix.cpp.

◆ id()

QByteArray QFileSystemEngine::id ( const QFileSystemEntry & entry)
static

Definition at line 767 of file qfilesystemengine_unix.cpp.

◆ isCaseSensitive()

bool QFileSystemEngine::isCaseSensitive ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 1885 of file qfilesystemengine_unix.cpp.

◆ mkdir()

bool QFileSystemEngine::mkdir ( const QFileSystemEntry & entry,
std::optional< QFile::Permissions > permissions = std::nullopt )
static

Definition at line 1229 of file qfilesystemengine_unix.cpp.

◆ mkpath()

bool QFileSystemEngine::mkpath ( const QFileSystemEntry & entry,
std::optional< QFile::Permissions > permissions = std::nullopt )
static

Definition at line 1219 of file qfilesystemengine_unix.cpp.

◆ moveFileToTrash()

bool QFileSystemEngine::moveFileToTrash ( const QFileSystemEntry & source,
QFileSystemEntry & newLocation,
QSystemError & error )
static

Definition at line 34 of file qfilesystemengine_mac.mm.

◆ removeDirectory()

static bool QFileSystemEngine::removeDirectory ( const QFileSystemEntry & entry,
bool removeEmptyParents )
inlinestatic

Definition at line 132 of file qfilesystemengine_p.h.

◆ removeFile()

bool QFileSystemEngine::removeFile ( const QFileSystemEntry & entry,
QSystemError & error )
static

Definition at line 1751 of file qfilesystemengine_unix.cpp.

◆ renameFile()

bool QFileSystemEngine::renameFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1667 of file qfilesystemengine_unix.cpp.

◆ renameOverwriteFile()

bool QFileSystemEngine::renameOverwriteFile ( const QFileSystemEntry & source,
const QFileSystemEntry & target,
QSystemError & error )
static

Definition at line 1739 of file qfilesystemengine_unix.cpp.

◆ resolveGroupName()

QString QFileSystemEngine::resolveGroupName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 208 of file qfilesystemengine.cpp.

◆ resolveUserName()

QString QFileSystemEngine::resolveUserName ( const QFileSystemEntry & entry,
QFileSystemMetaData & data )
static

Definition at line 193 of file qfilesystemengine.cpp.

◆ rmdir()

bool QFileSystemEngine::rmdir ( const QFileSystemEntry & entry)
static

Definition at line 1244 of file qfilesystemengine_unix.cpp.

◆ rmpath()

bool QFileSystemEngine::rmpath ( const QFileSystemEntry & entry)
static

Definition at line 1251 of file qfilesystemengine_unix.cpp.

◆ rootPath()

QString QFileSystemEngine::rootPath ( )
static

Definition at line 1824 of file qfilesystemengine_unix.cpp.

◆ setCurrentPath()

bool QFileSystemEngine::setCurrentPath ( const QFileSystemEntry & entry)
static

Definition at line 1849 of file qfilesystemengine_unix.cpp.

◆ setFileTime()

bool QFileSystemEngine::setFileTime ( const QFileSystemEntry & entry,
const QDateTime & newDate,
QFile::FileTime whatTime,
QSystemError & error )
static

Definition at line 1785 of file qfilesystemengine_unix.cpp.

◆ setPermissions()

bool QFileSystemEngine::setPermissions ( const QFileSystemEntry & entry,
QFile::Permissions permissions,
QSystemError & error )
static

Definition at line 1762 of file qfilesystemengine_unix.cpp.

◆ supportsMoveFileToTrash()

bool QFileSystemEngine::supportsMoveFileToTrash ( )
static

Definition at line 24 of file qfilesystemengine_mac.mm.

◆ tempPath()

QString QFileSystemEngine::tempPath ( )
static

Definition at line 1829 of file qfilesystemengine_unix.cpp.

The documentation for this class was generated from the following files: