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

@see -> \see

Browse Source
This commit is contained in:
Nyall Dawson 2017-04-03 10:32:35 +10:00
parent e47073b1e1
commit dfb5f56f80
271 changed files with 3723 additions and 3723 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -44,13 +44,13 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject
/**
* Sets the filename for the output database.
* @see outputDatabaseFileName()
* \see outputDatabaseFileName()
*/
void setOutputDatabaseFileName( const QString &fileName ) { mDbFileName = fileName; }
/**
* Returns the filename for the output database.
* @see setOutputDatabaseFileName()
* \see setOutputDatabaseFileName()
*/
QString outputDatabaseFileName() const { return mDbFileName; }

12
src/analysis/raster/qgskde.h
View File

@ -110,22 +110,22 @@ class ANALYSIS_EXPORT QgsKernelDensityEstimation
/**
* Prepares the output file for writing and setups up the surface calculation. This must be called
* before adding features via addFeature().
* @see addFeature()
* @see finalise()
* \see addFeature()
* \see finalise()
*/
Result prepare();
/**
* Adds a single feature to the KDE surface. prepare() must be called before adding features.
* @see prepare()
* @see finalise()
* \see prepare()
* \see finalise()
*/
Result addFeature( const QgsFeature &feature );
/**
* Finalises the output file. Must be called after adding all features via addFeature().
* @see prepare()
* @see addFeature()
* \see prepare()
* \see addFeature()
*/
Result finalise();

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

@ -41,13 +41,13 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos
/** Sets the initial resolution displayed in the dialog.
* \param resolution default resolution in DPI
* @see resolution()
* \see resolution()
*/
void setResolution( int resolution );
/** Returns the selected resolution from the dialog.
* \returns image resolution in DPI
* @see setResolution()
* \see setResolution()
*/
int resolution() const;
@ -58,23 +58,23 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos
void setImageSize( QSizeF size );
/** Returns the user-set image width in pixels.
* @see imageHeight
* \see imageHeight
*/
int imageWidth() const;
/** Returns the user-set image height in pixels.
* @see imageWidth
* \see imageWidth
*/
int imageHeight() const;
/** Sets whether the crop to contents option should be checked in the dialog
* \param crop set to true to check crop to contents
* @see cropToContents()
* \see cropToContents()
*/
void setCropToContents( bool crop );
/** Returns whether the crop to contents option is checked in the dialog.
* @see setCropToContents()
* \see setCropToContents()
*/
bool cropToContents() const;

2
src/app/dwg/libdxfrw/drw_interface.h
View File

@ -56,7 +56,7 @@ class DRW_Interface
* Called for every block. Note: all entities added after this
* command go into this block until endBlock() is called.
*
* @see endBlock()
* \see endBlock()
*/
virtual void addBlock( const DRW_Block &data ) = 0;

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

@ -74,19 +74,19 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
bool onlySelected() const;
/** Returns the selected flat geometry type for the export.
* @see automaticGeometryType()
* @see forceMulti()
* @see includeZ()
* \see automaticGeometryType()
* \see forceMulti()
* \see includeZ()
*/
QgsWkbTypes::Type geometryType() const;
/** Returns true if geometry type is set to automatic.
* @see geometryType()
* \see geometryType()
*/
bool automaticGeometryType() const;
/** Returns true if force multi geometry type is checked.
* @see includeZ()
* \see includeZ()
*/
bool forceMulti() const;
@ -95,7 +95,7 @@ class APP_EXPORT QgsVectorLayerSaveAsDialog : public QDialog, private Ui::QgsVec
void setForceMulti( bool checked );
/** Returns true if include z dimension is checked.
* @see forceMulti()
* \see forceMulti()
*/
bool includeZ() const;

2
src/app/qgisapp.h
View File

@ -364,7 +364,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QMenu *createPopupMenu() override;
/**
* Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools}
* Access the vector layer tools. This will be an instance of {\see QgsGuiVectorLayerTools}
* by default.
* \returns The vector layer tools
*/

4
src/app/qgisappinterface.h
View File

@ -296,12 +296,12 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
* \since QGIS 3.0
* \note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* @see unregisterCustomDropHandler() */
* \see unregisterCustomDropHandler() */
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;
/** Unregister a previously registered custom drop handler.
* \since QGIS 3.0
* @see registerCustomDropHandler() */
* \see registerCustomDropHandler() */
virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override;
/** Accessors for inserting items into menus and toolbars.

4
src/app/qgsdecorationitem.h
View File

@ -49,12 +49,12 @@ class APP_EXPORT QgsDecorationItem: public QObject
bool enabled() const { return mEnabled; }
/** Returns the current placement for the item.
* @see setPlacement()
* \see setPlacement()
*/
Placement placement() const { return mPlacement; }
/** Sets the placement of the item.
* @see placement()
* \see placement()
*/
void setPlacement( Placement placement ) { mPlacement = placement; }

32
src/app/qgsmapcanvasdockwidget.h
View File

@ -56,77 +56,77 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM
/**
* Sets whether the view center should be synchronized with the main canvas center.
* @see isViewCenterSynchronized()
* \see isViewCenterSynchronized()
*/
void setViewCenterSynchronized( bool enabled );
/**
* Returns true if the view extent is synchronized with the main canvas extent.
* @see setViewCenterSynchronized()
* \see setViewCenterSynchronized()
*/
bool isViewCenterSynchronized() const;
/**
* Sets whether the cursor position marker is visible.
* @see isCursorMarkerVisible()
* \see isCursorMarkerVisible()
*/
void setCursorMarkerVisible( bool visible );
/**
* Returns true if the cursor position marker is visible.
* @see setCursorMarkerVisible()
* \see setCursorMarkerVisible()
*/
bool isCursorMarkerVisible() const;
/**
* Sets whether the main canvas extent is visible.
* @see isMainCanvasExtentVisible()
* \see isMainCanvasExtentVisible()
*/
void setMainCanvasExtentVisible( bool visible );
/**
* Returns true if the main canvas extent is visible.
* @see setMainCanvasExtentVisible()
* \see setMainCanvasExtentVisible()
*/
bool isMainCanvasExtentVisible() const;
/**
* Returns the scaling factor for main canvas scale to view scale.
* @see setScaleFactor()
* @see isViewScaleSynchronized()
* \see setScaleFactor()
* \see isViewScaleSynchronized()
*/
double scaleFactor() const;
/**
* Sets the scaling \a factor for main canvas scale to view scale.
* @see scaleFactor()
* @see setViewScaleSynchronized()
* \see scaleFactor()
* \see setViewScaleSynchronized()
*/
void setScaleFactor( double factor );
/**
* Sets whether the view scale should be synchronized with the main canvas center.
* @see isViewScaleSynchronized()
* @see setScaleFactor()
* \see isViewScaleSynchronized()
* \see setScaleFactor()
*/
void setViewScaleSynchronized( bool enabled );
/**
* Returns true if the view scale is synchronized with the main canvas extent.
* @see setViewScaleSynchronized()
* @see scaleFactor()
* \see setViewScaleSynchronized()
* \see scaleFactor()
*/
bool isViewScaleSynchronized() const;
/**
* Sets whether labels should be rendered in the view.
* @see labelsVisible()
* \see labelsVisible()
*/
void setLabelsVisible( bool enabled );
/**
* Returns whether labels are rendered in the view.
* @see setLabelsVisible()
* \see setLabelsVisible()
*/
bool labelsVisible() const;

4
src/app/qgsmaptoolselectutils.h
View File

@ -73,7 +73,7 @@ namespace QgsMapToolSelectUtils
\param e MouseEvents are used to determine the current selection
operations (add, subtract, contains)
\since QGIS 2.16
@see selectSingleFeature()
\see selectSingleFeature()
*/
void selectMultipleFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e );
@ -85,7 +85,7 @@ namespace QgsMapToolSelectUtils
must be in terms of the canvas coordinate system.
\param e MouseEvents are used to determine the current selection
operations (add, subtract, contains)
@see selectMultipleFeatures()
\see selectMultipleFeatures()
*/
void selectSingleFeature( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e );

16
src/app/qgspointmarkeritem.h
View File

@ -47,26 +47,26 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem
/** Sets the marker symbol to use for rendering the point. Note - you may need to call
* updateSize() after setting the symbol.
* \param symbol marker symbol. Ownership is transferred to item.
* @see symbol()
* @see updateSize()
* \see symbol()
* \see updateSize()
*/
void setSymbol( QgsMarkerSymbol *symbol );
/** Returns the marker symbol used for rendering the point.
* @see setSymbol()
* \see setSymbol()
*/
QgsMarkerSymbol *symbol();
/** Sets the feature used for rendering the marker symbol. The feature's attributes
* may affect the rendered symbol if data defined overrides are in place.
* \param feature feature for symbol
* @see feature()
* @see updateSize()
* \see feature()
* \see updateSize()
*/
void setFeature( const QgsFeature &feature );
/** Returns the feature used for rendering the marker symbol.
* @see setFeature()
* \see setFeature()
*/
QgsFeature feature() const { return mFeature; }
@ -78,14 +78,14 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem
/** Sets the transparency for the marker.
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency()
* \see transparency()
*/
void setTransparency( double transparency );
/** Returns the transparency for the marker.
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency()
* \see setTransparency()
*/
double transparency() const;

2
src/app/qgstip.h
View File

@ -25,7 +25,7 @@
* Tips can be generic, in which case they make no mention of
* gui dialogs etc, or gui-specific in which case they may allude
* to features of the graphical user interface.
* @see also QgsTipOfTheDay, QgsTipFactory
* \see also QgsTipOfTheDay, QgsTipFactory
*/
class APP_EXPORT QgsTip

2
src/app/qgstipfactory.h
View File

@ -25,7 +25,7 @@
* Tips can be generic, in which case they make no mention of
* gui dialogs etc, or gui-specific in which case they may allude
* to features of the graphical user interface.
* @see also QgsTipOfTheDay, QgsTip
* \see also QgsTipOfTheDay, QgsTip
*/
class APP_EXPORT QgsTipFactory : public QObject

72
src/core/annotations/qgsannotation.h
View File

@ -59,13 +59,13 @@ class CORE_EXPORT QgsAnnotation : public QObject
/**
* Returns true if the annotation is visible and should be rendered.
* @see setVisible()
* \see setVisible()
*/
bool isVisible() const { return mVisible; }
/**
* Sets whether the annotation is visible and should be rendered.
* @see isVisible()
* \see isVisible()
*/
void setVisible( bool visible );
@ -73,45 +73,45 @@ class CORE_EXPORT QgsAnnotation : public QObject
* Returns true if the annotation is attached to a fixed map position, or
* false if the annotation uses a position relative to the current map
* extent.
* @see setHasFixedMapPosition()
* @see mapPosition()
* @see relativePosition()
* \see setHasFixedMapPosition()
* \see mapPosition()
* \see relativePosition()
*/
bool hasFixedMapPosition() const { return mHasFixedMapPosition; }
/**
* Sets whether the annotation is attached to a fixed map position, or
* uses a position relative to the current map extent.
* @see hasFixedMapPosition()
* \see hasFixedMapPosition()
*/
void setHasFixedMapPosition( bool fixed );
/**
* Returns the map position of the annotation, if it is attached to a fixed map
* position.
* @see setMapPosition()
* @see hasFixedMapPosition()
* @see mapPositionCrs()
* \see setMapPosition()
* \see hasFixedMapPosition()
* \see mapPositionCrs()
*/
QgsPoint mapPosition() const { return mMapPosition; }
/**
* Sets the map position of the annotation, if it is attached to a fixed map
* position.
* @see mapPosition()
* \see mapPosition()
*/
void setMapPosition( const QgsPoint &position );
/**
* Returns the CRS of the map position, or an invalid CRS if the annotation does
* not have a fixed map position.
* @see setMapPositionCrs()
* \see setMapPositionCrs()
*/
QgsCoordinateReferenceSystem mapPositionCrs() const { return mMapPositionCrs; }
/**
* Sets the CRS of the map position.
* @see mapPositionCrs()
* \see mapPositionCrs()
*/
void setMapPositionCrs( const QgsCoordinateReferenceSystem &crs );
@ -119,7 +119,7 @@ class CORE_EXPORT QgsAnnotation : public QObject
* Returns the relative position of the annotation, if it is not attached to a fixed map
* position. The coordinates in the return point should be between 0 and 1, and represent
* the relative percentage for the position compared to the map width and height.
* @see setRelativePosition()
* \see setRelativePosition()
*/
QPointF relativePosition() const { return mRelativePosition; }
@ -127,60 +127,60 @@ class CORE_EXPORT QgsAnnotation : public QObject
* Sets the relative position of the annotation, if it is not attached to a fixed map
* position. The coordinates in the return point should be between 0 and 1, and represent
* the relative percentage for the position compared to the map width and height.
* @see relativePosition()
* \see relativePosition()
*/
void setRelativePosition( QPointF position );
/**
* Sets the annotation's frame's offset from the mapPosition() reference point.
* @see frameOffsetFromReferencePoint()
* \see frameOffsetFromReferencePoint()
*/
void setFrameOffsetFromReferencePoint( QPointF offset );
/**
* Returns the annotation's frame's offset from the mapPosition() reference point.
* @see setFrameOffsetFromReferencePoint()
* \see setFrameOffsetFromReferencePoint()
*/
QPointF frameOffsetFromReferencePoint() const { return mOffsetFromReferencePoint; }
/**
* Sets the size of the annotation's frame (the main area in which
* the annotation's content is drawn).
* @see frameSize()
* \see frameSize()
*/
void setFrameSize( QSizeF size );
/**
* Returns the size of the annotation's frame (the main area in which
* the annotation's content is drawn).
* @see setFrameSize()
* \see setFrameSize()
*/
QSizeF frameSize() const { return mFrameSize; }
/**
* Sets the margins (in millimeters) between the outside of the frame and the annotation
* content.
* @see contentsMargin()
* \see contentsMargin()
*/
void setContentsMargin( const QgsMargins &margins );
/**
* Returns the margins (in millimeters) between the outside of the frame and the annotation
* content.
* @see setContentsMargin()
* \see setContentsMargin()
*/
QgsMargins contentsMargin() const { return mContentsMargins; }
/**
* Sets the fill symbol used for rendering the annotation frame. Ownership
* of the symbol is transferred to the annotation.
* @see fillSymbol()
* \see fillSymbol()
*/
void setFillSymbol( QgsFillSymbol *symbol );
/**
* Returns the symbol that is used for rendering the annotation frame.
* @see setFillSymbol()
* \see setFillSymbol()
*/
QgsFillSymbol *fillSymbol() const { return mFillSymbol.get(); }
@ -192,29 +192,29 @@ class CORE_EXPORT QgsAnnotation : public QObject
/**
* Writes the annotation state to a DOM element. Derived classes should
* call _writeXml() within their implementation of this method.
* @see readXml()
* @see _writeXml()
* \see readXml()
* \see _writeXml()
*/
virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const = 0;
/**
* Restores the annotation's state from a DOM element. Derived classes should
* call _readXml() within their implementation of this method.
* @see writeXml()
* @see _readXml()
* \see writeXml()
* \see _readXml()
*/
virtual void readXml( const QDomElement &itemElem, const QDomDocument &doc ) = 0;
/**
* Sets the symbol that is drawn at the annotation's map position. Ownership
* of the symbol is transferred to the annotation.
* @see markerSymbol()
* \see markerSymbol()
*/
void setMarkerSymbol( QgsMarkerSymbol *symbol );
/**
* Returns the symbol that is drawn at the annotation's map position.
* @see setMarkerSymbol()
* \see setMarkerSymbol()
*/
QgsMarkerSymbol *markerSymbol() const { return mMarkerSymbol.get(); }
@ -222,7 +222,7 @@ class CORE_EXPORT QgsAnnotation : public QObject
* Returns the map layer associated with the annotation. Annotations can be
* associated with a map layer if their visibility should be synchronized
* with the layer's visibility.
* @see setMapLayer()
* \see setMapLayer()
*/
QgsMapLayer *mapLayer() const { return mMapLayer.data(); }
@ -230,20 +230,20 @@ class CORE_EXPORT QgsAnnotation : public QObject
* Sets the map layer associated with the annotation. Annotations can be
* associated with a map layer if their visibility should be synchronized
* with the layer's visibility.
* @see mapLayer()
* \see mapLayer()
*/
void setMapLayer( QgsMapLayer *layer );
/**
* Returns the feature associated with the annotation, or an invalid
* feature if none has been set.
* @see setAssociatedFeature()
* \see setAssociatedFeature()
*/
QgsFeature associatedFeature() const { return mFeature; }
/**
* Sets the feature associated with the annotation.
* @see associatedFeature()
* \see associatedFeature()
*/
virtual void setAssociatedFeature( const QgsFeature &feature ) { mFeature = feature; }
@ -280,16 +280,16 @@ class CORE_EXPORT QgsAnnotation : public QObject
/**
* Writes common annotation properties to a DOM element.
* This method should be called from subclasses in their writeXml method.
* @see writeXml()
* @see _readXml()
* \see writeXml()
* \see _readXml()
*/
void _writeXml( QDomElement &itemElem, QDomDocument &doc ) const;
/**
* Reads common annotation properties from a DOM element.
* This method should be called from subclasses in their readXml method.
* @see readXml()
* @see _writeXml()
* \see readXml()
* \see _writeXml()
*/
void _readXml( const QDomElement &annotationElem, const QDomDocument &doc );

18
src/core/annotations/qgsannotationmanager.h
View File

@ -55,8 +55,8 @@ class CORE_EXPORT QgsAnnotationManager : public QObject
/**
* Adds an annotation to the manager. Ownership of the annotation is transferred to the manager.
* Returns true if the addition was successful, or false if the annotation could not be added.
* @see removeAnnotation()
* @see annotationAdded()
* \see removeAnnotation()
* \see annotationAdded()
*/
bool addAnnotation( QgsAnnotation *annotation SIP_TRANSFER );
@ -64,16 +64,16 @@ class CORE_EXPORT QgsAnnotationManager : public QObject
* Removes an annotation from the manager. The annotation is deleted.
* Returns true if the removal was successful, or false if the removal failed (eg as a result
* of removing an annotation which is not contained in the manager).
* @see addAnnotation()
* @see compositionRemoved()
* @see compositionAboutToBeRemoved()
* @see clear()
* \see addAnnotation()
* \see compositionRemoved()
* \see compositionAboutToBeRemoved()
* \see clear()
*/
bool removeAnnotation( QgsAnnotation *annotation );
/**
* Removes and deletes all annotations from the manager.
* @see removeAnnotation()
* \see removeAnnotation()
*/
void clear();
@ -85,13 +85,13 @@ class CORE_EXPORT QgsAnnotationManager : public QObject
/**
* Reads the manager's state from a DOM element, restoring all annotations
* present in the XML document.
* @see writeXml()
* \see writeXml()
*/
bool readXml( const QDomElement &element, const QDomDocument &doc );
/**
* Returns a DOM element representing the state of the manager.
* @see readXml()
* \see readXml()
*/
QDomElement writeXml( QDomDocument &doc ) const;

4
src/core/annotations/qgshtmlannotation.h
View File

@ -48,13 +48,13 @@ class CORE_EXPORT QgsHtmlAnnotation: public QgsAnnotation
/**
* Sets the file path for the source HTML file.
* @see sourceFile()
* \see sourceFile()
*/
void setSourceFile( const QString &htmlFile );
/**
* Returns the file path for the source HTML file.
* @see setSourceFile()
* \see setSourceFile()
*/
QString sourceFile() const { return mHtmlFile; }

4
src/core/annotations/qgssvgannotation.h
View File

@ -44,13 +44,13 @@ class CORE_EXPORT QgsSvgAnnotation: public QgsAnnotation
/**
* Sets the file path for the source SVG file.
* @see filePath()
* \see filePath()
*/
void setFilePath( const QString &file );
/**
* Returns the file path for the source SVG file.
* @see setFilePath()
* \see setFilePath()
*/
QString filePath() const { return mFilePath; }

4
src/core/annotations/qgstextannotation.h
View File

@ -42,14 +42,14 @@ class CORE_EXPORT QgsTextAnnotation: public QgsAnnotation
/**
* Returns the text document which will be rendered
* within the annotation.
* @see setDocument()
* \see setDocument()
*/
const QTextDocument *document() const;
/**
* Sets the text document which will be rendered
* within the annotation. Ownership is not transferred.
* @see document()
* \see document()
*/
void setDocument( const QTextDocument *doc );

4
src/core/auth/qgsauthmanager.h
View File

@ -92,7 +92,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
const QString disabledMessage() const;
/** The standard authentication database file in ~/.qgis3/ or defined location
* @see QgsApplication::qgisAuthDatabaseFilePath
* \see QgsApplication::qgisAuthDatabaseFilePath
*/
const QString authenticationDatabasePath() const { return mAuthDbPath; }
@ -500,7 +500,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
/**
* Custom logging signal to relay to console output and QgsMessageLog
* @see QgsMessageLog
* \see QgsMessageLog
* \param message Message to send
* \param tag Associated tag (title)
* \param level Message log level

50
src/core/composer/qgsatlascomposition.h
View File

@ -49,33 +49,33 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Returns whether the atlas generation is enabled
* \returns true if atlas is enabled
* @see setEnabled
* \see setEnabled
*/
bool enabled() const { return mEnabled; }
/** Sets whether the atlas is enabled
* \param enabled set to true to enable to atlas
* @see enabled
* \see enabled
*/
void setEnabled( bool enabled );
/** Returns true if the atlas is set to hide the coverage layer
* \returns true if coverage layer is hidden
* @see setHideCoverage
* \see setHideCoverage
*/
bool hideCoverage() const { return mHideCoverage; }
/** Sets whether the coverage layer should be hidden in map items in the composition
* \param hide set to true to hide the coverage layer
* @see hideCoverage
* \see hideCoverage
*/
void setHideCoverage( bool hide );
/** Returns the filename expression used for generating output filenames for each
* atlas page.
* \returns filename pattern
* @see setFilenamePattern
* @see filenamePatternErrorString
* \see setFilenamePattern
* \see filenamePatternErrorString
* \note This property has no effect when exporting to PDF if singleFile() is true
*/
QString filenamePattern() const { return mFilenamePattern; }
@ -84,42 +84,42 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
* atlas page.
* \returns true if filename expression could be successful set, false if expression is invalid
* \param pattern expression to use for output filenames
* @see filenamePattern
* @see filenamePatternErrorString
* \see filenamePattern
* \see filenamePatternErrorString
* \note This method has no effect when exporting to PDF if singleFile() is true
*/
bool setFilenamePattern( const QString &pattern );
/** Returns an error string from parsing the filename expression.
* \returns filename pattern parser error
* @see setFilenamePattern
* @see filenamePattern
* \see setFilenamePattern
* \see filenamePattern
*/
QString filenamePatternErrorString() const { return mFilenameParserError; }
/** Returns the coverage layer used for the atlas features
* \returns atlas coverage layer
* @see setCoverageLayer
* \see setCoverageLayer
*/
QgsVectorLayer *coverageLayer() const { return mCoverageLayer; }
/** Sets the coverage layer to use for the atlas features
* \param layer vector coverage layer
* @see coverageLayer
* \see coverageLayer
*/
void setCoverageLayer( QgsVectorLayer *layer );
/** Returns the expression used for calculating the page name.
* \returns expression string, or field name from coverage layer
* @see setPageNameExpression
* @see nameForPage
* \see setPageNameExpression
* \see nameForPage
* \since QGIS 2.12
*/
QString pageNameExpression() const { return mPageNameExpression; }
/** Sets the expression used for calculating the page name.
* \param pageNameExpression expression string, or field name from coverage layer
* @see pageNameExpression
* \see pageNameExpression
* \since QGIS 2.12
*/
void setPageNameExpression( const QString &pageNameExpression ) { mPageNameExpression = pageNameExpression; }
@ -127,7 +127,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Returns the calculated name for a specified atlas page number.
* \param pageNumber number of page, where 0 = first page
* \returns page name
* @see pageNameExpression
* \see pageNameExpression
* \since QGIS 2.12
*/
QString nameForPage( int pageNumber ) const;
@ -135,7 +135,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Returns whether the atlas will be exported to a single file. This is only
* applicable for PDF exports.
* \returns true if atlas will be exported to a single file
* @see setSingleFile
* \see setSingleFile
* \note This property is only used for PDF exports.
*/
bool singleFile() const { return mSingleFile; }
@ -143,7 +143,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Sets whether the atlas should be exported to a single file. This is only
* applicable for PDF exports.
* \param single set to true to export atlas to a single file.
* @see singleFile
* \see singleFile
* \note This method is only used for PDF exports.
*/
void setSingleFile( bool single ) { mSingleFile = single; }
@ -162,8 +162,8 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Returns an error string from parsing the feature filter expression.
* \returns filename pattern parser error
* @see setFilenamePattern
* @see filenamePattern
* \see setFilenamePattern
* \see filenamePattern
*/
QString featureFilterErrorString() const { return mFilterParserError; }
@ -173,16 +173,16 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Returns the current list of predefined scales for the atlas. This is used
* for maps which are set to the predefined atlas scaling mode.
* \returns a vector of doubles representing predefined scales
* @see setPredefinedScales
* @see QgsComposerMap::atlasScalingMode
* \see setPredefinedScales
* \see QgsComposerMap::atlasScalingMode
*/
QVector<qreal> predefinedScales() const { return mPredefinedScales; }
/** Sets the list of predefined scales for the atlas. This is used
* for maps which are set to the predefined atlas scaling mode.
* \param scales a vector of doubles representing predefined scales
* @see predefinedScales
* @see QgsComposerMap::atlasScalingMode
* \see predefinedScales
* \see QgsComposerMap::atlasScalingMode
*/
void setPredefinedScales( const QVector<qreal> &scales );
@ -215,7 +215,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
/** Reads general atlas settings from xml
* \param elem a QDomElement holding the atlas properties.
* \param doc QDomDocument for the source xml.
* @see readXMLMapSettings
* \see readXMLMapSettings
* \note This method should be called before restoring composer item properties
*/
void readXml( const QDomElement &elem, const QDomDocument &doc );

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

@ -67,115 +67,115 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
/** Sets the width of the arrow head in mm
* \param width width of arrow head
* @see arrowHeadWidth
* \see arrowHeadWidth
*/
void setArrowHeadWidth( double width );
/** Returns the width of the arrow head in mm
* \returns width of arrow head
* @see setArrowHeadWidth
* \see setArrowHeadWidth
*/
double arrowHeadWidth() const { return mArrowHeadWidth; }
/** Sets the marker to draw at the start of the line
* \param svgPath file path for svg marker graphic to draw
* @see startMarker
* @see setEndMarker
* \see startMarker
* \see setEndMarker
*/
void setStartMarker( const QString &svgPath );
/** Returns the marker drawn at the start of the line
* \returns file path for svg marker graphic
* @see setStartMarker
* @see endMarker
* \see setStartMarker
* \see endMarker
*/
QString startMarker() const { return mStartMarkerFile; }
/** Sets the marker to draw at the end of the line
* \param svgPath file path for svg marker graphic to draw
* @see endMarker
* @see setStartMarker
* \see endMarker
* \see setStartMarker
*/
void setEndMarker( const QString &svgPath );
/** Returns the marker drawn at the end of the line
* \returns file path for svg marker graphic
* @see setEndMarker
* @see startMarker
* \see setEndMarker
* \see startMarker
*/
QString endMarker() const { return mEndMarkerFile; }
/** Returns the color used to draw stroke around the the arrow head.
* \returns arrow head stroke color
* @see arrowHeadFillColor
* @see setArrowHeadStrokeColor
* \see arrowHeadFillColor
* \see setArrowHeadStrokeColor
* \since QGIS 2.5
*/
QColor arrowHeadStrokeColor() const { return mArrowHeadStrokeColor; }
/** Sets the color used to draw the stroke around the arrow head.
* \param color arrow head stroke color
* @see setArrowHeadFillColor
* @see arrowHeadStrokeColor
* \see setArrowHeadFillColor
* \see arrowHeadStrokeColor
* \since QGIS 2.5
*/
void setArrowHeadStrokeColor( const QColor &color );
/** Returns the color used to fill the arrow head.
* \returns arrow head fill color
* @see arrowHeadStrokeColor
* @see setArrowHeadFillColor
* \see arrowHeadStrokeColor
* \see setArrowHeadFillColor
* \since QGIS 2.5
*/
QColor arrowHeadFillColor() const { return mArrowHeadFillColor; }
/** Sets the color used to fill the arrow head.
* \param color arrow head fill color
* @see arrowHeadFillColor
* @see setArrowHeadStrokeColor
* \see arrowHeadFillColor
* \see setArrowHeadStrokeColor
* \since QGIS 2.5
*/
void setArrowHeadFillColor( const QColor &color );
/** Sets the pen width for the stroke of the arrow head
* \param width pen width for arrow head stroke
* @see arrowHeadStrokeWidth
* @see setArrowHeadStrokeColor
* \see arrowHeadStrokeWidth
* \see setArrowHeadStrokeColor
* \since QGIS 2.5
*/
void setArrowHeadStrokeWidth( const double width );
/** Returns the pen width for the stroke of the arrow head
* \returns pen width for arrow head stroke
* @see setArrowHeadStrokeWidth
* @see arrowHeadStrokeColor
* \see setArrowHeadStrokeWidth
* \see arrowHeadStrokeColor
* \since QGIS 2.5
*/
double arrowHeadStrokeWidth() const { return mArrowHeadStrokeWidth; }
/** Sets the line symbol used for drawing the line portion of the arrow
* \param symbol line symbol
* @see lineSymbol
* \see lineSymbol
* \since QGIS 2.5
*/
void setLineSymbol( QgsLineSymbol *symbol );
/** Returns the line symbol used for drawing the line portion of the arrow
* \returns line symbol
* @see setLineSymbol
* \see setLineSymbol
* \since QGIS 2.5
*/
QgsLineSymbol *lineSymbol() { return mLineSymbol; }
/** Returns marker mode, which controls how the arrow endpoints are drawn
* \returns marker mode
* @see setMarkerMode
* \see setMarkerMode
*/
MarkerMode markerMode() const { return mMarkerMode; }
/** Sets the marker mode, which controls how the arrow endpoints are drawn
* \param mode marker mode
* @see setMarkerMode
* \see setMarkerMode
*/
void setMarkerMode( MarkerMode mode );

22
src/core/composer/qgscomposerattributetablemodelv2.h
View File

@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* \returns QgsComposerTableColumn for specified index
* \param index a QModelIndex
* \since QGIS 2.3
* @see indexFromColumn
* \see indexFromColumn
*/
QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const;
@ -89,7 +89,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* \returns QModelIndex for specified QgsComposerTableColumn
* \param column a QgsComposerTableColumn
* \since QGIS 2.3
* @see columnFromIndex
* \see columnFromIndex
*/
QModelIndex indexFromColumn( QgsComposerTableColumn *column );
@ -98,8 +98,8 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* \param column a QgsComposerTableColumn
* \param order sort order for column
* \since QGIS 2.3
* @see removeColumnFromSort
* @see moveColumnInSortRank
* \see removeColumnFromSort
* \see moveColumnInSortRank
*/
void setColumnAsSorted( QgsComposerTableColumn *column, Qt::SortOrder order );
@ -107,7 +107,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* removed from the sort rank list.
* \param column a QgsComposerTableColumn
* \since QGIS 2.3
* @see setColumnAsSorted
* \see setColumnAsSorted
*/
void setColumnAsUnsorted( QgsComposerTableColumn *column );
@ -115,7 +115,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* \param column a QgsComposerTableColumn
* \param direction direction to move the column in the sort rank list
* \since QGIS 2.3
* @see setColumnAsSorted
* \see setColumnAsSorted
*/
bool moveColumnInSortRank( QgsComposerTableColumn *column, ShiftDirection direction );
@ -162,7 +162,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
* \returns QgsComposerTableColumn for specified row
* \param row a row number
* \since QGIS 2.3
* @see columnFromIndex
* \see columnFromIndex
*/
QgsComposerTableColumn *columnFromRow( int row );
@ -170,8 +170,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
* \returns QgsComposerTableColumn for specified index
* \param index a QModelIndex
* \since QGIS 2.3
* @see columnFromRow
* @see columnFromSourceIndex
* \see columnFromRow
* \see columnFromSourceIndex
*/
QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const;
@ -180,8 +180,8 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
* \returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
* \param sourceIndex a QModelIndex
* \since QGIS 2.3
* @see columnFromRow
* @see columnFromIndex
* \see columnFromRow
* \see columnFromIndex
*/
QgsComposerTableColumn *columnFromSourceIndex( const QModelIndex &sourceIndex ) const;

70
src/core/composer/qgscomposerattributetablev2.h
View File

@ -75,7 +75,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* \param elem an existing QDomElement in which to store the attribute table's properties.
* \param doc QDomDocument for the destination xml.
* \param ignoreFrames ignore frames
* @see readXml
* \see readXml
*/
virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const override;
@ -83,7 +83,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* \param itemElem a QDomElement holding the attribute table's desired properties.
* \param doc QDomDocument for the source xml.
* \param ignoreFrames ignore frames
* @see writeXml
* \see writeXml
*/
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ) override;
@ -91,13 +91,13 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/** Sets the source for attributes to show in table body.
* \param source content source
* @see source
* \see source
*/
void setSource( const ContentSource source );
/** Returns the source for attributes shown in the table body.
* \returns content source
* @see setSource
* \see setSource
*/
ContentSource source() const { return mSource; }
@ -111,34 +111,34 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/** Sets the vector layer from which to display feature attributes
* \param layer Vector layer for attribute table
* @see vectorLayer
* \see vectorLayer
*/
void setVectorLayer( QgsVectorLayer *layer );
/** Returns the vector layer the attribute table is currently using
* \returns attribute table's current vector layer
* @see setVectorLayer
* \see setVectorLayer
*/
QgsVectorLayer *vectorLayer() const { return mVectorLayer; }
/** Sets the relation id from which to display child features
* \param relationId id for relation to display child features from
* @see relationId
* @see setSource
* \see relationId
* \see setSource
* \note only used if table source is set to RelationChildren
*/
void setRelationId( const QString &relationId );
/** Returns the relation id which the table displays child features from
* \returns relation id
* @see setRelationId
* @see source
* \see setRelationId
* \see source
* \note only used if table source is set to RelationChildren
*/
QString relationId() const { return mRelationId; }
/** Resets the attribute table's columns to match the vector layer's fields
* @see setVectorLayer
* \see setVectorLayer
*/
void resetColumns();
@ -148,16 +148,16 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* vector layer, and may result in the table changing size to accommodate the new displayed
* feature attributes.
* \param map QgsComposerMap which drives the extents of the table's features
* @see composerMap
* @see setDisplayOnlyVisibleFeatures
* \see composerMap
* \see setDisplayOnlyVisibleFeatures
*/
void setComposerMap( const QgsComposerMap *map );
/** Returns the composer map whose extents are controlling the features shown in the
* table. The extents of the map are only used if displayOnlyVisibleFeatures() is true.
* \returns composer map controlling the attribute table
* @see setComposerMap
* @see displayOnlyVisibleFeatures
* \see setComposerMap
* \see displayOnlyVisibleFeatures
*/
const QgsComposerMap *composerMap() const { return mComposerMap; }
@ -165,27 +165,27 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* in the attribute table changing its size to accommodate the new number of rows, and requires
* the table to refetch features from its vector layer.
* \param features maximum number of features to show in the table
* @see maximumNumberOfFeatures
* \see maximumNumberOfFeatures
*/
void setMaximumNumberOfFeatures( const int features );
/** Returns the maximum number of features to be shown by the table.
* \returns maximum number of features
* @see setMaximumNumberOfFeatures
* \see setMaximumNumberOfFeatures
*/
int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; }
/** Sets attribute table to only show unique rows.
* \param uniqueOnly set to true to show only unique rows. Duplicate rows
* will be stripped from the table.
* @see uniqueRowsOnly
* \see uniqueRowsOnly
*/
void setUniqueRowsOnly( const bool uniqueOnly );
/** Returns true if the table is set to show only unique rows.
* \returns true if table only shows unique rows and is stripping out
* duplicate rows.
* @see setUniqueRowsOnly
* \see setUniqueRowsOnly
*/
bool uniqueRowsOnly() const { return mShowUniqueRowsOnly; }
@ -193,16 +193,16 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* this setting forces the table to refetch features from its vector layer, and may result in
* the table changing size to accommodate the new displayed feature attributes.
* \param visibleOnly set to true to show only visible features
* @see displayOnlyVisibleFeatures
* @see setComposerMap
* \see displayOnlyVisibleFeatures
* \see setComposerMap
*/
void setDisplayOnlyVisibleFeatures( const bool visibleOnly );
/** Returns true if the table is set to show only features visible on a corresponding
* composer map item.
* \returns true if table only shows visible features
* @see composerMap
* @see setDisplayOnlyVisibleFeatures
* \see composerMap
* \see setDisplayOnlyVisibleFeatures
*/
bool displayOnlyVisibleFeatures() const { return mShowOnlyVisibleFeatures; }
@ -210,21 +210,21 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* feature.
* \param filterToAtlas set to true to show only features which intersect
* the atlas feature
* @see filterToAtlasFeature
* \see filterToAtlasFeature
*/
void setFilterToAtlasFeature( const bool filterToAtlas );
/** Returns true if the table is set to only show features which intersect the current atlas
* feature.
* \returns true if table only shows features which intersect the atlas feature
* @see setFilterToAtlasFeature
* \see setFilterToAtlasFeature
*/
bool filterToAtlasFeature() const { return mFilterToAtlasIntersection; }
/** Returns true if a feature filter is active on the attribute table
* \returns bool state of the feature filter
* @see setFilterFeatures
* @see featureFilter
* \see setFilterFeatures
* \see featureFilter
*/
bool filterFeatures() const { return mFilterFeatures; }
@ -232,16 +232,16 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* this setting forces the table to refetch features from its vector layer, and may result in
* the table changing size to accommodate the new displayed feature attributes.
* \param filter Set to true to enable the feature filter
* @see filterFeatures
* @see setFeatureFilter
* \see filterFeatures
* \see setFeatureFilter
*/
void setFilterFeatures( const bool filter );
/** Returns the current expression used to filter features for the table. The filter is only
* active if filterFeatures() is true.
* \returns feature filter expression
* @see setFeatureFilter
* @see filterFeatures
* \see setFeatureFilter
* \see filterFeatures
*/
QString featureFilter() const { return mFeatureFilter; }
@ -250,8 +250,8 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* to refetch features from its vector layer, and may result in
* the table changing size to accommodate the new displayed feature attributes.
* \param expression filter to use for selecting which features to display in the table
* @see featureFilter
* @see setFilterFeatures
* \see featureFilter
* \see setFilterFeatures
*/
void setFeatureFilter( const QString &expression );
@ -277,7 +277,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* be replaced by a line break.
* \param wrapString string to replace with line break
* \since QGIS 2.12
* @see wrapString
* \see wrapString
*/
void setWrapString( const QString &wrapString );
@ -285,7 +285,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* be replaced by a line break.
* \returns string which will be replaced with line break
* \since QGIS 2.12
* @see setWrapString
* \see setWrapString
*/
QString wrapString() const { return mWrapString; }

