sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-04-14 00:07:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Prepare commit converts single line doxygen block format

Browse Source 
Flips single line doxygen comments to use the proper single line
format:

/*!< comment */   to   //!< Comment

and

/** comment */    to   //! Comment
This commit is contained in:
Nyall Dawson 2016-10-25 09:17:39 +10:00
parent 3ef8e6afca
commit 1367fd09fc
557 changed files with 4682 additions and 4674 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
scripts/unify_includes.pl
View File

@ -28,6 +28,14 @@ END { die "header files not empty" if @inc; }
# Also fix doxygen comments
s#^(\s*)/\*[*!]\s*([^\s*].*)\s*$#$1/** \u$2\n#;
# Convert single line doxygent blocks:
# /*!< comment */ to //!< comment
# /** comment */ to //! comment
s#\/\*[!\*](?!\*)(<*)\h*(.*?)\h*\*\/\h*$#//!$1 $2#;
# Uppercase initial character in //!< comment
s#\/\/!<\s*(.)(.*)#//!< \u$1$2#;
if( /^\s*#include/ ) {
push @inc, $_ unless exists $inc{$_};
$inc{$_}=1;

30
src/analysis/interpolation/Bezier3D.h
View File

@ -27,38 +27,38 @@ class ANALYSIS_EXPORT Bezier3D: public ParametricLine
protected:
public:
/** Default constructor*/
//! Default constructor
Bezier3D();
/** Constructor, par is a pointer to the parent, controlpoly a controlpolygon*/
//! Constructor, par is a pointer to the parent, controlpoly a controlpolygon
Bezier3D( ParametricLine* par, QVector<Point3D*>* controlpoly );
/** Destructor*/
//! Destructor
virtual ~Bezier3D();
/** Do not use this method, since a Bezier curve does not consist of other curves*/
//! Do not use this method, since a Bezier curve does not consist of other curves
virtual void add( ParametricLine *pl ) override;
/** Calculates the first derivative and assigns it to v*/
//! Calculates the first derivative and assigns it to v
virtual void calcFirstDer( float t, Vector3D* v ) override;
/** Calculates the second derivative and assigns it to v*/
//! Calculates the second derivative and assigns it to v
virtual void calcSecDer( float t, Vector3D* v ) override;
//virtual Point3D calcPoint(float t);
/** Calculates the point on the curve and assigns it to p*/
//! Calculates the point on the curve and assigns it to p
virtual void calcPoint( float t, Point3D* p ) override;
/** Changes the order of control points*/
//! Changes the order of control points
virtual void changeDirection() override;
//virtual void draw(QPainter* p);
//virtual bool intersects(ParametricLine* pal);
/** Do not use this method, since a Bezier curve does not consist of other curves*/
//! Do not use this method, since a Bezier curve does not consist of other curves
virtual void remove( int i ) override;
/** Returns a control point*/
//! Returns a control point
virtual const Point3D* getControlPoint( int number ) const override;
/** Returns a pointer to the control polygon*/
//! Returns a pointer to the control polygon
virtual const QVector<Point3D*>* getControlPoly() const override;
/** Returns the degree of the curve*/
//! Returns the degree of the curve
virtual int getDegree() const override;
/** Returns the parent*/
//! Returns the parent
virtual ParametricLine* getParent() const override;
/** Sets the parent*/
//! Sets the parent
virtual void setParent( ParametricLine* par ) override;
/** Sets the control polygon*/
//! Sets the control polygon
virtual void setControlPoly( QVector<Point3D*>* cp ) override;
};

42
src/analysis/interpolation/CloughTocherInterpolator.h
View File

@ -27,15 +27,15 @@ class NormVecDecorator;
class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
{
protected:
/** Association with a triangulation object*/
//! Association with a triangulation object
NormVecDecorator* mTIN;
/** Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates)*/
//! Tolerance of the barycentric coordinates at the borders of the triangles (to prevent errors because of very small negativ baricentric coordinates)
double mEdgeTolerance;
/** First point of the triangle in x-,y-,z-coordinates*/
//! First point of the triangle in x-,y-,z-coordinates
Point3D point1;
/** Second point of the triangle in x-,y-,z-coordinates*/
//! Second point of the triangle in x-,y-,z-coordinates
Point3D point2;
/** Third point of the triangle in x-,y-,z-coordinates*/
//! Third point of the triangle in x-,y-,z-coordinates
Point3D point3;
Point3D cp1;
Point3D cp2;
@ -53,39 +53,39 @@ class ANALYSIS_EXPORT CloughTocherInterpolator : public TriangleInterpolator
Point3D cp14;
Point3D cp15;
Point3D cp16;
/** Derivative in x-direction at point1*/
//! Derivative in x-direction at point1
double der1X;
/** Derivative in y-direction at point1*/
//! Derivative in y-direction at point1
double der1Y;
/** Derivative in x-direction at point2*/
//! Derivative in x-direction at point2
double der2X;
/** Derivative in y-direction at point2*/
//! Derivative in y-direction at point2
double der2Y;
/** Derivative in x-direction at point3*/
//! Derivative in x-direction at point3
double der3X;
/** Derivative in y-direction at point3*/
//! Derivative in y-direction at point3
double der3Y;
/** Stores point1 of the last run*/
//! Stores point1 of the last run
Point3D lpoint1;
/** Stores point2 of the last run*/
//! Stores point2 of the last run
Point3D lpoint2;
/** Stores point3 of the last run*/
//! Stores point3 of the last run
Point3D lpoint3;
/** Finds out, in which triangle the point with the coordinates x and y is*/
//! Finds out, in which triangle the point with the coordinates x and y is
void init( double x, double y );
/** Calculates the Bernsteinpolynomials to calculate the Beziertriangle. 'n' is three in the cubical case, 'i', 'j', 'k' are the indices of the controllpoint and 'u', 'v', 'w' are the barycentric coordinates of the point*/
//! Calculates the Bernsteinpolynomials to calculate the Beziertriangle. 'n' is three in the cubical case, 'i', 'j', 'k' are the indices of the controllpoint and 'u', 'v', 'w' are the barycentric coordinates of the point
double calcBernsteinPoly( int n, int i, int j, int k, double u, double v, double w );
public:
/** Standard constructor*/
//! Standard constructor
CloughTocherInterpolator();
/** Constructor with a pointer to the triangulation as argument*/
//! Constructor with a pointer to the triangulation as argument
CloughTocherInterpolator( NormVecDecorator* tin );
/** Destructor*/
//! Destructor
virtual ~CloughTocherInterpolator();
/** Calculates the normal vector and assigns it to vec (not implemented at the moment)*/
//! Calculates the normal vector and assigns it to vec (not implemented at the moment)
virtual bool calcNormVec( double x, double y, Vector3D* result ) override;
/** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/
//! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point
virtual bool calcPoint( double x, double y, Point3D* result ) override;
virtual void setTriangulation( NormVecDecorator* tin );
};

126
src/analysis/interpolation/DualEdgeTriangulation.h
View File

@ -41,137 +41,137 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
DualEdgeTriangulation( int nop, Triangulation* decorator );
virtual ~DualEdgeTriangulation();
void setDecorator( Triangulation* d ) {mDecorator = d;}
/** Adds a line (e.g. a break-, structure- or an isoline) to the triangulation. The class takes ownership of the line object and its points*/
//! Adds a line (e.g. a break-, structure- or an isoline) to the triangulation. The class takes ownership of the line object and its points
void addLine( Line3D* line, bool breakline ) override;
/** Adds a point to the triangulation and returns the number of this point in case of success or -100 in case of failure*/
//! Adds a point to the triangulation and returns the number of this point in case of success or -100 in case of failure
int addPoint( Point3D* p ) override;
/** Performs a consistency check, remove this later*/
//! Performs a consistency check, remove this later
virtual void performConsistencyTest() override;
/** Calculates the normal at a point on the surface*/
//! Calculates the normal at a point on the surface
virtual bool calcNormal( double x, double y, Vector3D* result ) override;
/** Calculates x-, y and z-value of the point on the surface*/
//! Calculates x-, y and z-value of the point on the surface
virtual bool calcPoint( double x, double y, Point3D* result ) override;
/** Draws the points, edges and the forced lines*/
//! Draws the points, edges and the forced lines
//virtual void draw(QPainter* p, double xlowleft, double ylowleft, double xupright, double yupright, double width, double height) const;
/** Returns a pointer to the point with number i*/
//! Returns a pointer to the point with number i
virtual Point3D* getPoint( unsigned int i ) const override;
/** Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)*/
//! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)
int getOppositePoint( int p1, int p2 ) override;
/** Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'*/
//! Finds out, in which triangle the point with coordinates x and y is and assigns the numbers of the vertices to 'n1', 'n2' and 'n3' and the vertices to 'p1', 'p2' and 'p3'
//! @note not available in python bindings
virtual bool getTriangle( double x, double y, Point3D* p1, int* n1, Point3D* p2, int* n2, Point3D* p3, int* n3 ) override;
/** Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3*/
//! Finds out, in which triangle the point with coordinates x and y is and assigns addresses to the points at the vertices to 'p1', 'p2' and 'p3
virtual bool getTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 ) override;
/** Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. The value list has to be deleted by the code which called the method*/
//! Returns a pointer to a value list with the information of the triangles surrounding (counterclockwise) a point. Four integer values describe a triangle, the first three are the number of the half edges of the triangle and the fourth is -10, if the third (and most counterclockwise) edge is a breakline, and -20 otherwise. The value list has to be deleted by the code which called the method
QList<int>* getSurroundingTriangles( int pointno ) override;
/** Returns the largest x-coordinate value of the bounding box*/
//! Returns the largest x-coordinate value of the bounding box
virtual double getXMax() const override { return xMax; }
/** Returns the smallest x-coordinate value of the bounding box*/
//! Returns the smallest x-coordinate value of the bounding box
virtual double getXMin() const override { return xMin; }
/** Returns the largest y-coordinate value of the bounding box*/
//! Returns the largest y-coordinate value of the bounding box
virtual double getYMax() const override { return yMax; }
/** Returns the smallest x-coordinate value of the bounding box*/
//! Returns the smallest x-coordinate value of the bounding box
virtual double getYMin() const override { return yMin; }
/** Returns the number of points*/
//! Returns the number of points
virtual int getNumberOfPoints() const override;
/** Sets the behaviour of the triangulation in case of crossing forced lines*/
//! Sets the behaviour of the triangulation in case of crossing forced lines
virtual void setForcedCrossBehaviour( Triangulation::forcedCrossBehaviour b ) override;
/** Sets the color of the normal edges*/
//! Sets the color of the normal edges
virtual void setEdgeColor( int r, int g, int b ) override;
/** Sets the color of the forced edges*/
//! Sets the color of the forced edges
virtual void setForcedEdgeColor( int r, int g, int b ) override;
/** Sets the color of the breaklines*/
//! Sets the color of the breaklines
virtual void setBreakEdgeColor( int r, int g, int b ) override;
/** Sets an interpolator object*/
//! Sets an interpolator object
void setTriangleInterpolator( TriangleInterpolator* interpolator ) override;
/** Eliminates the horizontal triangles by swapping or by insertion of new points*/
//! Eliminates the horizontal triangles by swapping or by insertion of new points
void eliminateHorizontalTriangles() override;
/** Adds points to make the triangles better shaped (algorithm of ruppert)*/
//! Adds points to make the triangles better shaped (algorithm of ruppert)
virtual void ruppertRefinement() override;
/** Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
//! Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise
bool pointInside( double x, double y ) override;
/** Reads the dual edge structure of a taff file*/
//! Reads the dual edge structure of a taff file
//bool readFromTAFF(QString fileName);
/** Saves the dual edge structure to a taff file*/
//! Saves the dual edge structure to a taff file
//bool saveToTAFF(QString fileName) const;
/** Swaps the edge which is closest to the point with x and y coordinates (if this is possible)*/
//! Swaps the edge which is closest to the point with x and y coordinates (if this is possible)
virtual bool swapEdge( double x, double y ) override;
/** Returns a value list with the numbers of the four points, which would be affected by an edge swap. This function is e.g. needed by NormVecDecorator to know the points, for which the normals have to be recalculated. The returned ValueList has to be deleted by the code which calls the method*/
//! Returns a value list with the numbers of the four points, which would be affected by an edge swap. This function is e.g. needed by NormVecDecorator to know the points, for which the normals have to be recalculated. The returned ValueList has to be deleted by the code which calls the method
virtual QList<int>* getPointsAroundEdge( double x, double y ) override;
/** Saves the triangulation as a (line) shapefile
@return true in case of success*/
virtual bool saveAsShapefile( const QString& fileName ) const override;
protected:
/** X-coordinate of the upper right corner of the bounding box*/
//! X-coordinate of the upper right corner of the bounding box
double xMax;
/** X-coordinate of the lower left corner of the bounding box*/
//! X-coordinate of the lower left corner of the bounding box
double xMin;
/** Y-coordinate of the upper right corner of the bounding box*/
//! Y-coordinate of the upper right corner of the bounding box
double yMax;
/** Y-coordinate of the lower left corner of the bounding box*/
//! Y-coordinate of the lower left corner of the bounding box
double yMin;
/** Default value for the number of storable points at the beginning*/
//! Default value for the number of storable points at the beginning
const static unsigned int mDefaultStorageForPoints = 100000;
/** Stores pointers to all points in the triangulations (including the points contained in the lines)*/
//! Stores pointers to all points in the triangulations (including the points contained in the lines)
QVector<Point3D*> mPointVector;
/** Default value for the number of storable HalfEdges at the beginning*/
//! Default value for the number of storable HalfEdges at the beginning
const static unsigned int mDefaultStorageForHalfEdges = 300006;
/** Stores pointers to the HalfEdges*/
//! Stores pointers to the HalfEdges
QVector<HalfEdge*> mHalfEdge;
/** Association to an interpolator object*/
//! Association to an interpolator object
TriangleInterpolator* mTriangleInterpolator;
/** Member to store the behaviour in case of crossing forced segments*/
//! Member to store the behaviour in case of crossing forced segments
Triangulation::forcedCrossBehaviour mForcedCrossBehaviour;
/** Color to paint the normal edges*/
//! Color to paint the normal edges
QColor mEdgeColor;
/** Color to paint the forced edges*/
//! Color to paint the forced edges
QColor mForcedEdgeColor;
/** Color to paint the breaklines*/
//! Color to paint the breaklines
QColor mBreakEdgeColor;
/** Pointer to the decorator using this triangulation. It it is used directly, mDecorator equals this*/
//! Pointer to the decorator using this triangulation. It it is used directly, mDecorator equals this
Triangulation* mDecorator;
/** Inserts an edge and makes sure, everything is ok with the storage of the edge. The number of the HalfEdge is returned*/
//! Inserts an edge and makes sure, everything is ok with the storage of the edge. The number of the HalfEdge is returned
unsigned int insertEdge( int dual, int next, int point, bool mbreak, bool forced );
/** Inserts a forced segment between the points with the numbers p1 and p2 into the triangulation and returns the number of a HalfEdge belonging to this forced edge or -100 in case of failure*/
//! Inserts a forced segment between the points with the numbers p1 and p2 into the triangulation and returns the number of a HalfEdge belonging to this forced edge or -100 in case of failure
int insertForcedSegment( int p1, int p2, bool breakline );
/** Threshold for the leftOfTest to handle numerical instabilities*/
//! Threshold for the leftOfTest to handle numerical instabilities
//const static double leftOfTresh=0.00001;
/** Security to prevent endless loops in 'baseEdgeOfTriangle'. It there are more iteration then this number, the point will not be inserted*/
//! Security to prevent endless loops in 'baseEdgeOfTriangle'. It there are more iteration then this number, the point will not be inserted
const static int nBaseOfRuns = 300000;
/** Returns the number of an edge which points to the point with number 'point' or -1 if there is an error*/
//! Returns the number of an edge which points to the point with number 'point' or -1 if there is an error
int baseEdgeOfPoint( int point );
/** Returns the number of a HalfEdge from a triangle in which 'point' is in. If the number -10 is returned, this means, that 'point' is outside the convex hull. If -5 is returned, then numerical problems with the leftOfTest occurred (and the value of the possible edge is stored in the variable 'mUnstableEdge'. -20 means, that the inserted point is exactly on an edge (the number is stored in the variable 'mEdgeWithPoint'). -25 means, that the point is already in the triangulation (the number of the point is stored in the member 'mTwiceInsPoint'. If -100 is returned, this means that something else went wrong*/
//! Returns the number of a HalfEdge from a triangle in which 'point' is in. If the number -10 is returned, this means, that 'point' is outside the convex hull. If -5 is returned, then numerical problems with the leftOfTest occurred (and the value of the possible edge is stored in the variable 'mUnstableEdge'. -20 means, that the inserted point is exactly on an edge (the number is stored in the variable 'mEdgeWithPoint'). -25 means, that the point is already in the triangulation (the number of the point is stored in the member 'mTwiceInsPoint'. If -100 is returned, this means that something else went wrong
int baseEdgeOfTriangle( Point3D* point );
/** Checks, if 'edge' has to be swapped because of the empty circle criterion. If so, doSwap(...) is called.*/
//! Checks, if 'edge' has to be swapped because of the empty circle criterion. If so, doSwap(...) is called.
bool checkSwap( unsigned int edge, unsigned int recursiveDeep );
/** Swaps 'edge' and test recursively for other swaps (delaunay criterion)*/
//! Swaps 'edge' and test recursively for other swaps (delaunay criterion)
void doSwap( unsigned int edge, unsigned int recursiveDeep );
/** Swaps 'edge' and does no recursiv testing*/
//! Swaps 'edge' and does no recursiv testing
void doOnlySwap( unsigned int edge );
/** Number of an edge which does not point to the virtual point. It continuously updated for a fast search*/
//! Number of an edge which does not point to the virtual point. It continuously updated for a fast search
unsigned int mEdgeInside;
/** Number of an edge on the outside of the convex hull. It is updated in method 'baseEdgeOfTriangle' to enable insertion of points outside the convex hull*/
//! Number of an edge on the outside of the convex hull. It is updated in method 'baseEdgeOfTriangle' to enable insertion of points outside the convex hull
unsigned int mEdgeOutside;
/** If an inserted point is exactly on an existing edge, 'baseEdgeOfTriangle' returns -20 and sets the variable 'mEdgeWithPoint'*/
//! If an inserted point is exactly on an existing edge, 'baseEdgeOfTriangle' returns -20 and sets the variable 'mEdgeWithPoint'
unsigned int mEdgeWithPoint;
/** If an instability occurs in 'baseEdgeOfTriangle', mUnstableEdge is set to the value of the current edge*/
//! If an instability occurs in 'baseEdgeOfTriangle', mUnstableEdge is set to the value of the current edge
unsigned int mUnstableEdge;
/** If a point has been inserted twice, its number is stored in this member*/
//! If a point has been inserted twice, its number is stored in this member
int mTwiceInsPoint;
/** Returns true, if it is possible to swap an edge, otherwise false(concave quad or edge on (or outside) the convex hull)*/
//! Returns true, if it is possible to swap an edge, otherwise false(concave quad or edge on (or outside) the convex hull)
bool swapPossible( unsigned int edge );
/** Divides a polygon in a triangle and two polygons and calls itself recursively for these two polygons. 'poly' is a pointer to a list with the numbers of the edges of the polygon, 'free' is a pointer to a list of free halfedges, and 'mainedge' is the number of the edge, towards which the new triangle is inserted. Mainedge has to be the same as poly->begin(), otherwise the recursion does not work*/
//! Divides a polygon in a triangle and two polygons and calls itself recursively for these two polygons. 'poly' is a pointer to a list with the numbers of the edges of the polygon, 'free' is a pointer to a list of free halfedges, and 'mainedge' is the number of the edge, towards which the new triangle is inserted. Mainedge has to be the same as poly->begin(), otherwise the recursion does not work
void triangulatePolygon( QList<int>* poly, QList<int>* free, int mainedge );
/** Tests, if the bounding box of the halfedge with index i intersects the specified bounding box. The main purpose for this method is the drawing of the triangulation*/
//! Tests, if the bounding box of the halfedge with index i intersects the specified bounding box. The main purpose for this method is the drawing of the triangulation
bool halfEdgeBBoxTest( int edge, double xlowleft, double ylowleft, double xupright, double yupright ) const;
/** Calculates the minimum angle, which would be present, if the specified halfedge would be swapped*/
//! Calculates the minimum angle, which would be present, if the specified halfedge would be swapped
double swapMinAngle( int edge ) const;
/** Inserts a new point on the halfedge with number 'edge'. The position can have a value from 0 to 1 (e.g. 0.5 would be in the middle). The return value is the number of the new inserted point. tin is the triangulation, which should be used to calculate the elevation of the inserted point*/
//! Inserts a new point on the halfedge with number 'edge'. The position can have a value from 0 to 1 (e.g. 0.5 would be in the middle). The return value is the number of the new inserted point. tin is the triangulation, which should be used to calculate the elevation of the inserted point
int splitHalfEdge( int edge, float position );
/** Returns true, if a half edge is on the convex hull and false otherwise*/
//! Returns true, if a half edge is on the convex hull and false otherwise
bool edgeOnConvexHull( int edge );
/** Function needed for the ruppert algorithm. Tests, if point is in the circle through both endpoints of edge and the endpoint of edge->dual->next->point. If so, the function calls itself recursively for edge->next and edge->next->next. Stops, if it finds a forced edge or a convex hull edge*/
//! Function needed for the ruppert algorithm. Tests, if point is in the circle through both endpoints of edge and the endpoint of edge->dual->next->point. If so, the function calls itself recursively for edge->next and edge->next->next. Stops, if it finds a forced edge or a convex hull edge
void evaluateInfluenceRegion( Point3D* point, int edge, QSet<int> &set );
};

