Skip to content

Class QfAndroidPlatformUtilities

ClassList > QfAndroidPlatformUtilities

Inherits the following classes: QfPlatformUtilities

Public Types inherited from QfPlatformUtilities

See QfPlatformUtilities

Type Name
enum Capability

Public Properties inherited from QfPlatformUtilities

See QfPlatformUtilities

Type Name
property QfPlatformUtilities::Capabilities capabilities

Public Signals inherited from QfPlatformUtilities

See QfPlatformUtilities

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
QfAndroidPlatformUtilities ()
virtual QStringList additionalApplicationDirectories () override const
virtual void afterUpdate () override
virtual QStringList appDataDirs () override const
virtual QString applicationDirectory () override const
virtual QfPlatformUtilities::Capabilities capabilities () override const
virtual bool checkCameraPermissions () override const
virtual bool checkMicrophonePermissions () override const
virtual bool checkPositioningPermissions () override const
virtual void dimBrightness () override
virtual void executeQfAction () override const
virtual void exportDatasetTo (const QString & path) override const
Exports a dataset path to a user-specified location.
virtual void exportFolderTo (const QString & path) override const
Exports a folder path to a user-specified location.
virtual QfResourceSource * getCameraPicture (const QString & prefix, const QString & pictureFilePath, const QString & suffix, QObject * parent=nullptr) override
virtual QfResourceSource * getCameraVideo (const QString & prefix, const QString & videoFilePath, const QString & suffix, QObject * parent=nullptr) override
virtual QfResourceSource * getFile (const QString & prefix, const QString & filePath, const QString & mimeType, QObject * parent=nullptr) override
virtual QfResourceSource * getGalleryPicture (const QString & prefix, const QString & pictureFilePath, QObject * parent=nullptr) override
virtual QfResourceSource * getGalleryVideo (const QString & prefix, const QString & videoFilePath, QObject * parent=nullptr) override
virtual bool hasQfAction () override const
virtual bool hasQgsProject () override const
virtual void importDatasets () override const
Requests and imports one or more datasets into QField's application directory action.
virtual void importProjectArchive () override const
Requests and imports a project archive into QField's application directory action.
virtual void importProjectFolder () override const
Requests and imports a project folder into QField's application directory action.
virtual bool isSystemDarkTheme () override const
virtual void loadQgsProject () override const
virtual QfViewStatus * open (const QString & uri, bool editing, QObject * parent=nullptr) override
virtual void removeDataset (const QString & path) override const
Removes a given dataset path .
virtual void removeFolder (const QString & path) override const
Removes a given folder path .
virtual void requestBackgroundPositioningPermissions () override
virtual void requestStoragePermission () override const
virtual void restoreBrightness () override
virtual QStringList rootDirectories () override const
virtual void sendCompressedFolderTo (const QString & path) override const
Compresses a folder path and sends it via the platform native API.
virtual void sendDatasetTo (const QString & path) override const
Sends a dataset path via the platform native API.
virtual void setHandleVolumeKeys (const bool handle) override
virtual void setScreenLockPermission (const bool allowLock) override
virtual QString startPositioningService () override const
virtual void stopPositioningService () override const
virtual double systemFontPointSize () override const
virtual QString systemSharedDataLocation () override const
virtual void updateProjectFromArchive (const QString & projectPath) override const
virtual void uploadPendingAttachments (QfCloudConnection * connection) override const
virtual void vibrate (int milliseconds) override const

Public Functions inherited from QfPlatformUtilities

See QfPlatformUtilities

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 inherited from QfPlatformUtilities

See QfPlatformUtilities

Type Name
QfPlatformUtilities * instance ()

Public Functions Documentation

function QfAndroidPlatformUtilities

QfAndroidPlatformUtilities::QfAndroidPlatformUtilities ()

function additionalApplicationDirectories

virtual QStringList QfAndroidPlatformUtilities::additionalApplicationDirectories () override const

Secondary application directories which can be used by individual platforms.

Implements QfPlatformUtilities::additionalApplicationDirectories

function afterUpdate

virtual void QfAndroidPlatformUtilities::afterUpdate () override

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.

Implements QfPlatformUtilities::afterUpdate

function appDataDirs

virtual QStringList QfAndroidPlatformUtilities::appDataDirs () override const

Returns:

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

Implements QfPlatformUtilities::appDataDirs

function applicationDirectory

virtual QString QfAndroidPlatformUtilities::applicationDirectory () override const

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

Implements QfPlatformUtilities::applicationDirectory

function capabilities

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

Returns flags containing the supported capabilities of the platform.

Implements QfPlatformUtilities::capabilities

function checkCameraPermissions

virtual bool QfAndroidPlatformUtilities::checkCameraPermissions () override 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

Implements QfPlatformUtilities::checkCameraPermissions

function checkMicrophonePermissions

virtual bool QfAndroidPlatformUtilities::checkMicrophonePermissions () override 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

Implements QfPlatformUtilities::checkMicrophonePermissions

function checkPositioningPermissions

virtual bool QfAndroidPlatformUtilities::checkPositioningPermissions () override 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

Implements QfPlatformUtilities::checkPositioningPermissions

function dimBrightness

virtual void QfAndroidPlatformUtilities::dimBrightness () override

Dims the brightness of the screen on supported devices.

Implements QfPlatformUtilities::dimBrightness

function executeQfAction

virtual void QfAndroidPlatformUtilities::executeQfAction () override const

Loads the action provided during launch.

See also: hasQfAction

Implements QfPlatformUtilities::executeQfAction

function exportDatasetTo

Exports a dataset path to a user-specified location. 

virtual void QfAndroidPlatformUtilities::exportDatasetTo (
    const QString & path
) override const

Implements QfPlatformUtilities::exportDatasetTo

function exportFolderTo

Exports a folder path to a user-specified location. 

virtual void QfAndroidPlatformUtilities::exportFolderTo (
    const QString & path
) override const

Implements QfPlatformUtilities::exportFolderTo

function getCameraPicture

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

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

Implements QfPlatformUtilities::getCameraPicture

function getCameraVideo

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

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

Implements QfPlatformUtilities::getCameraVideo

function getFile

virtual QfResourceSource * QfAndroidPlatformUtilities::getFile (
    const QString & prefix,
    const QString & filePath,
    const QString & mimeType,
    QObject * parent=nullptr
) override

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

Implements QfPlatformUtilities::getFile

function getGalleryPicture

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

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

Implements QfPlatformUtilities::getGalleryPicture

function getGalleryVideo

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

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

Implements QfPlatformUtilities::getGalleryVideo

function hasQfAction

virtual bool QfAndroidPlatformUtilities::hasQfAction () override const

Returns the current action string

See also: loadQfAction

Implements QfPlatformUtilities::hasQfAction

function hasQgsProject

virtual bool QfAndroidPlatformUtilities::hasQgsProject () override const

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

See also: loadQgsProject

Implements QfPlatformUtilities::hasQgsProject

function importDatasets

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

virtual void QfAndroidPlatformUtilities::importDatasets () override const

Implements QfPlatformUtilities::importDatasets

function importProjectArchive

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

virtual void QfAndroidPlatformUtilities::importProjectArchive () override const

Implements QfPlatformUtilities::importProjectArchive

function importProjectFolder

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

virtual void QfAndroidPlatformUtilities::importProjectFolder () override const

Implements QfPlatformUtilities::importProjectFolder

function isSystemDarkTheme

virtual bool QfAndroidPlatformUtilities::isSystemDarkTheme () override const

Returns TRUE is the system uses a dark theme.

Implements QfPlatformUtilities::isSystemDarkTheme

function loadQgsProject

virtual void QfAndroidPlatformUtilities::loadQgsProject () override const

Loads the project file provided during launch.

See also: hasQgsProject

Implements QfPlatformUtilities::loadQgsProject

function open

virtual QfViewStatus * QfAndroidPlatformUtilities::open (
    const QString & uri,
    bool editing,
    QObject * parent=nullptr
) override

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.

Implements QfPlatformUtilities::open

function removeDataset

Removes a given dataset path . 

virtual void QfAndroidPlatformUtilities::removeDataset (
    const QString & path
) override const

Implements QfPlatformUtilities::removeDataset

function removeFolder

Removes a given folder path . 

virtual void QfAndroidPlatformUtilities::removeFolder (
    const QString & path
) override const

Implements QfPlatformUtilities::removeFolder

function requestBackgroundPositioningPermissions

virtual void QfAndroidPlatformUtilities::requestBackgroundPositioningPermissions () override

Implements QfPlatformUtilities::requestBackgroundPositioningPermissions

function requestStoragePermission

virtual void QfAndroidPlatformUtilities::requestStoragePermission () override const

Implements QfPlatformUtilities::requestStoragePermission

function restoreBrightness

virtual void QfAndroidPlatformUtilities::restoreBrightness () override

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

Implements QfPlatformUtilities::restoreBrightness

function rootDirectories

virtual QStringList QfAndroidPlatformUtilities::rootDirectories () override const

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

Implements QfPlatformUtilities::rootDirectories

function sendCompressedFolderTo

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

virtual void QfAndroidPlatformUtilities::sendCompressedFolderTo (
    const QString & path
) override const

Implements QfPlatformUtilities::sendCompressedFolderTo

function sendDatasetTo

Sends a dataset path via the platform native API. 

virtual void QfAndroidPlatformUtilities::sendDatasetTo (
    const QString & path
) override const

Implements QfPlatformUtilities::sendDatasetTo

function setHandleVolumeKeys

virtual void QfAndroidPlatformUtilities::setHandleVolumeKeys (
    const bool handle
) override

Sets whether the device volume keys are handled by QField.

Implements QfPlatformUtilities::setHandleVolumeKeys

function setScreenLockPermission

virtual void QfAndroidPlatformUtilities::setScreenLockPermission (
    const bool allowLock
) override

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.

Implements QfPlatformUtilities::setScreenLockPermission

function startPositioningService

virtual QString QfAndroidPlatformUtilities::startPositioningService () override const

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

Implements QfPlatformUtilities::startPositioningService

function stopPositioningService

virtual void QfAndroidPlatformUtilities::stopPositioningService () override const

Stops a positioning service on supported platforms.

Implements QfPlatformUtilities::stopPositioningService

function systemFontPointSize

inline virtual double QfAndroidPlatformUtilities::systemFontPointSize () override const

Returns the default system font size.

Implements QfPlatformUtilities::systemFontPointSize

function systemSharedDataLocation

virtual QString QfAndroidPlatformUtilities::systemSharedDataLocation () override 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.

Implements QfPlatformUtilities::systemSharedDataLocation

function updateProjectFromArchive

virtual void QfAndroidPlatformUtilities::updateProjectFromArchive (
    const QString & projectPath
) override const

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

Parameters:

  • projectPath the project file path

Implements QfPlatformUtilities::updateProjectFromArchive

function uploadPendingAttachments

virtual void QfAndroidPlatformUtilities::uploadPendingAttachments (
    QfCloudConnection * connection
) override const

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

Implements QfPlatformUtilities::uploadPendingAttachments

function vibrate

virtual void QfAndroidPlatformUtilities::vibrate (
    int milliseconds
) override const

Vibrates the device on supported platforms.

Implements QfPlatformUtilities::vibrate

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