14
src/core/composer/qgscomposerframe.h
View File

@ -35,7 +35,7 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
/** Sets the visible part of the multiframe's content which is visible within
* this frame (relative to the total multiframe extent in mm).
* \param section visible portion of content
* @see extent
* \see extent
*/
void setContentSection( const QRectF &section ) { mSection = section; }
@ -61,42 +61,42 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
* is shown in this frame.
* \returns extent of visible portion
* \since QGIS 2.5
* @see setContentSection
* \see setContentSection
*/
QRectF extent() const { return mSection; }
/** Returns whether the page should be hidden (ie, not included in composer exports) if this frame is empty
* \returns true if page should be hidden if frame is empty
* \since QGIS 2.5
* @see setHidePageIfEmpty
* \see setHidePageIfEmpty
*/
bool hidePageIfEmpty() const { return mHidePageIfEmpty; }
/** Sets whether the page should be hidden (ie, not included in composer exports) if this frame is empty
* \param hidePageIfEmpty set to true if page should be hidden if frame is empty
* \since QGIS 2.5
* @see hidePageIfEmpty
* \see hidePageIfEmpty
*/
void setHidePageIfEmpty( const bool hidePageIfEmpty );
/** Returns whether the background and frame stroke should be hidden if this frame is empty
* \returns true if background and stroke should be hidden if frame is empty
* \since QGIS 2.5
* @see setHideBackgroundIfEmpty
* \see setHideBackgroundIfEmpty
*/
bool hideBackgroundIfEmpty() const { return mHideBackgroundIfEmpty; }
/** Sets whether the background and frame stroke should be hidden if this frame is empty
* \param hideBackgroundIfEmpty set to true if background and stroke should be hidden if frame is empty
* \since QGIS 2.5
* @see hideBackgroundIfEmpty
* \see hideBackgroundIfEmpty
*/
void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty );
/** Returns whether the frame is empty
* \returns true if frame is empty
* \since QGIS 2.5
* @see hidePageIfEmpty
* \see hidePageIfEmpty
*/
bool isEmpty() const;

68
src/core/composer/qgscomposerhtml.h
View File

@ -49,18 +49,18 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
/** Sets the source mode for item's HTML content.
* \param mode ContentMode for the item's source
* @see contentMode
* @see setUrl
* @see setHtml
* \see contentMode
* \see setUrl
* \see setHtml
* \since QGIS 2.5
*/
void setContentMode( ContentMode mode ) { mContentMode = mode; }
/** Returns the source mode for item's HTML content.
* \returns ContentMode for the item's source
* @see setContentMode
* @see url
* @see html
* \see setContentMode
* \see url
* \see html
* \since QGIS 2.5
*/
ContentMode contentMode() const { return mContentMode; }
@ -69,16 +69,16 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* the QgsComposerHtml::Url mode. Content is automatically fetched and the
* HTML item refreshed after calling this function.
* \param url URL of content to display in the item
* @see url
* @see contentMode
* \see url
* \see contentMode
*/
void setUrl( const QUrl &url );
/** Returns the URL of the content displayed in the item if the item is using
* the QgsComposerHtml::Url mode.
* \returns url for content displayed in item
* @see setUrl
* @see contentMode
* \see setUrl
* \see contentMode
*/
QUrl url() const { return mUrl; }
@ -87,9 +87,9 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* does not automatically refresh the item's contents. Call loadHtml to trigger
* a refresh of the item after setting the HTML content.
* \param html HTML to display in item
* @see html
* @see contentMode
* @see loadHtml
* \see html
* \see contentMode
* \see loadHtml
* \since QGIS 2.5
*/
void setHtml( const QString &html );
@ -97,8 +97,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
/** Returns the HTML source displayed in the item if the item is using
* the QgsComposerHtml::ManualHtml mode.
* \returns HTML displayed in item
* @see setHtml
* @see contentMode
* \see setHtml
* \see contentMode
* \since QGIS 2.5
*/
QString html() const { return mHtml; }
@ -108,7 +108,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* treated as a QGIS expression and evaluated against the current atlas
* feature.
* \returns true if html item will evaluate expressions in the content
* @see setEvaluateExpressions
* \see setEvaluateExpressions
* \since QGIS 2.5
*/
bool evaluateExpressions() const { return mEvaluateExpressions; }
@ -118,7 +118,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* treated as a QGIS expression and evaluated against the current atlas
* feature.
* \param evaluateExpressions set to true to evaluate expressions in the HTML content
* @see evaluateExpressions
* \see evaluateExpressions
* \since QGIS 2.5
*/
void setEvaluateExpressions( bool evaluateExpressions );
@ -126,7 +126,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
/** Returns whether html item is using smart breaks. Smart breaks prevent
* the html frame contents from breaking mid-way though a line of text.
* \returns true if html item is using smart breaks
* @see setUseSmartBreaks
* \see setUseSmartBreaks
*/
bool useSmartBreaks() const { return mUseSmartBreaks; }
@ -134,7 +134,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* the html frame contents from breaking mid-way though a line of text.
* \param useSmartBreaks set to true to prevent content from breaking
* mid-way through a line of text
* @see useSmartBreaks
* \see useSmartBreaks
*/
void setUseSmartBreaks( bool useSmartBreaks );
@ -147,8 +147,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* \param maxBreakDistance maximum amount of empty space to leave when calculating
* page break locations
* \since QGIS 2.3
* @see maxBreakDistance
* @see setUseSmartBreaks
* \see maxBreakDistance
* \see setUseSmartBreaks
*/
void setMaxBreakDistance( double maxBreakDistance );
@ -158,8 +158,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* is only effective if useSmartBreaks is true.
* \returns maximum amount of empty space to leave when calculating page break locations
* \since QGIS 2.3
* @see setMaxBreakDistance
* @see useSmartBreaks
* \see setMaxBreakDistance
* \see useSmartBreaks
*/
double maxBreakDistance() const { return mMaxBreakDistance; }
@ -168,9 +168,9 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* using this function does not automatically refresh the item's contents. Call loadHtml
* to trigger a refresh of the item after setting the stylesheet rules.
* \param stylesheet CSS rules for user stylesheet
* @see userStylesheet
* @see setUserStylesheetEnabled
* @see loadHtml
* \see userStylesheet
* \see setUserStylesheetEnabled
* \see loadHtml
* \since QGIS 2.5
*/
void setUserStylesheet( const QString &stylesheet );
@ -178,24 +178,24 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
/** Returns the user stylesheet CSS rules used while rendering the HTML content. These
* overriding the styles specified within the HTML source.
* \returns CSS rules for user stylesheet
* @see setUserStylesheet
* @see userStylesheetEnabled
* \see setUserStylesheet
* \see userStylesheetEnabled
* \since QGIS 2.5
*/
QString userStylesheet() const { return mUserStylesheet; }
/** Sets whether user stylesheets are enabled for the HTML content.
* \param stylesheetEnabled set to true to enable user stylesheets
* @see userStylesheetEnabled
* @see setUserStylesheet
* \see userStylesheetEnabled
* \see setUserStylesheet
* \since QGIS 2.5
*/
void setUserStylesheetEnabled( const bool stylesheetEnabled );
/** Returns whether user stylesheets are enabled for the HTML content.
* \returns true if user stylesheets are enabled
* @see setUserStylesheetEnabled
* @see userStylesheet
* \see setUserStylesheetEnabled
* \see userStylesheet
* \since QGIS 2.5
*/
bool userStylesheetEnabled() const { return mEnableUserStylesheet; }
@ -215,8 +215,8 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* \param useCache set to true to use a cached copy of remote html
* content
* \param context expression context for evaluating data defined urls and expressions in html
* @see setUrl
* @see url
* \see setUrl
* \see url
*/
void loadHtml( const bool useCache = false, const QgsExpressionContext *context = nullptr );

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

@ -128,7 +128,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* command.
* \returns true if the item has been removed from the composition
* \since QGIS 2.5
* @see setIsRemoved
* \see setIsRemoved
*/
virtual bool isRemoved() const { return mRemovedFromComposition; }
@ -137,7 +137,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* command.
* \param removed set to true if the item has been removed from the composition
* \since QGIS 2.5
* @see isRemoved
* \see isRemoved
*/
void setIsRemoved( const bool removed ) { mRemovedFromComposition = removed; }
@ -165,16 +165,16 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
/** Gets the page the item is currently on.
* \returns page number for item, beginning on page 1
* @see pagePos
* @see updatePagePos
* \see pagePos
* \see updatePagePos
* \since QGIS 2.4
*/
int page() const;
/** Returns the item's position relative to its current page.
* \returns position relative to the page's top left corner.
* @see page
* @see updatePagePos
* \see page
* \see updatePagePos
* \since QGIS 2.4
*/
QPointF pagePos() const;
@ -183,8 +183,8 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* when the paper size changes.
* \param newPageWidth new width of the page in mm
* \param newPageHeight new height of the page in mm
* @see page
* @see pagePos
* \see page
* \see pagePos
* \since QGIS 2.4
*/
void updatePagePos( double newPageWidth, double newPageHeight );
@ -226,79 +226,79 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
/** Whether this item has a frame or not.
* \returns true if there is a frame around this item, otherwise false.
* @see setFrameEnabled
* @see frameStrokeWidth
* @see frameJoinStyle
* @see frameStrokeColor
* \see setFrameEnabled
* \see frameStrokeWidth
* \see frameJoinStyle
* \see frameStrokeColor
*/
bool hasFrame() const {return mFrame;}
/** Set whether this item has a frame drawn around it or not.
* \param drawFrame draw frame
* @see hasFrame
* @see setFrameStrokeWidth
* @see setFrameJoinStyle
* @see setFrameStrokeColor
* \see hasFrame
* \see setFrameStrokeWidth
* \see setFrameJoinStyle
* \see setFrameStrokeColor
*/
virtual void setFrameEnabled( const bool drawFrame );
/** Sets frame stroke color
* \param color new color for stroke frame
* \since QGIS 2.6
* @see frameStrokeColor
* @see setFrameEnabled
* @see setFrameJoinStyle
* @see setFrameStrokeWidth
* \see frameStrokeColor
* \see setFrameEnabled
* \see setFrameJoinStyle
* \see setFrameStrokeWidth
*/
virtual void setFrameStrokeColor( const QColor &color );
/** Returns the frame's stroke color. Only used if hasFrame is true.
* \returns frame stroke color
* \since QGIS 2.6
* @see hasFrame
* @see setFrameStrokeColor
* @see frameJoinStyle
* @see setFrameStrokeColor
* \see hasFrame
* \see setFrameStrokeColor
* \see frameJoinStyle
* \see setFrameStrokeColor
*/
QColor frameStrokeColor() const { return mFrameColor; }
/** Sets frame stroke width
* \param strokeWidth new width for stroke frame
* \since QGIS 2.2
* @see frameStrokeWidth
* @see setFrameEnabled
* @see setFrameJoinStyle
* @see setFrameStrokeColor
* \see frameStrokeWidth
* \see setFrameEnabled
* \see setFrameJoinStyle
* \see setFrameStrokeColor
*/
virtual void setFrameStrokeWidth( const double strokeWidth );
/** Returns the frame's stroke width. Only used if hasFrame is true.
* \returns Frame stroke width
* \since QGIS 2.3
* @see hasFrame
* @see setFrameStrokeWidth
* @see frameJoinStyle
* @see frameStrokeColor
* \see hasFrame
* \see setFrameStrokeWidth
* \see frameJoinStyle
* \see frameStrokeColor
*/
double frameStrokeWidth() const { return mFrameWidth; }
/** Returns the join style used for drawing the item's frame
* \returns Join style for stroke frame
* \since QGIS 2.3
* @see hasFrame
* @see setFrameJoinStyle
* @see frameStrokeWidth
* @see frameStrokeColor
* \see hasFrame
* \see setFrameJoinStyle
* \see frameStrokeWidth
* \see frameStrokeColor
*/
Qt::PenJoinStyle frameJoinStyle() const { return mFrameJoinStyle; }
/** Sets join style used when drawing the item's frame
* \param style Join style for stroke frame
* \since QGIS 2.3
* @see setFrameEnabled
* @see frameJoinStyle
* @see setFrameStrokeWidth
* @see setFrameStrokeColor
* \see setFrameEnabled
* \see frameJoinStyle
* \see setFrameStrokeWidth
* \see setFrameStrokeColor
*/
void setFrameJoinStyle( const Qt::PenJoinStyle style );
@ -307,7 +307,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* 1mm of this frame is drawn outside the item's rect. In this case the
* return value will be 1.0
* \since QGIS 2.2
* @see rectWithFrame
* \see rectWithFrame
*/
virtual double estimatedFrameBleed() const;
@ -317,77 +317,77 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* function, as rect() makes no allowances for the portion of outlines which are drawn
* outside of the item.
* \since QGIS 2.2
* @see estimatedFrameBleed
* \see estimatedFrameBleed
*/
virtual QRectF rectWithFrame() const;
/** Whether this item has a Background or not.
* \returns true if there is a Background around this item, otherwise false.
* @see setBackgroundEnabled
* @see backgroundColor
* \see setBackgroundEnabled
* \see backgroundColor
*/
bool hasBackground() const {return mBackground;}
/** Set whether this item has a Background drawn around it or not.
* \param drawBackground draw Background
* \returns nothing
* @see hasBackground
* @see setBackgroundColor
* \see hasBackground
* \see setBackgroundColor
*/
void setBackgroundEnabled( const bool drawBackground ) { mBackground = drawBackground; }
/** Gets the background color for this item
* \returns background color
* @see setBackgroundColor
* @see hasBackground
* \see setBackgroundColor
* \see hasBackground
*/
QColor backgroundColor() const { return mBackgroundColor; }
/** Sets the background color for this item
* \param backgroundColor new background color
* \returns nothing
* @see backgroundColor
* @see setBackgroundEnabled
* \see backgroundColor
* \see setBackgroundEnabled
*/
void setBackgroundColor( const QColor &backgroundColor );
/** Returns the item's composition blending mode.
* \returns item blending mode
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }
/** Sets the item's composition blending mode
* \param blendMode blending mode for item
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode blendMode );
/** Returns the item's transparency
* \returns transparency as integer between 0 (transparent) and 255 (opaque)
* @see setTransparency
* \see setTransparency
*/
int transparency() const { return mTransparency; }
/** Sets the item's transparency
* \param transparency integer between 0 (transparent) and 255 (opaque)
* @see transparency
* \see transparency
*/
void setTransparency( const int transparency );
/** Returns whether effects (e.g., blend modes) are enabled for the item
* \returns true if effects are enabled
* @see setEffectsEnabled
* @see transparency
* @see blendMode
* \see setEffectsEnabled
* \see transparency
* \see blendMode
*/
bool effectsEnabled() const { return mEffectsEnabled; }
/** Sets whether effects (e.g., blend modes) are enabled for the item
* \param effectsEnabled set to true to enable effects
* @see effectsEnabled
* @see setTransparency
* @see setBlendMode
* \see effectsEnabled
* \see setTransparency
* \see setBlendMode
*/
void setEffectsEnabled( const bool effectsEnabled );
@ -412,13 +412,13 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
/** Locks / unlocks the item position for mouse drags
* \param lock set to true to prevent item movement and resizing via the mouse
* @see positionLock
* \see positionLock
*/
void setPositionLock( const bool lock );
/** Returns whether position lock for mouse drags is enabled
* returns true if item is locked for mouse movement and resizing
* @see setPositionLock
* \see setPositionLock
*/
bool positionLock() const { return mItemPositionLocked; }
@ -428,7 +428,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* or the current evaluated rotation (which may be affected by data driven rotation
* settings).
* \since QGIS 2.1
* @see setItemRotation
* \see setItemRotation
*/
double itemRotation( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ) const;
@ -441,29 +441,29 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
/** Get item's id (which is not necessarly unique)
* \returns item id
* @see setId
* \see setId
*/
QString id() const { return mId; }
/** Set item's id (which is not necessarly unique)
* \param id new id for item
* @see id
* \see id
*/
virtual void setId( const QString &id );
/** Get item identification name
* \returns unique item identification string
* \note there is not setter since one can't manually set the id
* @see id
* @see setId
* \see id
* \see setId
*/
QString uuid() const { return mUuid; }
/** Get item display name. This is the item's id if set, and if
* not, a user-friendly string identifying item type.
* \returns display name for item
* @see id
* @see setId
* \see id
* \see setId
* \since QGIS 2.5
*/
virtual QString displayName() const;
@ -482,28 +482,28 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* or the current evaluated value (which may be affected by data driven settings).
* \returns true if item should be excluded
* \since QGIS 2.5
* @see setExcludeFromExports
* \see setExcludeFromExports
*/
bool excludeFromExports( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue );
/** Sets whether the item should be excluded from composer exports and prints
* \param exclude set to true to exclude the item from exports
* \since QGIS 2.5
* @see excludeFromExports
* \see excludeFromExports
*/
virtual void setExcludeFromExports( const bool exclude );
/** Returns whether this item is part of a group
* \returns true if item is in a group
* \since QGIS 2.5
* @see setIsGroupMember
* \see setIsGroupMember
*/
bool isGroupMember() const { return mIsGroupMember; }
/** Sets whether this item is part of a group
* \param isGroupMember set to true if item is in a group
* \since QGIS 2.5
* @see isGroupMember
* \see isGroupMember
*/
void setIsGroupMember( const bool isGroupMember );
@ -511,14 +511,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* \returns 0 if this item is to be placed on the same layer as the previous item,
* 1 if it should be placed on its own layer, and >1 if it requires multiple export layers
* \since QGIS 2.4
* @see setCurrentExportLayer
* \see setCurrentExportLayer
*/
virtual int numberExportLayers() const { return 0; }
/** Sets the current layer to draw for exporting
* \param layerIdx can be set to -1 to draw all item layers, and must be less than numberExportLayers()
* \since QGIS 2.4
* @see numberExportLayers
* \see numberExportLayers
*/
virtual void setCurrentExportLayer( const int layerIdx = -1 ) { mCurrentExportLayer = layerIdx; }
@ -534,7 +534,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* multiple item updates when many settings for an item are
* changed sequentially.
* \since QGIS 3.0
* @see updatesEnabled()
* \see updatesEnabled()
*/
void setUpdatesEnabled( bool enabled ) { mUpdatesEnabled = enabled; }
@ -544,7 +544,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* multiple item updates when many settings for an item are
* changed sequentially.
* \since QGIS 3.0
* @see setUpdatesEnabled()
* \see setUpdatesEnabled()
*/
bool updatesEnabled() const { return mUpdatesEnabled; }
@ -555,7 +555,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* \param adjustPosition set to true if item should be shifted so that rotation occurs
* around item center. If false, rotation occurs around item origin
* \since QGIS 2.1
* @see itemRotation
* \see itemRotation
*/
virtual void setItemRotation( const double r, const bool adjustPosition = false );

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

@ -98,16 +98,16 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
* value. The margins can be individually controlled using the setMarginX
* and setMarginY methods.
* \param m margin in mm
* @see setMarginX
* @see setMarginY
* \see setMarginX
* \see setMarginY
*/
void setMargin( const double m );
/** Sets the horizontal margin between the edge of the frame and the label
* contents.
* \param margin horizontal margin in mm
* @see setMargin
* @see setMarginY
* \see setMargin
* \see setMarginY
* \since QGIS 2.7
*/
void setMarginX( const double margin );
@ -115,8 +115,8 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
/** Sets the vertical margin between the edge of the frame and the label
* contents.
* \param margin vertical margin in mm
* @see setMargin
* @see setMarginX
* \see setMargin
* \see setMarginX
* \since QGIS 2.7
*/
void setMarginY( const double margin );

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

@ -75,13 +75,13 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Sets whether the legend should automatically resize to fit its contents.
* \param enabled set to false to disable automatic resizing. The legend frame will not
* be expanded to fit legend items, and items may be cropped from display.
* @see resizeToContents()
* \see resizeToContents()
* \since QGIS 3.0
*/
void setResizeToContents( bool enabled );
/** Returns whether the legend should automatically resize to fit its contents.
* @see setResizeToContents()
* \see setResizeToContents()
* \since QGIS 3.0
*/
bool resizeToContents() const;
@ -114,7 +114,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
void setLegendFilterOutAtlas( bool doFilter );
//! Whether to filter out legend elements outside of the current atlas feature
//! @see setLegendFilterOutAtlas()
//! \see setLegendFilterOutAtlas()
//! \since QGIS 2.14
bool legendFilterOutAtlas() const;
@ -125,14 +125,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Returns the alignment of the legend title
* \returns Qt::AlignmentFlag for the legend title
* \since QGIS 2.3
* @see setTitleAlignment
* \see setTitleAlignment
*/
Qt::AlignmentFlag titleAlignment() const;
/** Sets the alignment of the legend title
* \param alignment Text alignment for drawing the legend title
* \since QGIS 2.3
* @see titleAlignment
* \see titleAlignment
*/
void setTitleAlignment( Qt::AlignmentFlag alignment );
@ -152,14 +152,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Returns the spacing in-between lines in mm
* \since QGIS 3.0
* @see setLineSpacing
* \see setLineSpacing
*/
double lineSpacing() const;
/** Sets the spacing in-between multiple lines
* \param spacing Double value to use as spacing in between multiple lines
* \since QGIS 3.0
* @see lineSpacing
* \see lineSpacing
*/
void setLineSpacing( double spacing );
@ -197,27 +197,27 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
void setEqualColumnWidth( bool s );
/** Returns whether a stroke will be drawn around raster symbol items.
* @see setDrawRasterStroke()
* @see rasterStrokeColor()
* @see rasterStrokeWidth()
* \see setDrawRasterStroke()
* \see rasterStrokeColor()
* \see rasterStrokeWidth()
* \since QGIS 2.12
*/
bool drawRasterStroke() const;
/** Sets whether a stroke will be drawn around raster symbol items.
* \param enabled set to true to draw borders
* @see drawRasterStroke()
* @see setRasterStrokeColor()
* @see setRasterStrokeWidth()
* \see drawRasterStroke()
* \see setRasterStrokeColor()
* \see setRasterStrokeWidth()
* \since QGIS 2.12
*/
void setDrawRasterStroke( bool enabled );
/** Returns the stroke color for the stroke drawn around raster symbol items. The stroke is
* only drawn if drawRasterStroke() is true.
* @see setRasterStrokeColor()
* @see drawRasterStroke()
* @see rasterStrokeWidth()
* \see setRasterStrokeColor()
* \see drawRasterStroke()
* \see rasterStrokeWidth()
* \since QGIS 2.12
*/
QColor rasterStrokeColor() const;
@ -225,18 +225,18 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Sets the stroke color for the stroke drawn around raster symbol items. The stroke is
* only drawn if drawRasterStroke() is true.
* \param color stroke color
* @see rasterStrokeColor()
* @see setDrawRasterStroke()
* @see setRasterStrokeWidth()
* \see rasterStrokeColor()
* \see setDrawRasterStroke()
* \see setRasterStrokeWidth()
* \since QGIS 2.12
*/
void setRasterStrokeColor( const QColor &color );
/** Returns the stroke width (in millimeters) for the stroke drawn around raster symbol items. The stroke is
* only drawn if drawRasterStroke() is true.
* @see setRasterStrokeWidth()
* @see drawRasterStroke()
* @see rasterStrokeColor()
* \see setRasterStrokeWidth()
* \see drawRasterStroke()
* \see rasterStrokeColor()
* \since QGIS 2.12
*/
double rasterStrokeWidth() const;
@ -244,9 +244,9 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Sets the stroke width for the stroke drawn around raster symbol items. The stroke is
* only drawn if drawRasterStroke() is true.
* \param width stroke width in millimeters
* @see rasterStrokeWidth()
* @see setDrawRasterStroke()
* @see setRasterStrokeColor()
* \see rasterStrokeWidth()
* \see setDrawRasterStroke()
* \see setRasterStrokeColor()
* \since QGIS 2.12
*/
void setRasterStrokeWidth( double width );

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

@ -75,11 +75,11 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
Fixed, //!< The current scale of the map is used for each feature of the atlas
Predefined, /*!< A scale is chosen from the predefined scales. The smallest scale from
the list of scales where the atlas feature is fully visible is chosen.
@see QgsAtlasComposition::setPredefinedScales.
\see QgsAtlasComposition::setPredefinedScales.
\note This mode is only valid for polygon or line atlas coverage layers
*/
Auto /*!< The extent is adjusted so that each feature is fully visible.
A margin is applied around the center @see setAtlasMargin
A margin is applied around the center \see setAtlasMargin
\note This mode is only valid for polygon or line atlas coverage layers*/
};
@ -138,7 +138,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* item to ensure that the extent exactly matches the specified extent, with no
* overlap or margin. This method implicitly alters the map scale.
* \param extent new extent for the map
* @see zoomToExtent
* \see zoomToExtent
*/
void setNewExtent( const QgsRectangle &extent );
@ -147,7 +147,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* an overlap or margin from the specified extent. This method implicitly alters the
* map scale.
* \param extent new extent for the map
* @see setNewExtent
* \see setNewExtent
* \since QGIS 2.5
*/
void zoomToExtent( const QgsRectangle &extent );
@ -161,7 +161,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* extent or the temporary atlas-driven feature extent depending on the current atlas state
* of the composition. Both a const and non-const version are included.
* \returns pointer to current map extent
* @see visibleExtentPolygon
* \see visibleExtentPolygon
*/
const QgsRectangle *currentMapExtent() const;
@ -174,8 +174,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* CRS is not set then the map's CRS will follow the composition's
* project's CRS.
* \since QGIS 3.0
* @see presetCrs()
* @see setCrs()
* \see presetCrs()
* \see setCrs()
*/
QgsCoordinateReferenceSystem crs() const;
@ -185,8 +185,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* setting. If the returned CRS is not valid then the project CRS
* will be used to render the map.
* \since QGIS 3.0
* @see crs()
* @see setCrs()
* \see crs()
* \see setCrs()
*/
QgsCoordinateReferenceSystem presetCrs() const { return mCrs; }
@ -194,8 +194,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* Sets the map's preset coordinate reference system. If a valid CRS is
* set, this CRS will be used to render the map regardless of any project CRS
* setting. If the CRS is not valid then the project CRS will be used to render the map.
* @see crs()
* @see presetCrs()
* \see crs()
* \see presetCrs()
* \since QGIS 3.0
*/
void setCrs( const QgsCoordinateReferenceSystem &crs );
@ -208,8 +208,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* or the current layer set of the QGIS map canvas. This is just a GUI flag,
* and itself does not change which layers are rendered in the map.
* Instead, use setLayers() to control which layers are rendered.
* @see setKeepLayerSet()
* @see layers()
* \see setKeepLayerSet()
* \see layers()
*/
bool keepLayerSet() const {return mKeepLayerSet;}
@ -218,24 +218,24 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* or the current layer set of the QGIS map canvas. This is just a GUI flag,
* and itself does not change which layers are rendered in the map.
* Instead, use setLayers() to control which layers are rendered.
* @see keepLayerSet()
* @see layers()
* \see keepLayerSet()
* \see layers()
*/
void setKeepLayerSet( bool enabled ) {mKeepLayerSet = enabled;}
/**
* Getter for stored layer set. If empty, the current canvas layers will
* be used instead.
* @see setLayers()
* @see keepLayerSet()
* \see setLayers()
* \see keepLayerSet()
*/
QList<QgsMapLayer *> layers() const;
/**
* Setter for stored layer set. If empty, the current canvas layers will
* be used instead.
* @see layers()
* @see keepLayerSet()
* \see layers()
* \see keepLayerSet()
*/
void setLayers( const QList<QgsMapLayer *> &layers );
@ -304,14 +304,14 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/** Returns the map item's grid stack, which is used to control how grids
* are drawn over the map's contents.
* \returns pointer to grid stack
* @see grid()
* \see grid()
* \since QGIS 2.5
*/
QgsComposerMapGridStack *grids() { return mGridStack; }
/** Returns the map item's first grid. This is a convenience function.
* \returns pointer to first grid for map item
* @see grids()
* \see grids()
* \since QGIS 2.5
*/
QgsComposerMapGrid *grid();
@ -319,14 +319,14 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/** Returns the map item's overview stack, which is used to control how overviews
* are drawn over the map's contents.
* \returns pointer to overview stack
* @see overview()
* \see overview()
* \since QGIS 2.5
*/
QgsComposerMapOverviewStack *overviews() { return mOverviewStack; }
/** Returns the map item's first overview. This is a convenience function.
* \returns pointer to first overview for map item
* @see overviews()
* \see overviews()
* \since QGIS 2.5
*/
QgsComposerMapOverview *overview();
@ -355,13 +355,13 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/**
* Sets whether annotations are drawn within the composer map.
* @see drawAnnotations()
* \see drawAnnotations()
*/
void setDrawAnnotations( bool draw ) { mDrawAnnotations = draw; }
/**
* Returns whether annotations are drawn within the composer map.
* @see setDrawAnnotations()
* \see setDrawAnnotations()
*/
bool drawAnnotations() const { return mDrawAnnotations; }
@ -374,15 +374,15 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/** Returns whether the map extent is set to follow the current atlas feature.
* \returns true if map will follow the current atlas feature.
* @see setAtlasDriven
* @see atlasScalingMode
* \see setAtlasDriven
* \see atlasScalingMode
*/
bool atlasDriven() const { return mAtlasDriven; }
/** Sets whether the map extent will follow the current atlas feature.
* \param enabled set to true if the map extents should be set by the current atlas feature.
* @see atlasDriven
* @see setAtlasScalingMode
* \see atlasDriven
* \see setAtlasScalingMode
*/
void setAtlasDriven( bool enabled );
@ -391,8 +391,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* is enabled.
* \returns the current scaling mode
* \note this parameter is only used if atlasDriven() is true
* @see setAtlasScalingMode
* @see atlasDriven
* \see setAtlasScalingMode
* \see atlasDriven
*/
AtlasScalingMode atlasScalingMode() const { return mAtlasScalingMode; }
@ -401,8 +401,8 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* is enabled.
* \param mode atlas scaling mode to set
* \note this parameter is only used if atlasDriven() is true
* @see atlasScalingMode
* @see atlasDriven
* \see atlasScalingMode
* \see atlasDriven
*/
void setAtlasScalingMode( AtlasScalingMode mode ) { mAtlasScalingMode = mode; }
@ -412,16 +412,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* settings).
* \returns margin size in percentage to leave around the atlas feature's extent
* \note this is only used if atlasScalingMode() is Auto.
* @see atlasScalingMode
* @see setAtlasMargin
* \see atlasScalingMode
* \see setAtlasMargin
*/
double atlasMargin( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue );
/** Sets the margin size (percentage) used when the map is in atlas mode.
* \param margin size in percentage to leave around the atlas feature's extent
* \note this is only used if atlasScalingMode() is Auto.
* @see atlasScalingMode
* @see atlasMargin
* \see atlasScalingMode
* \see atlasMargin
*/
void setAtlasMargin( double margin ) { mAtlasMargin = margin; }
@ -436,7 +436,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* If the map rotation is 0, the result is the same as currentMapExtent
* \returns polygon with the four corner points representing the visible map extent. The points are
* clockwise, starting at the top-left point
* @see currentMapExtent
* \see currentMapExtent
*/
QPolygonF visibleExtentPolygon() const;
@ -476,7 +476,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
void updateCachedImage();
/** Updates the cached map image if the map is set to Render mode
* @see updateCachedImage
* \see updateCachedImage
*/
void renderModeUpdateCachedImage();

252
src/core/composer/qgscomposermapgrid.h
View File