32
src/analysis/interpolation/HalfEdge.h
View File

@ -23,41 +23,41 @@
class ANALYSIS_EXPORT HalfEdge
{
protected:
/** Number of the dual HalfEdge*/
//! Number of the dual HalfEdge
int mDual;
/** Number of the next HalfEdge*/
//! Number of the next HalfEdge
int mNext;
/** Number of the point at which this HalfEdge points*/
//! Number of the point at which this HalfEdge points
int mPoint;
/** True, if the HalfEdge belongs to a break line, false otherwise*/
//! True, if the HalfEdge belongs to a break line, false otherwise
bool mBreak;
/** True, if the HalfEdge belongs to a constrained edge, false otherwise*/
//! True, if the HalfEdge belongs to a constrained edge, false otherwise
bool mForced;
public:
/** Default constructor. Values for mDual, mNext, mPoint are set to -10 which means that they are undefined*/
//! Default constructor. Values for mDual, mNext, mPoint are set to -10 which means that they are undefined
HalfEdge();
HalfEdge( int dual, int next, int point, bool mbreak, bool forced );
~HalfEdge();
/** Returns the number of the dual HalfEdge*/
//! Returns the number of the dual HalfEdge
int getDual() const;
/** Returns the number of the next HalfEdge*/
//! Returns the number of the next HalfEdge
int getNext() const;
/** Returns the number of the point at which this HalfEdge points*/
//! Returns the number of the point at which this HalfEdge points
int getPoint() const;
/** Returns, whether the HalfEdge belongs to a break line or not*/
//! Returns, whether the HalfEdge belongs to a break line or not
bool getBreak() const;
/** Returns, whether the HalfEdge belongs to a constrained edge or not*/
//! Returns, whether the HalfEdge belongs to a constrained edge or not
bool getForced() const;
/** Sets the number of the dual HalfEdge*/
//! Sets the number of the dual HalfEdge
void setDual( int d );
/** Sets the number of the next HalfEdge*/
//! Sets the number of the next HalfEdge
void setNext( int n );
/** Sets the number of point at which this HalfEdge points*/
//! Sets the number of point at which this HalfEdge points
void setPoint( int p );
/** Sets the break flag*/
//! Sets the break flag
void setBreak( bool b );
/** Sets the forced flag*/
//! Sets the forced flag
void setForced( bool f );
};

18
src/analysis/interpolation/LinTriangleInterpolator.h
View File

@ -25,27 +25,27 @@
class ANALYSIS_EXPORT LinTriangleInterpolator : public TriangleInterpolator
{
public:
/** Default constructor*/
//! Default constructor
LinTriangleInterpolator();
/** Constructor with reference to a DualEdgeTriangulation object*/
//! Constructor with reference to a DualEdgeTriangulation object
LinTriangleInterpolator( DualEdgeTriangulation* tin );
/** Destructor*/
//! Destructor
virtual ~LinTriangleInterpolator();
/** Calculates the normal vector and assigns it to vec*/
//! Calculates the normal vector and assigns it to vec
virtual bool calcNormVec( double x, double y, Vector3D* result ) override;
/** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/
//! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point
virtual bool calcPoint( double x, double y, Point3D* result ) override;
/** Returns a pointer to the current Triangulation object*/
//! Returns a pointer to the current Triangulation object
virtual DualEdgeTriangulation* getTriangulation() const;
/** Sets a Triangulation*/
//! Sets a Triangulation
virtual void setTriangulation( DualEdgeTriangulation* tin );
protected:
DualEdgeTriangulation* mTIN;
/** Calculates the first derivative with respect to x for a linear surface and assigns it to vec*/
//! Calculates the first derivative with respect to x for a linear surface and assigns it to vec
virtual bool calcFirstDerX( double x, double y, Vector3D* result );
/** Calculates the first derivative with respect to y for a linear surface and assigns it to vec*/
//! Calculates the first derivative with respect to y for a linear surface and assigns it to vec
virtual bool calcFirstDerY( double x, double y, Vector3D* result );
};

20
src/analysis/interpolation/Line3D.h
View File

@ -24,9 +24,9 @@
class ANALYSIS_EXPORT Line3D
{
private:
/** Copy constructor, declared private to not use it*/
//! Copy constructor, declared private to not use it
Line3D( const Line3D& );
/** Assignment operator, declared private to not use it*/
//! Assignment operator, declared private to not use it
Line3D& operator=( const Line3D& );
protected:
Node* head;
@ -38,21 +38,21 @@ class ANALYSIS_EXPORT Line3D
public:
Line3D();
~Line3D();
/** Returns true, if the Line contains no Point3D, otherwise false*/
//! Returns true, if the Line contains no Point3D, otherwise false
bool empty() const;
/** Inserts a node behind the current position and sets the current position to this new node*/
//! Inserts a node behind the current position and sets the current position to this new node
void insertPoint( Point3D* p );
/** Removes the point behind the current position*/
//! Removes the point behind the current position
void removePoint();
/** Gets the point at the current position*/
//! Gets the point at the current position
Point3D* getPoint() const;
/** Returns the current position*/
//! Returns the current position
unsigned int getCurrent() const;
/** Returns the size of the line (the numbero of inserted Nodes without 'head' and 'z'*/
//! Returns the size of the line (the numbero of inserted Nodes without 'head' and 'z'
unsigned int getSize() const;
/** Sets the current Node to head*/
//! Sets the current Node to head
void goToBegin();
/** Goes to the next Node*/
//! Goes to the next Node
void goToNext();
};

54
src/analysis/interpolation/MathUtils.h
View File

@ -24,60 +24,60 @@ class Vector3D;
namespace MathUtils
{
/** Calculates the barycentric coordinates of a point (x,y) with respect to p1, p2, p3 and stores the three barycentric coordinates in 'result'. Thus the u-coordinate is stored in result::x, the v-coordinate in result::y and the w-coordinate in result::z. Attention: p1, p2 and p3 have to be ordered counterclockwise*/
//! Calculates the barycentric coordinates of a point (x,y) with respect to p1, p2, p3 and stores the three barycentric coordinates in 'result'. Thus the u-coordinate is stored in result::x, the v-coordinate in result::y and the w-coordinate in result::z. Attention: p1, p2 and p3 have to be ordered counterclockwise
bool ANALYSIS_EXPORT calcBarycentricCoordinates( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result );
bool ANALYSIS_EXPORT BarycentricToXY( double u, double v, double w, Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result );
/** Calculates the value of a Bernstein polynomial*/
//! Calculates the value of a Bernstein polynomial
double ANALYSIS_EXPORT calcBernsteinPoly( int n, int i, double t );
/** Calculates the first derivative of a Bernstein polynomial with respect to the parameter t*/
//! Calculates the first derivative of a Bernstein polynomial with respect to the parameter t
double ANALYSIS_EXPORT cFDerBernsteinPoly( int n, int i, double t );
/** Calculates the value of a cubic Hermite polynomial*/
//! Calculates the value of a cubic Hermite polynomial
double ANALYSIS_EXPORT calcCubicHermitePoly( int n, int i, double t );
/** Calculates the first derivative of a cubic Hermite polynomial with respect to the parameter t*/
//! Calculates the first derivative of a cubic Hermite polynomial with respect to the parameter t
double ANALYSIS_EXPORT cFDerCubicHermitePoly( int n, int i, double t );
/** Calculates the center of the circle passing through p1, p2 and p3. Returns true in case of success and false otherwise (e.g. all three points on a line)*/
//! Calculates the center of the circle passing through p1, p2 and p3. Returns true in case of success and false otherwise (e.g. all three points on a line)
bool ANALYSIS_EXPORT circumcenter( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* result );
/** Calculates the (2 dimensional) distance from 'thepoint' to the line defined by p1 and p2*/
//! Calculates the (2 dimensional) distance from 'thepoint' to the line defined by p1 and p2
double ANALYSIS_EXPORT distPointFromLine( Point3D* thepoint, Point3D* p1, Point3D* p2 );
/** Faculty function*/
//! Faculty function
int ANALYSIS_EXPORT faculty( int n );
/** Tests, whether 'testp' is inside the circle through 'p1', 'p2' and 'p3'*/
//! Tests, whether 'testp' is inside the circle through 'p1', 'p2' and 'p3'
bool ANALYSIS_EXPORT inCircle( Point3D* testp, Point3D* p1, Point3D* p2, Point3D* p3 );
/** Tests, whether 'point' is inside the diametral circle through 'p1' and 'p2'*/
//! Tests, whether 'point' is inside the diametral circle through 'p1' and 'p2'
bool ANALYSIS_EXPORT inDiametral( Point3D* p1, Point3D* p2, Point3D* point );
/** Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negativ values mean left and positiv values right. There may be numerical instabilities, so a threshold may be useful*/
//! Returns whether 'thepoint' is left or right of the line from 'p1' to 'p2'. Negativ values mean left and positiv values right. There may be numerical instabilities, so a threshold may be useful
double ANALYSIS_EXPORT leftOf( Point3D* thepoint, Point3D* p1, Point3D* p2 );
/** Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned*/
//! Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned
bool ANALYSIS_EXPORT lineIntersection( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4 );
/** Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned. The intersecting point is stored in 'intersection_point.*/
//! Returns true, if line1 (p1 to p2) and line2 (p3 to p4) intersect. If the lines have an endpoint in common, false is returned. The intersecting point is stored in 'intersection_point.
bool ANALYSIS_EXPORT lineIntersection( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4, Point3D* intersection_point );
/** Lower function*/
//! Lower function
int ANALYSIS_EXPORT lower( int n, int i );
/** Returns the maximum of two doubles or the first argument if both are equal*/
//! Returns the maximum of two doubles or the first argument if both are equal
double ANALYSIS_EXPORT max( double x, double y );
/** Returns the minimum of two doubles or the first argument if both are equal*/
//! Returns the minimum of two doubles or the first argument if both are equal
double ANALYSIS_EXPORT min( double x, double y );
/** Power function for integer coefficients*/
//! Power function for integer coefficients
double ANALYSIS_EXPORT power( double a, int b );//calculates a power b
/** Returns the area of a triangle. If the points are ordered counterclockwise, the value will be positiv. If they are ordered clockwise, the value will be negativ*/
//! Returns the area of a triangle. If the points are ordered counterclockwise, the value will be positiv. If they are ordered clockwise, the value will be negativ
double ANALYSIS_EXPORT triArea( Point3D* pa, Point3D* pb, Point3D* pc );
/** Calculates the z-component of a vector with coordinates 'x' and 'y'which is in the same tangent plane as the tangent vectors 'v1' and 'v2'. The result is assigned to 'result' */
//! Calculates the z-component of a vector with coordinates 'x' and 'y'which is in the same tangent plane as the tangent vectors 'v1' and 'v2'. The result is assigned to 'result'
bool ANALYSIS_EXPORT derVec( const Vector3D* v1, const Vector3D* v2, Vector3D* result, double x, double y );
/** Calculates the intersection of the two vectors vec1 and vec2, which start at first(vec1) and second(vec2) end. The return value is t2(multiplication of v2 with t2 and adding to 'second' results the intersection point)*/
//! Calculates the intersection of the two vectors vec1 and vec2, which start at first(vec1) and second(vec2) end. The return value is t2(multiplication of v2 with t2 and adding to 'second' results the intersection point)
double ANALYSIS_EXPORT crossVec( Point3D* first, Vector3D* vec1, Point3D* second, Vector3D* vec2 );
/** Assigns the vector 'result', which is normal to the vector 'v1', on the left side of v1 and has length 'length'. This method works only with two dimensions.*/
//! Assigns the vector 'result', which is normal to the vector 'v1', on the left side of v1 and has length 'length'. This method works only with two dimensions.
bool ANALYSIS_EXPORT normalLeft( Vector3D* v1, Vector3D* result, double length );
/** Assigns the vector 'result', which is normal to the vector 'v1', on the right side of v1 and has length 'length'. The calculation is only in two dimensions*/
//! Assigns the vector 'result', which is normal to the vector 'v1', on the right side of v1 and has length 'length'. The calculation is only in two dimensions
bool ANALYSIS_EXPORT normalRight( Vector3D* v1, Vector3D* result, double length );
/** Calculates the normal vector of the plane through the points p1, p2 and p3 and assigns the result to vec. If the points are ordered counterclockwise, the normal will have a positive z-coordinate;*/
//! Calculates the normal vector of the plane through the points p1, p2 and p3 and assigns the result to vec. If the points are ordered counterclockwise, the normal will have a positive z-coordinate;
void ANALYSIS_EXPORT normalFromPoints( Point3D* p1, Point3D* p2, Point3D* p3, Vector3D* vec );
/** Returns true, if the point with coordinates x and y is inside (or at the edge) of the triangle p1,p2,p3 and false, if it is outside. p1, p2 and p3 have to be ordered counterclockwise*/
//! Returns true, if the point with coordinates x and y is inside (or at the edge) of the triangle p1,p2,p3 and false, if it is outside. p1, p2 and p3 have to be ordered counterclockwise
bool ANALYSIS_EXPORT pointInsideTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 );
/** Calculates a Vector orthogonal to 'tangent' with length 1 and closest possible to result. Returns true in case of success and false otherwise*/
//! Calculates a Vector orthogonal to 'tangent' with length 1 and closest possible to result. Returns true in case of success and false otherwise
bool ANALYSIS_EXPORT normalMinDistance( Vector3D* tangent, Vector3D* target, Vector3D* result );
/** Tests, if 'test' is in the same plane as 'p1', 'p2' and 'p3' and returns the z-difference from the plane to 'test*/
//! Tests, if 'test' is in the same plane as 'p1', 'p2' and 'p3' and returns the z-difference from the plane to 'test
double ANALYSIS_EXPORT planeTest( Point3D* test, Point3D* pt1, Point3D* pt2, Point3D* pt3 );
/** Calculates the angle between two segments (in 2 dimension, z-values are ignored)*/
//! Calculates the angle between two segments (in 2 dimension, z-values are ignored)
double ANALYSIS_EXPORT angle( Point3D* p1, Point3D* p2, Point3D* p3, Point3D* p4 );
}

12
src/analysis/interpolation/Node.h
View File

@ -24,22 +24,22 @@
class ANALYSIS_EXPORT Node
{
protected:
/** Pointer to the Point3D object associated with the node*/
//! Pointer to the Point3D object associated with the node
Point3D* mPoint;
/** Pointer to the next Node in the linked list*/
//! Pointer to the next Node in the linked list
Node* mNext;
public:
Node();
Node( const Node& n );
~Node();
Node& operator=( const Node& n );
/** Returns a pointer to the next element in the linked list*/
//! Returns a pointer to the next element in the linked list
Node* getNext() const;
/** Returns a pointer to the Point3D object associated with the node*/
//! Returns a pointer to the Point3D object associated with the node
Point3D* getPoint() const;
/** Sets the pointer to the next node*/
//! Sets the pointer to the next node
void setNext( Node* n );
/** Sets a new pointer to an associated Point3D object*/
//! Sets a new pointer to an associated Point3D object
void setPoint( Point3D* p );
};

36
src/analysis/interpolation/NormVecDecorator.h
View File

@ -29,54 +29,54 @@ class QProgressDialog;
class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
{
public:
/** Enumeration for the state of a point. NORMAL means, that the point is not on a breakline, BREAKLINE means that the point is on a breakline (but not an endpoint of it) and ENDPOINT means, that it is an endpoint of a breakline*/
//! Enumeration for the state of a point. NORMAL means, that the point is not on a breakline, BREAKLINE means that the point is on a breakline (but not an endpoint of it) and ENDPOINT means, that it is an endpoint of a breakline
enum pointState {NORMAL, BREAKLINE, ENDPOINT};
NormVecDecorator();
NormVecDecorator( Triangulation* tin );
virtual ~NormVecDecorator();
/** Adds a point to the triangulation*/
//! Adds a point to the triangulation
int addPoint( Point3D* p ) override;
/** Calculates the normal at a point on the surface and assigns it to 'result'. Returns true in case of success and false in case of failure*/
//! Calculates the normal at a point on the surface and assigns it to 'result'. Returns true in case of success and false in case of failure
bool calcNormal( double x, double y, Vector3D* result ) override;
/** Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise*/
//! Calculates the normal of a triangle-point for the point with coordinates x and y. This is needed, if a point is on a break line and there is no unique normal stored in 'mNormVec'. Returns false, it something went wrong and true otherwise
bool calcNormalForPoint( double x, double y, int point, Vector3D* result );
/** Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. Returns true in case of success and flase in case of failure*/
//! Calculates x-, y and z-value of the point on the surface and assigns it to 'result'. Returns true in case of success and flase in case of failure
bool calcPoint( double x, double y, Point3D* result ) override;
/** Eliminates the horizontal triangles by swapping or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done*/
//! Eliminates the horizontal triangles by swapping or by insertion of new points. If alreadyestimated is true, a re-estimation of the normals will be done
virtual void eliminateHorizontalTriangles() override;
/** Estimates the first derivative a point. Return true in case of succes and false otherwise*/
//! Estimates the first derivative a point. Return true in case of succes and false otherwise
bool estimateFirstDerivative( int pointno );
/** This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise*/
//! This method adds the functionality of estimating normals at the data points. Return true in the case of success and false otherwise
bool estimateFirstDerivatives( QProgressDialog* d = nullptr );
/** Returns a pointer to the normal vector for the point with the number n*/
//! Returns a pointer to the normal vector for the point with the number n
Vector3D* getNormal( int n ) const;
/** Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normaly taken from 'mNormVec', exept if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise*/
//! Finds out, in which triangle a point with coordinates x and y is and assigns the triangle points to p1, p2, p3 and the estimated normals to v1, v2, v3. The vectors are normaly taken from 'mNormVec', exept if p1, p2 or p3 is a point on a breakline. In this case, the normal is calculated on-the-fly. Returns false, if something went wrong and true otherwise
bool getTriangle( double x, double y, Point3D* p1, Vector3D* v1, Point3D* p2, Vector3D* v2, Point3D* p3, Vector3D* v3 );
/** This function behaves similar to the one above. Additionally, the numbers of the points are returned (ptn1, ptn2, ptn3) as well as the pointStates of the triangle points (state1, state2, state3)
* @note not available in Python bindings
*/
bool getTriangle( double x, double y, Point3D* p1, int* ptn1, Vector3D* v1, pointState* state1, Point3D* p2, int* ptn2, Vector3D* v2, pointState* state2, Point3D* p3, int* ptn3, Vector3D* v3, pointState* state3 );
/** Returns the state of the point with the number 'pointno'*/
//! Returns the state of the point with the number 'pointno'
pointState getState( int pointno ) const;
/** Sets an interpolator*/
//! Sets an interpolator
void setTriangleInterpolator( TriangleInterpolator* inter ) override;
/** Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true)*/
//! Swaps the edge which is closest to the point with x and y coordinates (if this is possible) and forces recalculation of the concerned normals (if alreadyestimated is true)
virtual bool swapEdge( double x, double y ) override;
/** Saves the triangulation as a (line) shapefile
@return true in case of success*/
virtual bool saveAsShapefile( const QString& fileName ) const override;
protected:
/** Is true, if the normals already have been estimated*/
//! Is true, if the normals already have been estimated
bool alreadyestimated;
const static unsigned int mDefaultStorageForNormals = 100000;
/** Association with an interpolator object*/
//! Association with an interpolator object
TriangleInterpolator* mInterpolator;
/** Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is a null pointer, this means, that the triangle point is on a breakline*/
//! Vector that stores the normals for the points. If 'estimateFirstDerivatives()' was called and there is a null pointer, this means, that the triangle point is on a breakline
QVector<Vector3D*>* mNormVec;
/** Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline*/
//! Vector who stores, it a point is not on a breakline, if it is a normal point of the breakline or if it is an endpoint of a breakline
QVector<pointState>* mPointState;
/** Sets the state (BREAKLINE, NORMAL, ENDPOINT) of a point*/
//! Sets the state (BREAKLINE, NORMAL, ENDPOINT) of a point
void setState( int pointno, pointState s );
};

