diff --git a/python/PyQt6/core/auto_generated/qgssnappingutils.sip.in b/python/PyQt6/core/auto_generated/qgssnappingutils.sip.in index 0c15bb21b4ab..10f4c1f5d1ef 100644 --- a/python/PyQt6/core/auto_generated/qgssnappingutils.sip.in +++ b/python/PyQt6/core/auto_generated/qgssnappingutils.sip.in @@ -206,7 +206,18 @@ Returns the list of extra snapping layers %End QgsDigitizingGuideLayer *guideLayer() const; +%Docstring +Returns the map guide layer + +.. versionadded:: 3.36 +%End + void setGuideLayer( QgsDigitizingGuideLayer *guideLayer ); +%Docstring +Sets the map guide layer + +.. versionadded:: 3.36 +%End public slots: diff --git a/python/core/auto_generated/qgssnappingutils.sip.in b/python/core/auto_generated/qgssnappingutils.sip.in index 0c15bb21b4ab..10f4c1f5d1ef 100644 --- a/python/core/auto_generated/qgssnappingutils.sip.in +++ b/python/core/auto_generated/qgssnappingutils.sip.in @@ -206,7 +206,18 @@ Returns the list of extra snapping layers %End QgsDigitizingGuideLayer *guideLayer() const; +%Docstring +Returns the map guide layer + +.. versionadded:: 3.36 +%End + void setGuideLayer( QgsDigitizingGuideLayer *guideLayer ); +%Docstring +Sets the map guide layer + +.. versionadded:: 3.36 +%End public slots: diff --git a/src/core/qgsdigitizingguidelayer.h b/src/core/qgsdigitizingguidelayer.h index 873b33cfcd09..ab95402359af 100644 --- a/src/core/qgsdigitizingguidelayer.h +++ b/src/core/qgsdigitizingguidelayer.h @@ -32,7 +32,7 @@ class QgsLineSymbol; /** * \ingroup core - * @brief The QgsDigitizingGuideLayer class holds map guides information saved in the project file. + * \brief The QgsDigitizingGuideLayer class holds map guides information saved in the project file. * * \since QGIS 3.36 */ @@ -56,7 +56,7 @@ class CORE_EXPORT QgsDigitizingGuideLayer : public QgsAnnotationLayer //! Adds a line guide void addLineGuide( QgsCurve *curve SIP_TRANSFER, const QString &title, QList details = QList(), const QDateTime &creation = QDateTime::currentDateTime() ); - //! Return the guides + //! Returns the guides std::pair, QList > guides() const; //! Returns the model diff --git a/src/core/qgssnappingutils.h b/src/core/qgssnappingutils.h index d95f4c31152f..4d0486b19f3a 100644 --- a/src/core/qgssnappingutils.h +++ b/src/core/qgssnappingutils.h @@ -232,7 +232,16 @@ class CORE_EXPORT QgsSnappingUtils : public QObject return mExtraSnapLayers; } + /** + * Returns the map guide layer + * \since QGIS 3.36 + */ QgsDigitizingGuideLayer *guideLayer() const; + + /** + * Sets the map guide layer + * \since QGIS 3.36 + */ void setGuideLayer( QgsDigitizingGuideLayer *guideLayer ); public slots: diff --git a/src/gui/advanceddigitizing/qgsdigitizingguidewidget.h b/src/gui/advanceddigitizing/qgsdigitizingguidewidget.h index 379a2ff50c84..77c6e7e69044 100644 --- a/src/gui/advanceddigitizing/qgsdigitizingguidewidget.h +++ b/src/gui/advanceddigitizing/qgsdigitizingguidewidget.h @@ -28,29 +28,29 @@ class QgsMapCanvas; /** * \ingroup core - * @brief The QgsDigitizingGuideLayer class holds map guides information saved in the project file. + * \brief The QgsDigitizingGuideLayer class holds map guides information saved in the project file. * * \since QGIS 3.36 */ class GUI_EXPORT QgsDigitizingGuideWidget : public QWidget, private Ui::QgsDigitizingGuideWidget { - Q_OBJECT -public: - explicit QgsDigitizingGuideWidget(QgsMapCanvas *canvas, QWidget *parent = nullptr); + Q_OBJECT + public: + explicit QgsDigitizingGuideWidget( QgsMapCanvas *canvas, QWidget *parent = nullptr ); -signals: + signals: -private: - void enableGuideMapTool(); + private: + void enableGuideMapTool(); - void guideSelectionChanged(const QItemSelection &selected, const QItemSelection &deselected); + void guideSelectionChanged( const QItemSelection &selected, const QItemSelection &deselected ); - void removeButtonClicked(); + void removeButtonClicked(); - QgsMapCanvas* mCanvas = nullptr; - QgsDigitizingGuideLayer* mGuideLayer = nullptr; + QgsMapCanvas *mCanvas = nullptr; + QgsDigitizingGuideLayer *mGuideLayer = nullptr; - QMap mGuidesMapTools; + QMap mGuidesMapTools; }; diff --git a/src/gui/qgsdigitizingguidemaptool.h b/src/gui/qgsdigitizingguidemaptool.h index bbdd3160e7fb..01a674166b60 100644 --- a/src/gui/qgsdigitizingguidemaptool.h +++ b/src/gui/qgsdigitizingguidemaptool.h @@ -62,7 +62,7 @@ class GUI_EXPORT QgsDigitizingGuideToolUserInputWidget : public QWidget, private /** * \ingroup gui - * @brief The QgsDigitizingGuideMapTool is a base class for map tools drawing map guides + * \brief The QgsDigitizingGuideMapTool is a base class for map tools drawing map guides * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapTool : public QgsMapTool @@ -91,7 +91,7 @@ class GUI_EXPORT QgsDigitizingGuideMapTool : public QgsMapTool /** * \ingroup gui - * @brief The QgsDigitizingGuideMapToolDistanceToPoints is a map tool to place a point guide at a given distance to 2 points + * \brief The QgsDigitizingGuideMapToolDistanceToPoints is a map tool to place a point guide at a given distance to 2 points * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapToolDistanceToPoints : public QgsDigitizingGuideMapTool @@ -119,7 +119,7 @@ class GUI_EXPORT QgsDigitizingGuideMapToolDistanceToPoints : public QgsDigitizin /** * \ingroup gui - * @brief The QgsDigitizingGuideMapToolLineAbstract is an absctract class for line extension/parallel/perpendicular implementations + * \brief The QgsDigitizingGuideMapToolLineAbstract is an absctract class for line extension/parallel/perpendicular implementations * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapToolLineAbstract : public QgsDigitizingGuideMapTool @@ -135,6 +135,7 @@ class GUI_EXPORT QgsDigitizingGuideMapToolLineAbstract : public QgsDigitizingGui void deactivate() override; protected: + //! Updates the rubber band using the constructed line void updateRubberBand( QgsLineString *line ); bool mHasOffset = false; @@ -160,7 +161,7 @@ class GUI_EXPORT QgsDigitizingGuideMapToolLineAbstract : public QgsDigitizingGui /** * \ingroup gui - * @brief The QgsDigitizingGuideMapToolLineExtension is a map tool to place a line guide as an extension of a segment + * \brief The QgsDigitizingGuideMapToolLineExtension is a map tool to place a line guide as an extension of a segment * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapToolLineExtension : public QgsDigitizingGuideMapToolLineAbstract @@ -176,7 +177,7 @@ class GUI_EXPORT QgsDigitizingGuideMapToolLineExtension : public QgsDigitizingGu /** * \ingroup gui - * @brief The QgsDigitizingGuideMapToolLineParallel is a map tool to place a line guide as a parallel to a segment + * \brief The QgsDigitizingGuideMapToolLineParallel is a map tool to place a line guide as a parallel to a segment * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapToolLineParallel : public QgsDigitizingGuideMapToolLineAbstract @@ -189,9 +190,10 @@ class GUI_EXPORT QgsDigitizingGuideMapToolLineParallel : public QgsDigitizingGui private: QgsLineString *createLine( const QgsPointXY &point, double offset = 0 ) override; }; + /** * \ingroup gui - * @brief The QgsDigitizingGuideMapToolLinePerpendicular is a map tool to place a line guide as a perpendicular to a segment + * \brief The QgsDigitizingGuideMapToolLinePerpendicular is a map tool to place a line guide as a perpendicular to a segment * \since QGIS 3.34 */ class GUI_EXPORT QgsDigitizingGuideMapToolLinePerpendicular : public QgsDigitizingGuideMapToolLineAbstract