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

doxygen fixes

Browse Source 
git-svn-id: http://svn.osgeo.org/qgis/trunk@14319 c8812cc2-4d05-0410-92ff-de0c093fc19c
This commit is contained in:
jef 2010-09-30 22:53:18 +00:00
parent 1c42e9a14c
commit f19c7aac24
62 changed files with 1289 additions and 832 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1504
Doxyfile
View File

File diff suppressed because it is too large Load Diff

13
doc/modules.dox
View File

@ -1,17 +1,18 @@
/** @defgroup core
/** @defgroup core QGIS core library
QGIS core library. Contains all basic GIS functionality.
Contains all basic GIS functionality.
*/
/** @defgroup gui
/** @defgroup gui QGIS gui library.
It's built on top of core library and adds reusable GUI widgets.
QGIS gui library. It's built on top of core library and adds reusable GUI widgets.
*/
/** @defgroup analysis
/** @defgroup analysis QGIS analysis library.
Analysis library. Built on top of core library, the analysis library provides
Built on top of core library, the analysis library provides
high level tools for carrying out spatial analysis on vector and raster data.
*/

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

@ -92,8 +92,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
void setTriangleInterpolator( TriangleInterpolator* interpolator );
/**Eliminates the horizontal triangles by swapping or by insertion of new points*/
void eliminateHorizontalTriangles();
/**Adds points to make the triangles better shaped (algorithm of ruppert)
\param tin the triangulation or decorator which interpolates the elevation*/
/**Adds points to make the triangles better shaped (algorithm of ruppert)*/
virtual void ruppertRefinement();
/**Returns true, if the point with coordinates x and y is inside the convex hull and false otherwise*/
bool pointInside( double x, double y );

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

@ -77,8 +77,7 @@ class ANALYSIS_EXPORT Triangulation
virtual void setTriangleInterpolator( TriangleInterpolator* interpolator ) = 0;
/**Eliminates the horizontal triangles by swapping*/
virtual void eliminateHorizontalTriangles() = 0;
/**Adds points to make the triangles better shaped (algorithm of ruppert)
\param tin the triangulation or decorator which interpolates the elevation*/
/**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*/
virtual bool pointInside( double x, double y ) = 0;

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

@ -62,8 +62,8 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
/**Create dual edge triangulation*/
void initialize();
/**Inserts the vertices of a geometry into the triangulation
@param g the geometry
/**Inserts the vertices of a feature into the triangulation
@param f the feature
@param zCoord true if the z coordinate is the interpolation attribute
@param attr interpolation attribute index (if zCoord is false)
@param type point/structure line, break line

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

@ -42,7 +42,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param tolerance (level of simplification)
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@ -54,7 +53,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
@ -64,7 +62,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create a polygon based on the extent of all (selected) features and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
@ -73,7 +70,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create buffers for a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param bufferDistance distance for buffering (if no buffer field is specified)
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param dissolve if true, merge all the buffers to a big multipolygon
@ -86,7 +82,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Create convex hull(s) of a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param uniqueIdField index of the attribute field that contains the unique convex hull id (or -1 if
all features have the same buffer distance)
@ -98,7 +93,6 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
/**Dissolve a vector layer and write it to a new shape file
@param layer input vector layer
@param shapefileName path to the output shp
@param fileEncoding encoding of the output file
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param uniqueIdField index of the attribute field that contains the unique id to dissolve on (or -1 if
all features should be dissolved together)

94
src/analysis/vector/qgsoverlayanalyzer.h
View File

@ -50,52 +50,54 @@ class ANALYSIS_EXPORT QgsOverlayAnalyzer
const QString& shapefileName, bool onlySelectedFeatures = false, \
QProgressDialog* p = 0 );
// /**Perform a union of two input vector layers and write output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Clip a vector layer based on the boundary of another vector layer and
// write output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Difference a vector layer based on the geometries of another vector layer
// and write the output to a new shape file
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
//
// /**Intersect two vector layers and write the geometries of each layer that
// do not intersect with the other layer to a new shape file (Symmetrical difference)
// @param layerA input vector layer
// @param layerB input vector layer
// @param shapefileName path to the output shp
// @param onlySelectedFeatures if true, only selected features are considered, else all the features
// @param p progress dialog (or 0 if no progress dialog is to be shown)
// @note: added in version 1.4*/
// bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
// const QString& shapefileName, bool onlySelectedFeatures = false,
// QProgressDialog* p = 0 );
#if 0
/**Perform a union of two input vector layers and write output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool combine( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );
/**Clip a vector layer based on the boundary of another vector layer and
write output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool clip( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );
/**Difference a vector layer based on the geometries of another vector layer
and write the output to a new shape file
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool difference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );
/**Intersect two vector layers and write the geometries of each layer that
do not intersect with the other layer to a new shape file (Symmetrical difference)
@param layerA input vector layer
@param layerB input vector layer
@param shapefileName path to the output shp
@param onlySelectedFeatures if true, only selected features are considered, else all the features
@param p progress dialog (or 0 if no progress dialog is to be shown)
@note: added in version 1.4*/
bool symDifference( QgsVectorLayer* layerA, QgsVectorLayer* layerB,
const QString& shapefileName, bool onlySelectedFeatures = false,
QProgressDialog* p = 0 );
#endif
private:

7
src/core/composer/qgscomposerarrow.h
View File

@ -60,14 +60,15 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
MarkerMode markerMode() const { return mMarkerMode;}
void setMarkerMode( MarkerMode mode ) {mMarkerMode = mode;}
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is the document to read
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

13
src/core/composer/qgscomposeritem.h
View File

@ -64,9 +64,15 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
};
/**Constructor
@param composition parent composition
@param manageZValue true if the z-Value of this object should be managed by mComposition*/
QgsComposerItem( QgsComposition* composition, bool manageZValue = true );
/**Constructor with box position and composer object
@param x x coordinate of item
@param y y coordinate of item
@param width width of item
@param height height of item
@param composition parent composition
@param manageZValue true if the z-Value of this object should be managed by mComposition*/
QgsComposerItem( qreal x, qreal y, qreal width, qreal height, QgsComposition* composition, bool manageZValue = true );
virtual ~QgsComposerItem();
@ -107,9 +113,9 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
corresponds to 1 scene size unit*/
virtual void setSceneRect( const QRectF& rectangle );
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc is the Dom document
*/
virtual bool writeXML( QDomElement& elem, QDomDocument & doc ) const = 0;
@ -118,6 +124,7 @@ class CORE_EXPORT QgsComposerItem: public QObject, public QGraphicsRectItem
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
virtual bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) = 0;

3
src/core/composer/qgscomposeritemgroup.h
View File

@ -42,12 +42,13 @@ class CORE_EXPORT QgsComposerItemGroup: public QgsComposerItem
/** stores state in Dom node
* @param elem is Dom element corresponding to 'Composer' tag
* @param temp write template file
* @param doc is the Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is the Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

9
src/core/composer/qgscomposerlabel.h
View File

@ -57,14 +57,15 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
@note: this function was added in version 1.4*/
QColor fontColor() const {return mFontColor;}
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param node is Dom node corresponding to 'ComposerLabel' tag
* @param itemElem is Dom element corresponding to 'ComposerLabel' tag
* @param doc document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

4
src/core/composer/qgscomposerlegend.h
View File

