QFile Class

Documentation des fonctions membres

QFile::QFile()

Construit un objet QFile.

[explicit] QFile::QFile(QObject *parent)

Construit un nouvel objet fichier avec l'adresse parent.

[explicit] QFile::QFile(const QString &name)

Construit un nouvel objet file pour représenter le fichier avec l'adresse name.

[explicit, since 6.0] QFile::QFile(const std::filesystem::path &name)

Construit un nouvel objet file pour représenter le fichier avec l'adresse name.

Cette fonction a été introduite dans Qt 6.0.

QFile::QFile(const QString &name, QObject *parent)

Construit un nouvel objet fichier avec l'adresse parent donnée pour représenter le fichier avec l'adresse name spécifiée.

[since 6.0] QFile::QFile(const std::filesystem::path &name, QObject *parent)

Construit un nouvel objet fichier avec l'adresse parent donnée pour représenter le fichier avec l'adresse name spécifiée.

Cette fonction a été introduite dans Qt 6.0.

[virtual noexcept] QFile::~QFile()

Détruit l'objet fichier, en le fermant si nécessaire.

bool QFile::copy(const QString &newName)

Copie le fichier nommé fileName() vers newName.

Ce fichier est fermé avant d'être copié.

Si le fichier copié est un lien symbolique (symlink), c'est le fichier auquel il fait référence qui est copié, et non le lien lui-même. À l'exception des autorisations, qui sont copiées, aucune autre métadonnée de fichier n'est copiée.

Renvoie true en cas de succès, sinon false.

Notez que si un fichier portant le nom newName existe déjà, copy() renvoie false. Cela signifie que QFile ne l'écrasera pas.

Voir également setFileName().

[since 6.0] bool QFile::copy(const std::filesystem::path &newName)

Cette fonction a été introduite dans Qt 6.0.

[static] bool QFile::copy(const QString &fileName, const QString &newName)

Copie le fichier nommé fileName dans newName.

Si le fichier copié est un lien symbolique (symlink), c'est le fichier auquel il fait référence qui est copié, et non le lien lui-même. À l'exception des autorisations, qui sont copiées, aucune autre métadonnée de fichier n'est copiée.

Renvoie true en cas de succès, sinon false.

Notez que si un fichier portant le nom newName existe déjà, copy() renvoie false. Cela signifie que QFile ne l'écrasera pas.

Voir aussi rename().

[static] QString QFile::decodeName(const QByteArray &localFileName)

Il s'agit de l'inverse de QFile::encodeName() qui utilise localFileName.

Voir également encodeName().

[static] QString QFile::decodeName(const char *localFileName)

Renvoie la version Unicode de l'adresse localFileName donnée. Voir encodeName() pour plus de détails.

[static] QByteArray QFile::encodeName(const QString &fileName)

Convertit fileName en un encodage 8 bits que vous pouvez utiliser dans les API natives. Sous Windows, l'encodage est celui de la page de code Windows active (ANSI). Sur les autres plateformes, il s'agit d'UTF-8, pour macOS sous forme décomposée (NFD).

Voir aussi decodeName().

[static] bool QFile::exists(const QString &fileName)

Renvoie true si le fichier spécifié par fileName existe ; sinon, renvoie false.

bool QFile::exists() const

Renvoie true si le fichier spécifié par fileName() existe ; sinon, renvoie false.

Voir aussi fileName() et setFileName().

[override virtual] QString QFile::fileName() const

Réimplémente : QFileDevice::fileName() const.

Renvoie le nom du fichier tel qu'il a été défini par setFileName(), rename() ou par les constructeurs de QFile.

Voir aussi setFileName(), rename() et QFileInfo::fileName().

[since 6.0] std::filesystem::path QFile::filesystemFileName() const

Renvoie fileName() sous la forme std::filesystem::path.

Cette fonction a été introduite dans Qt 6.0.

[since 6.3] std::filesystem::path QFile::filesystemSymLinkTarget() const

Retourne symLinkTarget() comme std::filesystem::path.

Cette fonction a été introduite dans Qt 6.3.

[static, since 6.3] std::filesystem::path QFile::filesystemSymLinkTarget(const std::filesystem::path &fileName)

Renvoie symLinkTarget() en tant que std::filesystem::path de fileName.

Cette fonction a été introduite dans Qt 6.3.

bool QFile::link(const QString &linkName)

