QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Class for file utilities. More...
#include <qgsfileutils.h>
Static Public Member Functions | |
static QString | addExtensionFromFilter (const QString &fileName, const QString &filter) |
Ensures that a fileName ends with an extension from the specified filter string. | |
static Qgis::DriveType | driveType (const QString &path) |
Returns the drive type for the given path. | |
static QString | ensureFileNameHasExtension (const QString &fileName, const QStringList &extensions) |
Ensures that a fileName ends with an extension from the provided list of extensions. | |
static QStringList | extensionsFromFilter (const QString &filter) |
Returns a list of the extensions contained within a file filter string. | |
static bool | fileMatchesFilter (const QString &fileName, const QString &filter) |
Returns true if the given fileName matches a file filter string. | |
static QString | findClosestExistingPath (const QString &path) |
Returns the top-most existing folder from path. | |
static QStringList | findFile (const QString &file, const QString &basepath=QString(), int maxClimbs=4, int searchCeiling=4, const QString ¤tDir=QString()) |
Will check basepath in an outward spiral up to maxClimbs levels to check if file exists. | |
static bool | isCloseToLimitOfOpenedFiles (int filesToBeOpened=1) |
Returns whether when opening new file(s) will reach, or nearly reach, the limit of simultaneously opened files by the process. | |
static int | openedFileCount () |
Returns the number of currently opened files by the process. | |
static int | openedFileLimit () |
Returns the limit of simultaneously opened files by the process. | |
static bool | pathIsSlowDevice (const QString &path) |
Returns true if the specified path is assumed to reside on a slow device, e.g. | |
static bool | renameDataset (const QString &oldPath, const QString &newPath, QString &error, Qgis::FileOperationFlags flags=Qgis::FileOperationFlag::IncludeMetadataFile|Qgis::FileOperationFlag::IncludeStyleFile) |
Renames the dataset at oldPath to newPath, renaming both the file at oldPath and all associated sidecar files which exist for it. | |
static QString | representFileSize (qint64 bytes) |
Returns the human size from bytes. | |
static QSet< QString > | sidecarFilesForPath (const QString &path) |
Returns a list of the sidecar files which exist for the dataset a the specified path. | |
static QStringList | splitPathToComponents (const QString &path) |
Given a file path, returns a list of all the components leading to that path. | |
static QString | stringToSafeFilename (const QString &string) |
Converts a string to a safe filename, replacing characters which are not safe for filenames with an '_' character. | |
static QString | uniquePath (const QString &path) |
Creates a unique file path name from a desired path by appending _<n> (where <n> is an integer number) before the file suffix. | |
static QString | wildcardsFromFilter (const QString &filter) |
Given a filter string like GeoTIFF Files (*.tiff *.tif) , extracts the wildcard portion of this filter (i.e. | |
Class for file utilities.
Definition at line 31 of file qgsfileutils.h.
|
static |
Ensures that a fileName ends with an extension from the specified filter string.
E.g. a fileName of d:/my_file
with a filter of GeoTIFF Files (*.tiff *.tif)
will return d:/my_file.tif
, where as fileName of d:/my_file.TIFF
or d:/my_file.TIF
will be returned unchanged.
Definition at line 134 of file qgsfileutils.cpp.
|
static |
Returns the drive type for the given path.
QgsNotSupportedException | if determining the drive type is not supported on the current platform. |
Definition at line 367 of file qgsfileutils.cpp.
|
static |
Ensures that a fileName ends with an extension from the provided list of extensions.
E.g. if extensions contains tif
and tiff
, then a fileName of d:/my_file
will return d:/my_file.tif
. A fileName of d:/my_file.TIFF
or d:/my_file.TIF
will be returned unchanged.
Definition at line 107 of file qgsfileutils.cpp.
|
static |
Returns a list of the extensions contained within a file filter string.
E.g. a filter of GeoTIFF Files (*.tiff *.tif)
would return a list containing tiff
, tif
. The initial '.' is stripped off the extension.
Definition at line 58 of file qgsfileutils.cpp.
|
static |
Returns true
if the given fileName matches a file filter string.
E.g a filter of GeoTIFF Files (*.tiff *.tif)
would return true
for a fileName of /home/test.tif
, or false
for /home/test.jpg
.
Definition at line 87 of file qgsfileutils.cpp.
|
static |
Returns the top-most existing folder from path.
E.g. if path is /home/user/projects/2018/P4343
and /home/user/projects
exists but no 2018
subfolder exists, then the function will return /home/user/projects
.
Definition at line 148 of file qgsfileutils.cpp.
|
static |
Will check basepath in an outward spiral up to maxClimbs levels to check if file exists.
file | Name or full path of the file to find |
basepath | current basepath of the file, needed if only the name is specified in file |
maxClimbs | limit the number of time the search can move up from the basepath |
searchCeiling | limits where in the folder hierarchy the search can be performed, 1 = root/drive, 2 = first folder level, 3 = sub folders ( Unix: /usr/bin, Win: C:/Users/Admin ), etc. |
currentDir | alternative default directory to override the actual current directory during the search |
Definition at line 181 of file qgsfileutils.cpp.
|
static |
Returns whether when opening new file(s) will reach, or nearly reach, the limit of simultaneously opened files by the process.
Currently only implemented on Linux.
filesToBeOpened | Number of files that will be opened. |
Definition at line 573 of file qgsfileutils.cpp.
|
static |
Returns the number of currently opened files by the process.
Currently only implemented on Linux.
Definition at line 561 of file qgsfileutils.cpp.
|
static |
Returns the limit of simultaneously opened files by the process.
Currently only implemented on Unix.
Definition at line 549 of file qgsfileutils.cpp.
|
static |
Returns true
if the specified path is assumed to reside on a slow device, e.g.
a remote network drive or other non-fixed device.
Definition at line 425 of file qgsfileutils.cpp.
|
static |
Renames the dataset at oldPath to newPath, renaming both the file at oldPath and all associated sidecar files which exist for it.
For instance, if oldPath specified a .shp file then the corresponding .dbf, .idx and .prj files would be renamed (amongst others).
The destination directory must already exist.
The optional flags argument can be used to control whether QMD metadata files and QML styling files should also be renamed accordingly. By default these will be renamed, but manually specifying a different set of flags allows callers to avoid this when desired.
oldPath | original path to dataset |
newPath | new path for dataset |
error | will be set to a descriptive error message if the rename operation fails |
flags | optional flags to control file operation behavior |
true
if the dataset was successfully renamed, or false
if an error occurredDefinition at line 477 of file qgsfileutils.cpp.
|
static |
Returns the human size from bytes.
Definition at line 41 of file qgsfileutils.cpp.
|
static |
Returns a list of the sidecar files which exist for the dataset a the specified path.
In this context a sidecar file is defined as a file which shares the same base filename as a dataset, but which differs in file extension. It defines the list of additional files which must be renamed or deleted alongside the main file associated with the dataset in order to completely rename/delete the dataset.
For instance, if path specified a .shp file then the corresponding .dbf, .idx and .prj files would be returned (amongst others).
Definition at line 457 of file qgsfileutils.cpp.
|
static |
Given a file path, returns a list of all the components leading to that path.
E.g. if path is /home/user/Pictures/test.png
, the returned list will contain /
, home
, user
, Pictures
, test.png
.
Definition at line 582 of file qgsfileutils.cpp.
|
static |
Converts a string to a safe filename, replacing characters which are not safe for filenames with an '_' character.
Definition at line 140 of file qgsfileutils.cpp.
|
static |
Creates a unique file path name from a desired path by appending _<n>
(where <n>
is an integer number) before the file suffix.
E.g. if /path/my_image.png
already exists /path/my_image_2.png
(and _3`,
_4`` etc.) will be checked until a file path that does not already exist is found.
path | the desired path. |
_<n>
(where <n>
is an integer number) appended to the file name before the suffix. Definition at line 610 of file qgsfileutils.cpp.
|
static |
Given a filter string like GeoTIFF Files (*.tiff *.tif)
, extracts the wildcard portion of this filter (i.e.
*.tiff *.tif
).
Definition at line 77 of file qgsfileutils.cpp.