10
src/analysis/interpolation/ParametricLine.h
View File

@ -28,19 +28,19 @@ class Vector3D;
class ANALYSIS_EXPORT ParametricLine
{
protected:
/** Degree of the parametric Line*/
//! Degree of the parametric Line
int mDegree;
/** Pointer to the parent object. If there isn't one, mParent is 0*/
//! Pointer to the parent object. If there isn't one, mParent is 0
ParametricLine* mParent;
/** MControlPoly stores the points of the control polygon*/
//! MControlPoly stores the points of the control polygon
QVector<Point3D*>* mControlPoly;
public:
/** Default constructor*/
//! Default constructor
ParametricLine();
/** Constructor, par is a pointer to the parent object, controlpoly the controlpolygon
*/
ParametricLine( ParametricLine* par, QVector<Point3D*>* controlpoly );
/** Destructor*/
//! Destructor
virtual ~ParametricLine();
virtual void add( ParametricLine* pl ) = 0;
virtual void calcFirstDer( float t, Vector3D* v ) = 0;

22
src/analysis/interpolation/Point3D.h
View File

@ -24,34 +24,34 @@
class ANALYSIS_EXPORT Point3D
{
protected:
/** X-coordinate*/
//! X-coordinate
double mX;
/** Y-coordinate*/
//! Y-coordinate
double mY;
/** Z-coordinate*/
//! Z-coordinate
double mZ;
public:
Point3D();
/** Constructor with the x-, y- and z-coordinate as arguments*/
//! Constructor with the x-, y- and z-coordinate as arguments
Point3D( double x, double y, double z );
Point3D( const Point3D& p );
~Point3D();
Point3D& operator=( const Point3D& p );
bool operator==( const Point3D& p ) const;
bool operator!=( const Point3D& p ) const;
/** Calculates the three-dimensional distance to another point*/
//! Calculates the three-dimensional distance to another point
double dist3D( Point3D* p ) const;
/** Returns the x-coordinate of the point*/
//! Returns the x-coordinate of the point
double getX() const;
/** Returns the y-coordinate of the point*/
//! Returns the y-coordinate of the point
double getY() const;
/** Returns the z-coordinate of the point*/
//! Returns the z-coordinate of the point
double getZ() const;
/** Sets the x-coordinate of the point*/
//! Sets the x-coordinate of the point
void setX( double x );
/** Sets the y-coordinate of the point*/
//! Sets the y-coordinate of the point
void setY( double y );
/** Sets the z-coordinate of the point*/
//! Sets the z-coordinate of the point
void setZ( double z );
};

6
src/analysis/interpolation/TriDecorator.h
View File

@ -29,9 +29,9 @@ class ANALYSIS_EXPORT TriDecorator : public Triangulation
virtual ~TriDecorator();
virtual void addLine( Line3D* line, bool breakline ) override;
virtual int addPoint( Point3D* p ) override;
/** Adds an association to a triangulation*/
//! Adds an association to a triangulation
virtual void addTriangulation( Triangulation* t );
/** Performs a consistency check, remove this later*/
//! Performs a consistency check, remove this later
virtual void performConsistencyTest() override;
virtual bool calcNormal( double x, double y, Vector3D* result ) override;
virtual bool calcPoint( double x, double y, Point3D* result ) override;
@ -56,7 +56,7 @@ class ANALYSIS_EXPORT TriDecorator : public Triangulation
virtual bool swapEdge( double x, double y ) override;
virtual QList<int>* getPointsAroundEdge( double x, double y ) override;
protected:
/** Association with a Triangulation object*/
//! Association with a Triangulation object
Triangulation* mTIN;
};

4
src/analysis/interpolation/TriangleInterpolator.h
View File

@ -26,9 +26,9 @@ class ANALYSIS_EXPORT TriangleInterpolator
{
public:
virtual ~TriangleInterpolator() {}
/** Calculates the normal vector and assigns it to vec*/
//! Calculates the normal vector and assigns it to vec
virtual bool calcNormVec( double x, double y, Vector3D* result ) = 0;
/** Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point*/
//! Performs a linear interpolation in a triangle and assigns the x-,y- and z-coordinates to point
virtual bool calcPoint( double x, double y, Point3D* result ) = 0;
};

46
src/analysis/interpolation/Triangulation.h
View File

@ -31,8 +31,8 @@ class ANALYSIS_EXPORT Triangulation
//! Enumeration describing the behaviour, if two forced lines cross.
enum forcedCrossBehaviour
{
SnappingType_VERTICE, //!< the second inserted forced line is snapped to the closest vertice of the first inserted forced line.
DELETE_FIRST, //!< the status of the first inserted forced line is reset to that of a normal edge (so that the second inserted forced line remain and the first not)
SnappingType_VERTICE, //!< The second inserted forced line is snapped to the closest vertice of the first inserted forced line.
DELETE_FIRST, //!< The status of the first inserted forced line is reset to that of a normal edge (so that the second inserted forced line remain and the first not)
INSERT_VERTICE
};
virtual ~Triangulation();
@ -55,7 +55,7 @@ class ANALYSIS_EXPORT Triangulation
*/
virtual bool calcNormal( double x, double y, Vector3D* result ) = 0;
/** Performs a consistency check, remove this later*/
//! Performs a consistency check, remove this later
virtual void performConsistencyTest() = 0;
/**
@ -64,7 +64,7 @@ class ANALYSIS_EXPORT Triangulation
*/
virtual bool calcPoint( double x, double y, Point3D* result ) = 0;
/** Returns a pointer to the point with number i. Any virtual points must have the number -1*/
//! Returns a pointer to the point with number i. Any virtual points must have the number -1
virtual Point3D* getPoint( unsigned int i ) const = 0;
/** Finds out in which triangle the point with coordinates x and y is and
@ -72,25 +72,25 @@ class ANALYSIS_EXPORT Triangulation
*/
virtual bool getTriangle( double x, double y, Point3D* p1, int* n1, Point3D* p2, int* n2, Point3D* p3, int* n3 ) = 0;
/** Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3*/
//! Finds out, in which triangle the point with coordinates x and y is and assigns the points at the vertices to 'p1', 'p2' and 'p3
virtual bool getTriangle( double x, double y, Point3D* p1, Point3D* p2, Point3D* p3 ) = 0;
/** Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)*/
//! Returns the number of the point opposite to the triangle points p1, p2 (which have to be on a halfedge)
virtual int getOppositePoint( int p1, int p2 ) = 0;
/** Returns the largest x-coordinate value of the bounding box*/
//! Returns the largest x-coordinate value of the bounding box
virtual double getXMax() const = 0;
/** Returns the smallest x-coordinate value of the bounding box*/
//! Returns the smallest x-coordinate value of the bounding box
virtual double getXMin() const = 0;
/** Returns the largest y-coordinate value of the bounding box*/
//! Returns the largest y-coordinate value of the bounding box
virtual double getYMax() const = 0;
/** Returns the smallest x-coordinate value of the bounding box*/
//! Returns the smallest x-coordinate value of the bounding box
virtual double getYMin() const = 0;
/** Returns the number of points*/
//! Returns the number of points
virtual int getNumberOfPoints() const = 0;
/**
@ -109,40 +109,40 @@ class ANALYSIS_EXPORT Triangulation
*/
virtual QList<int>* getPointsAroundEdge( double x, double y ) = 0;
/** Draws the points, edges and the forced lines*/
//! Draws the points, edges and the forced lines
//virtual void draw(QPainter* p, double xlowleft, double ylowleft, double xupright, double yupright, double width, double height) const=0;
/** Sets the behaviour of the triangulation in case of crossing forced lines*/
//! Sets the behaviour of the triangulation in case of crossing forced lines
virtual void setForcedCrossBehaviour( Triangulation::forcedCrossBehaviour b ) = 0;
/** Sets the color of the normal edges*/
//! Sets the color of the normal edges
virtual void setEdgeColor( int r, int g, int b ) = 0;
/** Sets the color of the forced edges*/
//! Sets the color of the forced edges
virtual void setForcedEdgeColor( int r, int g, int b ) = 0;
/** Sets the color of the breaklines*/
//! Sets the color of the breaklines
virtual void setBreakEdgeColor( int r, int g, int b ) = 0;
/** Sets an interpolator object*/
//! Sets an interpolator object
virtual void setTriangleInterpolator( TriangleInterpolator* interpolator ) = 0;
/** Eliminates the horizontal triangles by swapping*/
//! Eliminates the horizontal triangles by swapping
virtual void eliminateHorizontalTriangles() = 0;
/** Adds points to make the triangles better shaped (algorithm of ruppert)*/
//! Adds points to make the triangles better shaped (algorithm of ruppert)
virtual void ruppertRefinement() = 0;
/** Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
//! Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise
virtual bool pointInside( double x, double y ) = 0;
/** Reads the content of a taff-file*/
//! Reads the content of a taff-file
//virtual bool readFromTAFF(QString fileName)=0;
/** Saves the content to a taff file*/
//! Saves the content to a taff file
//virtual bool saveToTAFF(QString fileName) const=0;
/** Swaps the edge which is closest to the point with x and y coordinates (if this is possible)*/
//! Swaps the edge which is closest to the point with x and y coordinates (if this is possible)
virtual bool swapEdge( double x, double y ) = 0;
/**

30
src/analysis/interpolation/Vector3D.h
View File

@ -28,40 +28,40 @@
class ANALYSIS_EXPORT Vector3D
{
protected:
/** X-component of the vector*/
//! X-component of the vector
double mX;
/** Y-component of the vector*/
//! Y-component of the vector
double mY;
/** Z-component of the vector*/
//! Z-component of the vector
double mZ;
public:
/** Constructor taking the three components as arguments*/
//! Constructor taking the three components as arguments
Vector3D( double x, double y, double z );
/** Default constructor*/
//! Default constructor
Vector3D();
/** Copy constructor*/
//! Copy constructor
Vector3D( const Vector3D& v );
/** Destructor*/
//! Destructor
~Vector3D();
Vector3D& operator=( const Vector3D& v );
bool operator==( const Vector3D& v ) const;
bool operator!=( const Vector3D& v ) const;
/** Returns the x-component of the vector*/
//! Returns the x-component of the vector
double getX() const;
/** Returns the y-component of the vector*/
//! Returns the y-component of the vector
double getY() const;
/** Returns the z-component of the vector*/
//! Returns the z-component of the vector
double getZ() const;
/** Returns the length of the vector*/
//! Returns the length of the vector
double getLength() const;
/** Sets the x-component of the vector*/
//! Sets the x-component of the vector
void setX( double x );
/** Sets the y-component of the vector*/
//! Sets the y-component of the vector
void setY( double y );
/** Sets the z-component of the vector*/
//! Sets the z-component of the vector
void setZ( double z );
/** Standardises the vector*/
//! Standardises the vector
void standardise();
};

6
src/analysis/interpolation/qgsinterpolator.h
View File

@ -37,7 +37,7 @@ can be an attribute or the z-coordinates in case of 25D types*/
class ANALYSIS_EXPORT QgsInterpolator
{
public:
/** Describes the type of input data*/
//! Describes the type of input data
enum InputType
{
POINTS,
@ -45,7 +45,7 @@ class ANALYSIS_EXPORT QgsInterpolator
BREAK_LINES
};
/** A layer together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline)*/
//! A layer together with the information about interpolation attribute / z-coordinate interpolation and the type (point, structure line, breakline)
struct LayerData
{
QgsVectorLayer* vectorLayer;
@ -76,7 +76,7 @@ class ANALYSIS_EXPORT QgsInterpolator
QVector<vertexData> mCachedBaseData;
/** Flag that tells if the cache already has been filled*/
//! Flag that tells if the cache already has been filled
bool mDataIsCached;
//Information about the input vector layers and the attributes (or z-values) that are used for interpolation

8
src/analysis/interpolation/qgstininterpolator.h
View File

@ -54,14 +54,14 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
TriangleInterpolator* mTriangleInterpolator;
bool mIsInitialized;
bool mShowProgressDialog;
/** If true: export triangulation to shapefile after initialization*/
//! If true: export triangulation to shapefile after initialization
bool mExportTriangulationToFile;
/** File path to export the triangulation*/
//! File path to export the triangulation
QString mTriangulationFilePath;
/** Type of interpolation*/
//! Type of interpolation
TIN_INTERPOLATION mInterpolation;
/** Create dual edge triangulation*/
//! Create dual edge triangulation
void initialize();
/** Inserts the vertices of a feature into the triangulation
@param f the feature

4
src/analysis/openstreetmap/qgsosmdownload.h
View File

@ -82,8 +82,8 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
bool isFinished() const;
signals:
void finished(); //!< emitted when the network reply has finished (with success or with an error)
void downloadProgress( qint64, qint64 ); //!< normally the total length is not known (until we reach end)
void finished(); //!< Emitted when the network reply has finished (with success or with an error)
void downloadProgress( qint64, qint64 ); //!< Normally the total length is not known (until we reach end)
private slots:
void onReadyRead();

4
src/analysis/raster/qgsderivativefilter.h
View File

@ -33,9 +33,9 @@ class ANALYSIS_EXPORT QgsDerivativeFilter : public QgsNineCellFilter
float* x13, float* x23, float* x33 ) override = 0;
protected:
/** Calculates the first order derivative in x-direction according to Horn (1981)*/
//! Calculates the first order derivative in x-direction according to Horn (1981)
float calcFirstDerX( float* x11, float* x21, float* x31, float* x12, float* x22, float* x32, float* x13, float* x23, float* x33 );
/** Calculates the first order derivative in y-direction according to Horn (1981)*/
//! Calculates the first order derivative in y-direction according to Horn (1981)
float calcFirstDerY( float* x11, float* x21, float* x31, float* x12, float* x22, float* x32, float* x13, float* x23, float* x33 );
};

10
src/analysis/raster/qgsninecellfilter.h
View File

@ -31,7 +31,7 @@ the method that calculates the new value from the nine values. Everything else (
class ANALYSIS_EXPORT QgsNineCellFilter
{
public:
/** Constructor that takes input file, output file and output format (GDAL string)*/
//! Constructor that takes input file, output file and output format (GDAL string)
QgsNineCellFilter( const QString& inputFile, const QString& outputFile, const QString& outputFormat );
virtual ~QgsNineCellFilter();
/** Starts the calculation, reads from mInputFile and stores the result in mOutputFile
@ -62,7 +62,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
//default constructor forbidden. We need input file, output file and format obligatory
QgsNineCellFilter();
/** Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction*/
//! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction
GDALDatasetH openInputFile( int& nCellsX, int& nCellsY );
/** Opens the output driver and tests if it supports the creation of a new dataset
@return nullptr on error and the driver handle on success*/
@ -79,11 +79,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter
double mCellSizeX;
double mCellSizeY;
/** The nodata value of the input layer*/
//! The nodata value of the input layer
float mInputNodataValue;
/** The nodata value of the output layer*/
//! The nodata value of the output layer
float mOutputNodataValue;
/** Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet)*/
//! Scale factor for z-value if x-/y- units are different to z-units (111120 for degree->meters and 370400 for degree->feet)
double mZFactor;
};

18
src/analysis/raster/qgsrastercalculator.h
View File

@ -44,12 +44,12 @@ class ANALYSIS_EXPORT QgsRasterCalculator
//! Result of the calculation
enum Result
{
Success = 0, /*!< Calculation sucessful */
CreateOutputError = 1, /*!< Error creating output data file */
InputLayerError = 2, /*!< Error reading input layer */
Cancelled = 3, /*!< User cancelled calculation */
ParserError = 4, /*!< Error parsing formula */
MemoryError = 5, /*!< Error allocating memory for result */
Success = 0, //!< Calculation sucessful
CreateOutputError = 1, //!< Error creating output data file
InputLayerError = 2, //!< Error reading input layer
Cancelled = 3, //!< User cancelled calculation
ParserError = 4, //!< Error parsing formula
MemoryError = 5, //!< Error allocating memory for result
};
/** QgsRasterCalculator constructor.
@ -104,13 +104,13 @@ class ANALYSIS_EXPORT QgsRasterCalculator
QString mOutputFile;
QString mOutputFormat;
/** Output raster extent*/
//! Output raster extent
QgsRectangle mOutputRectangle;
QgsCoordinateReferenceSystem mOutputCrs;
/** Number of output columns*/
//! Number of output columns
int mNumOutputColumns;
/** Number of output rows*/
//! Number of output rows
int mNumOutputRows;
/***/

14
src/analysis/raster/qgsrastermatrix.h
View File

@ -56,21 +56,21 @@ class ANALYSIS_EXPORT QgsRasterMatrix
opLOG10,
};
/** Takes ownership of data array*/
//! Takes ownership of data array
QgsRasterMatrix();
//! @note note available in python bindings
QgsRasterMatrix( int nCols, int nRows, double* data, double nodataValue );
QgsRasterMatrix( const QgsRasterMatrix& m );
~QgsRasterMatrix();
/** Returns true if matrix is 1x1 (=scalar number)*/
//! Returns true if matrix is 1x1 (=scalar number)
bool isNumber() const { return ( mColumns == 1 && mRows == 1 ); }
double number() const { return mData[0]; }
/** Returns data array (but not ownership)*/
//! Returns data array (but not ownership)
//! @note not available in python bindings
double* data() { return mData; }
/** Returns data and ownership. Sets data and nrows, ncols of this matrix to 0*/
//! Returns data and ownership. Sets data and nrows, ncols of this matrix to 0
//! @note not available in python bindings
double* takeData();
@ -83,9 +83,9 @@ class ANALYSIS_EXPORT QgsRasterMatrix
void setNodataValue( double d ) { mNodataValue = d; }
QgsRasterMatrix& operator=( const QgsRasterMatrix& m );
/** Adds another matrix to this one*/
//! Adds another matrix to this one
bool add( const QgsRasterMatrix& other );
/** Subtracts another matrix from this one*/
//! Subtracts another matrix from this one
bool subtract( const QgsRasterMatrix& other );
bool multiply( const QgsRasterMatrix& other );
bool divide( const QgsRasterMatrix& other );
@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRasterMatrix
double* mData;
double mNodataValue;
/** +,-,*,/,^,<,>,<=,>=,=,!=, and, or*/
//! +,-,*,/,^,<,>,<=,>=,=,!=, and, or
bool twoArgumentOperation( TwoArgOperator op, const QgsRasterMatrix& other );
double calculateTwoArgumentOp( TwoArgOperator op, double arg1, double arg2 ) const;

14
src/analysis/raster/qgsrelief.h
View File

@ -62,7 +62,7 @@ class ANALYSIS_EXPORT QgsRelief
@return true in case of success*/
QList< ReliefColor > calculateOptimizedReliefClasses();
/** Write frequency of elevation values to file for manual inspection*/
//! Write frequency of elevation values to file for manual inspection
bool exportFrequencyDistributionToCsv( const QString& file );
private:
@ -73,9 +73,9 @@ class ANALYSIS_EXPORT QgsRelief
double mCellSizeX;
double mCellSizeY;
/** The nodata value of the input layer*/
//! The nodata value of the input layer
float mInputNodataValue;
/** The nodata value of the output layer*/
//! The nodata value of the output layer
float mOutputNodataValue;
double mZFactor;
@ -92,7 +92,7 @@ class ANALYSIS_EXPORT QgsRelief
bool processNineCellWindow( float* x1, float* x2, float* x3, float* x4, float* x5, float* x6, float* x7, float* x8, float* x9,
unsigned char* red, unsigned char* green, unsigned char* blue );
/** Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction*/
//! Opens the input file and returns the dataset handle and the number of pixels in x-/y- direction
GDALDatasetH openInputFile( int& nCellsX, int& nCellsY );
/** Opens the output driver and tests if it supports the creation of a new dataset
@return nullptr on error and the driver handle on success*/
@ -101,15 +101,15 @@ class ANALYSIS_EXPORT QgsRelief
@return the output dataset or nullptr in case of error*/
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );
/** Set elevation color*/
//! Set elevation color
bool setElevationColor( double elevation, int* red, int* green, int* blue );
/** Sets relief colors*/
//! Sets relief colors
void setDefaultReliefColors();
/** Returns class (0-255) for an elevation value
@return elevation class or -1 in case of error*/
int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange );
/** Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)*/
//! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)
void optimiseClassBreaks( QList<int>& breaks, double* frequencies );
/** Calculates coefficients a and b
@param input data points ( elevation class / frequency )

12
src/analysis/vector/qgsgeometryanalyzer.h
View File

@ -118,7 +118,7 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
const QString& outputFormat, int locationField1, int locationField2 = -1, int offsetField = -1, double offsetScale = 1.0,
bool forceSingleGeometry = false, QgsVectorDataProvider* memoryProvider = nullptr, QProgressDialog* p = nullptr );
/** Returns linear reference geometry as a multiline (or 0 if no match). Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS)*/
//! Returns linear reference geometry as a multiline (or 0 if no match). Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS)
QgsGeometry locateBetweenMeasures( double fromMeasure, double toMeasure, const QgsGeometry& lineGeom );
/** Returns linear reference geometry. Unlike the PostGIS function, this method always returns multipoint or 0 if no match (not geometry collection).
* Currently, the z-coordinates are considered to be the measures (no support for m-values in QGIS)
@ -129,16 +129,16 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
QList<double> simpleMeasure( QgsGeometry& geometry );
double perimeterMeasure( const QgsGeometry& geometry, QgsDistanceArea& measure );
/** Helper function to simplify an individual feature*/
//! Helper function to simplify an individual feature
void simplifyFeature( QgsFeature& f, QgsVectorFileWriter* vfw, double tolerance );
/** Helper function to get the cetroid of an individual feature*/
//! Helper function to get the cetroid of an individual feature
void centroidFeature( QgsFeature& f, QgsVectorFileWriter* vfw );
/** Helper function to buffer an individual feature*/
//! Helper function to buffer an individual feature
void bufferFeature( QgsFeature& f, int nProcessedFeatures, QgsVectorFileWriter* vfw, bool dissolve, QgsGeometry& dissolveGeometry,
double bufferDistance, int bufferDistanceField );
/** Helper function to get the convex hull of feature(s)*/
//! Helper function to get the convex hull of feature(s)
void convexFeature( QgsFeature& f, int nProcessedFeatures, QgsGeometry& dissolveGeometry );
/** Helper function to dissolve feature(s)*/
//! Helper function to dissolve feature(s)
QgsGeometry dissolveFeature( const QgsFeature& f, const QgsGeometry& dissolveInto );
//helper functions for event layer