@ -58,7 +58,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param grid QgsComposerMapGrid to add to the stack
* \note after adding a grid to the stack, updateBoundingRect() and update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see removeGrid
* \see removeGrid
*/
void addGrid( QgsComposerMapGrid *grid );
@ -66,7 +66,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param gridId id for the QgsComposerMapGrid to remove
* \note after removing a grid from the stack, updateBoundingRect() and update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see addGrid
* \see addGrid
*/
void removeGrid( const QString &gridId );
@ -74,7 +74,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param gridId id for the QgsComposerMapGrid to move up
* \note after moving a grid within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new grid stack order
* @see moveGridDown
* \see moveGridDown
*/
void moveGridUp( const QString &gridId );
@ -82,36 +82,36 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param gridId id for the QgsComposerMapGrid to move down
* \note after moving a grid within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new grid stack order
* @see moveGridUp
* \see moveGridUp
*/
void moveGridDown( const QString &gridId );
/** Returns a const reference to a grid within the stack
* \param gridId id for the QgsComposerMapGrid to find
* \returns const reference to grid, if found
* @see grid
* \see grid
*/
const QgsComposerMapGrid *constGrid( const QString &gridId ) const;
/** Returns a reference to a grid within the stack
* \param gridId id for the QgsComposerMapGrid to find
* \returns reference to grid if found
* @see constGrid
* \see constGrid
*/
QgsComposerMapGrid *grid( const QString &gridId ) const;
/** Returns a reference to a grid within the stack
* \param index grid position in the stack
* \returns reference to grid if found
* @see constGrid
* \see constGrid
*/
QgsComposerMapGrid *grid( const int index ) const;
/** Returns a reference to a grid within the stack
* \param idx grid position in the stack
* \returns reference to grid if found
* @see constGrid
* @see grid
* \see constGrid
* \see grid
*/
QgsComposerMapGrid &operator[]( int idx );
@ -124,14 +124,14 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param elem is DOM node corresponding to 'a ComposerMap' tag
* \param doc DOM document
* \returns true if read was successful
* @see writeXml
* \see writeXml
*/
bool readXml( const QDomElement &elem, const QDomDocument &doc ) override;
/** Calculates the maximum distance grids within the stack extend
* beyond the QgsComposerMap's item rect
* \returns maximum grid extension
* @see calculateMaxGridExtension()
* \see calculateMaxGridExtension()
*/
double maxGridExtension() const;
@ -143,7 +143,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \param bottom storage for bottom extension
* \param left storage for left extension
* \since QGIS 2.12
* @see maxGridExtension()
* \see maxGridExtension()
*/
void calculateMaxGridExtension( double &top, double &right, double &bottom, double &left ) const;
};
@ -285,38 +285,38 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Stores grid state in DOM element
* \param elem is DOM element corresponding to a 'ComposerMap' tag
* \param doc DOM document
* @see readXml
* \see readXml
*/
bool writeXml( QDomElement &elem, QDomDocument &doc ) const override;
/** Sets grid state from a DOM document
* \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag
* \param doc is DOM document
* @see writeXml
* \see writeXml
*/
bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override;
/** Sets the CRS for the grid.
* \param crs coordinate reference system for grid
* @see crs
* \see crs
*/
void setCrs( const QgsCoordinateReferenceSystem &crs );
/** Retrieves the CRS for the grid.
* \returns coordinate reference system for grid
* @see setCrs
* \see setCrs
*/
QgsCoordinateReferenceSystem crs() const { return mCRS; }
/** Sets the blending mode used for drawing the grid.
* \param mode blending mode for grid
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Retrieves the blending mode used for drawing the grid.
* \returns blending mode for grid
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }
@ -336,7 +336,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* \param bottom storage for bottom extension
* \param left storage for left extension
* \since QGIS 2.12
* @see maxExtension()
* \see maxExtension()
*/
void calculateMaxExtension( double &top, double &right, double &bottom, double &left );
@ -347,78 +347,78 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Sets the units to use for grid measurements such as the interval
* and offset for grid lines.
* \param unit unit for grid measurements
* @see units
* \see units
*/
void setUnits( const GridUnit unit );
/** Gets the units used for grid measurements such as the interval
* and offset for grid lines.
* \returns for grid measurements
* @see setUnits
* \see setUnits
*/
GridUnit units() const { return mGridUnit; }
/** Sets the interval between grid lines in the x-direction. The units
* are controlled through the setUnits method
* \param interval interval between horizontal grid lines
* @see setIntervalY
* @see intervalX
* \see setIntervalY
* \see intervalX
*/
void setIntervalX( const double interval );
/** Gets the interval between grid lines in the x-direction. The units
* are retrieved through the units() method.
* \returns interval between horizontal grid lines
* @see setIntervalX
* @see intervalY
* \see setIntervalX
* \see intervalY
*/
double intervalX() const { return mGridIntervalX; }
/** Sets the interval between grid lines in the y-direction. The units
* are controlled through the setUnits method
* \param interval interval between vertical grid lines
* @see setIntervalX
* @see intervalY
* \see setIntervalX
* \see intervalY
*/
void setIntervalY( const double interval );
/** Gets the interval between grid lines in the y-direction. The units
* are retrieved through the units() method.
* \returns interval between vertical grid lines
* @see setIntervalY
* @see intervalX
* \see setIntervalY
* \see intervalX
*/
double intervalY() const { return mGridIntervalY; }
/** Sets the offset for grid lines in the x-direction. The units
* are controlled through the setUnits method
* \param offset offset for horizontal grid lines
* @see setOffsetY
* @see offsetX
* \see setOffsetY
* \see offsetX
*/
void setOffsetX( const double offset );
/** Gets the offset for grid lines in the x-direction. The units
* are retrieved through the units() method.
* \returns offset for horizontal grid lines
* @see setOffsetX
* @see offsetY
* \see setOffsetX
* \see offsetY
*/
double offsetX() const { return mGridOffsetX; }
/** Sets the offset for grid lines in the y-direction. The units
* are controlled through the setUnits method
* \param offset offset for vertical grid lines
* @see setOffsetX
* @see offsetY
* \see setOffsetX
* \see offsetY
*/
void setOffsetY( const double offset );
/** Gets the offset for grid lines in the y-direction. The units
* are retrieved through the units() method.
* \returns offset for vertical grid lines
* @see setOffsetY
* @see offsetX
* \see setOffsetY
* \see offsetX
*/
double offsetY() const { return mGridOffsetY; }
@ -429,28 +429,28 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Sets the grid style, which controls how the grid is drawn
* over the map's contents
* \param style desired grid style
* @see style
* \see style
*/
void setStyle( const GridStyle style );
/** Gets the grid's style, which controls how the grid is drawn
* over the map's contents
* \returns current grid style
* @see setStyle
* \see setStyle
*/
GridStyle style() const { return mGridStyle; }
/** Sets the length of the cross segments drawn for the grid. This is only used for grids
* with QgsComposerMapGrid::Cross styles
* \param length cross length in millimeters
* @see crossLength
* \see crossLength
*/
void setCrossLength( const double length ) { mCrossLength = length; }
/** Retrieves the length of the cross segments drawn for the grid. This is only used for grids
* with QgsComposerMapGrid::Cross styles
* \returns cross length in millimeters
* @see setCrossLength
* \see setCrossLength
*/
double crossLength() const { return mCrossLength; }
@ -458,8 +458,8 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use
* setLineSymbol instead.
* \param width grid line width
* @see setLineSymbol
* @see setGridLineColor
* \see setLineSymbol
* \see setGridLineColor
*/
void setGridLineWidth( const double width );
@ -467,26 +467,26 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* or QgsComposerMapGrid::Cross styles. For more control over grid line appearance, use
* setLineSymbol instead.
* \param color color of grid lines
* @see setLineSymbol
* @see setGridLineWidth
* \see setLineSymbol
* \see setGridLineWidth
*/
void setGridLineColor( const QColor &color );
/** Sets the line symbol used for drawing grid lines. This is only used for grids with
* QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.
* \param symbol line symbol for grid lines
* @see lineSymbol
* @see setMarkerSymbol
* @see setStyle
* \see lineSymbol
* \see setMarkerSymbol
* \see setStyle
*/
void setLineSymbol( QgsLineSymbol *symbol );
/** Gets the line symbol used for drawing grid lines. This is only used for grids with
* QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.
* \returns line symbol for grid lines
* @see setLineSymbol
* @see markerSymbol
* @see style
* \see setLineSymbol
* \see markerSymbol
* \see style
* \note not available in Python bindings
*/
const QgsLineSymbol *lineSymbol() const { return mGridLineSymbol; }
@ -494,27 +494,27 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Gets the line symbol used for drawing grid lines. This is only used for grids with
* QgsComposerMapGrid::Solid or QgsComposerMapGrid::Cross styles.
* \returns line symbol for grid lines
* @see setLineSymbol
* @see markerSymbol
* @see style
* \see setLineSymbol
* \see markerSymbol
* \see style
*/
QgsLineSymbol *lineSymbol() { return mGridLineSymbol; }
/** Sets the marker symbol used for drawing grid points. This is only used for grids with a
* QgsComposerMapGrid::Markers style.
* \param symbol marker symbol for grid intersection points
* @see markerSymbol
* @see setLineSymbol
* @see setStyle
* \see markerSymbol
* \see setLineSymbol
* \see setStyle
*/
void setMarkerSymbol( QgsMarkerSymbol *symbol );
/** Gets the marker symbol used for drawing grid points. This is only used for grids with a
* QgsComposerMapGrid::Markers style.
* \returns marker symbol for grid intersection points
* @see setMarkerSymbol
* @see lineSymbol
* @see style
* \see setMarkerSymbol
* \see lineSymbol
* \see style
* \note not available in Python bindings
*/
const QgsMarkerSymbol *markerSymbol() const { return mGridMarkerSymbol; }
@ -522,9 +522,9 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Gets the marker symbol used for drawing grid points. This is only used for grids with a
* QgsComposerMapGrid::Markers style.
* \returns marker symbol for grid intersection points
* @see setMarkerSymbol
* @see lineSymbol
* @see style
* \see setMarkerSymbol
* \see lineSymbol
* \see style
*/
QgsMarkerSymbol *markerSymbol() { return mGridMarkerSymbol; }
@ -534,49 +534,49 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Sets whether annotations should be shown for the grid.
* \param enabled set to true to draw annotations for the grid
* @see annotationEnabled
* \see annotationEnabled
*/
void setAnnotationEnabled( const bool enabled ) { mShowGridAnnotation = enabled; }
/** Gets whether annotations are shown for the grid.
* \returns true if annotations are drawn for the grid
* @see setAnnotationEnabled
* \see setAnnotationEnabled
*/
bool annotationEnabled() const { return mShowGridAnnotation; }
/** Sets the font used for drawing grid annotations
* \param font font for annotations
* @see annotationFont
* \see annotationFont
*/
void setAnnotationFont( const QFont &font ) { mGridAnnotationFont = font; }
/** Gets the font used for drawing grid annotations
* \returns font for annotations
* @see setAnnotationFont
* \see setAnnotationFont
*/
QFont annotationFont() const { return mGridAnnotationFont; }
/** Sets the font color used for drawing grid annotations
* \param color font color for annotations
* @see annotationFontColor
* \see annotationFontColor
*/
void setAnnotationFontColor( const QColor &color ) { mGridAnnotationFontColor = color; }
/** Gets the font color used for drawing grid annotations
* \returns font color for annotations
* @see setAnnotationFontColor
* \see setAnnotationFontColor
*/
QColor annotationFontColor() const { return mGridAnnotationFontColor; }
/** Sets the coordinate precision for grid annotations
* \param precision number of decimal places to show when drawing grid annotations
* @see annotationPrecision
* \see annotationPrecision
*/
void setAnnotationPrecision( const int precision ) { mGridAnnotationPrecision = precision; }
/** Returns the coordinate precision for grid annotations
* \returns number of decimal places shown when drawing grid annotations
* @see setAnnotationPrecision
* \see setAnnotationPrecision
*/
int annotationPrecision() const { return mGridAnnotationPrecision; }
@ -584,7 +584,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* or whether grid annotations should be disabled for the side.
* \param display display mode for annotations
* \param border side of map for annotations
* @see annotationDisplay
* \see annotationDisplay
* \since QGIS 2.7
*/
void setAnnotationDisplay( const DisplayMode display, const BorderSide border );
@ -594,7 +594,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* from a side of the map frame.
* \param border side of map for annotations
* \returns display mode for grid annotations
* @see setAnnotationDisplay
* \see setAnnotationDisplay
* \since QGIS 2.7
*/
DisplayMode annotationDisplay( const BorderSide border ) const;
@ -603,7 +603,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* frame.
* \param position position to draw grid annotations
* \param border side of map for annotations
* @see annotationPosition
* \see annotationPosition
*/
void setAnnotationPosition( const AnnotationPosition position, const BorderSide border );
@ -611,58 +611,58 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* frame.
* \param border side of map for annotations
* \returns position that grid annotations are drawn in
* @see setAnnotationPosition
* \see setAnnotationPosition
*/
AnnotationPosition annotationPosition( const BorderSide border ) const;
/** Sets the distance between the map frame and annotations. Units are in millimeters.
* \param distance margin between map frame and annotations
* @see annotationFrameDistance
* \see annotationFrameDistance
*/
void setAnnotationFrameDistance( const double distance ) { mAnnotationFrameDistance = distance; }
/** Gets the distance between the map frame and annotations. Units are in millimeters.
* \returns margin between map frame and annotations
* @see setAnnotationFrameDistance
* \see setAnnotationFrameDistance
*/
double annotationFrameDistance() const { return mAnnotationFrameDistance; }
/** Sets the direction for drawing frame annotations.
* \param direction direction for frame annotations
* \param border side of map for annotations
* @see annotationDirection
* \see annotationDirection
*/
void setAnnotationDirection( const AnnotationDirection direction, const BorderSide border );
/** Sets the direction for drawing all frame annotations.
* \param direction direction for frame annotations
* @see annotationDirection
* \see annotationDirection
*/
void setAnnotationDirection( const AnnotationDirection direction );
/** Gets the direction for drawing frame annotations.
* \param border side of map for annotations
* \returns direction for frame annotations
* @see setAnnotationDirection
* \see setAnnotationDirection
*/
AnnotationDirection annotationDirection( const BorderSide border ) const;
/** Sets the format for drawing grid annotations.
* \param format format for grid annotations
* @see annotationFormat
* \see annotationFormat
*/
void setAnnotationFormat( const AnnotationFormat format ) { mGridAnnotationFormat = format; }
/** Gets the format for drawing grid annotations.
* \returns format for grid annotations
* @see setAnnotationFormat
* \see setAnnotationFormat
*/
AnnotationFormat annotationFormat() const { return mGridAnnotationFormat; }
/** Sets the expression used for drawing grid annotations. This is only used when annotationFormat()
* is QgsComposerMapGrid::CustomFormat.
* \param expression expression for evaluating custom grid annotations
* @see annotationExpression
* \see annotationExpression
* \since QGIS 2.12
*/
void setAnnotationExpression( const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); }
@ -670,7 +670,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Returns the expression used for drawing grid annotations. This is only used when annotationFormat()
* is QgsComposerMapGrid::CustomFormat.
* \returns expression for evaluating custom grid annotations
* @see setAnnotationExpression
* \see setAnnotationExpression
* \since QGIS 2.12
*/
QString annotationExpression() const { return mGridAnnotationExpressionString; }
@ -681,20 +681,20 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Sets the grid frame style.
* \param style style for grid frame
* @see frameStyle
* \see frameStyle
*/
void setFrameStyle( const FrameStyle style ) { mGridFrameStyle = style; }
/** Gets the grid frame style.
* \returns style for grid frame
* @see setFrameStyle
* \see setFrameStyle
*/
FrameStyle frameStyle() const { return mGridFrameStyle; }
/** Sets what type of grid divisions should be used for frames on a specified side of the map.
* \param divisions grid divisions for frame
* \param border side of map for frame
* @see frameDivisions
* \see frameDivisions
* \since QGIS 2.7
*/
void setFrameDivisions( const DisplayMode divisions, const BorderSide border );
@ -702,7 +702,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Gets the type of grid divisions which are used for frames on a specified side of the map.
* \param border side of map for frame
* \returns grid divisions for frame
* @see setFrameDivisions
* \see setFrameDivisions
* \since QGIS 2.7
*/
DisplayMode frameDivisions( const BorderSide border ) const;
@ -710,27 +710,27 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
/** Sets flags for grid frame sides. Setting these flags controls which sides
* of the map item the grid frame is drawn on.
* \param flags flags for grid frame sides
* @see setFrameSideFlag
* @see frameSideFlags
* @see testFrameSideFlag
* \see setFrameSideFlag
* \see frameSideFlags
* \see testFrameSideFlag
*/
void setFrameSideFlags( QgsComposerMapGrid::FrameSideFlags flags );
/** Sets whether the grid frame is drawn for a certain side of the map item.
* \param flag flag for grid frame side
* \param on set to true to draw grid frame on that side of the map
* @see setFrameSideFlags
* @see frameSideFlags
* @see testFrameSideFlag
* \see setFrameSideFlags
* \see frameSideFlags
* \see testFrameSideFlag
*/
void setFrameSideFlag( const FrameSideFlag flag, bool on = true );
/** Returns the flags which control which sides of the map item the grid frame
* is drawn on.
* \returns flags for side of map grid is drawn on
* @see setFrameSideFlags
* @see setFrameSideFlag
* @see testFrameSideFlag
* \see setFrameSideFlags
* \see setFrameSideFlag
* \see testFrameSideFlag
*/
FrameSideFlags frameSideFlags() const;
@ -738,9 +738,9 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* item.
* \param flag flag for grid frame side
* \returns true if grid frame should be drawn for that side of the map
* @see setFrameSideFlags
* @see setFrameSideFlag
* @see frameSideFlags
* \see setFrameSideFlags
* \see setFrameSideFlag
* \see frameSideFlags
*/
bool testFrameSideFlag( const FrameSideFlag flag ) const;
@ -748,7 +748,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* The size of the line outlines drawn in the frame is controlled through the
* setFramePenSize method.
* \param width width of grid frame in millimeters
* @see frameWidth
* \see frameWidth
*/
void setFrameWidth( const double width ) { mGridFrameWidth = width; }
@ -756,71 +756,71 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* The size of the line outlines drawn in the frame can be retrieved via the
* framePenSize method.
* \returns width of grid frame in millimeters
* @see setFrameWidth
* \see setFrameWidth
*/
double frameWidth() const { return mGridFrameWidth; }
/** Sets the width of the stroke drawn in the grid frame.
* \param width width of grid frame stroke
* @see framePenSize
* @see setFramePenColor
* \see framePenSize
* \see setFramePenColor
*/
void setFramePenSize( const double width ) { mGridFramePenThickness = width; }
/** Retrieves the width of the stroke drawn in the grid frame.
* \returns width of grid frame stroke
* @see setFramePenSize
* @see framePenColor
* \see setFramePenSize
* \see framePenColor
*/
double framePenSize() const { return mGridFramePenThickness; }
/** Sets the color of the stroke drawn in the grid frame.
* \param color color of grid frame stroke
* @see framePenColor
* @see setFramePenSize
* @see setFrameFillColor1
* @see setFrameFillColor2
* \see framePenColor
* \see setFramePenSize
* \see setFrameFillColor1
* \see setFrameFillColor2
*/
void setFramePenColor( const QColor &color ) { mGridFramePenColor = color; }
/** Retrieves the color of the stroke drawn in the grid frame.
* \returns color of grid frame stroke
* @see setFramePenColor
* @see framePenSize
* @see frameFillColor1
* @see frameFillColor2
* \see setFramePenColor
* \see framePenSize
* \see frameFillColor1
* \see frameFillColor2
*/
QColor framePenColor() const {return mGridFramePenColor;}
/** Sets the first fill color used for the grid frame.
* \param color first fill color for grid frame
* @see frameFillColor1
* @see setFramePenColor
* @see setFrameFillColor2
* \see frameFillColor1
* \see setFramePenColor
* \see setFrameFillColor2
*/
void setFrameFillColor1( const QColor &color ) { mGridFrameFillColor1 = color; }
/** Retrieves the first fill color for the grid frame.
* \returns first fill color for grid frame
* @see setFrameFillColor1
* @see framePenColor
* @see frameFillColor2
* \see setFrameFillColor1
* \see framePenColor
* \see frameFillColor2
*/
QColor frameFillColor1() const { return mGridFrameFillColor1; }
/** Sets the second fill color used for the grid frame.
* \param color second fill color for grid frame
* @see frameFillColor2
* @see setFramePenColor
* @see setFrameFillColor1
* \see frameFillColor2
* \see setFramePenColor
* \see setFrameFillColor1
*/
void setFrameFillColor2( const QColor &color ) { mGridFrameFillColor2 = color; }
/** Retrieves the second fill color for the grid frame.
* \returns second fill color for grid frame
* @see setFrameFillColor2
* @see framePenColor
* @see frameFillColor1
* \see setFrameFillColor2
* \see framePenColor
* \see frameFillColor1
*/
QColor frameFillColor2() const { return mGridFrameFillColor2; }

38
src/core/composer/qgscomposermapitem.h
View File

@ -46,26 +46,26 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
/** Stores map item state in DOM element
* \param elem is DOM element corresponding to a 'ComposerMap' tag
* \param doc DOM document
* @see readXml
* \see readXml
*/
virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const override;
/** Sets map item state from a DOM document
* \param itemElem is DOM node corresponding to a 'ComposerMapGrid' tag
* \param doc is DOM document
* @see writeXml
* \see writeXml
*/
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override;
/** Sets composer map for the item
* \param map composer map
* @see composerMap
* \see composerMap
*/
virtual void setComposerMap( QgsComposerMap *map );
/** Get composer map for the item
* \returns composer map
* @see setComposerMap
* \see setComposerMap
*/
virtual const QgsComposerMap *composerMap() const { return mComposerMap; }
@ -76,25 +76,25 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
/** Sets the friendly display name for the item
* \param name display name
* @see name
* \see name
*/
virtual void setName( const QString &name ) { mName = name; }
/** Get friendly display name for the item
* \returns display name
* @see setName
* \see setName
*/
virtual QString name() const { return mName; }
/** Controls whether the item will be drawn
* \param enabled set to true to enable drawing of the item
* @see enabled
* \see enabled
*/
virtual void setEnabled( const bool enabled ) { mEnabled = enabled; }
/** Returns whether the item will be drawn
* \returns true if item will be drawn on the map
* @see setEnabled
* \see setEnabled
*/
virtual bool enabled() const { return mEnabled; }
@ -149,7 +149,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param elem is DOM element corresponding to a 'ComposerMap' tag
* \param doc DOM document
* \returns true if write was successful
* @see readXml
* \see readXml
*/
virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const;
@ -157,7 +157,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param elem is DOM node corresponding to 'a ComposerMap' tag
* \param doc DOM document
* \returns true if read was successful
* @see writeXml
* \see writeXml
*/
virtual bool readXml( const QDomElement &elem, const QDomDocument &doc ) = 0;
@ -180,7 +180,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param item QgsComposerMapItem to add to the stack
* \note after adding an item to the stack update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see removeItem
* \see removeItem
*/
void addItem( QgsComposerMapItem *item );
@ -188,7 +188,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param itemId id for the QgsComposerMapItem to remove
* \note after removing an item from the stack, update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see addItem
* \see addItem
*/
void removeItem( const QString &itemId );
@ -196,7 +196,7 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param itemId id for the QgsComposerMapItem to move up
* \note after moving an item within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new item stack order
* @see moveItemDown
* \see moveItemDown
*/
void moveItemUp( const QString &itemId );
@ -204,36 +204,36 @@ class CORE_EXPORT QgsComposerMapItemStack
* \param itemId id for the QgsComposerMapItem to move down
* \note after moving an item within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new item stack order
* @see moveItemUp
* \see moveItemUp
*/
void moveItemDown( const QString &itemId );
/** Returns a const reference to an item within the stack
* \param itemId id for the QgsComposerMapItem to find
* \returns const reference to item, if found
* @see item
* \see item
*/
const QgsComposerMapItem *constItem( const QString &itemId ) const;
/** Returns a reference to an item within the stack
* \param itemId id for the QgsComposerMapItem to find
* \returns reference to item if found
* @see constItem
* \see constItem
*/
QgsComposerMapItem *item( const QString &itemId ) const;
/** Returns a reference to an item within the stack
* \param index item position in the stack
* \returns reference to item if found
* @see constItem
* \see constItem
*/
QgsComposerMapItem *item( const int index ) const;
/** Returns a reference to an item within the stack
* \param idx item position in the stack
* \returns reference to item if found
* @see constItem
* @see item
* \see constItem
* \see item
* \note not available in Python bindings
*/
QgsComposerMapItem &operator[]( int idx );

44
src/core/composer/qgscomposermapoverview.h
View File

@ -52,7 +52,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \param overview QgsComposerMapOverview to add to the stack
* \note after adding a overview to the stack, update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see removeOverview
* \see removeOverview
*/
void addOverview( QgsComposerMapOverview *overview );
@ -60,7 +60,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \param overviewId id for the QgsComposerMapOverview to remove
* \note after removing an overview from the stack, update()
* should be called for the QgsComposerMap to prevent rendering artifacts
* @see addOverview
* \see addOverview
*/
void removeOverview( const QString &overviewId );
@ -68,7 +68,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \param overviewId id for the QgsComposerMapOverview to move up
* \note after moving an overview within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new overview stack order
* @see moveOverviewDown
* \see moveOverviewDown
*/
void moveOverviewUp( const QString &overviewId );
@ -76,36 +76,36 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \param overviewId id for the QgsComposerMapOverview to move down
* \note after moving an overview within the stack, update() should be
* called for the QgsComposerMap to redraw the map with the new overview stack order
* @see moveOverviewUp
* \see moveOverviewUp
*/
void moveOverviewDown( const QString &overviewId );
/** Returns a const reference to an overview within the stack
* \param overviewId id for the QgsComposerMapOverview to find
* \returns const reference to overview, if found
* @see overview
* \see overview
*/
const QgsComposerMapOverview *constOverview( const QString &overviewId ) const;
/** Returns a reference to an overview within the stack
* \param overviewId id for the QgsComposerMapOverview to find
* \returns reference to overview if found
* @see constOverview
* \see constOverview
*/
QgsComposerMapOverview *overview( const QString &overviewId ) const;
/** Returns a reference to an overview within the stack
* \param index overview position in the stack
* \returns reference to overview if found
* @see constOverview
* \see constOverview
*/
QgsComposerMapOverview *overview( const int index ) const;
/** Returns a reference to an overview within the stack
* \param idx overview position in the stack
* \returns reference to overview if found
* @see constOverview
* @see overview
* \see constOverview
* \see overview
*/
QgsComposerMapOverview &operator[]( int idx );
@ -118,7 +118,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \param elem is DOM node corresponding to a 'ComposerMap' tag
* \param doc DOM document
* \returns true if read was successful
* @see writeXml
* \see writeXml
*/
bool readXml( const QDomElement &elem, const QDomDocument &doc ) override;
@ -153,14 +153,14 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
/** Stores overview state in DOM element
* \param elem is DOM element corresponding to a 'ComposerMap' tag
* \param doc DOM document
* @see readXml
* \see readXml
*/
bool writeXml( QDomElement &elem, QDomDocument &doc ) const override;
/** Sets overview state from a DOM document
* \param itemElem is DOM node corresponding to a 'ComposerMapOverview' tag
* \param doc is DOM document
* @see writeXml
* \see writeXml
*/
bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override;
@ -168,7 +168,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
/** Sets overview frame map.
* \param mapId source map id. -1 disables the overview frame
* @see frameMapId
* \see frameMapId
*/
void setFrameMap( const int mapId );
@ -179,58 +179,58 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
/** Sets the fill symbol used for drawing the overview extent.
* \param symbol fill symbol for overview
* @see frameSymbol
* \see frameSymbol
*/
void setFrameSymbol( QgsFillSymbol *symbol );
/** Gets the fill symbol used for drawing the overview extent.
* \returns fill symbol for overview
* @see setFrameSymbol
* \see setFrameSymbol
*/
QgsFillSymbol *frameSymbol() { return mFrameSymbol; }
/** Gets the fill symbol used for drawing the overview extent.
* \returns fill symbol for overview
* @see setFrameSymbol
* \see setFrameSymbol
* \note not available in Python bindings
*/
const QgsFillSymbol *frameSymbol() const { return mFrameSymbol; }
/** Retrieves the blending mode used for drawing the overview.
* \returns blending mode for overview
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }
/** Sets the blending mode used for drawing the overview.
* \param blendMode blending mode for overview
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode blendMode );
/** Returns whether the overview frame is inverted, ie, whether the shaded area is drawn outside
* the extent of the overview map.
* \returns true if overview frame is inverted
* @see setInverted
* \see setInverted
*/
bool inverted() const { return mInverted; }
/** Sets whether the overview frame is inverted, ie, whether the shaded area is drawn outside
* the extent of the overview map.
* \param inverted set to true if overview frame is to be inverted
* @see inverted
* \see inverted
*/
void setInverted( const bool inverted );
/** Returns whether the extent of the map is forced to center on the overview
* \returns true if map will be centered on overview
* @see setCentered
* \see setCentered
*/
bool centered() const { return mCentered; }
/** Sets whether the extent of the map is forced to center on the overview
* \param centered set to true if map will be centered on overview
* @see centered
* \see centered
*/
void setCentered( const bool centered );

70
src/core/composer/qgscomposermodel.h
View File

@ -102,7 +102,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
/** Adds an item to the top of the composition z stack.
* \param item item to add. The item must not already exist in the z-order list.
* \since QGIS 2.5
* @see reorderItemToTop
* \see reorderItemToTop
*/
void addItemAtTop( QgsComposerItem *item );
@ -116,9 +116,9 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to move
* \returns true if item was moved. Returns false if item was not found
* in z-order list or was already at the top of the z-order list.
* @see reorderItemDown
* @see reorderItemToTop
* @see reorderItemToBottom
* \see reorderItemDown
* \see reorderItemToTop
* \see reorderItemToBottom
* \since QGIS 2.5
*/
bool reorderItemUp( QgsComposerItem *item );
@ -127,9 +127,9 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to move
* \returns true if item was moved. Returns false if item was not found
* in z-order list or was already at the bottom of the z-order list.
* @see reorderItemUp
* @see reorderItemToTop
* @see reorderItemToBottom
* \see reorderItemUp
* \see reorderItemToTop
* \see reorderItemToBottom
* \since QGIS 2.5
*/
bool reorderItemDown( QgsComposerItem *item );
@ -138,9 +138,9 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to move
* \returns true if item was moved. Returns false if item was not found
* in z-order list or was already at the top of the z-order list.
* @see reorderItemUp
* @see reorderItemDown
* @see reorderItemToBottom
* \see reorderItemUp
* \see reorderItemDown
* \see reorderItemToBottom
* \since QGIS 2.5
*/
bool reorderItemToTop( QgsComposerItem *item );
@ -149,9 +149,9 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to move
* \returns true if item was moved. Returns false if item was not found
* in z-order list or was already at the bottom of the z-order list.
* @see reorderItemUp
* @see reorderItemDown
* @see reorderItemToTop
* \see reorderItemUp
* \see reorderItemDown
* \see reorderItemToTop
* \since QGIS 2.5
*/
bool reorderItemToBottom( QgsComposerItem *item );
@ -162,7 +162,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to search above
* \returns item above specified item. If no items were found, no item
* will be returned.
* @see getComposerItemBelow
* \see getComposerItemBelow
* \since QGIS 2.5
*/
QgsComposerItem *getComposerItemAbove( QgsComposerItem *item ) const;
@ -173,7 +173,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \param item item to search above
* \returns item below specified item. If no items were found, no item
* will be returned.
* @see getComposerItemAbove
* \see getComposerItemAbove
* \since QGIS 2.5
*/
QgsComposerItem *getComposerItemBelow( QgsComposerItem *item ) const;
@ -188,7 +188,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
/** Marks an item as removed from the composition. This must be called whenever an item
* has been removed from the composition.
* \param item to mark as removed from the composition
* @see setItemRestored
* \see setItemRestored
* \since QGIS 2.5
*/
void setItemRemoved( QgsComposerItem *item );
@ -196,43 +196,43 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
/** Restores an item to the composition. This must be called whenever an item removed
* from the composition is restored to the composition.
* \param item to mark as restored to the composition
* @see setItemRemoved
* \see setItemRemoved
* \since QGIS 2.5
*/
void setItemRestored( QgsComposerItem *item );
/** Must be called when an item's display name is modified
* \param item item to update
* @see updateItemLockStatus
* @see updateItemVisibility
* @see updateItemSelectStatus
* \see updateItemLockStatus
* \see updateItemVisibility
* \see updateItemSelectStatus
* \since QGIS 2.5
*/
void updateItemDisplayName( QgsComposerItem *item );
/** Must be called when an item's lock status changes
* \param item item to update
* @see updateItemDisplayName
* @see updateItemVisibility
* @see updateItemSelectStatus
* \see updateItemDisplayName
* \see updateItemVisibility
* \see updateItemSelectStatus
* \since QGIS 2.5
*/
void updateItemLockStatus( QgsComposerItem *item );
/** Must be called when an item's visibility changes
* \param item item to update
* @see updateItemDisplayName
* @see updateItemLockStatus
* @see updateItemSelectStatus
* \see updateItemDisplayName
* \see updateItemLockStatus
* \see updateItemSelectStatus
* \since QGIS 2.5
*/
void updateItemVisibility( QgsComposerItem *item );
/** Must be called when an item's selection status changes
* \param item item to update
* @see updateItemDisplayName
* @see updateItemVisibility
* @see updateItemLockStatus
* \see updateItemDisplayName
* \see updateItemVisibility
* \see updateItemLockStatus
* \since QGIS 2.5
*/
void updateItemSelectStatus( QgsComposerItem *item );
@ -277,13 +277,13 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* list and does not emit QAbstractItemModel signals. Accordingly, this method should
* only be called when changes to the z-order list are known and QAbstractItemModel begin
* signals have already been called.
* @see rebuildSceneItemList
* \see rebuildSceneItemList
*/
void refreshItemsInScene();
/** Steps through the item z-order list and rebuilds the items in composition list,
* emitting QAbstractItemModel signals as required.
* @see refreshItemsInScene
* \see refreshItemsInScene
*/
void rebuildSceneItemList();
@ -311,25 +311,25 @@ class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel
/** Returns the current item type filter, or QgsComposerItem::ComposerItem if no
* item type filter is set.
* @see setFilterType()
* \see setFilterType()
*/
QgsComposerItem::ItemType filterType() const { return mItemTypeFilter; }
/** Sets the item type filter. Only matching item types will be shown.
* \param itemType type to filter. Set to QgsComposerItem::ComposerItem to show all
* item types.
* @see filterType()
* \see filterType()
*/
void setFilterType( QgsComposerItem::ItemType itemType );
/** Sets a list of specific items to exclude from the model
* \param exceptList list of items to exclude
* @see exceptedItemList()
* \see exceptedItemList()
*/
void setExceptedItemList( const QList< QgsComposerItem * > &exceptList );
/** Returns the list of specific items excluded from the model.
* @see setExceptedItemList()
* \see setExceptedItemList()
*/
QList< QgsComposerItem * > exceptedItemList() const { return mExceptedList; }

44
src/core/composer/qgscomposermultiframe.h
View File

@ -74,8 +74,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* the frame size is not fixed in that direction and frames can have variable width
* or height accordingly.
* \since QGIS 2.5
* @see minFrameSize
* @see recalculateFrameRects
* \see minFrameSize
* \see recalculateFrameRects
*/
virtual QSizeF fixedFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); }
@ -86,8 +86,8 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \returns minimum size for frame. If the size has a width or height of 0, then
* the frame size has no minimum in that direction.
* \since QGIS 2.5
* @see fixedFrameSize
* @see recalculateFrameRects
* \see fixedFrameSize
* \see recalculateFrameRects
*/
virtual QSizeF minFrameSize( const int frameIndex = -1 ) const { Q_UNUSED( frameIndex ); return QSizeF( 0, 0 ); }
@ -102,7 +102,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
/** Adds a frame to the multiframe.
* \param frame frame to add
* \param recalcFrameSizes set to true to force recalculation of all existing frame sizes
* @see removeFrame
* \see removeFrame
*/
virtual void addFrame( QgsComposerFrame *frame, bool recalcFrameSizes = true ) = 0;
@ -118,25 +118,25 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* composition.
* \param i index of frame to remove
* \param removeEmptyPages set to true to remove pages which are empty after the frame is removed
* @see addFrame
* @see deleteFrames
* \see addFrame
* \see deleteFrames
*/
void removeFrame( int i, const bool removeEmptyPages = false );
/** Removes and deletes all child frames.
* @see removeFrame
* \see removeFrame
*/
void deleteFrames();
/** Sets the resize mode for the multiframe, and recalculates frame sizes to match.
* \param mode resize mode
* @see resizeMode
* \see resizeMode
*/
void setResizeMode( ResizeMode mode );
/** Returns the resize mode for the multiframe.
* \returns resize mode
* @see setResizeMode
* \see setResizeMode
*/
ResizeMode resizeMode() const { return mResizeMode; }
@ -145,7 +145,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \param elem is DOM element
* \param doc is the DOM document
* \param ignoreFrames set to false to avoid writing state information about child frames into DOM
* @see _writeXML
* \see _writeXML
*/
virtual bool writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const = 0;
@ -154,7 +154,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \param elem is DOM element
* \param doc is the DOM document
* \param ignoreFrames set to false to avoid writing state information about child frames into DOM
* @see writeXml
* \see writeXml
*/
bool _writeXml( QDomElement &elem, QDomDocument &doc, bool ignoreFrames = false ) const;
@ -163,7 +163,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \param itemElem is DOM element
* \param doc is the DOM document
* \param ignoreFrames set to false to avoid read state information about child frames from DOM
* @see _readXML
* \see _readXML
*/
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false ) = 0;
@ -172,7 +172,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \param itemElem is DOM element
* \param doc is the DOM document
* \param ignoreFrames set to false to avoid reading state information about child frames from DOM
* @see readXml
* \see readXml
*/
bool _readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false );
@ -183,13 +183,13 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
/** Returns whether undo commands should be created for interactions with the multiframe.
* \returns true if undo commands should be created
* @see setCreateUndoCommands
* \see setCreateUndoCommands
*/
bool createUndoCommands() const { return mCreateUndoCommands; }
/** Sets whether undo commands should be created for interactions with the multiframe.
* \param enabled set to true if undo commands should be created
* @see createUndoCommands
* \see createUndoCommands
*/
void setCreateUndoCommands( bool enabled ) { mCreateUndoCommands = enabled; }
@ -201,7 +201,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
/** Returns a child frame from the multiframe.
* \param i index of frame
* \returns child frame if found
* @see frameIndex
* \see frameIndex
*/
QgsComposerFrame *frame( int i ) const;
@ -209,7 +209,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* \param frame frame to find index of
* \returns index for frame if found, -1 if frame not found in multiframe
* \since QGIS 2.5
* @see frame
* \see frame
*/
int frameIndex( QgsComposerFrame *frame ) const;
@ -239,7 +239,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* component frames. If the resize mode is set to anything but UseExistingFrames then
* this may cause new frames to be added or frames to be removed, in order to fit
* the current size of the multiframe's content.
* @see recalculateFrameRects
* \see recalculateFrameRects
*/
virtual void recalculateFrameSizes();
@ -247,9 +247,9 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* method is useful for multiframes which implement a minFrameSize() or
* fixedFrameSize() method.
* \since QGIS 2.5
* @see minFrameSize()
* @see fixedFrameSize()
* @see recalculateFrameSizes
* \see minFrameSize()
* \see fixedFrameSize()
* \see recalculateFrameSizes
*/
void recalculateFrameRects();

30
src/core/composer/qgscomposerobject.h
View File

@ -132,29 +132,29 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
/** Returns a reference to the object's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setDataDefinedProperties()
* \see setDataDefinedProperties()
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/** Returns a reference to the object's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setDataDefinedProperties()
* \see setDataDefinedProperties()
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; }
/** Sets the objects's property collection, used for data defined overrides.
* \param collection property collection. Existing properties will be replaced.
* \since QGIS 3.0
* @see dataDefinedProperties()
* \see dataDefinedProperties()
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
/** Set a custom property for the object.
* \param key property key. If a property with the same key already exists it will be overwritten.
* \param value property value
* @see customProperty()
* @see removeCustomProperty()
* @see customProperties()
* \see customProperty()
* \see removeCustomProperty()
* \see customProperties()
* \since QGIS 2.12
*/
void setCustomProperty( const QString &key, const QVariant &value );
@ -163,26 +163,26 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
* \param key property key
* \param defaultValue default value to return if property with matching key does not exist
* \returns value of matching property
* @see setCustomProperty()
* @see removeCustomProperty()
* @see customProperties()
* \see setCustomProperty()
* \see removeCustomProperty()
* \see customProperties()
* \since QGIS 2.12
*/
QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const;
/** Remove a custom property from the object.
* \param key property key
* @see setCustomProperty()
* @see customProperty()
* @see customProperties()
* \see setCustomProperty()
* \see customProperty()
* \see customProperties()
* \since QGIS 2.12
*/
void removeCustomProperty( const QString &key );
/** Return list of keys stored in custom properties for the object.
* @see setCustomProperty()
* @see customProperty()
* @see removeCustomProperty()
* \see setCustomProperty()
* \see customProperty()
* \see removeCustomProperty()
* \since QGIS 2.12
*/
QStringList customProperties() const;

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

