Class QfPlatformUtilities

ClassList > QfPlatformUtilities

Inherits the following classes: QObject

Inherited by the following classes: QfAndroidPlatformUtilities, QfIosPlatformUtilities

Public Types

Type	Name
enum	Capability

Public Properties

Type	Name
property QfPlatformUtilities::Capabilities	capabilities

Public Signals

Type	Name
signal void	resourceCanceled (const QString & message) Emitted when a resource has been opened.
signal void	resourceOpened (const QString & path) Emitted when a resource has been opened.
signal void	resourceReceived (const QString & path) Emitted when a resource has been received.

Public Functions

Type	Name
virtual QStringList	additionalApplicationDirectories () const
virtual void	afterUpdate ()
virtual Q_INVOKABLE QStringList	appDataDirs () const
virtual Q_INVOKABLE QString	applicationDirectory () const
Q_INVOKABLE QStringList	availableGrids () const
virtual QfPlatformUtilities::Capabilities	capabilities () const
virtual Qt::PermissionStatus	checkCameraPermission () const
virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool	checkCameraPermissions () const
virtual Qt::PermissionStatus	checkMicrophonePermission () const
virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool	checkMicrophonePermissions () const
virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool	checkPositioningPermissions () const
virtual Q_INVOKABLE void	copyTextToClipboard (const QString & string) const
Q_INVOKABLE bool	createDir (const QString & path, const QString & dirname) const
virtual Q_INVOKABLE void	dimBrightness ()
virtual void	executeQfAction () const
virtual Q_INVOKABLE void	exportDatasetTo (const QString & path) const Exports a dataset path to a user-specified location.
virtual Q_INVOKABLE void	exportFolderTo (const QString & path) const Exports a folder path to a user-specified location.
virtual Q_INVOKABLE QfResourceSource *	getCameraPicture (const QString & prefix, const QString & pictureFilePath, const QString & suffix, QObject * parent=nullptr)
virtual Q_INVOKABLE QfResourceSource *	getCameraVideo (const QString & prefix, const QString & videoFilePath, const QString & suffix, QObject * parent=nullptr)
virtual Q_INVOKABLE QfResourceSource *	getFile (const QString & prefix, const QString & filePath, const QString & mimeType=QStringLiteral("*/*"), QObject * parent=nullptr)
virtual Q_INVOKABLE QfResourceSource *	getGalleryPicture (const QString & prefix, const QString & pictureFilePath, QObject * parent=nullptr)
virtual Q_INVOKABLE QfResourceSource *	getGalleryVideo (const QString & prefix, const QString & videoFilePath, QObject * parent=nullptr)
virtual Q_INVOKABLE QString	getTextFromClipboard () const
virtual bool	hasQfAction () const
virtual bool	hasQgsProject () const
virtual Q_INVOKABLE void	importDatasets () const Requests and imports one or more datasets into QField's application directory action.
virtual Q_INVOKABLE void	importProjectArchive () const Requests and imports a project archive into QField's application directory action.
virtual Q_INVOKABLE void	importProjectFolder () const Requests and imports a project folder into QField's application directory action.
void	initSystem ()
virtual Q_INVOKABLE bool	isSystemDarkTheme () const
virtual void	loadQgsProject () const
virtual Q_INVOKABLE QfViewStatus *	open (const QString & uri, bool editing=false, QObject * parent=nullptr)
virtual Q_INVOKABLE QfProjectSource *	openProject (QObject * parent=nullptr)
virtual Q_INVOKABLE void	removeDataset (const QString & path) const Removes a given dataset path .
virtual Q_INVOKABLE void	removeFolder (const QString & path) const Removes a given folder path .
Q_INVOKABLE bool	renameFile (const QString & oldFilePath, const QString & newFilePath, bool overwrite=true) const
virtual void	requestBackgroundPositioningPermissions ()
virtual void	requestCameraPermission (std::function< void(Qt::PermissionStatus)> func)
virtual void	requestMicrophonePermission (std::function< void(Qt::PermissionStatus)> func)
virtual Q_INVOKABLE void	requestStoragePermission () const
virtual Q_INVOKABLE void	restoreBrightness ()
Q_INVOKABLE bool	rmFile (const QString & filename) const
virtual QStringList	rootDirectories () const
virtual Q_INVOKABLE void	sendCompressedFilesTo (const QStringList & paths) const Compresses a list of file paths and sends it via the platform native API.
virtual Q_INVOKABLE void	sendCompressedFolderTo (const QString & path) const Compresses a folder path and sends it via the platform native API.
virtual Q_INVOKABLE void	sendDatasetTo (const QString & path) const Sends a dataset path via the platform native API.
virtual Q_INVOKABLE void	setHandleVolumeKeys (const bool handle)
virtual Q_INVOKABLE void	setScreenLockPermission (const bool allowLock)
virtual QString	startPositioningService () const
virtual void	stopPositioningService () const
virtual Q_INVOKABLE double	systemFontPointSize () const
virtual Q_INVOKABLE QString	systemLocalDataLocation (const QString & subDir=QString()) const
virtual QString	systemSharedDataLocation () const
virtual Q_INVOKABLE void	updateProjectFromArchive (const QString & projectPath) const
virtual Q_INVOKABLE void	uploadPendingAttachments (QfCloudConnection * connection) const
virtual Q_INVOKABLE void	vibrate (int milliseconds) const
virtual	~QfPlatformUtilities ()