Crée un lien nommé linkName qui pointe vers le fichier actuellement spécifié par fileName(). La nature d'un lien dépend du système de fichiers sous-jacent (qu'il s'agisse d'un raccourci sous Windows ou d'un lien symbolique sous Unix). Renvoie true en cas de succès, sinon false.

Cette fonction n'écrase pas une entité déjà existante dans le système de fichiers ; dans ce cas, link() renverra false et error() renverra RenameError.

Voir également setFileName().

[since 6.0] bool QFile::link(const std::filesystem::path &newName)

Cette fonction a été introduite dans Qt 6.0.

[static] bool QFile::link(const QString &fileName, const QString &linkName)

Crée un lien nommé linkName qui pointe vers le fichier fileName. La nature d'un lien dépend du système de fichiers sous-jacent (qu'il s'agisse d'un raccourci sous Windows ou d'un lien symbolique sous Unix). Renvoie true en cas de succès, sinon false.

Voir aussi link().

bool QFile::moveToTrash()

Déplace le fichier spécifié par fileName() vers la corbeille. Elle renvoie true en cas de succès et définit fileName() comme chemin d'accès au fichier dans la corbeille ; sinon, elle renvoie false.

Le temps d'exécution de cette fonction est indépendant de la taille du fichier à mettre à la corbeille. Si cette fonction est appelée dans un répertoire, elle peut être proportionnelle au nombre de fichiers mis à la corbeille. Si le fichier actuel fileName() pointe vers un lien symbolique, cette fonction déplacera le lien vers la corbeille, en le brisant éventuellement, et non la cible du lien.

Cette fonction utilise les API Windows et macOS pour effectuer la mise à la corbeille sur ces deux systèmes d'exploitation. Ailleurs (systèmes Unix), cette fonction implémente la spécification FreeDesktop.org Trash version 1.0.

Voir aussi supportsMoveToTrash(), remove() et QDir::remove().

[static] bool QFile::moveToTrash(const QString &fileName, QString *pathInTrash = nullptr)

