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. More...

static QString	ensureFileNameHasExtension (const QString &fileName, const QStringList &extensions)
	Ensures that a fileName ends with an extension from the provided list of extensions. More...

static QStringList	extensionsFromFilter (const QString &filter)
	Returns a list of the extensions contained within a file filter string. More...

static QString	findClosestExistingPath (const QString &path)
	Returns the top-most existing folder from path. More...

static QString	representFileSize (qint64 bytes)
	Returns the human size from bytes. More...

static QString	stringToSafeFilename (const QString &string)
	Converts a string to a safe filename, replacing characters which are not safe for filenames with an '_' character. More...

Detailed Description

Class for file utilities.

Since: QGIS 3.0

Definition at line 29 of file qgsfileutils.h.

Member Function Documentation

QString QgsFileUtils::addExtensionFromFilter	(	const QString &	fileName,
		const QString &	filter
	)

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.

See also: extensionsFromFilter(); ensureFileNameHasExtension()

Definition at line 84 of file qgsfileutils.cpp.

QString QgsFileUtils::ensureFileNameHasExtension	(	const QString &	fileName,
		const QStringList &	extensions
	)

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.

See also: extensionsFromFilter(); addExtensionFromFilter()

Definition at line 57 of file qgsfileutils.cpp.

QStringList QgsFileUtils::extensionsFromFilter ( const QString & filter )

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.

See also: ensureFileNameHasExtension(); addExtensionFromFilter()

Definition at line 38 of file qgsfileutils.cpp.

QString QgsFileUtils::findClosestExistingPath ( const QString & path )

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".

Since: QGIS 3.2

Definition at line 98 of file qgsfileutils.cpp.

QString QgsFileUtils::representFileSize ( qint64 bytes )

static

Returns the human size from bytes.

Definition at line 22 of file qgsfileutils.cpp.

QString QgsFileUtils::stringToSafeFilename ( const QString & string )

static

Converts a string to a safe filename, replacing characters which are not safe for filenames with an '_' character.

Warning: This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.

Definition at line 90 of file qgsfileutils.cpp.

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

/build/qgis-3.4.15+24xenial/src/core/qgsfileutils.h
/build/qgis-3.4.15+24xenial/src/core/qgsfileutils.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation