Skip to content

Class QfIosPlatformUtilities

ClassList > QfIosPlatformUtilities

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
QfIosPlatformUtilities ()
virtual void afterUpdate () override
virtual QStringList appDataDirs () override const
virtual QString applicationDirectory () override const
virtual QfPlatformUtilities::Capabilities capabilities () override const
virtual Qt::PermissionStatus checkCameraPermission () override const
virtual Qt::PermissionStatus checkMicrophonePermission () 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 * 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 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 QfViewStatus * open (const QString & uri, bool editing=false, QObject * parent=nullptr) override
virtual QfProjectSource * openProject (QObject * parent=nullptr) override
virtual void requestCameraPermission (std::function< void(Qt::PermissionStatus)> func) override
virtual void requestMicrophonePermission (std::function< void(Qt::PermissionStatus)> func) 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 setScreenLockPermission (const bool allowLock) override
virtual double systemFontPointSize () override const
virtual QString systemSharedDataLocation () override const
virtual void updateProjectFromArchive (const QString & projectPath) 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 QfIosPlatformUtilities

QfIosPlatformUtilities::QfIosPlatformUtilities ()

function afterUpdate

virtual void QfIosPlatformUtilities::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 QfIosPlatformUtilities::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 QfIosPlatformUtilities::applicationDirectory () override const

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

Implements QfPlatformUtilities::applicationDirectory

function capabilities

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

Returns flags containing the supported capabilities of the platform.

Implements QfPlatformUtilities::capabilities

function checkCameraPermission

virtual Qt::PermissionStatus QfIosPlatformUtilities::checkCameraPermission () override const

Implements QfPlatformUtilities::checkCameraPermission

function checkMicrophonePermission

virtual Qt::PermissionStatus QfIosPlatformUtilities::checkMicrophonePermission () override const

Implements QfPlatformUtilities::checkMicrophonePermission

function exportDatasetTo

Exports a dataset path to a user-specified location. 

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

Implements QfPlatformUtilities::exportDatasetTo

function exportFolderTo

Exports a folder path to a user-specified location. 

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

Implements QfPlatformUtilities::exportFolderTo

function getCameraPicture

virtual QfResourceSource * QfIosPlatformUtilities::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 * QfIosPlatformUtilities::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 getGalleryPicture

virtual QfResourceSource * QfIosPlatformUtilities::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 * QfIosPlatformUtilities::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 importDatasets

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

virtual void QfIosPlatformUtilities::importDatasets () override const

Implements QfPlatformUtilities::importDatasets

function importProjectArchive

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

virtual void QfIosPlatformUtilities::importProjectArchive () override const

Implements QfPlatformUtilities::importProjectArchive

function importProjectFolder

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

virtual void QfIosPlatformUtilities::importProjectFolder () override const

Implements QfPlatformUtilities::importProjectFolder

function isSystemDarkTheme

virtual bool QfIosPlatformUtilities::isSystemDarkTheme () override const

Returns TRUE is the system uses a dark theme.

Implements QfPlatformUtilities::isSystemDarkTheme

function open

virtual QfViewStatus * QfIosPlatformUtilities::open (
    const QString & uri,
    bool editing=false,
    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 openProject

virtual QfProjectSource * QfIosPlatformUtilities::openProject (
    QObject * parent=nullptr
) override

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.

Implements QfPlatformUtilities::openProject

function requestCameraPermission

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

Implements QfPlatformUtilities::requestCameraPermission

function requestMicrophonePermission

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

Implements QfPlatformUtilities::requestMicrophonePermission

function rootDirectories

inline virtual QStringList QfIosPlatformUtilities::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 QfIosPlatformUtilities::sendCompressedFolderTo (
    const QString & path
) override const

Implements QfPlatformUtilities::sendCompressedFolderTo

function sendDatasetTo

Sends a dataset path via the platform native API. 

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

Implements QfPlatformUtilities::sendDatasetTo

function setScreenLockPermission

virtual void QfIosPlatformUtilities::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 systemFontPointSize

inline virtual double QfIosPlatformUtilities::systemFontPointSize () override const

Returns the default system font size.

Implements QfPlatformUtilities::systemFontPointSize

function systemSharedDataLocation

virtual QString QfIosPlatformUtilities::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 QfIosPlatformUtilities::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

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