@ -73,8 +73,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* picture source may override this value. The path can either be a local path
* or a remote (http) path.
* \param path path for the source image
* @see usePictureExpression
* @see picturePath
* \see usePictureExpression
* \see picturePath
* \since QGIS 2.5
*/
void setPicturePath( const QString &path );
@ -82,8 +82,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Returns the path of the source image. Data defined picture source may override
* this value. The path can either be a local path or a remote (http) path.
* \returns path for the source image
* @see usePictureExpression
* @see setPicturePath
* \see usePictureExpression
* \see setPicturePath
* \since QGIS 2.5
*/
QString picturePath() const;
@ -108,8 +108,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Returns the rotation used for drawing the picture within the item's frame
* \returns picture rotation in degrees
* \since QGIS 2.2
* @see setPictureRotation
* @see rotationMap
* \see setPictureRotation
* \see rotationMap
*/
double pictureRotation() const { return mPictureRotation; }
@ -118,8 +118,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* amount as the specified map object. This is useful especially for
* syncing north arrows with a map item.
* \param composerMapId composer map id to sync rotation with
* @see setPictureRotation
* @see rotationMap
* \see setPictureRotation
* \see rotationMap
*/
void setRotationMap( int composerMapId );
@ -127,46 +127,46 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* disabled. If this is set then the picture is rotated by the same amount
* as the specified map object.
* \returns id of map object
* @see setRotationMap
* @see useRotationMap
* \see setRotationMap
* \see useRotationMap
*/
int rotationMap() const;
/** True if the picture rotation is matched to a map item.
* \returns true if rotation map is in use
* @see rotationMap
* @see setRotationMap
* \see rotationMap
* \see setRotationMap
*/
bool useRotationMap() const { return mRotationMap; }
/**
* Returns the mode used to align the picture to a map's North.
* @see setNorthMode()
* @see northOffset()
* \see setNorthMode()
* \see northOffset()
* \since QGIS 2.18
*/
NorthMode northMode() const { return mNorthMode; }
/**
* Sets the mode used to align the picture to a map's North.
* @see northMode()
* @see setNorthOffset()
* \see northMode()
* \see setNorthOffset()
* \since QGIS 2.18
*/
void setNorthMode( NorthMode mode );
/**
* Returns the offset added to the picture's rotation from a map's North.
* @see setNorthOffset()
* @see northMode()
* \see setNorthOffset()
* \see northMode()
* \since QGIS 2.18
*/
double northOffset() const { return mNorthOffset; }
/**
* Sets the offset added to the picture's rotation from a map's North.
* @see northOffset()
* @see setNorthMode()
* \see northOffset()
* \see setNorthMode()
* \since QGIS 2.18
*/
void setNorthOffset( double offset );
@ -175,7 +175,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* item's frame.
* \returns resize mode of picture
* \since QGIS 2.3
* @see setResizeMode
* \see setResizeMode
*/
ResizeMode resizeMode() const { return mResizeMode; }
@ -183,7 +183,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* within the picture item's frame.
* \param anchor anchor point for picture
* \since QGIS 2.3
* @see pictureAnchor
* \see pictureAnchor
*/
void setPictureAnchor( QgsComposerItem::ItemPositionMode anchor );
@ -191,13 +191,13 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* within the picture item's frame.
* \returns anchor point for picture
* \since QGIS 2.3
* @see setPictureAnchor
* \see setPictureAnchor
*/
ItemPositionMode pictureAnchor() const { return mPictureAnchor; }
/** Returns the fill color used for parametrized SVG files.
* @see setSvgFillColor()
* @see svgStrokeColor()
* \see setSvgFillColor()
* \see svgStrokeColor()
* \since QGIS 2.14.1
*/
QColor svgFillColor() const { return mSvgFillColor; }
@ -206,15 +206,15 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* \param color fill color.
* \note this setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* @see svgFillColor()
* @see setSvgStrokeColor()
* \see svgFillColor()
* \see setSvgStrokeColor()
* \since QGIS 2.14.1
*/
void setSvgFillColor( const QColor &color );
/** Returns the stroke color used for parametrized SVG files.
* @see setSvgStrokeColor()
* @see svgFillColor()
* \see setSvgStrokeColor()
* \see svgFillColor()
* \since QGIS 2.14.1
*/
QColor svgStrokeColor() const { return mSvgStrokeColor; }
@ -223,15 +223,15 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* \param color stroke color.
* \note this setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* @see svgStrokelColor()
* @see setSvgFillColor()
* \see svgStrokelColor()
* \see setSvgFillColor()
* \since QGIS 2.14.1
*/
void setSvgStrokeColor( const QColor &color );
/** Returns the stroke width (in mm) used for parametrized SVG files.
* @see setSvgStrokeWidth()
* @see svgStrokeColor()
* \see setSvgStrokeWidth()
* \see svgStrokeColor()
* \since QGIS 2.14.1
*/
double svgStrokeWidth() const { return mSvgStrokeWidth; }
@ -240,8 +240,8 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* \param width stroke width in mm
* \note this setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* @see svgStrokeWidth()
* @see setSvgStrokeColor()
* \see svgStrokeWidth()
* \see setSvgStrokeColor()
* \since QGIS 2.14.1
*/
void setSvgStrokeWidth( double width );
@ -257,7 +257,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Sets the picture rotation within the item bounds. This does not affect
* the item's frame, only the way the picture is drawn within the item.
* \param r rotation in degrees clockwise
* @see pictureRotation
* \see pictureRotation
* \since QGIS 2.2
*/
virtual void setPictureRotation( double r );
@ -265,7 +265,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Sets the resize mode used for drawing the picture within the item bounds.
* \param mode ResizeMode to use for image file
* \since QGIS 2.3
* @see resizeMode
* \see resizeMode
*/
virtual void setResizeMode( ResizeMode mode );

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

@ -78,18 +78,18 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
void setNumUnitsPerSegment( double units );
/** Returns the size mode for scale bar segments.
* @see setSegmentSizeMode
* @see minBarWidth
* @see maxBarWidth
* \see setSegmentSizeMode
* \see minBarWidth
* \see maxBarWidth
* \since QGIS 2.9
*/
SegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; }
/** Sets the size mode for scale bar segments.
* \param mode size mode
* @see segmentSizeMode
* @see setMinBarWidth
* @see setMaxBarWidth
* \see segmentSizeMode
* \see setMinBarWidth
* \see setMaxBarWidth
* \since QGIS 2.9
*/
void setSegmentSizeMode( SegmentSizeMode mode );
@ -97,9 +97,9 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/** Returns the minimum size (in millimeters) for scale bar segments. This
* property is only effective if the @link segmentSizeMode @endlink is set
* to @link SegmentSizeFitWidth @endlink.
* @see segmentSizeMode
* @see setMinBarWidth
* @see maxBarWidth
* \see segmentSizeMode
* \see setMinBarWidth
* \see maxBarWidth
* \since QGIS 2.9
*/
double minBarWidth() const { return mMinBarWidth; }
@ -108,9 +108,9 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* property is only effective if the @link segmentSizeMode @endlink is set
* to @link SegmentSizeFitWidth @endlink.
* \param minWidth minimum width in millimeters
* @see minBarWidth
* @see setMaxBarWidth
* @see setSegmentSizeMode
* \see minBarWidth
* \see setMaxBarWidth
* \see setSegmentSizeMode
* \since QGIS 2.9
*/
void setMinBarWidth( double minWidth );
@ -118,9 +118,9 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/** Returns the maximum size (in millimeters) for scale bar segments. This
* property is only effective if the @link segmentSizeMode @endlink is set
* to @link SegmentSizeFitWidth @endlink.
* @see segmentSizeMode
* @see setMaxBarWidth
* @see minBarWidth
* \see segmentSizeMode
* \see setMaxBarWidth
* \see minBarWidth
* \since QGIS 2.9
*/
double maxBarWidth() const { return mMaxBarWidth; }
@ -129,9 +129,9 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* property is only effective if the @link segmentSizeMode @endlink is set
* to @link SegmentSizeFitWidth @endlink.
* \param maxWidth maximum width in millimeters
* @see minBarWidth
* @see setMaxBarWidth
* @see setSegmentSizeMode
* \see minBarWidth
* \see setMaxBarWidth
* \see setSegmentSizeMode
* \since QGIS 2.9
*/
void setMaxBarWidth( double maxWidth );
@ -147,90 +147,90 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/** Returns the color used for drawing text in the scalebar.
* \returns font color for scalebar.
* @see setFontColor
* @see font
* \see setFontColor
* \see font
*/
QColor fontColor() const {return mFontColor;}
/** Sets the color used for drawing text in the scalebar.
* \param c font color for scalebar.
* @see fontColor
* @see setFont
* \see fontColor
* \see setFont
*/
void setFontColor( const QColor &c ) {mFontColor = c;}
/** Returns the color used for fills in the scalebar.
* @see setFillColor()
* @see fillColor2()
* \see setFillColor()
* \see fillColor2()
* \since QGIS 3.0
*/
QColor fillColor() const {return mFillColor;}
/** Sets the color used for fills in the scalebar.
* @see fillColor()
* @see setFillColor2()
* \see fillColor()
* \see setFillColor2()
* \since QGIS 3.0
*/
void setFillColor( const QColor &color ) {mFillColor = color; mBrush.setColor( color ); }
/** Returns the secondary color used for fills in the scalebar.
* @see setFillColor2()
* @see fillColor()
* \see setFillColor2()
* \see fillColor()
* \since QGIS 3.0
*/
QColor fillColor2() const {return mFillColor2;}
/** Sets the secondary color used for fills in the scalebar.
* @see fillColor2()
* @see setFillColor2()
* \see fillColor2()
* \see setFillColor2()
* \since QGIS 3.0
*/
void setFillColor2( const QColor &color ) {mFillColor2 = color; mBrush2.setColor( color ); }
/** Returns the color used for lines in the scalebar.
* @see setLineColor()
* \see setLineColor()
* \since QGIS 3.0
*/
QColor lineColor() const {return mLineColor;}
/** Sets the color used for lines in the scalebar.
* @see lineColor()
* \see lineColor()
* \since QGIS 3.0
*/
void setLineColor( const QColor &color ) { mLineColor = color; mPen.setColor( mLineColor ); }
/** Returns the line width in millimeters for lines in the scalebar.
* @see setLineWidth()
* \see setLineWidth()
* \since QGIS 3.0
*/
double lineWidth() const {return mLineWidth;}
/** Sets the line width in millimeters for lines in the scalebar.
* @see lineWidth()
* \see lineWidth()
* \since QGIS 3.0
*/
void setLineWidth( double width ) { mLineWidth = width; mPen.setWidthF( width ); }
/** Returns the pen used for drawing the scalebar.
* \returns QPen used for drawing the scalebar outlines.
* @see setPen
* @see brush
* \see setPen
* \see brush
*/
QPen pen() const {return mPen;}
/** Returns the primary brush for the scalebar.
* \returns QBrush used for filling the scalebar
* @see setBrush
* @see brush2
* @see pen
* \see setBrush
* \see brush2
* \see pen
*/
QBrush brush() const {return mBrush;}
/** Returns the secondary brush for the scalebar. This is used for alternating color style scalebars, such
* as single and double box styles.
* \returns QBrush used for secondary color areas
* @see setBrush2
* @see brush
* \see setBrush2
* \see brush
*/
QBrush brush2() const {return mBrush2;}
@ -260,7 +260,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/** Returns the join style used for drawing lines in the scalebar
* \returns Join style for lines
* \since QGIS 2.3
* @see setLineJoinStyle
* \see setLineJoinStyle
*/
Qt::PenJoinStyle lineJoinStyle() const { return mLineJoinStyle; }
@ -268,14 +268,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* \param style Join style for lines
* \returns nothing
* \since QGIS 2.3
* @see lineJoinStyle
* \see lineJoinStyle
*/
void setLineJoinStyle( Qt::PenJoinStyle style );
/** Returns the cap style used for drawing lines in the scalebar
* \returns Cap style for lines
* \since QGIS 2.3
* @see setLineCapStyle
* \see setLineCapStyle
*/
Qt::PenCapStyle lineCapStyle() const { return mLineCapStyle; }
@ -283,7 +283,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* \param style Cap style for lines
* \returns nothing
* \since QGIS 2.3
* @see lineCapStyle
* \see lineCapStyle
*/
void setLineCapStyle( Qt::PenCapStyle style );

48
src/core/composer/qgscomposertablecolumn.h
View File

@ -44,28 +44,28 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* \param columnElem an existing QDomElement in which to store the column's properties.
* \param doc QDomDocument for the destination xml.
* \since QGIS 2.3
* @see readXml
* \see readXml
*/
virtual bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const;
/** Reads the column's properties from xml.
* \param columnElem a QDomElement holding the column's desired properties.
* \since QGIS 2.3
* @see writeXml
* \see writeXml
*/
virtual bool readXml( const QDomElement &columnElem );
/** Returns the width for a column.
* \returns column width in mm, or 0 if column width is automatically calculated.
* \since QGIS 2.5
* @see setWidth
* \see setWidth
*/
double width() const { return mWidth; }
/** Sets the width for a column.
* \param width column width in mm, or 0 if column width is to be automatically calculated.
* \since QGIS 2.5
* @see width
* \see width
*/
void setWidth( const double width ) { mWidth = width; }
@ -73,7 +73,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* header cell.
* \returns Heading for column.
* \since QGIS 2.3
* @see setHeading
* \see setHeading
*/
QString heading() const { return mHeading; }
@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* header cell.
* \param heading Heading for column.
* \since QGIS 2.3
* @see heading
* \see heading
*/
void setHeading( const QString &heading ) { mHeading = heading; }
@ -89,8 +89,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* used for drawing column values within cells.
* \returns horizontal alignment.
* \since QGIS 2.3
* @see setHAlignment
* @see vAlignment
* \see setHAlignment
* \see vAlignment
*/
Qt::AlignmentFlag hAlignment() const { return mHAlignment; }
@ -98,8 +98,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* used for drawing column values within cells.
* \param alignment horizontal alignment for cell.
* \since QGIS 2.3
* @see hAlignment
* @see setVAlignment
* \see hAlignment
* \see setVAlignment
*/
void setHAlignment( Qt::AlignmentFlag alignment ) { mHAlignment = alignment; }
@ -107,8 +107,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* used for drawing column values within cells.
* \returns vertical alignment.
* \since QGIS 2.12
* @see setVAlignment
* @see hAlignment
* \see setVAlignment
* \see hAlignment
*/
Qt::AlignmentFlag vAlignment() const { return mVAlignment; }
@ -116,8 +116,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* used for drawing column values within cells.
* \param alignment vertical alignment for cell.
* \since QGIS 2.12
* @see vAlignment
* @see setHAlignment
* \see vAlignment
* \see setHAlignment
*/
void setVAlignment( Qt::AlignmentFlag alignment ) { mVAlignment = alignment; }
@ -126,7 +126,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* \returns attribute name or expression text for column
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see setAttribute
* \see setAttribute
*/
QString attribute() const { return mAttribute; }
@ -135,7 +135,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* \param attribute attribute name or expression text for column
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see attribute
* \see attribute
*/
void setAttribute( const QString &attribute ) { mAttribute = attribute; }
@ -144,8 +144,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* \returns sort order for column
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see setSortOrder
* @see sortByRank
* \see setSortOrder
* \see sortByRank
*/
Qt::SortOrder sortOrder() const { return mSortOrder; }
@ -154,8 +154,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* \param sortOrder sort order for column
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see sortOrder
* @see setSortByRank
* \see sortOrder
* \see setSortByRank
*/
void setSortOrder( Qt::SortOrder sortOrder ) { mSortOrder = sortOrder; }
@ -168,8 +168,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* sorted.
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see setSortByRank
* @see sortOrder
* \see setSortByRank
* \see sortOrder
*/
int sortByRank() const { return mSortByRank; }
@ -182,8 +182,8 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* sorted.
* \since QGIS 2.3
* \note only applicable when used in a QgsComposerAttributeTable
* @see sortByRank
* @see setSortOrder
* \see sortByRank
* \see setSortOrder
*/
void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; }

172
src/core/composer/qgscomposertablev2.h
View File

@ -71,13 +71,13 @@ class CORE_EXPORT QgsComposerTableStyle
/** Writes the style's properties to XML for storage.
* \param styleElem an existing QDomElement in which to store the style's properties.
* \param doc QDomDocument for the destination XML.
* @see readXml
* \see readXml
*/
bool writeXml( QDomElement &styleElem, QDomDocument &doc ) const;
/** Reads the style's properties from XML.
* \param styleElem a QDomElement holding the style's desired properties.
* @see writeXml
* \see writeXml
*/
bool readXml( const QDomElement &styleElem );
@ -152,26 +152,26 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
/** Sets the margin distance between cell borders and their contents.
* \param margin margin for cell contents
* @see cellMargin
* \see cellMargin
*/
void setCellMargin( const double margin );
/** Returns the margin distance between cell borders and their contents.
* \returns margin for cell contents
* @see setCellMargin
* \see setCellMargin
*/
double cellMargin() const { return mCellMargin; }
/** Sets the behavior for empty tables with no content rows.
* \param mode behavior mode for empty tables
* @see emptyTableBehavior
* \see emptyTableBehavior
*/
void setEmptyTableBehavior( const EmptyTableMode mode );
/** Returns the behavior mode for empty tables. This property controls
* how the table is drawn if it contains no content rows.
* \returns behavior mode for empty tables
* @see setEmptyTableBehavior
* \see setEmptyTableBehavior
*/
EmptyTableMode emptyTableBehavior() const { return mEmptyTableMode; }
@ -179,8 +179,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* is displayed in the table body if the empty table behavior is
* set to ShowMessage
* \param message message to show for empty tables
* @see emptyTableMessage
* @see setEmptyTableBehavior
* \see emptyTableMessage
* \see setEmptyTableBehavior
*/
void setEmptyTableMessage( const QString &message );
@ -188,215 +188,215 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* is displayed in the table body if the empty table behavior is
* set to ShowMessage
* \returns message to show for empty tables
* @see setEmptyTableMessage
* @see emptyTableBehavior
* \see setEmptyTableMessage
* \see emptyTableBehavior
*/
QString emptyTableMessage() const { return mEmptyTableMessage; }
/** Sets whether empty rows should be drawn. Tables default to hiding empty rows.
* \param showEmpty set to true to show empty rows in the table
* @see showEmptyRows
* \see showEmptyRows
*/
void setShowEmptyRows( const bool showEmpty );
/** Returns whether empty rows are drawn in the table
* \returns true if empty rows are drawn
* @see setShowEmptyRows
* \see setShowEmptyRows
*/
bool showEmptyRows() const { return mShowEmptyRows; }
/** Sets the font used to draw header text in the table.
* \param font font for header cells
* @see headerFont
* @see setContentFont
* \see headerFont
* \see setContentFont
*/
void setHeaderFont( const QFont &font );
/** Returns the font used to draw header text in the table.
* \returns font for header cells
* @see setHeaderFont
* @see contentFont
* \see setHeaderFont
* \see contentFont
*/
QFont headerFont() const { return mHeaderFont; }
/** Sets the color used to draw header text in the table.
* \param color header text color
* @see headerFontColor
* @see setHeaderFont
* @see setContentFontColor
* \see headerFontColor
* \see setHeaderFont
* \see setContentFontColor
*/
void setHeaderFontColor( const QColor &color );
/** Returns the color used to draw header text in the table.
* \returns color for header text
* @see setHeaderFontColor
* @see headerFont
* @see contentFontColor
* \see setHeaderFontColor
* \see headerFont
* \see contentFontColor
*/
QColor headerFontColor() const { return mHeaderFontColor; }
/** Sets the horizontal alignment for table headers
* \param alignment Horizontal alignment for table header cells
* @see headerHAlignment
* \see headerHAlignment
*/
void setHeaderHAlignment( const HeaderHAlignment alignment );
/** Returns the horizontal alignment for table headers
* \returns Horizontal alignment for table header cells
* @see setHeaderHAlignment
* \see setHeaderHAlignment
*/
HeaderHAlignment headerHAlignment() const { return mHeaderHAlignment; }
/** Sets the display mode for headers in the table. This property controls
* if and where headers are shown in the table.
* \param mode display mode for headers
* @see headerMode
* \see headerMode
*/
void setHeaderMode( const HeaderMode mode );
/** Returns the display mode for headers in the table. This property controls
* if and where headers are shown in the table.
* \returns display mode for headers
* @see setHeaderMode
* \see setHeaderMode
*/
HeaderMode headerMode() const { return mHeaderMode; }
/** Sets the font used to draw text in table body cells.
* \param font font for table cells
* @see contentFont
* @see setHeaderFont
* \see contentFont
* \see setHeaderFont
*/
void setContentFont( const QFont &font );
/** Returns the font used to draw text in table body cells.
* \returns font for table cells
* @see setContentFont
* @see headerFont
* \see setContentFont
* \see headerFont
*/
QFont contentFont() const { return mContentFont; }
/** Sets the color used to draw text in table body cells.
* \param color table cell text color
* @see contentFontColor
* @see setContentFont
* @see setHeaderFontColor
* \see contentFontColor
* \see setContentFont
* \see setHeaderFontColor
*/
void setContentFontColor( const QColor &color );
/** Returns the color used to draw text in table body cells.
* \returns text color for table cells
* @see setContentFontColor
* @see contentFont
* @see headerFontColor
* \see setContentFontColor
* \see contentFont
* \see headerFontColor
*/
QColor contentFontColor() const { return mContentFontColor; }
/** Sets whether grid lines should be drawn in the table
* \param showGrid set to true to show grid lines
* @see showGrid
* @see setGridStrokeWidth
* @see setGridColor
* \see showGrid
* \see setGridStrokeWidth
* \see setGridColor
*/
void setShowGrid( const bool showGrid );
/** Returns whether grid lines are drawn in the table
* \returns true if grid lines are shown
* @see setShowGrid
* @see gridStrokeWidth
* @see gridColor
* \see setShowGrid
* \see gridStrokeWidth
* \see gridColor
*/
bool showGrid() const { return mShowGrid; }
/** Sets the width for grid lines in the table.
* \param width grid line width
* @see gridStrokeWidth
* @see setShowGrid
* @see setGridColor
* \see gridStrokeWidth
* \see setShowGrid
* \see setGridColor
*/
void setGridStrokeWidth( const double width );
/** Returns the width of grid lines in the table.
* \returns grid line width
* @see setGridStrokeWidth
* @see showGrid
* @see gridColor
* \see setGridStrokeWidth
* \see showGrid
* \see gridColor
*/
double gridStrokeWidth() const { return mGridStrokeWidth; }
/** Sets color used for grid lines in the table.
* \param color grid line color
* @see gridColor
* @see setShowGrid
* @see setGridStrokeWidth
* \see gridColor
* \see setShowGrid
* \see setGridStrokeWidth
*/
void setGridColor( const QColor &color );
/** Returns the color used for grid lines in the table.
* \returns grid line color
* @see setGridColor
* @see showGrid
* @see gridStrokeWidth
* \see setGridColor
* \see showGrid
* \see gridStrokeWidth
*/
QColor gridColor() const { return mGridColor; }
/** Sets whether the grid's horizontal lines should be drawn in the table
* \param horizontalGrid set to true to draw grid's horizontal lines
* @see setShowGrid
* @see setGridStrokeWidth
* @see setGridColor
* @see setVerticalGrid
* \see setShowGrid
* \see setGridStrokeWidth
* \see setGridColor
* \see setVerticalGrid
* \since QGIS 3.0
*/
void setHorizontalGrid( const bool horizontalGrid );
/** Returns whether the grid's horizontal lines are drawn in the table
* \returns true if grid's horizontal lines are drawn
* @see setShowGrid
* @see setGridStrokeWidth
* @see setGridColor
* @see setVerticalGrid
* \see setShowGrid
* \see setGridStrokeWidth
* \see setGridColor
* \see setVerticalGrid
* \since QGIS 3.0
*/
bool horizontalGrid() const { return mHorizontalGrid; }
/** Sets whether the grid's vertical lines should be drawn in the table
* \param verticalGrid set to true to draw grid's vertical lines
* @see setShowGrid
* @see setGridStrokeWidth
* @see setGridColor
* @see setHorizontalGrid
* \see setShowGrid
* \see setGridStrokeWidth
* \see setGridColor
* \see setHorizontalGrid
* \since QGIS 3.0
*/
void setVerticalGrid( const bool verticalGrid );
/** Returns whether the grid's vertical lines are drawn in the table
* \returns true if grid's vertical lines are drawn
* @see setShowGrid
* @see setGridStrokeWidth
* @see setGridColor
* @see setHorizontalGrid
* \see setShowGrid
* \see setGridStrokeWidth
* \see setGridColor
* \see setHorizontalGrid
* \since QGIS 3.0
*/
bool verticalGrid() const { return mVerticalGrid; }
/** Sets color used for background of table.
* \param color table background color
* @see backgroundColor
* @see setGridColor
* \see backgroundColor
* \see setGridColor
*/
void setBackgroundColor( const QColor &color );
/** Returns the color used for the background of the table.
* \returns table background color
* @see setBackgroundColor
* @see gridColor
* \see setBackgroundColor
* \see gridColor
*/
QColor backgroundColor() const { return mBackgroundColor; }
/** Sets the wrap behavior for the table, which controls how text within cells is
* automatically wrapped.
* \param behavior wrap behavior
* @see wrapBehavior
* \see wrapBehavior
* \since QGIS 2.12
*/
void setWrapBehavior( WrapBehavior behavior );
@ -404,35 +404,35 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
/** Returns the wrap behavior for the table, which controls how text within cells is
* automatically wrapped.
* \returns current wrap behavior
* @see setWrapBehavior
* \see setWrapBehavior
* \since QGIS 2.12
*/
WrapBehavior wrapBehavior() const { return mWrapBehavior; }
/** Returns a pointer to the list of QgsComposerTableColumns shown in the table
* \returns pointer to list of columns in table
* @see setColumns
* \see setColumns
*/
QgsComposerTableColumns *columns() { return &mColumns; }
/** Replaces the columns in the table with a specified list of QgsComposerTableColumns.
* \param columns list of QgsComposerTableColumns to show in table. Ownership of columns
* is transferred to the table.
* @see columns
* \see columns
*/
void setColumns( const QgsComposerTableColumns &columns );
/** Sets the cell style for a cell group.
* \param group group to set style for
* \param style new cell style
* @see cellStyle()
* \see cellStyle()
* \since QGIS 2.12
*/
void setCellStyle( CellStyleGroup group, const QgsComposerTableStyle &style );
/** Returns the cell style for a cell group.
* \param group group to retrieve style for
* @see setCellStyle()
* \see setCellStyle()
* \since QGIS 2.12
*/
const QgsComposerTableStyle *cellStyle( CellStyleGroup group ) const;
@ -472,7 +472,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
/** Refreshes the contents shown in the table by querying for new data.
* This also causes the column widths and size of the table to change to accommodate the
* new data.
* @see adjustFrameToSize
* \see adjustFrameToSize
*/
virtual void refreshAttributes();
@ -556,14 +556,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
/** Returns total width of table contents.
* \returns table width
* @see totalHeight
* \see totalHeight
*/
//not const, as needs to call calculateMaxColumnWidths()
double totalWidth();
/** Returns total height of table contents.
* \returns total height
* @see totalWidth
* \see totalWidth
*/
//not const, as needs to call calculateMaxRowHeights()
double totalHeight();
@ -605,7 +605,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* \param lastRow index corresponding to last row shown in frame. If greater than the number of content rows in the
* table, then the default row height will be used for the remaining rows.
* \param drawHeaderLines set to true to include for the table header
* @see drawVerticalGridLines
* \see drawVerticalGridLines
* \since QGIS 2.12
*/
void drawHorizontalGridLines( QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines ) const;
@ -620,8 +620,8 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* \param hasHeader set to true if table frame includes header cells
* \param mergeCells set to true to merge table content cells
* \note not available in Python bindings
* @see drawVerticalGridLines
* @see calculateMaxColumnWidths
* \see drawVerticalGridLines
* \see calculateMaxColumnWidths
* \note not available in Python bindings
* \since QGIS 2.12
*/

2
src/core/composer/qgscomposertexttable.h
View File

@ -44,7 +44,7 @@ class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2
/** Sets the contents of the text table.
* \param contents list of table rows
* @see addRow
* \see addRow
*/
void setContents( const QList< QStringList > &contents );

60
src/core/composer/qgscomposerutils.h
View File

@ -60,7 +60,7 @@ class CORE_EXPORT QgsComposerUtils
/** Ensures that an angle is in the range 0 <= angle < 360
* \param angle angle in degrees
* \returns equivalent angle within the range [0, 360)
* @see snappedAngle
* \see snappedAngle
*/
static double normalizedAngle( const double angle );
@ -81,13 +81,13 @@ class CORE_EXPORT QgsComposerUtils
/** Returns the size in mm corresponding to a font point size
* \param pointSize font size in points
* @see mmToPoints
* \see mmToPoints
*/
static double pointsToMM( const double pointSize );
/** Returns the size in mm corresponding to a font point size
* \param mmSize font size in mm
* @see pointsToMM
* \see pointsToMM
*/
static double mmToPoints( const double mmSize );
@ -127,15 +127,15 @@ class CORE_EXPORT QgsComposerUtils
/** Reads all pre 3.0 data defined properties from an XML element.
* \since QGIS 3.0
* @see readDataDefinedProperty
* @see writeDataDefinedPropertyMap
* \see readDataDefinedProperty
* \see writeDataDefinedPropertyMap
*/
static void readOldDataDefinedPropertyMap( const QDomElement &itemElem,
QgsPropertyCollection &dataDefinedProperties );
/** Reads a pre 3.0 data defined property from an XML DOM element.
* \since QGIS 3.0
* @see readDataDefinedPropertyMap
* \see readDataDefinedPropertyMap
*/
static QgsProperty readOldDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property, const QDomElement &ddElem );
@ -151,10 +151,10 @@ class CORE_EXPORT QgsComposerUtils
* \param font input font
* \returns font ascent in millimeters
* \since QGIS 2.5
* @see fontDescentMM
* @see fontHeightMM
* @see fontHeightCharacterMM
* @see textWidthMM
* \see fontDescentMM
* \see fontHeightMM
* \see fontHeightCharacterMM
* \see textWidthMM
*/
static double fontAscentMM( const QFont &font );
@ -162,10 +162,10 @@ class CORE_EXPORT QgsComposerUtils
* \param font input font
* \returns font descent in millimeters
* \since QGIS 2.5
* @see fontAscentMM
* @see fontHeightMM
* @see fontHeightCharacterMM
* @see textWidthMM
* \see fontAscentMM
* \see fontHeightMM
* \see fontHeightCharacterMM
* \see textWidthMM
*/
static double fontDescentMM( const QFont &font );
@ -174,10 +174,10 @@ class CORE_EXPORT QgsComposerUtils
* \param font input font
* \returns font height in millimeters
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightCharacterMM
* @see textWidthMM
* \see fontAscentMM
* \see fontDescentMM
* \see fontHeightCharacterMM
* \see textWidthMM
*/
static double fontHeightMM( const QFont &font );
@ -187,10 +187,10 @@ class CORE_EXPORT QgsComposerUtils
* \param character character to calculate height for
* \returns character height in millimeters
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightMM
* @see textWidthMM
* \see fontAscentMM
* \see fontDescentMM
* \see fontHeightMM
* \see textWidthMM
*/
static double fontHeightCharacterMM( const QFont &font, QChar character );
@ -200,11 +200,11 @@ class CORE_EXPORT QgsComposerUtils
* \param text string to calculate width of
* \returns string width in millimeters
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightMM
* @see fontHeightCharacterMM
* @see textHeightMM
* \see fontAscentMM
* \see fontDescentMM
* \see fontHeightMM
* \see fontHeightCharacterMM
* \see textHeightMM
*/
static double textWidthMM( const QFont &font, const QString &text );
@ -216,7 +216,7 @@ class CORE_EXPORT QgsComposerUtils
* \param multiLineHeight line spacing factor
* \returns string height in millimeters
* \since QGIS 2.12
* @see textWidthMM
* \see textWidthMM
*/
static double textHeightMM( const QFont &font, const QString &text, double multiLineHeight = 1.0 );
@ -251,7 +251,7 @@ class CORE_EXPORT QgsComposerUtils
* target map. If the \a dpi argument is not specified then the dpi will be taken from the destinatation
* painter device.
* \since QGIS 3.0
* @see createRenderContextForComposition()
* \see createRenderContextForComposition()
*/
static QgsRenderContext createRenderContextForMap( QgsComposerMap *map, QPainter *painter, double dpi = -1 );
@ -260,7 +260,7 @@ class CORE_EXPORT QgsComposerUtils
* This method returns a new QgsRenderContext which matches the scale and settings from the composition's
* QgsComposition::referenceMap().
* \since QGIS 3.0
* @see createRenderContextForMap()
* \see createRenderContextForMap()
*/
static QgsRenderContext createRenderContextForComposition( QgsComposition *composition, QPainter *painter );

122
src/core/composer/qgscomposition.h
View File

@ -131,14 +131,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/**
* Returns the composition's name.
* @see setName()
* \see setName()
* \since QGIS 3.0
*/
QString name() const { return mName; }
/**
* Sets the composition's name.
* @see name()
* \see name()
* \since QGIS 3.0
*/
void setName( const QString &name );
@ -148,23 +148,23 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param height page height in mm
* \param keepRelativeItemPosition if true, all items and guides will be moved so that they retain
* their same relative position to the top left corner of their current page.
* @see paperHeight
* @see paperWidth
* \see paperHeight
* \see paperWidth
*/
void setPaperSize( double width, double height,
bool keepRelativeItemPosition = true );
/** Height of paper item
* \returns height in mm
* @see paperWidth
* @see setPaperSize
* \see paperWidth
* \see setPaperSize
*/
double paperHeight() const;
/** Width of paper item
* \returns width in mm
* @see paperHeight
* @see setPaperSize
* \see paperHeight
* \see setPaperSize
*/
double paperWidth() const;
@ -178,8 +178,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param marginBottom bottom margin (millimeters)
* \param marginLeft left margin (millimeters)
* \since QGIS 2.12
* @see setResizeToContentsMargins()
* @see resizeToContentsMargins()
* \see setResizeToContentsMargins()
* \see resizeToContentsMargins()
*/
void resizePageToContents( double marginTop = 0.0, double marginRight = 0.0,
double marginBottom = 0.0, double marginLeft = 0.0 );
@ -191,8 +191,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param marginBottom bottom margin (millimeters)
* \param marginLeft left margin (millimeters)
* \since QGIS 2.12
* @see resizePageToContents()
* @see resizeToContentsMargins()
* \see resizePageToContents()
* \see resizeToContentsMargins()
*/
void setResizeToContentsMargins( double marginTop, double marginRight,
double marginBottom, double marginLeft );
@ -204,8 +204,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param marginBottom reference for bottom margin (millimeters)
* \param marginLeft reference for left margin (millimeters)
* \since QGIS 2.12
* @see resizePageToContents()
* @see setResizeToContentsMargins()
* \see resizePageToContents()
* \see setResizeToContentsMargins()
*/
void resizeToContentsMargins( double &marginTop, double &marginRight,
double &marginBottom, double &marginLeft ) const;
@ -217,13 +217,13 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Sets the number of pages for the composition.
* \param pages number of pages
* @see numPages
* \see numPages
*/
void setNumPages( const int pages );
/** Returns the number of pages in the composition.
* \returns number of pages
* @see setNumPages
* \see setNumPages
*/
int numPages() const;
@ -232,9 +232,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param page page number, starting with 1
* \returns true if page is empty
* \since QGIS 2.5
* @see numPages
* @see setNumPages
* @see shouldExportPage
* \see numPages
* \see setNumPages
* \see shouldExportPage
*/
bool pageIsEmpty( const int page ) const;
@ -242,8 +242,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param page page number, starting with 1
* \returns true if page should be exported
* \since QGIS 2.5
* @see numPages
* @see pageIsEmpty
* \see numPages
* \see pageIsEmpty
*/
bool shouldExportPage( const int page ) const;
@ -293,7 +293,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* will also prevent them from being rendered in composition exports.
* \param visible set to true to show pages, false to hide pages
* \since QGIS 2.12
* @see pagesVisible()
* \see pagesVisible()
*/
void setPagesVisible( bool visible );
@ -301,7 +301,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* effects both display of the page boundaries in composer views and
* whether they will be rendered in composition exports.
* \since QGIS 2.12
* @see setPagesVisible()
* \see setPagesVisible()
*/
bool pagesVisible() const { return mPagesVisible; }
@ -326,7 +326,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Sets the snap tolerance to use when automatically snapping items during movement and resizing to guides
* and the edges and centers of other items.
* \param snapTolerance snap tolerance in pixels
* @see alignmentSnapTolerance
* \see alignmentSnapTolerance
* \since QGIS 2.5
*/
void setSnapTolerance( const int snapTolerance ) { mSnapTolerance = snapTolerance; }
@ -334,21 +334,21 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns the snap tolerance to use when automatically snapping items during movement and resizing to guides
* and the edges and centers of other items.
* \returns snap tolerance in pixels
* @see setAlignmentSnapTolerance
* \see setAlignmentSnapTolerance
* \since QGIS 2.5
*/
int snapTolerance() const { return mSnapTolerance; }
/** Sets whether selection bounding boxes should be shown in the composition
* \param boundsVisible set to true to show selection bounding box
* @see boundingBoxesVisible
* \see boundingBoxesVisible
* \since QGIS 2.7
*/
void setBoundingBoxesVisible( const bool boundsVisible );
/** Returns whether selection bounding boxes should be shown in the composition
* \returns true if selection bounding boxes should be shown
* @see setBoundingBoxesVisible
* \see setBoundingBoxesVisible
* \since QGIS 2.7
*/
bool boundingBoxesVisible() const { return mBoundingBoxesVisible; }
@ -427,32 +427,32 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns true if the composition will generate corresponding world files when pages
* are exported.
* @see setGenerateWorldFile()
* @see referenceMap()
* \see setGenerateWorldFile()
* \see referenceMap()
*/
bool generateWorldFile() const { return mGenerateWorldFile; }
/** Sets whether the composition will generate corresponding world files when pages
* are exported.
* \param enabled set to true to generate world files
* @see generateWorldFile()
* @see setReferenceMap()
* \see generateWorldFile()
* \see setReferenceMap()
*/
void setGenerateWorldFile( bool enabled ) { mGenerateWorldFile = enabled; }
/** Returns the map item which will be used to generate corresponding world files when the
* composition is exported. If no map was explicitly set via setReferenceMap(), the largest
* map in the composition will be returned (or nullptr if there are no maps in the composition).
* @see setReferenceMap()
* @see generateWorldFile()
* \see setReferenceMap()
* \see generateWorldFile()
*/
QgsComposerMap *referenceMap() const;
/** Sets the map item which will be used to generate corresponding world files when the
* composition is exported.
* \param map composer map item
* @see referenceMap()
* @see setGenerateWorldFile()
* \see referenceMap()
* \see setGenerateWorldFile()
*/
void setReferenceMap( QgsComposerMap *map );
@ -664,8 +664,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param dpi optional dpi override, or 0 to use default composition print resolution. This
* parameter has no effect if imageSize is specified.
* \returns rendered image, or null image if image does not fit into available memory
* @see renderRectAsRaster()
* @see renderPage()
* \see renderRectAsRaster()
* \see renderPage()
*/
QImage printPageAsRaster( int page, QSize imageSize = QSize(), int dpi = 0 );
@ -679,16 +679,16 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* parameter has no effect if imageSize is specified.
* \returns rendered image, or null image if image does not fit into available memory
* \since QGIS 2.12
* @see printPageAsRaster()
* @see renderRect()
* \see printPageAsRaster()
* \see renderRect()
*/
QImage renderRectAsRaster( const QRectF &rect, QSize imageSize = QSize(), int dpi = 0 );
/** Renders a full page to a paint device.
* \param p destination painter
* \param page page number, 0 based such that the first page is page 0
* @see renderRect()
* @see printPageAsRaster()
* \see renderRect()
* \see printPageAsRaster()
*/
void renderPage( QPainter *p, int page );
@ -697,8 +697,8 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param p destination painter
* \param rect region of composition to render
* \since QGIS 2.12
* @see renderPage()
* @see renderRectAsRaster()
* \see renderPage()
* \see renderRectAsRaster()
*/
void renderRect( QPainter *p, const QRectF &rect );
@ -735,14 +735,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns the current atlas mode of the composition
* \returns current atlas mode
* @see setAtlasMode
* \see setAtlasMode
*/
QgsComposition::AtlasMode atlasMode() const { return mAtlasMode; }
/** Sets the current atlas mode of the composition.
* \param mode atlas mode to switch to
* \returns false if the mode could not be changed.
* @see atlasMode
* \see atlasMode
*/
bool setAtlasMode( const QgsComposition::AtlasMode mode );
@ -761,9 +761,9 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Set a custom property for the composition.
* \param key property key. If a property with the same key already exists it will be overwritten.
* \param value property value
* @see customProperty()
* @see removeCustomProperty()
* @see customProperties()
* \see customProperty()
* \see removeCustomProperty()
* \see customProperties()
* \since QGIS 2.12
*/
void setCustomProperty( const QString &key, const QVariant &value );
@ -772,26 +772,26 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* \param key property key
* \param defaultValue default value to return if property with matching key does not exist
* \returns value of matching property
* @see setCustomProperty()
* @see removeCustomProperty()
* @see customProperties()
* \see setCustomProperty()
* \see removeCustomProperty()
* \see customProperties()
* \since QGIS 2.12
*/
QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const;
/** Remove a custom property from the composition.
* \param key property key
* @see setCustomProperty()
* @see customProperty()
* @see customProperties()
* \see setCustomProperty()
* \see customProperty()
* \see customProperties()
* \since QGIS 2.12
*/
void removeCustomProperty( const QString &key );
/** Return list of keys stored in custom properties for composition.
* @see setCustomProperty()
* @see customProperty()
* @see removeCustomProperty()
* \see setCustomProperty()
* \see customProperty()
* \see removeCustomProperty()
* \since QGIS 2.12
*/
QStringList customProperties() const;
@ -853,20 +853,20 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns a reference to the composition's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setDataDefinedProperties()
* \see setDataDefinedProperties()
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/** Returns a reference to the composition's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setDataDefinedProperties()
* \see setDataDefinedProperties()
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; }
/** Sets the composition's property collection, used for data defined overrides.
* \param collection property collection. Existing properties will be replaced.
* \since QGIS 3.0
* @see dataDefinedProperties()
* \see dataDefinedProperties()
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
@ -1015,7 +1015,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/**
* Emitted when the composition's name is changed.
* \since QGIS 3.0
* @see setName()
* \see setName()
*/
void nameChanged( const QString &name );

