Skip to content
Permalink
Browse files

Add comments for new functions

  • Loading branch information
mhugent committed Jun 20, 2012
1 parent 2ef84cc commit 31e504124af327ced35686fa77bf53f800a4a379
Showing with 18 additions and 1 deletion.
  1. +9 −0 python/core/qgsproject.sip
  2. +9 −1 src/core/qgsproject.h
@@ -240,12 +240,21 @@ public:
@note added in 1.4 */
void setBadLayerHandler( QgsProjectBadLayerHandler* handler );

/**Convenience function to set snap settings per layer
@note added in version 1.9*/
void setSnapSettingsForLayer( const QString& layerId, bool enabled, QgsSnapper::SnappingType type, QgsTolerance::UnitType unit, double tolerance, bool avoidIntersection );

/**Convenience function to query snap settings of a layer
@note added in version 1.9*/
bool snapSettingsForLayer( const QString& layerId, bool& enabled /Out/, QgsSnapper::SnappingType& type /Out/, QgsTolerance::UnitType& units /Out/, double& tolerance /Out/,
bool& avoidIntersection /Out/ );

/**Convenience function to set topological editing
@note added in version 1.9*/
void setTopologicalEditing( bool enabled );

/**Convenience function to query topological editing status
@note added in version 1.9*/
bool topologicalEditing() const;

protected:
@@ -290,14 +290,22 @@ class CORE_EXPORT QgsProject : public QObject
bool createEmbeddedLayer( const QString& layerId, const QString& projectFilePath, QList<QDomNode>& brokenNodes,
QList< QPair< QgsVectorLayer*, QDomElement > >& vectorLayerList, bool saveFlag = true );

//convenience interface for querying / modifying the project snap settings per layer
/**Convenience function to set snap settings per layer
@note added in version 1.9*/
void setSnapSettingsForLayer( const QString& layerId, bool enabled, QgsSnapper::SnappingType type, QgsTolerance::UnitType unit, double tolerance,
bool avoidIntersection );

/**Convenience function to query snap settings of a layer
@note added in version 1.9*/
bool snapSettingsForLayer( const QString& layerId, bool& enabled, QgsSnapper::SnappingType& type, QgsTolerance::UnitType& units, double& tolerance,
bool& avoidIntersection ) const;

/**Convenience function to set topological editing
@note added in version 1.9*/
void setTopologicalEditing( bool enabled );

/**Convenience function to query topological editing status
@note added in version 1.9*/
bool topologicalEditing() const;

protected:

0 comments on commit 31e5041

Please sign in to comment.
You can’t perform that action at this time.