Public Static Functions

Type	Name
QfPlatformUtilities *	instance ()

Public Types Documentation

enum Capability

enum QfPlatformUtilities::Capability {
    NoCapabilities = 0,
    NativeCamera = 1,
    AdjustBrightness = 1 << 1,
    SentryFramework = 1 << 2,
    NativeLocalDataPicker = 1 << 3,
    CustomImport = 1 << 4,
    CustomExport = 1 << 5,
    CustomSend = 1 << 6,
    FilePicker = 1 << 7,
    VolumeKeys = 1 << 8,
    Vibrate = 1 << 9,
    UpdateProjectFromArchive = 1 << 10,
    PositioningService = 1 << 11
};

---

Public Properties Documentation

property capabilities [1/2]

QfPlatformUtilities::Capabilities QfPlatformUtilities::capabilities;

---

Public Signals Documentation

signal resourceCanceled

Emitted when a resource has been opened.

void QfPlatformUtilities::resourceCanceled;

---

signal resourceOpened

Emitted when a resource has been opened.

void QfPlatformUtilities::resourceOpened;

---

signal resourceReceived

Emitted when a resource has been received.

void QfPlatformUtilities::resourceReceived;

---

Public Functions Documentation

function additionalApplicationDirectories

virtual QStringList QfPlatformUtilities::additionalApplicationDirectories () const

Secondary application directories which can be used by individual platforms.

---

function afterUpdate

virtual void QfPlatformUtilities::afterUpdate () 

This method can be used to implement platform specific initialization tasks to be performed after an app update. This is implemented for Android to extract app assets to location where it can be accessed via filesystem.

---

function appDataDirs

virtual Q_INVOKABLE QStringList QfPlatformUtilities::appDataDirs () const

Returns:

a list of data directories where user data is searched. User data are pg_service.conf, authentication config, grids, ...

---

function applicationDirectory

virtual Q_INVOKABLE QString QfPlatformUtilities::applicationDirectory () const

The main application directory within which projects and datasets can be imported.

---

function availableGrids

Q_INVOKABLE QStringList QfPlatformUtilities::availableGrids () const

---

function capabilities [2/2]

virtual QfPlatformUtilities::Capabilities QfPlatformUtilities::capabilities () const

Returns flags containing the supported capabilities of the platform.

---

function checkCameraPermission

virtual Qt::PermissionStatus QfPlatformUtilities::checkCameraPermission () const

---

function checkCameraPermissions

virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool QfPlatformUtilities::checkCameraPermissions () const

Checks for camera permissions on the device. If the permissions are not given, the user will be asked to grant permissions.

Deprecated

Since QField 3.1

---

function checkMicrophonePermission

virtual Qt::PermissionStatus QfPlatformUtilities::checkMicrophonePermission () const

---

function checkMicrophonePermissions

virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool QfPlatformUtilities::checkMicrophonePermissions () const

Checks for camera microphone on the device. If the permissions are not given, the user will be asked to grant permissions.

Deprecated

Since QField 3.1

---

function checkPositioningPermissions

virtual Q_DECL_DEPRECATED virtual Q_INVOKABLE bool QfPlatformUtilities::checkPositioningPermissions () const

Checks for positioning (GPS etc) permissions on the device. If the permissions are not given, the user will be asked to grant permissions. It will return true, if at least coarse permissions are granted. It will ask for fine permissions if none are granted.

Deprecated

Since QField 3.1

---

function copyTextToClipboard

virtual Q_INVOKABLE void QfPlatformUtilities::copyTextToClipboard (
    const QString & string
) const

Copies a text string to the system clipboard.

---

function createDir

Q_INVOKABLE bool QfPlatformUtilities::createDir (
    const QString & path,
    const QString & dirname
) const

---

function dimBrightness

inline virtual Q_INVOKABLE void QfPlatformUtilities::dimBrightness () 

Dims the brightness of the screen on supported devices.

---

function executeQfAction

virtual void QfPlatformUtilities::executeQfAction () const