2
src/core/composer/qgsgroupungroupitemscommand.h
View File

@ -45,7 +45,7 @@ class CORE_EXPORT QgsGroupUngroupItemsCommand: public QObject, public QUndoComma
/** Create a group or ungroup command
*
* \param s command kind (@see State)
* \param s command kind (\see State)
* \param item the group item being created or ungrouped
* \param c the composition including this group
* \param text command label

18
src/core/composer/qgslayoutmanager.h
View File

@ -54,8 +54,8 @@ class CORE_EXPORT QgsLayoutManager : public QObject
* Adds a composition to the manager. Ownership of the composition is transferred to the manager.
* Returns true if the addition was successful, or false if the composition could not be added (eg
* as a result of a duplicate composition name).
* @see removeComposition()
* @see compositionAdded()
* \see removeComposition()
* \see compositionAdded()
*/
bool addComposition( QgsComposition *composition );
@ -63,16 +63,16 @@ class CORE_EXPORT QgsLayoutManager : public QObject
* Removes a composition from the manager. The composition is deleted.
* Returns true if the removal was successful, or false if the removal failed (eg as a result
* of removing a composition which is not contained in the manager).
* @see addComposition()
* @see compositionRemoved()
* @see compositionAboutToBeRemoved()
* @see clear()
* \see addComposition()
* \see compositionRemoved()
* \see compositionAboutToBeRemoved()
* \see clear()
*/
bool removeComposition( QgsComposition *composition );
/**
* Removes and deletes all compositions from the manager.
* @see removeComposition()
* \see removeComposition()
*/
void clear();
@ -90,13 +90,13 @@ class CORE_EXPORT QgsLayoutManager : public QObject
/**
* Reads the manager's state from a DOM element, restoring all compositions
* present in the XML document.
* @see writeXml()
* \see writeXml()
*/
bool readXml( const QDomElement &element, const QDomDocument &doc );
/**
* Returns a DOM element representing the state of the manager.
* @see readXml()
* \see readXml()
*/
QDomElement writeXml( QDomDocument &doc ) const;

18
src/core/dxf/qgsdxfexport.h
View File

@ -64,7 +64,7 @@ class CORE_EXPORT QgsDxfExport
/**
* Add layers to export
* \param layers list of layers and corresponding attribute indexes that determine the layer name (-1 for original layer name or title)
* @see setLayerTitleAsName
* \see setLayerTitleAsName
*/
void addLayers( const QList< QPair<QgsVectorLayer *, int > > &layers );
@ -85,7 +85,7 @@ class CORE_EXPORT QgsDxfExport
/**
* Retrieve reference scale for output
* \returns reference scale
* @see setSymbologyScaleDenominator
* \see setSymbologyScaleDenominator
*/
double symbologyScaleDenominator() const { return mSymbologyScaleDenominator; }
@ -97,14 +97,14 @@ class CORE_EXPORT QgsDxfExport
/**
* Set destination CRS
* @see destinationCrs()
* \see destinationCrs()
* \since QGIS 3.0
*/
void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
/**
* Returns the destination CRS, or an invalid CRS if no reprojection will be done.
* @see setDestinationCrs()
* \see setDestinationCrs()
* \since QGIS 3.0
*/
QgsCoordinateReferenceSystem destinationCrs() const;
@ -118,7 +118,7 @@ class CORE_EXPORT QgsDxfExport
/**
* Get symbology export mode
* \returns mode
* @see setSymbologyExport
* \see setSymbologyExport
*/
SymbologyExport symbologyExport() const { return mSymbologyExport; }
@ -131,7 +131,7 @@ class CORE_EXPORT QgsDxfExport
/**
* Get extent of area to export
* \returns area to export
* @see setExtent
* \see setExtent
*/
QgsRectangle extent() const { return mExtent; }
@ -139,14 +139,14 @@ class CORE_EXPORT QgsDxfExport
* Enable use of title (where set) instead of layer name,
* when attribute index of corresponding layer index is -1
* \param layerTitleAsName flag
* @see addLayers
* \see addLayers
*/
void setLayerTitleAsName( bool layerTitleAsName ) { mLayerTitleAsName = layerTitleAsName; }
/**
* Retrieve whether layer title (where set) instead of name shall be use
* \returns flag
* @see setLayerTitleAsName
* \see setLayerTitleAsName
*/
bool layerTitleAsName() { return mLayerTitleAsName; }
@ -168,7 +168,7 @@ class CORE_EXPORT QgsDxfExport
* Get name for layer respecting the use layer title as layer name mode
* \param vl the vector layer
* \returns name of layer
* @see setLayerTitleAsName
* \see setLayerTitleAsName
*/
QString layerName( QgsVectorLayer *vl ) const;

20
src/core/effects/qgsblureffect.h
View File

@ -58,56 +58,56 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
/** Sets blur level (strength)
* \param level blur level. Depending on the current @link blurMethod @endlink, this parameter
* has different effects
* @see blurLevel
* @see blurMethod
* \see blurLevel
* \see blurMethod
*/
void setBlurLevel( const int level ) { mBlurLevel = level; }
/** Returns the blur level (strength)
* \returns blur level. Depending on the current @link blurMethod @endlink, this parameter
* has different effects
* @see setBlurLevel
* @see blurMethod
* \see setBlurLevel
* \see blurMethod
*/
int blurLevel() const { return mBlurLevel; }
/** Sets the blur method (algorithm) to use for performing the blur.
* \param method blur method
* @see blurMethod
* \see blurMethod
*/
void setBlurMethod( const BlurMethod method ) { mBlurMethod = method; }
/** Returns the blur method (algorithm) used for performing the blur.
* \returns blur method
* @see setBlurMethod
* \see setBlurMethod
*/
BlurMethod blurMethod() const { return mBlurMethod; }
/** Sets the transparency for the effect
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency
* \see transparency
*/
void setTransparency( const double transparency ) { mTransparency = transparency; }
/** Returns the transparency for the effect
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency
* \see setTransparency
*/
double transparency() const { return mTransparency; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the effect on to a destination
* paint device
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the effect on to a destination
* paint device
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }

60
src/core/effects/qgscoloreffect.h
View File

@ -53,7 +53,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \param brightness Valid values are between -255 and 255, where 0 represents
* no change, negative values indicate darkening and positive values indicate
* lightening
* @see setBrightness
* \see setBrightness
*/
void setBrightness( int brightness ) { mBrightness = qBound( -255, brightness, 255 ); }
@ -61,7 +61,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \returns brightness value. Values are between -255 and 255, where 0 represents
* no change, negative values indicate darkening and positive values indicate
* lightening
* @see setBrightness
* \see setBrightness
*/
int brightness() const { return mBrightness; }
@ -69,7 +69,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \param contrast Valid values are between -100 and 100, where 0 represents
* no change, negative values indicate less contrast and positive values indicate
* greater contrast
* @see setContrast
* \see setContrast
*/
void setContrast( int contrast ) { mContrast = qBound( -100, contrast, 100 ); }
@ -77,7 +77,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \returns contrast value. Values are between -100 and 100, where 0 represents
* no change, negative values indicate less contrast and positive values indicate
* greater contrast
* @see setContrast
* \see setContrast
*/
int contrast() const { return mContrast; }
@ -85,7 +85,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \param saturation Valid values are between 0 and 2.0, where 1.0 represents
* no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
* greater saturation
* @see saturation
* \see saturation
*/
void setSaturation( double saturation ) { mSaturation = saturation; }
@ -93,99 +93,99 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
* \returns saturation value. Values are between 0 and 2.0, where 1.0 represents
* no change, 0.0 represents totally desaturated (grayscale), and positive values indicate
* greater saturation
* @see setSaturation
* \see setSaturation
*/
double saturation() const { return mSaturation; }
/** Sets whether the effect should convert a picture to grayscale.
* \param grayscaleMode method for grayscale conversion
* @see grayscaleMode
* \see grayscaleMode
*/
void setGrayscaleMode( QgsImageOperation::GrayscaleMode grayscaleMode ) { mGrayscaleMode = grayscaleMode; }
/** Returns whether the effect will convert a picture to grayscale.
* \returns method for grayscale conversion
* @see setGrayscaleMode
* \see setGrayscaleMode
*/
QgsImageOperation::GrayscaleMode grayscaleMode() const { return mGrayscaleMode; }
/** Sets whether the effect should colorize a picture.
* \param colorizeOn set to true to enable colorization
* @see colorizeOn
* @see setColorizeColor
* @see setColorizeStrength
* \see colorizeOn
* \see setColorizeColor
* \see setColorizeStrength
*/
void setColorizeOn( bool colorizeOn ) { mColorizeOn = colorizeOn; }
/** Returns whether the effect will colorize a picture.
* \returns true if colorization is enableds
* @see setColorizeOn
* @see colorizeColor
* @see colorizeStrength
* \see setColorizeOn
* \see colorizeColor
* \see colorizeStrength
*/
bool colorizeOn() const { return mColorizeOn; }
/** Sets the color used for colorizing a picture. This is only used if
* @link setColorizeOn @endlink is set to true.
* \param colorizeColor colorization color
* @see colorizeColor
* @see setColorizeOn
* @see setColorizeStrength
* \see colorizeColor
* \see setColorizeOn
* \see setColorizeStrength
*/
void setColorizeColor( const QColor &colorizeColor );
/** Returns the color used for colorizing a picture. This is only used if
* @link colorizeOn @endlink is set to true.
* \returns colorization color
* @see setColorizeColor
* @see colorizeOn
* @see colorizeStrength
* \see setColorizeColor
* \see colorizeOn
* \see colorizeStrength
*/
QColor colorizeColor() const { return mColorizeColor; }
/** Sets the strength for colorizing a picture. This is only used if
* @link setColorizeOn @endlink is set to true.
* \param colorizeStrength colorization strength, between 0 and 100
* @see colorizeStrength
* @see setColorizeOn
* @see setColorizeColor
* \see colorizeStrength
* \see setColorizeOn
* \see setColorizeColor
*/
void setColorizeStrength( int colorizeStrength ) { mColorizeStrength = colorizeStrength; }
/** Returns the strength used for colorizing a picture. This is only used if
* @link setColorizeOn @endlink is set to true.
* \returns colorization strength, between 0 and 100
* @see setColorizeStrengths
* @see colorizeOn
* @see colorizeColor
* \see setColorizeStrengths
* \see colorizeOn
* \see colorizeColor
*/
int colorizeStrength() const { return mColorizeStrength; }
/** Sets the transparency for the effect
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency
* \see transparency
*/
void setTransparency( const double transparency ) { mTransparency = transparency; }
/** Returns the transparency for the effect
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency
* \see setTransparency
*/
double transparency() const { return mTransparency; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the effect on to a destination
* paint device
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the effect on to a destination
* paint device
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }

4
src/core/effects/qgseffectstack.h
View File

@ -79,7 +79,7 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect
/** Appends an effect to the end of the stack.
* \param effect QgsPaintEffect to append. Ownership of the effect will be
* transferred to the stack object.
* @see insertEffect
* \see insertEffect
*/
void appendEffect( QgsPaintEffect *effect );
@ -87,7 +87,7 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect
* \param index position to insert the effect
* \param effect QgsPaintEffect to insert. Ownership of the effect will be
* transferred to the stack object.
* @see appendEffect
* \see appendEffect
*/
bool insertEffect( const int index, QgsPaintEffect *effect );

76
src/core/effects/qgsgloweffect.h
View File

@ -54,49 +54,49 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
/** Sets the spread distance for drawing the glow effect.
* \param spread spread distance. Units are specified via @link setSpreadUnit @endlink
* @see spread
* @see setSpreadUnit
* @see setSpreadMapUnitScale
* \see spread
* \see setSpreadUnit
* \see setSpreadMapUnitScale
*/
void setSpread( const double spread ) { mSpread = spread; }
/** Returns the spread distance used for drawing the glow effect.
* \returns spread distance. Units are retrieved via @link spreadUnit @endlink
* @see setSpread
* @see spreadUnit
* @see spreadMapUnitScale
* \see setSpread
* \see spreadUnit
* \see spreadMapUnitScale
*/
double spread() const { return mSpread; }
/** Sets the units used for the glow spread distance.
* \param unit units for spread distance
* @see spreadUnit
* @see setSpread
* @see setSpreadMapUnitScale
* \see spreadUnit
* \see setSpread
* \see setSpreadMapUnitScale
*/
void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; }
/** Returns the units used for the glow spread distance.
* \returns units for spread distance
* @see setSpreadUnit
* @see spread
* @see spreadMapUnitScale
* \see setSpreadUnit
* \see spread
* \see spreadMapUnitScale
*/
QgsUnitTypes::RenderUnit spreadUnit() const { return mSpreadUnit; }
/** Sets the map unit scale used for the spread distance.
* \param scale map unit scale for spread distance
* @see spreadMapUnitScale
* @see setSpread
* @see setSpreadUnit
* \see spreadMapUnitScale
* \see setSpread
* \see setSpreadUnit
*/
void setSpreadMapUnitScale( const QgsMapUnitScale &scale ) { mSpreadMapUnitScale = scale; }
/** Returns the map unit scale used for the spread distance.
* \returns map unit scale for spread distance
* @see setSpreadMapUnitScale
* @see spread
* @see spreadUnit
* \see setSpreadMapUnitScale
* \see spread
* \see spreadUnit
*/
const QgsMapUnitScale &spreadMapUnitScale() const { return mSpreadMapUnitScale; }
@ -104,28 +104,28 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
* output from the glow effect.
* \param level blur level. Values between 0 and 16 are valid, with larger
* values indicating greater blur strength.
* @see blurLevel
* \see blurLevel
*/
void setBlurLevel( const int level ) { mBlurLevel = level; }
/** Returns the blur level (strength) for the glow.
* \returns blur level. Value will be between 0 and 16, with larger
* values indicating greater blur strength.
* @see setBlurLevel
* \see setBlurLevel
*/
int blurLevel() const { return mBlurLevel; }
/** Sets the transparency for the effect
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency
* \see transparency
*/
void setTransparency( const double transparency ) { mTransparency = transparency; }
/** Returns the transparency for the effect
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency
* \see setTransparency
*/
double transparency() const { return mTransparency; }
@ -133,8 +133,8 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \param color glow color
* @see color
* @see setColorType
* \see color
* \see setColorType
*/
void setColor( const QColor &color ) { mColor = color; }
@ -142,38 +142,38 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
* is set to SingleColor. The glow will fade between the specified color and
* a totally transparent version of the color.
* \returns glow color
* @see setColor
* @see colorType
* \see setColor
* \see colorType
*/
QColor color() const { return mColor; }
/** Sets the color ramp for the glow. This only applies if the @link colorType @endlink
* is set to ColorRamp. The glow will utilize colors from the ramp.
* \param ramp color ramp for glow. Ownership of the ramp is transferred to the effect.
* @see ramp
* @see setColorType
* \see ramp
* \see setColorType
*/
void setRamp( QgsColorRamp *ramp );
/** Returns the color ramp used for the glow. This only applies if the @link colorType @endlink
* is set to ColorRamp. The glow will utilize colors from the ramp.
* \returns color ramp for glow
* @see setRamp
* @see colorType
* \see setRamp
* \see colorType
*/
QgsColorRamp *ramp() const { return mRamp; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the effect on to a destination
* paint device
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the effect on to a destination
* paint device
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }
@ -181,18 +181,18 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
* color ramp or by simply specificing a single color. setColorType is used to specify which mode to use
* for the glow.
* \param colorType color type to use for glow
* @see colorType
* @see setColor
* @see setRamp
* \see colorType
* \see setColor
* \see setRamp
*/
void setColorType( GlowColorType colorType ) { mColorType = colorType; }
/** Returns the color mode used for the glow. The glow can either be drawn using a QgsColorRamp
* color ramp or by specificing a single color.
* \returns current color mode used for the glow
* @see setColorType
* @see color
* @see ramp
* \see setColorType
* \see color
* \see ramp
*/
GlowColorType colorType() const { return mColorType; }

2
src/core/effects/qgsimageoperation.h
View File

@ -174,7 +174,7 @@ class CORE_EXPORT QgsImageOperation
* it will be centered in the returned rectangle.
* \param center return rectangle will be centered on the center of the original image if set to true
* \since QGIS 2.9
* @see cropTransparent
* \see cropTransparent
*/
static QRect nonTransparentImageRect( const QImage &image, QSize minSize = QSize(), bool center = false );

58
src/core/effects/qgspainteffect.h
View File

@ -55,7 +55,7 @@ class CORE_EXPORT QgsPaintEffect
/** Drawing modes for effects. These modes are used only when effects are
* drawn as part of an effects stack
* @see QgsEffectStack
* \see QgsEffectStack
*/
enum DrawMode
{
@ -81,15 +81,15 @@ class CORE_EXPORT QgsPaintEffect
/** Returns the properties describing the paint effect encoded in a
* string format.
* \returns string map of properties, in the form property key, value
* @see readProperties
* @see saveProperties
* \see readProperties
* \see saveProperties
*/
virtual QgsStringMap properties() const = 0;
/** Reads a string map of an effect's properties and restores the effect
* to the state described by the properties map.
* \param props effect properties encoded in a string map
* @see properties
* \see properties
*/
virtual void readProperties( const QgsStringMap &props ) = 0;
@ -99,21 +99,21 @@ class CORE_EXPORT QgsPaintEffect
* \param doc destination DOM document
* \param element destination DOM element
* \returns true if save was successful
* @see readProperties
* \see readProperties
*/
virtual bool saveProperties( QDomDocument &doc, QDomElement &element ) const;
/** Restores the effect to the state described by a DOM element.
* \param element DOM element describing an effect's state
* \returns true if read was successful
* @see saveProperties
* \see saveProperties
*/
virtual bool readProperties( const QDomElement &element );
/** Renders a picture using the effect.
* \param picture source QPicture to render
* \param context destination render context
* @see begin
* \see begin
*/
virtual void render( QPicture &picture, QgsRenderContext &context );
@ -121,41 +121,41 @@ class CORE_EXPORT QgsPaintEffect
* @link end @endlink member is called all intercepted paint operations will be
* drawn to the render context after being modified by the effect.
* \param context destination render context
* @see end
* @see render
* \see end
* \see render
*/
virtual void begin( QgsRenderContext &context );
/** Ends interception of paint operations to a render context, and draws the result
* to the render context after being modified by the effect.
* \param context destination render context
* @see begin
* \see begin
*/
virtual void end( QgsRenderContext &context );
/** Returns whether the effect is enabled
* \returns true if effect is enabled
* @see setEnabled
* \see setEnabled
*/
bool enabled() const { return mEnabled; }
/** Sets whether the effect is enabled
* \param enabled set to false to disable the effect
* @see enabled
* \see enabled
*/
void setEnabled( const bool enabled );
/** Returns the draw mode for the effect. This property only has an
* effect if the paint effect is used in a @link QgsEffectStack @endlink
* \returns draw mode for effect
* @see setDrawMode
* \see setDrawMode
*/
DrawMode drawMode() const { return mDrawMode; }
/** Sets the draw mode for the effect. This property only has an
* effect if the paint effect is used in a @link QgsEffectStack @endlink
* \param drawMode draw mode for effect
* @see drawMode
* \see drawMode
*/
void setDrawMode( const DrawMode drawMode );
@ -169,23 +169,23 @@ class CORE_EXPORT QgsPaintEffect
* Derived classes must reimplement this method to apply any transformations to
* the source QPicture and draw the result using the context's painter.
* \param context destination render context
* @see drawSource
* \see drawSource
*/
virtual void draw( QgsRenderContext &context ) = 0;
/** Draws the source QPicture onto the specified painter. Handles scaling of the picture
* to account for the destination painter's DPI.
* \param painter destination painter
* @see source
* @see sourceAsImage
* \see source
* \see sourceAsImage
*/
void drawSource( QPainter &painter );
/** Returns the source QPicture. The @link draw @endlink member can utilize this when
* drawing the effect.
* \returns source QPicture
* @see drawSource
* @see sourceAsImage
* \see drawSource
* \see sourceAsImage
*/
const QPicture *source() const { return mPicture; }
@ -194,10 +194,10 @@ class CORE_EXPORT QgsPaintEffect
* source QPicture by the results of the @link boundingRect @endlink method.
* The result is cached to speed up subsequent calls to sourceAsImage.
* \returns source QPicture rendered to an image
* @see drawSource
* @see source
* @see imageOffset
* @see boundingRect
* \see drawSource
* \see source
* \see imageOffset
* \see boundingRect
*/
QImage *sourceAsImage( QgsRenderContext &context );
@ -205,7 +205,7 @@ class CORE_EXPORT QgsPaintEffect
* render context.
* \param context destination render context
* \returns point offset for image top left corner
* @see sourceAsImage
* \see sourceAsImage
*/
QPointF imageOffset( const QgsRenderContext &context ) const;
@ -215,7 +215,7 @@ class CORE_EXPORT QgsPaintEffect
* \param rect original source bounding rect
* \param context destination render context
* \returns modified bounding rect
* @see sourceAsImage
* \see sourceAsImage
*/
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
@ -274,28 +274,28 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
/** Sets the transparency for the effect
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency
* \see transparency
*/
void setTransparency( const double transparency ) { mTransparency = transparency; }
/** Returns the transparency for the effect
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency
* \see setTransparency
*/
double transparency() const { return mTransparency; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the source on to a destination
* paint device
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the source on to a destination
* paint device
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }

16
src/core/effects/qgspainteffectregistry.h
View File

@ -48,13 +48,13 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata
/** Returns the unique string representing the paint effect class
* \returns unique string
* @see visibleName
* \see visibleName
*/
QString name() const { return mName; }
/** Returns the user visible string representing the paint effect class
* \returns friendly user visible string
* @see name
* \see name
*/
QString visibleName() const { return mVisibleName; }
@ -114,14 +114,14 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
/** Returns the paint effect properties widget creation function for the paint effect class
* \returns widget creation function
* \note not available in Python bindings
* @see setWidgetFunction
* \see setWidgetFunction
*/
QgsPaintEffectWidgetFunc widgetFunction() const { return mWidgetFunc; }
/** Sets the paint effect properties widget creation function for the paint effect class
* \param f widget creation function
* \note not available in Python bindings
* @see widgetFunction
* \see widgetFunction
*/
void setWidgetFunction( QgsPaintEffectWidgetFunc f ) { mWidgetFunc = f; }
@ -129,14 +129,14 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
* \param map string map of effect properties
* \returns new paint effect
* \note not available in Python bindings
* @see createWidget
* \see createWidget
*/
virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) override { return mCreateFunc ? mCreateFunc( map ) : nullptr; }
/** Creates a new paint effect properties widget for the metadata's effect class
* \returns effect properties widget
* \note not available in Python bindings
* @see createWidget
* \see createWidget
*/
virtual QgsPaintEffectWidget *createWidget() override { return mWidgetFunc ? mWidgetFunc() : nullptr; }
@ -204,7 +204,7 @@ class CORE_EXPORT QgsPaintEffectRegistry
* effects. All effects except the standard draw source effect are disabled,
* but are included so that they can be easily drawn just by enabling the effect.
* \returns default effects stack
* @see isDefaultStack()
* \see isDefaultStack()
*/
static QgsPaintEffect *defaultStack();
@ -212,7 +212,7 @@ class CORE_EXPORT QgsPaintEffectRegistry
* \param effect paint effect to test
* \returns true if effect is default stack
* \since QGIS 2.12
* @see defaultStack()
* \see defaultStack()
*/
static bool isDefaultStack( QgsPaintEffect *effect );

60
src/core/effects/qgsshadoweffect.h
View File

@ -43,116 +43,116 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
/** Sets blur level (strength) for the shadow.
* \param level blur level. Values between 0 and 16 are valid, with larger
* values indicating greater blur strength.
* @see blurLevel
* \see blurLevel
*/
void setBlurLevel( const int level ) { mBlurLevel = level; }
/** Returns the blur level (strength) for the shadow.
* \returns blur level. Value will be between 0 and 16, with larger
* values indicating greater blur strength.
* @see setBlurLevel
* \see setBlurLevel
*/
int blurLevel() const { return mBlurLevel; }
/** Sets the angle for offsetting the shadow.
* \param angle offset angle in degrees clockwise from North
* @see offsetAngle
* @see setOffsetDistance
* \see offsetAngle
* \see setOffsetDistance
*/
void setOffsetAngle( const int angle ) { mOffsetAngle = angle; }
/** Returns the angle used for offsetting the shadow.
* \returns offset angle in degrees clockwise from North
* @see setOffsetAngle
* @see offsetDistance
* \see setOffsetAngle
* \see offsetDistance
*/
int offsetAngle() const { return mOffsetAngle; }
/** Sets the distance for offsetting the shadow.
* \param distance offset distance. Units are specified via @link setOffsetUnit @endlink
* @see offsetDistance
* @see setOffsetUnit
* @see setOffsetMapUnitScale
* \see offsetDistance
* \see setOffsetUnit
* \see setOffsetMapUnitScale
*/
void setOffsetDistance( const double distance ) { mOffsetDist = distance; }
/** Returns the distance used for offsetting the shadow.
* \returns offset distance. Distance units are retrieved via @link offsetUnit @endlink
* @see setOffsetDistance
* @see offsetUnit
* @see offsetMapUnitScale
* \see setOffsetDistance
* \see offsetUnit
* \see offsetMapUnitScale
*/
double offsetDistance() const { return mOffsetDist; }
/** Sets the units used for the shadow offset distance.
* \param unit units for offset distance
* @see offsetUnit
* @see setOffsetDistance
* @see setOffsetMapUnitScale
* \see offsetUnit
* \see setOffsetDistance
* \see setOffsetMapUnitScale
*/
void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
/** Returns the units used for the shadow offset distance.
* \returns units for offset distance
* @see setOffsetUnit
* @see offsetDistance
* @see offsetMapUnitScale
* \see setOffsetUnit
* \see offsetDistance
* \see offsetMapUnitScale
*/
QgsUnitTypes::RenderUnit offsetUnit() const { return mOffsetUnit; }
/** Sets the map unit scale used for the shadow offset distance.
* \param scale map unit scale for offset distance
* @see offsetMapUnitScale
* @see setOffsetDistance
* @see setOffsetUnit
* \see offsetMapUnitScale
* \see setOffsetDistance
* \see setOffsetUnit
*/
void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
/** Returns the map unit scale used for the shadow offset distance.
* \returns map unit scale for offset distance
* @see setOffsetMapUnitScale
* @see offsetDistance
* @see offsetUnit
* \see setOffsetMapUnitScale
* \see offsetDistance
* \see offsetUnit
*/
const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
/** Sets the color for the shadow.
* \param color shadow color
* @see color
* \see color
*/
void setColor( const QColor &color ) { mColor = color; }
/** Returns the color used for the shadow.
* \returns shadow color
* @see setColor
* \see setColor
*/
QColor color() const { return mColor; }
/** Sets the transparency for the effect
* \param transparency double between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see transparency
* \see transparency
*/
void setTransparency( const double transparency ) { mTransparency = transparency; }
/** Returns the transparency for the effect
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
* and 1 is fully transparent
* @see setTransparency
* \see setTransparency
*/
double transparency() const { return mTransparency; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the effect on to a destination
* paint device
* @see blendMode
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the effect on to a destination
* paint device
* @see setBlendMode
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }

114
src/core/effects/qgstransformeffect.h
View File

@ -52,168 +52,168 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
/** Sets the transform x translation.
* \param translateX distance to translate along the x axis
* @see translateX
* @see setTranslateY
* @see setTranslateUnit
* @see setTranslateMapUnitScale
* \see translateX
* \see setTranslateY
* \see setTranslateUnit
* \see setTranslateMapUnitScale
*/
void setTranslateX( const double translateX ) { mTranslateX = translateX; }
/** Returns the transform x translation.
* \returns X distance translated along the x axis
* @see setTranslateX
* @see translateY
* @see translateUnit
* @see translateMapUnitScale
* \see setTranslateX
* \see translateY
* \see translateUnit
* \see translateMapUnitScale
*/
double translateX() const { return mTranslateX; }
/** Sets the transform y translation.
* \param translateY distance to translate along the y axis
* @see translateY
* @see setTranslateX
* @see setTranslateUnit
* @see setTranslateMapUnitScale
* \see translateY
* \see setTranslateX
* \see setTranslateUnit
* \see setTranslateMapUnitScale
*/
void setTranslateY( const double translateY ) { mTranslateY = translateY; }
/** Returns the transform y translation.
* \returns Y distance translated along the y axis
* @see setTranslateY
* @see translateX
* @see translateUnit
* @see translateMapUnitScale
* \see setTranslateY
* \see translateX
* \see translateUnit
* \see translateMapUnitScale
*/
double translateY() const { return mTranslateY; }
/** Sets the units used for the transform translation.
* \param unit units for translation
* @see translateUnit
* @see setTranslateX
* @see setTranslateY
* @see setTranslateMapUnitScale
* \see translateUnit
* \see setTranslateX
* \see setTranslateY
* \see setTranslateMapUnitScale
*/
void setTranslateUnit( const QgsUnitTypes::RenderUnit unit ) { mTranslateUnit = unit; }
/** Returns the units used for the transform translation.
* \returns units for translation
* @see setTranslateUnit
* @see translateX
* @see translateY
* @see translateMapUnitScale
* \see setTranslateUnit
* \see translateX
* \see translateY
* \see translateMapUnitScale
*/
QgsUnitTypes::RenderUnit translateUnit() const { return mTranslateUnit; }
/** Sets the map unit scale used for the transform translation.
* \param scale map unit scale for translation
* @see translateMapUnitScale
* @see setTranslateX
* @see setTranslateY
* @see setTranslateUnit
* \see translateMapUnitScale
* \see setTranslateX
* \see setTranslateY
* \see setTranslateUnit
*/
void setTranslateMapUnitScale( const QgsMapUnitScale &scale ) { mTranslateMapUnitScale = scale; }
/** Returns the map unit scale used for the transform translation.
* \returns map unit scale for translation
* @see setTranslateMapUnitScale
* @see translateX
* @see translateY
* @see translateUnit
* \see setTranslateMapUnitScale
* \see translateX
* \see translateY
* \see translateUnit
*/
const QgsMapUnitScale &translateMapUnitScale() const { return mTranslateMapUnitScale; }
/** Sets the x axis scaling factor.
* \param scaleX factor to scale x axis by, where 1.0 = no scaling
* @see scaleX
* @see setScaleY
* \see scaleX
* \see setScaleY
*/
void setScaleX( const double scaleX ) { mScaleX = scaleX; }
/** Returns the x axis scaling factor.
* \returns x axis scaling factor, where 1.0 = no scaling
* @see setScaleX
* @see scaleY
* \see setScaleX
* \see scaleY
*/
double scaleX() const { return mScaleX; }
/** Sets the y axis scaling factor.
* \param scaleY factor to scale y axis by, where 1.0 = no scaling
* @see scaleX
* \see scaleX
*/
void setScaleY( const double scaleY ) { mScaleY = scaleY; }
/** Returns the y axis scaling factor.
* \returns y axis scaling factor, where 1.0 = no scaling
* @see setScaleY
* @see scaleX
* \see setScaleY
* \see scaleX
*/
double scaleY() const { return mScaleY; }
/** Sets the transform rotation.
* \param rotation degrees to rotate, clockwise
* @see rotation
* \see rotation
*/
void setRotation( const double rotation ) { mRotation = rotation; }
/** Returns the transform rotation.
* \returns rotation in degrees clockwise
* @see setRotation
* \see setRotation
*/
double rotation() const { return mRotation; }
/** Sets the x axis shearing factor.
* \param shearX x axis shearing
* @see shearX
* @see setShearY
* \see shearX
* \see setShearY
*/
void setShearX( const double shearX ) { mShearX = shearX; }
/** Returns the x axis shearing factor.
* \returns x axis shearing
* @see setShearX
* @see shearY
* \see setShearX
* \see shearY
*/
double shearX() const { return mShearX; }
/** Sets the y axis shearing factor.
* \param shearY y axis shearing
* @see shearY
* @see setShearX
* \see shearY
* \see setShearX
*/
void setShearY( const double shearY ) { mShearY = shearY; }
/** Returns the y axis shearing factor.
* \returns y axis shearing
* @see setShearY
* @see shearX
* \see setShearY
* \see shearX
*/
double shearY() const { return mShearY; }
/** Sets whether to reflect along the x-axis
* \param reflectX true to reflect horizontally
* @see reflectX
* @see setReflectY
* \see reflectX
* \see setReflectY
*/
void setReflectX( const bool reflectX ) { mReflectX = reflectX; }
/** Returns whether transform will be reflected along the x-axis
* \returns true if transform will reflect horizontally
* @see setReflectX
* @see reflectY
* \see setReflectX
* \see reflectY
*/
bool reflectX() const { return mReflectX; }
/** Sets whether to reflect along the y-axis
* \param reflectY true to reflect horizontally
* @see reflectY
* @see setReflectX
* \see reflectY
* \see setReflectX
*/
void setReflectY( const bool reflectY ) { mReflectY = reflectY; }
/** Returns whether transform will be reflected along the y-axis
* \returns true if transform will reflect horizontally
* @see setReflectY
* @see reflectX
* \see setReflectY
* \see reflectX
*/
bool reflectY() const { return mReflectY; }

104
src/core/geometry/qgsabstractgeometry.h
View File