8
src/analysis/vector/qgspointsample.h
View File

@ -42,13 +42,13 @@ class ANALYSIS_EXPORT QgsPointSample
void addSamplePoints( QgsFeature& inputFeature, QgsVectorFileWriter& writer, int nPoints, double minDistance );
bool checkMinDistance( QgsPoint& pt, QgsSpatialIndex& index, double minDistance, QMap< QgsFeatureId, QgsPoint >& pointMap );
/** Layer id of input polygon/multipolygon layer*/
//! Layer id of input polygon/multipolygon layer
QgsVectorLayer* mInputLayer;
/** Output path of result layer*/
//! Output path of result layer
QString mOutputLayer;
/** Attribute containing number of points per feature*/
//! Attribute containing number of points per feature
QString mNumberOfPointsAttribute;
/** Attribute containing minimum distance between sample points (or -1 if no min. distance constraint)*/
//! Attribute containing minimum distance between sample points (or -1 if no min. distance constraint)
QString mMinDistanceAttribute;
QgsFeatureId mNCreatedPoints; //helper to find free ids
};

10
src/analysis/vector/qgstransectsample.h
View File

@ -50,7 +50,7 @@ class ANALYSIS_EXPORT QgsTransectSample
QgsGeometry findBaselineGeometry( const QVariant& strataId );
/** Returns true if another transect is within the specified minimum distance*/
//! Returns true if another transect is within the specified minimum distance
static bool otherTransectWithinDistance( const QgsGeometry& geom, double minDistLayerUnit, double minDistance, QgsSpatialIndex& sIndex, const QMap<QgsFeatureId, QgsGeometry>& lineFeatureMap, QgsDistanceArea& da );
QgsVectorLayer* mStrataLayer;
@ -70,9 +70,9 @@ class ANALYSIS_EXPORT QgsTransectSample
double mMinTransectLength;
/** If value is negative, the buffer distance ist set to the same value as the minimum distance*/
//! If value is negative, the buffer distance ist set to the same value as the minimum distance
double mBaselineBufferDistance;
/** If value is negative, no simplification is done to the baseline prior to create the buffer*/
//! If value is negative, no simplification is done to the baseline prior to create the buffer
double mBaselineSimplificationTolerance;
/** Finds the closest points between two line segments
@ -83,7 +83,7 @@ class ANALYSIS_EXPORT QgsTransectSample
@param pt2 out: closest point on secont geometry
@return true in case of success*/
static bool closestSegmentPoints( const QgsGeometry& g1, const QgsGeometry& g2, double& dist, QgsPoint& pt1, QgsPoint& pt2 );
/** Returns a copy of the multiline element closest to a point (caller takes ownership)*/
//! Returns a copy of the multiline element closest to a point (caller takes ownership)
static QgsGeometry closestMultilineElement( const QgsPoint& pt, const QgsGeometry& multiLine );
/** Returns clipped buffer line. Iteratively applies reduced tolerances if the result is not a single line
@param stratumGeom stratum polygon
@ -92,7 +92,7 @@ class ANALYSIS_EXPORT QgsTransectSample
@return clipped buffer line or 0 in case of error*/
QgsGeometry* clipBufferLine( const QgsGeometry& stratumGeom, QgsGeometry* clippedBaseline, double tolerance );
/** Returns distance to buffer the baseline (takes care of units and buffer settings*/
//! Returns distance to buffer the baseline (takes care of units and buffer settings
double bufferDistance( double minDistanceFromAttribute ) const;
};

10
src/analysis/vector/qgszonalstatistics.h
View File

@ -111,25 +111,25 @@ class ANALYSIS_EXPORT QgsZonalStatistics
int cellInfoForBBox( const QgsRectangle& rasterBBox, const QgsRectangle& featureBBox, double cellSizeX, double cellSizeY,
int& offsetX, int& offsetY, int& nCellsX, int& nCellsY ) const;
/** Returns statistics by considering the pixels where the center point is within the polygon (fast)*/
//! Returns statistics by considering the pixels where the center point is within the polygon (fast)
void statisticsFromMiddlePointTest( void* band, const QgsGeometry& poly, int pixelOffsetX, int pixelOffsetY, int nCellsX, int nCellsY,
double cellSizeX, double cellSizeY, const QgsRectangle& rasterBBox, FeatureStats& stats );
/** Returns statistics with precise pixel - polygon intersection test (slow) */
//! Returns statistics with precise pixel - polygon intersection test (slow)
void statisticsFromPreciseIntersection( void* band, const QgsGeometry& poly, int pixelOffsetX, int pixelOffsetY, int nCellsX, int nCellsY,
double cellSizeX, double cellSizeY, const QgsRectangle& rasterBBox, FeatureStats& stats );
/** Tests whether a pixel's value should be included in the result*/
//! Tests whether a pixel's value should be included in the result
bool validPixel( float value ) const;
QString getUniqueFieldName( const QString& fieldName );
QString mRasterFilePath;
/** Raster band to calculate statistics from (defaults to 1)*/
//! Raster band to calculate statistics from (defaults to 1)
int mRasterBand;
QgsVectorLayer* mPolygonLayer;
QString mAttributePrefix;
/** The nodata value of the input layer*/
//! The nodata value of the input layer
float mInputNodataValue;
Statistics mStatistics;
};

10
src/app/composer/qgsattributeselectiondialog.h
View File