@ -88,12 +88,13 @@ class CORE_EXPORT QgsComposerLegend: public QgsComposerItem
/** stores state in Dom node
* @param elem is Dom element corresponding to 'Composer' tag
* @param temp write template file
* @param doc Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
@ -135,6 +136,7 @@ class CORE_EXPORT QgsComposerLegend: public QgsComposerItem
void drawLayerItem( QPainter* p, QgsComposerLayerItem* layerItem, double& currentYCoord, double& maxXCoord );
/**Draws child items of a layer item
@param p painter
@param layerItem parent model item (layer)
@param currentYCoord in/out: current y position of legend item
@param maxXCoord in/out: maximum x-coordinate of the whole legend

10
src/core/composer/qgscomposermap.h
View File

@ -78,6 +78,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
void draw( QPainter *painter, const QgsRectangle& extent, const QSize& size, int dpi );
/** \brief Draw to paint device
@param painter painter
@param extent map extent
@param size size in scene coordinates
@param dpi scene dpi*/
@ -155,12 +156,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/** stores state in Dom node
* @param elem is Dom element corresponding to 'Composer' tag
* @param temp write template file
* @param doc Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to 'ComposerMap' tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
@ -353,14 +355,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/**Draws the map grid*/
void drawGrid( QPainter* p );
/**Draw coordinates for mGridAnnotationType Coordinate
@param lines the coordinate lines in item coordinates*/
@param p drawing painter
@param hLines horizontal coordinate lines in item coordinates
@param vLines vertical coordinate lines in item coordinates*/
void drawCoordinateAnnotations( QPainter* p, const QList< QPair< double, QLineF > >& hLines, const QList< QPair< double, QLineF > >& vLines );
void drawCoordinateAnnotation( QPainter* p, const QPointF& pos, QString annotationString );
/**Draws a single annotation
@param p drawing painter
@param pos item coordinates where to draw
@param rotation text rotation
@param the text to draw*/
@param annotationText the text to draw*/
void drawAnnotation( QPainter* p, const QPointF& pos, int rotation, const QString& annotationText );
/**Returns the grid lines with associated coordinate value
@return 0 in case of success*/

11
src/core/composer/qgscomposerpicture.h
View File

@ -42,14 +42,15 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
corresponds to 1 scene size unit and resizes the svg symbol / image*/
void setSceneRect( const QRectF& rectangle );
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc is Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );
@ -80,9 +81,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/**Calculates bounding rect for image such that aspect ratio is correct*/
QRectF boundedImageRect( double deviceWidth, double deviceHeight );
/**Updates content of mImage using svg generator
@param out: boundWidth width of mImage that is used by the svg renderer. May different from mImage.width() to preserve aspect ratio
@param out: boundHeight height of mImage that is used by the svg renderer*/
/**Updates content of mImage using svg generator*/
void updateImageFromSvg();

5
src/core/composer/qgscomposerscalebar.h
View File

@ -101,14 +101,15 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/**Returns string of first label (important for drawing, labeling, size calculation*/
QString firstLabelString() const;
/** stores state in Dom node
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param temp write template file
* @param doc Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

7
src/core/composer/qgscomposershape.h
View File

@ -40,14 +40,15 @@ class CORE_EXPORT QgsComposerShape: public QgsComposerItem
/** \brief Reimplementation of QCanvasItem::paint - draw on canvas */
void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget );
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc write template file
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

7
src/core/composer/qgspaperitem.h
View File

@ -32,14 +32,15 @@ class CORE_EXPORT QgsPaperItem: public QgsComposerItem
/** \brief Reimplementation of QCanvasItem::paint*/
void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget );
/** stores state in Dom node
* @param node is Dom node corresponding to 'Composer' tag
* @param temp write template file
/** stores state in Dom element
* @param elem is Dom element corresponding to 'Composer' tag
* @param doc Dom document
*/
bool writeXML( QDomElement& elem, QDomDocument & doc ) const;
/** sets state from Dom document
* @param itemElem is Dom node corresponding to item tag
* @param doc is the Dom document
*/
bool readXML( const QDomElement& itemElem, const QDomDocument& doc );

1
src/core/composer/qgsscalebarstyle.h
View File

@ -34,6 +34,7 @@ class CORE_EXPORT QgsScaleBarStyle
virtual ~QgsScaleBarStyle();
/**Draws the style
@param p painter object
@param xOffset offset to account for centered labeling*/
virtual void draw( QPainter* p, double xOffset = 0 ) const = 0; //to do by every subclass
virtual void drawLabels( QPainter* p ) const; //default implementation provided

4
src/core/composer/qgssingleboxscalebarstyle.h
View File

@ -31,6 +31,10 @@ class CORE_EXPORT QgsSingleBoxScaleBarStyle: public QgsScaleBarStyle
QString name() const;
/*! draw method
@param p painter object
@param xOffset x offset
*/
void draw( QPainter* p, double xOffset = 0 ) const;
private:

4
src/core/composer/qgsticksscalebarstyle.h
View File

@ -37,6 +37,10 @@ class CORE_EXPORT QgsTicksScaleBarStyle: public QgsScaleBarStyle
QString name() const;
/*! draw method
@param p painter object
@param xOffset offset
*/
void draw( QPainter* p, double xOffset = 0 ) const;
void setTickPosition( TickPosition p ) {mTickPosition = p;}

2
src/core/qgsapplication.h
View File

@ -38,7 +38,7 @@ class CORE_EXPORT QgsApplication: public QApplication
* The theme search path usually will be pkgDataPath + "/themes/" + themName + "/"
* but plugin writers etc can use themeName() as a basis for searching
* for resources in their own datastores e.g. a Qt4 resource bundle.
* @Note A basic test will be carried out to ensure the theme search path
* @note A basic test will be carried out to ensure the theme search path
* based on the supplied theme name exists. If it does not the theme name will
* be reverted to 'default'.
*/

44
src/core/qgscoordinatereferencesystem.h
View File

@ -211,17 +211,19 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
bool readXML( QDomNode & theNode );
/*! Stores state to the given Dom node in the given document.
* Below is an example of the generated tag.
* <spatialrefsys>
* <proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
* <srsid>2585</srsid>
* <srid>4326</srid>
* <epsg>4326</epsg>
* <description>WGS 84</description>
* <projectionacronym>longlat</projectionacronym>
* <ellipsoidacronym>WGS84</ellipsoidacronym>
* </spatialrefsys>
\verbatim
<spatialrefsys>
<proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
<srsid>2585</srsid>
<srid>4326</srid>
<epsg>4326</epsg>
<description>WGS 84</description>
<projectionacronym>longlat</projectionacronym>
<ellipsoidacronym>WGS84</ellipsoidacronym>
</spatialrefsys>
\endverbatim
* @param theNode The node in which state will be restored
* @param theDom The document in which state will be stored
* @param theDoc The document in which state will be stored
* @return bool True on success, False on failure
*/
bool writeXML( QDomNode & theNode, QDomDocument & theDoc ) const;
@ -315,21 +317,21 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
// a fully valid crs. Programmers should use the createFrom* methods rather
private:
/** A static helper function to find out the proj4 string for a srsid
* @param int theSrsId The srsid used for the lookup
* @param theSrsId The srsid used for the lookup
* @return QString The proj4 string
*/
static QString proj4FromSrsId( const int theSrsId );
/*! Set the QGIS SrsId
* @param long theSrsId The internal sqlite3 srs.db primary key for this srs
* @param theSrsId The internal sqlite3 srs.db primary key for this srs
*/
void setInternalId( long theSrsId );
/*! Set the postgis srid
* @param long theSrsId The postgis spatial_ref_sys key for this srs
* @param theSrid The postgis spatial_ref_sys key for this srs
*/
void setSrid( long theSrid );
/*! Set the Description
* @param QString the Description A textual description of the srs.
* @param theDescription A textual description of the srs.
*/
void setDescription( QString theDescription );
/* Set the Proj Proj4String.
@ -337,25 +339,25 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
*/
void setProj4String( QString theProj4String );
/*! Set this Geographic? flag
* @param bool theGeoFlag Whether this is a geographic or projected coordinate system
* @param theGeoFlag Whether this is a geographic or projected coordinate system
*/
void setGeographicFlag( bool theGeoFlag );
/*! Set the EpsgCrsId identifier for this srs
* @param long theEpsg the ESPG identifier for this srs (defaults to 0)
* @param theEpsg the ESPG identifier for this srs (defaults to 0)
*/
void setEpsg( long theEpsg );
/*! Set the authority identifier for this srs
* @param QString thID the authority identifier for this srs (defaults to 0)
* @param theID the authority identifier for this srs (defaults to 0)
*/
void setAuthId( QString theID );
/*! Set the projection acronym
* @param QString the acronym (must be a valid proj4 projection acronym)
* @param theProjectionAcronym the acronym (must be a valid proj4 projection acronym)
*/
void setProjectionAcronym( QString theProjectionAcronym );
/*! Set the ellipsoid acronym
* @param QString the acronym (must be a valid proj4 ellipsoid acronym)
* @param theEllipsoidAcronym the acronym (must be a valid proj4 ellipsoid acronym)
*/
void setEllipsoidAcronym( QString theEllipsoidAcronym );
@ -368,8 +370,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
/*! Get a record from the srs.db or qgis.db backends, given an sql statment.
* @note only handles queries that return a single record.
* @note it will first try the system srs.db then the users qgis.db!
* @param QString The sql query to execute
* @return QMap An associative array of field name <-> value pairs
* @param theSql The sql query to execute
* @return An associative array of field name <-> value pairs
*/
RecordMap getRecord( QString theSql );