@ -79,30 +79,30 @@ class CORE_EXPORT QgsAbstractGeometry
//virtual int coordDim() const { return mCoordDimension; }
/** Returns a unique string representing the geometry type.
* @see wkbType
* @see wktTypeStr
* \see wkbType
* \see wktTypeStr
*/
virtual QString geometryType() const = 0;
/** Returns the WKB type of the geometry.
* @see geometryType
* @see wktTypeStr
* \see geometryType
* \see wktTypeStr
*/
QgsWkbTypes::Type wkbType() const { return mWkbType; }
/** Returns the WKT type string of the geometry.
* @see geometryType
* @see wkbType
* \see geometryType
* \see wkbType
*/
QString wktTypeStr() const;
/** Returns true if the geometry is 3D and contains a z-value.
* @see isMeasure
* \see isMeasure
*/
bool is3D() const;
/** Returns true if the geometry contains m values.
* @see is3D
* \see is3D
*/
bool isMeasure() const;
@ -127,32 +127,32 @@ class CORE_EXPORT QgsAbstractGeometry
/** Sets the geometry from a WKB string.
* After successful read the wkb argument will be at the position where the reading has stopped.
* @see fromWkt
* \see fromWkt
*/
virtual bool fromWkb( QgsConstWkbPtr &wkb ) = 0;
/** Sets the geometry from a WKT string.
* @see fromWkb
* \see fromWkb
*/
virtual bool fromWkt( const QString &wkt ) = 0;
//export
/** Returns a WKB representation of the geometry.
* @see asWkt
* @see asGML2
* @see asGML3
* @see asJSON
* \see asWkt
* \see asGML2
* \see asGML3
* \see asJSON
* \since QGIS 3.0
*/
virtual QByteArray asWkb() const = 0;
/** Returns a WKT representation of the geometry.
* \param precision number of decimal places for coordinates
* @see asWkb
* @see asGML2
* @see asGML3
* @see asJSON
* \see asWkb
* \see asGML2
* \see asGML3
* \see asJSON
*/
virtual QString asWkt( int precision = 17 ) const = 0;
@ -160,10 +160,10 @@ class CORE_EXPORT QgsAbstractGeometry
* \param doc DOM document
* \param precision number of decimal places for coordinates
* \param ns XML namespace
* @see asWkb
* @see asWkt
* @see asGML3
* @see asJSON
* \see asWkb
* \see asWkt
* \see asGML3
* \see asJSON
*/
virtual QDomElement asGML2( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0;
@ -171,19 +171,19 @@ class CORE_EXPORT QgsAbstractGeometry
* \param doc DOM document
* \param precision number of decimal places for coordinates
* \param ns XML namespace
* @see asWkb
* @see asWkt
* @see asGML2
* @see asJSON
* \see asWkb
* \see asWkt
* \see asGML2
* \see asJSON
*/
virtual QDomElement asGML3( QDomDocument &doc, int precision = 17, const QString &ns = "gml" ) const = 0;
/** Returns a GeoJSON representation of the geometry.
* \param precision number of decimal places for coordinates
* @see asWkb
* @see asWkt
* @see asGML2
* @see asGML3
* \see asWkb
* \see asWkt
* \see asGML2
* \see asGML3
*/
virtual QString asJSON( int precision = 17 ) const = 0;
@ -253,8 +253,8 @@ class CORE_EXPORT QgsAbstractGeometry
* \param position vertex id for position of inserted vertex
* \param vertex vertex to insert
* \returns true if insert was successful
* @see moveVertex
* @see deleteVertex
* \see moveVertex
* \see deleteVertex
*/
virtual bool insertVertex( QgsVertexId position, const QgsPointV2 &vertex ) = 0;
@ -262,34 +262,34 @@ class CORE_EXPORT QgsAbstractGeometry
* \param position vertex id for vertex to move
* \param newPos new position of vertex
* \returns true if move was successful
* @see insertVertex
* @see deleteVertex
* \see insertVertex
* \see deleteVertex
*/
virtual bool moveVertex( QgsVertexId position, const QgsPointV2 &newPos ) = 0;
/** Deletes a vertex within the geometry
* \param position vertex id for vertex to delete
* \returns true if delete was successful
* @see insertVertex
* @see moveVertex
* \see insertVertex
* \see moveVertex
*/
virtual bool deleteVertex( QgsVertexId position ) = 0;
/** Returns the length of the geometry.
* @see area()
* @see perimeter()
* \see area()
* \see perimeter()
*/
virtual double length() const { return 0.0; }
/** Returns the perimeter of the geometry.
* @see area()
* @see length()
* \see area()
* \see length()
*/
virtual double perimeter() const { return 0.0; }
/** Returns the area of the geometry.
* @see length()
* @see perimeter()
* \see length()
* \see perimeter()
*/
virtual double area() const { return 0.0; }
@ -336,8 +336,8 @@ class CORE_EXPORT QgsAbstractGeometry
virtual int ringCount( int part = 0 ) const = 0;
/** Returns count of parts contained in the geometry.
* @see vertexCount
* @see ringCount
* \see vertexCount
* \see ringCount
*/
virtual int partCount() const = 0;
@ -345,8 +345,8 @@ class CORE_EXPORT QgsAbstractGeometry
* \param zValue initial z-value for all nodes
* \returns true on success
* \since QGIS 2.12
* @see dropZValue()
* @see addMValue()
* \see dropZValue()
* \see addMValue()
*/
virtual bool addZValue( double zValue = 0 ) = 0;
@ -354,23 +354,23 @@ class CORE_EXPORT QgsAbstractGeometry
* \param mValue initial m-value for all nodes
* \returns true on success
* \since QGIS 2.12
* @see dropMValue()
* @see addZValue()
* \see dropMValue()
* \see addZValue()
*/
virtual bool addMValue( double mValue = 0 ) = 0;
/** Drops any z-dimensions which exist in the geometry.
* \returns true if Z values were present and have been removed
* @see addZValue()
* @see dropMValue()
* \see addZValue()
* \see dropMValue()
* \since QGIS 2.14
*/
virtual bool dropZValue() = 0;
/** Drops any measure values which exist in the geometry.
* \returns true if m-values were present and have been removed
* @see addMValue()
* @see dropZValue()
* \see addMValue()
* \see dropZValue()
* \since QGIS 2.14
*/
virtual bool dropMValue() = 0;

8
src/core/geometry/qgscurve.h
View File

@ -41,12 +41,12 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry
virtual QgsCurve *clone() const override = 0;
/** Returns the starting point of the curve.
* @see endPoint
* \see endPoint
*/
virtual QgsPointV2 startPoint() const = 0;
/** Returns the end point of the curve.
* @see startPoint
* \see startPoint
*/
virtual QgsPointV2 endPoint() const = 0;
@ -118,14 +118,14 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry
/** Returns the x-coordinate of the specified node in the line string.
* \param index index of node, where the first node in the line is 0
* \returns x-coordinate of node, or 0.0 if index is out of bounds
* @see setXAt()
* \see setXAt()
*/
virtual double xAt( int index ) const = 0;
/** Returns the y-coordinate of the specified node in the line string.
* \param index index of node, where the first node in the line is 0
* \returns y-coordinate of node, or 0.0 if index is out of bounds
* @see setYAt()
* \see setYAt()
*/
virtual double yAt( int index ) const = 0;

8
src/core/geometry/qgscurvepolygon.h
View File

@ -72,8 +72,8 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
* of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension
* from the CurvePolygon and all interior rings.
* \param ring new exterior ring. Ownership is transferred to the CurvePolygon.
* @see setInteriorRings()
* @see exteriorRing()
* \see setInteriorRings()
* \see exteriorRing()
*/
virtual void setExteriorRing( QgsCurve *ring );
@ -86,7 +86,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
* Removes an interior ring from the polygon. The first interior ring has index 0.
* The corresponding ring is removed from the polygon and deleted. If a ring was successfully removed
* the function will return true. It is not possible to remove the exterior ring using this method.
* @see removeInteriorRings()
* \see removeInteriorRings()
*/
bool removeInteriorRing( int ringIndex );
@ -95,7 +95,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
* parameter is specified then only rings smaller than this minimum
* area will be removed.
* \since QGIS 3.0
* @see removeInteriorRing()
* \see removeInteriorRing()
*/
void removeInteriorRings( double minimumAllowedArea = -1 );

58
src/core/geometry/qgsgeometry.h
View File

@ -101,21 +101,21 @@ class CORE_EXPORT QgsGeometry
/** Returns the underlying geometry store.
* \since QGIS 2.10
* @see setGeometry
* \see setGeometry
*/
QgsAbstractGeometry *geometry() const;
/** Sets the underlying geometry store. Ownership of geometry is transferred.
* \since QGIS 2.10
* @see geometry
* \see geometry
*/
void setGeometry( QgsAbstractGeometry *geometry );
/** Returns true if the geometry is null (ie, contains no underlying geometry
* accessible via @link geometry @endlink).
* @see geometry
* \see geometry
* \since QGIS 2.10
* @see isEmpty()
* \see isEmpty()
*/
bool isNull() const;
@ -166,12 +166,12 @@ class CORE_EXPORT QgsGeometry
GEOSGeometry *exportToGeos( double precision = 0 ) const;
/** Returns type of the geometry as a WKB type (point / linestring / polygon etc.)
* @see type
* \see type
*/
QgsWkbTypes::Type wkbType() const;
/** Returns type of the geometry as a QgsWkbTypes::GeometryType
* @see wkbType
* \see wkbType
*/
QgsWkbTypes::GeometryType type() const;
@ -179,7 +179,7 @@ class CORE_EXPORT QgsGeometry
* Returns true if the geometry is empty (eg a linestring with no vertices,
* or a collection with no geometries). A null geometry will always
* return true for isEmpty().
* @see isNull()
* \see isNull()
*/
bool isEmpty() const;
@ -242,7 +242,7 @@ class CORE_EXPORT QgsGeometry
* \param vertex vertex index to calculate bisector angle at
* \returns bisector angle, in radians clockwise from north
* \since QGIS 3.0
* @see interpolateAngle()
* \see interpolateAngle()
*/
double angleAtVertex( int vertex ) const;
@ -330,13 +330,13 @@ class CORE_EXPORT QgsGeometry
/** Returns the nearest point on this geometry to another geometry.
* \since QGIS 2.14
* @see shortestLine()
* \see shortestLine()
*/
QgsGeometry nearestPoint( const QgsGeometry &other ) const;
/** Returns the shortest line joining this geometry to another geometry.
* \since QGIS 2.14
* @see nearestPoint()
* \see nearestPoint()
*/
QgsGeometry shortestLine( const QgsGeometry &other ) const;
@ -479,7 +479,7 @@ class CORE_EXPORT QgsGeometry
/**
* Returns the bounding box of the geometry.
* @see orientedMinimumBoundingBox()
* \see orientedMinimumBoundingBox()
*/
QgsRectangle boundingBox() const;
@ -488,7 +488,7 @@ class CORE_EXPORT QgsGeometry
* rotated rectangle which fully encompasses the geometry. The area, angle (clockwise in degrees from North),
* width and height of the rotated bounding box will also be returned.
* \since QGIS 3.0
* @see boundingBox()
* \see boundingBox()
*/
QgsGeometry orientedMinimumBoundingBox( double &area, double &angle, double &width, double &height ) const;
@ -619,7 +619,7 @@ class CORE_EXPORT QgsGeometry
* at the added nodes.
* Curved geometry types are automatically segmentized by this routine.
* \since QGIS 3.0
* @see densifyByDistance()
* \see densifyByDistance()
*/
QgsGeometry densifyByCount( int extraNodesPerSegment ) const;
@ -635,7 +635,7 @@ class CORE_EXPORT QgsGeometry
* at the added nodes.
* Curved geometry types are automatically segmentized by this routine.
* \since QGIS 3.0
* @see densifyByCount()
* \see densifyByCount()
*/
QgsGeometry densifyByDistance( double distance ) const;
@ -643,8 +643,8 @@ class CORE_EXPORT QgsGeometry
* Returns the center of mass of a geometry.
* \note for line based geometries, the center point of the line is returned,
* and for point based geometries, the point itself is returned
* @see pointOnSurface()
* @see poleOfInaccessibility()
* \see pointOnSurface()
* \see poleOfInaccessibility()
*/
QgsGeometry centroid() const;
@ -652,8 +652,8 @@ class CORE_EXPORT QgsGeometry
* Returns a point guaranteed to lie on the surface of a geometry. While the centroid()
* of a geometry may be located outside of the geometry itself (e.g., for concave shapes),
* the point on surface will always be inside the geometry.
* @see centroid()
* @see poleOfInaccessibility()
* \see centroid()
* \see poleOfInaccessibility()
*/
QgsGeometry pointOnSurface() const;
@ -665,8 +665,8 @@ class CORE_EXPORT QgsGeometry
* tolerance. More precise tolerances require more iterations and will take longer
* to calculate.
* Optionally, the distance to the polygon boundary from the pole can be stored.
* @see centroid()
* @see pointOnSurface()
* \see centroid()
* \see pointOnSurface()
* \since QGIS 3.0
*/
QgsGeometry poleOfInaccessibility( double precision, double *distanceToBoundary = nullptr ) const;
@ -705,7 +705,7 @@ class CORE_EXPORT QgsGeometry
/**
* Return interpolated point on line at distance
* \since QGIS 1.9
* @see lineLocatePoint()
* \see lineLocatePoint()
*/
QgsGeometry interpolate( double distance ) const;
@ -716,7 +716,7 @@ class CORE_EXPORT QgsGeometry
* \param point point to seek proximity to
* \returns distance along line, or -1 on error
* \note only valid for linestring geometries
* @see interpolate()
* \see interpolate()
* \since QGIS 3.0
*/
double lineLocatePoint( const QgsGeometry &point ) const;
@ -727,7 +727,7 @@ class CORE_EXPORT QgsGeometry
* of the node is returned.
* \param distance distance along geometry
* \since QGIS 3.0
* @see angleAtVertex()
* \see angleAtVertex()
*/
double interpolateAngle( double distance ) const;
@ -930,14 +930,14 @@ class CORE_EXPORT QgsGeometry
/** Converts the geometry to straight line segments, if it is a curved geometry type.
* \since QGIS 2.10
* @see requiresConversionToStraightSegments
* \see requiresConversionToStraightSegments
*/
void convertToStraightSegment();
/** Returns true if the geometry is a curved geometry type which requires conversion to
* display as straight line segments.
* \since QGIS 2.10
* @see convertToStraightSegment
* \see convertToStraightSegment
*/
bool requiresConversionToStraightSegments() const;
@ -965,7 +965,7 @@ class CORE_EXPORT QgsGeometry
* \param id reference to QgsVertexId for storing result
* \returns true if vertex was found
* \since QGIS 2.10
* @see vertexNrFromVertexId
* \see vertexNrFromVertexId
*/
bool vertexIdFromVertexNr( int nr, QgsVertexId &id ) const;
@ -973,7 +973,7 @@ class CORE_EXPORT QgsGeometry
* \param i vertex id
* \returns vertex number
* \since QGIS 2.10
* @see vertexIdFromVertexNr
* \see vertexIdFromVertexNr
*/
int vertexNrFromVertexId( QgsVertexId i ) const;
@ -1000,14 +1000,14 @@ class CORE_EXPORT QgsGeometry
/** Creates a QgsPolyline from a QPolygonF.
* \param polygon source polygon
* \returns QgsPolyline
* @see createPolygonFromQPolygonF
* \see createPolygonFromQPolygonF
*/
static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
/** Creates a QgsPolygon from a QPolygonF.
* \param polygon source polygon
* \returns QgsPolygon
* @see createPolylineFromQPolygonF
* \see createPolylineFromQPolygonF
*/
static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );

4
src/core/geometry/qgsgeos.h
View File

@ -120,13 +120,13 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
/** Returns the closest point on the geometry to the other geometry.
* \since QGIS 2.14
* @see shortestLine()
* \see shortestLine()
*/
QgsGeometry closestPoint( const QgsGeometry &other, QString *errorMsg = nullptr ) const;
/** Returns the shortest line joining this geometry to the other geometry.
* \since QGIS 2.14
* @see closestPoint()
* \see closestPoint()
*/
QgsGeometry shortestLine( const QgsGeometry &other, QString *errorMsg = nullptr ) const;

12
src/core/geometry/qgslinestring.h
View File

@ -73,7 +73,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0
* \returns z-coordinate of node, or 0.0 if index is out of bounds or the line
* does not have a z dimension
* @see setZAt()
* \see setZAt()
*/
double zAt( int index ) const;
@ -81,7 +81,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0
* \returns m value of node, or 0.0 if index is out of bounds or the line
* does not have m values
* @see setMAt()
* \see setMAt()
*/
double mAt( int index ) const;
@ -89,7 +89,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0. Corresponding
* node must already exist in line string.
* \param x x-coordinate of node
* @see xAt()
* \see xAt()
*/
void setXAt( int index, double x );
@ -97,7 +97,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0. Corresponding
* node must already exist in line string.
* \param y y-coordinate of node
* @see yAt()
* \see yAt()
*/
void setYAt( int index, double y );
@ -105,7 +105,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0. Corresponding
* node must already exist in line string, and the line string must have z-dimension.
* \param z z-coordinate of node
* @see zAt()
* \see zAt()
*/
void setZAt( int index, double z );
@ -113,7 +113,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
* \param index index of node, where the first node in the line is 0. Corresponding
* node must already exist in line string, and the line string must have m values.
* \param m m value of node
* @see mAt()
* \see mAt()
*/
void setMAt( int index, double m );

60
src/core/geometry/qgspointv2.h
View File

@ -64,86 +64,86 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
bool operator!=( const QgsPointV2 &pt ) const;
/** Returns the point's x-coordinate.
* @see setX()
* @see rx()
* \see setX()
* \see rx()
*/
double x() const { return mX; }
/** Returns the point's y-coordinate.
* @see setY()
* @see ry()
* \see setY()
* \see ry()
*/
double y() const { return mY; }
/** Returns the point's z-coordinate.
* @see setZ()
* @see rz()
* \see setZ()
* \see rz()
*/
double z() const { return mZ; }
/** Returns the point's m value.
* @see setM()
* @see rm()
* \see setM()
* \see rm()
*/
double m() const { return mM; }
/** Returns a reference to the x-coordinate of this point.
* Using a reference makes it possible to directly manipulate x in place.
* @see x()
* @see setX()
* \see x()
* \see setX()
* \note not available in Python bindings
*/
double &rx() { clearCache(); return mX; }
/** Returns a reference to the y-coordinate of this point.
* Using a reference makes it possible to directly manipulate y in place.
* @see y()
* @see setY()
* \see y()
* \see setY()
* \note not available in Python bindings
*/
double &ry() { clearCache(); return mY; }
/** Returns a reference to the z-coordinate of this point.
* Using a reference makes it possible to directly manipulate z in place.
* @see z()
* @see setZ()
* \see z()
* \see setZ()
* \note not available in Python bindings
*/
double &rz() { clearCache(); return mZ; }
/** Returns a reference to the m value of this point.
* Using a reference makes it possible to directly manipulate m in place.
* @see m()
* @see setM()
* \see m()
* \see setM()
* \note not available in Python bindings
*/
double &rm() { clearCache(); return mM; }
/** Sets the point's x-coordinate.
* @see x()
* @see rx()
* \see x()
* \see rx()
*/
void setX( double x ) { clearCache(); mX = x; }
/** Sets the point's y-coordinate.
* @see y()
* @see ry()
* \see y()
* \see ry()
*/
void setY( double y ) { clearCache(); mY = y; }
/** Sets the point's z-coordinate.
* \note calling this will have no effect if the point does not contain a z-dimension. Use addZValue() to
* add a z value and force the point to have a z dimension.
* @see z()
* @see rz()
* \see z()
* \see rz()
*/
void setZ( double z ) { clearCache(); mZ = z; }
/** Sets the point's m-value.
* \note calling this will have no effect if the point does not contain a m-dimension. Use addMValue() to
* add a m value and force the point to have an m dimension.
* @see m()
* @see rm()
* \see m()
* \see rm()
*/
void setM( double m ) { clearCache(); mM = m; }
@ -157,7 +157,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
* when comparing distances.
* \since QGIS 3.0
* @see distanceSquared()
* \see distanceSquared()
*/
double distance( double x, double y ) const;
@ -173,7 +173,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* Returns the squared distance between this point a specified x, y coordinate. Calling
* this is faster than calling distance(), and may be useful in use cases such as comparing
* distances where the extra expense of calling distance() is not required.
* @see distance()
* \see distance()
* \since QGIS 3.0
*/
double distanceSquared( double x, double y ) const;
@ -182,7 +182,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* Returns the squared distance between this point another point. Calling
* this is faster than calling distance(), and may be useful in use cases such as comparing
* distances where the extra expense of calling distance() is not required.
* @see distance()
* \see distance()
* \since QGIS 3.0
*/
double distanceSquared( const QgsPointV2 &other ) const;
@ -192,7 +192,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* cases it may be more appropriate to call the faster distanceSquared() method, e.g.,
* when comparing distances.
* \since QGIS 3.0
* @see distanceSquared()
* \see distanceSquared()
*/
double distance3D( double x, double y, double z ) const;
@ -208,7 +208,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* Returns the 3D squared distance between this point a specified x, y, z coordinate. Calling
* this is faster than calling distance(), and may be useful in use cases such as comparing
* distances where the extra expense of calling distance() is not required.
* @see distance()
* \see distance()
* \since QGIS 3.0
*/
double distanceSquared3D( double x, double y, double z ) const;
@ -217,7 +217,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
* Returns the 3D squared distance between this point another point. Calling
* this is faster than calling distance(), and may be useful in use cases such as comparing
* distances where the extra expense of calling distance() is not required.
* @see distance()
* \see distance()
* \since QGIS 3.0
*/
double distanceSquared3D( const QgsPointV2 &other ) const;

58
src/core/geometry/qgswkbtypes.h
View File