@ -36,7 +36,7 @@ class QgsComposerObject;
// QgsComposerColumnAlignmentDelegate
/** A delegate for showing column alignment as a combo box*/
//! A delegate for showing column alignment as a combo box
class QgsComposerColumnAlignmentDelegate : public QItemDelegate
{
Q_OBJECT
@ -53,7 +53,7 @@ class QgsComposerColumnAlignmentDelegate : public QItemDelegate
// QgsComposerColumnAlignmentDelegate
/** A delegate for showing column attribute source as a QgsFieldExpressionWidget*/
//! A delegate for showing column attribute source as a QgsFieldExpressionWidget
class QgsComposerColumnSourceDelegate : public QItemDelegate, private QgsExpressionContextGenerator
{
Q_OBJECT
@ -74,7 +74,7 @@ class QgsComposerColumnSourceDelegate : public QItemDelegate, private QgsExpress
// QgsComposerColumnWidthDelegate
/** A delegate for showing column width as a spin box*/
//! A delegate for showing column width as a spin box
class QgsComposerColumnWidthDelegate : public QItemDelegate
{
Q_OBJECT
@ -91,7 +91,7 @@ class QgsComposerColumnWidthDelegate : public QItemDelegate
// QgsComposerColumnSortOrderDelegate
/** A delegate for showing column sort order as a combo box*/
//! A delegate for showing column sort order as a combo box
class QgsComposerColumnSortOrderDelegate : public QItemDelegate
{
Q_OBJECT
@ -108,7 +108,7 @@ class QgsComposerColumnSortOrderDelegate : public QItemDelegate
// QgsAttributeSelectionDialog
/** A dialog to select what attributes to display (in the table item), set the column properties and specify a sort order*/
//! A dialog to select what attributes to display (in the table item), set the column properties and specify a sort order
class QgsAttributeSelectionDialog: public QDialog, private Ui::QgsAttributeSelectionDialogBase
{
Q_OBJECT

46
src/app/composer/qgscomposer.h
View File

@ -389,43 +389,43 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
//! Save window state
void saveWindowState();
/** Add a composer arrow to the item/widget map and creates a configuration widget for it*/
//! Add a composer arrow to the item/widget map and creates a configuration widget for it
void addComposerArrow( QgsComposerArrow* arrow );
/** Add a composer polygon to the item/widget map and creates a configuration widget for it*/
//! Add a composer polygon to the item/widget map and creates a configuration widget for it
void addComposerPolygon( QgsComposerPolygon* polygon );
/** Add a composer polyline to the item/widget map and creates a configuration widget for it*/
//! Add a composer polyline to the item/widget map and creates a configuration widget for it
void addComposerPolyline( QgsComposerPolyline* polyline );
/** Add a composer map to the item/widget map and creates a configuration widget for it*/
//! Add a composer map to the item/widget map and creates a configuration widget for it
void addComposerMap( QgsComposerMap* map );
/** Adds a composer label to the item/widget map and creates a configuration widget for it*/
//! Adds a composer label to the item/widget map and creates a configuration widget for it
void addComposerLabel( QgsComposerLabel* label );
/** Adds a composer scale bar to the item/widget map and creates a configuration widget for it*/
//! Adds a composer scale bar to the item/widget map and creates a configuration widget for it
void addComposerScaleBar( QgsComposerScaleBar* scalebar );
/** Adds a composer legend to the item/widget map and creates a configuration widget for it*/
//! Adds a composer legend to the item/widget map and creates a configuration widget for it
void addComposerLegend( QgsComposerLegend* legend );
/** Adds a composer picture to the item/widget map and creates a configuration widget*/
//! Adds a composer picture to the item/widget map and creates a configuration widget
void addComposerPicture( QgsComposerPicture* picture );
/** Adds a composer shape to the item/widget map and creates a configuration widget*/
//! Adds a composer shape to the item/widget map and creates a configuration widget
void addComposerShape( QgsComposerShape* shape );
/** Adds a composer table v2 to the item/widget map and creates a configuration widget*/
//! Adds a composer table v2 to the item/widget map and creates a configuration widget
void addComposerTableV2( QgsComposerAttributeTableV2* table, QgsComposerFrame* frame );
/** Adds composer html and creates a configuration widget*/
//! Adds composer html and creates a configuration widget
void addComposerHtmlFrame( QgsComposerHtml* html, QgsComposerFrame* frame );
/** Removes item from the item/widget map and deletes the configuration widget. Does not delete the item itself*/
//! Removes item from the item/widget map and deletes the configuration widget. Does not delete the item itself
void deleteItem( QgsComposerItem* item );
/** Shows the configuration widget for a composer item*/
//! Shows the configuration widget for a composer item
void showItemOptions( QgsComposerItem* i );
//XML, usually connected with QgsProject::readProject and QgsProject::writeProject
@ -463,19 +463,19 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
private:
/** Establishes the signal slot connections from the QgsComposerView to the composer*/
//! Establishes the signal slot connections from the QgsComposerView to the composer
void connectViewSlots();
/** Establishes the signal slot connections from the QgsComposition to the composer*/
//! Establishes the signal slot connections from the QgsComposition to the composer
void connectCompositionSlots();
/** Establishes other signal slot connections for the composer*/
//! Establishes other signal slot connections for the composer
void connectOtherSlots();
/** Creates the composition widget*/
//! Creates the composition widget
void createCompositionWidget();
/** Sets up the compositions undo/redo connections*/
//! Sets up the compositions undo/redo connections
void setupUndoView();
//! True if a composer map contains a WMS layer
@ -532,19 +532,19 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
QPrinter* printer();
/** Composer title*/
//! Composer title
QString mTitle;
/** Labels in status bar which shows current mouse position*/
//! Labels in status bar which shows current mouse position
QLabel* mStatusCursorXLabel;
QLabel* mStatusCursorYLabel;
QLabel* mStatusCursorPageLabel;
/** Combobox in status bar which shows/adjusts current zoom level*/
//! Combobox in status bar which shows/adjusts current zoom level
QComboBox* mStatusZoomCombo;
QList<double> mStatusZoomLevelsList;
/** Label in status bar which shows messages from the composition*/
//! Label in status bar which shows messages from the composition
QLabel* mStatusCompositionLabel;
/** Label in status bar which shows atlas details*/
//! Label in status bar which shows atlas details
QLabel* mStatusAtlasLabel;
//! Pointer to composer view

2
src/app/composer/qgscomposerarrowwidget.h
View File

@ -37,7 +37,7 @@ class QgsComposerArrowWidget: public QgsComposerItemBaseWidget, private Ui::QgsC
QButtonGroup* mRadioButtonGroup;
/** Enables / disables the SVG line inputs*/
//! Enables / disables the SVG line inputs
void enableSvgInputElements( bool enable );
void updateLineSymbolMarker();

6
src/app/composer/qgscomposerattributetablewidget.h
View File

@ -35,7 +35,7 @@ class QgsComposerAttributeTableWidget: public QgsComposerItemBaseWidget, private
QgsComposerAttributeTableV2* mComposerTable;
QgsComposerFrame* mFrame;
/** Blocks / unblocks the signals of all GUI elements*/
//! Blocks / unblocks the signals of all GUI elements
void blockAllSignals( bool b );
void toggleSourceControls();
@ -80,10 +80,10 @@ class QgsComposerAttributeTableWidget: public QgsComposerItemBaseWidget, private
void on_mWrapBehaviourComboBox_currentIndexChanged( int index );
void on_mAdvancedCustomisationButton_clicked();
/** Inserts a new maximum number of features into the spin box (without the spinbox emitting a signal)*/
//! Inserts a new maximum number of features into the spin box (without the spinbox emitting a signal)
void setMaximumNumberOfFeatures( int n );
/** Sets the GUI elements to the values of mComposerTable*/
//! Sets the GUI elements to the values of mComposerTable
void updateGuiElements();
void atlasToggled();

4
src/app/composer/qgscomposerhtmlwidget.h
View File

@ -50,11 +50,11 @@ class QgsComposerHtmlWidget: public QgsComposerItemBaseWidget, private Ui::QgsCo
void on_mEmptyFrameCheckBox_toggled( bool checked );
void on_mHideEmptyBgCheckBox_toggled( bool checked );
/** Sets the GUI elements to the values of mHtmlItem*/
//! Sets the GUI elements to the values of mHtmlItem
void setGuiElementValues();
protected slots:
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
private:

20
src/app/composer/qgscomposeritemwidget.h
View File

@ -56,7 +56,7 @@ class QgsComposerConfigObject: public QObject
QgsComposerConfigObject( QWidget* parent, QgsComposerObject* composerObject );
~QgsComposerConfigObject();
/** Sets a data defined property for the item from its current data defined button settings*/
//! Sets a data defined property for the item from its current data defined button settings
void setDataDefinedProperty( const QgsDataDefinedButton *ddBtn, QgsComposerObject::DataDefinedProperty p );
/** Registers a data defined button, setting up its initial value, connections and description.
@ -68,14 +68,14 @@ class QgsComposerConfigObject: public QObject
void registerDataDefinedButton( QgsDataDefinedButton* button, QgsComposerObject::DataDefinedProperty property,
QgsDataDefinedButton::DataType type, const QString& description );
/** Returns the current atlas coverage layer (if set)*/
//! Returns the current atlas coverage layer (if set)
QgsVectorLayer* atlasCoverageLayer() const;
/** Returns the atlas for the composition*/
//! Returns the atlas for the composition
QgsAtlasComposition *atlasComposition() const;
private slots:
/** Must be called when a data defined button changes*/
//! Must be called when a data defined button changes
void updateDataDefinedProperty();
//! Updates data defined buttons to reflect current state of atlas (eg coverage layer)
@ -108,10 +108,10 @@ class QgsComposerItemBaseWidget: public QgsPanelWidget
void registerDataDefinedButton( QgsDataDefinedButton* button, QgsComposerObject::DataDefinedProperty property,
QgsDataDefinedButton::DataType type, const QString& description );
/** Returns the current atlas coverage layer (if set)*/
//! Returns the current atlas coverage layer (if set)
QgsVectorLayer* atlasCoverageLayer() const;
/** Returns the atlas for the composition*/
//! Returns the atlas for the composition
QgsAtlasComposition *atlasComposition() const;
private:
@ -128,12 +128,12 @@ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBa
QgsComposerItemWidget( QWidget* parent, QgsComposerItem* item );
~QgsComposerItemWidget();
/** A combination of upper/middle/lower and left/middle/right*/
//! A combination of upper/middle/lower and left/middle/right
QgsComposerItem::ItemPositionMode positionMode() const;
/** Toggles display of the background group*/
//! Toggles display of the background group
void showBackgroundGroup( bool showGroup );
/** Toggles display of the frame group*/
//! Toggles display of the frame group
void showFrameGroup( bool showGroup );
public slots:
@ -183,7 +183,7 @@ class QgsComposerItemWidget: public QWidget, private Ui::QgsComposerItemWidgetBa
void setValuesForGuiNonPositionElements();
protected slots:
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
private:

2
src/app/composer/qgscomposerlegenditemdialog.h
View File

@ -34,7 +34,7 @@ class QgsComposerLegendItemDialog: public QDialog, private Ui::QgsComposerLegend
QgsComposerLegendItemDialog( const QStandardItem* item, QWidget* parent = nullptr );
~QgsComposerLegendItemDialog();
/** Returns the item text inserted by user*/
//! Returns the item text inserted by user
QString itemText() const;
private:

2
src/app/composer/qgscomposerlegendlayersdialog.h
View File

@ -34,7 +34,7 @@ class QgsComposerLegendLayersDialog: public QDialog, private Ui::QgsComposerLege
private:
QgsComposerLegendLayersDialog(); //forbidden
/** Stores the relation between items and map layer pointers. */
//! Stores the relation between items and map layer pointers.
QMap<QListWidgetItem*, QgsMapLayer*> mItemLayerMap;
};

6
src/app/composer/qgscomposerlegendwidget.h
View File

@ -37,7 +37,7 @@ class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::Qgs
explicit QgsComposerLegendWidget( QgsComposerLegend* legend );
~QgsComposerLegendWidget();
/** Updates the legend layers and groups*/
//! Updates the legend layers and groups
void updateLegend();
QgsComposerLegend* legend() { return mLegend; }
@ -94,10 +94,10 @@ class QgsComposerLegendWidget: public QgsComposerItemBaseWidget, private Ui::Qgs
void setCurrentNodeStyleFromAction();
private slots:
/** Sets GUI according to state of mLegend*/
//! Sets GUI according to state of mLegend
void setGuiElements();
/** Update the enabling state of the filter by atlas button */
//! Update the enabling state of the filter by atlas button
void updateFilterLegendByAtlasButton();
void on_mItemTreeView_doubleClicked( const QModelIndex &index );

18
src/app/composer/qgscomposermanager.h
View File

@ -24,7 +24,7 @@
class QListWidgetItem;
class QgsComposer;
/** Delegate for a line edit for renaming a composer. Prevents entry of duplicate composer names.*/
//! Delegate for a line edit for renaming a composer. Prevents entry of duplicate composer names.
class QgsComposerNameDelegate : public QItemDelegate
{
Q_OBJECT
@ -55,7 +55,7 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase
void addTemplates( const QMap<QString, QString>& templates );
public slots:
/** Raise, unminimize and activate this window */
//! Raise, unminimize and activate this window
void activate();
private:
@ -90,24 +90,24 @@ class QgsComposerManager: public QDialog, private Ui::QgsComposerManagerBase
#endif
private slots:
/** Slot to update buttons state when selecting compositions */
//! Slot to update buttons state when selecting compositions
void toggleButtons();
void on_mAddButton_clicked();
/** Slot to track combobox to use specific template path */
//! Slot to track combobox to use specific template path
void on_mTemplate_currentIndexChanged( int indx );
/** Slot to choose path to template */
//! Slot to choose path to template
void on_mTemplatePathBtn_pressed();
/** Slot to open default templates dir with user's system */
//! Slot to open default templates dir with user's system
void on_mTemplatesDefaultDirBtn_pressed();
/** Slot to open user templates dir with user's system */
//! Slot to open user templates dir with user's system
void on_mTemplatesUserDirBtn_pressed();
/** Refreshes the list of composers */
//! Refreshes the list of composers
void refreshComposers();
void remove_clicked();
void show_clicked();
/** Duplicate composer */
//! Duplicate composer
void duplicate_clicked();
void rename_clicked();
void on_mComposerListWidget_itemChanged( QListWidgetItem * item );

12
src/app/composer/qgscomposermapgridwidget.h
View File

@ -93,16 +93,16 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg
protected:
/** Sets the current composer map values to the GUI elements*/
//! Sets the current composer map values to the GUI elements
virtual void updateGuiElements();
protected slots:
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
private slots:
/** Sets the GUI elements to the values of mPicture*/
//! Sets the GUI elements to the values of mPicture
void setGuiElementValues();
void updateGridLineStyleFromWidget();
@ -114,7 +114,7 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg
QgsComposerMap* mComposerMap;
QgsComposerMapGrid* mComposerMapGrid;
/** Blocks / unblocks the signals of all GUI elements*/
//! Blocks / unblocks the signals of all GUI elements
void blockAllSignals( bool b );
void handleChangedFrameDisplay( QgsComposerMapGrid::BorderSide border, const QgsComposerMapGrid::DisplayMode mode );
@ -135,10 +135,10 @@ class QgsComposerMapGridWidget: public QgsComposerItemBaseWidget, private Ui::Qg
void updateGridLineSymbolMarker();
void updateGridMarkerSymbolMarker();
/** Enables/disables grid frame related controls*/
//! Enables/disables grid frame related controls
void toggleFrameControls( bool frameEnabled, bool frameFillEnabled, bool frameSizeEnabled );
/** Is there some predefined scales, globally or as project's options ?*/
//! Is there some predefined scales, globally or as project's options ?
bool hasPredefinedScales() const;
};

20
src/app/composer/qgscomposermapwidget.h
View File

@ -93,22 +93,22 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom
void addPageToToolbox( QWidget * widget, const QString& name );
/** Sets the current composer map values to the GUI elements*/
//! Sets the current composer map values to the GUI elements
virtual void updateGuiElements();
protected slots:
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
private slots:
/** Sets the GUI elements to the values of mPicture*/
//! Sets the GUI elements to the values of mPicture
void setGuiElementValues();
/** Enables or disables the atlas margin around feature option depending on coverage layer type*/
//! Enables or disables the atlas margin around feature option depending on coverage layer type
void atlasLayerChanged( QgsVectorLayer* layer );
/** Enables or disables the atlas controls when composer atlas is toggled on/off*/
//! Enables or disables the atlas controls when composer atlas is toggled on/off
void compositionAtlasToggled( bool atlasEnabled );
void aboutToShowKeepLayersVisibilityPresetsMenu();
@ -124,10 +124,10 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom
private:
QgsComposerMap* mComposerMap;
/** Sets extent of composer map from line edits*/
//! Sets extent of composer map from line edits
void updateComposerExtentFromGui();
/** Blocks / unblocks the signals of all GUI elements*/
//! Blocks / unblocks the signals of all GUI elements
void blockAllSignals( bool b );
void handleChangedFrameDisplay( QgsComposerMapGrid::BorderSide border, const QgsComposerMapGrid::DisplayMode mode );
@ -145,13 +145,13 @@ class QgsComposerMapWidget: public QgsComposerItemBaseWidget, private Ui::QgsCom
void initAnnotationPositionBox( QComboBox* c, QgsComposerMapGrid::AnnotationPosition pos );
void initAnnotationDirectionBox( QComboBox* c, QgsComposerMapGrid::AnnotationDirection dir );
/** Enables or disables the atlas margin and predefined scales radio depending on the atlas coverage layer type*/
//! Enables or disables the atlas margin and predefined scales radio depending on the atlas coverage layer type
void toggleAtlasScalingOptionsByLayerType();
/** Recalculates the bounds for an atlas map when atlas properties change*/
//! Recalculates the bounds for an atlas map when atlas properties change
void updateMapForAtlas();
/** Is there some predefined scales, globally or as project's options ?*/
//! Is there some predefined scales, globally or as project's options ?
bool hasPredefinedScales() const;
QListWidgetItem* addGridListItem( const QString& id, const QString& name );

16
src/app/composer/qgscomposerpicturewidget.h
View File

@ -34,7 +34,7 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg
explicit QgsComposerPictureWidget( QgsComposerPicture* picture );
~QgsComposerPictureWidget();
/** Add the icons of the standard directories to the preview*/
//! Add the icons of the standard directories to the preview
void addStandardDirectoriesToPreview();
public slots:
@ -53,14 +53,14 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg
void resizeEvent( QResizeEvent * event ) override;
protected slots:
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
private slots:
/** Sets the GUI elements to the values of mPicture*/
//! Sets the GUI elements to the values of mPicture
void setGuiElementValues();
/** Sets the picture rotation GUI control value*/
//! Sets the picture rotation GUI control value
void setPicRotationSpinValue( double r );
/** Load SVG and pixel-based image previews
@ -75,15 +75,15 @@ class QgsComposerPictureWidget: public QgsComposerItemBaseWidget, private Ui::Qg
private:
QgsComposerPicture* mPicture;
/** Whether the picture selection previews have been loaded */
//! Whether the picture selection previews have been loaded
bool mPreviewsLoaded;
/** Add the icons of a directory to the preview. Returns 0 in case of success*/
//! Add the icons of a directory to the preview. Returns 0 in case of success
int addDirectoryToPreview( const QString& path );
/** Tests if a file is valid svg*/
//! Tests if a file is valid svg
bool testSvgFile( const QString& filename ) const;
/** Tests if a file is a valid pixel format*/
//! Tests if a file is a valid pixel format
bool testImageFile( const QString& filename ) const;
//! Renders an svg file to a QIcon, correctly handling any SVG parameters present in the file

2
src/app/composer/qgscomposerpolygonwidget.h
View File

@ -41,7 +41,7 @@ class QgsComposerPolygonWidget: public QgsComposerItemBaseWidget, private Ui::Qg
private slots:
void on_mPolygonStyleButton_clicked();
/** Sets the GUI elements to the currentValues of mComposerShape*/
//! Sets the GUI elements to the currentValues of mComposerShape
void setGuiElementValues();
void updateStyleFromWidget();

2
src/app/composer/qgscomposerpolylinewidget.h
View File

@ -41,7 +41,7 @@ class QgsComposerPolylineWidget: public QgsComposerItemBaseWidget, private Ui::Q
private slots:
void on_mLineStyleButton_clicked();
/** Sets the GUI elements to the currentValues of mComposerShape*/
//! Sets the GUI elements to the currentValues of mComposerShape
void setGuiElementValues();
void updateStyleFromWidget();

4
src/app/composer/qgscomposerscalebarwidget.h
View File

@ -66,10 +66,10 @@ class QgsComposerScaleBarWidget: public QgsComposerItemBaseWidget, private Ui::Q
QgsComposerScaleBar* mComposerScaleBar;
QButtonGroup mSegmentSizeRadioGroup;
/** Enables/disables the signals of the input gui elements*/
//! Enables/disables the signals of the input gui elements
void blockMemberSignals( bool enable );
/** Enables/disables controls based on scale bar style*/
//! Enables/disables controls based on scale bar style
void toggleStyleSpecificControls( const QString& style );
void connectUpdateSignal();

8
src/app/composer/qgscomposershapewidget.h
View File

@ -23,7 +23,7 @@
class QgsComposerShape;
/** Input widget for QgsComposerShape*/
//! Input widget for QgsComposerShape
class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerShapeWidgetBase
{
Q_OBJECT
@ -34,7 +34,7 @@ class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsC
private:
QgsComposerShape* mComposerShape;
/** Blocks / unblocks the signal of all GUI elements*/
//! Blocks / unblocks the signal of all GUI elements
void blockAllSignals( bool block );
private slots:
@ -42,12 +42,12 @@ class QgsComposerShapeWidget: public QgsComposerItemBaseWidget, private Ui::QgsC
void on_mCornerRadiusSpinBox_valueChanged( double val );
void on_mShapeStyleButton_clicked();
/** Sets the GUI elements to the currentValues of mComposerShape*/
//! Sets the GUI elements to the currentValues of mComposerShape
void setGuiElementValues();
void updateShapeStyle();
/** Enables or disables the rounded radius spin box based on shape type*/
//! Enables or disables the rounded radius spin box based on shape type
void toggleRadiusSpin( const QString& shapeText );
void updateSymbolFromWidget();
void cleanUpSymbolSelector( QgsPanelWidget* container );

2
src/app/composer/qgscomposertablebackgroundcolorsdialog.h
View File

@ -56,7 +56,7 @@ class QgsComposerTableBackgroundColorsDialog: public QDialog, private Ui::QgsCom
QMap< QgsComposerTableV2::CellStyleGroup, QgsColorButton* > mColorButtonMap;
/** Sets the GUI elements to the values of the table*/
//! Sets the GUI elements to the values of the table
void setGuiElementValues();

26
src/app/composer/qgscompositionwidget.h
View File

@ -61,23 +61,23 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid
void on_mOffsetYSpinBox_valueChanged( double d );
void on_mSnapToleranceSpinBox_valueChanged( int tolerance );
/** Sets GUI elements to width/height from composition*/
//! Sets GUI elements to width/height from composition
void displayCompositionWidthHeight();
/** Sets Print as raster checkbox value*/
//! Sets Print as raster checkbox value
void setPrintAsRasterCheckBox( bool state );
/** Sets number of pages spin box value*/
//! Sets number of pages spin box value
void setNumberPages();
signals:
/** Is emitted when page orientation changes*/
//! Is emitted when page orientation changes
void pageOrientationChanged( const QString& orientation );
private slots:
/** Must be called when a data defined button changes*/
//! Must be called when a data defined button changes
void updateDataDefinedProperty();
/** Initializes data defined buttons to current atlas coverage layer*/
//! Initializes data defined buttons to current atlas coverage layer
void populateDataDefinedButtons();
void variablesChanged();
@ -94,13 +94,13 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid
QMap<QString, QgsCompositionPaper> mPaperMap;
QgsCompositionWidget(); //default constructor is forbidden
/** Sets width/height to chosen paper format and updates paper item*/
//! Sets width/height to chosen paper format and updates paper item
void applyCurrentPaperSettings();
/** Applies the current width and height values*/
//! Applies the current width and height values
void applyWidthHeight();
/** Makes sure width/height values for custom paper matches the current orientation*/
//! Makes sure width/height values for custom paper matches the current orientation
void adjustOrientation();
/** Sets GUI elements to snaping distances of composition*/
//! Sets GUI elements to snaping distances of composition
void displaySnapingSettings();
void updatePageStyle();
@ -110,13 +110,13 @@ class QgsCompositionWidget: public QgsPanelWidget, private Ui::QgsCompositionWid
double size( QDoubleSpinBox *spin );
void setSize( QDoubleSpinBox *spin, double v );
/** Blocks / unblocks the signals of all items*/
//! Blocks / unblocks the signals of all items
void blockSignals( bool block );
/** Sets a data defined property for the item from its current data defined button settings*/
//! Sets a data defined property for the item from its current data defined button settings
void setDataDefinedProperty( const QgsDataDefinedButton *ddBtn, QgsComposerObject::DataDefinedProperty property );
/** Returns the data defined property corresponding to a data defined button widget*/
//! Returns the data defined property corresponding to a data defined button widget
virtual QgsComposerObject::DataDefinedProperty ddPropertyForWidget( QgsDataDefinedButton* widget );

4
src/app/legend/qgsapplegendinterface.h
View File

@ -37,10 +37,10 @@ class QgsAppLegendInterface : public QgsLegendInterface
public:
/** Constructor */
//! Constructor
explicit QgsAppLegendInterface( QgsLayerTreeView * layerTreeView );
/** Destructor */
//! Destructor
~QgsAppLegendInterface();
//! Return a string list of groups

30
src/app/nodetool/qgsmaptoolnodetool.h
View File

@ -26,7 +26,7 @@ class QgsVertexEntry;
class QgsSelectedFeature;
class QgsNodeEditor;
/** A maptool to move/deletes/adds vertices of line or polygon features*/
//! A maptool to move/deletes/adds vertices of line or polygon features
class QgsMapToolNodeTool: public QgsMapToolEdit
{
Q_OBJECT
@ -138,46 +138,46 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
and applies it to the map canvas*/
QgsMapCanvasSnapper mSnapper;
/** Rubber bands during node move */
//! Rubber bands during node move
QMap<QgsFeatureId, QgsGeometryRubberBand*> mMoveRubberBands;
/** Rubber band for selected feature */
//! Rubber band for selected feature
QgsGeometryRubberBand* mSelectRubberBand;
/** Vertices of features to move */
//! Vertices of features to move
QMap<QgsFeatureId, QList< QPair<QgsVertexId, QgsPointV2> > > mMoveVertices;
/** Object containing selected feature and it's vertexes */
//! Object containing selected feature and it's vertexes
QgsSelectedFeature *mSelectedFeature;
/** Dock widget which allows editing vertices */
//! Dock widget which allows editing vertices
QgsNodeEditor* mNodeEditor;
/** Flag if moving of vertexes is occurring */
//! Flag if moving of vertexes is occurring
bool mMoving;
/** Flag if selection of another feature can occur */
//! Flag if selection of another feature can occur
bool mSelectAnother;
/** Feature id of another feature where user clicked */
//! Feature id of another feature where user clicked
QgsFeatureId mAnother;
/** Stored position of last press down action to count how much vertexes should be moved */
//! Stored position of last press down action to count how much vertexes should be moved
QPoint mPressCoordinates;
/** Closest vertex to click in map coordinates */
//! Closest vertex to click in map coordinates
QgsPoint mClosestMapVertex;
/** Active rubberband for selecting vertexes */
//! Active rubberband for selecting vertexes
QRubberBand *mSelectionRubberBand;
/** Rectangle defining area for selecting vertexes */
//! Rectangle defining area for selecting vertexes
QRect* mRect;
/** Flag to tell if edition points */
//! Flag to tell if edition points
bool mIsPoint;
/** Vertex to deselect on release */
//! Vertex to deselect on release
int mDeselectOnRelease;
};

4
src/app/ogr/qgsnewogrconnection.cpp
View File

@ -100,7 +100,7 @@ void QgsNewOgrConnection::testConnection()
}
}
/** Autoconnected SLOTS **/
//! Autoconnected SLOTS *
void QgsNewOgrConnection::accept()
{
QSettings settings;
@ -140,4 +140,4 @@ void QgsNewOgrConnection::on_btnConnect_clicked()
testConnection();
}
/** End Autoconnected SLOTS **/
//! End Autoconnected SLOTS *

4
src/app/ogr/qgsvectorlayersaveasdialog.h
View File

@ -53,7 +53,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
QStringList layerOptions() const;
long crs() const;
QgsAttributeList selectedAttributes() const;
/** Return selected attributes that must be exported with their displayed values instead of their raw values. Added in QGIS 2.16 */
//! Return selected attributes that must be exported with their displayed values instead of their raw values. Added in QGIS 2.16
QgsAttributeList attributesAsDisplayedValues() const;
bool addToCanvas() const;
/** Returns type of symbology export.
@ -101,7 +101,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
*/
void setIncludeZ( bool checked );
/** Returns creation action */
//! Returns creation action
QgsVectorFileWriter::ActionOnExistingFile creationActionOnExistingFile() const;
private slots:

4
src/app/qgisapp.cpp
View File

@ -9255,13 +9255,13 @@ void QgisApp::unregisterMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactor
mMapStyleWidget->setPageFactories( mMapLayerPanelFactories );
}
/** Get a pointer to the currently selected map layer */
//! Get a pointer to the currently selected map layer
QgsMapLayer *QgisApp::activeLayer()
{
return mLayerTreeView ? mLayerTreeView->currentLayer() : nullptr;
}
/** Set the current layer */
//! Set the current layer
bool QgisApp::setActiveLayer( QgsMapLayer *layer )
{
if ( !layer )

108
src/app/qgisapp.h
View File

@ -183,10 +183,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/
QString crsAndFormatAdjustedLayerUri( const QString& uri, const QStringList& supportedCrs, const QStringList& supportedFormats ) const;
/** Add a 'pre-made' map layer to the project */
//! Add a 'pre-made' map layer to the project
void addMapLayer( QgsMapLayer *theMapLayer );
/** Set the extents of the map canvas */
//! Set the extents of the map canvas
void setExtent( const QgsRectangle& theRect );
//! Remove all layers from the map and legend - reimplements same method from qgisappbase
void removeAllLayers();
@ -217,16 +217,16 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//!Overloaded version of the private function with same name that takes the imagename as a parameter
void saveMapAsImage( const QString&, QPixmap * );
/** Get the mapcanvas object from the app */
//! Get the mapcanvas object from the app
QgsMapCanvas *mapCanvas();
/** Return the messageBar object which allows displaying unobtrusive messages to the user.*/
//! Return the messageBar object which allows displaying unobtrusive messages to the user.
QgsMessageBar *messageBar();
/** Open the message log dock widget **/
//! Open the message log dock widget *
void openMessageLog();
/** Adds a widget to the user input tool bar.*/
//! Adds a widget to the user input tool bar.
void addUserInputWidget( QWidget* widget );
//! Set theme (icons)
@ -278,7 +278,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* windows which are hidden rather than deleted when closed. */
void removeWindow( QAction *action );
/** Returns the print composers*/
//! Returns the print composers
QSet<QgsComposer*> printComposers() const {return mPrintComposers;}
/** Get a unique title from user for new and duplicate composers
* @param acceptEmpty whether to accept empty titles (one will be generated)
@ -286,15 +286,15 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* @return QString::null if user cancels input dialog
*/
bool uniqueComposerTitle( QWidget *parent, QString& composerTitle, bool acceptEmpty, const QString& currentTitle = QString() );
/** Creates a new composer and returns a pointer to it*/
//! Creates a new composer and returns a pointer to it
QgsComposer* createNewComposer( QString title = QString() );
/** Deletes a composer and removes entry from Set*/
//! Deletes a composer and removes entry from Set
void deleteComposer( QgsComposer *c );
/** Duplicates a composer and adds it to Set
*/
QgsComposer *duplicateComposer( QgsComposer *currentComposer, QString title = QString() );
/** Overloaded function used to sort menu entries alphabetically */
//! Overloaded function used to sort menu entries alphabetically
QMenu* createPopupMenu() override;
/**
@ -388,7 +388,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QAction *actionLayerSaveAs() { return mActionLayerSaveAs; }
QAction *actionRemoveLayer() { return mActionRemoveLayer; }
QAction *actionDuplicateLayer() { return mActionDuplicateLayer; }
/** @note added in 2.4 */
//! @note added in 2.4
QAction *actionSetLayerScaleVisibility() { return mActionSetLayerScaleVisibility; }
QAction *actionSetLayerCrs() { return mActionSetLayerCRS; }
QAction *actionSetProjectCrsFromLayer() { return mActionSetProjectCRSFromLayer; }
@ -493,7 +493,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* @returns list of layers in legend order, or empty list */
QList<QgsMapLayer *> editableLayers( bool modified = false ) const;
/** Get timeout for timed messages: default of 5 seconds */
//! Get timeout for timed messages: default of 5 seconds
int messageTimeout();
//! emit initializationCompleted signal
@ -504,7 +504,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QList<QgsDecorationItem*> decorationItems() { return mDecorationItems; }
void addDecorationItem( QgsDecorationItem *item ) { mDecorationItems.append( item ); }
/** @note added in 2.1 */
//! @note added in 2.1
static QString normalizedMenuName( const QString & name ) { return name.normalized( QString::NormalizationForm_KD ).remove( QRegExp( "[^a-zA-Z]" ) ); }
#ifdef Q_OS_WIN
@ -513,19 +513,19 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void parseVersionInfo( QNetworkReply* reply, int& latestVersion, QStringList& versionInfo );
/** Register a new tab in the layer properties dialog */
//! Register a new tab in the layer properties dialog
void registerMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactory* factory );
/** Unregister a previously registered tab in the layer properties dialog */
//! Unregister a previously registered tab in the layer properties dialog
void unregisterMapLayerPropertiesFactory( QgsMapLayerConfigWidgetFactory* factory );
/** Register a new custom drop handler. */
//! Register a new custom drop handler.
void registerCustomDropHandler( QgsCustomDropHandler* handler );
/** Unregister a previously registered custom drop handler. */
//! Unregister a previously registered custom drop handler.
void unregisterCustomDropHandler( QgsCustomDropHandler* handler );
/** Process the list of URIs that have been dropped in QGIS */
//! Process the list of URIs that have been dropped in QGIS
void handleDropUriList( const QgsMimeDataUtils::UriList& lst );
public slots:
@ -570,7 +570,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! starts/stops editing mode of a layer
bool toggleEditing( QgsMapLayer *layer, bool allowCancel = true );
/** Save edits for active vector layer and start new transactions */
//! Save edits for active vector layer and start new transactions
void saveActiveLayerEdits();
/** Save edits of a layer
@ -588,19 +588,19 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! Save current edits for selected layer(s) and start new transaction(s)
void saveEdits();
/** Save edits for all layers and start new transactions */
//! Save edits for all layers and start new transactions
void saveAllEdits( bool verifyAction = true );
/** Rollback current edits for selected layer(s) and start new transaction(s) */
//! Rollback current edits for selected layer(s) and start new transaction(s)
void rollbackEdits();
/** Rollback edits for all layers and start new transactions */
//! Rollback edits for all layers and start new transactions
void rollbackAllEdits( bool verifyAction = true );
/** Cancel edits for selected layer(s) and toggle off editing */
//! Cancel edits for selected layer(s) and toggle off editing
void cancelEdits();
/** Cancel all edits for all layers and toggle off editing */
//! Cancel all edits for all layers and toggle off editing
void cancelAllEdits( bool verifyAction = true );
void updateUndoActions();
@ -644,7 +644,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void copyFeatures( QgsFeatureStore & featureStore );
void loadGDALSublayers( const QString& uri, const QStringList& list );
/** Deletes the selected attributes for the currently selected vector layer*/
//! Deletes the selected attributes for the currently selected vector layer
void deleteSelected( QgsMapLayer *layer = nullptr, QWidget *parent = nullptr, bool promptConfirmation = false );
//! project was written
@ -679,10 +679,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! Watch for QFileOpenEvent.
virtual bool event( QEvent *event ) override;
/** Open a raster layer using the Raster Data Provider. */
//! Open a raster layer using the Raster Data Provider.
QgsRasterLayer *addRasterLayer( QString const & uri, QString const & baseName, QString const & providerKey );
/** Open a plugin layer using its provider */
//! Open a plugin layer using its provider
QgsPluginLayer* addPluginLayer( const QString& uri, const QString& baseName, const QString& providerKey );
void addWfsLayer( const QString& uri, const QString& typeName );
@ -793,12 +793,12 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
Only workds on raster layers*/
void legendLayerStretchUsingCurrentExtent();
/** Apply the same style to selected layers or to current legend group*/
//! Apply the same style to selected layers or to current legend group
void applyStyleToGroup();
/** Set the CRS of the current legend group*/
//! Set the CRS of the current legend group
void legendGroupSetCrs();
/** Set the WMS data of the current legend group*/
//! Set the WMS data of the current legend group
void legendGroupSetWmsData();
//! zoom to extent of layer
@ -813,9 +813,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
* (stretch based on pixels values in full dataset)
* Valid for non wms raster layers only. */
void fullHistogramStretch();
/** Perform a local cumulative cut stretch */
//! Perform a local cumulative cut stretch
void localCumulativeCutStretch();
/** Perform a full extent cumulative cut stretch */
//! Perform a full extent cumulative cut stretch
void fullCumulativeCutStretch();
/** Increase raster brightness
* Valid for non wms raster layers only. */
@ -960,9 +960,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void fileNewBlank();
//! As above but allows forcing without prompt and forcing blank project
void fileNew( bool thePromptToSaveFlag, bool forceBlank = false );
/** What type of project to open after launch */
//! What type of project to open after launch
void fileOpenAfterLaunch();
/** After project read, set any auto-opened project as successful */
//! After project read, set any auto-opened project as successful
void fileOpenedOKAfterLaunch();
//! Create a new file from a template project
bool fileNewFromTemplate( const QString& fileName );
@ -1112,10 +1112,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! stop "busy" progress bar
void canvasRefreshFinished();
/** Dialog for verification of action on many edits */
//! Dialog for verification of action on many edits
bool verifyEditsActionDialog( const QString& act, const QString& upon );
/** Update gui actions/menus when layers are modified */
//! Update gui actions/menus when layers are modified
void updateLayerModifiedActions();
//! change layer subset of current vector layer
@ -1130,10 +1130,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! change log message icon in statusbar
void toggleLogMessageIcon( bool hasLogMessage );
/** Called when some layer's editing mode was toggled on/off */
//! Called when some layer's editing mode was toggled on/off
void layerEditStateChanged();
/** Update the label toolbar buttons */
//! Update the label toolbar buttons
void updateLabelToolButtons();
/** Activates or deactivates actions depending on the current maplayer type.
@ -1203,13 +1203,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void modifyAnnotation();
void reprojectAnnotations();
/** Alerts user when labeling font for layer has not been found on system */
//! Alerts user when labeling font for layer has not been found on system
void labelingFontNotFound( QgsVectorLayer *vlayer, const QString& fontfamily );
/** Alerts user when commit errors occurred */
//! Alerts user when commit errors occurred
void commitError( QgsVectorLayer *vlayer );
/** Opens the labeling dialog for a layer when called from labelingFontNotFound alert */
//! Opens the labeling dialog for a layer when called from labelingFontNotFound alert
void labelingDialogFontNotFound( QAction *act );
//! shows label settings dialog (for labeling-ng)
@ -1266,10 +1266,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void writeAnnotationItemsToProject( QDomDocument& doc );
/** Creates the composer instances in a project file and adds them to the menu*/
//! Creates the composer instances in a project file and adds them to the menu
bool loadComposersFromProject( const QDomDocument& doc );
/** Slot to handle display of composers menu, e.g. sorting */
//! Slot to handle display of composers menu, e.g. sorting
void on_mPrintComposersMenu_aboutToShow();
bool loadAnnotationItemsFromProject( const QDomDocument& doc );
@ -1333,10 +1333,10 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/
void showStatisticsDockWidget();
/** Pushes a layer error to the message bar */
//! Pushes a layer error to the message bar
void onLayerError( const QString& msg );
/** Set the layer for the map style dock. Doesn't show the style dock */
//! Set the layer for the map style dock. Doesn't show the style dock
void setMapStyleDockLayer( QgsMapLayer *layer );
//! Handles processing of dropped mimedata
@ -1380,7 +1380,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
@note added in version 2.3*/
void composerRemoved( QgsComposerView* v );
/** This signal is emitted when QGIS' initialization is complete */
//! This signal is emitted when QGIS' initialization is complete
void initializationCompleted();
void customCrsValidation( QgsCoordinateReferenceSystem &crs );
@ -1415,7 +1415,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/
bool addRasterLayer( QgsRasterLayer * theRasterLayer );
/** Open a raster layer - this is the generic function which takes all parameters */
//! Open a raster layer - this is the generic function which takes all parameters
QgsRasterLayer* addRasterLayerPrivate( const QString & uri, const QString & baseName,
const QString & providerKey, bool guiWarning,
bool guiUpdate );
@ -1439,7 +1439,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
@return empty geometry in case of error or if canceled */
QgsGeometry unionGeometries( const QgsVectorLayer* vl, QgsFeatureList& featureList, bool &canceled );
/** Deletes all the composer objects and clears mPrintComposers*/
//! Deletes all the composer objects and clears mPrintComposers
void deletePrintComposers();
void saveAsVectorFileGeneral( QgsVectorLayer* vlayer = nullptr, bool symbologyOption = true );
@ -1450,9 +1450,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
*/
QgsVectorLayer * pasteToNewMemoryVector();
/** Returns all annotation items in the canvas*/
//! Returns all annotation items in the canvas
QList<QgsAnnotationItem*> annotationItems();
/** Removes annotation items in the canvas*/
//! Removes annotation items in the canvas
void removeAnnotationItems();
//! Configure layer tree view according to the user options from QSettings
@ -1478,13 +1478,13 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void updateCrsStatusBar();
void createDecorations();
/** Do histogram stretch for singleband gray / multiband color rasters*/
//! Do histogram stretch for singleband gray / multiband color rasters
void histogramStretch( bool visibleAreaOnly = false, QgsRaster::ContrastEnhancementLimits theLimits = QgsRaster::ContrastEnhancementMinMax );
/** Apply raster brightness */
//! Apply raster brightness
void adjustBrightnessContrast( int delta, bool updateBrightness = true );
/** Copy a vector style from a layer to another one, if they have the same geometry type */
//! Copy a vector style from a layer to another one, if they have the same geometry type
void duplicateVectorStyle( QgsVectorLayer* srcLayer, QgsVectorLayer* destLayer );
QgisAppStyleSheet *mStyleSheetBuilder;
@ -1695,7 +1695,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QList<QgsWelcomePageItemsModel::RecentProjectData> mRecentProjects;
//! Print composers of this project, accessible by id string
QSet<QgsComposer*> mPrintComposers;
/** QGIS-internal vector feature clipboard */
//! QGIS-internal vector feature clipboard
QgsClipboard *mInternalClipboard;
//! Flag to indicate how the project properties dialog was summoned
bool mShowProjectionTab;

52
src/app/qgisappinterface.h
View File

@ -165,7 +165,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
#endif
void openURL( const QString& url, bool useQgisDocDirectory = true ) override;
/** Return a pointer to the map canvas used by qgisapp */
//! Return a pointer to the map canvas used by qgisapp
QgsMapCanvas * mapCanvas() override;
/**
@ -184,10 +184,10 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
QgsMessageBar * messageBar() override;
/** Open the message log dock widget **/
//! Open the message log dock widget *
void openMessageLog() override;
/** Adds a widget to the user input tool bar.*/
//! Adds a widget to the user input tool bar.
void addUserInputWidget( QWidget* widget ) override;
// ### QGIS 3: return QgsComposer*, not QgsComposerView*
@ -210,56 +210,56 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
*/
QgsComposerView* duplicateComposer( QgsComposerView* composerView, const QString& title = QString() ) override;
/** Deletes parent composer of composer view, after closing composer window */
//! Deletes parent composer of composer view, after closing composer window
void deleteComposer( QgsComposerView* composerView ) override;
/** Return changeable options built from settings and/or defaults */
//! Return changeable options built from settings and/or defaults
QMap<QString, QVariant> defaultStyleSheetOptions() override;
/** Generate stylesheet
* @param opts generated default option values, or a changed copy of them */
void buildStyleSheet( const QMap<QString, QVariant>& opts ) override;
/** Save changed default option keys/values to user settings */
//! Save changed default option keys/values to user settings
void saveStyleSheetOptions( const QMap<QString, QVariant>& opts ) override;
/** Get reference font for initial qApp (may not be same as QgisApp) */
//! Get reference font for initial qApp (may not be same as QgisApp)
QFont defaultStyleSheetFont() override;
/** Add action to the plugins menu */
//! Add action to the plugins menu
void addPluginToMenu( const QString& name, QAction* action ) override;
/** Remove action from the plugins menu */
//! Remove action from the plugins menu
void removePluginMenu( const QString& name, QAction* action ) override;
/** Add action to the Database menu */
//! Add action to the Database menu
void addPluginToDatabaseMenu( const QString& name, QAction* action ) override;
/** Remove action from the Database menu */
//! Remove action from the Database menu
void removePluginDatabaseMenu( const QString& name, QAction* action ) override;
/** Add action to the Raster menu */
//! Add action to the Raster menu
void addPluginToRasterMenu( const QString& name, QAction* action ) override;
/** Remove action from the Raster menu */
//! Remove action from the Raster menu
void removePluginRasterMenu( const QString& name, QAction* action ) override;
/** Add action to the Vector menu */
//! Add action to the Vector menu
void addPluginToVectorMenu( const QString& name, QAction* action ) override;
/** Remove action from the Raster menu */
//! Remove action from the Raster menu
void removePluginVectorMenu( const QString& name, QAction* action ) override;
/** Add action to the Web menu */
//! Add action to the Web menu
void addPluginToWebMenu( const QString& name, QAction* action ) override;
/** Remove action from the Web menu */
//! Remove action from the Web menu
void removePluginWebMenu( const QString& name, QAction* action ) override;
/** Add "add layer" action to the layer menu */
//! Add "add layer" action to the layer menu
void insertAddLayerAction( QAction *action ) override;
/** Remove "add layer" action from the layer menu */
//! Remove "add layer" action from the layer menu
void removeAddLayerAction( QAction *action ) override;
/** Add a dock widget to the main window */
//! Add a dock widget to the main window
void addDockWidget( Qt::DockWidgetArea area, QDockWidget * dockwidget ) override;
/** Remove specified dock widget from main window (doesn't delete it). */
//! Remove specified dock widget from main window (doesn't delete it).
void removeDockWidget( QDockWidget * dockwidget ) override;
//! return CAD dock widget
@ -282,10 +282,10 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* windows which are hidden rather than deleted when closed. */
virtual void removeWindow( QAction *action ) override;
/** Register action to the shortcuts manager so its shortcut can be changed in GUI. */
//! Register action to the shortcuts manager so its shortcut can be changed in GUI.
virtual bool registerMainWindowAction( QAction* action, const QString& defaultShortcut ) override;
/** Unregister a previously registered action. (e.g. when plugin is going to be unloaded. */
//! Unregister a previously registered action. (e.g. when plugin is going to be unloaded.
virtual bool unregisterMainWindowAction( QAction* action ) override;
/** Register a new tab in the vector layer properties dialog.
@ -408,9 +408,9 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
virtual QAction *actionAddRasterLayer() override;
virtual QAction *actionAddPgLayer() override;
virtual QAction *actionAddWmsLayer() override;
/** Get access to the native Add ArcGIS FeatureServer action. */
//! Get access to the native Add ArcGIS FeatureServer action.
virtual QAction *actionAddAfsLayer() override;
/** Get access to the native Add ArcGIS MapServer action. */
//! Get access to the native Add ArcGIS MapServer action.
virtual QAction *actionAddAmsLayer() override;
virtual QAction *actionCopyLayerStyle() override;
virtual QAction *actionPasteLayerStyle() override;
@ -500,7 +500,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
*/
virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const override;
/** Get timeout for timed messages: default of 5 seconds */
//! Get timeout for timed messages: default of 5 seconds
virtual int messageTimeout() override;
signals:

8
src/app/qgisappstylesheet.h
View File

@ -33,7 +33,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject
QgisAppStyleSheet( QObject * parent = nullptr );
~QgisAppStyleSheet();
/** Return changeable options built from settings and/or defaults */
//! Return changeable options built from settings and/or defaults
QMap<QString, QVariant> defaultOptions();
/** Generate stylesheet
@ -42,10 +42,10 @@ class APP_EXPORT QgisAppStyleSheet: public QObject
*/
void buildStyleSheet( const QMap<QString, QVariant>& opts );
/** Save changed default option keys/values to user settings */
//! Save changed default option keys/values to user settings
void saveToSettings( const QMap<QString, QVariant>& opts );
/** Get reference font for initial qApp */
//! Get reference font for initial qApp
QFont defaultFont() { return mDefaultFont; }
signals:
@ -55,7 +55,7 @@ class APP_EXPORT QgisAppStyleSheet: public QObject
void appStyleSheetChanged( const QString& appStyleSheet );
private:
/** Set active configuration values */
//! Set active configuration values
void setActiveValues();
// qt styles

2
src/app/qgsalignrasterdialog.cpp
View File

@ -55,7 +55,7 @@ static QString _rasterLayerName( const QString& filename )
/** Helper class to report progress */
//! Helper class to report progress
struct QgsAlignRasterDialogProgress : public QgsAlignRaster::ProgressHandler
{
explicit QgsAlignRasterDialogProgress( QProgressBar* pb ) : mPb( pb ) {}

4
src/app/qgsalignrasterdialog.h
View File

@ -21,7 +21,7 @@
class QgsAlignRaster;
/** Dialog providing user interface for QgsAlignRaster */
//! Dialog providing user interface for QgsAlignRaster
class QgsAlignRasterDialog : public QDialog, private Ui::QgsAlignRasterDialog
{
Q_OBJECT
@ -62,7 +62,7 @@ class QgsAlignRasterDialog : public QDialog, private Ui::QgsAlignRasterDialog
class QgsMapLayerComboBox;
class QCheckBox;
/** Simple dialog to display details of one layer's configuration */
//! Simple dialog to display details of one layer's configuration
class QgsAlignRasterLayerConfigDialog : public QDialog
{
Q_OBJECT

2
src/app/qgsbrowserdockwidget.h
View File

@ -50,7 +50,7 @@ class QgsBrowserPropertiesWidget : public QWidget
explicit QgsBrowserPropertiesWidget( QWidget* parent = nullptr );
static QgsBrowserPropertiesWidget* createWidget( QgsDataItem* item, QWidget* parent = nullptr );
virtual void setItem( QgsDataItem* item ) { Q_UNUSED( item ) }
/** Set content widget, usually item paramWidget. Takes ownership. */
//! Set content widget, usually item paramWidget. Takes ownership.
virtual void setWidget( QWidget* widget );
/** Sets whether the properties widget should display in condensed mode, ie, for display in a dock

10
src/app/qgsclipboard.h
View File

@ -57,9 +57,9 @@ class APP_EXPORT QgsClipboard : public QObject
//! Available formats for copying features as text
enum CopyFormat
{
AttributesOnly, /*!< Tab delimited text, attributes only */
AttributesWithWKT, /*!< Tab delimited text, with geometry in WKT format */
GeoJSON, /*!< GeoJSON FeatureCollection format */
AttributesOnly, //!< Tab delimited text, attributes only
AttributesWithWKT, //!< Tab delimited text, with geometry in WKT format
GeoJSON, //!< GeoJSON FeatureCollection format
};
/**
@ -145,7 +145,7 @@ class APP_EXPORT QgsClipboard : public QObject
void systemClipboardChanged();
signals:
/** Emitted when content changed */
//! Emitted when content changed
void changed();
private:
@ -181,7 +181,7 @@ class APP_EXPORT QgsClipboard : public QObject
QgsFields mFeatureFields;
QgsCoordinateReferenceSystem mCRS;
/** True when the data from the system clipboard should be read */
//! True when the data from the system clipboard should be read
bool mUseSystemClipboard;
friend class TestQgisAppClipboard;

84
src/app/qgsdecorationgrid.h
View File

@ -59,81 +59,81 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
BoundaryDirection
};
/** Sets coordinate grid style. */
//! Sets coordinate grid style.
void setGridStyle( GridStyle style ) {mGridStyle = style;}
GridStyle gridStyle() const { return mGridStyle; }
/** Sets coordinate interval in x-direction for composergrid. */
//! Sets coordinate interval in x-direction for composergrid.
void setGridIntervalX( double interval ) { mGridIntervalX = interval;}
double gridIntervalX() const { return mGridIntervalX; }
/** Sets coordinate interval in y-direction for composergrid. */
//! Sets coordinate interval in y-direction for composergrid.
void setGridIntervalY( double interval ) { mGridIntervalY = interval;}
double gridIntervalY() const { return mGridIntervalY; }
/** Sets x-coordinate offset for composer grid */
//! Sets x-coordinate offset for composer grid
void setGridOffsetX( double offset ) { mGridOffsetX = offset; }
double gridOffsetX() const { return mGridOffsetX; }
/** Sets y-coordinate offset for composer grid */
//! Sets y-coordinate offset for composer grid
void setGridOffsetY( double offset ) { mGridOffsetY = offset; }
double gridOffsetY() const { return mGridOffsetY; }
/** Sets the pen to draw composer grid */
//! Sets the pen to draw composer grid
void setGridPen( const QPen& p ) { mGridPen = p; }
QPen gridPen() const { return mGridPen; }
/** Sets with of grid pen */
//! Sets with of grid pen
void setGridPenWidth( double w ) { mGridPen.setWidthF( w ); }
/** Sets the color of the grid pen */
//! Sets the color of the grid pen
void setGridPenColor( const QColor& c ) { mGridPen.setColor( c ); }
/** Sets font for grid annotations */
//! Sets font for grid annotations
void setGridAnnotationFont( const QFont& f ) { mGridAnnotationFont = f; }
QFont gridAnnotationFont() const { return mGridAnnotationFont; }
/** Sets coordinate precision for grid annotations */
//! Sets coordinate precision for grid annotations
void setGridAnnotationPrecision( int p ) {mGridAnnotationPrecision = p;}
int gridAnnotationPrecision() const {return mGridAnnotationPrecision;}
/** Sets flag if grid annotation should be shown */
//! Sets flag if grid annotation should be shown
void setShowGridAnnotation( bool show ) {mShowGridAnnotation = show;}
bool showGridAnnotation() const {return mShowGridAnnotation;}
/** Sets position of grid annotations. Possibilities are inside or outside of the map frame */
//! Sets position of grid annotations. Possibilities are inside or outside of the map frame
void setGridAnnotationPosition( GridAnnotationPosition p ) {mGridAnnotationPosition = p;}
GridAnnotationPosition gridAnnotationPosition() const {return mGridAnnotationPosition;}
/** Sets distance between map frame and annotations */
//! Sets distance between map frame and annotations
void setAnnotationFrameDistance( double d ) {mAnnotationFrameDistance = d;}
double annotationFrameDistance() const {return mAnnotationFrameDistance;}
/** Sets grid annotation direction. Can be horizontal, vertical, direction of axis and horizontal and vertical */
//! Sets grid annotation direction. Can be horizontal, vertical, direction of axis and horizontal and vertical
void setGridAnnotationDirection( GridAnnotationDirection d ) {mGridAnnotationDirection = d;}
GridAnnotationDirection gridAnnotationDirection() const {return mGridAnnotationDirection;}
/** Sets length of the cros segments (if grid style is cross) */
//! Sets length of the cros segments (if grid style is cross)
/* void setCrossLength( double l ) {mCrossLength = l;} */
/* double crossLength() {return mCrossLength;} */
/** Set symbol that is used to draw grid lines. Takes ownership*/
//! Set symbol that is used to draw grid lines. Takes ownership
void setLineSymbol( QgsLineSymbol* symbol );
const QgsLineSymbol* lineSymbol() const { return mLineSymbol; }
/** Set symbol that is used to draw markers. Takes ownership*/
//! Set symbol that is used to draw markers. Takes ownership
void setMarkerSymbol( QgsMarkerSymbol* symbol );
const QgsMarkerSymbol* markerSymbol() const { return mMarkerSymbol; }
/** Sets map unit type */
//! Sets map unit type
void setMapUnits( QgsUnitTypes::DistanceUnit t ) { mMapUnits = t; }
QgsUnitTypes::DistanceUnit mapUnits() { return mMapUnits; }
/** Set mapUnits value */
//! Set mapUnits value
void setDirty( bool dirty = true );
bool isDirty();
/** Computes interval that is approx. 1/5 of canvas extent */
//! Computes interval that is approx. 1/5 of canvas extent
bool getIntervalFromExtent( double* values, bool useXAxis = true );
/** Computes interval from current raster layer */
//! Computes interval from current raster layer
bool getIntervalFromCurrentLayer( double* values );
double getDefaultInterval( bool useXAxis = true );
@ -154,7 +154,7 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
private:
/** Enum for different frame borders*/
//! Enum for different frame borders
enum Border
{
Left,
@ -163,31 +163,31 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
Top
};
/** Line or Symbol */
//! Line or Symbol
GridStyle mGridStyle;
/** Grid line interval in x-direction (map units)*/
//! Grid line interval in x-direction (map units)
double mGridIntervalX;
/** Grid line interval in y-direction (map units)*/
//! Grid line interval in y-direction (map units)
double mGridIntervalY;
/** Grid line offset in x-direction*/
//! Grid line offset in x-direction
double mGridOffsetX;
/** Grid line offset in y-direction*/
//! Grid line offset in y-direction
double mGridOffsetY;
/** Grid line pen*/
//! Grid line pen
QPen mGridPen;
/** Font for grid line annotation*/
//! Font for grid line annotation
QFont mGridAnnotationFont;
/** Digits after the dot*/
//! Digits after the dot
int mGridAnnotationPrecision;
/** True if coordinate values should be drawn*/
//! True if coordinate values should be drawn
bool mShowGridAnnotation;
/** Annotation position inside or outside of map frame*/
//! Annotation position inside or outside of map frame
GridAnnotationPosition mGridAnnotationPosition;
/** Distance between map frame and annotation*/
//! Distance between map frame and annotation
double mAnnotationFrameDistance;
/** Annotation can be horizontal / vertical or different for axes*/
//! Annotation can be horizontal / vertical or different for axes
GridAnnotationDirection mGridAnnotationDirection;
/** The length of the cross sides for mGridStyle Cross*/
//! The length of the cross sides for mGridStyle Cross
/* double mCrossLength; */
QgsLineSymbol* mLineSymbol;
@ -213,23 +213,23 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
/** Returns the grid lines for the y-coordinates. Not vertical in case of rotation
@return 0 in case of success*/
int yGridLines( QList< QPair< qreal, QLineF > >& lines ) const;
/** Returns the item border of a point (in item coordinates)*/
//! Returns the item border of a point (in item coordinates)
Border borderForLineCoord( QPointF point, QPainter* p ) const;
/** Draws Text. Takes care about all the composer specific issues (calculation to pixel, scaling of font and painter
to work around the Qt font bug)*/
void drawText( QPainter* p, double x, double y, const QString& text, const QFont& font ) const;
/** Like the above, but with a rectangle for multiline text*/
//! Like the above, but with a rectangle for multiline text
void drawText( QPainter* p, const QRectF& rect, const QString& text, const QFont& font, Qt::AlignmentFlag halignment = Qt::AlignLeft, Qt::AlignmentFlag valignment = Qt::AlignTop ) const;
/** Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE*/
//! Returns the font width in millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE
double textWidthMillimeters( const QFont& font, const QString& text ) const;
/** Returns the font height of a character in millimeters. */
//! Returns the font height of a character in millimeters.
double fontHeightCharacterMM( const QFont& font, QChar c ) const;
/** Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE*/
//! Returns the font ascent in Millimeters (considers upscaling and downscaling with FONT_WORKAROUND_SCALE
double fontAscentMillimeters( const QFont& font ) const;
/** Calculates font to from point size to pixel size*/
//! Calculates font to from point size to pixel size
double pixelFontSize( double pointSize ) const;
/** Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE*/
//! Returns a font where size is in pixel and font size is upscaled with FONT_WORKAROUND_SCALE
QFont scaledFontPixelSize( const QFont& font ) const;
/* friend class QgsDecorationGridDialog; */

2
src/app/qgsdecorationitem.h
View File

@ -79,7 +79,7 @@ class APP_EXPORT QgsDecorationItem: public QObject
protected:
/** True if decoration item has to be displayed*/
//! True if decoration item has to be displayed
bool mEnabled;
//! Placement of the decoration

2
src/app/qgsdelattrdialog.h
View File

@ -30,7 +30,7 @@ class APP_EXPORT QgsDelAttrDialog: public QDialog, private Ui::QgsDelAttrDialogB
public:
QgsDelAttrDialog( const QgsVectorLayer* vl );
~QgsDelAttrDialog();
/** Returns the selected attribute indices*/
//! Returns the selected attribute indices
QList<int> selectedAttributes();
};

2
src/app/qgsdiagramproperties.h
View File

@ -34,7 +34,7 @@ class APP_EXPORT QgsDiagramProperties : public QWidget, private Ui::QgsDiagramPr
~QgsDiagramProperties();
/** Adds an attribute from the list of available attributes to the assigned attributes with a random color.*/
//! Adds an attribute from the list of available attributes to the assigned attributes with a random color.
void addAttribute( QTreeWidgetItem * item );
public slots:

2
src/app/qgsdisplayangle.h
View File

@ -20,7 +20,7 @@
class QgsMapToolMeasureAngle;
/** A class that displays results of angle measurements with the proper unit*/
//! A class that displays results of angle measurements with the proper unit
class APP_EXPORT QgsDisplayAngle: public QDialog, private Ui::QgsDisplayAngleBase
{
Q_OBJECT

2
src/app/qgsdxfexportdialog.h
View File

@ -91,7 +91,7 @@ class QgsDxfExportDialog : public QDialog, private Ui::QgsDxfExportDialogBase
QgsCoordinateReferenceSystem crs() const;
public slots:
/** Change the selection of layers in the list */
//! Change the selection of layers in the list
void selectAll();
void unSelectAll();

14
src/app/qgsfieldcalculator.h
View File

@ -22,7 +22,7 @@
class QgsVectorLayer;
/** A dialog class that provides calculation of new fields using existing fields, values and a set of operators*/
//! A dialog class that provides calculation of new fields using existing fields, values and a set of operators
class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalculatorBase
{
Q_OBJECT
@ -44,23 +44,23 @@ class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalcula
void on_mButtonBox_helpRequested() { QgsContextHelp::run( metaObject()->className() ); }
private slots:
/** Sets the ok button enabled / disabled*/
//! Sets the ok button enabled / disabled
void setOkButtonState();
void setPrecisionMinMax();
private:
//! default constructor forbidden
QgsFieldCalculator();
/** Inserts existing fields into the combo box*/
//! Inserts existing fields into the combo box
void populateFields();
/** Inserts the types supported by the provider into the combo box*/
//! Inserts the types supported by the provider into the combo box
void populateOutputFieldTypes();
QgsVectorLayer* mVectorLayer;
/** Key: field name, Value: field index*/
//! Key: field name, Value: field index
QMap<QString, int> mFieldMap;
/** Create a field based on the definitions */
//! Create a field based on the definitions
inline QgsField fieldDefinition()
{
return QgsField( mOutputFieldNameLineEdit->text(),
@ -73,7 +73,7 @@ class APP_EXPORT QgsFieldCalculator: public QDialog, private Ui::QgsFieldCalcula
);
}
/** Idx of changed attribute*/
//! Idx of changed attribute
int mAttributeId;
friend class TestQgsFieldCalculator;

2
src/app/qgsfieldsproperties.h
View File

@ -196,7 +196,7 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope
void updateExpression();
/** Editing of layer was toggled */
//! Editing of layer was toggled
void editingToggled();
protected:

2
src/app/qgshandlebadlayers.h
View File

@ -30,7 +30,7 @@ class APP_EXPORT QgsHandleBadLayersHandler
public:
QgsHandleBadLayersHandler();
/** Implementation of the handler */
//! Implementation of the handler
virtual void handleBadLayers( const QList<QDomNode>& layers ) override;
};

14
src/app/qgsidentifyresultsdialog.h
View File

@ -84,7 +84,7 @@ class APP_EXPORT QgsIdentifyResultsWebViewItem: public QObject, public QTreeWidg
QgsIdentifyResultsWebViewItem( QTreeWidget *treeWidget = nullptr );
QgsIdentifyResultsWebView *webView() { return mWebView; }
void setHtml( const QString &html );
/** @note added in 2.1 */
//! @note added in 2.1
void setContent( const QByteArray & data, const QString & mimeType = QString(), const QUrl & baseUrl = QUrl() );
public slots:
@ -122,12 +122,12 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
~QgsIdentifyResultsDialog();
/** Add add feature from vector layer */
//! Add add feature from vector layer
void addFeature( QgsVectorLayer * layer,
const QgsFeature &f,
const QMap< QString, QString > &derivedAttributes );
/** Add add feature from other layer */
//! Add add feature from other layer
void addFeature( QgsRasterLayer * layer,
const QString& label,
const QMap< QString, QString > &attributes,
@ -136,13 +136,13 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
const QgsFeature &feature = QgsFeature(),
const QMap<QString, QVariant> &params = ( QMap<QString, QVariant>() ) );
/** Add feature from identify results */
//! Add feature from identify results
void addFeature( const QgsMapToolIdentify::IdentifyResult& result );
/** Map tool was deactivated */
//! Map tool was deactivated
void deactivate();
/** Map tool was activated */
//! Map tool was activated
void activate();
signals:
@ -156,7 +156,7 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
void activateLayer( QgsMapLayer * );
public slots:
/** Remove results */
//! Remove results
void clear();
void updateViewModes();

8
src/app/qgsjoindialog.h
View File

@ -30,13 +30,13 @@ class APP_EXPORT QgsJoinDialog: public QDialog, private Ui::QgsJoinDialogBase
QgsJoinDialog( QgsVectorLayer* layer, QList<QgsMapLayer*> alreadyJoinedLayers, QWidget * parent = nullptr, Qt::WindowFlags f = 0 );
~QgsJoinDialog();
/** Configure the dialog for an existing join */
//! Configure the dialog for an existing join
void setJoinInfo( const QgsVectorJoinInfo& joinInfo );
/** Returns the join info */
//! Returns the join info
QgsVectorJoinInfo joinInfo() const;
/** Returns true if user wants to create an attribute index on the join field*/
//! Returns true if user wants to create an attribute index on the join field
bool createAttributeIndex() const;
private slots:
@ -45,7 +45,7 @@ class APP_EXPORT QgsJoinDialog: public QDialog, private Ui::QgsJoinDialogBase
void checkDefinitionValid();
private:
/** Target layer*/
//! Target layer
QgsVectorLayer* mLayer;
};

2
src/app/qgslabelinggui.h
View File

@ -52,7 +52,7 @@ class APP_EXPORT QgsLabelingGui : public QgsTextFormatWidget, private QgsExpress
void blockInitSignals( bool block );
void syncDefinedCheckboxFrame( QgsDataDefinedButton* ddBtn, QCheckBox* chkBx, QFrame* f );
void populateDataDefinedButtons( QgsPalLayerSettings& s );
/** Sets data defined property attribute to map */
//! Sets data defined property attribute to map
void setDataDefinedProperty( const QgsDataDefinedButton* ddBtn, QgsPalLayerSettings::DataDefinedProperties p, QgsPalLayerSettings& lyr );
private:

18
src/app/qgslabelpropertydialog.h
View File

@ -24,7 +24,7 @@
#include <QDialog>
/** A dialog to enter data defined label attributes*/
//! A dialog to enter data defined label attributes
class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPropertyDialogBase
{
Q_OBJECT
@ -32,7 +32,7 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro
QgsLabelPropertyDialog( const QString& layerId, const QString& providerId, int featureId, const QFont& labelFont, const QString& labelText, QWidget * parent = nullptr, Qt::WindowFlags f = 0 );
~QgsLabelPropertyDialog();
/** Returns properties changed by the user*/
//! Returns properties changed by the user
const QgsAttributeMap& changedProperties() const { return mChangedProperties; }
signals:
@ -67,25 +67,25 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro
void on_mLabelTextLineEdit_textChanged( const QString& text );
private:
/** Sets activation / values to the gui elements depending on the label settings and feature values*/
//! Sets activation / values to the gui elements depending on the label settings and feature values
void init( const QString& layerId, const QString& providerId, int featureId, const QString& labelText );
void disableGuiElements();
/** Block / unblock all input element signals*/
//! Block / unblock all input element signals
void blockElementSignals( bool block );
void setDataDefinedValues( const QgsPalLayerSettings &layerSettings, QgsVectorLayer* vlayer );
void enableDataDefinedWidgets( QgsVectorLayer* vlayer );
/** Updates font when family or style is updated */
//! Updates font when family or style is updated
void updateFont( const QFont& font, bool block = true );
/** Updates combobox with named styles of font */
//! Updates combobox with named styles of font
void populateFontStyleComboBox();
void fillHaliComboBox();
void fillValiComboBox();
/** Insert changed value into mChangedProperties*/
//! Insert changed value into mChangedProperties
void insertChangedValue( QgsPalLayerSettings::DataDefinedProperties p, const QVariant& value );
QgsAttributeMap mChangedProperties;
@ -94,10 +94,10 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro
QFontDatabase mFontDB;
/** Label field for the current layer (or -1 if none)*/
//! Label field for the current layer (or -1 if none)
int mCurLabelField;
/** Current feature */
//! Current feature
QgsFeature mCurLabelFeat;
};

2
src/app/qgslayerstylingwidget.h
View File

@ -61,7 +61,7 @@ class APP_EXPORT QgsMapLayerStyleCommand : public QUndoCommand
virtual void undo() override;
virtual void redo() override;
/** Try to merge with other commands of this type when they are created in small time interval */
//! Try to merge with other commands of this type when they are created in small time interval
virtual bool mergeWith( const QUndoCommand* other ) override;
private:

2
src/app/qgsmaplayerstyleguiutils.h
View File

@ -23,7 +23,7 @@ class QgsMapLayer;
class QAction;
class QMenu;
/** Various GUI utility functions for dealing with map layer's style manager */
//! Various GUI utility functions for dealing with map layer's style manager
class QgsMapLayerStyleGuiUtils : public QObject
{
Q_OBJECT

2
src/app/qgsmaptooladdcircularstring.h
View File

@ -44,7 +44,7 @@ class QgsMapToolAddCircularString: public QgsMapToolCapture
* Completed circular strings will be added to this tool by calling its addCurve() method.
* */
QgsMapToolCapture* mParentTool;
/** Circular string points (in map coordinates)*/
//! Circular string points (in map coordinates)
QgsPointSequence mPoints;
//! The rubberband to show the already completed circular strings
QgsGeometryRubberBand* mRubberBand;

4
src/app/qgsmaptooladdfeature.h
View File

@ -15,12 +15,12 @@
#include "qgsmaptoolcapture.h"
/** This tool adds new point/line/polygon features to already existing vector layers*/
//! This tool adds new point/line/polygon features to already existing vector layers
class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolCapture
{
Q_OBJECT
public:
/** @note mode parameter added in QGIS 2.12 */
//! @note mode parameter added in QGIS 2.12
QgsMapToolAddFeature( QgsMapCanvas* canvas, CaptureMode mode = CaptureNone );
virtual ~QgsMapToolAddFeature();
void cadCanvasReleaseEvent( QgsMapMouseEvent * e ) override;

4
src/app/qgsmaptooladdpart.h
View File

@ -15,7 +15,7 @@
#include "qgsmaptoolcapture.h"
/** A map tool that adds new parts to multipart features*/
//! A map tool that adds new parts to multipart features
class APP_EXPORT QgsMapToolAddPart : public QgsMapToolCapture
{
Q_OBJECT
@ -28,6 +28,6 @@ class APP_EXPORT QgsMapToolAddPart : public QgsMapToolCapture
void activate() override;
private:
/** Check if there is any feature selected */
//! Check if there is any feature selected
bool checkSelection();
};

2
src/app/qgsmaptooladdring.h
View File

@ -15,7 +15,7 @@
#include "qgsmaptoolcapture.h"
/** A tool to cut holes into polygons and multipolygon features*/
//! A tool to cut holes into polygons and multipolygon features
class APP_EXPORT QgsMapToolAddRing: public QgsMapToolCapture
{
Q_OBJECT

10
src/app/qgsmaptoolannotation.h
View File

@ -36,18 +36,18 @@ class APP_EXPORT QgsMapToolAnnotation: public QgsMapTool
void keyPressEvent( QKeyEvent* e ) override;
protected:
/** Creates a new item. To be implemented by subclasses. Returns 0 by default*/
//! Creates a new item. To be implemented by subclasses. Returns 0 by default
virtual QgsAnnotationItem* createItem( QMouseEvent* e );
/** Creates an editor widget (caller takes ownership)*/
//! Creates an editor widget (caller takes ownership)
QDialog* createItemEditor( QgsAnnotationItem* item );
private:
/** Returns the topmost annotation item at the position (or 0 if none)*/
//! Returns the topmost annotation item at the position (or 0 if none)
QgsAnnotationItem* itemAtPos( QPointF pos );
QgsAnnotationItem* selectedItem();
/** Returns a list of all annotationitems in the canvas*/
//! Returns a list of all annotationitems in the canvas
QList<QgsAnnotationItem*> annotationItems();
/** Switches visibility states of text items*/
//! Switches visibility states of text items
void toggleTextItemVisibilities();
QgsAnnotationItem::MouseMoveAction mCurrentMoveAction;

2
src/app/qgsmaptooldeletepart.h
View File

@ -20,7 +20,7 @@
class QgsVertexMarker;
/** Map tool to delete vertices from line/polygon features*/
//! Map tool to delete vertices from line/polygon features
class APP_EXPORT QgsMapToolDeletePart: public QgsMapToolEdit
{
Q_OBJECT

2
src/app/qgsmaptooldeletering.h
View File

@ -19,7 +19,7 @@
#include "qgsmaptooledit.h"
class QgsVertexMarker;
/** Map tool to delete vertices from line/polygon features*/
//! Map tool to delete vertices from line/polygon features
class APP_EXPORT QgsMapToolDeleteRing : public QgsMapToolEdit
{

16
src/app/qgsmaptoollabel.h
View File

@ -23,7 +23,7 @@
class QgsRubberBand;
/** Base class for map tools that modify label properties*/
//! Base class for map tools that modify label properties
class APP_EXPORT QgsMapToolLabel: public QgsMapTool
{
Q_OBJECT
@ -63,7 +63,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
protected:
QgsRubberBand* mLabelRubberBand;
QgsRubberBand* mFeatureRubberBand;
/** Shows label fixpoint (left/bottom by default)*/
//! Shows label fixpoint (left/bottom by default)
QgsRubberBand* mFixPointRubberBand;
struct LabelDetails
@ -76,7 +76,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
QgsPalLayerSettings settings;
};
/** Currently dragged label position*/
//! Currently dragged label position
LabelDetails mCurrentLabel;
@ -91,10 +91,10 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
@return true in case of success*/
bool currentLabelRotationPoint( QgsPoint& pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false );
/** Creates label / feature / fixpoint rubber bands for the current label position*/
//! Creates label / feature / fixpoint rubber bands for the current label position
void createRubberBands();
/** Removes label / feature / fixpoint rubber bands*/
//! Removes label / feature / fixpoint rubber bands
void deleteRubberBands();
/** Returns current label's text
@ -107,17 +107,17 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
@return true in case of success*/
bool currentFeature( QgsFeature& f, bool fetchGeom = false );
/** Returns the font for the current feature (considering default font and data defined properties)*/
//! Returns the font for the current feature (considering default font and data defined properties)
QFont currentLabelFont();
/** Returns a data defined attribute column name for particular property or empty string if not defined */
//! Returns a data defined attribute column name for particular property or empty string if not defined
QString dataDefinedColumnName( QgsPalLayerSettings::DataDefinedProperties p, const QgsPalLayerSettings& labelSettings ) const;
/** Returns a data defined attribute column index
@return -1 if column does not exist or an expression is used instead */
int dataDefinedColumnIndex( QgsPalLayerSettings::DataDefinedProperties p, const QgsPalLayerSettings& labelSettings, const QgsVectorLayer* vlayer ) const;
/** Returns whether to preserve predefined rotation data during label pin/unpin operations*/
//! Returns whether to preserve predefined rotation data during label pin/unpin operations
bool currentLabelPreserveRotation();
/** Get data defined position of current label

16
src/app/qgsmaptoolmeasureangle.h
View File

@ -23,7 +23,7 @@
class QgsDisplayAngle;
class QgsRubberBand;
/** Map tool to measure angle between two segments*/
//! Map tool to measure angle between two segments
class APP_EXPORT QgsMapToolMeasureAngle: public QgsMapTool
{
Q_OBJECT
@ -46,28 +46,28 @@ class APP_EXPORT QgsMapToolMeasureAngle: public QgsMapTool
void deactivate() override;
private:
/** Points defining the angle (three for measuring)*/
//! Points defining the angle (three for measuring)
QList<QgsPoint> mAnglePoints;
QgsRubberBand* mRubberBand;
QgsDisplayAngle* mResultDisplay;
/** Creates a new rubber band and deletes the old one*/
//! Creates a new rubber band and deletes the old one
void createRubberBand();
/** Snaps point to background layers*/
//! Snaps point to background layers
QgsPoint snapPoint( QPoint p );
/** Tool for measuring */
//! Tool for measuring
QgsDistanceArea mDa;
public slots:
/** Recalculate angle if projection state changed*/
//! Recalculate angle if projection state changed
void updateSettings();
private slots:
/** Deletes the rubber band and the dialog*/
//! Deletes the rubber band and the dialog
void stopMeasuring();
/** Configures distance area objects with ellipsoid / output crs*/
//! Configures distance area objects with ellipsoid / output crs
void configureDistanceArea();
};

8
src/app/qgsmaptoolmovefeature.h
View File

@ -18,7 +18,7 @@
#include "qgsmaptooladvanceddigitizing.h"
/** Map tool for translating feature position by mouse drag*/
//! Map tool for translating feature position by mouse drag
class APP_EXPORT QgsMapToolMoveFeature: public QgsMapToolAdvancedDigitizing
{
Q_OBJECT
@ -34,13 +34,13 @@ class APP_EXPORT QgsMapToolMoveFeature: public QgsMapToolAdvancedDigitizing
void deactivate() override;
private:
/** Start point of the move in map coordinates*/
//! Start point of the move in map coordinates
QgsPoint mStartPointMapCoords;
/** Rubberband that shows the feature being moved*/
//! Rubberband that shows the feature being moved
QgsRubberBand* mRubberBand;
/** Id of moved feature*/
//! Id of moved feature
QgsFeatureIds mMovedFeatures;
QPoint mPressPos;

4
src/app/qgsmaptoolmovelabel.h
View File

@ -20,7 +20,7 @@
#include "qgsmaptoollabel.h"
/** A map tool for dragging label positions*/
//! A map tool for dragging label positions
class APP_EXPORT QgsMapToolMoveLabel: public QgsMapToolLabel
{
Q_OBJECT
@ -37,7 +37,7 @@ class APP_EXPORT QgsMapToolMoveLabel: public QgsMapToolLabel
protected:
/** Start point of the move in map coordinates*/
//! Start point of the move in map coordinates
QgsPoint mStartPointMapCoords;
double mClickOffsetX;

28
src/app/qgsmaptooloffsetcurve.h
View File

@ -34,30 +34,30 @@ class APP_EXPORT QgsMapToolOffsetCurve: public QgsMapToolEdit
void canvasMoveEvent( QgsMapMouseEvent* e ) override;
private slots:
/** Places curve offset to value entered in the spin box*/
//! Places curve offset to value entered in the spin box
void placeOffsetCurveToValue();
/** Apply the offset either from the spin box or from the mouse event */
//! Apply the offset either from the spin box or from the mouse event
void applyOffset();
private:
/** Rubberband that shows the position of the offset curve*/
//! Rubberband that shows the position of the offset curve
QgsRubberBand* mRubberBand;
/** Geometry to manipulate*/
//! Geometry to manipulate
QgsGeometry mOriginalGeometry;
/** Geometry after manipulation*/
//! Geometry after manipulation
QgsGeometry mModifiedGeometry;
/** ID of manipulated feature*/
//! ID of manipulated feature
QgsFeatureId mModifiedFeature;
/** Layer ID of source layer*/
//! Layer ID of source layer
QString mSourceLayerId;
/** Internal flag to distinguish move from click*/
//! Internal flag to distinguish move from click
bool mGeometryModified;
/** Shows current distance value and allows numerical editing*/
//! Shows current distance value and allows numerical editing
QgsDoubleSpinBox* mDistanceWidget;
/** Marker to show the cursor was snapped to another location*/
//! Marker to show the cursor was snapped to another location
QgsVertexMarker* mSnapVertexMarker;
/** Forces geometry copy (no modification of geometry in current layer)*/
//! Forces geometry copy (no modification of geometry in current layer)
bool mForceCopy;
bool mMultiPartGeometry;
@ -67,11 +67,11 @@ class APP_EXPORT QgsMapToolOffsetCurve: public QgsMapToolEdit
void createDistanceWidget();
void deleteDistanceWidget();
void setOffsetForRubberBand( double offset );
/** Creates a linestring from the polygon ring containing the snapped vertex. Caller takes ownership of the created object*/
//! Creates a linestring from the polygon ring containing the snapped vertex. Caller takes ownership of the created object
QgsGeometry linestringFromPolygon( const QgsGeometry& featureGeom, int vertex );
/** Returns a single line from a multiline (or does nothing if geometry is already a single line). Deletes the input geometry*/
//! Returns a single line from a multiline (or does nothing if geometry is already a single line). Deletes the input geometry
QgsGeometry convertToSingleLine( const QgsGeometry& geom, int vertex, bool& isMulti );
/** Converts offset line back to a multiline if necessary*/
//! Converts offset line back to a multiline if necessary
QgsGeometry* convertToMultiLine( QgsGeometry* geom );
};

2
src/app/qgsmaptoolpinlabels.h
View File

@ -23,7 +23,7 @@
class QgsRubberBand;
class QgsLabelPosition;
/** A map tool for pinning (writing to attribute table) and unpinning labelpositions and rotation*/
//! A map tool for pinning (writing to attribute table) and unpinning labelpositions and rotation
class APP_EXPORT QgsMapToolPinLabels: public QgsMapToolLabel
{
Q_OBJECT

2
src/app/qgsmaptoolpointsymbol.h
View File

@ -42,7 +42,7 @@ class APP_EXPORT QgsMapToolPointSymbol: public QgsMapToolEdit
QgsVectorLayer* mActiveLayer;
QgsFeatureId mFeatureNumber;
/** Screen coordinate of the snaped feature*/
//! Screen coordinate of the snaped feature
QPoint mSnappedPoint;
virtual void canvasPressOnFeature( QgsMapMouseEvent* e, const QgsFeature& feature, const QgsPoint& snappedPoint ) = 0;

2
src/app/qgsmaptoolreshape.h
View File

@ -18,7 +18,7 @@
#include "qgsmaptoolcapture.h"
/** A map tool that draws a line and splits the features cut by the line*/
//! A map tool that draws a line and splits the features cut by the line
class APP_EXPORT QgsMapToolReshape: public QgsMapToolCapture
{
Q_OBJECT

10
src/app/qgsmaptoolrotatefeature.h
View File

@ -61,7 +61,7 @@ class APP_EXPORT QgsAngleMagnetWidget : public QWidget
};
/** Map tool to rotate features */
//! Map tool to rotate features
class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit
{
Q_OBJECT
@ -91,14 +91,14 @@ class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit
void createRotationWidget();
void deleteRotationWidget();
/** Start point of the move in map coordinates*/
//! Start point of the move in map coordinates
QgsPoint mStartPointMapCoords;
QPointF mInitialPos;
/** Rubberband that shows the feature being moved*/
//! Rubberband that shows the feature being moved
QgsRubberBand* mRubberBand;
/** Id of moved feature*/
//! Id of moved feature
QgsFeatureIds mRotatedFeatures;
double mRotation;
double mRotationOffset;
@ -108,7 +108,7 @@ class APP_EXPORT QgsMapToolRotateFeature: public QgsMapToolEdit
bool mRotationActive;
/** Shows current angle value and allows numerical editing*/
//! Shows current angle value and allows numerical editing
QgsAngleMagnetWidget* mRotationWidget;
};

6
src/app/qgsmaptoolrotatelabel.h
View File

@ -36,13 +36,13 @@ class APP_EXPORT QgsMapToolRotateLabel: public QgsMapToolLabel
protected:
static int roundTo15Degrees( double n );
/** Converts azimuth value to counterclockwise 0 - 360*/
//! Converts azimuth value to counterclockwise 0 - 360
static double azimuthToCCW( double a );
QgsRubberBand* createRotationPreviewBox();
void setRotationPreviewBox( double rotation );
/** Rotates input point counterclockwise around centerPoint*/
//! Rotates input point counterclockwise around centerPoint
QgsPoint rotatePointCounterClockwise( const QgsPoint& input, const QgsPoint& centerPoint, double degrees );
double mStartRotation; //rotation value prior to start rotating
@ -52,7 +52,7 @@ class APP_EXPORT QgsMapToolRotateLabel: public QgsMapToolLabel
QgsPointRotationItem* mRotationItem;
QgsRubberBand* mRotationPreviewBox;
/** True if ctrl was pressed during the last mouse move event*/
//! True if ctrl was pressed during the last mouse move event
bool mCtrlPressed;
};

16
src/app/qgsmaptoolrotatepointsymbols.h
View File

@ -50,27 +50,27 @@ class APP_EXPORT QgsMapToolRotatePointSymbols: public QgsMapToolPointSymbol
private:
/** Last azimut between mouse and edited point*/
//! Last azimut between mouse and edited point
double mCurrentMouseAzimut;
/** Last feature rotation*/
//! Last feature rotation
double mCurrentRotationFeature;
bool mRotating;
QSet<int> mCurrentRotationAttributes;
/** Item that displays rotation during mouse move*/
//! Item that displays rotation during mouse move
QgsPointRotationItem* mRotationItem;
/** True if ctrl was pressed during the last mouse move event*/
//! True if ctrl was pressed during the last mouse move event
bool mCtrlPressed;
//! Clone of first found marker symbol for feature with rotation attribute set
QScopedPointer< QgsMarkerSymbol > mMarkerSymbol;
void drawArrow( double azimut ) const;
/** Calculates the azimut between mousePos and mSnappedPoint*/
//! Calculates the azimut between mousePos and mSnappedPoint
double calculateAzimut( QPoint mousePos );
/** Create item with the point symbol for a specific feature. This will be used to show the rotation to the user*/
//! Create item with the point symbol for a specific feature. This will be used to show the rotation to the user
void createPixmapItem( QgsMarkerSymbol *markerSymbol );
/** Sets the rotation of the pixmap item*/
//! Sets the rotation of the pixmap item
void setPixmapItemRotation( double rotation );
/** Rounds value to 15 degree integer (used if ctrl pressed)*/
//! Rounds value to 15 degree integer (used if ctrl pressed)
static int roundTo15Degrees( double n );
};

2
src/app/qgsmaptoolshowhidelabels.h
View File

@ -22,7 +22,7 @@
#include "qgsfeature.h"
/** A map tool for showing or hidding a feature's label*/
//! A map tool for showing or hidding a feature's label
class APP_EXPORT QgsMapToolShowHideLabels : public QgsMapToolLabel
{
Q_OBJECT

14
src/app/qgsmaptoolsimplify.h
View File

@ -49,7 +49,7 @@ class APP_EXPORT QgsSimplifyDialog : public QDialog, private Ui::SimplifyLineDia
};
/** Map tool to simplify line/polygon features */
//! Map tool to simplify line/polygon features
class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit
{
Q_OBJECT
@ -71,12 +71,12 @@ class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit
QString statusText() const;
public slots:
/** Slot to change display when slidebar is moved */
//! Slot to change display when slidebar is moved
void setTolerance( double tolerance );
void setToleranceUnits( int units );
/** Slot to store feture after simplification */
//! Slot to store feture after simplification
void storeSimplified();
void clearSelection();
@ -91,15 +91,15 @@ class APP_EXPORT QgsMapToolSimplify: public QgsMapToolEdit
int vertexCount( const QgsGeometry& g ) const;
// data
/** Dialog with slider to set correct tolerance value */
//! Dialog with slider to set correct tolerance value
QgsSimplifyDialog* mSimplifyDialog;
/** Rubber bands to draw current state of simplification */
//! Rubber bands to draw current state of simplification
QList<QgsRubberBand*> mRubberBands;
/** Features with which we are working */
//! Features with which we are working
QList<QgsFeature> mSelectedFeatures;
/** Real value of tolerance */
//! Real value of tolerance
double mTolerance;
QgsTolerance::UnitType mToleranceUnits;

2
src/app/qgsmaptoolsplitfeatures.h
View File

@ -18,7 +18,7 @@
#include "qgsmaptoolcapture.h"
/** A map tool that draws a line and splits the features cut by the line*/
//! A map tool that draws a line and splits the features cut by the line
class APP_EXPORT QgsMapToolSplitFeatures: public QgsMapToolCapture
{
Q_OBJECT

2
src/app/qgsmaptoolsplitparts.h
View File

@ -18,7 +18,7 @@
#include "qgsmaptoolcapture.h"
/** A map tool that draws a line and splits the parts cut by the line*/
//! A map tool that draws a line and splits the parts cut by the line
class QgsMapToolSplitParts: public QgsMapToolCapture
{
Q_OBJECT

2
src/app/qgsmeasuretool.h
View File

@ -105,7 +105,7 @@ class APP_EXPORT QgsMeasureTool : public QgsMapTool
//@param p (pixel) coordinate
QgsPoint snapPoint( QPoint p );
/** Removes the last vertex from mRubberBand*/
//! Removes the last vertex from mRubberBand
void undo();
};

16
src/app/qgsmergeattributesdialog.h
View File

@ -30,7 +30,7 @@ class QgsVectorLayer;
class QComboBox;
/** A dialog to insert the merge behaviour for attributes (e.g. for the union features editing tool)*/
//! A dialog to insert the merge behaviour for attributes (e.g. for the union features editing tool)
class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeAttributesDialogBase
{
Q_OBJECT
@ -38,7 +38,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
enum ItemDataRole
{
FieldIndex = Qt::UserRole /*!< index of corresponding field in source table */
FieldIndex = Qt::UserRole //!< Index of corresponding field in source table
};
@ -68,16 +68,16 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
private:
QgsMergeAttributesDialog(); //default constructor forbidden
void createTableWidgetContents();
/** Create new combo box with the options for featureXX / mean / min / max */
//! Create new combo box with the options for featureXX / mean / min / max
QComboBox* createMergeComboBox( QVariant::Type columnType ) const;
/** Returns the table widget column index of a combo box
@return the column index or -1 in case of error*/
int findComboColumn( QComboBox* c ) const;
/** Calculates the merged value of a column (depending on the selected merge behaviour) and inserts the value in the corresponding cell*/
//! Calculates the merged value of a column (depending on the selected merge behaviour) and inserts the value in the corresponding cell
void refreshMergedValue( int col );
/** Inserts the attribute value of a specific feature into the row of merged attributes*/
//! Inserts the attribute value of a specific feature into the row of merged attributes
QVariant featureAttribute( QgsFeatureId featureId, int col );
/** Appends the values of the features for the final value*/
//! Appends the values of the features for the final value
QVariant concatenationAttribute( int col );
/** Calculates a summary statistic for a column. Returns null if no valid numerical
@ -85,13 +85,13 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
*/
QVariant calcStatistic( int col, QgsStatisticalSummary::Statistic stat );
/** Sets mSelectionRubberBand to a new feature*/
//! Sets mSelectionRubberBand to a new feature
void createRubberBandForFeature( QgsFeatureId featureId );
QgsFeatureList mFeatureList;
QgsVectorLayer* mVectorLayer;
QgsMapCanvas* mMapCanvas;
/** Item that highlights the selected feature in the merge table*/
//! Item that highlights the selected feature in the merge table
QgsRubberBand* mSelectionRubberBand;
QgsFields mFields;

4
src/app/qgsnewspatialitelayerdialog.h
View File

@ -52,10 +52,10 @@ class APP_EXPORT QgsNewSpatialiteLayerDialog: public QDialog, private Ui::QgsNew
void on_buttonBox_rejected();
private:
/** Returns the selected geometry type*/
//! Returns the selected geometry type
QString selectedType() const;
/** Create a new database */
//! Create a new database
bool createDb();
bool apply();

36
src/app/qgsoptions.h
View File

@ -81,7 +81,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
*/
void on_mProjectOnLaunchCmbBx_currentIndexChanged( int indx );
/** Slot to choose path to project to open after launch */
//! Slot to choose path to project to open after launch
void on_mProjectOnLaunchPushBtn_pressed();
/**
@ -91,42 +91,42 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
*/
bool newVisible();
/** Slot to select the default font point size for app */
//! Slot to select the default font point size for app
void on_spinFontSize_valueChanged( int fontSize );
/** Slot to set font family for app to Qt default */
//! Slot to set font family for app to Qt default
void on_mFontFamilyRadioQt_released();
/** Slot to set font family for app to custom choice */
//! Slot to set font family for app to custom choice
void on_mFontFamilyRadioCustom_released();
/** Slot to select custom font family choice for app */
//! Slot to select custom font family choice for app
void on_mFontFamilyComboBox_currentFontChanged( const QFont& font );
/** Slot to set whether to use custom group boxes */
//! Slot to set whether to use custom group boxes
void on_mCustomGroupBoxChkBx_clicked( bool chkd );
void on_mProxyTypeComboBox_currentIndexChanged( int idx );
/** Add a new URL to exclude from Proxy*/
//! Add a new URL to exclude from Proxy
void on_mAddUrlPushButton_clicked();
/** Remove an URL to exclude from Proxy*/
//! Remove an URL to exclude from Proxy
void on_mRemoveUrlPushButton_clicked();
/** Slot to flag restoring/delete window state settings upon restart*/
//! Slot to flag restoring/delete window state settings upon restart
void on_mRestoreDefaultWindowStateBtn_clicked();
/** Slot to enable custom environment variables table and buttons */
//! Slot to enable custom environment variables table and buttons
void on_mCustomVariablesChkBx_toggled( bool chkd );
/** Slot to add a custom environment variable to the app */
//! Slot to add a custom environment variable to the app
void on_mAddCustomVarBtn_clicked();
/** Slot to remove a custom environment variable from the app */
//! Slot to remove a custom environment variable from the app
void on_mRemoveCustomVarBtn_clicked();
/** Slot to filter out current environment variables not specific to QGIS */
//! Slot to filter out current environment variables not specific to QGIS
void on_mCurrentVariablesQGISChxBx_toggled( bool qgisSpecific );
/* Let the user add a path to the list of search paths
@ -177,16 +177,16 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
* used in scale combobox */
void on_pbnDefaultScaleValues_clicked();
/** Let the user load scales from file */
//! Let the user load scales from file
void on_pbnImportScales_clicked();
/** Let the user load scales from file */
//! Let the user load scales from file
void on_pbnExportScales_clicked();
/** Auto slot executed when the active page in the option section widget is changed */
//! Auto slot executed when the active page in the option section widget is changed
void on_mOptionsStackedWidget_currentChanged( int theIndx );
/** A scale in the list of predefined scales changed */
//! A scale in the list of predefined scales changed
void scaleItemChanged( QListWidgetItem* changedScaleItem );
/* Load the list of drivers available in GDAL */
@ -209,7 +209,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
QgsCoordinateReferenceSystem mLayerDefaultCrs;
bool mLoadedGdalDriverList;
/** Generate table row for custom environment variables */
//! Generate table row for custom environment variables
void addCustomEnvVarRow( const QString& varName, const QString& varVal, const QString& varApply = QString() );
void saveDefaultDatumTransformations();

Some files were not shown because too many files have changed in this diff Show More