Loads the action provided during launch.

See also: hasQfAction

---

function exportDatasetTo

Exports a dataset path to a user-specified location.

virtual Q_INVOKABLE void QfPlatformUtilities::exportDatasetTo (
    const QString & path
) const

---

function exportFolderTo

Exports a folder path to a user-specified location.

virtual Q_INVOKABLE void QfPlatformUtilities::exportFolderTo (
    const QString & path
) const

---

function getCameraPicture

virtual Q_INVOKABLE QfResourceSource * QfPlatformUtilities::getCameraPicture (
    const QString & prefix,
    const QString & pictureFilePath,
    const QString & suffix,
    QObject * parent=nullptr
) 

Get a picture from camera and copy it to the requested prefix

Parameters:

• prefix The project folder
• pictureFilePath The path (including subfolders and name) of the file

Returns:

The name of the picture or null

---

function getCameraVideo

virtual Q_INVOKABLE QfResourceSource * QfPlatformUtilities::getCameraVideo (
    const QString & prefix,
    const QString & videoFilePath,
    const QString & suffix,
    QObject * parent=nullptr
) 

Get a video from camera and copy it to the requested prefix

Parameters:

• prefix The project folder
• videoFilePath The path (including subfolders and name) of the file

Returns:

The name of the video or null

---

function getFile

virtual Q_INVOKABLE QfResourceSource * QfPlatformUtilities::getFile (
    const QString & prefix,
    const QString & filePath,
    const QString & mimeType=QStringLiteral("*/*"),
    QObject * parent=nullptr
) 

Get a file from the operating system and copy it to the requested prefix

Parameters:

• prefix The project folder
• filePath The path (including subfolders and name) of the file
• filter The filter string (e.g. *.mp3)

Returns:

The name of the file or null

---

function getGalleryPicture

virtual Q_INVOKABLE QfResourceSource * QfPlatformUtilities::getGalleryPicture (
    const QString & prefix,
    const QString & pictureFilePath,
    QObject * parent=nullptr
) 

Get a picture from gallery and copy it to the requested prefix

Parameters:

• prefix The project folder
• pictureFilePath The path (including subfolders and name) of the file

Returns:

The name of the picture or null

---

function getGalleryVideo

virtual Q_INVOKABLE QfResourceSource * QfPlatformUtilities::getGalleryVideo (
    const QString & prefix,
    const QString & videoFilePath,
    QObject * parent=nullptr
) 

Get a video from gallery and copy it to the requested prefix

Parameters:

• prefix The project folder
• videoFilePath The path (including subfolders and name) of the video

Returns:

The name of the video or null

---

function getTextFromClipboard

virtual Q_INVOKABLE QString QfPlatformUtilities::getTextFromClipboard () const

Returns the current text from the system clipboard.

---

function hasQfAction

virtual bool QfPlatformUtilities::hasQfAction () const

Returns the current action string

See also: loadQfAction

---

function hasQgsProject

virtual bool QfPlatformUtilities::hasQgsProject () const

Returns TRUE is a project file has been provided and should be opened at launch.

See also: loadQgsProject

---

function importDatasets

Requests and imports one or more datasets into QField's application directory action.

virtual Q_INVOKABLE void QfPlatformUtilities::importDatasets () const

---

function importProjectArchive

Requests and imports a project archive into QField's application directory action.

virtual Q_INVOKABLE void QfPlatformUtilities::importProjectArchive () const

---

function importProjectFolder

Requests and imports a project folder into QField's application directory action.

virtual Q_INVOKABLE void QfPlatformUtilities::importProjectFolder () const

---

function initSystem

void QfPlatformUtilities::initSystem () 

This method will do initialization tasks and copy sample projects to a writable location It will also call afterUpdate whenever a new version is detected.

---

function isSystemDarkTheme

virtual Q_INVOKABLE bool QfPlatformUtilities::isSystemDarkTheme () const

Returns TRUE is the system uses a dark theme.

---

function loadQgsProject

virtual void QfPlatformUtilities::loadQgsProject () const

Loads the project file provided during launch.

See also: hasQgsProject

---

function open

virtual Q_INVOKABLE QfViewStatus * QfPlatformUtilities::open (
    const QString & uri,
    bool editing=false,
    QObject * parent=nullptr
) 

Open the resource (file, image, ...) that is available under uri. The mimetype is detected to indicate the system how the file should be opened. An optional editing parameter can be set to true to indicate to supported systems the resource is expected to be edited.

---

function openProject

virtual Q_INVOKABLE QfProjectSource * QfPlatformUtilities::openProject (
    QObject * parent=nullptr
) 