@ -130,7 +130,7 @@ class CORE_EXPORT QgsWkbTypes
* The geometry types are used to group QgsWkbTypes::Type in a
* coarse way.
*
* @see geometryType( QgsWkbTypes::Type )
* \see geometryType( QgsWkbTypes::Type )
*/
enum GeometryType
{
@ -142,9 +142,9 @@ class CORE_EXPORT QgsWkbTypes
};
/** Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon.
* @see isSingleType()
* @see multiType()
* @see flatType()
* \see isSingleType()
* \see multiType()
* \see flatType()
*/
static Type singleType( Type type )
{
@ -285,9 +285,9 @@ class CORE_EXPORT QgsWkbTypes
}
/** Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon.
* @see isMultiType()
* @see singleType()
* @see flatType()
* \see isMultiType()
* \see singleType()
* \see flatType()
*/
static Type multiType( Type type )
{
@ -416,8 +416,8 @@ class CORE_EXPORT QgsWkbTypes
/** Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions.
* For example, for PolygonZM WKB types the single type would be Polygon.
* @see singleType()
* @see multiType()
* \see singleType()
* \see multiType()
*/
static Type flatType( Type type )
{
@ -534,8 +534,8 @@ class CORE_EXPORT QgsWkbTypes
static Type parseType( const QString &wktStr );
/** Returns true if the WKB type is a single type.
* @see isMultiType()
* @see singleType()
* \see isMultiType()
* \see singleType()
*/
static bool isSingleType( Type type )
{
@ -543,8 +543,8 @@ class CORE_EXPORT QgsWkbTypes
}
/** Returns true if the WKB type is a multi type.
* @see isSingleType()
* @see multiType()
* \see isSingleType()
* \see multiType()
*/
static bool isMultiType( Type type )
{
@ -614,7 +614,7 @@ class CORE_EXPORT QgsWkbTypes
* always be less than or equal to the coordinate dimension.
* \returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries
* Invalid geometry types will return a dimension of 0.
* @see coordDimensions()
* \see coordDimensions()
*/
static int wkbDimensions( Type type )
{
@ -634,7 +634,7 @@ class CORE_EXPORT QgsWkbTypes
* be between 2-4, depending on whether the geometry type contains the Z or M dimensions.
* Invalid geometry types will return a dimension of 0.
* \since QGIS 2.14
* @see wkbDimensions()
* \see wkbDimensions()
*/
static int coordDimensions( Type type )
{
@ -748,8 +748,8 @@ class CORE_EXPORT QgsWkbTypes
/** Tests whether a WKB type contains the z-dimension.
* \returns true if type has z values
* @see addZ()
* @see hasM()
* \see addZ()
* \see hasM()
*/
static bool hasZ( Type type )
{
@ -797,8 +797,8 @@ class CORE_EXPORT QgsWkbTypes
/** Tests whether a WKB type contains m values.
* \returns true if type has m values
* @see addM()
* @see hasZ()
* \see addM()
* \see hasZ()
*/
static bool hasM( Type type )
{
@ -841,9 +841,9 @@ class CORE_EXPORT QgsWkbTypes
/** Adds the z dimension to a WKB type and returns the new type
* \param type original type
* \since QGIS 2.12
* @see addM()
* @see dropZ()
* @see hasZ()
* \see addM()
* \see dropZ()
* \see hasZ()
*/
static Type addZ( Type type )
{
@ -865,9 +865,9 @@ class CORE_EXPORT QgsWkbTypes
/** Adds the m dimension to a WKB type and returns the new type
* \param type original type
* \since QGIS 2.12
* @see addZ()
* @see dropM()
* @see hasM()
* \see addZ()
* \see dropM()
* \see hasM()
*/
static Type addM( Type type )
{
@ -896,8 +896,8 @@ class CORE_EXPORT QgsWkbTypes
/** Drops the z dimension (if present) for a WKB type and returns the new type.
* \param type original type
* \since QGIS 2.14
* @see dropM()
* @see addZ()
* \see dropM()
* \see addZ()
*/
static Type dropZ( Type type )
{
@ -913,8 +913,8 @@ class CORE_EXPORT QgsWkbTypes
/** Drops the m dimension (if present) for a WKB type and returns the new type.
* \param type original type
* \since QGIS 2.14
* @see dropZ()
* @see addM()
* \see dropZ()
* \see addM()
*/
static Type dropM( Type type )
{

12
src/core/gps/info.h
View File

@ -64,8 +64,8 @@ typedef struct _nmeaPOS
/**
* Information about satellite
* @see nmeaSATINFO
* @see nmeaGPGSV
* \see nmeaSATINFO
* \see nmeaGPGSV
*/
typedef struct _nmeaSATELLITE
{
@ -79,8 +79,8 @@ typedef struct _nmeaSATELLITE
/**
* Information about all satellites in view
* @see nmeaINFO
* @see nmeaGPGSV
* \see nmeaINFO
* \see nmeaGPGSV
*/
typedef struct _nmeaSATINFO
{
@ -93,8 +93,8 @@ typedef struct _nmeaSATINFO
/**
* Summary GPS information from all parsed packets,
* used also for generating NMEA stream
* @see nmea_parse
* @see nmea_GPGGA2info, nmea_...2info
* \see nmea_parse
* \see nmea_GPGGA2info, nmea_...2info
*/
typedef struct _nmeaINFO
{

2
src/core/gps/nmeatime.h
View File

@ -38,7 +38,7 @@ extern "C"
/**
* Date and time data
* @see nmea_time_now
* \see nmea_time_now
*/
typedef struct _nmeaTIME
{

26
src/core/layertree/qgslayertree.h
View File

@ -102,9 +102,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* Will only be used if the property hasCustomLayerOrder is true.
* If you need the current layer order that is active, prefer using layerOrder().
*
* @see setCustomLayerOrder
* @see layerOrder
* @see hasCustomLayerOrder
* \see setCustomLayerOrder
* \see layerOrder
* \see hasCustomLayerOrder
*
* \since QGIS 3.0
*/
@ -115,9 +115,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* Will only be used if the property hasCustomLayerOrder is true.
* If you need the current layer order that is active, prefer using layerOrder().
*
* @see customLayerOrder
* @see layerOrder
* @see hasCustomLayerOrder
* \see customLayerOrder
* \see layerOrder
* \see hasCustomLayerOrder
*
* \since QGIS 3.0
*/
@ -128,9 +128,9 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* Will only be used if the property hasCustomLayerOrder is true.
* If you need the current layer order that is active, prefer using layerOrder().
*
* @see customLayerOrder
* @see layerOrder
* @see hasCustomLayerOrder
* \see customLayerOrder
* \see layerOrder
* \see hasCustomLayerOrder
*
* \since QGIS 3.0
*/
@ -142,7 +142,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* customLayerOrder or the layer order derived from the tree.
* This property is read only.
*
* @see customLayerOrder
* \see customLayerOrder
*
* \since QGIS 3.0
*/
@ -152,7 +152,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* Determines if the layer order should be derived from the layer tree
* or if a custom override order shall be used instead.
*
* @see customLayerOrder
* \see customLayerOrder
*
* \since QGIS 3.0
*/
@ -162,7 +162,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
* Determines if the layer order should be derived from the layer tree
* or if a custom override order shall be used instead.
*
* @see setCustomLayerOrder
* \see setCustomLayerOrder
*
* \since QGIS 3.0
*/
@ -216,7 +216,7 @@ class CORE_EXPORT QgsLayerTree : public QgsLayerTreeGroup
/**
* Emitted when the hasCustomLayerOrder flag changes.
*
* @see hasCustomLayerOrder
* \see hasCustomLayerOrder
*
* \since QGIS 3.0
*/

6
src/core/layertree/qgslayertreemodel.h
View File

@ -48,7 +48,7 @@ class QgsLayerTree;
* Behavior of the model can be customized with flags. For example, whether to show legend or
* whether to allow changes to the layer tree.
*
* @see QgsLayerTreeView
* \see QgsLayerTreeView
* \since QGIS 2.4
*/
class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
@ -127,12 +127,12 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
//! (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true)
//! \since QGIS 2.6
//! \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18
//! @see layerOriginalLegendNodes()
//! \see layerOriginalLegendNodes()
QList<QgsLayerTreeModelLegendNode *> layerLegendNodes( QgsLayerTreeLayer *nodeLayer, bool skipNodeEmbeddedInParent = false );
//! Return original (unfiltered) list of legend nodes attached to a particular layer node
//! \since QGIS 2.14
//! @see layerLegendNodes()
//! \see layerLegendNodes()
QList<QgsLayerTreeModelLegendNode *> layerOriginalLegendNodes( QgsLayerTreeLayer *nodeLayer );
//! Return legend node that may be embedded in parent (i.e. its icon will be used for layer's icon).

8
src/core/layertree/qgslayertreemodellegendnode.h
View File

@ -187,7 +187,7 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
QSize minimumIconSize( QgsRenderContext *context ) const;
/** Returns the symbol used by the legend node.
* @see setSymbol()
* \see setSymbol()
* \since QGIS 2.14
*/
const QgsSymbol *symbol() const;
@ -195,7 +195,7 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
/** Sets the symbol to be used by the legend node. The symbol change is also propagated
* to the associated vector layer's renderer.
* \param symbol new symbol for node. Ownership is transferred.
* @see symbol()
* \see symbol()
* \since QGIS 2.14
*/
void setSymbol( QgsSymbol *symbol );
@ -204,13 +204,13 @@ class CORE_EXPORT QgsSymbolLegendNode : public QgsLayerTreeModelLegendNode
/** Checks all items belonging to the same layer as this node.
* \since QGIS 2.14
* @see uncheckAllItems()
* \see uncheckAllItems()
*/
void checkAllItems();
/** Unchecks all items belonging to the same layer as this node.
* \since QGIS 2.14
* @see checkAllItems()
* \see checkAllItems()
*/
void uncheckAllItems();

2
src/core/layertree/qgslayertreenode.h
View File

@ -63,7 +63,7 @@ class QgsMapLayer;
* - "legend/..." - properties for legend appearance customization
* - "expandedLegendNodes" - list of layer's legend nodes' rules in expanded state
*
* @see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
* \see also QgsLayerTree, QgsLayerTreeLayer, QgsLayerTreeGroup
* \since QGIS 2.4
*/
class CORE_EXPORT QgsLayerTreeNode : public QObject

4
src/core/pal/feature.h
View File

@ -266,8 +266,8 @@ namespace pal
/** Calculates the priority for the feature. This will be the feature's priority if set,
* otherwise the layer's default priority.
* @see Feature::setPriority
* @see Feature::priority
* \see Feature::setPriority
* \see Feature::priority
*/
double calculatePriority() const;

8
src/core/pal/labelposition.h
View File

@ -175,25 +175,25 @@ namespace pal
}
/** Returns the candidate label position's geographical cost.
* @see setCost
* \see setCost
*/
double cost() const { return mCost; }
/** Sets the candidate label position's geographical cost.
* \param newCost new cost for position
* @see cost
* \see cost
*/
void setCost( double newCost ) { mCost = newCost; }
/** Sets whether the position is marked as conflicting with an obstacle feature.
* \param conflicts set to true to mark candidate as being in conflict
* \note This method applies to all label parts for the candidate position.
* @see conflictsWithObstacle
* \see conflictsWithObstacle
*/
void setConflictsWithObstacle( bool conflicts );
/** Returns whether the position is marked as conflicting with an obstacle feature.
* @see setConflictsWithObstacle
* \see setConflictsWithObstacle
*/
bool conflictsWithObstacle() const { return mHasObstacleConflict; }

42
src/core/pal/layer.h
View File

@ -91,7 +91,7 @@ namespace pal
QString name() const { return mName; }
/** Returns the layer's arrangement policy.
* @see setArrangement
* \see setArrangement
*/
QgsPalLayerSettings::Placement arrangement() const { return mArrangement; }
@ -101,18 +101,18 @@ namespace pal
/** Sets the layer's arrangement policy.
* \param arrangement arrangement policy
* @see arrangement
* \see arrangement
*/
void setArrangement( QgsPalLayerSettings::Placement arrangement ) { mArrangement = arrangement; }
/** Returns the layer's arrangement flags.
* @see setArrangementFlags
* \see setArrangementFlags
*/
LineArrangementFlags arrangementFlags() const { return mArrangementFlags; }
/** Sets the layer's arrangement flags.
* \param flags arrangement flags
* @see arrangementFlags
* \see arrangementFlags
*/
void setArrangementFlags( LineArrangementFlags flags ) { mArrangementFlags = flags; }
@ -124,84 +124,84 @@ namespace pal
* labeling or as obstacles.
*
* \param active set to true to make the layer active, or false to deactivate the layer
* @see active
* \see active
*/
void setActive( bool active ) { mActive = active; }
/** Returns whether the layer is currently active.
* @see setActive
* \see setActive
*/
bool active() const { return mActive; }
/** Sets whether the layer will be labeled.
* \note Layers are labelled if and only if labelLayer and active are true
* \param toLabel set to false disable labeling this layer
* @see labelLayer
* @see setActive
* \see labelLayer
* \see setActive
*/
void setLabelLayer( bool toLabel ) { mLabelLayer = toLabel; }
/** Returns whether the layer will be labeled or not.
* @see setLabelLayer
* \see setLabelLayer
*/
bool labelLayer() const { return mLabelLayer; }
/** Returns the obstacle type, which controls how features within the layer
* act as obstacles for labels.
* @see setObstacleType
* \see setObstacleType
*/
QgsPalLayerSettings::ObstacleType obstacleType() const { return mObstacleType; }
/** Sets the obstacle type, which controls how features within the layer
* act as obstacles for labels.
* \param obstacleType new obstacle type
* @see obstacleType
* \see obstacleType
*/
void setObstacleType( QgsPalLayerSettings::ObstacleType obstacleType ) { mObstacleType = obstacleType; }
/** Sets the layer's priority.
* \param priority layer priority, between 0 and 1. 0 corresponds to highest priority,
* 1 to lowest priority.
* @see priority
* \see priority
*/
void setPriority( double priority );
/** Returns the layer's priority, between 0 and 1. 0 corresponds to highest priority,
* 1 to lowest priority.
* @see setPriority
* \see setPriority
*/
double priority() const { return mDefaultPriority; }
/** Sets the layer's labeling mode.
* \param mode label mode
* @see labelMode
* \see labelMode
*/
void setLabelMode( LabelMode mode ) { mMode = mode; }
/** Returns the layer's labeling mode.
* @see setLabelMode
* \see setLabelMode
*/
LabelMode labelMode() const { return mMode; }
/** Sets whether connected lines should be merged before labeling
* \param merge set to true to merge connected lines
* @see mergeConnectedLines
* \see mergeConnectedLines
*/
void setMergeConnectedLines( bool merge ) { mMergeLines = merge; }
/** Returns whether connected lines will be merged before labeling.
* @see setMergeConnectedLines
* \see setMergeConnectedLines
*/
bool mergeConnectedLines() const { return mMergeLines; }
/** Sets how upside down labels will be handled within the layer.
* \param ud upside down label handling mode
* @see upsideDownLabels
* \see upsideDownLabels
*/
void setUpsidedownLabels( UpsideDownLabels ud ) { mUpsidedownLabels = ud; }
/** Returns how upside down labels are handled within the layer.
* @see setUpsidedownLabels
* \see setUpsidedownLabels
*/
UpsideDownLabels upsidedownLabels() const { return mUpsidedownLabels; }
@ -209,13 +209,13 @@ namespace pal
* are forced to be placed inside the feature's geometry.
* \param forceInside set to true to force centroid labels to be within the
* feature. If set to false then the centroid may fall outside the feature.
* @see centroidInside
* \see centroidInside
*/
void setCentroidInside( bool forceInside ) { mCentroidInside = forceInside; }
/** Returns whether labels placed at the centroid of features within the layer
* are forced to be placed inside the feature's geometry.
* @see setCentroidInside
* \see setCentroidInside
*/
bool centroidInside() const { return mCentroidInside; }

26
src/core/processing/qgsprocessingfeedback.h
View File

@ -41,7 +41,7 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback
* Sets a progress report text string. This can be used in conjunction with
* setProgress() to provide detailed progress reports, such as "Transformed
* 4 of 5 layers".
* @see setProgress()
* \see setProgress()
*/
virtual void setProgressText( const QString &text ) { Q_UNUSED( text ); }
@ -55,9 +55,9 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback
* Pushes a general informational message from the algorithm. This can
* be used to report feedback which is neither a status report or an
* error, such as "Found 47 matching features".
* @see pushCommandInfo()
* @see pushDebugInfo()
* @see pushConsoleInfo()
* \see pushCommandInfo()
* \see pushDebugInfo()
* \see pushConsoleInfo()
*/
virtual void pushInfo( const QString &info ) { Q_UNUSED( info ); }
@ -65,27 +65,27 @@ class CORE_EXPORT QgsProcessingFeedback : public QgsFeedback
* Pushes an informational message containing a command from the algorithm.
* This is usually used to report commands which are executed in an external
* application or as subprocesses.
* @see pushInfo()
* @see pushDebugInfo()
* @see pushConsoleInfo()
* \see pushInfo()
* \see pushDebugInfo()
* \see pushConsoleInfo()
*/
virtual void pushCommandInfo( const QString &info ) { Q_UNUSED( info ); }
/**
* Pushes an informational message containing debugging helpers from
* the algorithm.
* @see pushInfo()
* @see pushCommandInfo()
* @see pushConsoleInfo()
* \see pushInfo()
* \see pushCommandInfo()
* \see pushConsoleInfo()
*/
virtual void pushDebugInfo( const QString &info ) { Q_UNUSED( info ); }
/**
* Pushes a console feedback message from the algorithm. This is used to
* report the output from executing an external command or subprocess.
* @see pushInfo()
* @see pushDebugInfo()
* @see pushCommandInfo()
* \see pushInfo()
* \see pushDebugInfo()
* \see pushCommandInfo()
*/
virtual void pushConsoleInfo( const QString &info ) { Q_UNUSED( info ); }

8
src/core/processing/qgsprocessingprovider.h
View File

@ -48,13 +48,13 @@ class CORE_EXPORT QgsProcessingProvider
/**
* Returns an icon for the provider.
* @see svgIconPath()
* \see svgIconPath()
*/
virtual QIcon icon() const;
/**
* Returns a path to an SVG version of the provider's icon.
* @see icon()
* \see icon()
*/
virtual QString svgIconPath() const;
@ -62,14 +62,14 @@ class CORE_EXPORT QgsProcessingProvider
* Returns the unique provider id, used for identifying the provider. This string
* should be a unique, short, character only string, eg "qgis" or "gdal". This
* string should not be localised.
* @see name()
* \see name()
*/
virtual QString id() const = 0;
/**
* Returns the full provider name, which is used to describe the provider within the GUI.
* This string should be localised.
* @see id()
* \see id()
*/
virtual QString name() const = 0;

6
src/core/processing/qgsprocessingregistry.h
View File

@ -60,21 +60,21 @@ class CORE_EXPORT QgsProcessingRegistry : public QObject
* Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
* Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
* in the registry).
* @see removeProvider()
* \see removeProvider()
*/
bool addProvider( QgsProcessingProvider *provider SIP_TRANSFER );
/**
* Removes a provider implementation from the registry (the provider object is deleted).
* Returns false if the provider could not be removed (eg provider does not exist in the registry).
* @see addProvider()
* \see addProvider()
*/
bool removeProvider( QgsProcessingProvider *provider );
/**
* Removes a provider implementation from the registry (the provider object is deleted).
* Returns false if the provider could not be removed (eg provider does not exist in the registry).
* @see addProvider()
* \see addProvider()
*/
bool removeProvider( const QString &providerId );

12
src/core/qgis.h
View File

@ -130,7 +130,7 @@ class CORE_EXPORT Qgis
/** \ingroup core
* RAII signal blocking class. Used for temporarily blocking signals from a QObject
* for the lifetime of QgsSignalBlocker object.
* @see whileBlocking()
* \see whileBlocking()
* \since QGIS 2.16
* \note not available in Python bindings
*/
@ -171,7 +171,7 @@ template<class Object> class QgsSignalBlocker // clazy:exclude=rule-of-three
* No signals will be emitted when calling these methods.
*
* \since QGIS 2.16
* @see QgsSignalBlocker
* \see QgsSignalBlocker
* \note not available in Python bindings
*/
// based on Boojum's code from http://stackoverflow.com/questions/3556687/prevent-firing-signals-in-qt
@ -250,7 +250,7 @@ inline double qgsRound( double number, double places )
* \param ok will be set to true if conversion was successful
* \returns string converted to double if possible
* \since QGIS 2.9
* @see permissiveToInt
* \see permissiveToInt
*/
CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
@ -260,20 +260,20 @@ CORE_EXPORT double qgsPermissiveToDouble( QString string, bool &ok );
* \param ok will be set to true if conversion was successful
* \returns string converted to int if possible
* \since QGIS 2.9
* @see permissiveToDouble
* \see permissiveToDouble
*/
CORE_EXPORT int qgsPermissiveToInt( QString string, bool &ok );
//! Compares two QVariant values and returns whether the first is less than the second.
//! Useful for sorting lists of variants, correctly handling sorting of the various
//! QVariant data types (such as strings, numeric values, dates and times)
//! @see qgsVariantGreaterThan()
//! \see qgsVariantGreaterThan()
CORE_EXPORT bool qgsVariantLessThan( const QVariant &lhs, const QVariant &rhs );
//! Compares two QVariant values and returns whether the first is greater than the second.
//! Useful for sorting lists of variants, correctly handling sorting of the various
//! QVariant data types (such as strings, numeric values, dates and times)
//! @see qgsVariantLessThan()
//! \see qgsVariantLessThan()
CORE_EXPORT bool qgsVariantGreaterThan( const QVariant &lhs, const QVariant &rhs );
CORE_EXPORT QString qgsVsiPrefix( const QString &path );

2
src/core/qgsaction.h
View File

@ -152,7 +152,7 @@ class CORE_EXPORT QgsAction
* Action scopes may offer additional variables like the clicked
* coordinate.
*
* @see QgsActionScope
* \see QgsActionScope
* \since QGIS 3.0
*/
QSet<QString> actionScopes() const;

16
src/core/qgsaggregatecalculator.h
View File

@ -74,14 +74,14 @@ class CORE_EXPORT QgsAggregateCalculator
/** Optional filter for calculating aggregate over a subset of features, or an
* empty string to use all features.
* @see QgsAggregateCalculator::setFilter()
* @see QgsAggregateCalculator::filter()
* \see QgsAggregateCalculator::setFilter()
* \see QgsAggregateCalculator::filter()
*/
QString filter;
/** Delimiter to use for joining values with the StringConcatenate aggregate.
* @see QgsAggregateCalculator::setDelimiter()
* @see QgsAggregateCalculator::delimiter()
* \see QgsAggregateCalculator::setDelimiter()
* \see QgsAggregateCalculator::delimiter()
*/
QString delimiter;
};
@ -102,23 +102,23 @@ class CORE_EXPORT QgsAggregateCalculator
/** Sets a filter to limit the features used during the aggregate calculation.
* \param filterExpression expression for filtering features, or empty string to remove filter
* @see filter()
* \see filter()
*/
void setFilter( const QString &filterExpression ) { mFilterExpression = filterExpression; }
/** Returns the filter which limits the features used during the aggregate calculation.
* @see setFilter()
* \see setFilter()
*/
QString filter() const { return mFilterExpression; }
/** Sets the delimiter to use for joining values with the StringConcatenate aggregate.
* \param delimiter string delimiter
* @see delimiter()
* \see delimiter()
*/
void setDelimiter( const QString &delimiter ) { mDelimiter = delimiter; }
/** Returns the delimiter used for joining values with the StringConcatenate aggregate.
* @see setDelimiter()
* \see setDelimiter()
*/
QString delimiter() const { return mDelimiter; }

2
src/core/qgsanimatedicon.h
View File

@ -133,7 +133,7 @@ class CORE_EXPORT QgsAnimatedIcon : public QObject
* to this signal directly.
* Connecting to this signal directly will cause the animation not to be started.
*
* @see connectFrameChanged
* \see connectFrameChanged
*/
void frameChanged();

16
src/core/qgsapplication.h
View File

@ -218,25 +218,25 @@ class CORE_EXPORT QgsApplication : public QApplication
/** Returns the user's operating system login account name.
* \since QGIS 2.14
* @see userFullName()
* \see userFullName()
*/
static QString userLoginName();
/** Returns the user's operating system login account full display name.
* \since QGIS 2.14
* @see userLoginName()
* \see userLoginName()
*/
static QString userFullName();
/** Returns a string name of the operating system QGIS is running on.
* \since QGIS 2.14
* @see platform()
* \see platform()
*/
static QString osName();
/** Returns the QGIS platform name, e.g., "desktop" or "server".
* \since QGIS 2.14
* @see osName()
* \see osName()
*/
static QString platform();
@ -369,9 +369,9 @@ class CORE_EXPORT QgsApplication : public QApplication
static QStringList skippedGdalDrivers() { return ABISYM( mGdalSkipList ); }
/** Apply the skipped drivers list to gdal
* @see skipGdalDriver
* @see restoreGdalDriver
* @see skippedGdalDrivers */
* \see skipGdalDriver
* \see restoreGdalDriver
* \see skippedGdalDrivers */
static void applyGdalSkippedDrivers();
/** Get maximum concurrent thread count
@ -572,7 +572,7 @@ class CORE_EXPORT QgsApplication : public QApplication
static QString ABISYM( mBuildOutputPath );
/** List of gdal drivers to be skipped. Uses GDAL_SKIP to exclude them.
* @see skipGdalDriver, restoreGdalDriver */
* \see skipGdalDriver, restoreGdalDriver */
static QStringList ABISYM( mGdalSkipList );
/**

8
src/core/qgsattributetableconfig.h
View File

@ -147,27 +147,27 @@ class CORE_EXPORT QgsAttributeTableConfig
/** Returns the width of a column, or -1 if column should use default width.
* \param column column index
* @see setColumnWidth()
* \see setColumnWidth()
*/
int columnWidth( int column ) const;
/** Sets the width of a column.
* \param column column index
* \param width column width in pixels, or -1 if column should use default width
* @see columnWidth()
* \see columnWidth()
*/
void setColumnWidth( int column, int width );
/** Returns true if the specified column is hidden.
* \param column column index
* @see setColumnHidden()
* \see setColumnHidden()
*/
bool columnHidden( int column ) const;
/** Sets whether the specified column should be hidden.
* \param column column index
* \param hidden set to true to hide column
* @see columnHidden()
* \see columnHidden()
*/
void setColumnHidden( int column, bool hidden );

4
src/core/qgsbrowsermodel.h
View File

@ -146,14 +146,14 @@ class CORE_EXPORT QgsBrowserModel : public QAbstractItemModel
/**
* Adds a directory to the favorites group.
* \since QGIS 3.0
* @see removeFavorite()
* \see removeFavorite()
*/
void addFavoriteDirectory( const QString &directory );
/**
* Removes a favorite directory from its corresponding model index.
* \since QGIS 3.0
* @see addFavoriteDirectory()
* \see addFavoriteDirectory()
*/
void removeFavorite( const QModelIndex &index );

4
src/core/qgscachedfeatureiterator.h
View File

@ -62,7 +62,7 @@ class CORE_EXPORT QgsCachedFeatureIterator : public QgsAbstractFeatureIterator
* \param f Will write to this feature
* \returns bool true if the operation was ok
*
* @see bool getFeature( QgsFeature& f )
* \see bool getFeature( QgsFeature& f )
*/
virtual bool fetchFeature( QgsFeature &f ) override;
@ -119,7 +119,7 @@ class CORE_EXPORT QgsCachedFeatureWriterIterator : public QgsAbstractFeatureIter
* \param f Will write to this feature
* \returns bool true if the operation was ok
*
* @see bool getFeature( QgsFeature& f )
* \see bool getFeature( QgsFeature& f )
*/
virtual bool fetchFeature( QgsFeature &f ) override;

80
src/core/qgscolorramp.h
View File

@ -134,42 +134,42 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp
virtual QgsStringMap properties() const override;
/** Returns the gradient start color.
* @see setColor1()
* @see color2()
* \see setColor1()
* \see color2()
*/
QColor color1() const { return mColor1; }
/** Returns the gradient end color.
* @see setColor2()
* @see color1()
* \see setColor2()
* \see color1()
*/
QColor color2() const { return mColor2; }
/** Sets the gradient start color.
* \param color start color
* @see color1()
* @see setColor2()
* \see color1()
* \see setColor2()
*/
void setColor1( const QColor &color ) { mColor1 = color; }
/** Sets the gradient end color.
* \param color end color
* @see color2()
* @see setColor1()
* \see color2()
* \see setColor1()
*/
void setColor2( const QColor &color ) { mColor2 = color; }
/** Returns true if the gradient is using discrete interpolation, rather than
* smoothly interpolating between colors.
* @see setDiscrete()
* \see setDiscrete()
*/
bool isDiscrete() const { return mDiscrete; }
/** Sets whether the gradient should use discrete interpolation, rather than
* smoothly interpolating between colors.
* \param discrete set to true to use discrete interpolation
* @see convertToDiscrete()
* @see isDiscrete()
* \see convertToDiscrete()
* \see isDiscrete()
*/
void setDiscrete( bool discrete ) { mDiscrete = discrete; }
@ -177,7 +177,7 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp
* interpolation.
* \param discrete set to true to convert the gradient stops to discrete,
* or false to convert them to smooth interpolation
* @see isDiscrete()
* \see isDiscrete()
*/
void convertToDiscrete( bool discrete );
@ -185,23 +185,23 @@ class CORE_EXPORT QgsGradientColorRamp : public QgsColorRamp
* \param stops list of stops. Any existing color stops will be replaced. The stop
* list will be automatically reordered so that stops are listed in ascending offset
* order.
* @see stops()
* \see stops()
*/
void setStops( const QgsGradientStopsList &stops );
/** Returns the list of intermediate gradient stops for the ramp.
* @see setStops()
* \see setStops()
*/
QgsGradientStopsList stops() const { return mStops; }
/** Returns any additional info attached to the gradient ramp (e.g., authorship notes)
* @see setInfo()
* \see setInfo()
*/
QgsStringMap info() const { return mInfo; }
/** Sets additional info to attach to the gradient ramp (e.g., authorship notes)
* \param info map of string info to attach
* @see info()
* \see info()
*/
void setInfo( const QgsStringMap &info ) { mInfo = info; }
@ -255,7 +255,7 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp
/** Returns a new QgsLimitedRandomColorRamp color ramp created using the properties encoded in a string
* map.
* \param properties color ramp properties
* @see properties()
* \see properties()
*/
static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() );
@ -280,32 +280,32 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp
void updateColors();
/** Returns the minimum hue for generated colors
* @see setHueMin()
* \see setHueMin()
*/
int hueMin() const { return mHueMin; }
/** Returns the maximum hue for generated colors
* @see setHueMax()
* \see setHueMax()
*/
int hueMax() const { return mHueMax; }
/** Returns the minimum saturation for generated colors
* @see setSatMin()
* \see setSatMin()
*/
int satMin() const { return mSatMin; }
/** Returns the maximum saturation for generated colors
* @see setSatMax()
* \see setSatMax()
*/
int satMax() const { return mSatMax; }
/** Returns the minimum value for generated colors
* @see setValMin()
* \see setValMin()
*/
int valMin() const { return mValMin; }
/** Returns the maximum value for generated colors
* @see setValMax()
* \see setValMax()
*/
int valMax() const { return mValMax; }
@ -314,32 +314,32 @@ class CORE_EXPORT QgsLimitedRandomColorRamp : public QgsColorRamp
void setCount( int val ) { mCount = val; }
/** Sets the minimum hue for generated colors
* @see hueMin()
* \see hueMin()
*/
void setHueMin( int val ) { mHueMin = val; }
/** Sets the maximum hue for generated colors
* @see hueMax()
* \see hueMax()
*/
void setHueMax( int val ) { mHueMax = val; }
/** Sets the minimum saturation for generated colors
* @see satMin()
* \see satMin()
*/
void setSatMin( int val ) { mSatMin = val; }
/** Sets the maximum saturation for generated colors
* @see satMax()
* \see satMax()
*/
void setSatMax( int val ) { mSatMax = val; }
/** Sets the minimum value for generated colors
* @see valMin()
* \see valMin()
*/
void setValMin( int val ) { mValMin = val; }
/** Sets the maximum value for generated colors
* @see valMax()
* \see valMax()
*/
void setValMax( int val ) { mValMax = val; }
@ -411,18 +411,18 @@ class CORE_EXPORT QgsPresetSchemeColorRamp : public QgsColorRamp, public QgsColo
/** Returns a new QgsPresetSchemeColorRamp color ramp created using the properties encoded in a string
* map.
* \param properties color ramp properties
* @see properties()
* \see properties()
*/
static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() );
/** Sets the list of colors used by the ramp.
* \param colors list of colors
* @see colors()
* \see colors()
*/
bool setColors( const QgsNamedColorList &colors, const QString & = QString(), const QColor & = QColor() ) override { mColors = colors; return true; }
/** Returns the list of colors used by the ramp.
* @see setColors()
* \see setColors()
*/
QList< QColor > colors() const;
@ -471,7 +471,7 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp
/** Returns a new QgsColorBrewerColorRamp color ramp created using the properties encoded in a string
* map.
* \param properties color ramp properties
* @see properties()
* \see properties()
*/
static QgsColorRamp *create( const QgsStringMap &properties = QgsStringMap() );
@ -484,38 +484,38 @@ class CORE_EXPORT QgsColorBrewerColorRamp : public QgsColorRamp
virtual int count() const override { return mColors; }
/** Returns the name of the color brewer color scheme.
* @see setSchemeName()
* \see setSchemeName()
*/
QString schemeName() const { return mSchemeName; }
/** Returns the number of colors in the ramp.
* @see setColors()
* \see setColors()
*/
int colors() const { return mColors; }
/** Sets the name of the color brewer color scheme.
* \param schemeName scheme name, must match a valid color brewer scheme name
* @see schemeName()
* @see listSchemeNames()
* \see schemeName()
* \see listSchemeNames()
*/
void setSchemeName( const QString &schemeName ) { mSchemeName = schemeName; loadPalette(); }
/** Sets the number of colors in the ramp.
* \param colors number of colors. Must match a valid value for the scheme,
* which can be retrieved using listSchemeVariants()
* @see colors()
* \see colors()
*/
void setColors( int colors ) { mColors = colors; loadPalette(); }
/** Returns a list of all valid color brewer scheme names.
* @see listSchemeVariants()
* \see listSchemeVariants()
*/
static QStringList listSchemeNames();
/** Returns a list of the valid variants (numbers of colors) for a specified
* color brewer scheme name
* \param schemeName color brewer scheme name
* @see listSchemeNames()
* \see listSchemeNames()
*/
static QList<int> listSchemeVariants( const QString &schemeName );

8
src/core/qgscolorscheme.h
View File

@ -86,7 +86,7 @@ class CORE_EXPORT QgsColorScheme
/** Returns whether the color scheme is editable
* \returns true if scheme is editable
* @see setColors
* \see setColors
*/
virtual bool isEditable() const { return false; }
@ -95,7 +95,7 @@ class CORE_EXPORT QgsColorScheme
* \param context to set colors for
* \param baseColor base color to set colors for
* \returns true if colors were set successfully
* @see isEditable
* \see isEditable
*/
virtual bool setColors( const QgsNamedColorList &colors, const QString &context = QString(), const QColor &baseColor = QColor() );
@ -204,13 +204,13 @@ class CORE_EXPORT QgsRecentColorScheme : public QgsColorScheme
/** Adds a color to the list of recent colors.
* \param color color to add
* \since QGIS 2.14
* @see lastUsedColor()
* \see lastUsedColor()
*/
static void addRecentColor( const QColor &color );
/** Returns the most recently used color.
* \since QGIS 3.0
* @see addRecentColor()
* \see addRecentColor()
*/
static QColor lastUsedColor();
};

22
src/core/qgscolorschemeregistry.h
View File

@ -42,37 +42,37 @@ class CORE_EXPORT QgsColorSchemeRegistry
virtual ~QgsColorSchemeRegistry();
/** Adds all color schemes from the global instance to this color scheme.
* @see addDefaultSchemes
* @see addColorScheme
* \see addDefaultSchemes
* \see addColorScheme
*/
void populateFromInstance();
/** Adds all default color schemes to this color scheme.
* @see populateFromInstance
* @see addColorScheme
* @see addUserSchemes
* \see populateFromInstance
* \see addColorScheme
* \see addUserSchemes
*/
void addDefaultSchemes();
/** Creates schemes for all gpl palettes in the user's palettes folder.
* @see populateFromInstance
* @see addDefaultSchemes
* @see addColorScheme
* \see populateFromInstance
* \see addDefaultSchemes
* \see addColorScheme
*/
void addUserSchemes();
/** Adds a color scheme to the registry. Ownership of the scheme is transferred
* to the registry.
* \param scheme color scheme to add
* @see populateFromInstance
* @see removeColorScheme
* \see populateFromInstance
* \see removeColorScheme
*/
void addColorScheme( QgsColorScheme *scheme );
/** Removes all matching color schemes from the registry
* \param scheme color scheme to remove
* \returns true if scheme was found and removed
* @see addColorScheme
* \see addColorScheme
*/
bool removeColorScheme( QgsColorScheme *scheme );

36
src/core/qgscoordinatereferencesystem.h
View File

@ -216,7 +216,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
*
* If no prefix is specified, WKT definition is assumed.
* \param definition A String containing a coordinate reference system definition.
* @see createFromString()
* \see createFromString()
*/
// TODO QGIS 3: remove "POSTGIS" and "INTERNAL", allow PROJ4 without the prefix
explicit QgsCoordinateReferenceSystem( const QString &definition );
@ -240,7 +240,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* Returns a list of all valid SRS IDs present in the CRS database. Any of the
* returned values can be safely passed to fromSrsId() to create a new, valid
* QgsCoordinateReferenceSystem object.
* @see fromSrsId()
* \see fromSrsId()
* \since QGIS 3.0
*/
static QList< long > validSrsIds();
@ -251,7 +251,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326"
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* @see createFromOgcWmsCrs()
* \see createFromOgcWmsCrs()
*/
static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs );
@ -266,7 +266,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \param proj4 proj4 format string
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* @see createFromProj4()
* \see createFromProj4()
*/
static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 );
@ -274,7 +274,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \param wkt WKT for the desired spatial reference system.
* \returns matching CRS, or an invalid CRS if string could not be matched
* \since QGIS 3.0
* @see createFromWkt()
* \see createFromWkt()
*/
static QgsCoordinateReferenceSystem fromWkt( const QString &wkt );
@ -282,8 +282,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \param srsId internal QGIS SRS ID
* \returns matching CRS, or an invalid CRS if ID could not be found
* \since QGIS 3.0
* @see createFromSrsId()
* @see validSrsIds()
* \see createFromSrsId()
* \see validSrsIds()
*/
static QgsCoordinateReferenceSystem fromSrsId( long srsId );
@ -306,7 +306,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* and refer to QGIS internal CRS IDs.
* \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \returns True on success else false
* @see fromOgcWmsCrs()
* \see fromOgcWmsCrs()
*/
// TODO QGIS 3: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())
bool createFromOgcWmsCrs( const QString &crs );
@ -328,7 +328,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param wkt The WKT for the desired spatial reference system.
* \returns True on success else false
* @see fromWkt()
* \see fromWkt()
*/
bool createFromWkt( const QString &wkt );
@ -339,7 +339,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param srsId The internal QGIS CRS ID for the desired spatial reference system.
* \returns True on success else false
* @see fromSrsId()
* \see fromSrsId()
*/
bool createFromSrsId( const long srsId );
@ -363,7 +363,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* \note this method uses an internal cache. Call invalidateCache() to clear the cache.
* \param projString A proj4 format string
* \returns True on success else false
* @see fromProj4()
* \see fromProj4()
*/
bool createFromProj4( const QString &projString );
@ -420,7 +420,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
*
* \note It is not usually necessary to use this function, unless you
* are trying to force this CRS to be valid.
* @see setCustomCrsValidation(), customCrsValidation()
* \see setCustomCrsValidation(), customCrsValidation()
*/
void validate();
@ -492,7 +492,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* If CRS object is a custom CRS (not found in database), the method will return
* internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005"
* \returns the authority identifier for this CRS
* @see description()
* \see description()
*/
QString authid() const;
@ -501,27 +501,27 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* user.
* \returns descriptive name of the CRS
* \note an empty string will be returned if the description is not available for the CRS
* @see authid()
* \see authid()
*/
QString description() const;
/** Returns the projection acronym for the projection used by the CRS.
* \returns the official proj4 acronym for the projection family
* \note an empty string will be returned if the projectionAcronym is not available for the CRS
* @see ellipsoidAcronym()
* \see ellipsoidAcronym()
*/
QString projectionAcronym() const;
/** Returns the ellipsoid acronym for the ellipsoid used by the CRS.
* \returns the official proj4 acronym for the ellipoid
* \note an empty string will be returned if the ellipsoidAcronym is not available for the CRS
* @see projectionAcronym()
* \see projectionAcronym()
*/
QString ellipsoidAcronym() const;
/** Returns a WKT representation of this CRS.
* \returns string containing WKT of the CRS
* @see toProj4()
* \see toProj4()
*/
QString toWkt() const;
@ -532,7 +532,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
* overridden with these.
* \returns Proj4 format string that defines this CRS.
* \note an empty string will be returned if the CRS could not be represented by a Proj4 string
* @see toWkt()
* \see toWkt()
*/
QString toProj4() const;

20
src/core/qgscoordinatetransform.h
View File

@ -84,30 +84,30 @@ class CORE_EXPORT QgsCoordinateTransform
/*!
* Sets the source coordinate reference system.
* \param crs CRS to transform coordinates from
* @see sourceCrs()
* @see setDestinationCrs()
* \see sourceCrs()
* \see setDestinationCrs()
*/
void setSourceCrs( const QgsCoordinateReferenceSystem &crs );
/*!
* Sets the destination coordinate reference system.
* \param crs CRS to transform coordinates to
* @see destinationCrs()
* @see setSourceCrs()
* \see destinationCrs()
* \see setSourceCrs()
*/
void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
/** Returns the source coordinate reference system, which the transform will
* transform coordinates from.
* @see setSourceCrs()
* @see destinationCrs()
* \see setSourceCrs()
* \see destinationCrs()
*/
QgsCoordinateReferenceSystem sourceCrs() const;
/** Returns the destination coordinate reference system, which the transform will
* transform coordinates to.
* @see setDestinationCrs()
* @see sourceCrs()
* \see setDestinationCrs()
* \see sourceCrs()
*/
QgsCoordinateReferenceSystem destinationCrs() const;
@ -261,7 +261,7 @@ class CORE_EXPORT QgsCoordinateTransform
/** Restores state from the given Dom node.
* \param node The node from which state will be restored
* \returns bool True on success, False on failure
* @see writeXml()
* \see writeXml()
*/
bool readXml( const QDomNode &node );
@ -269,7 +269,7 @@ class CORE_EXPORT QgsCoordinateTransform
* \param node The node in which state will be restored
* \param document The document in which state will be stored
* \returns bool True on success, False on failure
* @see readXml()
* \see readXml()
*/
bool writeXml( QDomNode &node, QDomDocument &document ) const;

16
src/core/qgsdataitem.h
View File

@ -90,13 +90,13 @@ class CORE_EXPORT QgsDataItem : public QObject
/** Inserts a new child item. The child will be inserted at a position using an alphabetical order based on mName.
* \param child child item to insert. Ownership is transferred, and item parent will be set and relevant connections made.
* \param refresh - set to true to refresh populated item, emitting relevant signals to the model
* @see deleteChildItem()
* \see deleteChildItem()
*/
virtual void addChildItem( QgsDataItem *child, bool refresh = false );
/** Removes and deletes a child item, emitting relevant signals to the model.
* \param child child to remove. Item must exist as a current child.
* @see addChildItem()
* \see addChildItem()
*/
virtual void deleteChildItem( QgsDataItem *child );
@ -119,27 +119,27 @@ class CORE_EXPORT QgsDataItem : public QObject
/** Returns whether the item accepts drag and dropped layers - e.g. for importing a dataset to a provider.
* Subclasses should override this and handleDrop() to accept dropped layers.
* @see handleDrop()
* \see handleDrop()
*/
virtual bool acceptDrop() { return false; }
/** Attempts to process the mime data dropped on this item. Subclasses must override this and acceptDrop() if they
* accept dropped layers.
* @see acceptDrop()
* \see acceptDrop()
*/
virtual bool handleDrop( const QMimeData * /*data*/, Qt::DropAction /*action*/ ) { return false; }
/** Returns true if the item may be dragged.
* Default implementation returns false.
* A draggable item has to implement mimeUri() that will be used to pass data.
* @see mimeUri()
* \see mimeUri()
* \since QGIS 3.0
*/
virtual bool hasDragEnabled() const { return false; }
/** Return mime URI for the data item.
* Items that return valid URI will be returned in mime data when dragging a selection from browser model.
* @see hasDragEnabled()
* \see hasDragEnabled()
* \since QGIS 3.0
*/
virtual QgsMimeDataUtils::Uri mimeUri() const { return QgsMimeDataUtils::Uri(); }
@ -512,13 +512,13 @@ class CORE_EXPORT QgsFavoritesItem : public QgsDataCollectionItem
/**
* Adds a new directory to the favorites group.
* @see removeDirectory()
* \see removeDirectory()
*/
void addDirectory( const QString &directory );
/**
* Removes an existing directory from the favorites group.
* @see addDirectory()
* \see addDirectory()
*/
void removeDirectory( QgsDirectoryItem *item );

12
src/core/qgsdatetimestatisticalsummary.h
View File

@ -65,14 +65,14 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary
/** Returns flags which specify which statistics will be calculated. Some statistics
* are always calculated (e.g., count).
* @see setStatistics
* \see setStatistics
*/
Statistics statistics() const { return mStatistics; }
/** Sets flags which specify which statistics will be calculated. Some statistics
* are always calculated (e.g., count).
* \param stats flags for statistics to calculate
* @see statistics
* \see statistics
*/
void setStatistics( Statistics stats ) { mStatistics = stats; }
@ -83,7 +83,7 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary
/** Calculates summary statistics for a list of variants. Any non-datetime variants will be
* ignored.
* \param values list of variants
* @see addValue()
* \see addValue()
*/
void calculate( const QVariantList &values );
@ -96,14 +96,14 @@ class CORE_EXPORT QgsDateTimeStatisticalSummary
* to clear the results from any previous calculations
* \note finalize() must be called after adding the final value and before
* retrieving calculated statistics.
* @see calculate()
* @see finalize()
* \see calculate()
* \see finalize()
*/
void addValue( const QVariant &value );
/** Must be called after adding all datetimes with addValue() and before retrieving
* any calculated datetime statistics.
* @see addValue()
* \see addValue()
*/
void finalize();

88
src/core/qgsdiagramrenderer.h
View File

@ -115,21 +115,21 @@ class CORE_EXPORT QgsDiagramLayerSettings
/**
* Returns the diagram placement.
* @see setPlacement()
* \see setPlacement()
* \since QGIS 2.16
*/
Placement placement() const { return mPlacement; }
/** Sets the diagram placement.
* \param value placement value
* @see placement()
* \see placement()
* \since QGIS 2.16
*/
void setPlacement( Placement value ) { mPlacement = value; }
/** Returns the diagram placement flags. These are only used if the diagram placement
* is set to a line type.
* @see setLinePlacementFlags()
* \see setLinePlacementFlags()
* \since QGIS 2.16
*/
LinePlacementFlags linePlacementFlags() const { return mPlacementFlags; }
@ -137,7 +137,7 @@ class CORE_EXPORT QgsDiagramLayerSettings
/** Sets the the diagram placement flags. These are only used if the diagram placement
* is set to a line type.
* \param flags placement value
* @see getPlacement()
* \see getPlacement()
* \since QGIS 2.16
*/
void setLinePlacementFlags( LinePlacementFlags flags ) { mPlacementFlags = flags; }
@ -146,14 +146,14 @@ class CORE_EXPORT QgsDiagramLayerSettings
* \returns diagram priority, where 0 = low and 10 = high
* \note placement priority is shared with labeling, so diagrams with a high priority may displace labels
* and vice-versa
* @see setPriority()
* \see setPriority()
* \since QGIS 2.16
*/
int priority() const { return mPriority; }
/** Sets the diagram priority.
* \param value priority, where 0 = low and 10 = high
* @see priority()
* \see priority()
* \since QGIS 2.16
*/
void setPriority( int value ) { mPriority = value; }
@ -162,7 +162,7 @@ class CORE_EXPORT QgsDiagramLayerSettings
* with a lower z-index.
* \note z-index ordering is shared with labeling, so diagrams with a high z-index may be drawn over labels
* with a low z-index and vice-versa
* @see setZIndex()
* \see setZIndex()
* \since QGIS 2.16
*/
double zIndex() const { return mZIndex; }
@ -170,92 +170,92 @@ class CORE_EXPORT QgsDiagramLayerSettings
/** Sets the diagram z-index. Diagrams (or labels) with a higher z-index are drawn over diagrams
* with a lower z-index.
* \param index diagram z-index
* @see zIndex()
* \see zIndex()
* \since QGIS 2.16
*/
void setZIndex( double index ) { mZIndex = index; }
/** Returns whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
* @see setIsObstacle()
* \see setIsObstacle()
* \since QGIS 2.16
*/
bool isObstacle() const { return mObstacle; }
/** Sets whether the feature associated with a diagram acts as an obstacle for other labels or diagrams.
* \param isObstacle set to true for feature to act as obstacle
* @see isObstacle()
* \see isObstacle()
* \since QGIS 2.16
*/
void setIsObstacle( bool isObstacle ) { mObstacle = isObstacle; }
/** Returns the distance between the diagram and the feature (in mm).
* @see setDistance()
* \see setDistance()
* \since QGIS 2.16
*/
double distance() const { return mDistance; }
/** Sets the distance between the diagram and the feature.
* \param distance distance in mm
* @see distance()
* \see distance()
* \since QGIS 2.16
*/
void setDistance( double distance ) { mDistance = distance; }
/** Returns the diagram renderer associated with the layer.
* @see setRenderer()
* \see setRenderer()
* \since QGIS 2.16
*/
QgsDiagramRenderer *renderer() { return mRenderer; }
/** Returns the diagram renderer associated with the layer.
* @see setRenderer()
* \see setRenderer()
* \since QGIS 2.16
*/
const QgsDiagramRenderer *renderer() const { return mRenderer; }
/** Sets the diagram renderer associated with the layer.
* \param diagramRenderer diagram renderer. Ownership is transferred to the object.
* @see renderer()
* \see renderer()
* \since QGIS 2.16
*/
void setRenderer( QgsDiagramRenderer *diagramRenderer );
/** Returns the coordinate transform associated with the layer, or an
* invalid transform if no transformation is required.
* @see setCoordinateTransform()
* \see setCoordinateTransform()
* \since QGIS 2.16
*/
QgsCoordinateTransform coordinateTransform() const { return mCt; }
/** Sets the coordinate transform associated with the layer.
* \param transform coordinate transform. Ownership is transferred to the object.
* @see coordinateTransform()
* \see coordinateTransform()
* \since QGIS 2.16
*/
void setCoordinateTransform( const QgsCoordinateTransform &transform );
/** Returns whether the layer should show all diagrams, including overlapping diagrams
* @see setShowAllDiagrams()
* \see setShowAllDiagrams()
* \since QGIS 2.16
*/
bool showAllDiagrams() const { return mShowAll; }
/** Sets whether the layer should show all diagrams, including overlapping diagrams
* \param showAllDiagrams set to true to show all diagrams
* @see showAllDiagrams()
* \see showAllDiagrams()
* \since QGIS 2.16
*/
void setShowAllDiagrams( bool showAllDiagrams ) { mShowAll = showAllDiagrams; }
/**
* Reads the diagram settings from a DOM element.
* @see writeXml()
* \see writeXml()
*/
void readXml( const QDomElement &elem, const QgsVectorLayer *layer );
/**
* Writes the diagram settings to a DOM element.
* @see readXml()
* \see readXml()
*/
void writeXml( QDomElement &layerElem, QDomDocument &doc, const QgsVectorLayer *layer ) const;
@ -275,20 +275,20 @@ class CORE_EXPORT QgsDiagramLayerSettings
/** Returns a reference to the diagram's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setDataDefinedProperties()
* \see setDataDefinedProperties()
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/** Returns a reference to the diagram's property collection, used for data defined overrides.
* \since QGIS 3.0
* @see setProperties()
* \see setProperties()
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; }
/** Sets the diagram's property collection, used for data defined overrides.
* \param collection property collection. Existing properties will be replaced.
* \since QGIS 3.0
* @see dataDefinedProperties()
* \see dataDefinedProperties()
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
@ -496,14 +496,14 @@ class CORE_EXPORT QgsDiagramRenderer
/**
* Reads diagram state from a DOM element. Subclasses should ensure that _readXml() is called
* by their readXml implementation to restore the general QgsDiagramRenderer settings.
* @see writeXml()
* \see writeXml()
*/
virtual void readXml( const QDomElement &elem, const QgsVectorLayer *layer ) = 0;
/**
* Writes diagram state to a DOM element. Subclasses should ensure that _writeXml() is called
* by their writeXml implementation to save the general QgsDiagramRenderer settings.
* @see readXml()
* \see readXml()
*/
virtual void writeXml( QDomElement &layerElem, QDomDocument &doc, const QgsVectorLayer *layer ) const = 0;
@ -515,48 +515,48 @@ class CORE_EXPORT QgsDiagramRenderer
/** Returns true if renderer will show legend items for diagram attributes.
* \since QGIS 2.16
* @see setAttributeLegend()
* @see sizeLegend()
* \see setAttributeLegend()
* \see sizeLegend()
*/
bool attributeLegend() const { return mShowAttributeLegend; }
/** Sets whether the renderer will show legend items for diagram attributes.
* \param enabled set to true to show diagram attribute legend
* \since QGIS 2.16
* @see attributeLegend()
* @see setSizeLegend()
* \see attributeLegend()
* \see setSizeLegend()
*/
void setAttributeLegend( bool enabled ) { mShowAttributeLegend = enabled; }
/** Returns true if renderer will show legend items for diagram sizes.
* \since QGIS 2.16
* @see setSizeLegend()
* @see attributeLegend()
* @see sizeLegendSymbol()
* \see setSizeLegend()
* \see attributeLegend()
* \see sizeLegendSymbol()
*/
bool sizeLegend() const { return mShowSizeLegend; }
/** Sets whether the renderer will show legend items for diagram sizes.
* \param enabled set to true to show diagram size legend
* \since QGIS 2.16
* @see sizeLegend()
* @see setAttributeLegend()
* @see setSizeLegendSymbol()
* \see sizeLegend()
* \see setAttributeLegend()
* \see setSizeLegendSymbol()
*/
void setSizeLegend( bool enabled ) { mShowSizeLegend = enabled; }
/** Returns the marker symbol used for rendering the diagram size legend.
* \since QGIS 2.16
* @see setSizeLegendSymbol()
* @see sizeLegend()
* \see setSizeLegendSymbol()
* \see sizeLegend()
*/
QgsMarkerSymbol *sizeLegendSymbol() const { return mSizeLegendSymbol.get(); }
/** Sets the marker symbol used for rendering the diagram size legend.
* \param symbol marker symbol, ownership is transferred to the renderer.
* \since QGIS 2.16
* @see sizeLegendSymbol()
* @see setSizeLegend()
* \see sizeLegendSymbol()
* \see setSizeLegend()
*/
void setSizeLegendSymbol( QgsMarkerSymbol *symbol ) { mSizeLegendSymbol.reset( symbol ); }
@ -584,13 +584,13 @@ class CORE_EXPORT QgsDiagramRenderer
/**
* Reads internal QgsDiagramRenderer state from a DOM element.
* @see _writeXml()
* \see _writeXml()
*/
void _readXml( const QDomElement &elem, const QgsVectorLayer *layer );
/**
* Writes internal QgsDiagramRenderer diagram state to a DOM element.
* @see _readXml()
* \see _readXml()
*/
void _writeXml( QDomElement &rendererElem, QDomDocument &doc, const QgsVectorLayer *layer ) const;
@ -674,14 +674,14 @@ class CORE_EXPORT QgsLinearlyInterpolatedDiagramRenderer : public QgsDiagramRend
/**
* Returns the field name used for interpolating the diagram size.
* @see setClassificationField()
* \see setClassificationField()
* \since QGIS 3.0
*/
QString classificationField() const { return mInterpolationSettings.classificationField; }
/**
* Sets the field name used for interpolating the diagram size.
* @see classificationField()
* \see classificationField()
* \since QGIS 3.0
*/
void setClassificationField( const QString &field ) { mInterpolationSettings.classificationField = field; }

88
src/core/qgsdistancearea.h
View File

@ -52,22 +52,22 @@ class CORE_EXPORT QgsDistanceArea
/** Sets whether coordinates must be projected to ellipsoid before measuring
* \note for calculations to use the ellipsoid, both the ellipsoid mode must be true
* and an ellipse must be set
* @see setEllipsoid()
* @see willUseEllipsoid()
* \see setEllipsoid()
* \see willUseEllipsoid()
*/
void setEllipsoidalMode( bool flag );
/** Returns whether ellipsoidal calculations are enabled
* @see willUseEllipsoid()
* @see setEllipsoidalMode()
* \see willUseEllipsoid()
* \see setEllipsoidalMode()
*/
bool ellipsoidalEnabled() const { return mEllipsoidalMode; }
/** Returns whether calculations will use the ellipsoid. Calculations will only use the
* ellipsoid if ellipsoidalEnabled() is true and an ellipsoid has been set.
* \since QGIS 2.14
* @see ellipsoidalEnabled()
* @see ellipsoid()
* \see ellipsoidalEnabled()
* \see ellipsoid()
*/
bool willUseEllipsoid() const;
@ -77,7 +77,7 @@ class CORE_EXPORT QgsDistanceArea
/**
* Sets source spatial reference system (by QGIS CRS)
* \note: missing in Python bindings in QGIS < 2.2
* @see sourceCrs()
* \see sourceCrs()
*/
void setSourceCrs( const QgsCoordinateReferenceSystem &srcCRS );
@ -85,12 +85,12 @@ class CORE_EXPORT QgsDistanceArea
void setSourceAuthId( const QString &authid );
/** Returns the source spatial reference system.
* @see setSourceCrs()
* \see setSourceCrs()
*/
QgsCoordinateReferenceSystem sourceCrs() const { return mCoordTransform.sourceCrs(); }
/** Returns the QgsCoordinateReferenceSystem::srsid() for the CRS used during calculations.
* @see setSourceCrs()
* \see setSourceCrs()
* \since QGIS 2.14
*/
long sourceCrsId() const { return mCoordTransform.sourceCrs().srsid(); }
@ -101,27 +101,27 @@ class CORE_EXPORT QgsDistanceArea
/** Sets ellipsoid by its acronym. Calculations will only use the ellipsoid if
* both the ellipsoid has been set and ellipsoidalEnabled() is true.
* \returns true if ellipsoid was successfully set
* @see ellipsoid()
* @see setEllipsoidalMode()
* @see willUseEllipsoid()
* \see ellipsoid()
* \see setEllipsoidalMode()
* \see willUseEllipsoid()
*/
bool setEllipsoid( const QString &ellipsoid );
/** Sets ellipsoid by supplied radii. Calculations will only use the ellipsoid if
* both the ellipsoid has been set and ellipsoidalEnabled() is true.
* \returns true if ellipsoid was successfully set
* @see ellipsoid()
* @see setEllipsoidalMode()
* @see willUseEllipsoid()
* \see ellipsoid()
* \see setEllipsoidalMode()
* \see willUseEllipsoid()
*/
// Inverse flattening is calculated with invf = a/(a-b)
bool setEllipsoid( double semiMajor, double semiMinor );
/** Returns ellipsoid's acronym. Calculations will only use the
* ellipsoid if ellipsoidalEnabled() is true and an ellipsoid has been set.
* @see setEllipsoid()
* @see ellipsoidalEnabled()
* @see willUseEllipsoid()
* \see setEllipsoid()
* \see ellipsoidalEnabled()
* \see willUseEllipsoid()
*/
QString ellipsoid() const { return mEllipsoid; }
@ -137,9 +137,9 @@ class CORE_EXPORT QgsDistanceArea
* \returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the
* returned area can be retrieved by calling areaUnits().
* \since QGIS 2.12
* @see measureLength()
* @see measurePerimeter()
* @see areaUnits()
* \see measureLength()
* \see measurePerimeter()
* \see areaUnits()
*/
double measureArea( const QgsGeometry *geometry ) const;
@ -148,9 +148,9 @@ class CORE_EXPORT QgsDistanceArea
* \returns area of geometry. For geometry collections, non surface geometries will be ignored. The units for the
* returned area can be retrieved by calling areaUnits().
* \since QGIS 2.12
* @see measureLength()
* @see measurePerimeter()
* @see areaUnits()
* \see measureLength()
* \see measurePerimeter()
* \see areaUnits()
*/
double measureArea( const QgsGeometry &geometry ) const;
@ -159,9 +159,9 @@ class CORE_EXPORT QgsDistanceArea
* \returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the
* returned distance can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* @see lengthUnits()
* @see measureArea()
* @see measurePerimeter()
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
*/
double measureLength( const QgsGeometry *geometry ) const;
@ -170,9 +170,9 @@ class CORE_EXPORT QgsDistanceArea
* \returns length of geometry. For geometry collections, non curve geometries will be ignored. The units for the
* returned distance can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* @see lengthUnits()
* @see measureArea()
* @see measurePerimeter()
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
*/
double measureLength( const QgsGeometry &geometry ) const;
@ -181,9 +181,9 @@ class CORE_EXPORT QgsDistanceArea
* \returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the
* returned perimeter can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* @see lengthUnits()
* @see measureArea()
* @see measurePerimeter()
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
*/
double measurePerimeter( const QgsGeometry *geometry ) const;
@ -192,16 +192,16 @@ class CORE_EXPORT QgsDistanceArea
* \returns perimeter of geometry. For geometry collections, any non-polygon geometries will be ignored. The units for the
* returned perimeter can be retrieved by calling lengthUnits().
* \since QGIS 2.12
* @see lengthUnits()
* @see measureArea()
* @see measurePerimeter()
* \see lengthUnits()
* \see measureArea()
* \see measurePerimeter()
*/
double measurePerimeter( const QgsGeometry &geometry ) const;
/** Measures the length of a line with multiple segments.
* \param points list of points in line
* \returns length of line. The units for the returned length can be retrieved by calling lengthUnits().
* @see lengthUnits()
* \see lengthUnits()
*/
double measureLine( const QList<QgsPoint> &points ) const;
@ -209,7 +209,7 @@ class CORE_EXPORT QgsDistanceArea
* \param p1 start of line
* \param p2 end of line
* \returns distance between points. The units for the returned distance can be retrieved by calling lengthUnits().
* @see lengthUnits()
* \see lengthUnits()
*/
double measureLine( const QgsPoint &p1, const QgsPoint &p2 ) const;
@ -224,13 +224,13 @@ class CORE_EXPORT QgsDistanceArea
/** Returns the units of distance for length calculations made by this object.
* \since QGIS 2.14
* @see areaUnits()
* \see areaUnits()
*/
QgsUnitTypes::DistanceUnit lengthUnits() const;
/** Returns the units of area for areal calculations made by this object.
* \since QGIS 2.14
* @see lengthUnits()
* \see lengthUnits()
*/
QgsUnitTypes::AreaUnit areaUnits() const;
@ -248,7 +248,7 @@ class CORE_EXPORT QgsDistanceArea
* kilometers
* \returns formatted distance string
* \since QGIS 2.16
* @see formatArea()
* \see formatArea()
*/
static QString formatDistance( double distance, int decimals, QgsUnitTypes::DistanceUnit unit, bool keepBaseUnit = false );
@ -260,7 +260,7 @@ class CORE_EXPORT QgsDistanceArea
* square kilometers
* \returns formatted area string
* \since QGIS 2.14
* @see formatDistance()
* \see formatDistance()
*/
static QString formatArea( double area, int decimals, QgsUnitTypes::AreaUnit unit, bool keepBaseUnit = false );
@ -270,7 +270,7 @@ class CORE_EXPORT QgsDistanceArea
* was calculated by this class, ie that its unit of length is equal to lengthUnits().
* \param toUnits distance unit to convert measurement to
* \returns converted distance
* @see convertAreaMeasurement()
* \see convertAreaMeasurement()
* \since QGIS 2.14
*/
double convertLengthMeasurement( double length, QgsUnitTypes::DistanceUnit toUnits ) const;
@ -281,7 +281,7 @@ class CORE_EXPORT QgsDistanceArea
* was calculated by this class, ie that its unit of area is equal to areaUnits().
* \param toUnits area unit to convert measurement to
* \returns converted area
* @see convertLengthMeasurement()
* \see convertLengthMeasurement()
* \since QGIS 2.14
*/
double convertAreaMeasurement( double area, QgsUnitTypes::AreaUnit toUnits ) const;

2
src/core/qgseditformconfig.h
View File

@ -156,7 +156,7 @@ class CORE_EXPORT QgsEditFormConfig
* \returns false if a field exists with the provided widgetName. In this case
* QgsVectorLayer::setEditorWidgetSetup should be used.
*
* @see QgsVectorLayer::setEditorWidgetSetup() for field configurations.
* \see QgsVectorLayer::setEditorWidgetSetup() for field configurations.
*/
bool setWidgetConfig( const QString &widgetName, const QVariantMap &config );

52
src/core/qgsexpression.h
View File

@ -182,7 +182,7 @@ class CORE_EXPORT QgsExpression
* all attributes from the layer are required for evaluation of the expression.
* QgsFeatureRequest::setSubsetOfAttributes automatically handles this case.
*
* @see referencedAttributeIndexes()
* \see referencedAttributeIndexes()
*/
QSet<QString> referencedColumns() const;
@ -261,9 +261,9 @@ class CORE_EXPORT QgsExpression
/** Return calculator used for distance and area calculations
* (used by $length, $area and $perimeter functions only)
* @see setGeomCalculator()
* @see distanceUnits()
* @see areaUnits()
* \see setGeomCalculator()
* \see distanceUnits()
* \see areaUnits()
*/
QgsDistanceArea *geomCalculator();
@ -273,39 +273,39 @@ class CORE_EXPORT QgsExpression
* cartesian methods (ie no ellipsoidal calculations).
* \param calc geometry calculator. Ownership is not transferred. Set to a nullptr to force
* cartesian calculations.
* @see geomCalculator()
* \see geomCalculator()
*/
void setGeomCalculator( const QgsDistanceArea *calc );
/** Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
* \note distances are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* @see setDistanceUnits()
* @see areaUnits()
* \see setDistanceUnits()
* \see areaUnits()
*/
QgsUnitTypes::DistanceUnit distanceUnits() const;
/** Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
* \note distances are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* @see distanceUnits()
* @see setAreaUnits()
* \see distanceUnits()
* \see setAreaUnits()
*/
void setDistanceUnits( QgsUnitTypes::DistanceUnit unit );
/** Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area".
* \note areas are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* @see setAreaUnits()
* @see distanceUnits()
* \see setAreaUnits()
* \see distanceUnits()
*/
QgsUnitTypes::AreaUnit areaUnits() const;
/** Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area".
* \note areas are only converted when a geomCalculator() has been set
* \since QGIS 2.14
* @see areaUnits()
* @see setDistanceUnits()
* \see areaUnits()
* \see setDistanceUnits()
*/
void setAreaUnits( QgsUnitTypes::AreaUnit unit );
@ -606,7 +606,7 @@ class CORE_EXPORT QgsExpression
/** Returns a list of the groups the function belongs to.
* \since QGIS 3.0
* @see group()
* \see group()
*/
QStringList groups() const { return mGroups; }
@ -762,13 +762,13 @@ class CORE_EXPORT QgsExpression
* \param function function to register
* \param transferOwnership set to true to transfer ownership of function to expression engine
* \returns true on successful registration
* @see unregisterFunction
* \see unregisterFunction
*/
static bool registerFunction( Function *function, bool transferOwnership = false );
/** Unregisters a function from the expression engine. The function will no longer be usable in expressions.
* \param name function name
* @see registerFunction
* \see registerFunction
*/
static bool unregisterFunction( const QString &name );
@ -793,14 +793,14 @@ class CORE_EXPORT QgsExpression
static int functionCount();
/** Returns a quoted column reference (in double quotes)
* @see quotedString()
* @see quotedValue()
* \see quotedString()
* \see quotedValue()
*/
static QString quotedColumnRef( QString name );
/** Returns a quoted version of a string (in single quotes)
* @see quotedValue()
* @see quotedColumnRef()
* \see quotedValue()
* \see quotedColumnRef()
*/
static QString quotedString( QString text );
@ -808,8 +808,8 @@ class CORE_EXPORT QgsExpression
* quotations where required.
* \param value value to convert to a string representation
* \since QGIS 2.14
* @see quotedString()
* @see quotedColumnRef()
* \see quotedString()
* \see quotedColumnRef()
*/
static QString quotedValue( const QVariant &value );
@ -818,8 +818,8 @@ class CORE_EXPORT QgsExpression
* \param value value to convert to a string representation
* \param type value type
* \since QGIS 2.14
* @see quotedString()
* @see quotedColumnRef()
* \see quotedString()
* \see quotedColumnRef()
*/
static QString quotedValue( const QVariant &value, QVariant::Type type );
@ -1232,7 +1232,7 @@ class CORE_EXPORT QgsExpression
/** Returns the help text for a specified function.
* \param name function name
* @see variableHelpText()
* \see variableHelpText()
*/
static QString helpText( QString name );
@ -1240,7 +1240,7 @@ class CORE_EXPORT QgsExpression
* \param variableName name of variable
* \param showValue set to true to include current value of variable in help text
* \param value current value of variable to show in help text
* @see helpText()
* \see helpText()
* \since QGIS 2.12
*/
static QString variableHelpText( const QString &variableName, bool showValue = true, const QVariant &value = QVariant() );

162
src/core/qgsexpressioncontext.h
View File

@ -162,15 +162,15 @@ class CORE_EXPORT QgsExpressionContextScope
* with the same name is already set then its value is overwritten, otherwise a new variable is added to the scope.
* \param name variable name
* \param value variable value
* @see addVariable()
* \see addVariable()
*/
void setVariable( const QString &name, const QVariant &value );
/** Adds a variable into the context scope. If a variable with the same name is already set then its
* value is overwritten, otherwise a new variable is added to the scope.
* \param variable definition of variable to insert
* @see setVariable()
* @see addFunction()
* \see setVariable()
* \see addFunction()
*/
void addVariable( const QgsExpressionContextScope::StaticVariable &variable );
@ -184,29 +184,29 @@ class CORE_EXPORT QgsExpressionContextScope
/** Tests whether a variable with the specified name exists in the scope.
* \param name variable name
* \returns true if matching variable was found in the scope
* @see variable()
* @see hasFunction()
* \see variable()
* \see hasFunction()
*/
bool hasVariable( const QString &name ) const;
/** Retrieves a variable's value from the scope.
* \param name variable name
* \returns variable value, or invalid QVariant if matching variable could not be found
* @see hasVariable()
* @see function()
* \see hasVariable()
* \see function()
*/
QVariant variable( const QString &name ) const;
/** Returns a list of variable names contained within the scope.
* @see functionNames()
* @see filteredVariableNames()
* \see functionNames()
* \see filteredVariableNames()
*/
QStringList variableNames() const;
/** Returns a filtered and sorted list of variable names contained within the scope.
* Hidden variable names will be excluded, and the list will be sorted so that
* read only variables are listed first.
* @see variableNames()
* \see variableNames()
*/
QStringList filteredVariableNames() const;
@ -224,44 +224,44 @@ class CORE_EXPORT QgsExpressionContextScope
/** Tests whether a function with the specified name exists in the scope.
* \param name function name
* \returns true if matching function was found in the scope
* @see function()
* @see hasFunction()
* \see function()
* \see hasFunction()
*/
bool hasFunction( const QString &name ) const;
/** Retrieves a function from the scope.
* \param name function name
* \returns function, or null if matching function could not be found
* @see hasFunction()
* @see functionNames()
* @see variable()
* \see hasFunction()
* \see functionNames()
* \see variable()
*/
QgsExpression::Function *function( const QString &name ) const;
/** Retrieves a list of names of functions contained in the scope.
* @see function()
* @see variableNames()
* \see function()
* \see variableNames()
*/
QStringList functionNames() const;
/** Adds a function to the scope.
* \param name function name
* \param function function to insert. Ownership is transferred to the scope.
* @see addVariable()
* \see addVariable()
*/
void addFunction( const QString &name, QgsScopedExpressionFunction *function );
/**
* Returns true if the scope has a feature associated with it.
* \since QGIS 3.0
* @see feature()
* \see feature()
*/
bool hasFeature() const { return mHasFeature; }
/**
* Sets the feature associated with the scope.
* @see setFeature()
* @see hasFeature()
* \see setFeature()
* \see hasFeature()
* \since QGIS 3.0
*/
QgsFeature feature() const { return mFeature; }
@ -269,16 +269,16 @@ class CORE_EXPORT QgsExpressionContextScope
/** Convenience function for setting a feature for the scope. Any existing
* feature set by the scope will be overwritten.
* \param feature feature for scope
* @see removeFeature()
* @see feature()
* \see removeFeature()
* \see feature()
*/
void setFeature( const QgsFeature &feature ) { mHasFeature = true; mFeature = feature; }
/**
* Removes any feature associated with the scope.
* \since QGIS 3.0
* @see setFeature()
* @see hasFeature()
* \see setFeature()
* \see hasFeature()
*/
void removeFeature() { mHasFeature = false; mFeature = QgsFeature(); }
@ -335,8 +335,8 @@ class CORE_EXPORT QgsExpressionContext
/** Check whether a variable is specified by any scope within the context.
* \param name variable name
* \returns true if variable is set
* @see variable()
* @see variableNames()
* \see variable()
* \see variableNames()
*/
bool hasVariable( const QString &name ) const;
@ -345,8 +345,8 @@ class CORE_EXPORT QgsExpressionContext
* variable set.
* \param name variable name
* \returns variable value if matching variable exists in the context, otherwise an invalid QVariant
* @see hasVariable()
* @see variableNames()
* \see hasVariable()
* \see variableNames()
*/
QVariant variable( const QString &name ) const;
@ -361,14 +361,14 @@ class CORE_EXPORT QgsExpressionContext
* user. This is used by the expression builder to more prominently display the
* variable.
* \param name variable name
* @see setHighlightedVariables()
* \see setHighlightedVariables()
*/
bool isHighlightedVariable( const QString &name ) const;
/** Sets the list of variable names within the context intended to be highlighted to the user. This
* is used by the expression builder to more prominently display these variables.
* \param variableNames variable names to highlight
* @see isHighlightedVariable()
* \see isHighlightedVariable()
*/
void setHighlightedVariables( const QStringList &variableNames );
@ -392,12 +392,12 @@ class CORE_EXPORT QgsExpressionContext
/** Returns the scope at the specified index within the context.
* \param index index of scope
* \returns matching scope, or null if none found
* @see lastScope()
* \see lastScope()
*/
QgsExpressionContextScope *scope( int index );
/** Returns the last scope added to the context.
* @see scope()
* \see scope()
*/
QgsExpressionContextScope *lastScope();
@ -421,17 +421,17 @@ class CORE_EXPORT QgsExpressionContext
/** Returns a list of variables names set by all scopes in the context.
* \returns list of unique variable names
* @see filteredVariableNames
* @see functionNames
* @see hasVariable
* @see variable
* \see filteredVariableNames
* \see functionNames
* \see hasVariable
* \see variable
*/
QStringList variableNames() const;
/** Returns a filtered list of variables names set by all scopes in the context. The included
* variables are those which should be seen by users.
* \returns filtered list of unique variable names
* @see variableNames
* \see variableNames
*/
QStringList filteredVariableNames() const;
@ -445,13 +445,13 @@ class CORE_EXPORT QgsExpressionContext
/** Checks whether a specified function is contained in the context.
* \param name function name
* \returns true if context provides a matching function
* @see function
* \see function
*/
bool hasFunction( const QString &name ) const;
/** Retrieves a list of function names contained in the context.
* @see function()
* @see variableNames()
* \see function()
* \see variableNames()
*/
QStringList functionNames() const;
@ -460,7 +460,7 @@ class CORE_EXPORT QgsExpressionContext
* function set.
* \param name function name
* \returns function if contained by the context, otherwise null.
* @see hasFunction
* \see hasFunction
*/
QgsExpression::Function *function( const QString &name ) const;
@ -498,19 +498,19 @@ class CORE_EXPORT QgsExpressionContext
* will be set within the last scope of the context, so will override any
* existing features within the context.
* \param feature feature for context
* @see feature()
* \see feature()
*/
void setFeature( const QgsFeature &feature );
/**
* Returns true if the context has a feature associated with it.
* \since QGIS 3.0
* @see feature()
* \see feature()
*/
bool hasFeature() const;
/** Convenience function for retrieving the feature for the context, if set.
* @see setFeature
* \see setFeature
*/
QgsFeature feature() const;
@ -518,12 +518,12 @@ class CORE_EXPORT QgsExpressionContext
* will be set within the last scope of the context, so will override any
* existing fields within the context.
* \param fields fields for context
* @see fields()
* \see fields()
*/
void setFields( const QgsFields &fields );
/** Convenience function for retrieving the fields for the context, if set.
* @see setFields
* \see setFields
*/
QgsFields fields() const;
@ -539,18 +539,18 @@ class CORE_EXPORT QgsExpressionContext
* expression context.
* \param key unique key for retrieving cached value
* \param value value to cache
* @see hasCachedValue()
* @see cachedValue()
* @see clearCachedValues()
* \see hasCachedValue()
* \see cachedValue()
* \see clearCachedValues()
* \since QGIS 2.16
*/
void setCachedValue( const QString &key, const QVariant &value ) const;
/** Returns true if the expression context contains a cached value with a matching key.
* \param key unique key used to store cached value
* @see setCachedValue()
* @see cachedValue()
* @see clearCachedValues()
* \see setCachedValue()
* \see cachedValue()
* \see clearCachedValues()
* \since QGIS 2.16
*/
bool hasCachedValue( const QString &key ) const;
@ -559,17 +559,17 @@ class CORE_EXPORT QgsExpressionContext
* of an expensive expression sub-calculation.
* \param key unique key used to store cached value
* \returns matching cached value, or invalid QVariant if not set
* @see setCachedValue()
* @see hasCachedValue()
* @see clearCachedValues()
* \see setCachedValue()
* \see hasCachedValue()
* \see clearCachedValues()
* \since QGIS 2.16
*/
QVariant cachedValue( const QString &key ) const;
/** Clears all cached values from the context.
* @see setCachedValue()
* @see hasCachedValue()
* @see cachedValue()
* \see setCachedValue()
* \see hasCachedValue()
* \see cachedValue()
* \since QGIS 2.16
*/
void clearCachedValues() const;
@ -618,7 +618,7 @@ class CORE_EXPORT QgsExpressionContextUtils
/** Creates a new scope which contains variables and functions relating to the global QGIS context.
* For instance, QGIS version numbers and variables specified through QGIS options.
* @see setGlobalVariable()
* \see setGlobalVariable()
*/
static QgsExpressionContextScope *globalScope();
@ -626,23 +626,23 @@ class CORE_EXPORT QgsExpressionContextUtils
* globalScope().
* \param name variable name
* \param value variable value
* @see setGlobalVariable()
* @see globalScope()
* \see setGlobalVariable()
* \see globalScope()
*/
static void setGlobalVariable( const QString &name, const QVariant &value );
/** Sets all global context variables. Existing global variables will be removed and replaced
* with the variables specified.
* \param variables new set of global variables
* @see setGlobalVariable()
* @see globalScope()
* \see setGlobalVariable()
* \see globalScope()
*/
static void setGlobalVariables( const QVariantMap &variables );
/** Creates a new scope which contains variables and functions relating to a QGIS project.
* For instance, project path and title, and variables specified through the project properties.
* \param project What project to use
* @see setProjectVariable()
* \see setProjectVariable()
*/
static QgsExpressionContextScope *projectScope( const QgsProject *project );
@ -651,8 +651,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* \param project Project to apply changes to
* \param name variable name
* \param value variable value
* @see setProjectVariables()
* @see projectScope()
* \see setProjectVariables()
* \see projectScope()
*/
static void setProjectVariable( QgsProject *project, const QString &name, const QVariant &value );
@ -660,8 +660,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* with the variables specified.
* \param project Project to apply changes to
* \param variables new set of project variables
* @see setProjectVariable()
* @see projectScope()
* \see setProjectVariable()
* \see projectScope()
*/
static void setProjectVariables( QgsProject *project, const QVariantMap &variables );
@ -680,8 +680,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* \param layer map layer
* \param name variable name
* \param value variable value
* @see setLayerVariables()
* @see layerScope()
* \see setLayerVariables()
* \see layerScope()
*/
static void setLayerVariable( QgsMapLayer *layer, const QString &name, const QVariant &value );
@ -689,8 +689,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* with the variables specified.
* \param layer map layer
* \param variables new set of layer variables
* @see setLayerVariable()
* @see layerScope()
* \see setLayerVariable()
* \see layerScope()
*/
static void setLayerVariables( QgsMapLayer *layer, const QVariantMap &variables );
@ -718,8 +718,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* \param composition target composition
* \param name variable name
* \param value variable value
* @see setCompositionVariables()
* @see compositionScope()
* \see setCompositionVariables()
* \see compositionScope()
*/
static void setCompositionVariable( QgsComposition *composition, const QString &name, const QVariant &value );
@ -727,8 +727,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* with the variables specified.
* \param composition target composition
* \param variables new set of layer variables
* @see setCompositionVariable()
* @see compositionScope()
* \see setCompositionVariable()
* \see compositionScope()
*/
static void setCompositionVariables( QgsComposition *composition, const QVariantMap &variables );
@ -749,8 +749,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* \param composerItem target composer item
* \param name variable name
* \param value variable value
* @see setComposerItemVariables()
* @see composerItemScope()
* \see setComposerItemVariables()
* \see composerItemScope()
*/
static void setComposerItemVariable( QgsComposerItem *composerItem, const QString &name, const QVariant &value );
@ -758,8 +758,8 @@ class CORE_EXPORT QgsExpressionContextUtils
* with the variables specified.
* \param composerItem target composer item
* \param variables new set of layer variables
* @see setComposerItemVariable()
* @see composerItemScope()
* \see setComposerItemVariable()
* \see composerItemScope()
*/
static void setComposerItemVariables( QgsComposerItem *composerItem, const QVariantMap &variables );

46
src/core/qgsfeature.h
View File

@ -218,20 +218,20 @@ class CORE_EXPORT QgsFeature
/** Get the feature ID for this feature.
* \returns feature ID
* @see setId()
* \see setId()
*/
QgsFeatureId id() const;
/** Sets the feature ID for this feature.
* \param id feature id
* @see id
* \see id
*/
void setId( QgsFeatureId id );
/** Returns the feature's attributes.
* @link attributes @endlink method.
* \returns list of feature's attributes
* @see setAttributes
* \see setAttributes
* \since QGIS 2.9
* \note Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode
*/
@ -240,8 +240,8 @@ class CORE_EXPORT QgsFeature
/** Sets the feature's attributes.
* The feature will be valid after.
* \param attrs attribute list
* @see setAttribute
* @see attributes
* \see setAttribute
* \see attributes
*/
void setAttributes( const QgsAttributes &attrs );
@ -252,7 +252,7 @@ class CORE_EXPORT QgsFeature
* \returns false, if the field index does not exist
* \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code feature[field] = attr @endcode
* @see setAttributes
* \see setAttributes
*/
#ifndef SIP_RUN
bool setAttribute( int field, const QVariant &attr );
@ -287,7 +287,7 @@ class CORE_EXPORT QgsFeature
/** Deletes an attribute and its value.
* \param field the index of the field
* @see setAttribute
* \see setAttribute
* \note For Python: raises a KeyError exception if the field is not found
* \note Alternatively in Python: @code del feature[field] @endcode
*/
@ -307,39 +307,39 @@ class CORE_EXPORT QgsFeature
/** Returns the validity of this feature. This is normally set by
* the provider to indicate some problem that makes the feature
* invalid or to indicate a null feature.
* @see setValid
* \see setValid
*/
bool isValid() const;
/** Sets the validity of the feature.
* \param validity set to true if feature is valid
* @see isValid
* \see isValid
*/
void setValid( bool validity );
/** Returns true if the feature has an associated geometry.
* @see geometry()
* \see geometry()
* \since QGIS 3.0.
*/
bool hasGeometry() const;
/** Returns the geometry associated with this feature. If the feature has no geometry,
* an empty QgsGeometry object will be returned.
* @see hasGeometry()
* @see setGeometry()
* \see hasGeometry()
* \see setGeometry()
*/
QgsGeometry geometry() const;
/** Set the feature's geometry. The feature will be valid after.
* \param geometry new feature geometry
* @see geometry()
* @see clearGeometry()
* \see geometry()
* \see clearGeometry()
*/
void setGeometry( const QgsGeometry &geometry );
/** Removes any geometry associated with the feature.
* @see setGeometry()
* @see hasGeometry()
* \see setGeometry()
* \see hasGeometry()
* \since QGIS 3.0
*/
void clearGeometry();
@ -350,12 +350,12 @@ class CORE_EXPORT QgsFeature
* C++: Defaults to false
* Python: Defaults to true
* \since QGIS 2.9
* @see fields
* \see fields
*/
void setFields( const QgsFields &fields, bool initAttributes = false SIP_PYDEFAULTVALUE( true ) );
/** Returns the field map associated with the feature.
* @see setFields
* \see setFields
*/
QgsFields fields() const;
@ -367,7 +367,7 @@ class CORE_EXPORT QgsFeature
* \returns false if attribute name could not be converted to index (C++ only)
* \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code feature[name] = attr @endcode
* @see setFields
* \see setFields
*/
#ifndef SIP_RUN
bool setAttribute( const QString &name, const QVariant &value );
@ -400,7 +400,7 @@ class CORE_EXPORT QgsFeature
* \returns false if attribute name could not be converted to index (C++ only)
* \note For Python: raises a KeyError exception instead of returning false
* \note Alternatively in Python: @code del feature[name] @endcode
* @see setFields
* \see setFields
*/
bool deleteAttribute( const QString &name );
#ifdef SIP_RUN
@ -426,7 +426,7 @@ class CORE_EXPORT QgsFeature
* \returns The value of the attribute (C++: Invalid variant if no such name exists )
* \note For Python: raises a KeyError exception if the field is not found
* \note Alternatively in Python: @code feature[name] @endcode
* @see setFields
* \see setFields
*/
#ifndef SIP_RUN
QVariant attribute( const QString &name ) const;
@ -453,7 +453,7 @@ class CORE_EXPORT QgsFeature
* \returns The value of the attribute (C++: Invalid variant if no such index exists )
* \note For Python: raises a KeyError exception if the field is not found
* \note Alternatively in Python: @code feature[fieldIdx] @endcode
* @see setFields
* \see setFields
*/
#ifndef SIP_RUN
QVariant attribute( int fieldIdx ) const;
@ -479,7 +479,7 @@ class CORE_EXPORT QgsFeature
* before this method can be used.
* \param fieldName name of field to get attribute index of
* \returns -1 if field does not exist or field map is not associated.
* @see setFields
* \see setFields
*/
int fieldNameIndex( const QString &fieldName ) const;

22
src/core/qgsfeaturerequest.h
View File

@ -270,16 +270,16 @@ class CORE_EXPORT QgsFeatureRequest
//! Get feature IDs that should be fetched.
const QgsFeatureIds &filterFids() const { return mFilterFids; }
/** Set the filter expression. {@see QgsExpression}
/** Set the filter expression. {\see QgsExpression}
* \param expression expression string
* @see filterExpression
* @see setExpressionContext
* \see filterExpression
* \see setExpressionContext
*/
QgsFeatureRequest &setFilterExpression( const QString &expression );
/** Returns the filter expression if set.
* @see setFilterExpression
* @see expressionContext
* \see setFilterExpression
* \see expressionContext
*/
QgsExpression *filterExpression() const { return mFilterExpression.get(); }
@ -292,15 +292,15 @@ class CORE_EXPORT QgsFeatureRequest
/** Returns the expression context used to evaluate filter expressions.
* \since QGIS 2.12
* @see setExpressionContext
* @see filterExpression
* \see setExpressionContext
* \see filterExpression
*/
QgsExpressionContext *expressionContext() { return &mExpressionContext; }
/** Sets the expression context used to evaluate filter expressions.
* \since QGIS 2.12
* @see expressionContext
* @see setFilterExpression
* \see expressionContext
* \see setFilterExpression
*/
QgsFeatureRequest &setExpressionContext( const QgsExpressionContext &context );
@ -354,13 +354,13 @@ class CORE_EXPORT QgsFeatureRequest
/** Set the maximum number of features to request.
* \param limit maximum number of features, or -1 to request all features.
* @see limit()
* \see limit()
* \since QGIS 2.14
*/
QgsFeatureRequest &setLimit( long limit );
/** Returns the maximum number of features to request, or -1 if no limit set.
* @see setLimit
* \see setLimit
* \since QGIS 2.14
*/
long limit() const { return mLimit; }

12
src/core/qgsfeedback.h
View File

@ -64,8 +64,8 @@ class CORE_EXPORT QgsFeedback : public QObject
/**
* Sets the current progress for the feedback object. The \a progress
* argument is in percentage and valid values range from 0-100.
* @see progress()
* @see progressChanged()
* \see progress()
* \see progressChanged()
* \since QGIS 3.0
*/
void setProgress( double progress ) { mProgress = progress; emit progressChanged( mProgress ); }
@ -74,8 +74,8 @@ class CORE_EXPORT QgsFeedback : public QObject
* Returns the current progress reported by the feedback object. Depending on how the
* feedback object is used progress reporting may not be supported. The returned value
* is in percentage and ranges from 0-100.
* @see setProgress()
* @see progressChanged()
* \see setProgress()
* \see progressChanged()
* \since QGIS 3.0
*/
double progress() const { return mProgress; }
@ -89,8 +89,8 @@ class CORE_EXPORT QgsFeedback : public QObject
* feedback object is used progress reporting may not be supported. The \a progress
* argument is in percentage and ranges from 0-100.
* \since QGIS 3.0
* @see setProgress()
* @see progress()
* \see setProgress()
* \see progress()
*/
void progressChanged( double progress );

20
src/core/qgsfield.h
View File

@ -93,15 +93,15 @@ class CORE_EXPORT QgsField
bool operator!=( const QgsField &other ) const;
/** Returns the name of the field.
* @see setName()
* @see displayName()
* \see setName()
* \see displayName()
*/
QString name() const;
/** Returns the name to use when displaying this field. This will be the
* field alias if set, otherwise the field name.
* @see name()
* @see alias()
* \see name()
* \see alias()
* \since QGIS 3.0
*/
QString displayName() const;
@ -196,7 +196,7 @@ class CORE_EXPORT QgsField
* \returns expression evaluated when calculating default values for field, or an
* empty string if no default is set
* \since QGIS 3.0
* @see setDefaultValueExpression()
* \see setDefaultValueExpression()
*/
QString defaultValueExpression() const;
@ -204,34 +204,34 @@ class CORE_EXPORT QgsField
* \param expression expression to evaluate when calculating default values for field. Pass
* an empty expression to clear the default.
* \since QGIS 3.0
* @see defaultValueExpression()
* \see defaultValueExpression()
*/
void setDefaultValueExpression( const QString &expression );
/**
* Returns constraints which are present for the field.
* \since QGIS 3.0
* @see setConstraints()
* \see setConstraints()
*/
const QgsFieldConstraints &constraints() const;
/**
* Sets constraints which are present for the field.
* \since QGIS 3.0
* @see constraints()
* \see constraints()
*/
void setConstraints( const QgsFieldConstraints &constraints );
/** Returns the alias for the field (the friendly displayed name of the field ),
* or an empty string if there is no alias.
* @see setAlias()
* \see setAlias()
* \since QGIS 3.0
*/
QString alias() const;
/** Sets the alias for the field (the friendly displayed name of the field ).
* \param alias field alias, or empty string to remove an existing alias
* @see alias()
* \see alias()
* \since QGIS 3.0
*/
void setAlias( const QString &alias );

38
src/core/qgsfieldconstraints.h
View File

@ -75,23 +75,23 @@ class CORE_EXPORT QgsFieldConstraints
/**
* Returns any constraints which are present for the field.
* @see setConstraints()
* @see constraintOrigin()
* \see setConstraints()
* \see constraintOrigin()
*/
Constraints constraints() const { return mConstraints; }
/**
* Returns the origin of a field constraint, or ConstraintOriginNotSet if the constraint
* is not present on this field.
* @see constraints()
* \see constraints()
*/
ConstraintOrigin constraintOrigin( Constraint constraint ) const;
/**
* Returns the strength of a field constraint, or ConstraintStrengthNotSet if the constraint
* is not present on this field.
* @see constraints()
* @see setConstraintStrength()
* \see constraints()
* \see setConstraintStrength()
*/
ConstraintStrength constraintStrength( Constraint constraint ) const;
@ -99,46 +99,46 @@ class CORE_EXPORT QgsFieldConstraints
* Sets the strength of a constraint. Note that the strength of constraints which originate
* from a provider cannot be changed. Constraints default to ConstraintStrengthHard unless
* explicitly changed.
* @see constraintStrength()
* \see constraintStrength()
*/
void setConstraintStrength( Constraint constraint, ConstraintStrength strength );
/**
* Sets a constraint on the field.
* @see constraints()
* @see removeConstraint()
* \see constraints()
* \see removeConstraint()
*/
void setConstraint( Constraint constraint, ConstraintOrigin origin = ConstraintOriginLayer );
/**
* Removes a constraint from the field.
* @see setConstraint()
* @see constraints()
* \see setConstraint()
* \see constraints()
*/
void removeConstraint( Constraint constraint ) { mConstraints &= ~constraint; }
/**
* Returns the constraint expression for the field, if set.
* @see constraints()
* @see constraintDescription()
* @see setConstraintExpression()
* \see constraints()
* \see constraintDescription()
* \see setConstraintExpression()
*/
QString constraintExpression() const;
/**
* Returns the descriptive name for the constraint expression.
* @see constraints()
* @see constraintExpression()
* @see setConstraintExpression()
* \see constraints()
* \see constraintExpression()
* \see setConstraintExpression()
*/
QString constraintDescription() const { return mExpressionConstraintDescription; }
/**
* Set the constraint expression for the field. An optional descriptive name for the constraint
* can also be set. Setting an empty expression will clear any existing expression constraint.
* @see constraintExpression()
* @see constraintDescription()
* @see constraints()
* \see constraintExpression()
* \see constraintDescription()
* \see constraints()
*/
void setConstraintExpression( const QString &expression, const QString &description = QString() );

6
src/core/qgsfields.h
View File

@ -132,7 +132,7 @@ class CORE_EXPORT QgsFields
* \param fieldName The name of the field.
*
* \returns The field index if found or -1 in case it cannot be found.
* @see lookupField For a more tolerant alternative.
* \see lookupField For a more tolerant alternative.
*/
int indexFromName( const QString &fieldName ) const;
@ -144,7 +144,7 @@ class CORE_EXPORT QgsFields
* \param fieldName The name of the field.
*
* \returns The field index if found or -1 in case it cannot be found.
* @see lookupField For a more tolerant alternative.
* \see lookupField For a more tolerant alternative.
* \since QGIS 3.0
*/
int indexOf( const QString &fieldName ) const;
@ -160,7 +160,7 @@ class CORE_EXPORT QgsFields
* \param fieldName The name to look for.
*
* \returns The field index if found or -1 in case it cannot be found.
* @see indexFromName For a more performant and precise but less tolerant alternative.
* \see indexFromName For a more performant and precise but less tolerant alternative.
* \since QGIS 2.4
*/
int lookupField( const QString &fieldName ) const;

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