Déplace le fichier spécifié par fileName dans la corbeille. Renvoie true en cas de succès, et attribue à pathInTrash (s'il est fourni) le chemin d'accès au fichier dans la corbeille ; sinon, renvoie false.

Le temps d'exécution de cette fonction est indépendant de la taille du fichier à mettre à la corbeille. Si cette fonction est appelée dans un répertoire, elle peut être proportionnelle au nombre de fichiers mis à la corbeille. Si le fichier actuel fileName() pointe vers un lien symbolique, cette fonction déplacera le lien vers la corbeille, en le brisant éventuellement, et non la cible du lien.

Cette fonction utilise les API Windows et macOS pour effectuer la mise à la corbeille sur ces deux systèmes d'exploitation. Ailleurs (systèmes Unix), cette fonction implémente la spécification FreeDesktop.org Trash version 1.0.

[override virtual] bool QFile::open(QIODeviceBase::OpenMode mode)

Réimplémente : QIODevice::open(QIODeviceBase::OpenMode mode).

Ouvre le fichier en utilisant les drapeaux mode et renvoie true en cas de succès ; sinon, renvoie false.

Les drapeaux de mode doivent inclure QIODeviceBase::ReadOnly, WriteOnly, ou ReadWrite. Il peut également y avoir des drapeaux supplémentaires, tels que Text et Unbuffered.

Voir aussi QT_USE_NODISCARD_FILE_OPEN et setFileName().

[since 6.3] bool QFile::open(QIODeviceBase::OpenMode mode, QFileDevice::Permissions permissions)

Si le fichier n'existe pas et que mode implique de le créer, il est créé avec la valeur spécifiée permissions.

Sur les systèmes POSIX, les autorisations réelles sont influencées par la valeur de umask.

Sous Windows, les autorisations sont émulées à l'aide d'ACL. Ces listes peuvent être dans un ordre non canonique lorsqu'un groupe se voit accorder moins d'autorisations que d'autres. Les fichiers et les répertoires présentant de telles autorisations génèrent des avertissements lorsque l'onglet Sécurité de la boîte de dialogue Propriétés est ouvert. Le fait d'accorder au groupe toutes les autorisations accordées aux autres permet d'éviter ces avertissements.

Cette fonction a été introduite dans Qt 6.3.

Voir aussi QIODevice::OpenMode, setFileName(), et QT_USE_NODISCARD_FILE_OPEN.

bool QFile::open(FILE *fh, QIODeviceBase::OpenMode mode, QFileDevice::FileHandleFlags handleFlags = DontCloseHandle)

Ouvre le fichier existant fh dans le répertoire mode. handleFlags peut être utilisé pour spécifier des options supplémentaires. Renvoie true en cas de succès, sinon false.

Exemple :

#include <stdio.h>

void printError(const char* msg)
{
    QFile file;
    file.open(stderr, QIODevice::WriteOnly);
    file.write(msg, qstrlen(msg));        // write to stderr
    file.close();
}

Lorsqu'un QFile est ouvert à l'aide de cette fonction, le comportement de close() est contrôlé par l'indicateur AutoCloseHandle. Si AutoCloseHandle est spécifié et que cette fonction réussit, l'appel à close() ferme la poignée adoptée. Dans le cas contraire, close() ne ferme pas le fichier, mais le vide.

Attention :

1. Si fh ne fait pas référence à un fichier normal, par exemple s'il s'agit de stdin, stdout ou stderr, il se peut que vous ne puissiez pas utiliser seek(). size() renvoie 0 dans ces cas. Voir QIODevice::isSequential() pour plus d'informations.
2. Comme cette fonction ouvre le fichier sans en spécifier le nom, vous ne pouvez pas utiliser cette QFile avec une QFileInfo.

Note pour la plate-forme Windows

fh doit être ouvert en mode binaire (c'est-à-dire que la chaîne de mode doit contenir "b", comme dans "rb" ou "wb") lors de l'accès à des fichiers et à d'autres périphériques à accès aléatoire. Qt traduira les caractères de fin de ligne si vous passez QIODevice::Text à mode. Les périphériques séquentiels, tels que stdin et stdout, ne sont pas concernés par cette limitation.

Vous devez activer la prise en charge des applications de console afin d'utiliser les flux stdin, stdout et stderr sur la console. Pour ce faire, ajoutez la déclaration suivante au fichier de projet de votre application :

CONFIG += console

Voir aussi close() et QT_USE_NODISCARD_FILE_OPEN.

bool QFile::open(int fd, QIODeviceBase::OpenMode mode, QFileDevice::FileHandleFlags handleFlags = DontCloseHandle)

Ouvre le descripteur de fichier existant fd dans le répertoire mode. handleFlags peut être utilisé pour spécifier des options supplémentaires. Renvoie true en cas de succès, sinon false.

Lorsqu'un QFile est ouvert à l'aide de cette fonction, le comportement de close() est contrôlé par l'indicateur AutoCloseHandle. Si AutoCloseHandle est spécifié et que cette fonction réussit, l'appel à close() ferme la poignée adoptée. Dans le cas contraire, close() ne ferme pas le fichier, mais le vide.

Voir aussi close() et QT_USE_NODISCARD_FILE_OPEN.

[override virtual] QFileDevice::Permissions QFile::permissions() const

Réimplémente : QFileDevice::permissions() const.

Voir également setPermissions().

[static] QFileDevice::Permissions QFile::permissions(const QString &fileName)

Renvoie la combinaison complète OR-ed together de QFile::Permission pour fileName.

[static, since 6.0] QFileDevice::Permissions QFile::permissions(const std::filesystem::path &filename)

Cette fonction a été introduite dans Qt 6.0.

bool QFile::remove()

Supprime le fichier spécifié par fileName().

Renvoie true si le fichier a été supprimé avec succès ; sinon, renvoie false.

Le fichier est fermé avant d'être supprimé, s'il était ouvert.

Voir aussi setFileName().

[static] bool QFile::remove(const QString &fileName)

Supprime le fichier spécifié par l'adresse fileName.

Renvoie true si le fichier a été supprimé avec succès ; sinon, renvoie false.

Voir aussi remove().

bool QFile::rename(const QString &newName)

Renomme le fichier actuellement spécifié par fileName() en newName. Renvoie true en cas de succès, sinon false.

Si un fichier portant le nom newName existe déjà, rename() renvoie false (c'est-à-dire que QFile ne l'écrasera pas).

Le fichier est fermé avant d'être renommé.

Si l'opération de renommage échoue, Qt XML tentera de copier le contenu de ce fichier sur newName, puis de supprimer ce fichier, en ne conservant que newName. Si cette opération de copie échoue ou si ce fichier ne peut pas être supprimé, le fichier de destination newName est supprimé pour restaurer l'ancien état.

Voir aussi setFileName().

[since 6.0] bool QFile::rename(const std::filesystem::path &newName)

Cette fonction a été introduite dans Qt 6.0.

[static] bool QFile::rename(const QString &oldName, const QString &newName)

Renomme le fichier oldName en newName. Renvoie true en cas de succès, sinon false.

Si un fichier portant le nom newName existe déjà, rename() renvoie false (c'est-à-dire que QFile ne l'écrasera pas).

Voir aussi rename().

[override virtual] bool QFile::resize(qint64 sz)

Réimplémente : QFileDevice::resize(qint64 sz).

[static] bool QFile::resize(const QString &fileName, qint64 sz)

Définit fileName à la taille (en octets) de sz. Retourne true si le redimensionnement réussit, false dans le cas contraire. Si sz est plus grand que fileName, les nouveaux octets seront mis à 0, si sz est plus petit, le fichier est simplement tronqué.

Voir aussi resize().

void QFile::setFileName(const QString &name)

Définit l'adresse name du fichier. Le nom peut ne pas avoir de chemin d'accès, avoir un chemin d'accès relatif ou un chemin d'accès absolu.

N'appelez pas cette fonction si le fichier a déjà été ouvert.

Si le nom du fichier n'a pas de chemin d'accès ou un chemin d'accès relatif, le chemin d'accès utilisé sera le chemin d'accès au répertoire courant de l'application au moment de l'appel à open( ).

Exemple :

QFile file;
QDir::setCurrent("/tmp");
file.setFileName("readme.txt");
QDir::setCurrent("/home");
file.open(QIODevice::ReadOnly);      // opens "/home/readme.txt" under Unix

Notez que le séparateur de répertoire "/" fonctionne pour tous les systèmes d'exploitation pris en charge par Qt.

Voir aussi fileName(), QFileInfo, et QDir.

[since 6.0] void QFile::setFileName(const std::filesystem::path &name)

Cette fonction a été introduite dans Qt 6.0.

[override virtual] bool QFile::setPermissions(QFileDevice::Permissions permissions)

Réimplémente : QFileDevice::setPermissions(QFileDevice::Permissions permissions).

Définit les permissions pour le fichier à l'adresse permissions spécifiée. Retourne true en cas de succès, ou false si les permissions ne peuvent pas être modifiées.

Voir aussi permissions() et setFileName().

[static] bool QFile::setPermissions(const QString &fileName, QFileDevice::Permissions permissions)

Définit les permissions pour le fichier fileName à permissions.

[static, since 6.0] bool QFile::setPermissions(const std::filesystem::path &filename, QFileDevice::Permissions permissionSpec)

Cette fonction a été introduite dans Qt 6.0.

[override virtual] qint64 QFile::size() const

Réimplémente : QFileDevice::size() const.

[static, since 6.9] bool QFile::supportsMoveToTrash()

Renvoie true si Qt XML supporte le déplacement de fichiers vers une corbeille dans le système d'exploitation actuel en utilisant la fonction moveToTrash(), false sinon. Notez que cette fonction renvoyant true n'implique pas que moveToTrash() réussira. En particulier, cette fonction ne vérifie pas si l'utilisateur a désactivé la fonctionnalité dans ses paramètres.

Cette fonction a été introduite dans Qt 6.9.

Voir aussi moveToTrash().

[static] QString QFile::symLinkTarget(const QString &fileName)

Renvoie le chemin absolu du fichier ou du répertoire auquel se réfère le lien symbolique (ou le raccourci sous Windows) spécifié par fileName, ou renvoie une chaîne vide si fileName ne correspond pas à un lien symbolique.

Ce nom ne peut pas représenter un fichier existant ; il s'agit uniquement d'une chaîne de caractères. QFile::exists() renvoie true si le lien symbolique pointe vers un fichier existant.

QString QFile::symLinkTarget() const

Renvoie le chemin absolu du fichier ou du répertoire vers lequel pointe un lien symbolique (ou un raccourci sous Windows), ou une chaîne vide si l'objet n'est pas un lien symbolique.

Ce nom ne peut pas représenter un fichier existant ; il s'agit uniquement d'une chaîne de caractères. QFile::exists() renvoie true si le lien symbolique pointe vers un fichier existant.

Voir aussi fileName() et setFileName().