14
src/core/qgscoordinatetransform.h
View File

@ -78,7 +78,7 @@ class CORE_EXPORT QgsCoordinateTransform: public QObject
* Constructs a QgsCoordinateTransform using a Spatial Reference Id
* of the layer and map canvas coordinate system as Wkt
* @param theSourceSrid Spatial Ref Id of the layer's coordinate system
* @param theSourceWkt Wkt of the map canvas coordinate system
* @param theDestWkt Wkt of the map canvas coordinate system
* @param theSourceCRSType On of the enum members defined in QgsCoordinateReferenceSystem::CrsType
*/
QgsCoordinateTransform( long theSourceSrid,
@ -144,7 +144,7 @@ class CORE_EXPORT QgsCoordinateTransform: public QObject
* It assumes that rect is a bounding box, and creates a bounding box
* in the proejcted CS, so that all points in source rectangle is within
* returned rectangle.
* @param QgsRectangle rect to transform
* @param theRect rect to transform
* @param direction TransformDirection (defaults to ForwardTransform)
* @return QgsRectangle in Destination Coordinate System
*/
@ -161,7 +161,7 @@ class CORE_EXPORT QgsCoordinateTransform: public QObject
/*! Transform a QgsRectangle to the dest Coordinate system
* If the direction is ForwardTransform then coordinates are transformed from layer CS --> map canvas CS,
* otherwise points are transformed from map canvas CS to layerCS.
* @param QgsRectangle rect to transform
* @param theRect rect to transform
* @param direction TransformDirection (defaults to ForwardTransform)
* @return QgsRectangle in Destination Coordinate System
*/
@ -170,8 +170,10 @@ class CORE_EXPORT QgsCoordinateTransform: public QObject
/*! Transform an array of coordinates to a different Coordinate System
* If the direction is ForwardTransform then coordinates are transformed from layer CS --> map canvas CS,
* otherwise points are transformed from map canvas CS to layerCS.
* @param x x cordinate of point to transform
* @param y y coordinate of point to transform
* @param numPoint number of coordinates in arrays
* @param x array of x coordinates to transform
* @param y array of y coordinates to transform
* @param z array of z coordinates to transform
* @param direction TransformDirection (defaults to ForwardTransform)
* @return QgsRectangle in Destination Coordinate System
*/
@ -211,7 +213,7 @@ class CORE_EXPORT QgsCoordinateTransform: public QObject
/*! Stores state to the given Dom node in the given document
* @param theNode The node in which state will be restored
* @param theDom The document in which state will be stored
* @param theDoc The document in which state will be stored
* @return bool True on success, False on failure
*/
bool writeXML( QDomNode & theNode, QDomDocument & theDoc );

2
src/core/qgsdataprovider.h
View File

@ -66,7 +66,7 @@ class CORE_EXPORT QgsDataProvider : public QObject
/**
* Set the data source specification. This may be a path or database
* connection string
* @param data source specification
* @param uri source specification
*/
virtual void setDataSourceUri( QString const & uri )
{

2
src/core/qgsfield.h
View File

@ -30,7 +30,7 @@ class CORE_EXPORT QgsField
{
public:
/** Constructor. Constructs a new QgsField object.
* @param nam Field name
* @param name Field name
* @param type Field variant type, currently supported: String / Int / Double
* @param typeName Field type (eg. char, varchar, text, int, serial, double).
Field types are usually unique to the source and are stored exactly

13
src/core/qgsgeometry.h
View File

@ -267,9 +267,9 @@ class CORE_EXPORT QgsGeometry
/**Splits this geometry according to a given line. Note that the geometry is only split once. If there are several intersections
between geometry and splitLine, only the first one is considered.
@param splitLine the line that splits the geometry
@param newGeometrys OUT: list of new geometries that have been created with the split
@param[out] newGeometries list of new geometries that have been created with the split
@param topological true if topological editing is enabled
@topologyTestPoints OUT: points that need to be tested for topological completeness in the dataset
@param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
@return 0 in case of success, 1 if geometry has not been split, error else*/
int splitGeometry( const QList<QgsPoint>& splitLine,
QList<QgsGeometry*>&newGeometries,
@ -478,6 +478,9 @@ class CORE_EXPORT QgsGeometry
* If the requested vertex number is greater
* than the last actual vertex,
* it is assumed that the vertex is to be appended instead of inserted.
* @param x x coordinate
* @param y y coordinate
* @param beforeVertex insert before vertex with this index
* @param old_sequence The sequence to update (The caller remains the owner).
* @param new_sequence The updated sequence (The caller becomes the owner if the function returns true).
* Returns false if beforeVertex does not correspond to a valid vertex number
@ -489,7 +492,6 @@ class CORE_EXPORT QgsGeometry
GEOSCoordSequence** new_sequence );
/**Translates a single vertex by dx and dy.
@param ptr pointer to the wkb fragment containing the vertex
@param wkbPosition position in wkb array. Is increased automatically by the function
@param dx translation of x-coordinate
@param dy translation of y-coordinate
@ -497,7 +499,6 @@ class CORE_EXPORT QgsGeometry
void translateVertex( int& wkbPosition, double dx, double dy, bool hasZValue );
/**Transforms a single vertex by ct.
@param ptr pointer to the wkb fragment containing the vertex
@param wkbPosition position in wkb array. Is increased automatically by the function
@param ct the QgsCoordinateTransform
@param hasZValue 25D type?*/
@ -506,8 +507,8 @@ class CORE_EXPORT QgsGeometry
//helper functions for geometry splitting
/**Splits line/multiline geometries
@splitLine the line that splits the feature
@newGeometry new geometry if splitting was successful
@param splitLine the line that splits the feature
@param newGeometries new geometries if splitting was successful
@return 0 in case of success, 1 if geometry has not been split, error else*/
int splitLinearGeometry( GEOSGeometry *splitLine, QList<QgsGeometry*>& newGeometries );
/**Splits polygon/multipolygon geometries

2
src/core/qgshttptransaction.h
View File

@ -86,7 +86,7 @@ class CORE_EXPORT QgsHttpTransaction : public QObject
QString errorString();
/**Apply proxy settings from QSettings to a http object
@param return true if proxy settings was applied, false else*/
@return true if proxy settings was applied, false else*/
static bool applyProxySettings( QHttp& http, const QString& url );
/**

22
src/core/qgslabel.h
View File

@ -92,13 +92,22 @@ class CORE_EXPORT QgsLabel
};
/** \brief render label
* \param sizeScale global scale factor for size in pixels, labels in map units are not scaled
* \note deprecated
* \param painter painter to render label in
* \param viewExtent extent to render labels in
* \param coordinateTransform coordinate transformation to use
* \param transform transformation from coordinate to canvas pixels
* \param feature feature to label
* \param selected feature is selected
* \param classAttributes attributes to create label from
* \param sizeScale scale
* \param rasterScaleFactor raster scale
* \deprecated
*/
void renderLabel( QPainter* painter, const QgsRectangle& viewExtent,
QgsCoordinateTransform* coordinateTransform,
const QgsMapToPixel *transform,
QgsFeature &feature, bool selected, QgsLabelAttributes *classAttributes = 0, double sizeScale = 1., double rasterScaleFactor = 1.0 )
QgsFeature &feature, bool selected, QgsLabelAttributes *classAttributes = 0,
double sizeScale = 1., double rasterScaleFactor = 1.0 )
{
QgsRenderContext r;
r.setExtent( viewExtent );
@ -111,13 +120,16 @@ class CORE_EXPORT QgsLabel
}
/** \brief render label
* \param sizeScale global scale factor for size in pixels, labels in map units are not scaled
* \param renderContext the render context
* \param feature feature to render the label for
* \param selected feature is selected
* \param classAttributes attributes to create the label from
* \note added in 1.2
*/
void renderLabel( QgsRenderContext &renderContext, QgsFeature &feature, bool selected, QgsLabelAttributes *classAttributes = 0 );
/** Reads the renderer configuration from an XML file
@param rnode the Dom node to read
@param node the Dom node to read
*/
void readXML( const QDomNode& node );

34
src/core/qgsmaplayer.h
View File

@ -55,6 +55,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** Constructor
* @param type Type of layer as defined in QgsMapLayer::LayerType enum
* @param lyrname Display Name of the layer
* @param source datasouce of layer
*/
QgsMapLayer( QgsMapLayer::LayerType type = VectorLayer, QString lyrname = QString::null, QString source = QString::null );
@ -85,14 +86,14 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** This is the method that does the actual work of
* drawing the layer onto a paint device.
* @param QgsRenderContext - describes the extents,
* @param rendererContext describes the extents,
* resolution etc. that should be used when rendering the
* layer.
*/
virtual bool draw( QgsRenderContext& rendererContext );
/** Draw labels
* @TODO to be removed: used only in vector layers
* @todo to be removed: used only in vector layers
*/
virtual void drawLabels( QgsRenderContext& rendererContext );
@ -152,6 +153,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** stores state in Dom node
@param layer_node is Dom node corresponding to ``projectlayers'' tag
@param document is Dom document
@note
The Dom node corresponds to a Dom document project file XML element to be
@ -227,7 +229,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** Retrieve the default style for this layer if one
* exists (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* @param a reference to a flag that will be set to false if
* @param theResultFlag a reference to a flag that will be set to false if
* we did not manage to load the default style.
* @return a QString with any status messages
* @see also loadNamedStyle ();
@ -237,12 +239,12 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** Retrieve a named style for this layer if one
* exists (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* @param QString theURI - the file name or other URI for the
* @param theURI - the file name or other URI for the
* style file. First an attempt will be made to see if this
* is a file and load that, if that fails the qgis.db styles
* table will be consulted to see if there is a style who's
* key matches the URI.
* @param a reference to a flag that will be set to false if
* @param theResultFlag a reference to a flag that will be set to false if
* we did not manage to load the default style.
* @return a QString with any status messages
* @see also loadDefaultStyle ();
@ -254,42 +256,42 @@ class CORE_EXPORT QgsMapLayer : public QObject
/** Save the properties of this layer as the default style
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* @param a reference to a flag that will be set to false if
* @param theResultFlag a reference to a flag that will be set to false if
* we did not manage to save the default style.
* @return a QString with any status messages
* @see also loadNamedStyle () and saveNamedStyle()
* @sa loadNamedStyle() and @see saveNamedStyle()
*/
virtual QString saveDefaultStyle( bool & theResultFlag );
/** Save the properties of this layer as a named style
* (either as a .qml file on disk or as a
* record in the users style table in their personal qgis.db)
* @param QString theURI - the file name or other URI for the
* @param theURI the file name or other URI for the
* style file. First an attempt will be made to see if this
* is a file and save to that, if that fails the qgis.db styles
* table will be used to create a style entry who's
* key matches the URI.
* @param a reference to a flag that will be set to false if
* @param theResultFlag a reference to a flag that will be set to false if
* we did not manage to save the default style.
* @return a QString with any status messages
* @see also saveDefaultStyle ();
* @sa saveDefaultStyle()
*/
virtual QString saveNamedStyle( const QString theURI, bool & theResultFlag );
/** Read the symbology for the current layer from the Dom node supplied.
* @param QDomNode node that will contain the symbology definition for this layer.
* @param node node that will contain the symbology definition for this layer.
* @param errorMessage reference to string that will be updated with any error messages
* @return true in case of success.
*/
virtual bool readSymbology( const QDomNode& node, QString& errorMessage ) = 0;
/** Write the symbology for the layer into the docment provided.
* @param QDomNode the node that will have the style element added to it.
* @param QDomDocument the document that will have the QDomNode added.
* @param errorMessage reference to string that will be updated with any error messages
* @param node the node that will have the style element added to it.
* @param doc the document that will have the QDomNode added.
* @param errorMessage reference to string that will be updated with any error messages
* @return true in case of success.
*/
virtual bool writeSymbology( QDomNode&, QDomDocument& doc, QString& errorMessage ) const = 0;
virtual bool writeSymbology( QDomNode &node, QDomDocument& doc, QString& errorMessage ) const = 0;
/** Return pointer to layer's undo stack */
QUndoStack* undoStack();
@ -339,7 +341,7 @@ class CORE_EXPORT QgsMapLayer : public QObject
void layerCrsChanged();
/** This signal should be connected with the slot QgsMapCanvas::refresh()
* @TODO: to be removed - GUI dependency
* \todo to be removed - GUI dependency
*/
void repaintRequested();

2
src/core/qgsnetworkaccessmanager.cpp
View File

@ -122,7 +122,7 @@ void QgsNetworkAccessManager::setFallbackProxyAndExcludes( const QNetworkProxy &
mExcludedURLs = excludes;
}
QNetworkReply *QgsNetworkAccessManager::createRequest( QgsNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *outgoingData )
QNetworkReply *QgsNetworkAccessManager::createRequest( QNetworkAccessManager::Operation op, const QNetworkRequest &req, QIODevice *outgoingData )
{
emit requestAboutToBeCreated( op, req, outgoingData );
QNetworkReply *reply = QNetworkAccessManager::createRequest( op, req, outgoingData );

2
src/core/qgspallabeling.h
View File

@ -131,7 +131,7 @@ class CORE_EXPORT QgsPalLayerSettings
QMap< DataDefinedProperties, int > dataDefinedProperties;
/**Calculates pixel size (considering scale factors and oversampling)
@param label size (pixels, possibily map units in future)
@param size size to convert
@param c rendercontext
@return font pixel size*/
int sizeToPixel( double size, const QgsRenderContext& c ) const;

49
src/core/qgsproject.cpp
View File

@ -42,19 +42,9 @@
static const char *const ident_ = "$Id$";
// / canonical project instance
// canonical project instance
QgsProject * QgsProject::theProject_;
/**
Take the given scope and key and convert them to a string list of key
tokens that will be used to navigate through a Property hierarchy
@ -85,8 +75,9 @@ QStringList makeKeyTokens_( QString const &scope, QString const &key )
/**
return the property that matches the given key sequence, if any
@param sequence is a tokenized key sequence
@param p is likely to be the top level QgsPropertyKey in QgsProject:e:Imp.
@param scope scope of key
@param key keyname
@param rootProperty is likely to be the top level QgsPropertyKey in QgsProject:e:Imp.
@return null if not found, otherwise located Property
*/
@ -159,7 +150,8 @@ QgsProperty * findKey_( QString const & scope,
/** add the given key and value
@param sequence is list of keys
@param scope scope of key
@param key key name
@param rootProperty is the property from which to start adding
@param value the value associated with the key
*/
@ -435,10 +427,11 @@ static void dump_( QgsPropertyKey const & topQgsPropertyKey )
Restore any optional properties found in "doc" to "properties".
<properties> tags for all optional properties. Within that there will be
scope tags. In the following example there exist one property in the
"fsplugin" scope. "layers" is a list containing three string values.
properties tags for all optional properties. Within that there will be scope
tags. In the following example there exist one property in the "fsplugin"
scope. "layers" is a list containing three string values.
\verbatim
<properties>
<fsplugin>
<foo type="int" >42</foo>
@ -454,7 +447,9 @@ scope tags. In the following example there exist one property in the
</feature_types>
</fsplugin>
</properties>
\endverbatim
@param doc xml document
@param project_properties should be the top QgsPropertyKey node.
*/
@ -537,10 +532,12 @@ _getProperties( QDomDocument const &doc, QgsPropertyKey & project_properties )
Get the project title
XML in file has this form:
\verbatim
<qgis projectname="default project">
<title>a project title</title>
\endverbatim
@todo XXX we should go with the attribute xor <title>, not both.
@todo XXX we should go with the attribute xor title, not both.
*/
static void _getTitle( QDomDocument const &doc, QString & title )
{
@ -604,12 +601,13 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
Read map layers from project file
@returns pair of < bool, list<QDomNode> >; bool is true if function worked;
else is false. list contains nodes corresponding to layers that couldn't
be loaded
@returns \code QPair< bool, QList<QDomNode> > \endcode
bool is true if function worked; else is false.
list contains nodes corresponding to layers that couldn't be loaded
@note XML of form:
\verbatim
<maplayer type="vector">
<layername>Hydrop</layername>
<datasource>/data/usgs/city_shp/hydrop.shp</datasource>
@ -644,7 +642,7 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
<alignment value="center" field="" />
</labelattributes>
</maplayer>
\endverbatim
*/
QPair< bool, QList<QDomNode> > QgsProject::_getMapLayers( QDomDocument const &doc )
{
@ -750,7 +748,7 @@ bool QgsProject::read( QFileInfo const &file )
/**
/*
@note it's presumed that the caller has already reset the map canvas, map
registry, and legend
*/
@ -763,10 +761,10 @@ bool QgsProject::read()
if ( !imp_->file.open( QIODevice::ReadOnly ) )
{
imp_->file.close(); // even though we got an error, let's make
// sure it's closed anyway
imp_->file.close();
setError( tr( "Unable to open %1" ).arg( imp_->file.fileName() ) );
return false;
}
@ -789,6 +787,7 @@ bool QgsProject::read()
imp_->file.close();
setError( tr( "%1 for file %2" ).arg( errorString ).arg( imp_->file.fileName() ) );
return false;
}

2
src/core/qgsproject.h
View File

@ -144,7 +144,7 @@ class CORE_EXPORT QgsProject : public QObject
implementations fails. Since the read()s are invoked from qgisapp,
then qgisapp handles the exception. It prompts the user for the new
location of the data, if any. If there is a new location, the Dom
node associated with the layer has its <datasource> tag corrected.
node associated with the layer has its datasource tag corrected.
Then that node is passed to this member function to be re-opened.
*/

2
src/core/qgsprojectproperty.cpp
View File

@ -225,7 +225,7 @@ bool QgsPropertyValue::readXML( QDomNode & keyNode )
/**
@param element created by parent QgsPropertyKey
keyElement created by parent QgsPropertyKey
*/
bool QgsPropertyValue::writeXML( QString const & nodeName,
QDomElement & keyElement,

8
src/core/qgsprojectproperty.h
View File

@ -85,13 +85,13 @@ class CORE_EXPORT QgsProperty
virtual bool readXML( QDomNode & keyNode ) = 0;
/**
adds property hierarchy to given Dom node
adds property hierarchy to given Dom element
Used for saving properties to project file.
@param nodeName the tag name associated with this element
@param node the parent (or encompassing) property node
@param documetn the overall project file Dom document
@param element the parent (or encompassing) property element
@param document the overall project file Dom document
*/
virtual bool writeXML( QString const & nodeName,
QDomElement & element,
@ -238,6 +238,8 @@ class CORE_EXPORT QgsPropertyKey : public QgsProperty
/** set the value associated with this key
@param name is the key name
@param value is the value to set
@return pointer to property value
*/
QgsPropertyValue * setValue( QString const & name, QVariant const & value )
{

4
src/core/qgsrasterdataprovider.h
View File

@ -121,7 +121,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider
/**
* \brief Identify details from a server (e.g. WMS) from the last screen update
*
* \param point[in] The pixel coordinate (as it was displayed locally on screen)
* \param[in] point The pixel coordinate (as it was displayed locally on screen)
*
* \return A text document containing the return from the WMS server
*
@ -136,7 +136,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider
/**
* \brief Identify details from a server (e.g. WMS) from the last screen update
*
* \param point[in] The pixel coordinate (as it was displayed locally on screen)
* \param[in] point The pixel coordinate (as it was displayed locally on screen)
*
* \return A html document containing the return from the WMS server
*

4
src/core/qgstolerance.h
View File

@ -54,7 +54,9 @@ class CORE_EXPORT QgsTolerance
/**
* Static function to translate tolerance value into current map unit value
* @param tolerace tolerance value to be translated
* @param tolerance tolerance value to be translated
* @param layer reference layer
* @param renderer renderer
* @param units type of units to be translated
* @return value of tolerance in map units
*/

2
src/core/qgsvectordataprovider.h
View File

@ -195,7 +195,7 @@ class CORE_EXPORT QgsVectorDataProvider : public QgsDataProvider
/**
* Return unique values of an attribute
* @param index the index of the attribute
* @param values reference to the list to fill
* @param uniqueValues values reference to the list to fill
* @param limit maxmum number of the values to return (added in 1.4)
*
* Default implementation simply iterates the features

2
src/core/qgsvectorfilewriter.h
View File

@ -119,7 +119,7 @@ class CORE_EXPORT QgsVectorFileWriter
~QgsVectorFileWriter();
/** Delete a shapefile (and its accompanying shx / dbf / prf)
* @param QString theFileName - /path/to/file.shp
* @param theFileName /path/to/file.shp
* @return bool true if the file was deleted successfully
*/
static bool deleteShapeFile( QString theFileName );

16
src/core/qgsvectorlayer.h
View File

@ -204,19 +204,19 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
virtual bool writeXml( QDomNode & layer_node, QDomDocument & doc );
/** Read the symbology for the current layer from the Dom node supplied.
* @param QDomNode node that will contain the symbology definition for this layer.
* @param node node that will contain the symbology definition for this layer.
* @param errorMessage reference to string that will be updated with any error messages
* @return true in case of success.
*/
bool readSymbology( const QDomNode& node, QString& errorMessage );
/** Write the symbology for the layer into the docment provided.
* @param QDomNode the node that will have the style element added to it.
* @param QDomDocument the document that will have the QDomNode added.
* @param errorMessage reference to string that will be updated with any error messages
* @param node the node that will have the style element added to it.
* @param doc the document that will have the QDomNode added.
* @param errorMessage reference to string that will be updated with any error messages
* @return true in case of success.
*/
bool writeSymbology( QDomNode&, QDomDocument& doc, QString& errorMessage ) const;
bool writeSymbology( QDomNode& node, QDomDocument& doc, QString& errorMessage ) const;
/**
@ -260,7 +260,8 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
bool featureAtId( int featureId, QgsFeature &f, bool fetchGeometries = true, bool fetchAttributes = true );
/** Adds a feature
@param lastFeatureInBatch If True, will also go to the effort of e.g. updating the extents.
@param f feature to add
@param alsoUpdateExtent If True, will also go to the effort of e.g. updating the extents.
@return True in case of success and False in case of error
*/
bool addFeature( QgsFeature& f, bool alsoUpdateExtent = true );
@ -637,9 +638,10 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
/**Snaps to a geometry and adds the result to the multimap if it is within the snapping result
@param startPoint start point of the snap
@param featureId id of feature
@param geom geometry to snap
@param sqrSnappingTolerance squared search tolerance of the snap
@param snappingResult list to which the result is appended
@param snappingResults list to which the result is appended
@param snap_to snap to vertex or to segment
*/
void snapToGeometry( const QgsPoint& startPoint, int featureId, QgsGeometry* geom, double sqrSnappingTolerance,

75
src/core/raster/qgsrasterlayer.cpp
View File

@ -79,15 +79,15 @@ QgsRasterLayer::QgsRasterLayer(
QString const & path,
QString const & baseName,
bool loadDefaultStyleFlag )
: QgsMapLayer( RasterLayer, baseName, path ),
: QgsMapLayer( RasterLayer, baseName, path )
// Constant that signals property not used.
QSTRING_NOT_SET( "Not Set" ),
TRSTRING_NOT_SET( tr( "Not Set" ) ),
mStandardDeviations( 0 ),
mDataProvider( 0 ),
mWidth( std::numeric_limits<int>::max() ),
mHeight( std::numeric_limits<int>::max() ),
mInvertColor( false )
, QSTRING_NOT_SET( "Not Set" )
, TRSTRING_NOT_SET( tr( "Not Set" ) )
, mStandardDeviations( 0 )
, mDataProvider( 0 )
, mWidth( std::numeric_limits<int>::max() )
, mHeight( std::numeric_limits<int>::max() )
, mInvertColor( false )
{
mRasterType = QgsRasterLayer::GrayOrUndefined;
@ -167,8 +167,8 @@ QgsRasterLayer::QgsRasterLayer(
} // QgsRasterLayer ctor
/**
* TODO Rename into a general constructor when the old raster interface is retired
* @param dummy is just there to distinguish this function signature from the old non-provider one.
* @todo Rename into a general constructor when the old raster interface is retired
* parameter dummy is just there to distinguish this function signature from the old non-provider one.
*/
QgsRasterLayer::QgsRasterLayer( int dummy,
QString const & rasterLayerPath,
@ -178,15 +178,15 @@ QgsRasterLayer::QgsRasterLayer( int dummy,
QStringList const & styles,
QString const & format,
QString const & crs )
: QgsMapLayer( RasterLayer, baseName, rasterLayerPath ),
mStandardDeviations( 0 ),
mDataProvider( 0 ),
mEditable( false ),
mWidth( std::numeric_limits<int>::max() ),
mHeight( std::numeric_limits<int>::max() ),
mInvertColor( false ),
mModified( false ),
mProviderKey( providerKey )
: QgsMapLayer( RasterLayer, baseName, rasterLayerPath )
, mStandardDeviations( 0 )
, mDataProvider( 0 )
, mEditable( false )
, mWidth( std::numeric_limits<int>::max() )
, mHeight( std::numeric_limits<int>::max() )
, mInvertColor( false )
, mModified( false )
, mProviderKey( providerKey )
{
QgsDebugMsg( "(8 arguments) starting. with layer list of " +
layers.join( ", " ) + " and style list of " + styles.join( ", " ) + " and format of " +
@ -677,7 +677,7 @@ int QgsRasterLayer::bandNumber( QString const & theBandName )
* <li>myRasterBandStats.colorTable
* </ul>
*
* @seealso RasterBandStats
* @sa RasterBandStats
* @note This is a cpu intensive and slow task!
*/
const QgsRasterBandStats QgsRasterLayer::bandStatistics( int theBandNo )
@ -1051,7 +1051,7 @@ QString QgsRasterLayer::buildPyramids( RasterPyramidList const & theRasterPyrami
{
//build the pyramid and show progress to console
//NOTE this (magphase) is disabled in teh gui since it tends
//NOTE this (magphase) is disabled in the gui since it tends
//to create corrupted images. The images can be repaired
//by running one of the other resampling strategies below.
//see ticket #284
@ -1361,7 +1361,7 @@ bool QgsRasterLayer::copySymbologySettings( const QgsMapLayer& theOther )
} //todo
/**
* @param band number
* @param theBandNo the band number
* @return pointer to the color table
*/
QList<QgsColorRampShader::ColorRampItem>* QgsRasterLayer::colorTable( int theBandNo )
@ -2314,7 +2314,7 @@ QPixmap QgsRasterLayer::legendAsPixmap( bool theWithNameFlag )
} //end of legendAsPixmap function
/**
* \param int theLabelCountInt Number of vertical labels to display
* \param theLabelCount number of vertical labels to display
* @return a pixmap representing a legend image
*/
QPixmap QgsRasterLayer::legendAsPixmap( int theLabelCount )
@ -3899,6 +3899,7 @@ bool QgsRasterLayer::readSymbology( const QDomNode& layer_node, QString& errorMe
Raster layer project file XML of form:
\verbatim
<maplayer type="raster" visible="1" showInOverviewFlag="1">
<layername>Wynoochee_dem</layername>
<datasource>/home/mcoletti/mnt/MCOLETTIF8F9/c/Toolkit_Course/Answers/Training_Data/wynoochee_dem.img</datasource>
@ -3914,12 +3915,13 @@ bool QgsRasterLayer::readSymbology( const QDomNode& layer_node, QString& errorMe
<mGrayBandName>Undefined</mGrayBandName>
</rasterproperties>
</maplayer>
\endverbatim
@note Called by QgsMapLayer::readXML().
*/
bool QgsRasterLayer::readXml( QDomNode & layer_node )
{
//! @NOTE Make sure to read the file first so stats etc are initialised properly!
//! @note Make sure to read the file first so stats etc are initialised properly!
//process provider key
QDomNode pkeyNode = layer_node.namedItem( "provider" );
@ -4538,9 +4540,10 @@ void QgsRasterLayer::drawMultiBandSingleBandPseudoColor( QPainter * theQPainter,
/**
* This method is used to render a single band with a color map.
* @param theQPainter - pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort - pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theGdalBand - pointer to the GDALRasterBand which should be rendered.
* @param theQPainter pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theQgsMapToPixel transformation coordinate to map canvas pixel
* @param theBandNo band number
*/
void QgsRasterLayer::drawPalettedSingleBandColor( QPainter * theQPainter, QgsRasterViewPort * theRasterViewPort,
const QgsMapToPixel* theQgsMapToPixel, int theBandNo )
@ -4617,9 +4620,10 @@ void QgsRasterLayer::drawPalettedSingleBandColor( QPainter * theQPainter, QgsRas
/**
* This method is used to render a paletted raster layer as a gray image.
* @param theQPainter - pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort - pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theGdalBand - pointer to the GDALRasterBand which should be rendered.
* @param theQPainter pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theQgsMapToPixel transformation between map coordinates and canvas pixels
* @param theBandNo band number
*/
void QgsRasterLayer::drawPalettedSingleBandGray( QPainter * theQPainter, QgsRasterViewPort * theRasterViewPort,
const QgsMapToPixel* theQgsMapToPixel, int theBandNo )
@ -4700,7 +4704,8 @@ void QgsRasterLayer::drawPalettedSingleBandGray( QPainter * theQPainter, QgsRast
* This method is used to render a paletted raster layer as a pseudocolor image.
* @param theQPainter - pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort - pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theGdalBand - pointer to the GDALRasterBand which should be rendered.
* @param theQgsMapToPixel transformation between map coordinates and canvas pixels
* @param theBandNo band number
gray.
*/
@ -4792,9 +4797,11 @@ void QgsRasterLayer::drawPalettedSingleBandPseudoColor( QPainter * theQPainter,
/**
* This method is used to render a paletted raster layer as a color image -- currently not supported
* @param theQPainter - pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort - pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theGdalBand - pointer to the GDALRasterBand which should be rendered.
* @param theQPainter pointer to the QPainter onto which the layer should be drawn.
* @param theRasterViewPort pointer to the ViewPort struct containing dimensions of viewable area and subset area to be extracted from data file.
* @param theQgsMapToPixel transformation coordinate to map canvas pixel
* @param theBandNo pointer to the GDALRasterBand which should be rendered.
* @note not supported at this time
*/
void QgsRasterLayer::drawPalettedMultiBandColor( QPainter * theQPainter, QgsRasterViewPort * theRasterViewPort,
const QgsMapToPixel* theQgsMapToPixel, int theBandNo )

2
src/core/raster/qgsrasterlayer.h
View File

@ -503,7 +503,7 @@ class CORE_EXPORT QgsRasterLayer : public QgsMapLayer
QString identifyAsText( const QgsPoint & point );
/** \brief Identify arbitrary details from the WMS server found on the point position
* @added in 1.5
* @note added in 1.5
*/
QString identifyAsHtml( const QgsPoint & point );

8
src/core/renderer/qgsgraduatedsymbolrenderer.h
View File

@ -67,15 +67,17 @@ class CORE_EXPORT QgsGraduatedSymbolRenderer: public QgsRenderer
virtual bool willRenderFeature( QgsFeature *f );
/**Renders a feature
\param p a painter (usually the one from the current map canvas)
\param renderContext the render context
\param f a pointer to a feature to render
\param t the transform object containing the information how to transform the map coordinates to screen coordinates
\param img image to render in
\param selected feature is selected
\param opacity opacity of feature
\note added in 1.2 */
void renderFeature( QgsRenderContext &renderContext, QgsFeature& f, QImage* img, bool selected, double opacity = 1.0 );
/**Sets the classicifation field by index
\param field the number of the field to classify*/
void setClassificationField( int );
void setClassificationField( int field );
/**Reads the renderer configuration from an XML file
@param rnode the Dom node to read

9
src/core/renderer/qgsrenderer.h
View File

@ -58,8 +58,10 @@ class CORE_EXPORT QgsRenderer
/**A vector layer passes features to a renderer object to change the brush and pen of the qpainter
@param p the painter storing brush and pen
@param f a pointer to the feature to be rendered
@param pic pointer to an image (used for point symbols)
@param scalefactor pointer to the scale factor for the marker image
@param img a pointer to picture
@param selected feature is selected
@param widthScale scale
@param rasterScaleFactor raster scale
@note deprecated */
void renderFeature( QPainter* p, QgsFeature& f, QImage* img, bool selected, double widthScale = 1.0, double rasterScaleFactor = 1.0 )
{
@ -82,8 +84,9 @@ class CORE_EXPORT QgsRenderer
/**Reads the renderer configuration from an XML file
@param rnode the Dom node to read
@param vl the vector layer which will be associated with the renderer
@return 0 in case of success, 1 if vector layer has no renderer, 2 if classification field not found*/
@return 0 in case of success, 1 if vector layer has no renderer, 2 if classification field not found*/
virtual int readXML( const QDomNode& rnode, QgsVectorLayer& vl ) = 0;
/**Writes the contents of the renderer to a configuration file*/
// virtual void writeXML(std::ostream& xml)=0;
/**Writes the contents of the renderer to a configuration file

1
src/core/symbology-ng/qgscategorizedsymbolrendererv2.h
View File

@ -8,6 +8,7 @@
class QgsVectorColorRampV2;
class QgsVectorLayer;
/* \brief categorized renderer */
class CORE_EXPORT QgsRendererCategoryV2
{
public:

8
src/core/symbology/qgsmarkercatalogue.h
View File

@ -42,11 +42,19 @@ class CORE_EXPORT QgsMarkerCatalogue : public QObject
/** Returns pixmap of the marker
* \param fullName full name, e.g. hard:circle, svg:/home/usr1/marker1.svg
* \param size size of image
* \param pen pen to use
* \param brush brush to use
* \param opacity opacity to use
*/
QImage imageMarker( QString fullName, double size, QPen pen, QBrush brush, double opacity = 1.0 );
/** Returns qpicture of the marker
* \param fullName full name, e.g. hard:circle, svg:/home/usr1/marker1.svg
* \param size size of marker
* \param pen pen to use
* \param brush brush to use
* \param opacity opacity to use
*/
QPicture pictureMarker( QString fullName, double size, QPen pen, QBrush brush, double opacity = 1.0 );

1
src/gui/qgisgui.h
View File

@ -56,6 +56,7 @@ namespace QgisGui
@param selectedFiles string list of selected files; will be empty if none selected
@param enc encoding?
@param title the title for the dialog
@param cancelAll add button to cancel further requests
@note
Stores persistent settings under /UI/. The sub-keys will be

4
src/gui/qgisinterface.h
View File

@ -163,13 +163,13 @@ class GUI_EXPORT QgisInterface : public QObject
*/
virtual bool unregisterMainWindowAction( QAction* action ) = 0;
// TODO: is this deprecated in favour of QgsContextHelp?
// @todo is this deprecated in favour of QgsContextHelp?
/** Open a url in the users browser. By default the QGIS doc directory is used
* as the base for the URL. To open a URL that is not relative to the installed
* QGIS documentation, set useQgisDocDirectory to false.
* @param url URL to open
* @param useQgisDocDirectory If true, the URL will be formed by concatenating
* url to the QGIS documentation directory path (<prefix>/share/doc)
* url to the QGIS documentation directory path (prefix/share/doc)
*/
virtual void openURL( QString url, bool useQgisDocDirectory = true ) = 0;

1
src/gui/qgsattributeeditor.h
View File

@ -25,6 +25,7 @@ class QWidget;
class QgsVectorLayer;
class QComboBox;
/* \brief create attribute widget for editing */
class GUI_EXPORT QgsAttributeEditor : public QObject
{
Q_OBJECT

4
src/gui/qgsgenericprojectionselector.cpp
View File

@ -80,13 +80,13 @@ void QgsGenericProjectionSelector::setSelectedAuthId( QString theID )
QString QgsGenericProjectionSelector::selectedProj4String()
{
//@NOTE don't use getSelectedWkt as that just returns the name part!
//@note don't use getSelectedWkt as that just returns the name part!
return projectionSelector->selectedProj4String();
}
long QgsGenericProjectionSelector::selectedCrsId()
{
//@NOTE don't use getSelectedWkt as that just returns the name part!
//@note don't use getSelectedWkt as that just returns the name part!
return projectionSelector->selectedCrsId();
}

2
src/gui/qgsmapcanvas.cpp
View File

@ -54,7 +54,7 @@ email : sherman at mrcc.com
#include "qgsvectorlayer.h"
#include <math.h>
/** @DEPRECATED: to be deleted, stuff from here should be moved elsewhere */
/** @deprecated to be deleted, stuff from here should be moved elsewhere */
class QgsMapCanvas::CanvasProperties
{
public:

2
src/gui/qgsmapcanvassnapper.h
View File

@ -58,7 +58,7 @@ class GUI_EXPORT QgsMapCanvasSnapper
Uses snap mode QgsSnapper::SnapWithOneResult. Therefore, only the
closest result is returned.
@param p start point of the snap (in pixel coordinates)
@param result snapped point
@param results snapped points
@param excludePoints a list with (map coordinate) points that should be excluded in the snapping result. Useful e.g. for vertex moves where a vertex should not be snapped to its original position
@return 0 in case of success*/
int snapToBackgroundLayers( const QPoint& p, QList<QgsSnappingResult>& results, const QList<QgsPoint>& excludePoints = QList<QgsPoint>() );

11
src/gui/qgsmaptip.h
View File

@ -35,21 +35,20 @@ class GUI_EXPORT QgsMapTip
*/
virtual ~QgsMapTip();
/** Show a maptip at a given point on the map canvas
* @param QgsMapLayer thepLayer - a qgis vector map layer pointer that will
* @param thepLayer a qgis vector map layer pointer that will
* be used to provide the attribute data for the map tip.
* @param QgsPoint theMapPosition - a reference to the position of the cursor
* @param theMapPosition a reference to the position of the cursor
* in map coordinatess.
* @param QgsPoint thePixelPosition - a reference to the position of the cursor
* @param thePixelPosition a reference to the position of the cursor
* in pixel coordinates.
* @param QgsMapCanvas thepMapCanvas - a map canvas on which the tip is drawn
* @param mpMapCanvas a map canvas on which the tip is drawn
*/
void showMapTip( QgsMapLayer * thepLayer,
QgsPoint & theMapPosition,
QPoint & thePixelPosition,
QgsMapCanvas *mpMapCanvas );
/** Clear the current maptip if it exists
* @param QgsMapCanvas mpMapCanvas - the canvas from which the tip should
* be cleared.
* @param mpMapCanvas the canvas from which the tip should be cleared.
*/
void clear( QgsMapCanvas *mpMapCanvas );
private:

18
src/gui/qgsprojectbadlayerguihandler.h
View File

@ -39,7 +39,7 @@ class GUI_EXPORT QgsProjectBadLayerGuiHandler : public QObject, public QgsProjec
The QDomNode is a QgsProject Dom node corresponding to a map layer state.
Essentially dumps <datasource> tag.
Essentially dumps datasource tag.
*/
QString dataSource( QDomNode & layerNode );
@ -47,19 +47,18 @@ class GUI_EXPORT QgsProjectBadLayerGuiHandler : public QObject, public QgsProjec
The QDomNode is a QgsProject Dom node corresponding to a map layer state.
If the <provider> is "ogr", then it's a file type.
If the provider tag is "ogr", then it's a file type.
However, if the layer is a raster, then there won't be a <provider> tag. It
will always have an associated file.
However, if the layer is a raster, then there won't be a
provider tag. It will always have an associated file.
If the layer doesn't fall into either of the previous two categories, then
it's either a database or URL. If the <datasource> tag has "url=", then
it's URL based. If the <datasource> tag has "dbname=">, then the layer data
is in a database.
it's either a database or URL. If the datasource tag has "url=", then it's
URL based and if it has "dbname=">, then the layer data is in a database.
*/
ProviderType providerType( QDomNode & layerNode );
/** set the <datasource> to the new value */
/** set the datasource element to the new value */
void setDataSource( QDomNode & layerNode, QString const & dataSource );
/** this is used to locate files that have moved or otherwise are missing */
@ -69,7 +68,8 @@ class GUI_EXPORT QgsProjectBadLayerGuiHandler : public QObject, public QgsProjec
This QDom object represents a QgsProject node that maps to a specific layer.
@param layerNode QDom node containing layer project information
@param fileFilters file filters to use
@param constLayerNode QDom node containing layer project information
@todo

2
src/gui/qgsprojectionselector.h
View File

@ -173,7 +173,7 @@ class GUI_EXPORT QgsProjectionSelector: public QWidget, private Ui::QgsProjectio
/**
* \brief gets an arbitrary sqlite3 expression from the selection
*
* \param attributeName The sqlite3 column name, typically "srid" or "sridid"
* \param e The sqlite3 expression (typically "srid" or "sridid")
*/
QString getSelectedExpression( QString e );

8
src/gui/qgsquickprint.h
View File

@ -76,9 +76,9 @@ class GUI_EXPORT QgsQuickPrint: public QObject
* to choose an appropriate scale factor, typically
* you should divide the print resolution by the
* screen resolution (often 72dpi or 96dpi).
* @param theScaleFactor - amount by which symbol sizes
* @param theScaleFactor amount by which symbol sizes
* will be multiplied.
* @param SymbolScalingType - whether the sizes should
* @param theDirection whether the sizes should
* be scaled up or down.
* @see scaleTextLabels
*/
@ -92,9 +92,9 @@ class GUI_EXPORT QgsQuickPrint: public QObject
* to choose an appropriate scale factor, typically
* you should divide the print resolution by the
* screen resolution (often 72dpi or 96dpi).
* @param theScaleFactor - amount by which symbol sizes
* @param theScaleFactor amount by which symbol sizes
* will be multiplied.
* @param SymbolScalingType - whether the sizes should
* @param theDirection whether the sizes should
* be scaled up or down.
* @see scalePointSymbols
*/

5
src/gui/qgsrubberband.h
View File

@ -58,7 +58,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
@param geom the geometry object
@param layer the layer containing the feature, used for coord transformation to map
crs. In case of 0 pointer, the coordinates are not going to be transformed.
@param render the maprender object (used for coord transformation)*/
*/
void setToGeometry( QgsGeometry* geom, QgsVectorLayer* layer );
/**Add the geometry of an existing feature to a rubberband
@ -66,8 +66,7 @@ class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
@param geom the geometry object
@param layer the layer containing the feature, used for coord transformation to map
crs. In case of 0 pointer, the coordinates are not going to be transformed.
@param render the maprender object (used for coord transformation)
@noted added in 1.5
@note added in 1.5
*/
void addGeometry( QgsGeometry* geom, QgsVectorLayer* layer );

2
src/mapserver/qgsconfigcache.h
View File

@ -23,7 +23,7 @@
class QgsConfigParser;
/**A cache for configuration XML (usefull because of the mapfile parameter)*/
/**A cache for configuration XML (useful because of the mapfile parameter)*/
class QgsConfigCache
{
public:

2
src/mapserver/qgssldrule.h
View File

@ -49,7 +49,7 @@ class QgsSLDRule
const QgsFilter* filter() const {return mFilter;}
/**Returns a set of attribute incices needed in this rule (filter indices and ev. \
/**Returns a set of attribute indices needed in this rule (filter indices and if any\
rotation attribute index and scaling attribute index */
QSet<int> attributeIndices() const;

12
src/mapserver/qgswmsserver.h
View File

@ -41,7 +41,7 @@ class QPainter;
/**This class handles all the wms server requests. The parameters and values have to be passed in the form of
a map<QString, QString>. This map is usually generated by a subclass of QgsWMSRequestHandler, which makes QgsWMSServer
independant from any server side technology*/
independent from any server side technology*/
class QgsWMSServer
{
@ -92,11 +92,11 @@ class QgsWMSServer
@param j pixel y-coordinate
@param layerCoords calculated layer coordinates are assigned to this point
@return 0 in case of success*/
int infoPointToLayerCoordinates( int i, int j, QgsPoint& layerCoords, QgsMapRenderer* mapRender, \
int infoPointToLayerCoordinates( int i, int j, QgsPoint& layerCoords, QgsMapRenderer* mapRender,
QgsMapLayer* layer ) const;
/**Appends feature info xml for the layer to the layer element of the feature info dom document
@return 0 in case of success*/
int featureInfoFromVectorLayer( QgsVectorLayer* layer, const QgsPoint& infoPoint, int nFeatures, QDomDocument& infoDocument, QDomElement& layerElement, QgsMapRenderer* mapRender, \
int featureInfoFromVectorLayer( QgsVectorLayer* layer, const QgsPoint& infoPoint, int nFeatures, QDomDocument& infoDocument, QDomElement& layerElement, QgsMapRenderer* mapRender,
QMap<int, QString>& aliasMap, QSet<QString>& hiddenAttributes ) const;
/**Appends feature info xml for the layer to the layer element of the dom document*/
int featureInfoFromRasterLayer( QgsRasterLayer* layer, const QgsPoint& infoPoint, QDomDocument& infoDocument, QDomElement& layerElement ) const;
@ -105,11 +105,11 @@ class QgsWMSServer
QStringList layerSet( const QStringList& layersList, const QStringList& stylesList, const QgsCoordinateReferenceSystem& destCRS ) const;
//helper functions for GetLegendGraphics
void drawLegendLayerItem( QgsComposerLayerItem* item, QPainter* p, double& maxX, double& currentY, const QFont& layerFont, \
const QFont& itemFont, double boxSpace, double layerSpace, double symbolSpace, double iconLabelSpace, \
void drawLegendLayerItem( QgsComposerLayerItem* item, QPainter* p, double& maxX, double& currentY, const QFont& layerFont,
const QFont& itemFont, double boxSpace, double layerSpace, double symbolSpace, double iconLabelSpace,
double symbolWidth, double symbolHeight, double fontOversamplingFactor, double dpi ) const;
/**Draws a (old generation) symbol. Optionally, maxHeight is adapted (e.g. for large point markers) */
void drawLegendSymbol( QgsComposerLegendItem* item, QPainter* p, double boxSpace, double currentY, double& symbolWidth, double& symbolHeight, \
void drawLegendSymbol( QgsComposerLegendItem* item, QPainter* p, double boxSpace, double currentY, double& symbolWidth, double& symbolHeight,
double layerOpacity, double dpi, double yDownShift ) const;
void drawPointSymbol( QPainter* p, QgsSymbol* s, double boxSpace, double currentY, double& symbolWidth, double& symbolHeight, double layerOpacity, double dpi ) const;
void drawLineSymbol( QPainter* p, QgsSymbol* s, double boxSpace, double currentY, double symbolWidth, double symbolHeight, double layerOpacity, double yDownShift ) const;

2
src/plugins/qgisplugin.h
View File

@ -12,7 +12,7 @@
* (at your option) any later version. *
* *
***************************************************************************/
/*! \mainpage Quantum GIS - Plugin API
/*! Quantum GIS - Plugin API
*
* \section about About QGis Plugins
* Plugins provide additional functionality to QGis. Plugins must

2
src/plugins/qgsapplydialog.h
View File

@ -19,7 +19,7 @@
#include <QDialog>
/**Interface class for dialogs that have an apply operation (e.g. for symbology)*/
/** \brief Interface class for dialogs that have an apply operation (e.g. for symbology)*/
class QgsApplyDialog: public QDialog
{
public: