StandardPaths QML Type

Permet d'accéder aux chemins d'accès système standard. En savoir plus...

Ce type est obsolète depuis Qt Labs Platform 6.4. Nous déconseillons fortement de l'utiliser dans du nouveau code.

• Liste de tous les membres, y compris les membres hérités

Méthodes

• string displayName(StandardLocation type)
• url findExecutable(string executableName, list<string> paths)
• url locate(StandardLocation type, string fileName, LocateOptions options)
• list<url> locateAll(StandardLocation type, string fileName, LocateOptions options)
• void setTestModeEnabled(bool testMode)
• list<url> standardLocations(StandardLocation type)
• url writableLocation(StandardLocation type)

Description détaillée

Utilisez plutôt QtCore::StandardPaths.

Le type singleton StandardPaths fournit des méthodes permettant d'interroger les chemins d'accès standard du système. Les chemins d'accès standard sont particulièrement utiles en association avec les types FileDialog et FolderDialog.

FileDialog {
    folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation)
}

Voir également QtCore::StandardPaths, FileDialog, FolderDialog et QStandardPaths.

Documentation des méthodes

string displayName(StandardLocation type)

Renvoie un nom d'affichage localisé pour l'emplacement donné type ou une chaîne vide QString si aucun emplacement correspondant n'est trouvé.

Voir également QStandardPaths::displayName().

url findExecutable(string executableName, list<string> paths)

Recherche le fichier exécutable nommé « executableName » dans le répertoire spécifié « paths », ou dans les chemins d'accès système si « paths » est vide.

Sur la plupart des systèmes d’exploitation, le chemin système est déterminé par la variable d’environnement PATH. Les répertoires dans lesquels rechercher l’exécutable peuvent être définis dans l’argument paths. Pour effectuer une recherche à la fois dans vos propres chemins et dans les chemins système, appelez findExecutable deux fois : une fois avec des chemins définis et une fois avec des chemins vides. Les liens symboliques ne sont pas résolus afin de préserver le comportement des exécutables dont le fonctionnement dépend du nom avec lequel ils sont invoqués.

Renvoie le chemin d’accès absolu vers l’exécutable, ou une chaîne vide s’il est introuvable.

Si le chemin executableName fourni est un chemin absolu pointant vers un exécutable, c’est son chemin « propre » qui est renvoyé.

Voir aussi QStandardPaths::findExecutable().

url locate(StandardLocation type, string fileName, LocateOptions options)

Recherche un fichier ou un répertoire nommé « fileName » dans les emplacements par défaut de type.

Le drapeau options vous permet de spécifier s'il faut rechercher des fichiers ou des répertoires. Par défaut, ce drapeau est défini sur LocateFile.

Renvoie le chemin absolu du premier fichier ou répertoire trouvé ; sinon, renvoie une chaîne vide.

Voir aussi QStandardPaths::locate().

list<url> locateAll(StandardLocation type, string fileName, LocateOptions options)

Recherche tous les fichiers ou répertoires portant le nom « fileName » dans les emplacements par défaut de « type ».

L’indicateur « options » vous permet de préciser s’il faut rechercher des fichiers ou des répertoires. Par défaut, cet indicateur est défini sur « LocateFile ».

Renvoie la liste de tous les fichiers trouvés.

Voir aussi QStandardPaths::locateAll().

void setTestModeEnabled(bool testMode)

Si testMode vaut true, cela active un « mode test » spécial dans QStandardPaths, qui redirige les emplacements accessibles en écriture vers des répertoires de test. Cela empêche les tests automatisés de lire ou d’écrire dans la configuration de l’utilisateur actuel.

Cela concerne les emplacements dans lesquels les programmes de test sont susceptibles d'écrire des fichiers : GenericDataLocation, AppDataLocation, ConfigLocation, GenericConfigLocation, AppConfigLocation, StateLocation, GenericStateLocation, GenericCacheLocation et CacheLocation. Les autres emplacements ne sont pas concernés.

Sous Unix, XDG_DATA_HOME est défini sur ~/.qttest/share, XDG_CONFIG_HOME sur ~/.qttest/config, XDG_STATE_HOME sur ~/.qttest/state et XDG_CACHE_HOME sur ~/.qttest/cache.

Sous macOS, les données sont stockées dans ~/.qttest/Application Support, le cache dans ~/.qttest/Cache et la configuration dans ~/.qttest/Preferences.

Sous Windows, tout est stocké dans un répertoire « qttest » situé sous %APPDATA%.

Voir également QStandardPaths::setTestModeEnabled().

list<url> standardLocations(StandardLocation type)

Renvoie tous les répertoires contenant des fichiers de type « type ».

La liste des répertoires est triée par ordre décroissant de priorité, en commençant par writableLocation() si celui-ci peut être déterminé. Cette liste est vide si aucun emplacement n’est défini pour le type.

Voir également ` QStandardPaths::standardLocations()`.

url writableLocation(StandardLocation type)

Renvoie le répertoire dans lequel les fichiers de ` type ` doivent être enregistrés, ou une chaîne vide si l'emplacement ne peut pas être déterminé.

Voir aussi QStandardPaths::writableLocation().