Add missing docs

This commit is contained in:
Nyall Dawson 2016-08-02 07:26:11 +10:00
parent 4b78b1c208
commit d075b128a8
6 changed files with 47 additions and 0 deletions

View File

@ -794,6 +794,10 @@ class QgsGeometry
//! Allows direct construction of QVariants from geometry.
operator QVariant() const;
/** Returns true if the geometry is non empty (ie, isEmpty() returns false),
* or false if it is an empty, uninitialised geometry (ie, ieEmpty() returns true).
* @note added in QGIS 3.0
*/
operator bool() const;
}; // class QgsGeometry

View File

@ -145,7 +145,13 @@ class QgsVectorLayerEditBuffer : QObject
void featureAdded( QgsFeatureId fid );
void featureDeleted( QgsFeatureId fid );
/** Emitted when a feature's geometry is changed.
* @param fid feature ID
* @param geom new feature geometry
*/
void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom );
void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant & );
void attributeAdded( int idx );
void attributeDeleted( int idx );

View File

@ -4,7 +4,21 @@ class QgsHighlight : QgsMapCanvasItem
#include <qgshighlight.h>
%End
public:
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated map layer
*/
//QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsMapLayer *layer );
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated vector layer
*/
QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsVectorLayer *layer );
~QgsHighlight();
/** Set line/outline to color, polygon fill to color with alpha = 63.

View File

@ -845,6 +845,10 @@ class CORE_EXPORT QgsGeometry
return QVariant::fromValue( *this );
}
/** Returns true if the geometry is non empty (ie, isEmpty() returns false),
* or false if it is an empty, uninitialised geometry (ie, ieEmpty() returns true).
* @note added in QGIS 3.0
*/
operator bool() const;
private:

View File

@ -172,7 +172,13 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject
void featureAdded( QgsFeatureId fid );
void featureDeleted( QgsFeatureId fid );
/** Emitted when a feature's geometry is changed.
* @param fid feature ID
* @param geom new feature geometry
*/
void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom );
void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant & );
void attributeAdded( int idx );
void attributeDeleted( int idx );

View File

@ -35,8 +35,21 @@ class QgsSymbolV2;
class GUI_EXPORT QgsHighlight: public QgsMapCanvasItem
{
public:
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated map layer
*/
QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsMapLayer *layer );
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated vector layer
*/
QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsVectorLayer *layer );
/** Constructor for highlighting true feature shape using feature attributes
* and renderer.
* @param mapCanvas map canvas