Indicates the system that we want to open a project. The system shall show a suitable user interface element (like a filebrowser) to let the user select a project. The call returns immediately and the returned QfProjectSource will notify when the project has actually been chosen.

---

function removeDataset

Removes a given dataset path .

virtual Q_INVOKABLE void QfPlatformUtilities::removeDataset (
    const QString & path
) const

---

function removeFolder

Removes a given folder path .

virtual Q_INVOKABLE void QfPlatformUtilities::removeFolder (
    const QString & path
) const

---

function renameFile

Q_INVOKABLE bool QfPlatformUtilities::renameFile (
    const QString & oldFilePath,
    const QString & newFilePath,
    bool overwrite=true
) const

---

function requestBackgroundPositioningPermissions

inline virtual void QfPlatformUtilities::requestBackgroundPositioningPermissions () 

---

function requestCameraPermission

virtual void QfPlatformUtilities::requestCameraPermission (
    std::function< void(Qt::PermissionStatus)> func
) 

---

function requestMicrophonePermission

virtual void QfPlatformUtilities::requestMicrophonePermission (
    std::function< void(Qt::PermissionStatus)> func
) 

---

function requestStoragePermission

inline virtual Q_INVOKABLE void QfPlatformUtilities::requestStoragePermission () const

---

function restoreBrightness

inline virtual Q_INVOKABLE void QfPlatformUtilities::restoreBrightness () 

Restores the brightness of the screen to its original value on supported devices.

---

function rmFile

Q_INVOKABLE bool QfPlatformUtilities::rmFile (
    const QString & filename
) const

---

function rootDirectories

virtual QStringList QfPlatformUtilities::rootDirectories () const

A list of root directories (e.g. root of an external storage) when system-wide access is available.

---

function sendCompressedFilesTo

Compresses a list of file paths and sends it via the platform native API.

virtual Q_INVOKABLE void QfPlatformUtilities::sendCompressedFilesTo (
    const QStringList & paths
) const

---

function sendCompressedFolderTo

Compresses a folder path and sends it via the platform native API.

virtual Q_INVOKABLE void QfPlatformUtilities::sendCompressedFolderTo (
    const QString & path
) const

---

function sendDatasetTo

Sends a dataset path via the platform native API.

virtual Q_INVOKABLE void QfPlatformUtilities::sendDatasetTo (
    const QString & path
) const

---

function setHandleVolumeKeys

inline virtual Q_INVOKABLE void QfPlatformUtilities::setHandleVolumeKeys (
    const bool handle
) 

Sets whether the device volume keys are handled by QField.

---

function setScreenLockPermission

inline virtual Q_INVOKABLE void QfPlatformUtilities::setScreenLockPermission (
    const bool allowLock
) 

Sets whether the device screen is allowed to go in lock mode.

Parameters:

• allowLock if set to FALSE, the screen will not be allowed to lock.

---

function startPositioningService

inline virtual QString QfPlatformUtilities::startPositioningService () const

Starts a positioning service on supported platforms and returns the remote object URL.

---

function stopPositioningService

inline virtual void QfPlatformUtilities::stopPositioningService () const

Stops a positioning service on supported platforms.

---

function systemFontPointSize

virtual Q_INVOKABLE double QfPlatformUtilities::systemFontPointSize () const

Returns the default system font size.

---

function systemLocalDataLocation

virtual Q_INVOKABLE QString QfPlatformUtilities::systemLocalDataLocation (
    const QString & subDir=QString()
) const

Returns:

a directory where local data can be stored. this includes local qfieldcloud data or sample projects. A subDir is appended to the path.

---

function systemSharedDataLocation

virtual QString QfPlatformUtilities::systemSharedDataLocation () const

The path to share data location. Under this path, there should be the app specific directories qgis/ proj/ qfield/ ... Refers to /share or /usr/share on Linux. This path is assumed to be read only.

---

function updateProjectFromArchive

virtual Q_INVOKABLE void QfPlatformUtilities::updateProjectFromArchive (
    const QString & projectPath
) const

Update a local project content from a user-picked archive file action

Parameters:

• projectPath the project file path

---

function uploadPendingAttachments

virtual Q_INVOKABLE void QfPlatformUtilities::uploadPendingAttachments (
    QfCloudConnection * connection
) const

Uploads any pending attachments linked to the logged in user account.

---

function vibrate

inline virtual Q_INVOKABLE void QfPlatformUtilities::vibrate (
    int milliseconds
) const

Vibrates the device on supported platforms.

---

function ~QfPlatformUtilities

virtual QfPlatformUtilities::~QfPlatformUtilities () 

---

Public Static Functions Documentation

function instance

static QfPlatformUtilities * QfPlatformUtilities::instance () 

---

---

The documentation for this class was generated from the following file src/core/platforms/qfplatformutilities.h