This documentation lists all C++ functions that can be called from QML in QFIELD.
- AppInterface
- AttributeFormModel
- BarcodeDecoder
- BluetoothDeviceModel
- BookmarkModel
- ChangelogContents
- ClipboardManager
- Coordinatereferencesystemutils
- DeltaFileWrapper
- DigitizingLogger
- DistanceArea
- DrawingCanvas
- DrawingTemplateModel
- ExpressionContextUtils
- ExpressionEvaluator
- ExpressionVariableModel
- ExternalStorage
- FeatureCheckListModel
- FeatureGatherer
- FeatureHistory
- FeatureListModel
- FeatureListModelSelection
- FeatureModel
- Featureutils
- Fileutils
- FocusStack
- Geofencer
- Geometry
- GeometryEditorsModel
- GeometryOperationResult
- LayerObserver
- LayerTreeMapCanvasBridge
- LayerUtils
- Layertreemodel
- LocalFilesModel
- Locatormodelsuperbridge
- MessageLogModel
- ModelHelper
- MultiFeatureListModel
- Navigation
- OrderedRelationModel
- Permissions
- Platformutilities
- PluginManager
- Positioning
- PositioningDeviceModel
- PositioningSource
- Positioningutils
- PrintLayoutListModel
- ProcessingAlgorithm
- Processingalgorithmsmodel
- ProjectInfo
- ProjectUtils
- QFieldAppAuthRequestHandler
- QFieldCloudConnection
- QFieldCloudUtils
- Qfieldcloudprojectsmodel
- QgsGeometryWrapper
- QgsQuickCoordinateTransformer
- QgsQuickElevationProfileCanvas
- Qgsquickmapsettings
- RecentProjectListModel
- RelationUtils
- Rubberbandmodel
- SensorListModel
- SerialPortModel
- Settings
- SnappingUtils
- Stringutils
- Tracker
- TrackingModel
- Urlutils
- ValueMapModel
- Vertexmodel
- WebdavConnection
Signature: Q_INVOKABLE void addItemToCanvasActionsToolbar( QQuickItem *item ) const;
Source: appinterface.h:120
Description:
Adds an \a item in the map canvas menu's action toolbar container
Signature: Q_INVOKABLE void addItemToDashboardActionsToolbar( QQuickItem *item ) const;
Source: appinterface.h:125
Description:
Adds an \a item in the dashboard's action toolbar container
Signature: Q_INVOKABLE void addItemToMainMenuActionsToolbar( QQuickItem *item ) const;
Source: appinterface.h:132
Description:
Adds an \a item in the dashboard's action toolbar container \note This function is deprecated and will be removed in the future, use the addItemToDashboardActionsToolbar function instead
Signature: Q_INVOKABLE void addItemToPluginsToolbar( QQuickItem *item ) const;
Source: appinterface.h:115
Description:
Adds an \a item in the plugins toolbar container
Signature: Q_INVOKABLE QVariantMap availableLanguages() const;
Source: appinterface.h:64
Description: No documentation available
Signature: Q_INVOKABLE void clearProject() const;
Source: appinterface.h:105
Description:
Clears the currently opened project
Signature: Q_INVOKABLE void closeSentry() const;
Source: appinterface.h:100
Description:
Closes active sentry connection.
Signature: Q_INVOKABLE bool hasProjectOnLaunch() const;
Source: appinterface.h:48
Description: No documentation available
Signature: Q_INVOKABLE void importUrl( const QString &url );
Source: appinterface.h:46
Description: No documentation available
Signature: Q_INVOKABLE void initiateSentry() const;
Source: appinterface.h:95
Description:
Initalizes sentry connection.
Signature: Q_INVOKABLE bool isAuthenticationConfigurationAvailable( const QString &id ) const;
Source: appinterface.h:71
Description:
Returns TRUE if the authentication configuration \a id is available.
Signature: Q_INVOKABLE bool isFileExtensionSupported( const QString &filename ) const;
Source: appinterface.h:66
Description: No documentation available
Signature: Q_INVOKABLE bool loadFile( const QString &path, const QString &name = QString() );
Source: appinterface.h:49
Description: No documentation available
Signature: Q_INVOKABLE void logMessage( const QString &message );
Source: appinterface.h:78
Description:
Adds a log \a message that will be visible to the user through the message log panel, as well as added into the device's system logs which will be captured by the sentry's reporting framework when enabled.
Signature: Q_INVOKABLE void logRuntimeProfiler();
Source: appinterface.h:85
Description:
Outputs the current runtime profiler model content into the message log panel, as well as added into the device's system logs which will be captured by the sentry's reporting framework when enabled.
Signature: Q_INVOKABLE bool print( const QString &layoutName );
Source: appinterface.h:59
Description: No documentation available
Signature: Q_INVOKABLE bool printAtlasFeatures( const QString &layoutName, const QList<long long> &featureIds );
Source: appinterface.h:60
Description: No documentation available
Signature: Q_INVOKABLE void readProject();
Source: appinterface.h:51
Description: No documentation available
Signature: Q_INVOKABLE bool readProjectBoolEntry( const QString &scope, const QString &key, bool def = false ) const;
Source: appinterface.h:57
Description: No documentation available
Signature: Q_INVOKABLE double readProjectDoubleEntry( const QString &scope, const QString &key, double def = 0.0 ) const;
Source: appinterface.h:56
Description: No documentation available
Signature: Q_INVOKABLE QString readProjectEntry( const QString &scope, const QString &key, const QString &def = QString() ) const;
Source: appinterface.h:54
Description: No documentation available
Signature: Q_INVOKABLE int readProjectNumEntry( const QString &scope, const QString &key, int def = 0 ) const;
Source: appinterface.h:55
Description: No documentation available
Signature: Q_INVOKABLE void reloadProject();
Source: appinterface.h:50
Description: No documentation available
Signature: Q_INVOKABLE void removeRecentProject( const QString &path );
Source: appinterface.h:52
Description: No documentation available
Signature: Q_INVOKABLE void sendLog( const QString &message, const QString &cloudUser );
Source: appinterface.h:90
Description:
Sends a logs reporting through to sentry when enabled.
Signature: Q_INVOKABLE void setScreenDimmerTimeout( int timeoutSeconds );
Source: appinterface.h:62
Description: No documentation available
Signature: Q_INVOKABLE void applyFeatureModel();
Source: attributeformmodel.h:107
Description:
! Applies feature model data such as attribute values, constraints, visibility to the attribute form model
Signature: Q_INVOKABLE void applyParentDefaultValues();
Source: attributeformmodel.h:110
Description:
! Applies default values linked to a parent feature
Signature: Q_INVOKABLE QVariant attribute( const QString &name );
Source: attributeformmodel.h:104
Description:
Get the attribute of the current feature by name \param name the name of the attribute \return value of the attribute
Signature: Q_INVOKABLE bool create();
Source: attributeformmodel.h:92
Description:
Create the current (not existing yet) feature
Signature: Q_INVOKABLE bool deleteFeature();
Source: attributeformmodel.h:97
Description:
Delete the current feature
Signature: Q_INVOKABLE bool save();
Source: attributeformmodel.h:87
Description:
Save the current (already existing) feature
Signature: Q_INVOKABLE void clearDecodedString();
Source: barcodedecoder.h:47
Description:
Clears the decoded string value and sets it to an empty string.
Signature: Q_INVOKABLE int addDevice( const QString &name, const QString &address );
Source: bluetoothdevicemodel.h:71
Description:
Adds a Bluetooth device if not already in the model \param name friendly device name used as identifier in the user interface \param address Bluetooth address of the device \returns returns index of the Bluetooth device
Signature: Q_INVOKABLE int findIndexFromAddress( const QString &address ) const;
Source: bluetoothdevicemodel.h:82
Description:
Returns the row index for a given Bluetooth device address
Signature: Q_INVOKABLE void startServiceDiscovery( const bool fullDiscovery );
Source: bluetoothdevicemodel.h:77
Description:
Starts a scan to discovery nearby Bluetooth devices \param fullDiscovery set to TRUE to trigger a more expensive scan
Signature: Q_INVOKABLE QString addBookmarkAtPoint( QgsPoint point, const QString &name = QString(), const QString &group = QString() );
Source: bookmarkmodel.h:56
Description: No documentation available
Signature: Q_INVOKABLE QgsCoordinateReferenceSystem getBookmarkCrs( const QString &id );
Source: bookmarkmodel.h:64
Description: No documentation available
Signature: Q_INVOKABLE QgsPoint getBookmarkPoint( const QString &id );
Source: bookmarkmodel.h:62
Description: No documentation available
Signature: Q_INVOKABLE void removeBookmark( const QString &id );
Source: bookmarkmodel.h:60
Description: No documentation available
Signature: Q_INVOKABLE void setExtentFromBookmark( const QModelIndex &index );
Source: bookmarkmodel.h:54
Description: No documentation available
Signature: Q_INVOKABLE void updateBookmarkDetails( const QString &id, const QString &name, const QString &group );
Source: bookmarkmodel.h:58
Description: No documentation available
Signature: Q_INVOKABLE void request();
Source: changelogcontents.h:59
Description:
Initiates a HTTP request to obtain the changelog contents. @see markdownChanged() @see statusChanged()
Signature: Q_INVOKABLE void copyFeatureToClipboard( const QgsFeature &feature, bool includeGeometry = false );
Source: clipboardmanager.h:50
Description:
Copies a feature into the system's clipboard in both plain text as well as HTML. \param feature the feature from which the attributes will be copied into memory \param includeGeometry set to TRUE when a WKT string representation of the geometry should be included
Signature: Q_INVOKABLE void copyFeatureToClipboard( QgsVectorLayer *layer, QgsFeatureId fid, bool includeGeometry = false );
Source: clipboardmanager.h:59
Description:
Copies a feature into the system's clipboard in both plain text as well as HTML. \param layer the vector layer associated to the feature \param fid the id of the feature \param includeGeometry set to TRUE when a WKT string representation of the geometry should be included
Signature: Q_INVOKABLE QgsFeature pasteFeatureFromClipboard();
Source: clipboardmanager.h:65
Description:
Returns a feature with attributes and geometry matching clipboard values when a feature has been copied into the clipboard.
Signature: static Q_INVOKABLE bool defaultCoordinateOrderForCrsIsXY( const QgsCoordinateReferenceSystem &crs );
Source: coordinatereferencesystemutils.h:54
Description:
! Returns whether the default coordinate order of a given \a crs is XY
Signature: static Q_INVOKABLE QgsCoordinateTransformContext emptyTransformContext() { return QgsCoordinateTransformContext(); } //! Returns whether the default coordinate order of a given \a crs is XY static Q_INVOKABLE bool defaultCoordinateOrderForCrsIsXY( const QgsCoordinateReferenceSystem &crs );
Source: coordinatereferencesystemutils.h:51
Description:
Returns an empty transform context \note This can be used in QML to avoid errors when a parent object pointer goes undefined
Signature: static Q_INVOKABLE QgsCoordinateReferenceSystem fromDescription( const QString &definition ) { return QgsCoordinateReferenceSystem( definition ); } //! Returns an EPGS:4326 WGS84 CRS static Q_INVOKABLE QgsCoordinateReferenceSystem wgs84Crs() { return QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) ); } /** * Returns an invalid CRS * \note This can be used in QML to avoid errors when a parent object pointer goes undefined */ static Q_INVOKABLE QgsCoordinateReferenceSystem invalidCrs() { return QgsCoordinateReferenceSystem(); } /** * Returns an empty transform context * \note This can be used in QML to avoid errors when a parent object pointer goes undefined */ static Q_INVOKABLE QgsCoordinateTransformContext emptyTransformContext() { return QgsCoordinateTransformContext(); } //! Returns whether the default coordinate order of a given \a crs is XY static Q_INVOKABLE bool defaultCoordinateOrderForCrsIsXY( const QgsCoordinateReferenceSystem &crs );
Source: coordinatereferencesystemutils.h:36
Description:
! Returns an CRS matching the provided \a definition.
Signature: static Q_INVOKABLE QgsCoordinateReferenceSystem invalidCrs() { return QgsCoordinateReferenceSystem(); } /** * Returns an empty transform context * \note This can be used in QML to avoid errors when a parent object pointer goes undefined */ static Q_INVOKABLE QgsCoordinateTransformContext emptyTransformContext() { return QgsCoordinateTransformContext(); } //! Returns whether the default coordinate order of a given \a crs is XY static Q_INVOKABLE bool defaultCoordinateOrderForCrsIsXY( const QgsCoordinateReferenceSystem &crs );
Source: coordinatereferencesystemutils.h:45
Description:
Returns an invalid CRS \note This can be used in QML to avoid errors when a parent object pointer goes undefined
Signature: static Q_INVOKABLE QgsCoordinateReferenceSystem wgs84Crs() { return QgsCoordinateReferenceSystem( QStringLiteral( "EPSG:4326" ) ); } /** * Returns an invalid CRS * \note This can be used in QML to avoid errors when a parent object pointer goes undefined */ static Q_INVOKABLE QgsCoordinateReferenceSystem invalidCrs() { return QgsCoordinateReferenceSystem(); } /** * Returns an empty transform context * \note This can be used in QML to avoid errors when a parent object pointer goes undefined */ static Q_INVOKABLE QgsCoordinateTransformContext emptyTransformContext() { return QgsCoordinateTransformContext(); } //! Returns whether the default coordinate order of a given \a crs is XY static Q_INVOKABLE bool defaultCoordinateOrderForCrsIsXY( const QgsCoordinateReferenceSystem &crs );
Source: coordinatereferencesystemutils.h:39
Description:
! Returns an EPGS:4326 WGS84 CRS
Signature: Q_INVOKABLE bool apply();
Source: deltafilewrapper.h:314
Description:
Attempts to apply a delta file. The list of deltas is not being reset after successfull application and should be handled by the caller. @note it is not guaranteed that the project layers have not changed in case of failure @return whether the attempt was successful @todo TEST
Signature: Q_INVOKABLE bool applyReversed();
Source: deltafilewrapper.h:325
Description:
Attempts to apply a delta file in reverse order (resulting in local changes being discarded). The list of deltas is not being reset after successfull application and should be handled by the caller. @note it is not guaranteed that the project layers have not changed in case of failure @return whether the attempt was successful. @todo TEST
Signature: Q_INVOKABLE int count() const;
Source: deltafilewrapper.h:169
Description:
Returns the number of delta elements @return int number of delta elements
Signature: Q_INVOKABLE bool hasError() const;
Source: deltafilewrapper.h:153
Description:
Returns whether the class has encountered I/O error regarding the delta file. If true is returned, the behaviour of the class instance is no more defined. @return bool whether an error has been encountered
Signature: Q_INVOKABLE bool isCreatedFeature( QgsVectorLayer *vl, QgsFeature feature );
Source: deltafilewrapper.h:235
Description:
Returns TRUE if a feature from a given vector layer is recorded as being created in the deltas file. @param vl the vector layer @param feature the feature
Signature: Q_INVOKABLE void reset();
Source: deltafilewrapper.h:115
Description:
Clears the deltas from memory as there are no deltas at all. Does not affect the permanent storage until toFile() is called.
Signature: Q_INVOKABLE void resetId();
Source: deltafilewrapper.h:121
Description:
Assigns a new unique delta file id.
Signature: Q_INVOKABLE bool toFile();
Source: deltafilewrapper.h:217
Description:
Writes deltas file to the permanent storage. @return bool whether write has been successful
Signature: Q_INVOKABLE QString toFileForUpload( const QString &outFileName = QString() ) const;
Source: deltafilewrapper.h:225
Description:
Writes deltas file to the permanent storage with replaced layerIds, ready for upload. @return QString an empty string
Signature: Q_INVOKABLE void addCoordinate( const QgsPoint &point );
Source: digitizinglogger.h:125
Description:
Adds a \a point into the digitizing logs' buffer.
Signature: Q_INVOKABLE void clearCoordinates();
Source: digitizinglogger.h:140
Description:
Clear the points buffer from the digitizing logs.
Signature: Q_INVOKABLE void removeLastCoordinate();
Source: digitizinglogger.h:130
Description:
Removes the last point entered into the digitizing logs' buffer.
Signature: Q_INVOKABLE void writeCoordinates();
Source: digitizinglogger.h:135
Description:
Writes the points buffer to the digitizing logs layer.
Signature: Q_INVOKABLE double convertAreaMeansurement( double area, Qgis::AreaUnit toUnits ) const;
Source: distancearea.h:83
Description: No documentation available
Signature: Q_INVOKABLE double convertLengthMeansurement( double length, Qgis::DistanceUnit toUnits ) const;
Source: distancearea.h:82
Description: No documentation available
Signature: Q_INVOKABLE void clear();
Source: drawingcanvas.h:116
Description:
Clears the drawing canvas. \see isEmpty()
Signature: Q_INVOKABLE void createBlankCanvas( int width, int height, QColor backgroundColor = QColor( 255, 255, 255 ) );
Source: drawingcanvas.h:103
Description:
Creates a blank drawing canvas. \param width the width of the canvas. \param height the height of the canvas. \param backgroundColor the background color of the canvas.
Signature: Q_INVOKABLE void createCanvasFromImage( const QString &path );
Source: drawingcanvas.h:110
Description:
Creates a drawing canvas from a given image which will be the background on which the drawing will be overlayed. \param path the image path.
Signature: Q_INVOKABLE void fitCanvas();
Source: drawingcanvas.h:133
Description:
Fits the drawing canvas to match available width and height.
Signature: Q_INVOKABLE void pan( const QPointF &oldPosition, const QPointF &newPosition );
Source: drawingcanvas.h:138
Description:
Pans the drawing canvas by the distance between two points.
Signature: Q_INVOKABLE QString save() const;
Source: drawingcanvas.h:128
Description:
Saves the drawing canvas to a temporary location. \returns the temporary file path of the saved image.
Signature: Q_INVOKABLE void strokeBegin( const QPointF &point, const QColor color = QColor( 0, 0, 0 ) );
Source: drawingcanvas.h:150
Description:
Begins a stroke operation. \param point the first point of the stroke \param color the color of the stroke
Signature: Q_INVOKABLE void strokeEnd( const QPointF &point );
Source: drawingcanvas.h:162
Description:
Ends the current stroke with a final \a point added to the stroke path. \note The function strokeBegin must have been called prior to this function.
Signature: Q_INVOKABLE void strokeMove( const QPointF &point );
Source: drawingcanvas.h:156
Description:
Adds a new \a point to the current stroke path. \note The function strokeBegin must have been called prior to this function.
Signature: Q_INVOKABLE void undo();
Source: drawingcanvas.h:122
Description:
Undos the last drawing operation. \see isDirty()
Signature: Q_INVOKABLE void zoom( double scale );
Source: drawingcanvas.h:143
Description:
Zooms the drawing canvas by the provided \a scale value.
Signature: Q_INVOKABLE void reloadModel();
Source: drawingtemplatemodel.h:72
Description:
Reloads the drawing template model.
Signature: Q_INVOKABLE static QVariantMap globalVariables();
Source: expressioncontextutils.h:128
Description:
Returns the global context variables. \see setGlobalVariable() \see setGlobalVariables() \see removeGlobalVariable()
Signature: Q_INVOKABLE static QVariantMap layerVariables( QgsMapLayer *layer );
Source: expressioncontextutils.h:49
Description:
Returns a layer context variables. \param layer map layer \see setLayerVariable() \see setLayerVariables() \see removeLayerVariable()
Signature: Q_INVOKABLE static QVariantMap projectVariables( QgsProject *project );
Source: expressioncontextutils.h:89
Description:
Returns a project context variables. \param project project \see setProjectVariable() \see setProjectVariables() \see removeProjectVariable()
Signature: Q_INVOKABLE static void removeGlobalVariable( const QString &name );
Source: expressioncontextutils.h:156
Description:
Removes a global context variable. \param name variable name \see globalVariables() \see setGlobalVariable() \see setGlobalVariables()
Signature: Q_INVOKABLE static void removeLayerVariable( QgsMapLayer *layer, const QString &name );
Source: expressioncontextutils.h:80
Description:
Removes a layer context variable. \param layer map layer \param name variable name \see layerVariables() \see setLayerVariable() \see setLayerVariables()
Signature: Q_INVOKABLE static void removeProjectVariable( QgsProject *project, const QString &name );
Source: expressioncontextutils.h:120
Description:
Removes a project context variable. \param project project \param name variable name \see projectVariables() \see setProjectVariable() \see setProjectVariables()
Signature: Q_INVOKABLE static void setGlobalVariable( const QString &name, const QVariant &value );
Source: expressioncontextutils.h:138
Description:
Sets a global context variable. \param name variable name \param value variable value \see globalVariables() \see setGlobalVariables() \see removeGlobalVariable()
Signature: Q_INVOKABLE static void setGlobalVariables( const QVariantMap &variables );
Source: expressioncontextutils.h:147
Description:
Sets the global context variables. \param variables new set of global variables \see globalVariables() \see setGlobalVariable() \see removeGlobalVariable()
Signature: Q_INVOKABLE static void setLayerVariable( QgsMapLayer *layer, const QString &name, const QVariant &value );
Source: expressioncontextutils.h:60
Description:
Sets a layer context variable. \param layer map layer \param name variable name \param value variable value \see layerVariables() \see setLayerVariables() \see removeLayerVariable()
Signature: Q_INVOKABLE static void setLayerVariables( QgsMapLayer *layer, const QVariantMap &variables );
Source: expressioncontextutils.h:70
Description:
Sets a layer context variables. \param layer map layer \param variables new set of layer variables \see layerVariables() \see setLayerVariable() \see removeLayerVariable()
Signature: Q_INVOKABLE static void setProjectVariable( QgsProject *project, const QString &name, const QVariant &value );
Source: expressioncontextutils.h:100
Description:
Sets a project context variable. \param project project \param name variable name \param value variable value \see projectVariables() \see setProjectVariables() \see removeProjectVariable()
Signature: Q_INVOKABLE static void setProjectVariables( QgsProject *project, const QVariantMap &variables );
Source: expressioncontextutils.h:110
Description:
Sets a project context variables. \param project project \param variables new set of project variables \see projectVariables() \see setProjectVariable() \see removeProjectVariable()
Signature: Q_INVOKABLE QVariant evaluate();
Source: expressionevaluator.h:104
Description:
! Returns the evaluated expression text value
Signature: Q_INVOKABLE int addVariable( VariableScope scope, const QString &name, const QString &value );
Source: expressionvariablemodel.h:53
Description: No documentation available
Signature: Q_INVOKABLE void reloadVariables();
Source: expressionvariablemodel.h:59
Description: No documentation available
Signature: Q_INVOKABLE void removeVariable( VariableScope scope, const QString &name );
Source: expressionvariablemodel.h:55
Description: No documentation available
Signature: Q_INVOKABLE void save();
Source: expressionvariablemodel.h:57
Description: No documentation available
Signature: Q_INVOKABLE void fetch( const QString &url, const QString &authenticationConfigurationId );
Source: externalstorage.h:74
Description:
Triggers a fetch operation to download the content from an external storage and make it available locally. \param url the remote URL of the content \param authenticationConfigurationId the authentication configuration ID used to connect to the external storage endpoint
Signature: Q_INVOKABLE void toggleCheckAll( bool toggleChecked = true );
Source: featurechecklistmodel.h:92
Description:
Sets all element to either checked or unchecked state, depending on \a toggleChecked
Signature: Q_INVOKABLE bool deleteFeature( QgsFeatureId referencingFeatureId );
Source: referencingfeaturelistmodel.h:146
Description:
Deletes a feature regarding the referencing layer and the feature id of the selected child \param referencingFeatureId id of the selected child
Signature: Q_INVOKABLE int getFeatureIdRow( QgsFeatureId featureId );
Source: referencingfeaturelistmodel.h:152
Description:
Returns the row number for a given feature id \param featureId the feature id
Signature: Q_INVOKABLE void reload();
Source: referencingfeaturelistmodel.h:140
Description:
Reloads the model by starting the reload functionality in the gatherer (seperate thread) Sets the property parentPrimariesAvailable
Signature: Q_INVOKABLE bool redo();
Source: featurehistory.h:48
Description:
! Perform redo of the most recent modification step
Signature: Q_INVOKABLE const QString redoMessage();
Source: featurehistory.h:54
Description:
! Get the redo message to be show in the UI. NOTE should be called before calling \a redo.
Signature: Q_INVOKABLE bool undo();
Source: featurehistory.h:45
Description:
! Perform undo of the most recent modification step
Signature: Q_INVOKABLE const QString undoMessage();
Source: featurehistory.h:51
Description:
! Get the undo message to be show in the UI. NOTE should be called before calling \a undo.
Signature: Q_INVOKABLE QVariant dataFromRowIndex( int row, int role ) { return data( index( row, 0, QModelIndex() ), role ); } /** * Returns the first feature matching the key \a value. */ Q_INVOKABLE QgsFeature getFeatureFromKeyValue( const QVariant &value ) const;
Source: featurelistmodel.h:118
Description: No documentation available
Signature: Q_INVOKABLE QList<int> findDisplayValueMatches( const QString &filter ) const;
Source: featurelistmodel.h:155
Description:
Get rows for a given filter string used to match display values.
Signature: Q_INVOKABLE int findKey( const QVariant &key ) const;
Source: featurelistmodel.h:150
Description:
Get the row for a given key value.
Signature: Q_INVOKABLE QgsFeature getFeatureById( QgsFeatureId id ) const;
Source: featurelistmodel.h:128
Description:
Returns the first feature matching the key \a id.
Signature: Q_INVOKABLE QgsFeature getFeatureFromKeyValue( const QVariant &value ) const;
Source: featurelistmodel.h:123
Description:
Returns the first feature matching the key \a value.
Signature: Q_INVOKABLE void clear();
Source: featurelistmodelselection.h:46
Description: No documentation available
Signature: Q_INVOKABLE void toggleSelectedItem( int item );
Source: featurelistmodelselection.h:44
Description: No documentation available
Signature: Q_INVOKABLE void applyGeometryToVertexModel();
Source: featuremodel.h:234
Description:
! Apply the feature geometry to a vertex model if present.
Signature: Q_INVOKABLE void applyVertexModelToGeometry();
Source: featuremodel.h:231
Description:
! Apply the vertex model to the feature geometry. ! \note This shall be used if the feature model is used with the vertex model rather than the geometry and rubberband model
Signature: Q_INVOKABLE void applyVertexModelTopography();
Source: featuremodel.h:237
Description:
! Apply the vertex model changes to editablelayers' topography.
Signature: Q_INVOKABLE bool create();
Source: featuremodel.h:177
Description:
Will create this feature as a new feature on the data source.
Signature: Q_INVOKABLE bool deleteFeature();
Source: featuremodel.h:182
Description:
Deletes the current feature from the data source.
Signature: Q_INVOKABLE void refresh();
Source: featuremodel.h:172
Description:
Will refresh the feature values and geometry from the data source.
Signature: Q_INVOKABLE void reset();
Source: featuremodel.h:167
Description:
Will reset the feature to the original values and dismiss any buffered edits.
Signature: Q_INVOKABLE void resetAttributes( bool partialReset = false );
Source: featuremodel.h:193
Description:
Resets the attribute values of the current feature \param partialReset when set to TRUE, only attributes with default or remembered values will be reset
Signature: Q_INVOKABLE void resetFeature();
Source: featuremodel.h:195
Description: No documentation available
Signature: Q_INVOKABLE void resetFeatureId();
Source: featuremodel.h:197
Description: No documentation available
Signature: Q_INVOKABLE bool save();
Source: featuremodel.h:162
Description:
Will commit the edit buffer of this layer. May change in the future to only commit the changes buffered in this model. @return Success of the operation
Signature: Q_INVOKABLE bool suppressFeatureForm() const;
Source: featuremodel.h:187
Description:
Returns whether the feature form should be suppressed when adding new features.
Signature: Q_INVOKABLE bool updateAttributesFromFeature( const QgsFeature &feature );
Source: featuremodel.h:204
Description:
Update attributes to match that of a given feature \param feature feature from which attributes will be taken \return TRUE if one or more attribute was updated
Signature: Q_INVOKABLE void updateRubberband() const;
Source: featuremodel.h:240
Description:
! Update the linked geometry rubber band to match the feature's geometry
Signature: static Q_INVOKABLE QgsFeature createBlankFeature( const QgsFields &fields = QgsFields(), const QgsGeometry &geometry = QgsGeometry() );
Source: featureutils.h:42
Description:
Returns a new feature with its \a fields completely blank.
Signature: static Q_INVOKABLE QgsFeature createFeature( QgsVectorLayer *layer, const QgsGeometry &geometry = QgsGeometry(), const GnssPositionInformation &positionInformation = GnssPositionInformation(), const CloudUserInformation &cloudUserInformation = CloudUserInformation() );
Source: featureutils.h:47
Description:
Returns a new feature with its fields set to default values.
Signature: static Q_INVOKABLE QString displayName( QgsVectorLayer *layer, const QgsFeature &feature );
Source: featureutils.h:54
Description:
Returns the display name of a given feature. \param layer the vector layer containing the feature \param feature the feature to be named
Signature: static Q_INVOKABLE QgsRectangle extent( QgsQuickMapSettings *mapSettings, QgsVectorLayer *layer, const QgsFeature &feature );
Source: featureutils.h:63
Description:
Returns the map extent encompassig a given feature. \param mapSettings the map settings used to determine the CRS \param layer the vector layer containing the feature \param feature the feature from which the geometry will be used \returns a QgsRectangle extent
Signature: static Q_INVOKABLE QList<QgsFeature> featuresFromJsonString( const QString &string );
Source: featureutils.h:69
Description:
Returns a list of features while attempting to parse a GeoJSON \a string. If the string could not be parsed, an enmpty list will be returned.
Signature: Q_INVOKABLE static QString absolutePath( const QString &filePath );
Source: fileutils.h:53
Description:
! Returns the absolute path of the folder containing the \a filePath.
Signature: Q_INVOKABLE void addImageMetadata( const QString &imagePath, const GnssPositionInformation &positionInformation );
Source: fileutils.h:106
Description: No documentation available
Signature: Q_INVOKABLE void addImageStamp( const QString &imagePath, const QString &text );
Source: fileutils.h:108
Description: No documentation available
Signature: Q_INVOKABLE static QByteArray fileChecksum( const QString &fileName, const QCryptographicHash::Algorithm hashAlgorithm );
Source: fileutils.h:118
Description:
Returns the checksum of a file. An empty QByteArray will be returned if it cannot be calculated. \param fileName file name to get checksum of \param hashAlgorithm hash algorithm (md5, sha1, sha256 etc) \return QByteArray checksum value
Signature: Q_INVOKABLE static QString fileEtag( const QString &fileName, int partSize = 8 * 1024 * 1024 );
Source: fileutils.h:126
Description:
Returns an Object Storage (S3) ETag of a file. An empty string will be returned if it cannot be calculated. \param fileName file name to get checksum of \param partSize maximum size used to divide the file content into parts \return QString Etag value
Signature: Q_INVOKABLE static bool fileExists( const QString &filePath );
Source: fileutils.h:47
Description:
! Returns true if the \a filePath exists (false if it's a directory)
Signature: Q_INVOKABLE static QString fileName( const QString &filePath );
Source: fileutils.h:45
Description:
! Returns the filename of a \a filePath - if no file name exists it's empty
Signature: Q_INVOKABLE static QString fileSuffix( const QString &filePath );
Source: fileutils.h:49
Description:
! Returns the suffix (extension)
Signature: Q_INVOKABLE static QVariantMap getFileInfo( const QString &filePath );
Source: fileutils.h:96
Description:
Gets detailed information about a file including content, MD5 hash and metadata. This is useful for file validation, caching, and efficient file handling in QML. \param filePath The path to the file \return A map containing file metadata and optionally its content
Signature: Q_INVOKABLE static bool isImageMimeTypeSupported( const QString &mimeType );
Source: fileutils.h:43
Description:
! Returns TRUE if the provided mimetype is a supported image
Signature: Q_INVOKABLE static QString mimeTypeName( const QString &filePath );
Source: fileutils.h:41
Description:
! Returns the mimetype of a filepath as string
Signature: Q_INVOKABLE static QByteArray readFileContent( const QString &filePath );
Source: fileutils.h:74
Description:
Reads the entire content of a file and returns it as a byte array. \param filePath The path to the file to be read \return The file content as a QByteArray
Signature: Q_INVOKABLE static QString representFileSize( qint64 bytes );
Source: fileutils.h:51
Description:
! Returns a human-friendly size from bytes
Signature: Q_INVOKABLE void restrictImageSize( const QString &imagePath, int maximumWidthHeight );
Source: fileutils.h:104
Description:
Insures that a given image's width and height are restricted to a maximum size. \param imagePath the image file path \param maximumWidthHeight the maximum width and height size
Signature: Q_INVOKABLE static bool writeFileContent( const QString &filePath, const QByteArray &content );
Source: fileutils.h:88
Description:
Writes content to a file. \param filePath The path to the file to be written \param content The content to write to the file \return True if the write operation was successful, false otherwise \note Platform restrictions apply:
- On Android: Writing is only permitted within the app's internal storage or properly requested scoped storage locations.
- On iOS: Writing is restricted to the app's sandbox.
- Use PlatformUtilities.applicationDirectory() to get a safe write location.
Signature: Q_INVOKABLE void addFocusTaker( QObject *object );
Source: focusstack.h:30
Description: No documentation available
Signature: Q_INVOKABLE void forceActiveFocusOnLastTaker() const;
Source: focusstack.h:31
Description: No documentation available
Signature: Q_INVOKABLE void applyProjectSettings( QgsProject *project );
Source: geofencer.h:67
Description:
Sets the polygon layer holding areas from a given \a project.
Signature: Q_INVOKABLE void applyRubberband();
Source: geometry.h:43
Description: No documentation available
Signature: Q_INVOKABLE void addEditor( const QString &name, const QString &icon, const QString &toolbar, SupportedGeometries supportedGeometries = AllGeometries );
Source: geometryeditorsmodel.h:59
Description: No documentation available
Signature: Q_INVOKABLE static bool supportsGeometry( const QgsGeometry &geometry, const SupportedGeometries &supportedGeometries );
Source: geometryeditorsmodel.h:61
Description: No documentation available
Signature: static Q_INVOKABLE GeometryOperationResult addRingFromRubberband( QgsVectorLayer *layer, QgsFeatureId fid, RubberbandModel *rubberBandModel );
Source: geometryutils.h:80
Description:
! Adds a ring to a polygon with given \a fid using the ring in the rubberband model.
Signature: static Q_INVOKABLE QgsRectangle boundingBox( const QgsGeometry &geometry ) { return geometry.boundingBox(); } //! Returns a reprojected \a rectangle from the stated \a sourceCrs to a \a destinationCrs. static Q_INVOKABLE QgsRectangle reprojectRectangle( const QgsRectangle &rectangle, const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );
Source: geometryutils.h:113
Description:
! Returns the bounding box of a given \a geometry.
Signature: static Q_INVOKABLE QgsPoint centroid( const QgsGeometry &geometry );
Source: geometryutils.h:107
Description:
! Creates a centroid point from a given \a geometry.
Signature: static Q_INVOKABLE QgsPoint coordinateToPoint( const QGeoCoordinate &coor );
Source: geometryutils.h:89
Description:
! Converts QGeoCoordinate to QgsPoint.
Signature: static Q_INVOKABLE QgsGeometry createGeometryFromWkt( const QString &wkt );
Source: geometryutils.h:110
Description:
! Creates a geometry from a WKT string.
Signature: static Q_INVOKABLE double distanceBetweenPoints( const QgsPoint &start, const QgsPoint &end );
Source: geometryutils.h:92
Description:
! Returns the distance between a pair of \a start and \a end points.
Signature: static Q_INVOKABLE QgsPoint emptyPoint() { return QgsPoint(); } //! Creates a point from \a x and \a y with optional \a z and \a values static Q_INVOKABLE QgsPoint point( double x, double y, double z = std::numeric_limits<double>::quiet_NaN(), double m = std::numeric_limits<double>::quiet_NaN() ) { return QgsPoint( x, y, z, m ); } //! Creates a centroid point from a given \a geometry. static Q_INVOKABLE QgsPoint centroid( const QgsGeometry &geometry );
Source: geometryutils.h:101
Description:
! Returns an empty (i.e. null) point.
Signature: static Q_INVOKABLE GeometryOperationResult eraseFromRubberband( QgsVectorLayer *layer, QgsFeatureId fid, RubberbandModel *rubberBandModel );
Source: geometryutils.h:77
Description:
! Reshape a polygon with given \a fid using the ring in the rubberband model.
Signature: static Q_INVOKABLE QgsGeometry lineFromRubberband( RubberbandModel *rubberBandModel, const QgsCoordinateReferenceSystem &crs, Qgis::WkbType wkbType = Qgis::WkbType::Unknown );
Source: geometryutils.h:68
Description:
! Returns a QgsGeometry with a line by using the point sequence in the rubberband model.
Signature: static Q_INVOKABLE QgsPoint point( double x, double y, double z = std::numeric_limits<double>::quiet_NaN(), double m = std::numeric_limits<double>::quiet_NaN() ) { return QgsPoint( x, y, z, m ); } //! Creates a centroid point from a given \a geometry. static Q_INVOKABLE QgsPoint centroid( const QgsGeometry &geometry );
Source: geometryutils.h:104
Description:
! Creates a point from \a x and \a y with optional \a z and \a values
Signature: static Q_INVOKABLE QgsGeometry polygonFromRubberband( RubberbandModel *rubberBandModel, const QgsCoordinateReferenceSystem &crs, Qgis::WkbType wkbType = Qgis::WkbType::Unknown );
Source: geometryutils.h:65
Description:
! Returns a QgsGeometry with a polygon by using the point sequence in the rubberband model.
Signature: static Q_INVOKABLE QgsPoint reprojectPoint( const QgsPoint &point, const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );
Source: geometryutils.h:98
Description:
! Returns a reprojected \a point from the stated \a sourceCrs to a \a destinationCrs.
Signature: static Q_INVOKABLE QgsPoint reprojectPointToWgs84( const QgsPoint &point, const QgsCoordinateReferenceSystem &crs );
Source: geometryutils.h:95
Description:
! Returns a reprojected \a point from the stated \a crs to WGS84.
Signature: static Q_INVOKABLE QgsRectangle reprojectRectangle( const QgsRectangle &rectangle, const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );
Source: geometryutils.h:116
Description:
! Returns a reprojected \a rectangle from the stated \a sourceCrs to a \a destinationCrs.
Signature: static Q_INVOKABLE GeometryOperationResult reshapeFromRubberband( QgsVectorLayer *layer, QgsFeatureId fid, RubberbandModel *rubberBandModel );
Source: geometryutils.h:74
Description:
! Reshape a polygon with given \a fid using the ring in the rubberband model.
Signature: static Q_INVOKABLE GeometryOperationResult splitFeatureFromRubberband( QgsVectorLayer *layer, RubberbandModel *rubberBandModel );
Source: geometryutils.h:86
Description:
Performs a split using the line in the rubberband model. \note Requires a given vector layer to have selected feature(s).
Signature: static Q_INVOKABLE QgsGeometry variableWidthBufferByMFromRubberband( RubberbandModel *rubberBandModel, const QgsCoordinateReferenceSystem &crs );
Source: geometryutils.h:71
Description:
! Creates a variable width buffer polygon using M values from a rubberband model
Signature: Q_INVOKABLE void reset( bool isHardReset = false ) const;
Source: layerobserver.h:55
Description:
Clears the current delta file changes
Signature: Q_INVOKABLE void setCanvasLayers();
Source: layertreemapcanvasbridge.h:76
Description:
! force update of canvas layers from the layer tree. Normally this should not be needed to be called.
Signature: Q_INVOKABLE static bool addFeature( QgsVectorLayer *layer, QgsFeature feature );
Source: layerutils.h:134
Description:
Adds a \a feature into the \a layer. \note The function will not call startEditing() and commitChanges()
Signature: Q_INVOKABLE void close() { mFeatureIterator.close();
Source: layerutils.h:72
Description: No documentation available
Signature: Q_INVOKABLE static FeatureIterator createFeatureIteratorFromExpression( QgsVectorLayer *layer, const QString &expression );
Source: layerutils.h:150
Description:
Returns a feature iterator to get features matching a given \a expression within the provided \a layer.
Signature: Q_INVOKABLE static QString fieldType( const QgsField &field );
Source: layerutils.h:140
Description:
Returns the QVariant typeName of a \a field. This is a stable identifier (compared to the provider field name).
Signature: Q_INVOKABLE static bool hasMValue( QgsVectorLayer *layer );
Source: layerutils.h:145
Description:
Returns TRUE if the vector \a layer geometry has an M value.
Signature: Q_INVOKABLE bool hasNext() { if ( !mHasNextChecked ) { mHasNext = mFeatureIterator.nextFeature( mCurrentFeature );
Source: layerutils.h:49
Description: No documentation available
Signature: static Q_INVOKABLE bool isAtlasCoverageLayer( QgsVectorLayer *layer );
Source: layerutils.h:110
Description:
Returns TRUE if the vector layer is used as an atlas coverage layer in any of the print layouts of the currently opened project. \param layer the vector layer to check against print layouts
Signature: Q_INVOKABLE QgsFeature next() { if ( !mHasNextChecked ) { mFeatureIterator.nextFeature( mCurrentFeature );
Source: layerutils.h:59
Description: No documentation available
Signature: static Q_INVOKABLE void selectFeaturesInLayer( QgsVectorLayer *layer, const QList<int> &fids, Qgis::SelectBehavior behavior = Qgis::SelectBehavior::SetSelection );
Source: layerutils.h:119
Description:
Selects features in a layer This method is required since QML cannot perform the conversion of a feature ID to a QgsFeatureId \param layer the vector layer \param fids the list of feature IDs \param behavior the selection behavior
Signature: Q_INVOKABLE QVariant data( const QModelIndex &index, int role ) const override;
Source: layertreemodel.h:158
Description: No documentation available
Signature: Q_INVOKABLE void freeze();
Source: layertreemodel.h:76
Description:
! Freezes the model as is, with any source model signals ignored
Signature: Q_INVOKABLE void freeze();
Source: layertreemodel.h:173
Description:
! Freezes the model as is, with any source model signals ignored
Signature: Q_INVOKABLE QgsRectangle nodeExtent( const QModelIndex &index, QgsQuickMapSettings *mapSettings, const float buffer );
Source: layertreemodel.h:87
Description:
! Calculate layer tree node extent and add optional buffer
Signature: Q_INVOKABLE QgsRectangle nodeExtent( const QModelIndex &index, QgsQuickMapSettings *mapSettings, const float buffer = 0.02 );
Source: layertreemodel.h:187
Description:
! Calculate layer tree node extent
Signature: Q_INVOKABLE bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
Source: layertreemodel.h:159
Description: No documentation available
Signature: Q_INVOKABLE void unfreeze( bool resetModel = false );
Source: layertreemodel.h:78
Description:
! Unfreezes the model and resume listening to source model signals
Signature: Q_INVOKABLE void unfreeze( bool resetModel = false );
Source: layertreemodel.h:175
Description:
! Unfreezes the model and resume listening to source model signals
Signature: Q_INVOKABLE void updateCurrentMapTheme();
Source: layertreemodel.h:71
Description:
! Update map theme as currently used by the model ! This should be triggered after a project has been loaded
Signature: Q_INVOKABLE void updateCurrentMapTheme();
Source: layertreemodel.h:168
Description:
! Update map theme as currently used by the model ! This should be triggered after a project has been loaded
Signature: Q_INVOKABLE void addToFavorites( const QString &path );
Source: localfilesmodel.h:113
Description:
! Adds the \a path to the favorites list
Signature: Q_INVOKABLE void clearSelection();
Source: localfilesmodel.h:146
Description:
! Set checked state of all items to false
Signature: Q_INVOKABLE bool isPathFavoriteEditable( const QString &path );
Source: localfilesmodel.h:110
Description:
! Returns whether \a path's favorite state is editable
Signature: Q_INVOKABLE void moveUp();
Source: localfilesmodel.h:137
Description:
! Walks the navigation history back up on step
Signature: Q_INVOKABLE void removeFromFavorites( const QString &path );
Source: localfilesmodel.h:116
Description:
! Removes the \a path to the favorites list
Signature: Q_INVOKABLE void resetToPath( const QString &path );
Source: localfilesmodel.h:107
Description:
! Resets the model and sets the first navigation history item to the provided \a path
Signature: Q_INVOKABLE void resetToRoot();
Source: localfilesmodel.h:104
Description:
! Resets the model and sets the first navigation history item to root
Signature: Q_INVOKABLE void setChecked( const int &mIdx, const bool &checked );
Source: localfilesmodel.h:143
Description:
! Set checked state of an item in list
Signature: Q_INVOKABLE void deregisterQFieldLocatorFilter( QFieldLocatorFilter *filter );
Source: locatormodelsuperbridge.h:153
Description:
Deregisters a given \a filter with the locator.
Signature: Q_INVOKABLE QString getLocatorModelDescription( const int row );
Source: locatormodelsuperbridge.h:136
Description:
Returns the description for a given locator search result list item.
Signature: Q_INVOKABLE QString getPrefixFromSearchString( const QString &string );
Source: locatormodelsuperbridge.h:143
Description:
Looks for and if present returns the locator filter prefix from a given search string. If not prefix is detected, an empty string will be returned.
Signature: Q_INVOKABLE void registerQFieldLocatorFilter( QFieldLocatorFilter *filter );
Source: locatormodelsuperbridge.h:148
Description:
Registers a given \a filter with the locator.
Signature: Q_INVOKABLE void requestSearch( const QString &text );
Source: locatormodelsuperbridge.h:120
Description:
Requests a \a text query against the search bar.
Signature: Q_INVOKABLE void setGeocoderLocatorFiltersDefaulByPosition( const GnssPositionInformation &position );
Source: locatormodelsuperbridge.h:217
Description: No documentation available
Signature: Q_INVOKABLE void triggerResultAtRow( const int row, const int id = -1 );
Source: locatormodelsuperbridge.h:171
Description: No documentation available
Signature: Q_INVOKABLE void clear();
Source: messagelogmodel.h:73
Description:
! Clears any messages from the log
Signature: Q_INVOKABLE void suppress( const QVariantMap &filters );
Source: messagelogmodel.h:68
Description:
! activates suppression of messages with specific tag and an expression
Signature: Q_INVOKABLE void unsuppress( const QVariantMap &filters );
Source: messagelogmodel.h:70
Description:
! deactivates suppression of messages with specific tag and an expression
Signature: Q_INVOKABLE QVariant data( int row, int column, QString roleName );
Source: modelhelper.h:37
Description: No documentation available
Signature: Q_INVOKABLE QModelIndex index( int row, int column );
Source: modelhelper.h:33
Description: No documentation available
Signature: Q_INVOKABLE int role( QString roleName );
Source: modelhelper.h:35
Description: No documentation available
Signature: Q_INVOKABLE void clear( const bool keepSelected = false );
Source: multifeaturelistmodel.h:84
Description:
Resets the model to either an empty feature list or one that contains only the selected features. \param keepSelected if set to TRUE, selected features will be kept when resetting the model.
Signature: Q_INVOKABLE void clearSelection();
Source: multifeaturelistmodel.h:89
Description:
Empties the list of selected features.
Signature: Q_INVOKABLE bool deleteFeature( QgsVectorLayer *layer, QgsFeatureId fid );
Source: multifeaturelistmodel.h:137
Description:
Deletes a feature from a vector layer \param layer The layer from which a feature will be removed \param fid The id of the feature to remove
Signature: Q_INVOKABLE bool deleteSelection();
Source: multifeaturelistmodel.h:140
Description:
! Deletes selected features
Signature: Q_INVOKABLE bool duplicateFeature( QgsVectorLayer *layer, const QgsFeature &feature );
Source: multifeaturelistmodel.h:148
Description:
Duplicates a feature on a given layer \param layer The layer within which the feature will be duplicated \param feature The feature to be duplicated
Signature: Q_INVOKABLE bool duplicateSelection();
Source: multifeaturelistmodel.h:151
Description:
! Duplicates selected features onto their associated layer
Signature: Q_INVOKABLE bool mergeSelection();
Source: multifeaturelistmodel.h:129
Description:
Merges selected features by updating the first seleted feature's geometry to a combination (i.e. union) of geometries of all selected features. All but the first feature will then be removed from the vector layer containing the selected features.
Signature: Q_INVOKABLE bool moveSelection( const double x, const double y );
Source: multifeaturelistmodel.h:154
Description:
! Moves selected features along a given \a vector.
Signature: Q_INVOKABLE bool rotateSelection( const double angle );
Source: multifeaturelistmodel.h:157
Description:
! Rotate selected features along a given \a vector.
Signature: Q_INVOKABLE void setFeatures( QgsVectorLayer *vl, const QString &filter, const QgsRectangle &extent = QgsRectangle() );
Source: multifeaturelistmodel.h:73
Description:
Resets the model to contain features found from a \a vl with the possibility of filtering by a \a filter expression and/or an \a extent.
Signature: Q_INVOKABLE void toggleSelectedItem( int item );
Source: multifeaturelistmodel.h:163
Description:
Toggles the selection state of a given item. \param item the item's row number
Signature: Q_INVOKABLE void clear();
Source: navigation.h:198
Description:
Clears any existing destination point and feature.
Signature: Q_INVOKABLE void clearDestinationFeature();
Source: navigation.h:119
Description:
Clears the current destination feature, as well as the current destination point.
Signature: Q_INVOKABLE void nextDestinationVertex();
Source: navigation.h:125
Description:
Sets the destination point to the next vertex or centroid of the current destination feature. \note if a destination feature has not been provided, calling this function does nothing
Signature: Q_INVOKABLE void previousDestinationVertex();
Source: navigation.h:131
Description:
Sets the destination point to the previous vertex or centroid of the current destination feature. \note if a destination feature has not been provided, calling this function does nothing
Signature: Q_INVOKABLE void setDestinationFeature( const QgsFeature &feature, QgsVectorLayer *layer );
Source: navigation.h:114
Description:
Sets a provided feature as navigation destination, which allows for users to cycle through the feature centroid and its individual vertices as destination point. \param feature the feature used as destination \param layer the vector layer associated to the feature
Signature: Q_INVOKABLE bool moveItems( const int fromIdx, const int toIdx );
Source: orderedrelationmodel.h:56
Description: No documentation available
Signature: Q_INVOKABLE void triggerViewCurrentFeatureChange( int index );
Source: orderedrelationmodel.h:58
Description: No documentation available
Signature: Q_INVOKABLE void request();
Source: permissions.h:43
Description:
Requests the permission.
Signature: Q_INVOKABLE void request();
Source: permissions.h:76
Description:
Requests the permission.
Signature: Q_INVOKABLE virtual QStringList appDataDirs() const;
Source: platformutilities.h:113
Description:
\returns a list of data directories where user data is searched. User data are pg_service.conf, authentication config, grids, ...
Signature: Q_INVOKABLE virtual QString applicationDirectory() const;
Source: platformutilities.h:125
Description:
The main application directory within which projects and datasets can be imported.
Signature: Q_INVOKABLE QStringList availableGrids() const;
Source: platformutilities.h:114
Description: No documentation available
Signature: Q_DECL_DEPRECATED Q_INVOKABLE virtual bool checkCameraPermissions() const;
Source: platformutilities.h:240
Description:
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
Signature: Q_DECL_DEPRECATED Q_INVOKABLE virtual bool checkMicrophonePermissions() const;
Source: platformutilities.h:248
Description:
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
Signature: Q_DECL_DEPRECATED Q_INVOKABLE virtual bool checkPositioningPermissions() const;
Source: platformutilities.h:232
Description:
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
Signature: Q_INVOKABLE virtual void copyTextToClipboard( const QString &string ) const;
Source: platformutilities.h:274
Description:
Copies a text \a string to the system clipboard.
Signature: Q_INVOKABLE bool createDir( const QString &path, const QString &dirname ) const;
Source: platformutilities.h:117
Description:
TODO: move these functions to fileutils. Make sure to adjust any qml code relying on this.
Signature: Q_INVOKABLE virtual void dimBrightness() { return; };
Source: platformutilities.h:259
Description:
Dims the brightness of the screen on supported devices.
Signature: Q_INVOKABLE virtual void exportDatasetTo( const QString &path ) const;
Source: platformutilities.h:153
Description:
! Exports a dataset \a path to a user-specified location
Signature: Q_INVOKABLE virtual void exportFolderTo( const QString &path ) const;
Source: platformutilities.h:151
Description:
! Exports a folder \a path to a user-specified location
Signature: Q_INVOKABLE virtual QString getTextFromClipboard() const;
Source: platformutilities.h:279
Description:
Returns the current text from the system clipboard.
Signature: Q_INVOKABLE virtual void importDatasets() const;
Source: platformutilities.h:142
Description:
! Requests and imports one or more datasets into QField's application directory action
Signature: Q_INVOKABLE virtual void importProjectArchive() const;
Source: platformutilities.h:140
Description:
! Requests and imports a project archive into QField's application directory action
Signature: Q_INVOKABLE virtual void importProjectFolder() const;
Source: platformutilities.h:138
Description:
! Requests and imports a project folder into QField's application directory action
Signature: Q_INVOKABLE virtual bool isSystemDarkTheme() const;
Source: platformutilities.h:299
Description:
Returns TRUE is the system uses a dark theme.
Signature: Q_INVOKABLE virtual void removeDataset( const QString &path ) const;
Source: platformutilities.h:161
Description:
! Removes a given dataset \a path
Signature: Q_INVOKABLE virtual void removeFolder( const QString &path ) const;
Source: platformutilities.h:165
Description:
! Removes a given folder \a path
Signature: Q_INVOKABLE bool renameFile( const QString &oldFilePath, const QString &newFilePath, bool overwrite = true ) const;
Source: platformutilities.h:119
Description: No documentation available
Signature: Q_INVOKABLE virtual void requestStoragePermission() const {};
Source: platformutilities.h:317
Description: No documentation available
Signature: Q_INVOKABLE virtual void restoreBrightness() { return; };
Source: platformutilities.h:264
Description:
Restores the brightness of the screen to its original value on supported devices.
Signature: Q_INVOKABLE bool rmFile( const QString &filename ) const;
Source: platformutilities.h:118
Description: No documentation available
Signature: Q_INVOKABLE virtual QVariantMap sceneMargins( QQuickWindow *window ) const;
Source: platformutilities.h:284
Description:
Returns margins ("top", "right", "bottom", "left") within which interactive elements should not be drawn.
Signature: Q_INVOKABLE virtual void sendCompressedFolderTo( const QString &path ) const;
Source: platformutilities.h:158
Description:
! Compresses a folder \a path and sends it via the platform native API
Signature: Q_INVOKABLE virtual void sendDatasetTo( const QString &path ) const;
Source: platformutilities.h:156
Description:
! Sends a dataset \a path via the platform native API
Signature: Q_INVOKABLE virtual void setHandleVolumeKeys( const bool handle ) { Q_UNUSED( handle ); } /** * Copies a text \a string to the system clipboard. */ Q_INVOKABLE virtual void copyTextToClipboard( const QString &string ) const;
Source: platformutilities.h:269
Description:
Sets whether the device volume keys are handled by QField.
Signature: Q_INVOKABLE virtual void setScreenLockPermission( const bool allowLock ) { Q_UNUSED( allowLock ); } /** * Dims the brightness of the screen on supported devices. */ Q_INVOKABLE virtual void dimBrightness() { return; };
Source: platformutilities.h:254
Description:
Sets whether the device screen is allowed to go in lock mode. @param allowLock if set to FALSE, the screen will not be allowed to lock.
Signature: Q_INVOKABLE virtual double systemFontPointSize() const;
Source: platformutilities.h:289
Description:
Returns the default system font size.
Signature: Q_INVOKABLE virtual void updateProjectFromArchive( const QString &projectPath ) const;
Source: platformutilities.h:148
Description:
Update a local project content from a user-picked archive file action \param projectPath the project file path
Signature: Q_INVOKABLE virtual void uploadPendingAttachments( QFieldCloudConnection *connection ) const;
Source: platformutilities.h:294
Description:
Uploads any pending attachments linked to the logged in user account.
Signature: Q_INVOKABLE virtual void vibrate( int milliseconds ) const { Q_UNUSED( milliseconds ) } /** * Starts a positioning service on supported platforms. */ virtual void startPositioningService() const {} /** * Starts a positioning service on supported platforms. */ virtual void stopPositioningService() const {} Q_INVOKABLE virtual void requestStoragePermission() const {};
Source: platformutilities.h:304
Description:
Vibrates the device on supported platforms.
Signature: Q_INVOKABLE void clearPluginPermissions();
Source: pluginmanager.h:95
Description: No documentation available
Signature: Q_INVOKABLE void configureAppPlugin( const QString &uuid );
Source: pluginmanager.h:101
Description: No documentation available
Signature: Q_INVOKABLE void denyRequestedPluginPermission( bool permanent = false );
Source: pluginmanager.h:93
Description: No documentation available
Signature: Q_INVOKABLE void disableAppPlugin( const QString &uuid );
Source: pluginmanager.h:100
Description: No documentation available
Signature: Q_INVOKABLE void enableAppPlugin( const QString &uuid );
Source: pluginmanager.h:99
Description: No documentation available
Signature: Q_INVOKABLE void grantRequestedPluginPermission( bool permanent = false );
Source: pluginmanager.h:92
Description: No documentation available
Signature: Q_INVOKABLE void installFromUrl( const QString &url );
Source: pluginmanager.h:109
Description: No documentation available
Signature: Q_INVOKABLE bool isAppPluginConfigurable( const QString &uuid ) const;
Source: pluginmanager.h:104
Description: No documentation available
Signature: Q_INVOKABLE bool isAppPluginEnabled( const QString &uuid ) const;
Source: pluginmanager.h:103
Description: No documentation available
Signature: Q_INVOKABLE void uninstall( const QString &uuid );
Source: pluginmanager.h:110
Description: No documentation available
Signature: Q_INVOKABLE QList<GnssPositionInformation> getBackgroundPositionInformation() const;
Source: positioning.h:239
Description:
Returns a list of position information collected while background mode is active. \see backgroundMode() \see setBackgroundMode()
Signature: Q_INVOKABLE int addDevice( const Type &type, const QString &name, const QVariantMap &deviceSettings );
Source: positioningdevicemodel.h:84
Description:
Adds a positioning device to the user settings \param type device type \param name friendly device name used as identifier in the user interface \param deviceSettings settings map (used to generate the positioning device ID, editing, etc.) \returns returns index of the added device
Signature: Q_INVOKABLE const QString deviceId( const Device &device ) const;
Source: positioningdevicemodel.h:95
Description:
Returns the device ID string for a specific \a device \note this is the string to be used with the Positioning deviceId property
Signature: Q_INVOKABLE int findIndexFromDeviceId( const QString &id );
Source: positioningdevicemodel.h:100
Description:
Returns the row index for a given device ID
Signature: Q_INVOKABLE void reloadModel();
Source: positioningdevicemodel.h:75
Description:
Reloads the model from the user settings
Signature: Q_INVOKABLE void removeDevice( const QString &name );
Source: positioningdevicemodel.h:89
Description:
Removes the positioning device \a name from the user settings
Signature: Q_INVOKABLE QString deviceId() const { return mDeviceId; } /** * Sets the positioning device \a id used to fetch position information. * \note A blank string will connect the internal positioning device;
Source: positioningsource.h:100
Description:
Returns the current positioning device \a id used to fetch position information. \see setDevice
Signature: Q_INVOKABLE QList<GnssPositionInformation> getBackgroundPositionInformation() const;
Source: positioningsource.h:218
Description:
Returns a list of position information collected while background mode is active. \see backgroundMode() \see setBackgroundMode()
Signature: static Q_INVOKABLE GnssPositionInformation averagedPositionInformation( const QList<QVariant> &positionsInformation );
Source: positioningutils.h:56
Description:
Returns an average GnssPositionInformation from a list of position information
Signature: static Q_INVOKABLE double bearingTrueNorth( const QgsPoint &position, const QgsCoordinateReferenceSystem &crs );
Source: positioningutils.h:61
Description:
Returns the true north bearing from a given position and CRS
Signature: static Q_INVOKABLE GnssPositionInformation createEmptyGnssPositionInformation();
Source: positioningutils.h:46
Description:
Creates an empty GnssPositionInformation.
Signature: static Q_INVOKABLE GnssPositionInformation createGnssPositionInformation( double latitude, double longitude, double altitude, double speed, double direction, double horizontalAccuracy, double verticalAcurracy, double verticalSpeed, double magneticVariation, const QDateTime ×tamp, const QString &sourceName );
Source: positioningutils.h:41
Description:
Creates a GnssPositionInformation with values. The status will be set to "A"ctive by default.
Signature: Q_INVOKABLE void reloadModel();
Source: printlayoutlistmodel.h:79
Description:
!triggered when set another project
Signature: Q_INVOKABLE const QString titleAt( int row ) const;
Source: printlayoutlistmodel.h:76
Description: No documentation available
Signature: Q_INVOKABLE bool run( bool previewMode = false );
Source: processingalgorithm.h:131
Description:
Executes the algorithm.
Signature: Q_INVOKABLE void rebuild();
Source: processingalgorithmsmodel.h:73
Description:
! Rebuilds the algorithms model.
Signature: Q_INVOKABLE void rebuild();
Source: processingalgorithmsmodel.h:143
Description:
! Rebuilds the algorithms model.
Signature: Q_INVOKABLE QVariantMap getCopyrightDecorationConfiguration();
Source: projectinfo.h:193
Description:
! Retrieves configuration of the copyright decoration
Signature: Q_INVOKABLE QVariantMap getGridDecorationConfiguration();
Source: projectinfo.h:199
Description:
! Retrieves configuration of the grid decoration
Signature: Q_INVOKABLE QVariantMap getImageDecorationConfiguration();
Source: projectinfo.h:196
Description:
! Retrieves configuration of the image decoration
Signature: Q_INVOKABLE QVariantMap getTitleDecorationConfiguration();
Source: projectinfo.h:190
Description:
! Retrieves configuration of the title decoration
Signature: Q_INVOKABLE void restoreCloudUserInformation();
Source: projectinfo.h:176
Description:
Restores last saved cloud user information details attached to the current project
Signature: Q_INVOKABLE QModelIndex restoreTracker( QgsVectorLayer *layer );
Source: projectinfo.h:182
Description:
! Restore the last tracking session that occured within a vector \a layer.
Signature: Q_INVOKABLE void saveLayerRememberedFields( QgsMapLayer *layer );
Source: projectinfo.h:130
Description:
Saves the vector \a layer fields that are remembered during feature additions
Signature: Q_INVOKABLE void saveLayerSnappingConfiguration( QgsMapLayer *layer );
Source: projectinfo.h:125
Description:
Saves the current snapping configuration settings
Signature: Q_INVOKABLE void saveLayerStyle( QgsMapLayer *layer );
Source: projectinfo.h:115
Description:
Saves the \a layer style to the current project information settings
Signature: Q_INVOKABLE void saveLayerTreeState();
Source: projectinfo.h:120
Description:
Saves the current state (visibility and collapse status) of the layer tree
Signature: Q_INVOKABLE void saveTracker( QgsVectorLayer *layer );
Source: projectinfo.h:179
Description:
! Save an ongoing vector \a layer tracking session details
Signature: Q_INVOKABLE void saveVariable( const QString &name, const QString &value );
Source: projectinfo.h:184
Description: No documentation available
Signature: Q_INVOKABLE static QVariantMap mapLayers( QgsProject *project = nullptr );
Source: projectutils.h:38
Description:
Returns a map of all registered layers by layer ID. \note This function mimics QgsProject::mapLayers with a return type that is QML compatible.
Signature: Q_INVOKABLE Qgis::TransactionMode transactionMode( QgsProject *project = nullptr );
Source: projectutils.h:44
Description:
Returns the transaction mode for a given \a project. \note To be removed when QField updates to QGIS 3.38.
Signature: Q_INVOKABLE void abortAuthBrowser();
Source: qfieldappauthrequesthandler.h:62
Description:
! abort an ongoing external browser authentication request
Signature: Q_INVOKABLE void clearStoredRealms();
Source: qfieldappauthrequesthandler.h:59
Description:
! clears the stored realms
Signature: Q_INVOKABLE void enterCredentials( const QString &realm, const QString &username, const QString &password );
Source: qfieldappauthrequesthandler.h:53
Description:
! stores the credentials after the information is entered in the login dialog
Signature: Q_INVOKABLE bool handleLayerLogins();
Source: qfieldappauthrequesthandler.h:56
Description:
! handles each realm after the project has been loaded
Signature: Q_INVOKABLE void getAuthenticationProviders();
Source: qfieldcloudconnection.h:167
Description: No documentation available
Signature: Q_INVOKABLE void login( const QString &password = QString() );
Source: qfieldcloudconnection.h:164
Description: No documentation available
Signature: Q_INVOKABLE void logout();
Source: qfieldcloudconnection.h:165
Description: No documentation available
Signature: Q_INVOKABLE static void addPendingAttachments( const QString &projectId, const QStringList &fileNames, QFieldCloudConnection *cloudConnection = nullptr, const bool &checkSumCheck = false );
Source: qfieldcloudutils.h:151
Description:
Adds an array of files and/or folders for a given cloud project to the pending upload attachments list. If \a checkSumCheck is true, checks file checksums with the server; otherwise, adds all files without validation. @param projectId The project ID for which files are added. @param fileNames The list of file and/or folder path(s) to be added. @param cloudConnection The cloud connection used to fetch file data. @param checkSumCheck Whether to validate files by comparing checksums with the server.
Signature: Q_INVOKABLE static QString documentationFromErrorString( const QString &errorString );
Source: qfieldcloudutils.h:128
Description:
Returns a documentation page hyperlink related to the provided error string. @param errorString the error string to be processed @return The hyperlink to the documentation page related to the provided error code, or an empty string if no match is found.
Signature: Q_INVOKABLE static const QString getProjectId( const QString &fileName );
Source: qfieldcloudutils.h:112
Description:
Returns the cloud project id. @param fileName file name of the project to be checked @return const QString either UUID-like string or a null string in case of failure
Signature: Q_INVOKABLE static bool hasPendingAttachments();
Source: qfieldcloudutils.h:137
Description:
! Returns TRUE if pending attachments are detected.
Signature: Q_INVOKABLE static QString userFriendlyErrorString( const QString &errorString );
Source: qfieldcloudutils.h:120
Description:
Returns a user-friendly error message. @param errorString the error string to be processed. @return A user-friendly error message that will be displayed to the user, translated based on received error code.
Signature: Q_INVOKABLE bool discardLocalChangesFromCurrentProject();
Source: qfieldcloudprojectsmodel.h:258
Description:
! Discards the delta records of the current cloud project.
Signature: Q_INVOKABLE QVariantMap getProjectData( const QString &projectId ) const;
Source: qfieldcloudprojectsmodel.h:240
Description:
! Returns the cloud project data for given \a projectId.
Signature: Q_INVOKABLE void projectCancelDownload( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:285
Description:
! Cancels ongoing cloud project download with \a projectId.
Signature: Q_INVOKABLE ProjectModifications projectModification( const QString &projectId ) const;
Source: qfieldcloudprojectsmodel.h:264
Description:
! Returns the cloud project modification for given \a projectId.
Signature: Q_INVOKABLE void projectPackageAndDownload( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:282
Description:
! Downloads a cloud project with given \a projectId and all of its files.
Signature: Q_INVOKABLE void projectSetAutoPushEnabled( const QString &projectId, bool enabled );
Source: qfieldcloudprojectsmodel.h:291
Description:
! Toggles the cloud project auto-push enabled state
Signature: Q_INVOKABLE void projectSetAutoPushIntervalMins( const QString &projectId, int minutes );
Source: qfieldcloudprojectsmodel.h:294
Description:
! Sets the interval in \a minutes between which the project will auto-push changes
Signature: Q_INVOKABLE void projectSetForceAutoPush( const QString &projectId, bool force );
Source: qfieldcloudprojectsmodel.h:288
Description:
! Forces the cloud project auto-push enabled state to be TRUE
Signature: Q_INVOKABLE ProjectStatus projectStatus( const QString &projectId ) const;
Source: qfieldcloudprojectsmodel.h:261
Description:
! Returns the cloud project status for given \a projectId.
Signature: Q_INVOKABLE void projectUpload( const QString &projectId, const bool shouldDownloadUpdates );
Source: qfieldcloudprojectsmodel.h:246
Description:
! Pushes all local deltas for given \a projectId. If \a shouldDownloadUpdates is true, also calls downloadProject.
Signature: Q_INVOKABLE void refreshProjectDeltaList( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:249
Description:
! Retreives the delta list for a given \a projectId.
Signature: Q_INVOKABLE void refreshProjectFileOutdatedStatus( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:270
Description:
! Refreshes the project file (.qgs, .qgz) outdated status.
Signature: Q_INVOKABLE void refreshProjectModification( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:267
Description:
! Updates the project modification for given \a projectId.
Signature: Q_INVOKABLE void refreshProjectsList( bool shouldRefreshPublic = false, int projectFetchOffset = 0 );
Source: qfieldcloudprojectsmodel.h:243
Description:
! Requests the cloud projects list from the server. If \a shouldRefreshPublic is false, it will refresh only user's project, otherwise will refresh the public projects only, starting from \a projectFetchOffset for pagination.
Signature: Q_INVOKABLE void removeLocalProject( const QString &projectId );
Source: qfieldcloudprojectsmodel.h:252
Description:
! Remove local cloud project with given \a projectId from the device storage
Signature: Q_INVOKABLE bool revertLocalChangesFromCurrentProject();
Source: qfieldcloudprojectsmodel.h:255
Description:
! Reverts the deltas of the current cloud project. The changes would applied in reverse order and opposite methods, e.g. "delete" becomes "create".
Signature: Q_INVOKABLE void clear();
Source: qgsgeometrywrapper.h:51
Description:
! Clear the wrapper by setting empty geometry and invalid CRS
Signature: Q_INVOKABLE QVariantList pointList() const;
Source: qgsgeometrywrapper.h:48
Description:
! Returns a list of points if the geometry has point type (point, multipoint), an empty list otherwise
Signature: Q_INVOKABLE QgsPoint transformPosition( const QgsPoint &position ) const;
Source: qgsquickcoordinatetransformer.h:128
Description: No documentation available
Signature: Q_INVOKABLE void clear();
Source: qgsquickelevationprofilecanvas.h:281
Description:
Clears the current profile.
Signature: Q_INVOKABLE void populateLayersFromProject();
Source: qgsquickelevationprofilecanvas.h:89
Description:
Populates the current profile with elevation-enabled layers from the associated project.
Signature: Q_INVOKABLE void refresh();
Source: qgsquickelevationprofilecanvas.h:71
Description:
Triggers a complete regeneration of the profile, causing the profile extraction to perform in the background.
Signature: Q_INVOKABLE void zoomFull();
Source: qgsquickelevationprofilecanvas.h:270
Description:
Zooms to the full extent of the profile.
Signature: Q_INVOKABLE void zoomFullInRatio();
Source: qgsquickelevationprofilecanvas.h:276
Description:
Zooms to the full extent of the profile while maintaining X and Y axes' length ratio. \note This method only makes sense with CRSes having matching map units and elevation units types.
Signature: Q_INVOKABLE QPointF coordinateToScreen( const QgsPoint &point ) const;
Source: qgsquickmapsettings.h:196
Description:
Convert a map coordinate to screen pixel coordinates \param point A coordinate in map coordinates \return A coordinate in pixel / screen space
Signature: Q_INVOKABLE QgsPoint screenToCoordinate( const QPointF &point ) const;
Source: qgsquickmapsettings.h:205
Description:
Convert a screen coordinate to a map coordinate \param point A coordinate in pixel / screen coordinates \return A coordinate in map coordinates
Signature: Q_INVOKABLE void setCenter( const QgsPoint ¢er, bool handleMargins = false );
Source: qgsquickmapsettings.h:169
Description:
! Move current map extent to have center point defined by \a center
Signature: Q_INVOKABLE void setCenterToLayer( QgsMapLayer *layer, bool shouldZoom = true );
Source: qgsquickmapsettings.h:172
Description:
! Move current map extent to have center point defined by \a layer. Optionally only pan to the layer if \a shouldZoom is false.
Signature: Q_INVOKABLE void setExtent( const QgsRectangle &extent, bool handleMargins = false );
Source: qgsquickmapsettings.h:157
Description:
! \copydoc QgsMapSettings::setExtent()
Signature: Q_INVOKABLE void setExtentFromPoints( const QVariantList &points, const double &minimumScale = 0, bool handleMargins = false );
Source: qgsquickmapsettings.h:175
Description:
! Move current map extent to center around the list of \a points provided
Signature: Q_INVOKABLE QgsCoordinateTransformContext transformContext() const;
Source: qgsquickmapsettings.h:187
Description:
! \copydoc QgsMapSettings::transformContext()
Signature: Q_INVOKABLE void reloadModel();
Source: recentprojectlistmodel.h:73
Description: No documentation available
Signature: Q_INVOKABLE QgsRelation resolveReferencingRelation( QgsProject *project, QgsVectorLayer *layer, const QString &fieldName, const QString &relationId );
Source: relationutils.h:33
Description: No documentation available
Signature: Q_INVOKABLE void addVertex();
Source: rubberbandmodel.h:149
Description:
! Add vertex from the current position
Signature: Q_INVOKABLE void addVertexFromPoint( const QgsPoint &point );
Source: rubberbandmodel.h:152
Description:
! Add vertex with a given point
Signature: Q_INVOKABLE QgsPointSequence pointSequence( const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem(), Qgis::WkbType wkbType = Qgis::WkbType::Point, bool closeLine = false ) const;
Source: rubberbandmodel.h:146
Description:
The target CRS into which points should be reprojected. To retrieve unprojected points pass an invalid QgsCoordinateReferenceSystem object. By default coordinates will be returned unprojected.
Signature: Q_INVOKABLE void removeVertex();
Source: rubberbandmodel.h:155
Description:
! Remove the vertex at the current index
Signature: Q_INVOKABLE void reset();
Source: rubberbandmodel.h:158
Description:
! Reset the model, remove all vertices and restart the vertex index
Signature: Q_INVOKABLE void connectSensorId( const QString &id ) const;
Source: sensorlistmodel.h:57
Description:
Connects a sensor. \param id The unique ID string of the sensor
Signature: Q_INVOKABLE void disconnectSensorId( const QString &id ) const;
Source: sensorlistmodel.h:63
Description:
Disconnects a sensor. \param id The unique ID string of the sensor
Signature: Q_INVOKABLE int findIndexFromName( const QString &name ) const;
Source: serialportmodel.h:56
Description:
Returns the row index for a given serial port \a name.
Signature: Q_INVOKABLE void refresh();
Source: serialportmodel.h:51
Description:
Refresh the list of available serial ports.
Signature: Q_INVOKABLE void remove( const QString &key );
Source: settings.h:54
Description:
Removes the given \a key from settings.
Signature: Q_INVOKABLE void setValue( const QString &key, const QVariant &value );
Source: settings.h:33
Description: No documentation available
Signature: Q_INVOKABLE void sync();
Source: settings.h:59
Description:
Writes any unsaved changes to permanent storage, and reloads the settings.
Signature: Q_INVOKABLE QVariant value( const QString &key, const QVariant &defaultValue );
Source: settings.h:35
Description: No documentation available
Signature: Q_INVOKABLE bool valueBool( const QString &key, bool defaultValue );
Source: settings.h:42
Description:
Properly evaluates the returned value to be boolean. If the normal value() is used instead, a string "true" or "false" will be returned which will be evaluated to true either way by JS.
Signature: Q_INVOKABLE int valueInt( const QString &key, int defaultValue );
Source: settings.h:49
Description:
Properly evaluates the returned value to be int. If the normal value() is used instead, a string "1" or "-456" will be returned.
Signature: static Q_INVOKABLE QgsSnappingConfig emptySnappingConfig() { return QgsSnappingConfig(); } signals: void enabledChanged();
Source: snappingutils.h:62
Description:
Returns an empty snapping configuration object \note This can be used in QML to avoid errors when a parent object pointer goes undefined
Signature: static Q_INVOKABLE QString createUuid();
Source: stringutils.h:45
Description:
! Returns a new UUID string
Signature: static Q_INVOKABLE bool hasLinks( const QString &string );
Source: stringutils.h:42
Description:
! Returns whether a string contains one or more URLs
Signature: static Q_INVOKABLE QString highlightText( const QString &string, const QString &highlightText, const QColor &highlightColor = QColor() );
Source: stringutils.h:51
Description:
! Returns a string highlighting a text using HTML formatting
Signature: static Q_INVOKABLE QString insertLinks( const QString &string );
Source: stringutils.h:39
Description:
! Returns a string with any URL (e.g., http(s)/ftp) and mailto: text converted to valid HTML <a …> links
Signature: static Q_INVOKABLE QString pointInformation( const QgsPoint &point, const QgsCoordinateReferenceSystem &crs );
Source: stringutils.h:54
Description:
! Returns a string containing the \a point location and details of the \a crs
Signature: Q_INVOKABLE void processPositionInformation( const GnssPositionInformation &positionInformation, const QgsPoint &projectedPosition );
Source: tracker.h:150
Description:
! Process the given position information and projected position passed onto the tracker
Signature: Q_INVOKABLE void createProjectTrackers( QgsProject *project );
Source: trackingmodel.h:53
Description:
! Creates tracking sessions defined in a project being opened
Signature: Q_INVOKABLE QModelIndex createTracker( QgsVectorLayer *layer );
Source: trackingmodel.h:55
Description:
! Creates a tracking session for the provided vector \a layer.
Signature: Q_INVOKABLE bool featureInTracking( QgsVectorLayer *layer, QgsFeatureId featureId );
Source: trackingmodel.h:63
Description:
! Returns TRUE if the \a featureId is attached to a vector \a layer tracking session.
Signature: Q_INVOKABLE bool featuresInTracking( QgsVectorLayer *layer, const QList<QgsFeature> &features );
Source: trackingmodel.h:65
Description:
! Returns TRUE if the list of \a features is attached to a vector \a layer tracking session.
Signature: Q_INVOKABLE bool layerInTracking( QgsVectorLayer *layer );
Source: trackingmodel.h:67
Description:
! Returns TRUE if the vector \a layer has a tracking session.
Signature: Q_INVOKABLE void replayPositionInformationList( const QList<GnssPositionInformation> &positionInformationList, QgsQuickCoordinateTransformer *coordinateTransformer = nullptr );
Source: trackingmodel.h:72
Description:
! Replays a list of position information for all active trackers
Signature: Q_INVOKABLE void requestTrackingSetup( QgsVectorLayer *layer, bool skipSettings = false );
Source: trackingmodel.h:84
Description:
Forwards a tracking setup request to the user interface consisting of a settings panel followed by a feature form (unless suppressed by the project configuration). \a layer the vector layer associated with the tracking \a skipSettings set to TRUE if the settings panel should be omitted and only show the feature form
Signature: Q_INVOKABLE void setTrackerVisibility( QgsVectorLayer *layer, bool visible );
Source: trackingmodel.h:61
Description:
! Sets whether the tracking session rubber band is \a visible.
Signature: Q_INVOKABLE void startTracker( QgsVectorLayer *layer, const GnssPositionInformation &positionInformation = GnssPositionInformation(), const QgsPoint &projectedPosition = QgsPoint() );
Source: trackingmodel.h:57
Description:
! Starts tracking for the provided vector \a layer provided it has a tracking session created.
Signature: Q_INVOKABLE void stopTracker( QgsVectorLayer *layer );
Source: trackingmodel.h:59
Description:
! Stops the tracking session of the provided vector \a layer.
Signature: Q_INVOKABLE void suspendUntilReplay();
Source: trackingmodel.h:74
Description: No documentation available
Signature: static Q_INVOKABLE QUrl fromString( const QString &string );
Source: urlutils.h:41
Description:
! Returns a URL from a \a string with logic to handle local paths
Signature: static Q_INVOKABLE bool isRelativeOrFileUrl( const QString &url );
Source: urlutils.h:38
Description:
Checks whether the provided string is a relative \a url (has no protocol or starts with file://).
Signature: Q_INVOKABLE QVariant keyForValue( const QString &value ) const;
Source: valuemapmodel.h:78
Description:
Returns the key for a value or an invalid QVariant if not found.
Signature: Q_INVOKABLE int keyToIndex( const QVariant &key ) const;
Source: valuemapmodel.h:73
Description:
Returns the row (index) of a key or -1 if not found.
Signature: Q_INVOKABLE void addVertexNearestToPosition( const QgsPoint &mapPoint );
Source: vertexmodel.h:197
Description:
! Adds a new vertex on the segment having its mid-point nearest to the \a mapPoint
Signature: Q_INVOKABLE void clear();
Source: vertexmodel.h:179
Description:
! This will clear the data
Signature: Q_INVOKABLE void next();
Source: vertexmodel.h:188
Description:
! next vertex or segment
Signature: Q_INVOKABLE void previous();
Source: vertexmodel.h:185
Description:
! previous vertex or segment
Signature: Q_INVOKABLE void removeCurrentVertex();
Source: vertexmodel.h:199
Description: No documentation available
Signature: Q_INVOKABLE void reset();
Source: vertexmodel.h:182
Description:
! Reset the model to its original geometry
Signature: Q_INVOKABLE void selectVertexAtPosition( const QPointF &point, double threshold, bool autoInsert = true );
Source: vertexmodel.h:191
Description:
! Selects the vertex at the given screen \a point within a given \a threshold
Signature: Q_INVOKABLE void undoHistory();
Source: vertexmodel.h:264
Description: No documentation available
Signature: Q_INVOKABLE void updateGeometry( const QgsGeometry &geometry );
Source: vertexmodel.h:207
Description:
sets the geometry to the given \a geometry but preserves the index of the current vertex
this is used to update the original geometry while still editing the model
\see geometry property
Signature: Q_INVOKABLE void cancelRequest();
Source: webdavconnection.h:180
Description:
Cancels a requested download or upload operation. \see confirmationRequested \see isDownloadingPath \see isUploadingPath
Signature: Q_INVOKABLE void confirmRequest();
Source: webdavconnection.h:172
Description:
Launches a requested download or upload operation. \see confirmationRequested \see isDownloadingPath \see isUploadingPath
Signature: Q_INVOKABLE void downloadPath( const QString &localPath );
Source: webdavconnection.h:156
Description:
Download new and modified files from an imported remote path. \a localPath the local path within which a remote path was imported into \note This is not a synchronization process; files removed remotely will not be removed locally. Furthermore, all files modified remotely will overwrite locally-stored files.
Signature: Q_INVOKABLE void fetchAvailablePaths();
Source: webdavconnection.h:141
Description:
Fetches available remote paths from the current WebDAV endpoint.
Signature: Q_INVOKABLE static void forgetHistory( const QString &url = QString(), const QString &username = QString() );
Source: webdavconnection.h:193
Description: No documentation available
Signature: Q_INVOKABLE static bool hasWebdavConfiguration( const QString &path );
Source: webdavconnection.h:186
Description:
Returns TRUE if a given path contains a WebDAV configuration JSON file or is parented to a folder containing such a file.
Signature: Q_INVOKABLE static QVariantMap importHistory();
Source: webdavconnection.h:191
Description:
Returns a list of import history.
Signature: Q_INVOKABLE void importPath( const QString &remotePath, const QString &localPath );
Source: webdavconnection.h:148
Description:
Imports a remote path into a local path stored on the device. \a remotePath the remote path on the WebDAV endpoint. \a localPath the local path
Signature: Q_INVOKABLE void uploadPaths( const QStringList &localPaths );
Source: webdavconnection.h:164
Description:
Upload one or more file and/or folder to a WebDAV endpoint tied to the imported remote path. \a localPaths a list of files and folder parented to a local path within which a remote path was imported into \note This is not a synchronization process; files removed locally will not be removed remotely. Furthermore, all files modified locally will overwrite remotely-stored files.