Skip to content

Commit

Permalink
Add some class/method documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mhugent committed Jul 23, 2015
1 parent 1498107 commit ebe4f92
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
1 change: 1 addition & 0 deletions src/app/nodetool/qgsnodeeditor.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class QgsSelectedFeature;
class QgsVectorLayer;
class QTableWidget;

/** A widget to select and edit the vertex coordinates of a geometry numerically*/
class QgsNodeEditor : public QDockWidget
{
Q_OBJECT
Expand Down
13 changes: 10 additions & 3 deletions src/gui/qgsgeometryrubberband.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class QgsAbstractGeometryV2;
class QgsPointV2;
struct QgsVertexId;

/** A rubberband class for QgsAbstractGeometryV2 (considering curved geometries)*/
class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem
{
public:
Expand Down Expand Up @@ -63,15 +64,21 @@ class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem

/** Sets geometry (takes ownership). Geometry is expected to be in map coordinates */
void setGeometry( QgsAbstractGeometryV2* geom );
/** Returns a pointer to the geometry*/
const QgsAbstractGeometryV2* geometry() { return mGeometry; }

/** Moves vertex to new position (in map coordinates)*/
void moveVertex( const QgsVertexId& id, const QgsPointV2& newPos );

/** Sets fill color for vertex markers*/
void setFillColor( const QColor& c );
/** Sets outline color for vertex markes*/
void setOutlineColor( const QColor& c );
/** Sets outline width*/
void setOutlineWidth( int width );
void setLineStyle( Qt::PenStyle penStyle );
/** Sets pen style*/
void setLineStyle( Qt::PenStyle penStyle )
/** Sets brush style*/
void setBrushStyle( Qt::BrushStyle brushStyle );
/** Sets vertex marker icon type*/
void setIconType( IconType iconType ) { mIconType = iconType; }

protected:
Expand Down

0 comments on commit ebe4f92

Please sign in to comment.