mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-15 00:04:00 -04:00
@return(s) -> \return(s)
This commit is contained in:
parent
11dcfd935c
commit
e4daf8ea62
@ -101,7 +101,7 @@ class ANALYSIS_EXPORT DualEdgeTriangulation: public Triangulation
|
||||
virtual QList<int> *getPointsAroundEdge( double x, double y ) override;
|
||||
|
||||
/** Saves the triangulation as a (line) shapefile
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
virtual bool saveAsShapefile( const QString &fileName ) const override;
|
||||
|
||||
protected:
|
||||
|
@ -66,7 +66,7 @@ class ANALYSIS_EXPORT NormVecDecorator: public TriDecorator
|
||||
virtual bool swapEdge( double x, double y ) override;
|
||||
|
||||
/** Saves the triangulation as a (line) shapefile
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
virtual bool saveAsShapefile( const QString &fileName ) const override;
|
||||
|
||||
protected:
|
||||
|
@ -52,7 +52,7 @@ class ANALYSIS_EXPORT Triangulation
|
||||
|
||||
/**
|
||||
* Calculates the normal at a point on the surface and assigns it to 'result'.
|
||||
* @return true in case of success and false in case of failure
|
||||
* \return true in case of success and false in case of failure
|
||||
*/
|
||||
virtual bool calcNormal( double x, double y, Vector3D *result ) = 0;
|
||||
|
||||
@ -148,7 +148,7 @@ class ANALYSIS_EXPORT Triangulation
|
||||
|
||||
/**
|
||||
* Saves the triangulation as a (line) shapefile
|
||||
* @return true in case of success
|
||||
* \return true in case of success
|
||||
*/
|
||||
virtual bool saveAsShapefile( const QString &fileName ) const = 0;
|
||||
};
|
||||
|
@ -35,7 +35,7 @@ class ANALYSIS_EXPORT QgsGridFileWriter
|
||||
|
||||
/** Writes the grid file.
|
||||
\param showProgressDialog shows a dialog with the possibility to cancel
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
|
||||
int writeFile( bool showProgressDialog = false );
|
||||
|
||||
|
@ -33,7 +33,7 @@ class ANALYSIS_EXPORT QgsIDWInterpolator: public QgsInterpolator
|
||||
\param x x-coordinate (in map units)
|
||||
\param y y-coordinate (in map units)
|
||||
\param result out: interpolation result
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int interpolatePoint( double x, double y, double &result ) override;
|
||||
|
||||
void setDistanceCoefficient( double p ) {mDistanceCoefficient = p;}
|
||||
|
@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsInterpolator
|
||||
\param x x-coordinate (in map units)
|
||||
\param y y-coordinate (in map units)
|
||||
\param result out: interpolation result
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
virtual int interpolatePoint( double x, double y, double &result ) = 0;
|
||||
|
||||
//! \note not available in Python bindings
|
||||
@ -73,7 +73,7 @@ class ANALYSIS_EXPORT QgsInterpolator
|
||||
|
||||
/** Caches the vertex and value data from the provider. All the vertex data
|
||||
will be held in virtual memory
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int cacheBaseData();
|
||||
|
||||
QVector<vertexData> mCachedBaseData;
|
||||
@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsInterpolator
|
||||
\param geom the geometry
|
||||
\param zCoord true if the z-coordinate of the geometry is to be interpolated
|
||||
\param attributeValue the attribute value for interpolation (if not interpolated from z-coordinate)
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int addVerticesToCache( const QgsGeometry &geom, bool zCoord, double attributeValue );
|
||||
};
|
||||
|
||||
|
@ -44,7 +44,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
|
||||
\param x x-coordinate (in map units)
|
||||
\param y y-coordinate (in map units)
|
||||
\param result out: interpolation result
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int interpolatePoint( double x, double y, double &result ) override;
|
||||
|
||||
void setExportTriangulationToFile( bool e ) {mExportTriangulationToFile = e;}
|
||||
@ -70,7 +70,7 @@ class ANALYSIS_EXPORT QgsTINInterpolator: public QgsInterpolator
|
||||
\param zCoord true if the z coordinate is the interpolation attribute
|
||||
\param attr interpolation attribute index (if zCoord is false)
|
||||
\param type point/structure line, break line
|
||||
@return 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/
|
||||
\return 0 in case of success, -1 if the feature could not be inserted because of numerical problems*/
|
||||
int insertData( QgsFeature *f, bool zCoord, int attr, InputType type );
|
||||
};
|
||||
|
||||
|
@ -69,13 +69,13 @@ class ANALYSIS_EXPORT QgsOSMDownload : public QObject
|
||||
*
|
||||
* Only one request may be pending at one point - if you need more requests at once, use several instances.
|
||||
*
|
||||
* @return true if the network request has been issued, false otherwise (and sets error string)
|
||||
* \return true if the network request has been issued, false otherwise (and sets error string)
|
||||
*/
|
||||
bool start();
|
||||
|
||||
/**
|
||||
* @brief Aborts current pending request
|
||||
* @return true if there is a pending request and has been aborted, false otherwise
|
||||
* \return true if there is a pending request and has been aborted, false otherwise
|
||||
*/
|
||||
bool abort();
|
||||
|
||||
|
@ -56,7 +56,7 @@ class ANALYSIS_EXPORT QgsOSMXmlImport : public QObject
|
||||
|
||||
/**
|
||||
* Run import. This will parse the XML file and store the data in a SQLite database.
|
||||
* @return true on success, false when import failed (see errorString() for the error)
|
||||
* \return true on success, false when import failed (see errorString() for the error)
|
||||
*/
|
||||
bool import();
|
||||
|
||||
|
@ -145,7 +145,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
|
||||
{
|
||||
//! Method to be overridden for progress reporting.
|
||||
//! \param complete Overall progress of the alignment operation
|
||||
//! @return false if the execution should be canceled, true otherwise
|
||||
//! \return false if the execution should be canceled, true otherwise
|
||||
virtual bool progress( double complete ) = 0;
|
||||
|
||||
virtual ~ProgressHandler() = default;
|
||||
@ -194,14 +194,14 @@ class ANALYSIS_EXPORT QgsAlignRaster
|
||||
//! If a custom CRS is provided, suggested reprojection is calculated first (using GDAL) in order
|
||||
//! to determine suitable defaults for cell size and grid offset.
|
||||
//!
|
||||
//! @return true on success (may fail if it is not possible to reproject raster to given CRS)
|
||||
//! \return true on success (may fail if it is not possible to reproject raster to given CRS)
|
||||
bool setParametersFromRaster( const RasterInfo &rasterInfo, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
|
||||
//! Overridden variant for convenience, taking filename instead RasterInfo object.
|
||||
//! See the other variant for details.
|
||||
bool setParametersFromRaster( const QString &filename, const QString &customCRSWkt = QString(), QSizeF customCellSize = QSizeF(), QPointF customGridOffset = QPointF( -1, -1 ) );
|
||||
|
||||
//! Determine destination extent from the input rasters and calculate derived values
|
||||
//! @return true on success, sets error on error (see errorMessage())
|
||||
//! \return true on success, sets error on error (see errorMessage())
|
||||
bool checkInputParameters();
|
||||
|
||||
//! Return expected size of the resulting aligned raster
|
||||
@ -212,7 +212,7 @@ class ANALYSIS_EXPORT QgsAlignRaster
|
||||
QgsRectangle alignedRasterExtent() const;
|
||||
|
||||
//! Run the alignment process
|
||||
//! @return true on success, sets error on error (see errorMessage())
|
||||
//! \return true on success, sets error on error (see errorMessage())
|
||||
bool run();
|
||||
|
||||
//! Return error from a previous run() call.
|
||||
|
@ -38,7 +38,7 @@ class ANALYSIS_EXPORT QgsNineCellFilter
|
||||
|
||||
/** Starts the calculation, reads from mInputFile and stores the result in mOutputFile
|
||||
\param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed.
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int processRaster( QProgressDialog *p );
|
||||
|
||||
double cellSizeX() const { return mCellSizeX; }
|
||||
@ -68,11 +68,11 @@ class ANALYSIS_EXPORT QgsNineCellFilter
|
||||
GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
|
||||
|
||||
/** Opens the output driver and tests if it supports the creation of a new dataset
|
||||
@return nullptr on error and the driver handle on success*/
|
||||
\return nullptr on error and the driver handle on success*/
|
||||
GDALDriverH openOutputDriver();
|
||||
|
||||
/** Opens the output file and sets the same geotransform and CRS as the input data
|
||||
@return the output dataset or nullptr in case of error*/
|
||||
\return the output dataset or nullptr in case of error*/
|
||||
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );
|
||||
|
||||
protected:
|
||||
|
@ -81,7 +81,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
|
||||
|
||||
/** Starts the calculation and writes new raster
|
||||
\param p progress bar (or 0 if called from non-gui code)
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
//TODO QGIS 3.0 - return QgsRasterCalculator::Result
|
||||
int processCalculation( QProgressDialog *p = nullptr );
|
||||
|
||||
@ -90,11 +90,11 @@ class ANALYSIS_EXPORT QgsRasterCalculator
|
||||
QgsRasterCalculator();
|
||||
|
||||
/** Opens the output driver and tests if it supports the creation of a new dataset
|
||||
@return nullptr on error and the driver handle on success*/
|
||||
\return nullptr on error and the driver handle on success*/
|
||||
GDALDriverH openOutputDriver();
|
||||
|
||||
/** Opens the output file and sets the same geotransform and CRS as the input data
|
||||
@return the output dataset or nullptr in case of error*/
|
||||
\return the output dataset or nullptr in case of error*/
|
||||
GDALDatasetH openOutputFile( GDALDriverH outputDriver );
|
||||
|
||||
/** Sets gdal 6 parameters array from mOutputRectangle, mNumOutputColumns, mNumOutputRows
|
||||
|
@ -53,7 +53,7 @@ class ANALYSIS_EXPORT QgsRelief
|
||||
|
||||
/** Starts the calculation, reads from mInputFile and stores the result in mOutputFile
|
||||
\param p progress dialog that receives update and that is checked for abort. 0 if no progress bar is needed.
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int processRaster( QProgressDialog *p );
|
||||
|
||||
double zFactor() const { return mZFactor; }
|
||||
@ -65,7 +65,7 @@ class ANALYSIS_EXPORT QgsRelief
|
||||
void setReliefColors( const QList< ReliefColor > &c ) { mReliefColors = c; }
|
||||
|
||||
/** Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
QList< ReliefColor > calculateOptimizedReliefClasses();
|
||||
|
||||
//! Write frequency of elevation values to file for manual inspection
|
||||
@ -102,11 +102,11 @@ class ANALYSIS_EXPORT QgsRelief
|
||||
GDALDatasetH openInputFile( int &nCellsX, int &nCellsY );
|
||||
|
||||
/** Opens the output driver and tests if it supports the creation of a new dataset
|
||||
@return nullptr on error and the driver handle on success*/
|
||||
\return nullptr on error and the driver handle on success*/
|
||||
GDALDriverH openOutputDriver();
|
||||
|
||||
/** Opens the output file and sets the same geotransform and CRS as the input data
|
||||
@return the output dataset or nullptr in case of error*/
|
||||
\return the output dataset or nullptr in case of error*/
|
||||
GDALDatasetH openOutputFile( GDALDatasetH inputDataset, GDALDriverH outputDriver );
|
||||
|
||||
//! Set elevation color
|
||||
@ -116,7 +116,7 @@ class ANALYSIS_EXPORT QgsRelief
|
||||
void setDefaultReliefColors();
|
||||
|
||||
/** Returns class (0-255) for an elevation value
|
||||
@return elevation class or -1 in case of error*/
|
||||
\return elevation class or -1 in case of error*/
|
||||
int frequencyClassForElevation( double elevation, double minElevation, double elevationClassRange );
|
||||
//! Do one iteration of class break optimisation (algorithm from Garcia and Rodriguez)
|
||||
void optimiseClassBreaks( QList<int> &breaks, double *frequencies );
|
||||
|
@ -34,7 +34,7 @@ class ANALYSIS_EXPORT QgsPointSample
|
||||
QgsPointSample( QgsVectorLayer *inputLayer, const QString &outputLayer, const QString &nPointsAttribute, const QString &minDistAttribute = QString() );
|
||||
|
||||
/** Starts calculation of random points
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int createRandomPoints( QProgressDialog *pd );
|
||||
|
||||
private:
|
||||
|
@ -82,7 +82,7 @@ class ANALYSIS_EXPORT QgsTransectSample
|
||||
\param dist out: distance between the segments
|
||||
\param pt1 out: closest point on first geometry
|
||||
\param pt2 out: closest point on secont geometry
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
static bool closestSegmentPoints( const QgsGeometry &g1, const QgsGeometry &g2, double &dist, QgsPoint &pt1, QgsPoint &pt2 );
|
||||
//! Returns a copy of the multiline element closest to a point (caller takes ownership)
|
||||
static QgsGeometry closestMultilineElement( const QgsPoint &pt, const QgsGeometry &multiLine );
|
||||
@ -91,7 +91,7 @@ class ANALYSIS_EXPORT QgsTransectSample
|
||||
\param stratumGeom stratum polygon
|
||||
\param clippedBaseline base line geometry clipped to the stratum
|
||||
\param tolerance buffer distance (in layer units)
|
||||
@return clipped buffer line or 0 in case of error*/
|
||||
\return clipped buffer line or 0 in case of error*/
|
||||
QgsGeometry *clipBufferLine( const QgsGeometry &stratumGeom, QgsGeometry *clippedBaseline, double tolerance );
|
||||
|
||||
//! Returns distance to buffer the baseline (takes care of units and buffer settings
|
||||
|
@ -63,7 +63,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
|
||||
Statistics stats = Statistics( Count | Sum | Mean ) );
|
||||
|
||||
/** Starts the calculation
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int calculateStatistics( QProgressDialog *p );
|
||||
|
||||
private:
|
||||
@ -111,7 +111,7 @@ class ANALYSIS_EXPORT QgsZonalStatistics
|
||||
};
|
||||
|
||||
/** Analysis what cells need to be considered to cover the bounding box of a feature
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int cellInfoForBBox( const QgsRectangle &rasterBBox, const QgsRectangle &featureBBox, double cellSizeX, double cellSizeY,
|
||||
int &offsetX, int &offsetY, int &nCellsX, int &nCellsY ) const;
|
||||
|
||||
|
@ -125,7 +125,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
|
||||
/** Loads the contents of a template document into the composer's composition.
|
||||
* \param templateDoc template document to load
|
||||
* \param clearExisting set to true to remove all existing composition settings and items before loading template
|
||||
* @returns true if template load was successful
|
||||
* \returns true if template load was successful
|
||||
*/
|
||||
bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting );
|
||||
|
||||
|
@ -46,7 +46,7 @@ class QgsComposerImageExportOptionsDialog: public QDialog, private Ui::QgsCompos
|
||||
void setResolution( int resolution );
|
||||
|
||||
/** Returns the selected resolution from the dialog.
|
||||
* @returns image resolution in DPI
|
||||
* \returns image resolution in DPI
|
||||
* @see setResolution()
|
||||
*/
|
||||
int resolution() const;
|
||||
|
@ -35,7 +35,7 @@ class dxfRW
|
||||
* components being added.
|
||||
* \param interface_ the interface to use
|
||||
* \param ext should the extrusion be applied to convert in 2D?
|
||||
* @return true for success
|
||||
* \return true for success
|
||||
*/
|
||||
bool read( DRW_Interface *interface_, bool ext );
|
||||
void setBinary( bool b ) {binFile = b;}
|
||||
|
@ -101,7 +101,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
|
||||
* Function to check if selected feature exists and is same with original one
|
||||
* stored in internal structures
|
||||
* \param vlayer vector layer for checking
|
||||
* @return if feature is same as one in internal structures
|
||||
* \return if feature is same as one in internal structures
|
||||
*/
|
||||
bool checkCorrectnessOfFeature( QgsVectorLayer *vlayer );
|
||||
|
||||
@ -124,7 +124,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
|
||||
This is useful for snapping operations that just require a position to snap to and not all the
|
||||
snapping results. If the list is empty, the screen coordinates are transformed into map coordinates and returned
|
||||
\param snapResults results collected from the snapping operation.
|
||||
@return the snapped point in map coordinates*/
|
||||
\return the snapped point in map coordinates*/
|
||||
QgsPoint snapPointFromResults( const QList<QgsSnappingResult> &snapResults, QPoint screenCoords );
|
||||
|
||||
/** Inserts vertices to the snapped segments of the editing layer.
|
||||
@ -132,7 +132,7 @@ class QgsMapToolNodeTool: public QgsMapToolEdit
|
||||
\param snapResults results collected from the snapping operation
|
||||
\param editedLayer pointer to the editing layer
|
||||
\param skipFids set of feature IDs to avoid inserting vertices in
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int insertSegmentVerticesForSnap( const QList<QgsSnappingResult> &snapResults, QgsVectorLayer *editedLayer, const QgsFeatureIds &skipFids );
|
||||
|
||||
/** Snapper object that reads the settings from project and option
|
||||
|
@ -97,19 +97,19 @@ class QgsSelectedFeature: public QObject
|
||||
/**
|
||||
* Tells if vertex is selected
|
||||
* \param vertexNr number of vertex for which we are getting info
|
||||
* @return true if vertex is selected, false otherwise
|
||||
* \return true if vertex is selected, false otherwise
|
||||
*/
|
||||
bool isSelected( int vertexNr );
|
||||
|
||||
/**
|
||||
* Getting feature Id of feature selected
|
||||
* @return feature id of selected feature
|
||||
* \return feature id of selected feature
|
||||
*/
|
||||
QgsFeatureId featureId();
|
||||
|
||||
/**
|
||||
* Getting vertex map of vertexes
|
||||
* @return currently used vertex map
|
||||
* \return currently used vertex map
|
||||
*/
|
||||
QList<QgsVertexEntry *> &vertexMap();
|
||||
|
||||
@ -120,7 +120,7 @@ class QgsSelectedFeature: public QObject
|
||||
|
||||
/**
|
||||
* Get the layer of the selected feature
|
||||
* @return used vector layer
|
||||
* \return used vector layer
|
||||
*/
|
||||
QgsVectorLayer *vlayer();
|
||||
|
||||
|
@ -173,19 +173,19 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* file names instead of prompting user with a dialog.
|
||||
\param enc encoding type for the layer
|
||||
\param dataSourceType type of ogr datasource
|
||||
@returns true if successfully added layer
|
||||
\returns true if successfully added layer
|
||||
*/
|
||||
bool addVectorLayers( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType );
|
||||
|
||||
/** Overloaded vesion of the private addRasterLayer()
|
||||
Method that takes a list of file names instead of prompting
|
||||
user with a dialog.
|
||||
@returns true if successfully added layer(s)
|
||||
\returns true if successfully added layer(s)
|
||||
*/
|
||||
bool addRasterLayers( const QStringList &layerQStringList, bool guiWarning = true );
|
||||
|
||||
/** Open a raster layer for the given file
|
||||
@returns false if unable to open a raster layer for rasterFile
|
||||
\returns false if unable to open a raster layer for rasterFile
|
||||
\note
|
||||
This is essentially a simplified version of the above
|
||||
*/
|
||||
@ -208,7 +208,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
Used to process a commandline argument, FileOpen or Drop event.
|
||||
Set interactive to true if it is ok to ask the user for information (mostly for
|
||||
when a vector layer has sublayers and we want to ask which sublayers to use).
|
||||
@returns true if the file is successfully opened
|
||||
\returns true if the file is successfully opened
|
||||
*/
|
||||
bool openLayer( const QString &fileName, bool allowInteractive = false );
|
||||
|
||||
@ -223,7 +223,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
void openTemplate( const QString &fileName );
|
||||
|
||||
/** Opens a qgis project file
|
||||
@returns false if unable to open the project
|
||||
\returns false if unable to open the project
|
||||
*/
|
||||
bool addProject( const QString &projectFile );
|
||||
|
||||
@ -342,7 +342,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
/** Get a unique title from user for new and duplicate composers
|
||||
* \param acceptEmpty whether to accept empty titles (one will be generated)
|
||||
* \param currentTitle base name for initial title choice
|
||||
* @return QString::null if user cancels input dialog
|
||||
* \return QString::null if user cancels input dialog
|
||||
*/
|
||||
bool uniqueComposerTitle( QWidget *parent, QString &composerTitle, bool acceptEmpty, const QString ¤tTitle = QString() );
|
||||
//! Creates a new composer and returns a pointer to it
|
||||
@ -366,7 +366,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
/**
|
||||
* Access the vector layer tools. This will be an instance of {@see QgsGuiVectorLayerTools}
|
||||
* by default.
|
||||
* @return The vector layer tools
|
||||
* \return The vector layer tools
|
||||
*/
|
||||
QgsVectorLayerTools *vectorLayerTools() { return mVectorLayerTools; }
|
||||
|
||||
@ -571,7 +571,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
|
||||
/** Return vector layers in edit mode
|
||||
* \param modified whether to return only layers that have been modified
|
||||
* @returns list of layers in legend order, or empty list */
|
||||
* \returns list of layers in legend order, or empty list */
|
||||
QList<QgsMapLayer *> editableLayers( bool modified = false ) const;
|
||||
|
||||
//! Get timeout for timed messages: default of 5 seconds
|
||||
@ -991,7 +991,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addPluginToolBarWidget( QWidget *widget );
|
||||
//! Remove an icon from the plugin toolbar
|
||||
@ -1005,7 +1005,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addRasterToolBarWidget( QWidget *widget );
|
||||
//! Remove an icon from the Raster toolbar
|
||||
@ -1019,7 +1019,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addVectorToolBarWidget( QWidget *widget );
|
||||
//! Remove an icon from the Vector toolbar
|
||||
@ -1033,7 +1033,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addDatabaseToolBarWidget( QWidget *widget );
|
||||
//! Remove an icon from the Database toolbar
|
||||
@ -1047,7 +1047,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addWebToolBarWidget( QWidget *widget );
|
||||
//! Remove an icon from the Web toolbar
|
||||
@ -1528,7 +1528,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
void functionProfile( void ( QgisApp::*fnc )(), QgisApp *instance, QString name );
|
||||
|
||||
/** This method will open a dialog so the user can select GDAL sublayers to load
|
||||
* @returns true if any items were loaded
|
||||
* \returns true if any items were loaded
|
||||
*/
|
||||
bool askUserForZipItemLayers( const QString &path );
|
||||
|
||||
@ -1573,7 +1573,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
bool checkTasksDependOnProject();
|
||||
|
||||
/** Helper function to union several geometries together (used in function mergeSelectedFeatures)
|
||||
@return empty geometry in case of error or if canceled */
|
||||
\return empty geometry in case of error or if canceled */
|
||||
QgsGeometry unionGeometries( const QgsVectorLayer *vl, QgsFeatureList &featureList, bool &canceled );
|
||||
|
||||
//! Deletes all the composer objects and clears mPrintComposers
|
||||
@ -1589,7 +1589,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
|
||||
|
||||
/** Paste features from clipboard into a new memory layer.
|
||||
* If no features are in clipboard an empty layer is returned.
|
||||
* @return pointer to a new layer or 0 if failed
|
||||
* \return pointer to a new layer or 0 if failed
|
||||
*/
|
||||
QgsVectorLayer *pasteToNewMemoryVector();
|
||||
|
||||
|
@ -95,7 +95,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addToolBarWidget( QWidget *widget ) override;
|
||||
//! Remove an icon (action) from the plugin toolbar
|
||||
@ -109,7 +109,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addRasterToolBarWidget( QWidget *widget ) override;
|
||||
//! Remove an icon (action) from the Raster toolbar
|
||||
@ -123,7 +123,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addVectorToolBarWidget( QWidget *widget ) override;
|
||||
//! Remove an icon (action) from the Vector toolbar
|
||||
@ -137,7 +137,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addDatabaseToolBarWidget( QWidget *widget ) override;
|
||||
//! Remove an icon (action) from the Database toolbar
|
||||
@ -151,7 +151,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* with the returned QAction.
|
||||
*
|
||||
* \param widget widget to add. The toolbar will take ownership of this widget
|
||||
* @return the QAction you can use to remove this widget from the toolbar
|
||||
* \return the QAction you can use to remove this widget from the toolbar
|
||||
*/
|
||||
QAction *addWebToolBarWidget( QWidget *widget ) override;
|
||||
//! Remove an icon (action) from the Web toolbar
|
||||
@ -459,7 +459,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* \param layer The layer for which the dialog will be created
|
||||
* \param feature The feature for which the dialog will be created
|
||||
*
|
||||
* @return A feature form
|
||||
* \return A feature form
|
||||
*/
|
||||
virtual QgsAttributeDialog *getFeatureForm( QgsVectorLayer *layer, QgsFeature &feature ) override;
|
||||
|
||||
@ -468,7 +468,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
* With the help of this you can access methods like addFeature, startEditing
|
||||
* or stopEditing while giving the user the appropriate dialogs.
|
||||
*
|
||||
* @return An instance of the vector layer tools
|
||||
* \return An instance of the vector layer tools
|
||||
*/
|
||||
virtual QgsVectorLayerTools *vectorLayerTools() override;
|
||||
|
||||
@ -487,7 +487,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
|
||||
|
||||
/** Return vector layers in edit mode
|
||||
* \param modified whether to return only layers that have been modified
|
||||
* @returns list of layers in legend order, or empty list
|
||||
* \returns list of layers in legend order, or empty list
|
||||
*/
|
||||
virtual QList<QgsMapLayer *> editableLayers( bool modified = false ) const override;
|
||||
|
||||
|
@ -125,7 +125,7 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut
|
||||
|
||||
/**
|
||||
* Getter for constraint expression description
|
||||
* @return the expression description
|
||||
* \return the expression description
|
||||
* \since QGIS 2.16
|
||||
**/
|
||||
QString constraintExpressionDescription();
|
||||
|
@ -156,14 +156,14 @@ class APP_EXPORT QgsClipboard : public QObject
|
||||
void setSystemClipboard();
|
||||
|
||||
/** Creates a text representation of the clipboard features.
|
||||
* @returns clipboard text, respecting user export format
|
||||
* \returns clipboard text, respecting user export format
|
||||
*/
|
||||
QString generateClipboardText() const;
|
||||
|
||||
/** Attempts to convert a string to a list of features, by parsing the string as WKT and GeoJSON
|
||||
* \param string string to convert
|
||||
* \param fields fields for resultant features
|
||||
* @returns list of features if conversion was successful
|
||||
* \returns list of features if conversion was successful
|
||||
*/
|
||||
QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields ) const;
|
||||
|
||||
|
@ -211,11 +211,11 @@ class APP_EXPORT QgsDecorationGrid: public QgsDecorationItem
|
||||
void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText );
|
||||
|
||||
/** Returns the grid lines with associated coordinate value
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int xGridLines( QList< QPair< qreal, QLineF > > &lines ) const;
|
||||
|
||||
/** Returns the grid lines for the y-coordinates. Not vertical in case of rotation
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int yGridLines( QList< QPair< qreal, QLineF > > &lines ) const;
|
||||
//! Returns the item border of a point (in item coordinates)
|
||||
Border borderForLineCoord( QPointF point, QPainter *p ) const;
|
||||
|
@ -49,7 +49,7 @@ class APP_EXPORT QgsFeatureAction : public QAction
|
||||
*
|
||||
* \param defaultAttributes Provide some default attributes here if desired.
|
||||
*
|
||||
* @return true if feature was added if showModal is true. If showModal is false, returns true in every case
|
||||
* \return true if feature was added if showModal is true. If showModal is false, returns true in every case
|
||||
*/
|
||||
bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true );
|
||||
|
||||
|
@ -139,11 +139,11 @@ class APP_EXPORT QgsFieldsProperties : public QWidget, private Ui_QgsFieldsPrope
|
||||
|
||||
/** Adds an attribute to the table (but does not commit it yet)
|
||||
\param field the field to add
|
||||
@return false in case of a name conflict, true in case of success */
|
||||
\return false in case of a name conflict, true in case of success */
|
||||
bool addAttribute( const QgsField &field );
|
||||
|
||||
/** Creates the a proper item to save from the tree
|
||||
* @return A widget definition. Containing another container or the final field
|
||||
* \return A widget definition. Containing another container or the final field
|
||||
*/
|
||||
QgsAttributeEditorElement *createAttributeEditorWidget( QTreeWidgetItem *item, QgsAttributeEditorElement *parent, bool forceGroup = true );
|
||||
|
||||
|
@ -37,7 +37,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
|
||||
* \param defaultValues Default values for the feature to add
|
||||
* \param defaultGeometry A default geometry to add to the feature
|
||||
*
|
||||
* @return True in case of success, False if the operation failed/was aborted
|
||||
* \return True in case of success, False if the operation failed/was aborted
|
||||
*/
|
||||
bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues, const QgsGeometry &defaultGeometry, QgsFeature *feat = nullptr ) const override;
|
||||
|
||||
@ -47,7 +47,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
|
||||
*
|
||||
* \param layer The layer on which to start an edit session
|
||||
*
|
||||
* @return True, if the editing session was started
|
||||
* \return True, if the editing session was started
|
||||
*/
|
||||
bool startEditing( QgsVectorLayer *layer ) const override;
|
||||
|
||||
@ -59,7 +59,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
|
||||
* \param layer The layer to commit
|
||||
* \param allowCancel True if a cancel button should be offered
|
||||
*
|
||||
* @return True if successful
|
||||
* \return True if successful
|
||||
*/
|
||||
bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const override;
|
||||
|
||||
@ -67,7 +67,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools
|
||||
* Should be called, when the features should be committed but the editing session is not ended.
|
||||
*
|
||||
* \param layer The layer to commit
|
||||
* @return True if successful
|
||||
* \return True if successful
|
||||
*/
|
||||
bool saveEdits( QgsVectorLayer *layer ) const override;
|
||||
|
||||
|
@ -36,20 +36,20 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
/** Returns true if label move can be applied to a layer
|
||||
\param xCol out: index of the attribute for data defined x coordinate
|
||||
\param yCol out: index of the attribute for data defined y coordinate
|
||||
@return true if labels of layer can be moved*/
|
||||
\return true if labels of layer can be moved*/
|
||||
bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
|
||||
bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const;
|
||||
|
||||
/** Returns true if diagram move can be applied to a layer
|
||||
\param xCol out: index of the attribute for data defined x coordinate
|
||||
\param yCol out: index of the attribute for data defined y coordinate
|
||||
@return true if labels of layer can be moved*/
|
||||
\return true if labels of layer can be moved*/
|
||||
bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
|
||||
|
||||
/** Returns true if layer has attribute fields set up
|
||||
\param xCol out: index of the attribute for data defined x coordinate
|
||||
\param yCol out: index of the attribute for data defined y coordinate
|
||||
@return true if layer fields set up and exist*/
|
||||
\return true if layer fields set up and exist*/
|
||||
bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const;
|
||||
|
||||
/** Returns true if layer has attribute field set up for diagrams
|
||||
@ -89,12 +89,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
/** Returns label position for mouse click location
|
||||
\param e mouse event
|
||||
\param p out: label position
|
||||
@return true in case of success, false if no label at this location*/
|
||||
\return true in case of success, false if no label at this location*/
|
||||
bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p );
|
||||
|
||||
/** Finds out rotation point of current label position
|
||||
\param ignoreUpsideDown treat label as right-side-up
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
bool currentLabelRotationPoint( QgsPoint &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false );
|
||||
|
||||
//! Creates label / feature / fixpoint rubber bands for the current label position
|
||||
@ -110,7 +110,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
void currentAlignment( QString &hali, QString &vali );
|
||||
|
||||
/** Gets vector feature for current label pos
|
||||
@return true in case of success*/
|
||||
\return true in case of success*/
|
||||
bool currentFeature( QgsFeature &f, bool fetchGeom = false );
|
||||
|
||||
//! Returns the font for the current feature (considering default font and data defined properties)
|
||||
@ -120,7 +120,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
QString dataDefinedColumnName( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings ) const;
|
||||
|
||||
/** Returns a data defined attribute column index
|
||||
@return -1 if column does not exist or an expression is used instead */
|
||||
\return -1 if column does not exist or an expression is used instead */
|
||||
int dataDefinedColumnIndex( QgsPalLayerSettings::Property p, const QgsPalLayerSettings &labelSettings, const QgsVectorLayer *vlayer ) const;
|
||||
|
||||
//! Returns whether to preserve predefined rotation data during label pin/unpin operations
|
||||
@ -133,7 +133,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
\param ySuccess out: false if attribute value is NULL
|
||||
\param xCol out: index of the x position column
|
||||
\param yCol out: index of the y position column
|
||||
@return false if layer does not have data defined label position enabled*/
|
||||
\return false if layer does not have data defined label position enabled*/
|
||||
bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const;
|
||||
|
||||
/** Returns data defined rotation of current label
|
||||
@ -141,7 +141,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
\param rotationSuccess out: false if rotation value is NULL
|
||||
\param rCol out: index of the rotation column
|
||||
\param ignoreXY ignore that x and y are required to be data-defined
|
||||
@return true if data defined rotation is enabled on the layer
|
||||
\return true if data defined rotation is enabled on the layer
|
||||
*/
|
||||
bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const;
|
||||
|
||||
@ -151,12 +151,12 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
|
||||
\param show out: show/hide value
|
||||
\param showSuccess out: false if show/hide value is NULL
|
||||
\param showCol out: index of the show label column
|
||||
@return true if data defined show/hide is enabled on the layer
|
||||
\return true if data defined show/hide is enabled on the layer
|
||||
*/
|
||||
bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const;
|
||||
|
||||
/** Returns the pin status for the current label/diagram
|
||||
@return true if the label/diagram is pinned, false otherwise
|
||||
\return true if the label/diagram is pinned, false otherwise
|
||||
\since QGIS 2.16
|
||||
*/
|
||||
bool isPinned();
|
||||
|
@ -41,7 +41,7 @@ namespace QgsMapToolSelectUtils
|
||||
* \param doContains features will only be selected if fully contained within
|
||||
the selection rubber band (otherwise intersection is enough).
|
||||
* \param singleSelect only selects the closest feature to the selectGeometry.
|
||||
* @returns list of features which match search geometry and parameters
|
||||
* \returns list of features which match search geometry and parameters
|
||||
* \since QGIS 2.16
|
||||
*/
|
||||
QgsFeatureIds getMatchingFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, bool doContains, bool singleSelect );
|
||||
@ -92,7 +92,7 @@ namespace QgsMapToolSelectUtils
|
||||
/**
|
||||
Get the current selected canvas map layer. Returns nullptr if it is not a vector layer
|
||||
\param canvas The map canvas used for getting the current layer
|
||||
@return QgsVectorLayer The layer
|
||||
\return QgsVectorLayer The layer
|
||||
*/
|
||||
QgsVectorLayer *getCurrentVectorLayer( QgsMapCanvas *canvas );
|
||||
|
||||
|
@ -73,7 +73,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
|
||||
QComboBox *createMergeComboBox( QVariant::Type columnType ) const;
|
||||
|
||||
/** Returns the table widget column index of a combo box
|
||||
@return the column index or -1 in case of error*/
|
||||
\return the column index or -1 in case of error*/
|
||||
int findComboColumn( QComboBox *c ) const;
|
||||
//! Calculates the merged value of a column (depending on the selected merge behavior) and inserts the value in the corresponding cell
|
||||
void refreshMergedValue( int col );
|
||||
|
@ -83,7 +83,7 @@ class APP_EXPORT QgsPointMarkerItem: public QgsMapCanvasItem
|
||||
void setTransparency( double transparency );
|
||||
|
||||
/** Returns the transparency for the marker.
|
||||
* @returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency()
|
||||
*/
|
||||
|
@ -51,7 +51,7 @@ class APP_EXPORT QgsStatusBarScaleWidget : public QWidget
|
||||
|
||||
/**
|
||||
* @brief isLocked check if the scale should be locked to use magnifier instead of scale to zoom in/out
|
||||
* @return True if the scale shall be locked
|
||||
* \return True if the scale shall be locked
|
||||
*/
|
||||
bool isLocked() const;
|
||||
|
||||
|
@ -38,7 +38,7 @@ class APP_EXPORT QgsTipFactory : public QObject
|
||||
~QgsTipFactory();
|
||||
|
||||
/** Get a random tip (generic or gui-centric)
|
||||
* @return An QgsTip containing the tip
|
||||
* \return An QgsTip containing the tip
|
||||
*/
|
||||
QgsTip getTip();
|
||||
|
||||
@ -47,17 +47,17 @@ class APP_EXPORT QgsTipFactory : public QObject
|
||||
* number passed in as position. If the
|
||||
* position is invalid, an empty string will be
|
||||
* returned.
|
||||
* @return An QgsTip containing the tip
|
||||
* \return An QgsTip containing the tip
|
||||
*/
|
||||
QgsTip getTip( int position );
|
||||
|
||||
/** Get a random generic tip
|
||||
* @return An QgsTip containing the tip
|
||||
* \return An QgsTip containing the tip
|
||||
*/
|
||||
QgsTip getGenericTip();
|
||||
|
||||
/** Get a random gui-centric tip
|
||||
* @return An QgsTip containing the tip
|
||||
* \return An QgsTip containing the tip
|
||||
*/
|
||||
QgsTip getGuiTip();
|
||||
|
||||
|
@ -62,12 +62,12 @@ class APP_EXPORT QgsVectorLayerProperties : public QgsOptionsDialogBase, private
|
||||
|
||||
/** Adds an attribute to the table (but does not commit it yet)
|
||||
\param field the field to add
|
||||
@return false in case of a name conflict, true in case of success */
|
||||
\return false in case of a name conflict, true in case of success */
|
||||
bool addAttribute( const QgsField &field );
|
||||
|
||||
/** Deletes an attribute (but does not commit it)
|
||||
\param name attribute name
|
||||
@return false in case of a non-existing attribute.*/
|
||||
\return false in case of a non-existing attribute.*/
|
||||
bool deleteAttribute( int attr );
|
||||
|
||||
//! Adds a properties page factory to the vector layer properties dialog.
|
||||
|
@ -122,7 +122,7 @@ class CORE_EXPORT QgsAuthCertUtils
|
||||
* \param keypath File path to private key
|
||||
* \param keypass Passphrase for private key
|
||||
* \param reencrypt Whether to re-encrypt the private key with the passphrase
|
||||
* @return certificate, private key, key's algorithm type
|
||||
* \return certificate, private key, key's algorithm type
|
||||
*/
|
||||
static QStringList certKeyBundleToPem( const QString &certpath,
|
||||
const QString &keypath,
|
||||
@ -133,7 +133,7 @@ class CORE_EXPORT QgsAuthCertUtils
|
||||
* \param bundlepath File path to the PKCS bundle
|
||||
* \param bundlepass Passphrase for bundle
|
||||
* \param reencrypt Whether to re-encrypt the private key with the passphrase
|
||||
* @return certificate, private key, key's algorithm type
|
||||
* \return certificate, private key, key's algorithm type
|
||||
*/
|
||||
static QStringList pkcs12BundleToPem( const QString &bundlepath,
|
||||
const QString &bundlepass = QString(),
|
||||
@ -142,7 +142,7 @@ class CORE_EXPORT QgsAuthCertUtils
|
||||
/** Write a temporary file for a PEM text of cert/key/CAs bundle component
|
||||
* \param pemtext Component content as PEM text
|
||||
* \param name Name of file
|
||||
* @return File path to temporary file
|
||||
* \return File path to temporary file
|
||||
*/
|
||||
static QString pemTextToTempFile( const QString &name, const QByteArray &pemtext );
|
||||
|
||||
|
@ -123,7 +123,7 @@ class CORE_EXPORT QgsAuthMethodConfig
|
||||
/**
|
||||
* Remove a config from map
|
||||
* \param key Config to remove
|
||||
* @return Number of keys removed (should always be 1 or 0)
|
||||
* \return Number of keys removed (should always be 1 or 0)
|
||||
*/
|
||||
int removeConfig( const QString &key );
|
||||
|
||||
|
@ -246,14 +246,14 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
/**
|
||||
* Store an authentication config in the database
|
||||
* \param mconfig Associated authentication config id
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool storeAuthenticationConfig( QgsAuthMethodConfig &mconfig );
|
||||
|
||||
/**
|
||||
* Update an authentication config in the database
|
||||
* \param config Associated authentication config id
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool updateAuthenticationConfig( const QgsAuthMethodConfig &config );
|
||||
|
||||
@ -262,26 +262,26 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
* \param authcfg Associated authentication config id
|
||||
* \param mconfig Subclassed config to load into
|
||||
* \param full Whether to decrypt and populate all sensitive data in subclass
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool loadAuthenticationConfig( const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full = false );
|
||||
|
||||
/**
|
||||
* Remove an authentication config in the database
|
||||
* \param authcfg Associated authentication config id
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool removeAuthenticationConfig( const QString &authcfg );
|
||||
|
||||
/**
|
||||
* Clear all authentication configs from table in database and from provider caches
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool removeAllAuthenticationConfigs();
|
||||
|
||||
/**
|
||||
* Close connection to current authentication database and back it up
|
||||
* @return Path to backup
|
||||
* \return Path to backup
|
||||
*/
|
||||
bool backupAuthenticationDatabase( QString *backuppath = nullptr );
|
||||
|
||||
@ -289,7 +289,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
* Erase all rows from all tables in authentication database
|
||||
* \param backup Whether to backup of current database
|
||||
* \param backuppath Where the backup is locate
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool eraseAuthenticationDatabase( bool backup, QString *backuppath = nullptr );
|
||||
|
||||
@ -301,7 +301,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
* \param request The QNetworkRequest
|
||||
* \param authcfg Associated authentication config id
|
||||
* \param dataprovider Provider key filter, offering logic branching in authentication method
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg,
|
||||
const QString &dataprovider = QString() );
|
||||
@ -311,7 +311,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
* \param reply The QNetworkReply
|
||||
* \param authcfg Associated authentication config id
|
||||
* \param dataprovider Provider key filter, offering logic branching in authentication method
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg,
|
||||
const QString &dataprovider = QString() );
|
||||
@ -321,7 +321,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
* \param connectionItems The connection items, e.g. username=myname, of QgsDataSourceUri
|
||||
* \param authcfg Associated authentication config id
|
||||
* \param dataprovider Provider key filter, offering logic branching in authentication method
|
||||
* @return Whether operation succeeded
|
||||
* \return Whether operation succeeded
|
||||
*/
|
||||
bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg,
|
||||
const QString &dataprovider = QString() );
|
||||
@ -451,7 +451,7 @@ class CORE_EXPORT QgsAuthManager : public QObject
|
||||
bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy );
|
||||
|
||||
/** Get a whether certificate is trusted by user
|
||||
@return DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy
|
||||
\return DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy
|
||||
*/
|
||||
QgsAuthCertUtils::CertTrustPolicy getCertTrustPolicy( const QSslCertificate &cert );
|
||||
|
||||
|
@ -83,7 +83,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
|
||||
* \param authcfg Authentication configuration ID
|
||||
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
|
||||
* for custom updater code specific to the provider
|
||||
* @return Whether the update succeeded
|
||||
* \return Whether the update succeeded
|
||||
*/
|
||||
virtual bool updateNetworkRequest( QNetworkRequest &request, const QString &authcfg,
|
||||
const QString &dataprovider = QString() )
|
||||
@ -99,7 +99,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
|
||||
* \param authcfg Authentication configuration ID
|
||||
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
|
||||
* for custom updater code specific to the provider
|
||||
* @return Whether the update succeeded
|
||||
* \return Whether the update succeeded
|
||||
*/
|
||||
virtual bool updateNetworkReply( QNetworkReply *reply, const QString &authcfg,
|
||||
const QString &dataprovider = QString() )
|
||||
@ -115,7 +115,7 @@ class CORE_EXPORT QgsAuthMethod : public QObject
|
||||
* \param authcfg Authentication configuration ID
|
||||
* \param dataprovider Textual key for a data provider, e.g. 'postgres', that allows
|
||||
* for custom updater code specific to the provider
|
||||
* @return Whether the update succeeded
|
||||
* \return Whether the update succeeded
|
||||
*/
|
||||
virtual bool updateDataSourceUriItems( QStringList &connectionItems, const QString &authcfg,
|
||||
const QString &dataprovider = QString() )
|
||||
|
@ -63,7 +63,7 @@ class CORE_EXPORT QgsAuthMethodRegistry
|
||||
|
||||
/** Create an instance of the auth method
|
||||
\param authMethodKey identificator of the auth method
|
||||
@return instance of auth method or nullptr on error
|
||||
\return instance of auth method or nullptr on error
|
||||
*/
|
||||
QgsAuthMethod *authMethod( const QString &authMethodKey );
|
||||
|
||||
@ -81,7 +81,7 @@ class CORE_EXPORT QgsAuthMethodRegistry
|
||||
/** Get pointer to auth method function
|
||||
\param authMethodKey identificator of the auth method
|
||||
\param functionName name of function
|
||||
@return pointer to function or nullptr on error
|
||||
\return pointer to function or nullptr on error
|
||||
*/
|
||||
QFunctionPointer function( const QString &authMethodKey,
|
||||
const QString &functionName );
|
||||
|
@ -48,7 +48,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
QgsAtlasComposition( QgsComposition *composition );
|
||||
|
||||
/** Returns whether the atlas generation is enabled
|
||||
* @returns true if atlas is enabled
|
||||
* \returns true if atlas is enabled
|
||||
* @see setEnabled
|
||||
*/
|
||||
bool enabled() const { return mEnabled; }
|
||||
@ -60,7 +60,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
void setEnabled( bool enabled );
|
||||
|
||||
/** Returns true if the atlas is set to hide the coverage layer
|
||||
* @returns true if coverage layer is hidden
|
||||
* \returns true if coverage layer is hidden
|
||||
* @see setHideCoverage
|
||||
*/
|
||||
bool hideCoverage() const { return mHideCoverage; }
|
||||
@ -73,7 +73,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
|
||||
/** Returns the filename expression used for generating output filenames for each
|
||||
* atlas page.
|
||||
* @returns filename pattern
|
||||
* \returns filename pattern
|
||||
* @see setFilenamePattern
|
||||
* @see filenamePatternErrorString
|
||||
* \note This property has no effect when exporting to PDF if singleFile() is true
|
||||
@ -82,7 +82,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
|
||||
/** Sets the filename expression used for generating output filenames for each
|
||||
* atlas page.
|
||||
* @returns true if filename expression could be successful set, false if expression is invalid
|
||||
* \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
|
||||
@ -91,14 +91,14 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
bool setFilenamePattern( const QString &pattern );
|
||||
|
||||
/** Returns an error string from parsing the filename expression.
|
||||
* @returns filename pattern parser error
|
||||
* \returns filename pattern parser error
|
||||
* @see setFilenamePattern
|
||||
* @see filenamePattern
|
||||
*/
|
||||
QString filenamePatternErrorString() const { return mFilenameParserError; }
|
||||
|
||||
/** Returns the coverage layer used for the atlas features
|
||||
* @returns atlas coverage layer
|
||||
* \returns atlas coverage layer
|
||||
* @see setCoverageLayer
|
||||
*/
|
||||
QgsVectorLayer *coverageLayer() const { return mCoverageLayer; }
|
||||
@ -110,7 +110,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
void setCoverageLayer( QgsVectorLayer *layer );
|
||||
|
||||
/** Returns the expression used for calculating the page name.
|
||||
* @returns expression string, or field name from coverage layer
|
||||
* \returns expression string, or field name from coverage layer
|
||||
* @see setPageNameExpression
|
||||
* @see nameForPage
|
||||
* \since QGIS 2.12
|
||||
@ -126,7 +126,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
|
||||
* \returns page name
|
||||
* @see pageNameExpression
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
@ -134,7 +134,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
|
||||
* \returns true if atlas will be exported to a single file
|
||||
* @see setSingleFile
|
||||
* \note This property is only used for PDF exports.
|
||||
*/
|
||||
@ -161,7 +161,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
void setFeatureFilter( const QString &expression ) { mFeatureFilter = expression; }
|
||||
|
||||
/** Returns an error string from parsing the feature filter expression.
|
||||
* @returns filename pattern parser error
|
||||
* \returns filename pattern parser error
|
||||
* @see setFilenamePattern
|
||||
* @see filenamePattern
|
||||
*/
|
||||
@ -172,7 +172,7 @@ 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
|
||||
* \returns a vector of doubles representing predefined scales
|
||||
* @see setPredefinedScales
|
||||
* @see QgsComposerMap::atlasScalingMode
|
||||
*/
|
||||
@ -198,12 +198,12 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
/** Prepare the atlas map for the given feature. Sets the extent and context variables
|
||||
* \param i feature number
|
||||
* \param updateMaps set to true to redraw maps and recalculate their extent
|
||||
* @returns true if feature was successfully prepared
|
||||
* \returns true if feature was successfully prepared
|
||||
*/
|
||||
bool prepareForFeature( const int i, const bool updateMaps = true );
|
||||
|
||||
/** Prepare the atlas map for the given feature. Sets the extent and context variables
|
||||
* @returns true if feature was successfully prepared
|
||||
* \returns true if feature was successfully prepared
|
||||
*/
|
||||
bool prepareForFeature( const QgsFeature *feat );
|
||||
|
||||
@ -290,12 +290,12 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
|
||||
private:
|
||||
|
||||
/** Updates the filename expression.
|
||||
* @returns true if expression was successfully parsed, false if expression is invalid
|
||||
* \returns true if expression was successfully parsed, false if expression is invalid
|
||||
*/
|
||||
bool updateFilenameExpression();
|
||||
|
||||
/** Evaluates filename for current feature
|
||||
* @returns true if feature filename was successfully evaluated
|
||||
* \returns true if feature filename was successfully evaluated
|
||||
*/
|
||||
bool evalFeatureFilename( const QgsExpressionContext &context );
|
||||
|
||||
|
@ -72,7 +72,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setArrowHeadWidth( double width );
|
||||
|
||||
/** Returns the width of the arrow head in mm
|
||||
* @returns width of arrow head
|
||||
* \returns width of arrow head
|
||||
* @see setArrowHeadWidth
|
||||
*/
|
||||
double arrowHeadWidth() const { return mArrowHeadWidth; }
|
||||
@ -85,7 +85,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setStartMarker( const QString &svgPath );
|
||||
|
||||
/** Returns the marker drawn at the start of the line
|
||||
* @returns file path for svg marker graphic
|
||||
* \returns file path for svg marker graphic
|
||||
* @see setStartMarker
|
||||
* @see endMarker
|
||||
*/
|
||||
@ -99,14 +99,14 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setEndMarker( const QString &svgPath );
|
||||
|
||||
/** Returns the marker drawn at the end of the line
|
||||
* @returns file path for svg marker graphic
|
||||
* \returns file path for svg marker graphic
|
||||
* @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
|
||||
* \returns arrow head stroke color
|
||||
* @see arrowHeadFillColor
|
||||
* @see setArrowHeadStrokeColor
|
||||
* \since QGIS 2.5
|
||||
@ -122,7 +122,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setArrowHeadStrokeColor( const QColor &color );
|
||||
|
||||
/** Returns the color used to fill the arrow head.
|
||||
* @returns arrow head fill color
|
||||
* \returns arrow head fill color
|
||||
* @see arrowHeadStrokeColor
|
||||
* @see setArrowHeadFillColor
|
||||
* \since QGIS 2.5
|
||||
@ -146,7 +146,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setArrowHeadStrokeWidth( const double width );
|
||||
|
||||
/** Returns the pen width for the stroke of the arrow head
|
||||
* @returns pen width for arrow head stroke
|
||||
* \returns pen width for arrow head stroke
|
||||
* @see setArrowHeadStrokeWidth
|
||||
* @see arrowHeadStrokeColor
|
||||
* \since QGIS 2.5
|
||||
@ -161,14 +161,14 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
|
||||
void setLineSymbol( QgsLineSymbol *symbol );
|
||||
|
||||
/** Returns the line symbol used for drawing the line portion of the arrow
|
||||
* @returns line symbol
|
||||
* \returns line symbol
|
||||
* @see setLineSymbol
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
QgsLineSymbol *lineSymbol() { return mLineSymbol; }
|
||||
|
||||
/** Returns marker mode, which controls how the arrow endpoints are drawn
|
||||
* @returns marker mode
|
||||
* \returns marker mode
|
||||
* @see setMarkerMode
|
||||
*/
|
||||
MarkerMode markerMode() const { return mMarkerMode; }
|
||||
|
@ -64,7 +64,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
|
||||
|
||||
/** Moves the specified row up or down in the model. Used for rearranging the attribute tables
|
||||
* columns.
|
||||
* @returns true if the move is allowed
|
||||
* \returns true if the move is allowed
|
||||
* \param row row in model representing attribute table column to move
|
||||
* \param direction direction to move the attribute table column
|
||||
* \since QGIS 2.3
|
||||
@ -78,7 +78,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
|
||||
void resetToLayer();
|
||||
|
||||
/** Returns the QgsComposerTableColumn corresponding to an index in the model.
|
||||
* @returns QgsComposerTableColumn for specified index
|
||||
* \returns QgsComposerTableColumn for specified index
|
||||
* \param index a QModelIndex
|
||||
* \since QGIS 2.3
|
||||
* @see indexFromColumn
|
||||
@ -86,7 +86,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
|
||||
QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const;
|
||||
|
||||
/** Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.
|
||||
* @returns QModelIndex for specified QgsComposerTableColumn
|
||||
* \returns QModelIndex for specified QgsComposerTableColumn
|
||||
* \param column a QgsComposerTableColumn
|
||||
* \since QGIS 2.3
|
||||
* @see columnFromIndex
|
||||
@ -159,7 +159,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
|
||||
virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;
|
||||
|
||||
/** Returns the QgsComposerTableColumn corresponding to a row in the proxy model.
|
||||
* @returns QgsComposerTableColumn for specified row
|
||||
* \returns QgsComposerTableColumn for specified row
|
||||
* \param row a row number
|
||||
* \since QGIS 2.3
|
||||
* @see columnFromIndex
|
||||
@ -167,7 +167,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
|
||||
QgsComposerTableColumn *columnFromRow( int row );
|
||||
|
||||
/** Returns the QgsComposerTableColumn corresponding to an index in the proxy model.
|
||||
* @returns QgsComposerTableColumn for specified index
|
||||
* \returns QgsComposerTableColumn for specified index
|
||||
* \param index a QModelIndex
|
||||
* \since QGIS 2.3
|
||||
* @see columnFromRow
|
||||
@ -177,7 +177,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
|
||||
|
||||
/** Returns the QgsComposerTableColumn corresponding to an index from the source
|
||||
* QgsComposerAttributeTableColumnModel model.
|
||||
* @returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
|
||||
* \returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
|
||||
* \param sourceIndex a QModelIndex
|
||||
* \since QGIS 2.3
|
||||
* @see columnFromRow
|
||||
@ -198,7 +198,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
|
||||
ColumnFilterType mFilterType;
|
||||
|
||||
/** Returns a list of QgsComposerTableColumns without a set sort rank
|
||||
* @returns QgsComposerTableColumns in attribute table without a sort rank
|
||||
* \returns QgsComposerTableColumns in attribute table without a sort rank
|
||||
* \since QGIS 2.3
|
||||
*/
|
||||
QList<QgsComposerTableColumn *> columnsWithoutSortRank() const;
|
||||
|
@ -96,7 +96,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
void setSource( const ContentSource source );
|
||||
|
||||
/** Returns the source for attributes shown in the table body.
|
||||
* @returns content source
|
||||
* \returns content source
|
||||
* @see setSource
|
||||
*/
|
||||
ContentSource source() const { return mSource; }
|
||||
@ -105,7 +105,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
* if the table is set to atlas feature mode, then the source layer will be the
|
||||
* atlas coverage layer. If the table is set to layer attributes mode, then
|
||||
* the source layer will be the user specified vector layer.
|
||||
* @returns actual source layer
|
||||
* \returns actual source layer
|
||||
*/
|
||||
QgsVectorLayer *sourceLayer();
|
||||
|
||||
@ -116,7 +116,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
void setVectorLayer( QgsVectorLayer *layer );
|
||||
|
||||
/** Returns the vector layer the attribute table is currently using
|
||||
* @returns attribute table's current vector layer
|
||||
* \returns attribute table's current vector layer
|
||||
* @see setVectorLayer
|
||||
*/
|
||||
QgsVectorLayer *vectorLayer() const { return mVectorLayer; }
|
||||
@ -130,7 +130,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
void setRelationId( const QString &relationId );
|
||||
|
||||
/** Returns the relation id which the table displays child features from
|
||||
* @returns relation id
|
||||
* \returns relation id
|
||||
* @see setRelationId
|
||||
* @see source
|
||||
* \note only used if table source is set to RelationChildren
|
||||
@ -155,7 +155,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** 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
|
||||
* \returns composer map controlling the attribute table
|
||||
* @see setComposerMap
|
||||
* @see displayOnlyVisibleFeatures
|
||||
*/
|
||||
@ -170,7 +170,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
void setMaximumNumberOfFeatures( const int features );
|
||||
|
||||
/** Returns the maximum number of features to be shown by the table.
|
||||
* @returns maximum number of features
|
||||
* \returns maximum number of features
|
||||
* @see setMaximumNumberOfFeatures
|
||||
*/
|
||||
int maximumNumberOfFeatures() const { return mMaximumNumberOfFeatures; }
|
||||
@ -183,7 +183,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
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
|
||||
* \returns true if table only shows unique rows and is stripping out
|
||||
* duplicate rows.
|
||||
* @see setUniqueRowsOnly
|
||||
*/
|
||||
@ -200,7 +200,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** 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
|
||||
* \returns true if table only shows visible features
|
||||
* @see composerMap
|
||||
* @see setDisplayOnlyVisibleFeatures
|
||||
*/
|
||||
@ -216,13 +216,13 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** 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
|
||||
* \returns true if table only shows features which intersect the atlas feature
|
||||
* @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
|
||||
* \returns bool state of the feature filter
|
||||
* @see setFilterFeatures
|
||||
* @see featureFilter
|
||||
*/
|
||||
@ -239,7 +239,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** Returns the current expression used to filter features for the table. The filter is only
|
||||
* active if filterFeatures() is true.
|
||||
* @returns feature filter expression
|
||||
* \returns feature filter expression
|
||||
* @see setFeatureFilter
|
||||
* @see filterFeatures
|
||||
*/
|
||||
@ -266,7 +266,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
void setDisplayedFields( const QStringList &fields, bool refresh = true );
|
||||
|
||||
/** Returns the attributes used to sort the table's features.
|
||||
* @returns a QList of integer/bool pairs, where the integer refers to the attribute index and
|
||||
* \returns a QList of integer/bool pairs, where the integer refers to the attribute index and
|
||||
* the bool to the sort order for the attribute. If true the attribute is sorted ascending,
|
||||
* if false, the attribute is sorted in descending order.
|
||||
* \note not available in Python bindings
|
||||
@ -283,7 +283,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** Returns the string used to wrap the contents of the table cells by. Occurrences of this string will
|
||||
* be replaced by a line break.
|
||||
* @returns string which will be replaced with line break
|
||||
* \returns string which will be replaced with line break
|
||||
* \since QGIS 2.12
|
||||
* @see setWrapString
|
||||
*/
|
||||
@ -291,7 +291,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
|
||||
/** Queries the attribute table's vector layer for attributes to show in the table.
|
||||
* \param contents table content
|
||||
* @returns true if attributes were successfully fetched
|
||||
* \returns true if attributes were successfully fetched
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
bool getTableContents( QgsComposerTableContents &contents ) override;
|
||||
|
@ -40,7 +40,7 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
|
||||
void setContentSection( const QRectF §ion ) { mSection = section; }
|
||||
|
||||
/** Returns the parent multiframe for the frame.
|
||||
* @returns parent multiframe
|
||||
* \returns parent multiframe
|
||||
*/
|
||||
QgsComposerMultiFrame *multiFrame() const { return mMultiFrame; }
|
||||
|
||||
@ -59,14 +59,14 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
|
||||
|
||||
/** Returns the visible portion of the multi frame's content which
|
||||
* is shown in this frame.
|
||||
* @returns extent of visible portion
|
||||
* \returns extent of visible portion
|
||||
* \since QGIS 2.5
|
||||
* @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
|
||||
* \returns true if page should be hidden if frame is empty
|
||||
* \since QGIS 2.5
|
||||
* @see setHidePageIfEmpty
|
||||
*/
|
||||
@ -80,7 +80,7 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
|
||||
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
|
||||
* \returns true if background and stroke should be hidden if frame is empty
|
||||
* \since QGIS 2.5
|
||||
* @see setHideBackgroundIfEmpty
|
||||
*/
|
||||
@ -94,7 +94,7 @@ class CORE_EXPORT QgsComposerFrame: public QgsComposerItem
|
||||
void setHideBackgroundIfEmpty( const bool hideBackgroundIfEmpty );
|
||||
|
||||
/** Returns whether the frame is empty
|
||||
* @returns true if frame is empty
|
||||
* \returns true if frame is empty
|
||||
* \since QGIS 2.5
|
||||
* @see hidePageIfEmpty
|
||||
*/
|
||||
|
@ -57,7 +57,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
|
||||
void setContentMode( ContentMode mode ) { mContentMode = mode; }
|
||||
|
||||
/** Returns the source mode for item's HTML content.
|
||||
* @returns ContentMode for the item's source
|
||||
* \returns ContentMode for the item's source
|
||||
* @see setContentMode
|
||||
* @see url
|
||||
* @see html
|
||||
@ -76,7 +76,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
|
||||
|
||||
/** 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
|
||||
* \returns url for content displayed in item
|
||||
* @see setUrl
|
||||
* @see contentMode
|
||||
*/
|
||||
@ -96,7 +96,7 @@ 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
|
||||
* \returns HTML displayed in item
|
||||
* @see setHtml
|
||||
* @see contentMode
|
||||
* \since QGIS 2.5
|
||||
@ -107,7 +107,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
|
||||
* the HTML content. If set, any content inside [% %] tags will be
|
||||
* treated as a QGIS expression and evaluated against the current atlas
|
||||
* feature.
|
||||
* @returns true if html item will evaluate expressions in the content
|
||||
* \returns true if html item will evaluate expressions in the content
|
||||
* @see setEvaluateExpressions
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
@ -125,7 +125,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
|
||||
* \returns true if html item is using smart breaks
|
||||
* @see setUseSmartBreaks
|
||||
*/
|
||||
bool useSmartBreaks() const { return mUseSmartBreaks; }
|
||||
@ -156,7 +156,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
|
||||
* in the html. This distance is the maximum amount of empty space allowed
|
||||
* at the bottom of a frame after calculating the optimum break location. This setting
|
||||
* is only effective if useSmartBreaks is true.
|
||||
* @returns maximum amount of empty space to leave when calculating page break locations
|
||||
* \returns maximum amount of empty space to leave when calculating page break locations
|
||||
* \since QGIS 2.3
|
||||
* @see setMaxBreakDistance
|
||||
* @see useSmartBreaks
|
||||
@ -177,7 +177,7 @@ 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
|
||||
* \returns CSS rules for user stylesheet
|
||||
* @see setUserStylesheet
|
||||
* @see userStylesheetEnabled
|
||||
* \since QGIS 2.5
|
||||
@ -193,7 +193,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
|
||||
void setUserStylesheetEnabled( const bool stylesheetEnabled );
|
||||
|
||||
/** Returns whether user stylesheets are enabled for the HTML content.
|
||||
* @returns true if user stylesheets are enabled
|
||||
* \returns true if user stylesheets are enabled
|
||||
* @see setUserStylesheetEnabled
|
||||
* @see userStylesheet
|
||||
* \since QGIS 2.5
|
||||
|
@ -126,7 +126,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
/** Returns whether this item has been removed from the composition. Items removed
|
||||
* from the composition are not deleted so that they can be restored via an undo
|
||||
* command.
|
||||
* @returns true if the item has been removed from the composition
|
||||
* \returns true if the item has been removed from the composition
|
||||
* \since QGIS 2.5
|
||||
* @see setIsRemoved
|
||||
*/
|
||||
@ -164,7 +164,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) { Q_UNUSED( factor ); Q_UNUSED( point ); Q_UNUSED( mode ); }
|
||||
|
||||
/** Gets the page the item is currently on.
|
||||
* @returns page number for item, beginning on page 1
|
||||
* \returns page number for item, beginning on page 1
|
||||
* @see pagePos
|
||||
* @see updatePagePos
|
||||
* \since QGIS 2.4
|
||||
@ -172,7 +172,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
int page() const;
|
||||
|
||||
/** Returns the item's position relative to its current page.
|
||||
* @returns position relative to the page's top left corner.
|
||||
* \returns position relative to the page's top left corner.
|
||||
* @see page
|
||||
* @see updatePagePos
|
||||
* \since QGIS 2.4
|
||||
@ -225,7 +225,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
bool _readXml( const QDomElement &itemElem, const QDomDocument &doc );
|
||||
|
||||
/** Whether this item has a frame or not.
|
||||
* @returns true if there is a frame around this item, otherwise false.
|
||||
* \returns true if there is a frame around this item, otherwise false.
|
||||
* @see setFrameEnabled
|
||||
* @see frameStrokeWidth
|
||||
* @see frameJoinStyle
|
||||
@ -253,7 +253,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void setFrameStrokeColor( const QColor &color );
|
||||
|
||||
/** Returns the frame's stroke color. Only used if hasFrame is true.
|
||||
* @returns frame stroke color
|
||||
* \returns frame stroke color
|
||||
* \since QGIS 2.6
|
||||
* @see hasFrame
|
||||
* @see setFrameStrokeColor
|
||||
@ -273,7 +273,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void setFrameStrokeWidth( const double strokeWidth );
|
||||
|
||||
/** Returns the frame's stroke width. Only used if hasFrame is true.
|
||||
* @returns Frame stroke width
|
||||
* \returns Frame stroke width
|
||||
* \since QGIS 2.3
|
||||
* @see hasFrame
|
||||
* @see setFrameStrokeWidth
|
||||
@ -283,7 +283,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
double frameStrokeWidth() const { return mFrameWidth; }
|
||||
|
||||
/** Returns the join style used for drawing the item's frame
|
||||
* @returns Join style for stroke frame
|
||||
* \returns Join style for stroke frame
|
||||
* \since QGIS 2.3
|
||||
* @see hasFrame
|
||||
* @see setFrameJoinStyle
|
||||
@ -322,7 +322,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual QRectF rectWithFrame() const;
|
||||
|
||||
/** Whether this item has a Background or not.
|
||||
* @returns true if there is a Background around this item, otherwise false.
|
||||
* \returns true if there is a Background around this item, otherwise false.
|
||||
* @see setBackgroundEnabled
|
||||
* @see backgroundColor
|
||||
*/
|
||||
@ -330,14 +330,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
|
||||
/** Set whether this item has a Background drawn around it or not.
|
||||
* \param drawBackground draw Background
|
||||
* @returns nothing
|
||||
* \returns nothing
|
||||
* @see hasBackground
|
||||
* @see setBackgroundColor
|
||||
*/
|
||||
void setBackgroundEnabled( const bool drawBackground ) { mBackground = drawBackground; }
|
||||
|
||||
/** Gets the background color for this item
|
||||
* @returns background color
|
||||
* \returns background color
|
||||
* @see setBackgroundColor
|
||||
* @see hasBackground
|
||||
*/
|
||||
@ -345,14 +345,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
|
||||
/** Sets the background color for this item
|
||||
* \param backgroundColor new background color
|
||||
* @returns nothing
|
||||
* \returns nothing
|
||||
* @see backgroundColor
|
||||
* @see setBackgroundEnabled
|
||||
*/
|
||||
void setBackgroundColor( const QColor &backgroundColor );
|
||||
|
||||
/** Returns the item's composition blending mode.
|
||||
* @returns item blending mode
|
||||
* \returns item blending mode
|
||||
* @see setBlendMode
|
||||
*/
|
||||
QPainter::CompositionMode blendMode() const { return mBlendMode; }
|
||||
@ -364,7 +364,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
void setBlendMode( const QPainter::CompositionMode blendMode );
|
||||
|
||||
/** Returns the item's transparency
|
||||
* @returns transparency as integer between 0 (transparent) and 255 (opaque)
|
||||
* \returns transparency as integer between 0 (transparent) and 255 (opaque)
|
||||
* @see setTransparency
|
||||
*/
|
||||
int transparency() const { return mTransparency; }
|
||||
@ -376,7 +376,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
void setTransparency( const int transparency );
|
||||
|
||||
/** Returns whether effects (e.g., blend modes) are enabled for the item
|
||||
* @returns true if effects are enabled
|
||||
* \returns true if effects are enabled
|
||||
* @see setEffectsEnabled
|
||||
* @see transparency
|
||||
* @see blendMode
|
||||
@ -423,7 +423,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
bool positionLock() const { return mItemPositionLocked; }
|
||||
|
||||
/** Returns the current rotation for the composer item.
|
||||
* @returns rotation for composer item
|
||||
* \returns rotation for composer item
|
||||
* \param valueType controls whether the returned value is the user specified rotation,
|
||||
* or the current evaluated rotation (which may be affected by data driven rotation
|
||||
* settings).
|
||||
@ -440,7 +440,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void updateItem();
|
||||
|
||||
/** Get item's id (which is not necessarly unique)
|
||||
* @returns item id
|
||||
* \returns item id
|
||||
* @see setId
|
||||
*/
|
||||
QString id() const { return mId; }
|
||||
@ -452,7 +452,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void setId( const QString &id );
|
||||
|
||||
/** Get item identification name
|
||||
* @returns unique item identification string
|
||||
* \returns unique item identification string
|
||||
* \note there is not setter since one can't manually set the id
|
||||
* @see id
|
||||
* @see setId
|
||||
@ -461,7 +461,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
|
||||
/** 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
|
||||
* \returns display name for item
|
||||
* @see id
|
||||
* @see setId
|
||||
* \since QGIS 2.5
|
||||
@ -480,7 +480,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
/** Returns whether the item should be excluded from composer exports and prints
|
||||
* \param valueType controls whether the returned value is the user specified value,
|
||||
* or the current evaluated value (which may be affected by data driven settings).
|
||||
* @returns true if item should be excluded
|
||||
* \returns true if item should be excluded
|
||||
* \since QGIS 2.5
|
||||
* @see setExcludeFromExports
|
||||
*/
|
||||
@ -494,7 +494,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
virtual void setExcludeFromExports( const bool exclude );
|
||||
|
||||
/** Returns whether this item is part of a group
|
||||
* @returns true if item is in a group
|
||||
* \returns true if item is in a group
|
||||
* \since QGIS 2.5
|
||||
* @see setIsGroupMember
|
||||
*/
|
||||
@ -508,7 +508,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
void setIsGroupMember( const bool isGroupMember );
|
||||
|
||||
/** Get the number of layers that this item requires for exporting as layers
|
||||
* @returns 0 if this item is to be placed on the same layer as the previous item,
|
||||
* \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
|
||||
@ -659,7 +659,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
double rectHandlerBorderTolerance() const;
|
||||
|
||||
/** Returns the zoom factor of the graphics view.
|
||||
* @return the factor or -1 in case of error (e.g. graphic view does not exist)
|
||||
* \return the factor or -1 in case of error (e.g. graphic view does not exist)
|
||||
*/
|
||||
double horizontalViewScaleFactor() const;
|
||||
|
||||
@ -680,14 +680,14 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
* the position of the returned rect will be adjusted to account for the item's
|
||||
* position mode
|
||||
* \param context expression context for evaluating data defined expressions
|
||||
* @returns bounding box rectangle for item after data defined size and position have been
|
||||
* \returns bounding box rectangle for item after data defined size and position have been
|
||||
* set and position mode has been accounted for
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
QRectF evalItemRect( const QRectF &newRect, const bool resizeOnly = false, const QgsExpressionContext *context = nullptr );
|
||||
|
||||
/** Returns whether the item should be drawn in the current context
|
||||
* @returns true if item should be drawn
|
||||
* \returns true if item should be drawn
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
bool shouldDrawItem() const;
|
||||
|
@ -51,7 +51,7 @@ class CORE_EXPORT QgsComposerItemCommand: public QUndoCommand
|
||||
bool containsChange() const;
|
||||
|
||||
/** Returns the target item the command applies to.
|
||||
* @returns target composer item
|
||||
* \returns target composer item
|
||||
*/
|
||||
QgsComposerItem *item() const;
|
||||
|
||||
|
@ -58,37 +58,37 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
|
||||
void setFont( const QFont &f );
|
||||
|
||||
/** Accessor for the vertical alignment of the label
|
||||
* @returns Qt::AlignmentFlag
|
||||
* \returns Qt::AlignmentFlag
|
||||
*/
|
||||
Qt::AlignmentFlag vAlign() const { return mVAlignment; }
|
||||
|
||||
/** Accessor for the horizontal alignment of the label
|
||||
* @returns Qt::AlignmentFlag
|
||||
* \returns Qt::AlignmentFlag
|
||||
*/
|
||||
Qt::AlignmentFlag hAlign() const { return mHAlignment; }
|
||||
|
||||
/** Mutator for the horizontal alignment of the label
|
||||
* \param a alignment
|
||||
* @returns void
|
||||
* \returns void
|
||||
*/
|
||||
void setHAlign( Qt::AlignmentFlag a ) {mHAlignment = a;}
|
||||
|
||||
/** Mutator for the vertical alignment of the label
|
||||
* \param a alignment
|
||||
* @returns void
|
||||
* \returns void
|
||||
*/
|
||||
void setVAlign( Qt::AlignmentFlag a ) { mVAlignment = a; }
|
||||
|
||||
/** Returns the horizontal margin between the edge of the frame and the label
|
||||
* contents.
|
||||
* @returns horizontal margin in mm
|
||||
* \returns horizontal margin in mm
|
||||
* \since QGIS 2.7
|
||||
*/
|
||||
double marginX() const { return mMarginX; }
|
||||
|
||||
/** Returns the vertical margin between the edge of the frame and the label
|
||||
* contents.
|
||||
* @returns vertical margin in mm
|
||||
* \returns vertical margin in mm
|
||||
* \since QGIS 2.7
|
||||
*/
|
||||
double marginY() const { return mMarginY; }
|
||||
|
@ -123,7 +123,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
|
||||
QString title() const;
|
||||
|
||||
/** Returns the alignment of the legend title
|
||||
* @returns Qt::AlignmentFlag for the legend title
|
||||
* \returns Qt::AlignmentFlag for the legend title
|
||||
* \since QGIS 2.3
|
||||
* @see setTitleAlignment
|
||||
*/
|
||||
|
@ -160,7 +160,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
/** Returns a pointer to the current map extent, which is either the original user specified
|
||||
* 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
|
||||
* \returns pointer to current map extent
|
||||
* @see visibleExtentPolygon
|
||||
*/
|
||||
const QgsRectangle *currentMapExtent() const;
|
||||
@ -303,14 +303,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
|
||||
* \returns pointer to grid stack
|
||||
* @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
|
||||
* \returns pointer to first grid for map item
|
||||
* @see grids()
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
@ -318,14 +318,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
|
||||
* \returns pointer to overview stack
|
||||
* @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
|
||||
* \returns pointer to first overview for map item
|
||||
* @see overviews()
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
@ -344,7 +344,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
void setMapRotation( double r );
|
||||
|
||||
/** Returns the rotation used for drawing the map within the composer item
|
||||
* @returns rotation for map
|
||||
* \returns rotation for map
|
||||
* \param valueType controls whether the returned value is the user specified rotation,
|
||||
* or the current evaluated rotation (which may be affected by data driven rotation
|
||||
* settings).
|
||||
@ -373,7 +373,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
void assignFreeId();
|
||||
|
||||
/** Returns whether the map extent is set to follow the current atlas feature.
|
||||
* @returns true if map will follow the current atlas feature.
|
||||
* \returns true if map will follow the current atlas feature.
|
||||
* @see setAtlasDriven
|
||||
* @see atlasScalingMode
|
||||
*/
|
||||
@ -389,7 +389,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
/** Returns the current atlas scaling mode. This controls how the map's extents
|
||||
* are calculated for the current atlas feature when an atlas composition
|
||||
* is enabled.
|
||||
* @returns the current scaling mode
|
||||
* \returns the current scaling mode
|
||||
* \note this parameter is only used if atlasDriven() is true
|
||||
* @see setAtlasScalingMode
|
||||
* @see atlasDriven
|
||||
@ -410,7 +410,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
* \param valueType controls whether the returned value is the user specified atlas margin,
|
||||
* or the current evaluated atlas margin (which may be affected by data driven atlas margin
|
||||
* settings).
|
||||
* @returns margin size in percentage to leave around the atlas feature's extent
|
||||
* \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
|
||||
@ -426,7 +426,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
void setAtlasMargin( double margin ) { mAtlasMargin = margin; }
|
||||
|
||||
/** Get the number of layers that this item requires for exporting as layers
|
||||
* @returns 0 if this item is to be placed on the same layer as the previous item,
|
||||
* \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
|
||||
*/
|
||||
@ -434,7 +434,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
|
||||
|
||||
/** Returns a polygon representing the current visible map extent, considering map extents and rotation.
|
||||
* 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
|
||||
* \returns polygon with the four corner points representing the visible map extent. The points are
|
||||
* clockwise, starting at the top-left point
|
||||
* @see currentMapExtent
|
||||
*/
|
||||
|
@ -88,49 +88,49 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
|
||||
|
||||
/** 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
|
||||
* \returns const reference to grid, if found
|
||||
* @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
|
||||
* \returns reference to grid if found
|
||||
* @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
|
||||
* \returns reference to grid if found
|
||||
* @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
|
||||
* \returns reference to grid if found
|
||||
* @see constGrid
|
||||
* @see grid
|
||||
*/
|
||||
QgsComposerMapGrid &operator[]( int idx );
|
||||
|
||||
/** Returns a list of QgsComposerMapGrids contained by the stack
|
||||
* @returns list of grids
|
||||
* \returns list of grids
|
||||
*/
|
||||
QList< QgsComposerMapGrid * > asList() const;
|
||||
|
||||
/** Sets the grid stack's state from a DOM document
|
||||
* \param elem is DOM node corresponding to 'a ComposerMap' tag
|
||||
* \param doc DOM document
|
||||
* @returns true if read was successful
|
||||
* \returns true if read was successful
|
||||
* @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
|
||||
* \returns maximum grid extension
|
||||
* @see calculateMaxGridExtension()
|
||||
*/
|
||||
double maxGridExtension() const;
|
||||
@ -303,7 +303,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setCrs( const QgsCoordinateReferenceSystem &crs );
|
||||
|
||||
/** Retrieves the CRS for the grid.
|
||||
* @returns coordinate reference system for grid
|
||||
* \returns coordinate reference system for grid
|
||||
* @see setCrs
|
||||
*/
|
||||
QgsCoordinateReferenceSystem crs() const { return mCRS; }
|
||||
@ -315,7 +315,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
|
||||
|
||||
/** Retrieves the blending mode used for drawing the grid.
|
||||
* @returns blending mode for grid
|
||||
* \returns blending mode for grid
|
||||
* @see setBlendMode
|
||||
*/
|
||||
QPainter::CompositionMode blendMode() const { return mBlendMode; }
|
||||
@ -324,7 +324,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Calculates the maximum distance the grid extends beyond the QgsComposerMap's
|
||||
* item rect
|
||||
* @returns maximum extension in millimeters
|
||||
* \returns maximum extension in millimeters
|
||||
*/
|
||||
double maxExtension();
|
||||
|
||||
@ -353,7 +353,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the units used for grid measurements such as the interval
|
||||
* and offset for grid lines.
|
||||
* @returns for grid measurements
|
||||
* \returns for grid measurements
|
||||
* @see setUnits
|
||||
*/
|
||||
GridUnit units() const { return mGridUnit; }
|
||||
@ -368,7 +368,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the interval between grid lines in the x-direction. The units
|
||||
* are retrieved through the units() method.
|
||||
* @returns interval between horizontal grid lines
|
||||
* \returns interval between horizontal grid lines
|
||||
* @see setIntervalX
|
||||
* @see intervalY
|
||||
*/
|
||||
@ -384,7 +384,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the interval between grid lines in the y-direction. The units
|
||||
* are retrieved through the units() method.
|
||||
* @returns interval between vertical grid lines
|
||||
* \returns interval between vertical grid lines
|
||||
* @see setIntervalY
|
||||
* @see intervalX
|
||||
*/
|
||||
@ -400,7 +400,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the offset for grid lines in the x-direction. The units
|
||||
* are retrieved through the units() method.
|
||||
* @returns offset for horizontal grid lines
|
||||
* \returns offset for horizontal grid lines
|
||||
* @see setOffsetX
|
||||
* @see offsetY
|
||||
*/
|
||||
@ -416,7 +416,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the offset for grid lines in the y-direction. The units
|
||||
* are retrieved through the units() method.
|
||||
* @returns offset for vertical grid lines
|
||||
* \returns offset for vertical grid lines
|
||||
* @see setOffsetY
|
||||
* @see offsetX
|
||||
*/
|
||||
@ -435,7 +435,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the grid's style, which controls how the grid is drawn
|
||||
* over the map's contents
|
||||
* @returns current grid style
|
||||
* \returns current grid style
|
||||
* @see setStyle
|
||||
*/
|
||||
GridStyle style() const { return mGridStyle; }
|
||||
@ -449,7 +449,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** 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
|
||||
* \returns cross length in millimeters
|
||||
* @see setCrossLength
|
||||
*/
|
||||
double crossLength() const { return mCrossLength; }
|
||||
@ -483,7 +483,7 @@ 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
|
||||
* \returns line symbol for grid lines
|
||||
* @see setLineSymbol
|
||||
* @see markerSymbol
|
||||
* @see style
|
||||
@ -493,7 +493,7 @@ 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
|
||||
* \returns line symbol for grid lines
|
||||
* @see setLineSymbol
|
||||
* @see markerSymbol
|
||||
* @see style
|
||||
@ -511,7 +511,7 @@ 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
|
||||
* \returns marker symbol for grid intersection points
|
||||
* @see setMarkerSymbol
|
||||
* @see lineSymbol
|
||||
* @see style
|
||||
@ -521,7 +521,7 @@ 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
|
||||
* \returns marker symbol for grid intersection points
|
||||
* @see setMarkerSymbol
|
||||
* @see lineSymbol
|
||||
* @see style
|
||||
@ -539,7 +539,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setAnnotationEnabled( const bool enabled ) { mShowGridAnnotation = enabled; }
|
||||
|
||||
/** Gets whether annotations are shown for the grid.
|
||||
* @returns true if annotations are drawn for the grid
|
||||
* \returns true if annotations are drawn for the grid
|
||||
* @see setAnnotationEnabled
|
||||
*/
|
||||
bool annotationEnabled() const { return mShowGridAnnotation; }
|
||||
@ -551,7 +551,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setAnnotationFont( const QFont &font ) { mGridAnnotationFont = font; }
|
||||
|
||||
/** Gets the font used for drawing grid annotations
|
||||
* @returns font for annotations
|
||||
* \returns font for annotations
|
||||
* @see setAnnotationFont
|
||||
*/
|
||||
QFont annotationFont() const { return mGridAnnotationFont; }
|
||||
@ -563,7 +563,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setAnnotationFontColor( const QColor &color ) { mGridAnnotationFontColor = color; }
|
||||
|
||||
/** Gets the font color used for drawing grid annotations
|
||||
* @returns font color for annotations
|
||||
* \returns font color for annotations
|
||||
* @see setAnnotationFontColor
|
||||
*/
|
||||
QColor annotationFontColor() const { return mGridAnnotationFontColor; }
|
||||
@ -575,7 +575,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setAnnotationPrecision( const int precision ) { mGridAnnotationPrecision = precision; }
|
||||
|
||||
/** Returns the coordinate precision for grid annotations
|
||||
* @returns number of decimal places shown when drawing grid annotations
|
||||
* \returns number of decimal places shown when drawing grid annotations
|
||||
* @see setAnnotationPrecision
|
||||
*/
|
||||
int annotationPrecision() const { return mGridAnnotationPrecision; }
|
||||
@ -593,7 +593,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
* frame. This property also specifies whether annotations have been disabled
|
||||
* from a side of the map frame.
|
||||
* \param border side of map for annotations
|
||||
* @returns display mode for grid annotations
|
||||
* \returns display mode for grid annotations
|
||||
* @see setAnnotationDisplay
|
||||
* \since QGIS 2.7
|
||||
*/
|
||||
@ -610,7 +610,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
/** Gets the position for the grid annotations on a specified side of the map
|
||||
* frame.
|
||||
* \param border side of map for annotations
|
||||
* @returns position that grid annotations are drawn in
|
||||
* \returns position that grid annotations are drawn in
|
||||
* @see setAnnotationPosition
|
||||
*/
|
||||
AnnotationPosition annotationPosition( const BorderSide border ) const;
|
||||
@ -622,7 +622,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
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
|
||||
* \returns margin between map frame and annotations
|
||||
* @see setAnnotationFrameDistance
|
||||
*/
|
||||
double annotationFrameDistance() const { return mAnnotationFrameDistance; }
|
||||
@ -642,7 +642,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** Gets the direction for drawing frame annotations.
|
||||
* \param border side of map for annotations
|
||||
* @returns direction for frame annotations
|
||||
* \returns direction for frame annotations
|
||||
* @see setAnnotationDirection
|
||||
*/
|
||||
AnnotationDirection annotationDirection( const BorderSide border ) const;
|
||||
@ -654,7 +654,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setAnnotationFormat( const AnnotationFormat format ) { mGridAnnotationFormat = format; }
|
||||
|
||||
/** Gets the format for drawing grid annotations.
|
||||
* @returns format for grid annotations
|
||||
* \returns format for grid annotations
|
||||
* @see setAnnotationFormat
|
||||
*/
|
||||
AnnotationFormat annotationFormat() const { return mGridAnnotationFormat; }
|
||||
@ -669,7 +669,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
|
||||
* \returns expression for evaluating custom grid annotations
|
||||
* @see setAnnotationExpression
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
@ -686,7 +686,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setFrameStyle( const FrameStyle style ) { mGridFrameStyle = style; }
|
||||
|
||||
/** Gets the grid frame style.
|
||||
* @returns style for grid frame
|
||||
* \returns style for grid frame
|
||||
* @see setFrameStyle
|
||||
*/
|
||||
FrameStyle frameStyle() const { return mGridFrameStyle; }
|
||||
@ -701,7 +701,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
|
||||
* \returns grid divisions for frame
|
||||
* @see setFrameDivisions
|
||||
* \since QGIS 2.7
|
||||
*/
|
||||
@ -727,7 +727,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
|
||||
/** 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
|
||||
* \returns flags for side of map grid is drawn on
|
||||
* @see setFrameSideFlags
|
||||
* @see setFrameSideFlag
|
||||
* @see testFrameSideFlag
|
||||
@ -737,7 +737,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
/** Tests whether the grid frame should be drawn on a specified side of the map
|
||||
* item.
|
||||
* \param flag flag for grid frame side
|
||||
* @returns true if grid frame should be drawn for that side of the map
|
||||
* \returns true if grid frame should be drawn for that side of the map
|
||||
* @see setFrameSideFlags
|
||||
* @see setFrameSideFlag
|
||||
* @see frameSideFlags
|
||||
@ -755,7 +755,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
/** Gets the grid frame width. This property controls how wide the grid frame is.
|
||||
* The size of the line outlines drawn in the frame can be retrieved via the
|
||||
* framePenSize method.
|
||||
* @returns width of grid frame in millimeters
|
||||
* \returns width of grid frame in millimeters
|
||||
* @see setFrameWidth
|
||||
*/
|
||||
double frameWidth() const { return mGridFrameWidth; }
|
||||
@ -768,7 +768,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setFramePenSize( const double width ) { mGridFramePenThickness = width; }
|
||||
|
||||
/** Retrieves the width of the stroke drawn in the grid frame.
|
||||
* @returns width of grid frame stroke
|
||||
* \returns width of grid frame stroke
|
||||
* @see setFramePenSize
|
||||
* @see framePenColor
|
||||
*/
|
||||
@ -784,7 +784,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setFramePenColor( const QColor &color ) { mGridFramePenColor = color; }
|
||||
|
||||
/** Retrieves the color of the stroke drawn in the grid frame.
|
||||
* @returns color of grid frame stroke
|
||||
* \returns color of grid frame stroke
|
||||
* @see setFramePenColor
|
||||
* @see framePenSize
|
||||
* @see frameFillColor1
|
||||
@ -801,7 +801,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setFrameFillColor1( const QColor &color ) { mGridFrameFillColor1 = color; }
|
||||
|
||||
/** Retrieves the first fill color for the grid frame.
|
||||
* @returns first fill color for grid frame
|
||||
* \returns first fill color for grid frame
|
||||
* @see setFrameFillColor1
|
||||
* @see framePenColor
|
||||
* @see frameFillColor2
|
||||
@ -817,7 +817,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
void setFrameFillColor2( const QColor &color ) { mGridFrameFillColor2 = color; }
|
||||
|
||||
/** Retrieves the second fill color for the grid frame.
|
||||
* @returns second fill color for grid frame
|
||||
* \returns second fill color for grid frame
|
||||
* @see setFrameFillColor2
|
||||
* @see framePenColor
|
||||
* @see frameFillColor1
|
||||
@ -974,11 +974,11 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
|
||||
QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const;
|
||||
|
||||
/** Returns the grid lines with associated coordinate value
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int xGridLines( QList< QPair< double, QLineF > > &lines ) const;
|
||||
|
||||
/** Returns the grid lines for the y-coordinates. Not vertical in case of rotation
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int yGridLines( QList< QPair< double, QLineF > > &lines ) const;
|
||||
|
||||
int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const;
|
||||
|
@ -64,13 +64,13 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
|
||||
virtual void setComposerMap( QgsComposerMap *map );
|
||||
|
||||
/** Get composer map for the item
|
||||
* @returns composer map
|
||||
* \returns composer map
|
||||
* @see setComposerMap
|
||||
*/
|
||||
virtual const QgsComposerMap *composerMap() const { return mComposerMap; }
|
||||
|
||||
/** Get the unique id for the map item
|
||||
* @returns unique id
|
||||
* \returns unique id
|
||||
*/
|
||||
QString id() const { return mUuid; }
|
||||
|
||||
@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
|
||||
virtual void setName( const QString &name ) { mName = name; }
|
||||
|
||||
/** Get friendly display name for the item
|
||||
* @returns display name
|
||||
* \returns display name
|
||||
* @see setName
|
||||
*/
|
||||
virtual QString name() const { return mName; }
|
||||
@ -93,13 +93,13 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
|
||||
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
|
||||
* \returns true if item will be drawn on the map
|
||||
* @see setEnabled
|
||||
*/
|
||||
virtual bool enabled() const { return mEnabled; }
|
||||
|
||||
/** Returns true if the item is drawn using advanced effects, such as blend modes.
|
||||
* @returns true if item uses advanced effects
|
||||
* \returns true if item uses advanced effects
|
||||
*/
|
||||
virtual bool usesAdvancedEffects() const { return false; }
|
||||
|
||||
@ -141,14 +141,14 @@ class CORE_EXPORT QgsComposerMapItemStack
|
||||
virtual ~QgsComposerMapItemStack();
|
||||
|
||||
/** Returns the number of items in the stack
|
||||
* @returns number of items in the stack
|
||||
* \returns number of items in the stack
|
||||
*/
|
||||
int size() const { return mItems.size(); }
|
||||
|
||||
/** Stores the state of the item stack in a DOM node
|
||||
* \param elem is DOM element corresponding to a 'ComposerMap' tag
|
||||
* \param doc DOM document
|
||||
* @returns true if write was successful
|
||||
* \returns true if write was successful
|
||||
* @see readXml
|
||||
*/
|
||||
virtual bool writeXml( QDomElement &elem, QDomDocument &doc ) const;
|
||||
@ -156,7 +156,7 @@ class CORE_EXPORT QgsComposerMapItemStack
|
||||
/** Sets the item stack's state from a DOM document
|
||||
* \param elem is DOM node corresponding to 'a ComposerMap' tag
|
||||
* \param doc DOM document
|
||||
* @returns true if read was successful
|
||||
* \returns true if read was successful
|
||||
* @see writeXml
|
||||
*/
|
||||
virtual bool readXml( const QDomElement &elem, const QDomDocument &doc ) = 0;
|
||||
@ -168,7 +168,7 @@ class CORE_EXPORT QgsComposerMapItemStack
|
||||
|
||||
/** Returns whether any items within the stack contain advanced effects,
|
||||
* such as blending modes
|
||||
* @returns true if item stack contains advanced effects
|
||||
* \returns true if item stack contains advanced effects
|
||||
*/
|
||||
bool containsAdvancedEffects() const;
|
||||
|
||||
@ -210,28 +210,28 @@ class CORE_EXPORT QgsComposerMapItemStack
|
||||
|
||||
/** 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
|
||||
* \returns const reference to item, if found
|
||||
* @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
|
||||
* \returns reference to item if found
|
||||
* @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
|
||||
* \returns reference to item if found
|
||||
* @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
|
||||
* \returns reference to item if found
|
||||
* @see constItem
|
||||
* @see item
|
||||
* \note not available in Python bindings
|
||||
@ -239,7 +239,7 @@ class CORE_EXPORT QgsComposerMapItemStack
|
||||
QgsComposerMapItem &operator[]( int idx );
|
||||
|
||||
/** Returns a list of QgsComposerMapItems contained by the stack
|
||||
* @returns list of items
|
||||
* \returns list of items
|
||||
*/
|
||||
QList< QgsComposerMapItem * > asList() const;
|
||||
|
||||
|
@ -82,42 +82,42 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
|
||||
|
||||
/** 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
|
||||
* \returns const reference to overview, if found
|
||||
* @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
|
||||
* \returns reference to overview if found
|
||||
* @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
|
||||
* \returns reference to overview if found
|
||||
* @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
|
||||
* \returns reference to overview if found
|
||||
* @see constOverview
|
||||
* @see overview
|
||||
*/
|
||||
QgsComposerMapOverview &operator[]( int idx );
|
||||
|
||||
/** Returns a list of QgsComposerMapOverviews contained by the stack
|
||||
* @returns list of overviews
|
||||
* \returns list of overviews
|
||||
*/
|
||||
QList< QgsComposerMapOverview * > asList() const;
|
||||
|
||||
/** Sets the overview stack's state from a DOM document
|
||||
* \param elem is DOM node corresponding to a 'ComposerMap' tag
|
||||
* \param doc DOM document
|
||||
* @returns true if read was successful
|
||||
* \returns true if read was successful
|
||||
* @see writeXml
|
||||
*/
|
||||
bool readXml( const QDomElement &elem, const QDomDocument &doc ) override;
|
||||
@ -173,7 +173,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
|
||||
void setFrameMap( const int mapId );
|
||||
|
||||
/** Returns id of source map.
|
||||
* @returns source map id, or -1 if no source map set
|
||||
* \returns source map id, or -1 if no source map set
|
||||
*/
|
||||
int frameMapId() const { return mFrameMapId; }
|
||||
|
||||
@ -184,20 +184,20 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
|
||||
void setFrameSymbol( QgsFillSymbol *symbol );
|
||||
|
||||
/** Gets the fill symbol used for drawing the overview extent.
|
||||
* @returns fill symbol for overview
|
||||
* \returns fill symbol for overview
|
||||
* @see setFrameSymbol
|
||||
*/
|
||||
QgsFillSymbol *frameSymbol() { return mFrameSymbol; }
|
||||
|
||||
/** Gets the fill symbol used for drawing the overview extent.
|
||||
* @returns fill symbol for overview
|
||||
* \returns fill symbol for overview
|
||||
* @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
|
||||
* \returns blending mode for overview
|
||||
* @see setBlendMode
|
||||
*/
|
||||
QPainter::CompositionMode blendMode() const { return mBlendMode; }
|
||||
@ -210,7 +210,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
|
||||
|
||||
/** 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
|
||||
* \returns true if overview frame is inverted
|
||||
* @see setInverted
|
||||
*/
|
||||
bool inverted() const { return mInverted; }
|
||||
@ -223,7 +223,7 @@ class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem
|
||||
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
|
||||
* \returns true if map will be centered on overview
|
||||
* @see setCentered
|
||||
*/
|
||||
bool centered() const { return mCentered; }
|
||||
|
@ -88,7 +88,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Returns the size of the z-order list, which includes items which may
|
||||
* have been removed from the composition.
|
||||
* @returns size of z-order list
|
||||
* \returns size of z-order list
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
int zOrderListSize() const;
|
||||
@ -114,7 +114,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Moves an item up the z-order list.
|
||||
* \param item item to move
|
||||
* @returns true if item was moved. Returns false if item was not found
|
||||
* \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
|
||||
@ -125,7 +125,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Moves an item down the z-order list.
|
||||
* \param item item to move
|
||||
* @returns true if item was moved. Returns false if item was not found
|
||||
* \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
|
||||
@ -136,7 +136,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Moves an item to the top of the z-order list.
|
||||
* \param item item to move
|
||||
* @returns true if item was moved. Returns false if item was not found
|
||||
* \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
|
||||
@ -147,7 +147,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Moves an item to the bottom of the z-order list.
|
||||
* \param item item to move
|
||||
* @returns true if item was moved. Returns false if item was not found
|
||||
* \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
|
||||
@ -160,7 +160,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
* items which are currently in the composition, and ignores items which have been
|
||||
* removed from the composition.
|
||||
* \param item item to search above
|
||||
* @returns item above specified item. If no items were found, no item
|
||||
* \returns item above specified item. If no items were found, no item
|
||||
* will be returned.
|
||||
* @see getComposerItemBelow
|
||||
* \since QGIS 2.5
|
||||
@ -171,7 +171,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
* items which are currently in the composition, and ignores items which have been
|
||||
* removed from the composition.
|
||||
* \param item item to search above
|
||||
* @returns item below specified item. If no items were found, no item
|
||||
* \returns item below specified item. If no items were found, no item
|
||||
* will be returned.
|
||||
* @see getComposerItemAbove
|
||||
* \since QGIS 2.5
|
||||
@ -180,7 +180,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Returns the item z-order list. This list includes both items currently in the
|
||||
* composition and items which have been removed from the composition.
|
||||
* @returns item z-order list
|
||||
* \returns item z-order list
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
QList<QgsComposerItem *> *zOrderList();
|
||||
@ -240,7 +240,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
/** Returns the QModelIndex corresponding to a QgsComposerItem, if possible
|
||||
* \param item QgsComposerItem to find index for
|
||||
* \param column column number for created QModelIndex
|
||||
* @returns QModelIndex corresponding to item and specified column
|
||||
* \returns QModelIndex corresponding to item and specified column
|
||||
*/
|
||||
QModelIndex indexForItem( QgsComposerItem *item, const int column = 0 );
|
||||
|
||||
@ -267,7 +267,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
|
||||
|
||||
/** Returns the QgsComposerItem corresponding to a QModelIndex, if possible
|
||||
* \param index QModelIndex for item
|
||||
* @returns item corresponding to index
|
||||
* \returns item corresponding to index
|
||||
*/
|
||||
QgsComposerItem *itemFromIndex( const QModelIndex &index ) const;
|
||||
|
||||
@ -340,7 +340,7 @@ class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel
|
||||
/** Returns the QgsComposerItem corresponding to an index from the source
|
||||
* QgsComposerModel model.
|
||||
* \param sourceIndex a QModelIndex
|
||||
* @returns QgsComposerItem for specified index from QgsComposerModel
|
||||
* \returns QgsComposerItem for specified index from QgsComposerModel
|
||||
*/
|
||||
QgsComposerItem *itemFromSourceIndex( const QModelIndex &sourceIndex ) const;
|
||||
|
||||
|
@ -63,14 +63,14 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
virtual ~QgsComposerMultiFrame();
|
||||
|
||||
/** Returns the total size of the multiframe's content.
|
||||
* @returns total size required for content
|
||||
* \returns total size required for content
|
||||
*/
|
||||
virtual QSizeF totalSize() const = 0;
|
||||
|
||||
/** Returns the fixed size for a frame, if desired. If the fixed frame size changes,
|
||||
* the sizes of all frames can be recalculated by calling recalculateFrameRects().
|
||||
* \param frameIndex frame number
|
||||
* @returns fixed size for frame. If the size has a width or height of 0, then
|
||||
* \returns fixed size for frame. If the size has a width or height of 0, then
|
||||
* the frame size is not fixed in that direction and frames can have variable width
|
||||
* or height accordingly.
|
||||
* \since QGIS 2.5
|
||||
@ -83,7 +83,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
* size changes, the sizes of all frames can be recalculated by calling
|
||||
* recalculateFrameRects().
|
||||
* \param frameIndex frame number
|
||||
* @returns minimum size for frame. If the size has a width or height of 0, then
|
||||
* \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
|
||||
@ -108,7 +108,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
|
||||
/** Finds the optimal position to break a frame at.
|
||||
* \param yPos maximum vertical position for break
|
||||
* @returns the optimal breakable position which occurs in the multi frame close
|
||||
* \returns the optimal breakable position which occurs in the multi frame close
|
||||
* to and before the specified yPos
|
||||
* \since QGIS 2.3
|
||||
*/
|
||||
@ -135,7 +135,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
void setResizeMode( ResizeMode mode );
|
||||
|
||||
/** Returns the resize mode for the multiframe.
|
||||
* @returns resize mode
|
||||
* \returns resize mode
|
||||
* @see setResizeMode
|
||||
*/
|
||||
ResizeMode resizeMode() const { return mResizeMode; }
|
||||
@ -177,12 +177,12 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
bool _readXml( const QDomElement &itemElem, const QDomDocument &doc, bool ignoreFrames = false );
|
||||
|
||||
/** Returns the parent composition for the multiframe.
|
||||
* @returns composition
|
||||
* \returns composition
|
||||
*/
|
||||
QgsComposition *composition() { return mComposition; }
|
||||
|
||||
/** Returns whether undo commands should be created for interactions with the multiframe.
|
||||
* @returns true if undo commands should be created
|
||||
* \returns true if undo commands should be created
|
||||
* @see setCreateUndoCommands
|
||||
*/
|
||||
bool createUndoCommands() const { return mCreateUndoCommands; }
|
||||
@ -194,20 +194,20 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
void setCreateUndoCommands( bool enabled ) { mCreateUndoCommands = enabled; }
|
||||
|
||||
/** Returns the number of frames associated with this multiframe.
|
||||
* @returns number of child frames
|
||||
* \returns number of child frames
|
||||
**/
|
||||
int frameCount() const { return mFrameItems.size(); }
|
||||
|
||||
/** Returns a child frame from the multiframe.
|
||||
* \param i index of frame
|
||||
* @returns child frame if found
|
||||
* \returns child frame if found
|
||||
* @see frameIndex
|
||||
*/
|
||||
QgsComposerFrame *frame( int i ) const;
|
||||
|
||||
/** Returns the index of a frame within the multiframe
|
||||
* \param frame frame to find index of
|
||||
* @returns index for frame if found, -1 if frame not found in multiframe
|
||||
* \returns index for frame if found, -1 if frame not found in multiframe
|
||||
* \since QGIS 2.5
|
||||
* @see frame
|
||||
*/
|
||||
@ -218,13 +218,13 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
* and general frame properties (e.g., frame style, background, rendering settings).
|
||||
* \param pos position of top-left corner of the new frame
|
||||
* \param size size of the new frame
|
||||
* @returns new QgsComposerFrame
|
||||
* \returns new QgsComposerFrame
|
||||
* \since QGIS 2.3
|
||||
*/
|
||||
QgsComposerFrame *createNewFrame( QgsComposerFrame *currentFrame, QPointF pos, QSizeF size );
|
||||
|
||||
/** Get multiframe display name.
|
||||
* @returns display name for item
|
||||
* \returns display name for item
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
virtual QString displayName() const;
|
||||
|
@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
|
||||
/** Gets the position of a node in scene coordinate.
|
||||
* \param index of the node
|
||||
* \param position the position of the node
|
||||
* @return true if the index is valid and the position is set, false otherwise
|
||||
* \return true if the index is valid and the position is set, false otherwise
|
||||
*/
|
||||
bool nodePosition( const int index, QPointF &position );
|
||||
|
||||
@ -105,7 +105,7 @@ class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
|
||||
bool setSelectedNode( const int index );
|
||||
|
||||
/** Returns the currently selected node.
|
||||
* @return the index of the selected node, -1 otherwise
|
||||
* \return the index of the selected node, -1 otherwise
|
||||
*/
|
||||
int selectedNode() { return mSelectedNode; }
|
||||
|
||||
|
@ -111,7 +111,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
|
||||
virtual ~QgsComposerObject() = default;
|
||||
|
||||
/** Returns the composition the item is attached to.
|
||||
* @returns QgsComposition for item.
|
||||
* \returns QgsComposition for item.
|
||||
*/
|
||||
const QgsComposition *composition() const { return mComposition; }
|
||||
|
||||
@ -162,7 +162,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
|
||||
/** Read a custom property from the object.
|
||||
* \param key property key
|
||||
* \param defaultValue default value to return if property with matching key does not exist
|
||||
* @returns value of matching property
|
||||
* \returns value of matching property
|
||||
* @see setCustomProperty()
|
||||
* @see removeCustomProperty()
|
||||
* @see customProperties()
|
||||
|
@ -81,7 +81,7 @@ 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
|
||||
* \returns path for the source image
|
||||
* @see usePictureExpression
|
||||
* @see setPicturePath
|
||||
* \since QGIS 2.5
|
||||
@ -106,7 +106,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
|
||||
bool readXml( const QDomElement &itemElem, const QDomDocument &doc ) override;
|
||||
|
||||
/** Returns the rotation used for drawing the picture within the item's frame
|
||||
* @returns picture rotation in degrees
|
||||
* \returns picture rotation in degrees
|
||||
* \since QGIS 2.2
|
||||
* @see setPictureRotation
|
||||
* @see rotationMap
|
||||
@ -126,14 +126,14 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
|
||||
/** Returns the id of the rotation map. A value of -1 means map rotation is
|
||||
* disabled. If this is set then the picture is rotated by the same amount
|
||||
* as the specified map object.
|
||||
* @returns id of map object
|
||||
* \returns id of map object
|
||||
* @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
|
||||
* \returns true if rotation map is in use
|
||||
* @see rotationMap
|
||||
* @see setRotationMap
|
||||
*/
|
||||
@ -173,7 +173,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
|
||||
|
||||
/** Returns the resize mode used for drawing the picture within the composer
|
||||
* item's frame.
|
||||
* @returns resize mode of picture
|
||||
* \returns resize mode of picture
|
||||
* \since QGIS 2.3
|
||||
* @see setResizeMode
|
||||
*/
|
||||
@ -189,7 +189,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
|
||||
|
||||
/** Returns the picture's current anchor, which controls how it is placed
|
||||
* within the picture item's frame.
|
||||
* @returns anchor point for picture
|
||||
* \returns anchor point for picture
|
||||
* \since QGIS 2.3
|
||||
* @see setPictureAnchor
|
||||
*/
|
||||
@ -247,7 +247,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
|
||||
void setSvgStrokeWidth( double width );
|
||||
|
||||
/** Returns the current picture mode (image format).
|
||||
* @returns picture mode
|
||||
* \returns picture mode
|
||||
* \since QGIS 2.3
|
||||
*/
|
||||
Mode mode() const { return mMode; }
|
||||
|
@ -146,7 +146,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
void setFont( const QFont &font );
|
||||
|
||||
/** Returns the color used for drawing text in the scalebar.
|
||||
* @returns font color for scalebar.
|
||||
* \returns font color for scalebar.
|
||||
* @see setFontColor
|
||||
* @see font
|
||||
*/
|
||||
@ -212,14 +212,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
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.
|
||||
* \returns QPen used for drawing the scalebar outlines.
|
||||
* @see setPen
|
||||
* @see brush
|
||||
*/
|
||||
QPen pen() const {return mPen;}
|
||||
|
||||
/** Returns the primary brush for the scalebar.
|
||||
* @returns QBrush used for filling the scalebar
|
||||
* \returns QBrush used for filling the scalebar
|
||||
* @see setBrush
|
||||
* @see brush2
|
||||
* @see pen
|
||||
@ -228,7 +228,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
|
||||
/** 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
|
||||
* \returns QBrush used for secondary color areas
|
||||
* @see setBrush2
|
||||
* @see brush
|
||||
*/
|
||||
@ -258,7 +258,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
void setUnits( ScaleBarUnits u );
|
||||
|
||||
/** Returns the join style used for drawing lines in the scalebar
|
||||
* @returns Join style for lines
|
||||
* \returns Join style for lines
|
||||
* \since QGIS 2.3
|
||||
* @see setLineJoinStyle
|
||||
*/
|
||||
@ -266,14 +266,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
|
||||
/** Sets join style used when drawing the lines in the scalebar
|
||||
* \param style Join style for lines
|
||||
* @returns nothing
|
||||
* \returns nothing
|
||||
* \since QGIS 2.3
|
||||
* @see lineJoinStyle
|
||||
*/
|
||||
void setLineJoinStyle( Qt::PenJoinStyle style );
|
||||
|
||||
/** Returns the cap style used for drawing lines in the scalebar
|
||||
* @returns Cap style for lines
|
||||
* \returns Cap style for lines
|
||||
* \since QGIS 2.3
|
||||
* @see setLineCapStyle
|
||||
*/
|
||||
@ -281,7 +281,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
|
||||
|
||||
/** Sets cap style used when drawing the lines in the scalebar
|
||||
* \param style Cap style for lines
|
||||
* @returns nothing
|
||||
* \returns nothing
|
||||
* \since QGIS 2.3
|
||||
* @see lineCapStyle
|
||||
*/
|
||||
|
@ -56,7 +56,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
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.
|
||||
* \returns column width in mm, or 0 if column width is automatically calculated.
|
||||
* \since QGIS 2.5
|
||||
* @see setWidth
|
||||
*/
|
||||
@ -71,7 +71,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
|
||||
/** Returns the heading for a column, which is the value displayed in the columns
|
||||
* header cell.
|
||||
* @returns Heading for column.
|
||||
* \returns Heading for column.
|
||||
* \since QGIS 2.3
|
||||
* @see setHeading
|
||||
*/
|
||||
@ -87,7 +87,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
|
||||
/** Returns the horizontal alignment for a column, which controls the alignment
|
||||
* used for drawing column values within cells.
|
||||
* @returns horizontal alignment.
|
||||
* \returns horizontal alignment.
|
||||
* \since QGIS 2.3
|
||||
* @see setHAlignment
|
||||
* @see vAlignment
|
||||
@ -105,7 +105,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
|
||||
/** Returns the vertical alignment for a column, which controls the alignment
|
||||
* used for drawing column values within cells.
|
||||
* @returns vertical alignment.
|
||||
* \returns vertical alignment.
|
||||
* \since QGIS 2.12
|
||||
* @see setVAlignment
|
||||
* @see hAlignment
|
||||
@ -123,7 +123,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
|
||||
/** Returns the attribute name or expression used for the column's values. This property
|
||||
* is only used when the column is part of a QgsComposerAttributeTable.
|
||||
* @returns attribute name or expression text for column
|
||||
* \returns attribute name or expression text for column
|
||||
* \since QGIS 2.3
|
||||
* \note only applicable when used in a QgsComposerAttributeTable
|
||||
* @see setAttribute
|
||||
@ -141,7 +141,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
|
||||
/** Returns the sort order for the column. This property is only used when the column
|
||||
* is part of a QgsComposerAttributeTable and when sortByRank is > 0.
|
||||
* @returns sort order for column
|
||||
* \returns sort order for column
|
||||
* \since QGIS 2.3
|
||||
* \note only applicable when used in a QgsComposerAttributeTable
|
||||
* @see setSortOrder
|
||||
@ -164,7 +164,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
* column when the table is sorted by multiple columns, with lower sort ranks
|
||||
* having higher priority. This property is only used when the column
|
||||
* is part of a QgsComposerAttributeTable.
|
||||
* @returns sort rank for column. If sort rank is <= 0 then the column is not being
|
||||
* \returns sort rank for column. If sort rank is <= 0 then the column is not being
|
||||
* sorted.
|
||||
* \since QGIS 2.3
|
||||
* \note only applicable when used in a QgsComposerAttributeTable
|
||||
@ -188,7 +188,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
|
||||
void setSortByRank( int sortByRank ) { mSortByRank = sortByRank; }
|
||||
|
||||
/** Creates a duplicate column which is a deep copy of this column.
|
||||
* @returns a new QgsComposerTableColumn with same properties as this column.
|
||||
* \returns a new QgsComposerTableColumn with same properties as this column.
|
||||
* \since QGIS 2.3
|
||||
*/
|
||||
QgsComposerTableColumn *clone();
|
||||
|
@ -157,7 +157,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setCellMargin( const double margin );
|
||||
|
||||
/** Returns the margin distance between cell borders and their contents.
|
||||
* @returns margin for cell contents
|
||||
* \returns margin for cell contents
|
||||
* @see setCellMargin
|
||||
*/
|
||||
double cellMargin() const { return mCellMargin; }
|
||||
@ -170,7 +170,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
|
||||
/** 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
|
||||
* \returns behavior mode for empty tables
|
||||
* @see setEmptyTableBehavior
|
||||
*/
|
||||
EmptyTableMode emptyTableBehavior() const { return mEmptyTableMode; }
|
||||
@ -187,7 +187,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
/** Returns the message for empty tables with no content rows. This message
|
||||
* is displayed in the table body if the empty table behavior is
|
||||
* set to ShowMessage
|
||||
* @returns message to show for empty tables
|
||||
* \returns message to show for empty tables
|
||||
* @see setEmptyTableMessage
|
||||
* @see emptyTableBehavior
|
||||
*/
|
||||
@ -200,7 +200,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setShowEmptyRows( const bool showEmpty );
|
||||
|
||||
/** Returns whether empty rows are drawn in the table
|
||||
* @returns true if empty rows are drawn
|
||||
* \returns true if empty rows are drawn
|
||||
* @see setShowEmptyRows
|
||||
*/
|
||||
bool showEmptyRows() const { return mShowEmptyRows; }
|
||||
@ -213,7 +213,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setHeaderFont( const QFont &font );
|
||||
|
||||
/** Returns the font used to draw header text in the table.
|
||||
* @returns font for header cells
|
||||
* \returns font for header cells
|
||||
* @see setHeaderFont
|
||||
* @see contentFont
|
||||
*/
|
||||
@ -228,7 +228,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setHeaderFontColor( const QColor &color );
|
||||
|
||||
/** Returns the color used to draw header text in the table.
|
||||
* @returns color for header text
|
||||
* \returns color for header text
|
||||
* @see setHeaderFontColor
|
||||
* @see headerFont
|
||||
* @see contentFontColor
|
||||
@ -242,7 +242,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setHeaderHAlignment( const HeaderHAlignment alignment );
|
||||
|
||||
/** Returns the horizontal alignment for table headers
|
||||
* @returns Horizontal alignment for table header cells
|
||||
* \returns Horizontal alignment for table header cells
|
||||
* @see setHeaderHAlignment
|
||||
*/
|
||||
HeaderHAlignment headerHAlignment() const { return mHeaderHAlignment; }
|
||||
@ -256,7 +256,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
|
||||
/** 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
|
||||
* \returns display mode for headers
|
||||
* @see setHeaderMode
|
||||
*/
|
||||
HeaderMode headerMode() const { return mHeaderMode; }
|
||||
@ -269,7 +269,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setContentFont( const QFont &font );
|
||||
|
||||
/** Returns the font used to draw text in table body cells.
|
||||
* @returns font for table cells
|
||||
* \returns font for table cells
|
||||
* @see setContentFont
|
||||
* @see headerFont
|
||||
*/
|
||||
@ -284,7 +284,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setContentFontColor( const QColor &color );
|
||||
|
||||
/** Returns the color used to draw text in table body cells.
|
||||
* @returns text color for table cells
|
||||
* \returns text color for table cells
|
||||
* @see setContentFontColor
|
||||
* @see contentFont
|
||||
* @see headerFontColor
|
||||
@ -300,7 +300,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setShowGrid( const bool showGrid );
|
||||
|
||||
/** Returns whether grid lines are drawn in the table
|
||||
* @returns true if grid lines are shown
|
||||
* \returns true if grid lines are shown
|
||||
* @see setShowGrid
|
||||
* @see gridStrokeWidth
|
||||
* @see gridColor
|
||||
@ -316,7 +316,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setGridStrokeWidth( const double width );
|
||||
|
||||
/** Returns the width of grid lines in the table.
|
||||
* @returns grid line width
|
||||
* \returns grid line width
|
||||
* @see setGridStrokeWidth
|
||||
* @see showGrid
|
||||
* @see gridColor
|
||||
@ -332,7 +332,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setGridColor( const QColor &color );
|
||||
|
||||
/** Returns the color used for grid lines in the table.
|
||||
* @returns grid line color
|
||||
* \returns grid line color
|
||||
* @see setGridColor
|
||||
* @see showGrid
|
||||
* @see gridStrokeWidth
|
||||
@ -350,7 +350,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
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
|
||||
* \returns true if grid's horizontal lines are drawn
|
||||
* @see setShowGrid
|
||||
* @see setGridStrokeWidth
|
||||
* @see setGridColor
|
||||
@ -370,7 +370,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
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
|
||||
* \returns true if grid's vertical lines are drawn
|
||||
* @see setShowGrid
|
||||
* @see setGridStrokeWidth
|
||||
* @see setGridColor
|
||||
@ -387,7 +387,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
void setBackgroundColor( const QColor &color );
|
||||
|
||||
/** Returns the color used for the background of the table.
|
||||
* @returns table background color
|
||||
* \returns table background color
|
||||
* @see setBackgroundColor
|
||||
* @see gridColor
|
||||
*/
|
||||
@ -403,14 +403,14 @@ 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
|
||||
* \returns current wrap behavior
|
||||
* @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
|
||||
* \returns pointer to list of columns in table
|
||||
* @see setColumns
|
||||
*/
|
||||
QgsComposerTableColumns *columns() { return &mColumns; }
|
||||
@ -438,21 +438,21 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
const QgsComposerTableStyle *cellStyle( CellStyleGroup group ) const;
|
||||
|
||||
/** Returns the text used in the column headers for the table.
|
||||
* @returns QMap of int to QString, where the int is the column index (starting at 0),
|
||||
* \returns QMap of int to QString, where the int is the column index (starting at 0),
|
||||
* and the string is the text to use for the column's header
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
virtual QMap<int, QString> headerLabels() const;
|
||||
|
||||
/** Fetches the contents used for the cells in the table.
|
||||
* @returns true if table contents were successfully retrieved.
|
||||
* \returns true if table contents were successfully retrieved.
|
||||
* \param contents QgsComposerTableContents to store retrieved row data in
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
virtual bool getTableContents( QgsComposerTableContents &contents ) = 0;
|
||||
|
||||
/** Returns the current contents of the table. Excludes header cells.
|
||||
* @returns table contents
|
||||
* \returns table contents
|
||||
*/
|
||||
QgsComposerTableContents *contents() { return &mTableContents; }
|
||||
|
||||
@ -555,14 +555,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
virtual bool calculateMaxRowHeights();
|
||||
|
||||
/** Returns total width of table contents.
|
||||
* @returns table width
|
||||
* \returns table width
|
||||
* @see totalHeight
|
||||
*/
|
||||
//not const, as needs to call calculateMaxColumnWidths()
|
||||
double totalWidth();
|
||||
|
||||
/** Returns total height of table contents.
|
||||
* @returns total height
|
||||
* \returns total height
|
||||
* @see totalWidth
|
||||
*/
|
||||
//not const, as needs to call calculateMaxRowHeights()
|
||||
@ -576,7 +576,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
* \param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance,
|
||||
* if the frame would include all table content rows and have space left for extra rows then setting this parameter
|
||||
* to true would also include a count of these extra blank rows.
|
||||
* @returns number of visible content rows (excluding header row)
|
||||
* \returns number of visible content rows (excluding header row)
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const;
|
||||
@ -587,14 +587,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
* \param includeEmptyRows set to true to also include rows which would be empty in the returned count. For instance,
|
||||
* if the frame would include all table content rows and have space left for extra rows then setting this parameter
|
||||
* to true would also include a count of these extra blank rows.
|
||||
* @returns number of visible content rows (excludes header rows)
|
||||
* \returns number of visible content rows (excludes header rows)
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const;
|
||||
|
||||
/** Calculates a range of rows which should be visible in a given frame.
|
||||
* \param frameIndex index number for frame
|
||||
* @returns row range
|
||||
* \returns row range
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
QPair<int, int> rowRange( const int frameIndex ) const;
|
||||
@ -634,7 +634,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
/** Checks whether a table contents contains a given row
|
||||
* \param contents table contents to check
|
||||
* \param row row to check for
|
||||
* @returns true if contents contains rows
|
||||
* \returns true if contents contains rows
|
||||
*/
|
||||
bool contentsContainsRow( const QgsComposerTableContents &contents, const QgsComposerTableRow &row ) const;
|
||||
|
||||
@ -652,7 +652,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
|
||||
/** Returns the calculated background color for a row and column combination.
|
||||
* \param row row number, where -1 is the header row, and 0 is the first body row
|
||||
* \param column column number, where 0 is the first column
|
||||
* @returns background color, or invalid QColor if no background should be drawn
|
||||
* \returns background color, or invalid QColor if no background should be drawn
|
||||
*/
|
||||
QColor backgroundColor( int row, int column ) const;
|
||||
|
||||
|
@ -46,7 +46,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* starting from a line from north to south)
|
||||
* \param p1 start point of line
|
||||
* \param p2 end point of line
|
||||
* @returns angle in degrees, clockwise from south
|
||||
* \returns angle in degrees, clockwise from south
|
||||
*/
|
||||
static double angle( QPointF p1, QPointF p2 );
|
||||
|
||||
@ -59,14 +59,14 @@ 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)
|
||||
* \returns equivalent angle within the range [0, 360)
|
||||
* @see snappedAngle
|
||||
*/
|
||||
static double normalizedAngle( const double angle );
|
||||
|
||||
/** Snaps an angle to its closest 45 degree angle
|
||||
* \param angle angle in degrees
|
||||
* @returns angle snapped to 0, 45/90/135/180/225/270 or 315 degrees
|
||||
* \returns angle snapped to 0, 45/90/135/180/225/270 or 315 degrees
|
||||
*/
|
||||
static double snappedAngle( const double angle );
|
||||
|
||||
@ -75,7 +75,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* \param originalRect QRectF to be rotated and scaled
|
||||
* \param boundsRect QRectF specifying the bounds which the rotated and scaled rectangle must fit within
|
||||
* \param rotation the rotation in degrees to be applied to the rectangle
|
||||
* @returns largest scaled version of the rectangle possible
|
||||
* \returns largest scaled version of the rectangle possible
|
||||
*/
|
||||
static QRectF largestRotatedRectWithinBounds( const QRectF &originalRect, const QRectF &boundsRect, const double rotation );
|
||||
|
||||
@ -106,14 +106,14 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* \param beforeMax maximum value in before range
|
||||
* \param afterMin minimum value in after range
|
||||
* \param afterMax maximum value in after range
|
||||
* @returns position scaled to range specified by afterMin and afterMax
|
||||
* \returns position scaled to range specified by afterMin and afterMax
|
||||
*/
|
||||
static double relativePosition( const double position, const double beforeMin, const double beforeMax, const double afterMin, const double afterMax );
|
||||
|
||||
/** Decodes a string representing a paper orientation
|
||||
* \param orientationString string to decode
|
||||
* \param ok will be true if string could be decoded
|
||||
* @returns decoded paper orientation
|
||||
* \returns decoded paper orientation
|
||||
*/
|
||||
static QgsComposition::PaperOrientation decodePaperOrientation( const QString &orientationString, bool &ok );
|
||||
|
||||
@ -121,7 +121,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* \param presetString string to decode
|
||||
* \param width double for decoded paper width
|
||||
* \param height double for decoded paper height
|
||||
* @returns true if string could be decoded successfully
|
||||
* \returns true if string could be decoded successfully
|
||||
*/
|
||||
static bool decodePresetPaperSize( const QString &presetString, double &width, double &height );
|
||||
|
||||
@ -142,14 +142,14 @@ class CORE_EXPORT QgsComposerUtils
|
||||
/** Returns a font where size is set in pixels and the size has been upscaled with FONT_WORKAROUND_SCALE
|
||||
* to workaround QT font rendering bugs
|
||||
* \param font source font with size set in points
|
||||
* @returns font with size set in pixels
|
||||
* \returns font with size set in pixels
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
static QFont scaledFontPixelSize( const QFont &font );
|
||||
|
||||
/** Calculate font ascent in millimeters, including workarounds for QT font rendering issues
|
||||
* \param font input font
|
||||
* @returns font ascent in millimeters
|
||||
* \returns font ascent in millimeters
|
||||
* \since QGIS 2.5
|
||||
* @see fontDescentMM
|
||||
* @see fontHeightMM
|
||||
@ -160,7 +160,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
|
||||
/** Calculate font descent in millimeters, including workarounds for QT font rendering issues
|
||||
* \param font input font
|
||||
* @returns font descent in millimeters
|
||||
* \returns font descent in millimeters
|
||||
* \since QGIS 2.5
|
||||
* @see fontAscentMM
|
||||
* @see fontHeightMM
|
||||
@ -172,7 +172,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
/** Calculate font height in millimeters, including workarounds for QT font rendering issues
|
||||
* The font height is the font ascent + descent + 1 (for the baseline).
|
||||
* \param font input font
|
||||
* @returns font height in millimeters
|
||||
* \returns font height in millimeters
|
||||
* \since QGIS 2.5
|
||||
* @see fontAscentMM
|
||||
* @see fontDescentMM
|
||||
@ -185,7 +185,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* rendering issues
|
||||
* \param font input font
|
||||
* \param character character to calculate height for
|
||||
* @returns character height in millimeters
|
||||
* \returns character height in millimeters
|
||||
* \since QGIS 2.5
|
||||
* @see fontAscentMM
|
||||
* @see fontDescentMM
|
||||
@ -198,7 +198,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* rendering issues
|
||||
* \param font input font
|
||||
* \param text string to calculate width of
|
||||
* @returns string width in millimeters
|
||||
* \returns string width in millimeters
|
||||
* \since QGIS 2.5
|
||||
* @see fontAscentMM
|
||||
* @see fontDescentMM
|
||||
@ -214,7 +214,7 @@ class CORE_EXPORT QgsComposerUtils
|
||||
* \param font input font
|
||||
* \param text string to calculate height of
|
||||
* \param multiLineHeight line spacing factor
|
||||
* @returns string height in millimeters
|
||||
* \returns string height in millimeters
|
||||
* \since QGIS 2.12
|
||||
* @see textWidthMM
|
||||
*/
|
||||
|
@ -155,14 +155,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
bool keepRelativeItemPosition = true );
|
||||
|
||||
/** Height of paper item
|
||||
* @returns height in mm
|
||||
* \returns height in mm
|
||||
* @see paperWidth
|
||||
* @see setPaperSize
|
||||
*/
|
||||
double paperHeight() const;
|
||||
|
||||
/** Width of paper item
|
||||
* @returns width in mm
|
||||
* \returns width in mm
|
||||
* @see paperHeight
|
||||
* @see setPaperSize
|
||||
*/
|
||||
@ -211,7 +211,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
double &marginBottom, double &marginLeft ) const;
|
||||
|
||||
/** Returns the vertical space between pages in a composer view
|
||||
* @returns space between pages in mm
|
||||
* \returns space between pages in mm
|
||||
*/
|
||||
double spaceBetweenPages() const { return mSpaceBetweenPages; }
|
||||
|
||||
@ -222,7 +222,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
void setNumPages( const int pages );
|
||||
|
||||
/** Returns the number of pages in the composition.
|
||||
* @returns number of pages
|
||||
* \returns number of pages
|
||||
* @see setNumPages
|
||||
*/
|
||||
int numPages() const;
|
||||
@ -230,7 +230,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
/** Returns whether a page is empty, ie, it contains no items except for the background
|
||||
* paper item.
|
||||
* \param page page number, starting with 1
|
||||
* @returns true if page is empty
|
||||
* \returns true if page is empty
|
||||
* \since QGIS 2.5
|
||||
* @see numPages
|
||||
* @see setNumPages
|
||||
@ -240,7 +240,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
|
||||
/** Returns whether a specified page number should be included in exports of the composition.
|
||||
* \param page page number, starting with 1
|
||||
* @returns true if page should be exported
|
||||
* \returns true if page should be exported
|
||||
* \since QGIS 2.5
|
||||
* @see numPages
|
||||
* @see pageIsEmpty
|
||||
@ -333,7 +333,7 @@ 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
|
||||
* \returns snap tolerance in pixels
|
||||
* @see setAlignmentSnapTolerance
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
@ -347,7 +347,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
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
|
||||
* \returns true if selection bounding boxes should be shown
|
||||
* @see setBoundingBoxesVisible
|
||||
* \since QGIS 2.7
|
||||
*/
|
||||
@ -359,7 +359,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
/** Returns the topmost composer item at a specified position. Ignores paper items.
|
||||
* \param position point to search for item at
|
||||
* \param ignoreLocked set to true to ignore locked items
|
||||
* @returns composer item at position
|
||||
* \returns composer item at position
|
||||
*/
|
||||
QgsComposerItem *composerItemAt( QPointF position, const bool ignoreLocked = false ) const;
|
||||
|
||||
@ -367,7 +367,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
* \param position point to search for item at
|
||||
* \param belowItem item to search below
|
||||
* \param ignoreLocked set to true to ignore locked items
|
||||
* @returns composer item at position which is below specified item
|
||||
* \returns composer item at position which is below specified item
|
||||
*/
|
||||
QgsComposerItem *composerItemAt( QPointF position, const QgsComposerItem *belowItem, const bool ignoreLocked = false ) const;
|
||||
|
||||
@ -379,7 +379,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
|
||||
/** Returns list of selected composer items
|
||||
* \param includeLockedItems set to true to include locked items in list
|
||||
* @returns list of selected items
|
||||
* \returns list of selected items
|
||||
*/
|
||||
QList<QgsComposerItem *> selectedComposerItems( const bool includeLockedItems = true );
|
||||
|
||||
@ -403,14 +403,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const;
|
||||
|
||||
/** Returns the composer map with specified id
|
||||
* @return QgsComposerMap or 0 pointer if the composer map item does not exist
|
||||
* \return QgsComposerMap or 0 pointer if the composer map item does not exist
|
||||
*/
|
||||
const QgsComposerMap *getComposerMapById( const int id ) const;
|
||||
|
||||
/** Returns a composer item given its text identifier.
|
||||
* Ids are not necessarely unique, but this function returns only one element.
|
||||
* \param id - A QString representing the identifier of the item to retrieve.
|
||||
* @return QgsComposerItem pointer or 0 pointer if no such item exists.
|
||||
* \return QgsComposerItem pointer or 0 pointer if no such item exists.
|
||||
*/
|
||||
const QgsComposerItem *getComposerItemById( const QString &id ) const;
|
||||
|
||||
@ -533,7 +533,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
|
||||
/** Creates a new group from a list of composer items and adds it to the composition.
|
||||
* \param items items to include in group
|
||||
* @returns QgsComposerItemGroup of grouped items, if grouping was possible
|
||||
* \returns QgsComposerItemGroup of grouped items, if grouping was possible
|
||||
* \since QGIS 2.6
|
||||
*/
|
||||
QgsComposerItemGroup *groupItems( QList<QgsComposerItem *> items );
|
||||
@ -541,7 +541,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
/** Ungroups items by removing them from an item group and removing the group from the
|
||||
* composition.
|
||||
* \param group item group to ungroup
|
||||
* @returns list of items removed from the group, or an empty list if ungrouping
|
||||
* \returns list of items removed from the group, or an empty list if ungrouping
|
||||
* was not successful
|
||||
* \since QGIS 2.6
|
||||
*/
|
||||
@ -646,12 +646,12 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
void doPrint( QPrinter &printer, QPainter &painter, bool startNewPage = false );
|
||||
|
||||
/** Convenience function that prepares the printer and prints
|
||||
* @returns true if print was successful
|
||||
* \returns true if print was successful
|
||||
*/
|
||||
bool print( QPrinter &printer, const bool evaluateDDPageSize = false );
|
||||
|
||||
/** Convenience function that prepares the printer for printing in PDF and prints
|
||||
* @returns true if export was successful
|
||||
* \returns true if export was successful
|
||||
*/
|
||||
bool exportAsPDF( const QString &file );
|
||||
#endif
|
||||
@ -663,7 +663,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
* page size.
|
||||
* \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
|
||||
* \returns rendered image, or null image if image does not fit into available memory
|
||||
* @see renderRectAsRaster()
|
||||
* @see renderPage()
|
||||
*/
|
||||
@ -677,7 +677,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
* region of the composition.
|
||||
* \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
|
||||
* \returns rendered image, or null image if image does not fit into available memory
|
||||
* \since QGIS 2.12
|
||||
* @see printPageAsRaster()
|
||||
* @see renderRect()
|
||||
@ -734,14 +734,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
QgsAtlasComposition &atlasComposition() { return mAtlasComposition; }
|
||||
|
||||
/** Returns the current atlas mode of the composition
|
||||
* @returns current atlas mode
|
||||
* \returns current atlas mode
|
||||
* @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.
|
||||
* \returns false if the mode could not be changed.
|
||||
* @see atlasMode
|
||||
*/
|
||||
bool setAtlasMode( const QgsComposition::AtlasMode mode );
|
||||
@ -753,7 +753,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
QList< QgsPaperItem * > pages() { return mPages; }
|
||||
|
||||
/** Returns the items model attached to the composition
|
||||
* @returns QgsComposerModel for composition
|
||||
* \returns QgsComposerModel for composition
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
QgsComposerModel *itemsModel() { return mItemsModel; }
|
||||
@ -771,7 +771,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
/** Read a custom property from the composition.
|
||||
* \param key property key
|
||||
* \param defaultValue default value to return if property with matching key does not exist
|
||||
* @returns value of matching property
|
||||
* \returns value of matching property
|
||||
* @see setCustomProperty()
|
||||
* @see removeCustomProperty()
|
||||
* @see customProperties()
|
||||
@ -960,7 +960,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
void updateZValues( const bool addUndoCommands = true );
|
||||
|
||||
/** Returns the bounding rectangle of the selected items in scene coordinates
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int boundingRectOfSelectedItems( QRectF &bRect );
|
||||
|
||||
//! Loads default composer settings
|
||||
@ -990,7 +990,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
void refreshPageSize( const QgsExpressionContext *context = nullptr );
|
||||
|
||||
/** Check whether any data defined page settings are active.
|
||||
* @returns true if any data defined page settings are active.
|
||||
* \returns true if any data defined page settings are active.
|
||||
* \since QGIS 2.5
|
||||
*/
|
||||
bool ddPageSizeActive() const;
|
||||
|
@ -87,7 +87,7 @@ class CORE_EXPORT QgsDiagram
|
||||
* \param s The settings that specify the size type
|
||||
* \param c The rendering specifying the proper scale units for pixel conversion
|
||||
*
|
||||
* @return The converted size for rendering
|
||||
* \return The converted size for rendering
|
||||
*/
|
||||
QSizeF sizePainterUnits( QSizeF size, const QgsDiagramSettings &s, const QgsRenderContext &c );
|
||||
|
||||
@ -96,7 +96,7 @@ class CORE_EXPORT QgsDiagram
|
||||
* \param s Unused
|
||||
* \param c The rendering specifying the proper scale units for pixel conversion
|
||||
*
|
||||
* @return The converted length for rendering
|
||||
* \return The converted length for rendering
|
||||
*/
|
||||
double sizePainterUnits( double l, const QgsDiagramSettings &s, const QgsRenderContext &c );
|
||||
|
||||
@ -104,7 +104,7 @@ class CORE_EXPORT QgsDiagram
|
||||
* \param s The settings that contain the font size and size type
|
||||
* \param c The rendering specifying the proper scale units for pixel conversion
|
||||
*
|
||||
* @return The properly scaled font for rendering
|
||||
* \return The properly scaled font for rendering
|
||||
*/
|
||||
QFont scaledFont( const QgsDiagramSettings &s, const QgsRenderContext &c );
|
||||
|
||||
|
@ -66,7 +66,7 @@ class CORE_EXPORT QgsTextDiagram: public QgsDiagram
|
||||
QPen mPen;
|
||||
|
||||
/** Calculates intersection points between a line and an ellipse
|
||||
@return intersection points*/
|
||||
\return intersection points*/
|
||||
void lineEllipseIntersection( QPointF lineStart, QPointF lineEnd, QPointF ellipseMid, double r1, double r2, QList<QPointF> &result ) const;
|
||||
};
|
||||
|
||||
|
@ -72,7 +72,7 @@ class CORE_EXPORT QgsDxfExport
|
||||
* Export to a dxf file in the given encoding
|
||||
* \param d device
|
||||
* \param codec encoding
|
||||
* @returns 0 on success, 1 on invalid device, 2 when devices is not writable
|
||||
* \returns 0 on success, 1 on invalid device, 2 when devices is not writable
|
||||
*/
|
||||
int writeToFile( QIODevice *d, const QString &codec ); //maybe add progress dialog? other parameters (e.g. scale, dpi)?
|
||||
|
||||
@ -84,14 +84,14 @@ class CORE_EXPORT QgsDxfExport
|
||||
|
||||
/**
|
||||
* Retrieve reference scale for output
|
||||
* @returns reference scale
|
||||
* \returns reference scale
|
||||
* @see setSymbologyScaleDenominator
|
||||
*/
|
||||
double symbologyScaleDenominator() const { return mSymbologyScaleDenominator; }
|
||||
|
||||
/**
|
||||
* Retrieve map units
|
||||
* @returns unit
|
||||
* \returns unit
|
||||
*/
|
||||
QgsUnitTypes::DistanceUnit mapUnits() const;
|
||||
|
||||
@ -117,7 +117,7 @@ class CORE_EXPORT QgsDxfExport
|
||||
|
||||
/**
|
||||
* Get symbology export mode
|
||||
* @returns mode
|
||||
* \returns mode
|
||||
* @see setSymbologyExport
|
||||
*/
|
||||
SymbologyExport symbologyExport() const { return mSymbologyExport; }
|
||||
@ -130,7 +130,7 @@ class CORE_EXPORT QgsDxfExport
|
||||
|
||||
/**
|
||||
* Get extent of area to export
|
||||
* @returns area to export
|
||||
* \returns area to export
|
||||
* @see setExtent
|
||||
*/
|
||||
QgsRectangle extent() const { return mExtent; }
|
||||
@ -145,7 +145,7 @@ class CORE_EXPORT QgsDxfExport
|
||||
|
||||
/**
|
||||
* Retrieve whether layer title (where set) instead of name shall be use
|
||||
* @returns flag
|
||||
* \returns flag
|
||||
* @see setLayerTitleAsName
|
||||
*/
|
||||
bool layerTitleAsName() { return mLayerTitleAsName; }
|
||||
@ -160,14 +160,14 @@ class CORE_EXPORT QgsDxfExport
|
||||
* Get layer name for feature
|
||||
* \param id layer id of layer
|
||||
* \param f feature of layer
|
||||
* @returns layer name for feature
|
||||
* \returns layer name for feature
|
||||
*/
|
||||
QString layerName( const QString &id, const QgsFeature &f ) const;
|
||||
|
||||
/**
|
||||
* Get name for layer respecting the use layer title as layer name mode
|
||||
* \param vl the vector layer
|
||||
* @returns name of layer
|
||||
* \returns name of layer
|
||||
* @see setLayerTitleAsName
|
||||
*/
|
||||
QString layerName( QgsVectorLayer *vl ) const;
|
||||
@ -242,7 +242,7 @@ class CORE_EXPORT QgsDxfExport
|
||||
* Write a tuple of group code and a handle
|
||||
* \param code group code to use
|
||||
* \param handle handle to use (0 generates a new handle)
|
||||
* @returns the used handle
|
||||
* \returns the used handle
|
||||
*/
|
||||
int writeHandle( int code = 5, int handle = 0 );
|
||||
|
||||
|
@ -44,7 +44,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
|
||||
|
||||
/** Creates a new QgsBlurEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsBlurEffect
|
||||
* \returns new QgsBlurEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -64,7 +64,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
|
||||
void setBlurLevel( const int level ) { mBlurLevel = level; }
|
||||
|
||||
/** Returns the blur level (strength)
|
||||
* @returns blur level. Depending on the current @link blurMethod @endlink, this parameter
|
||||
* \returns blur level. Depending on the current @link blurMethod @endlink, this parameter
|
||||
* has different effects
|
||||
* @see setBlurLevel
|
||||
* @see blurMethod
|
||||
@ -78,7 +78,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
|
||||
void setBlurMethod( const BlurMethod method ) { mBlurMethod = method; }
|
||||
|
||||
/** Returns the blur method (algorithm) used for performing the blur.
|
||||
* @returns blur method
|
||||
* \returns blur method
|
||||
* @see setBlurMethod
|
||||
*/
|
||||
BlurMethod blurMethod() const { return mBlurMethod; }
|
||||
@ -91,7 +91,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency
|
||||
*/
|
||||
@ -105,7 +105,7 @@ class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blend mode used for drawing the effect on to a destination
|
||||
* paint device
|
||||
* @see setBlendMode
|
||||
*/
|
||||
|
@ -38,7 +38,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
|
||||
/** Creates a new QgsColorEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsColorEffect
|
||||
* \returns new QgsColorEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -58,7 +58,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
void setBrightness( int brightness ) { mBrightness = qBound( -255, brightness, 255 ); }
|
||||
|
||||
/** Returns the brightness modification for the effect.
|
||||
* @returns brightness value. Values are between -255 and 255, where 0 represents
|
||||
* \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
|
||||
@ -74,7 +74,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
void setContrast( int contrast ) { mContrast = qBound( -100, contrast, 100 ); }
|
||||
|
||||
/** Returns the contrast modification for the effect.
|
||||
* @returns contrast value. Values are between -100 and 100, where 0 represents
|
||||
* \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
|
||||
@ -90,7 +90,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
void setSaturation( double saturation ) { mSaturation = saturation; }
|
||||
|
||||
/** Returns the saturation modification for the effect.
|
||||
* @returns saturation value. Values are between 0 and 2.0, where 1.0 represents
|
||||
* \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
|
||||
@ -104,7 +104,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
void setGrayscaleMode( QgsImageOperation::GrayscaleMode grayscaleMode ) { mGrayscaleMode = grayscaleMode; }
|
||||
|
||||
/** Returns whether the effect will convert a picture to grayscale.
|
||||
* @returns method for grayscale conversion
|
||||
* \returns method for grayscale conversion
|
||||
* @see setGrayscaleMode
|
||||
*/
|
||||
QgsImageOperation::GrayscaleMode grayscaleMode() const { return mGrayscaleMode; }
|
||||
@ -118,7 +118,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
void setColorizeOn( bool colorizeOn ) { mColorizeOn = colorizeOn; }
|
||||
|
||||
/** Returns whether the effect will colorize a picture.
|
||||
* @returns true if colorization is enableds
|
||||
* \returns true if colorization is enableds
|
||||
* @see setColorizeOn
|
||||
* @see colorizeColor
|
||||
* @see colorizeStrength
|
||||
@ -136,7 +136,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
|
||||
/** Returns the color used for colorizing a picture. This is only used if
|
||||
* @link colorizeOn @endlink is set to true.
|
||||
* @returns colorization color
|
||||
* \returns colorization color
|
||||
* @see setColorizeColor
|
||||
* @see colorizeOn
|
||||
* @see colorizeStrength
|
||||
@ -154,7 +154,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
|
||||
/** 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
|
||||
* \returns colorization strength, between 0 and 100
|
||||
* @see setColorizeStrengths
|
||||
* @see colorizeOn
|
||||
* @see colorizeColor
|
||||
@ -169,7 +169,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency
|
||||
*/
|
||||
@ -183,7 +183,7 @@ class CORE_EXPORT QgsColorEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blend mode used for drawing the effect on to a destination
|
||||
* paint device
|
||||
* @see setBlendMode
|
||||
*/
|
||||
|
@ -47,7 +47,7 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect
|
||||
/** Creates a new QgsEffectStack effect. This method ignores
|
||||
* the map parameter, and always returns an empty effect stack.
|
||||
* \param map unused encoded properties string map
|
||||
* @returns new QgsEffectStack
|
||||
* \returns new QgsEffectStack
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -57,7 +57,7 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect
|
||||
/** Creates a new QgsEffectStack effect from a single initial effect.
|
||||
* \param effect initial effect to add to the stack. The effect will
|
||||
* be cloned, so ownership is not transferred to the stack.
|
||||
* @returns new QgsEffectStack containing initial effect
|
||||
* \returns new QgsEffectStack containing initial effect
|
||||
*/
|
||||
explicit QgsEffectStack( const QgsPaintEffect &effect );
|
||||
|
||||
@ -105,18 +105,18 @@ class CORE_EXPORT QgsEffectStack : public QgsPaintEffect
|
||||
|
||||
/** Returns a pointer to the list of effects currently contained by
|
||||
* the stack
|
||||
* @returns list of QgsPaintEffects within the stack
|
||||
* \returns list of QgsPaintEffects within the stack
|
||||
*/
|
||||
QList< QgsPaintEffect * > *effectList();
|
||||
|
||||
/** Returns count of effects contained by the stack
|
||||
* @returns count of effects
|
||||
* \returns count of effects
|
||||
*/
|
||||
int count() const { return mEffectList.count(); }
|
||||
|
||||
/** Returns a pointer to the effect at a specified index within the stack
|
||||
* \param index position of effect to return
|
||||
* @returns QgsPaintEffect at specified position
|
||||
* \returns QgsPaintEffect at specified position
|
||||
*/
|
||||
QgsPaintEffect *effect( int index ) const;
|
||||
|
||||
|
@ -61,7 +61,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns spread distance. Units are retrieved via @link spreadUnit @endlink
|
||||
* @see setSpread
|
||||
* @see spreadUnit
|
||||
* @see spreadMapUnitScale
|
||||
@ -77,7 +77,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; }
|
||||
|
||||
/** Returns the units used for the glow spread distance.
|
||||
* @returns units for spread distance
|
||||
* \returns units for spread distance
|
||||
* @see setSpreadUnit
|
||||
* @see spread
|
||||
* @see spreadMapUnitScale
|
||||
@ -93,7 +93,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
void setSpreadMapUnitScale( const QgsMapUnitScale &scale ) { mSpreadMapUnitScale = scale; }
|
||||
|
||||
/** Returns the map unit scale used for the spread distance.
|
||||
* @returns map unit scale for spread distance
|
||||
* \returns map unit scale for spread distance
|
||||
* @see setSpreadMapUnitScale
|
||||
* @see spread
|
||||
* @see spreadUnit
|
||||
@ -109,7 +109,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blur level. Value will be between 0 and 16, with larger
|
||||
* values indicating greater blur strength.
|
||||
* @see setBlurLevel
|
||||
*/
|
||||
@ -123,7 +123,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency
|
||||
*/
|
||||
@ -141,7 +141,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
/** Returns the color for the glow. This only applies if the @link colorType @endlink
|
||||
* is set to SingleColor. The glow will fade between the specified color and
|
||||
* a totally transparent version of the color.
|
||||
* @returns glow color
|
||||
* \returns glow color
|
||||
* @see setColor
|
||||
* @see colorType
|
||||
*/
|
||||
@ -157,7 +157,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
|
||||
/** 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
|
||||
* \returns color ramp for glow
|
||||
* @see setRamp
|
||||
* @see colorType
|
||||
*/
|
||||
@ -171,7 +171,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blend mode used for drawing the effect on to a destination
|
||||
* paint device
|
||||
* @see setBlendMode
|
||||
*/
|
||||
@ -189,7 +189,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
|
||||
/** 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
|
||||
* \returns current color mode used for the glow
|
||||
* @see setColorType
|
||||
* @see color
|
||||
* @see ramp
|
||||
@ -205,7 +205,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
|
||||
|
||||
/** Specifies whether the glow is drawn outside the picture or within
|
||||
* the picture.
|
||||
* @returns true if glow is to be drawn outside the picture, or false
|
||||
* \returns true if glow is to be drawn outside the picture, or false
|
||||
* to draw glow within the picture
|
||||
*/
|
||||
virtual bool shadeExterior() const = 0;
|
||||
@ -237,7 +237,7 @@ class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
|
||||
|
||||
/** Creates a new QgsOuterGlowEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsOuterGlowEffect
|
||||
* \returns new QgsOuterGlowEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -267,7 +267,7 @@ class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect
|
||||
|
||||
/** Creates a new QgsInnerGlowEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsInnerGlowEffect
|
||||
* \returns new QgsInnerGlowEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
|
@ -156,7 +156,7 @@ class CORE_EXPORT QgsImageOperation
|
||||
* quality blur.
|
||||
* \param image QImage to blur
|
||||
* \param radius blur radius in pixels
|
||||
* @returns blurred image
|
||||
* \returns blurred image
|
||||
* \note for fastest operation, ensure the source image is ARGB32_Premultiplied
|
||||
*/
|
||||
static QImage *gaussianBlur( QImage &image, const int radius );
|
||||
|
@ -69,18 +69,18 @@ class CORE_EXPORT QgsPaintEffect
|
||||
virtual ~QgsPaintEffect();
|
||||
|
||||
/** Returns the effect type.
|
||||
* @returns unique string representation of the effect type
|
||||
* \returns unique string representation of the effect type
|
||||
*/
|
||||
virtual QString type() const = 0;
|
||||
|
||||
/** Duplicates an effect by creating a deep copy of the effect
|
||||
* @returns clone of paint effect
|
||||
* \returns clone of paint effect
|
||||
*/
|
||||
virtual QgsPaintEffect *clone() const = 0;
|
||||
|
||||
/** Returns the properties describing the paint effect encoded in a
|
||||
* string format.
|
||||
* @returns string map of properties, in the form property key, value
|
||||
* \returns string map of properties, in the form property key, value
|
||||
* @see readProperties
|
||||
* @see saveProperties
|
||||
*/
|
||||
@ -98,14 +98,14 @@ class CORE_EXPORT QgsPaintEffect
|
||||
* @link properties @endlink.
|
||||
* \param doc destination DOM document
|
||||
* \param element destination DOM element
|
||||
* @returns true if save was successful
|
||||
* \returns true if save was successful
|
||||
* @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
|
||||
* \returns true if read was successful
|
||||
* @see saveProperties
|
||||
*/
|
||||
virtual bool readProperties( const QDomElement &element );
|
||||
@ -134,7 +134,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
virtual void end( QgsRenderContext &context );
|
||||
|
||||
/** Returns whether the effect is enabled
|
||||
* @returns true if effect is enabled
|
||||
* \returns true if effect is enabled
|
||||
* @see setEnabled
|
||||
*/
|
||||
bool enabled() const { return mEnabled; }
|
||||
@ -147,7 +147,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
|
||||
/** 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
|
||||
* \returns draw mode for effect
|
||||
* @see setDrawMode
|
||||
*/
|
||||
DrawMode drawMode() const { return mDrawMode; }
|
||||
@ -183,7 +183,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
|
||||
/** Returns the source QPicture. The @link draw @endlink member can utilize this when
|
||||
* drawing the effect.
|
||||
* @returns source QPicture
|
||||
* \returns source QPicture
|
||||
* @see drawSource
|
||||
* @see sourceAsImage
|
||||
*/
|
||||
@ -193,7 +193,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
* utilize this when drawing the effect. The image will be padded or cropped from the original
|
||||
* 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
|
||||
* \returns source QPicture rendered to an image
|
||||
* @see drawSource
|
||||
* @see source
|
||||
* @see imageOffset
|
||||
@ -204,7 +204,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
/** Returns the offset which should be used when drawing the source image on to a destination
|
||||
* render context.
|
||||
* \param context destination render context
|
||||
* @returns point offset for image top left corner
|
||||
* \returns point offset for image top left corner
|
||||
* @see sourceAsImage
|
||||
*/
|
||||
QPointF imageOffset( const QgsRenderContext &context ) const;
|
||||
@ -214,7 +214,7 @@ class CORE_EXPORT QgsPaintEffect
|
||||
* effects.
|
||||
* \param rect original source bounding rect
|
||||
* \param context destination render context
|
||||
* @returns modified bounding rect
|
||||
* \returns modified bounding rect
|
||||
* @see sourceAsImage
|
||||
*/
|
||||
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
|
||||
@ -262,7 +262,7 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
|
||||
|
||||
/** Creates a new QgsDrawSource effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsDrawSourceEffect
|
||||
* \returns new QgsDrawSourceEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -279,7 +279,7 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency
|
||||
*/
|
||||
@ -293,7 +293,7 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blend mode used for drawing the source on to a destination
|
||||
* paint device
|
||||
* @see setBlendMode
|
||||
*/
|
||||
|
@ -47,26 +47,26 @@ class CORE_EXPORT QgsPaintEffectAbstractMetadata
|
||||
virtual ~QgsPaintEffectAbstractMetadata() = default;
|
||||
|
||||
/** Returns the unique string representing the paint effect class
|
||||
* @returns unique string
|
||||
* \returns unique string
|
||||
* @see visibleName
|
||||
*/
|
||||
QString name() const { return mName; }
|
||||
|
||||
/** Returns the user visible string representing the paint effect class
|
||||
* @returns friendly user visible string
|
||||
* \returns friendly user visible string
|
||||
* @see name
|
||||
*/
|
||||
QString visibleName() const { return mVisibleName; }
|
||||
|
||||
/** Create a paint effect of this class given an encoded map of properties.
|
||||
* \param map properties string map
|
||||
* @returns new paint effect
|
||||
* \returns new paint effect
|
||||
*/
|
||||
virtual QgsPaintEffect *createPaintEffect( const QgsStringMap &map ) = 0;
|
||||
|
||||
/** Create configuration widget for paint effect of this class. Can return nullptr
|
||||
* if there's no GUI for the paint effect class.
|
||||
* @returns configuration widget
|
||||
* \returns configuration widget
|
||||
*/
|
||||
virtual QgsPaintEffectWidget *createWidget() { return nullptr; }
|
||||
|
||||
@ -106,13 +106,13 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
|
||||
{}
|
||||
|
||||
/** Returns the paint effect creation function for the paint effect class
|
||||
* @returns creation function
|
||||
* \returns creation function
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
QgsPaintEffectCreateFunc createFunction() const { return mCreateFunc; }
|
||||
|
||||
/** Returns the paint effect properties widget creation function for the paint effect class
|
||||
* @returns widget creation function
|
||||
* \returns widget creation function
|
||||
* \note not available in Python bindings
|
||||
* @see setWidgetFunction
|
||||
*/
|
||||
@ -127,14 +127,14 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
|
||||
|
||||
/** Creates a new paint effect of the metadata's effect class
|
||||
* \param map string map of effect properties
|
||||
* @returns new paint effect
|
||||
* \returns new paint effect
|
||||
* \note not available in Python bindings
|
||||
* @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
|
||||
* \returns effect properties widget
|
||||
* \note not available in Python bindings
|
||||
* @see createWidget
|
||||
*/
|
||||
@ -169,20 +169,20 @@ class CORE_EXPORT QgsPaintEffectRegistry
|
||||
|
||||
/** Returns the metadata for a specific effect.
|
||||
* \param name unique string name for paint effect class
|
||||
* @returns paint effect metadata if found, otherwise nullptr
|
||||
* \returns paint effect metadata if found, otherwise nullptr
|
||||
*/
|
||||
QgsPaintEffectAbstractMetadata *effectMetadata( const QString &name ) const;
|
||||
|
||||
/** Registers a new effect type.
|
||||
* \param metadata effect metadata. Ownership is transferred to the registry.
|
||||
* @returns true if add was successful.
|
||||
* \returns true if add was successful.
|
||||
*/
|
||||
bool addEffectType( QgsPaintEffectAbstractMetadata *metadata );
|
||||
|
||||
/** Creates a new paint effect given the effect name and properties map.
|
||||
* \param name unique name representing paint effect class
|
||||
* \param properties encoded string map of effect properties
|
||||
* @returns new paint effect of specified class, or nullptr if matching
|
||||
* \returns new paint effect of specified class, or nullptr if matching
|
||||
* paint effect could not be created
|
||||
*/
|
||||
QgsPaintEffect *createEffect( const QString &name, const QgsStringMap &properties = QgsStringMap() ) const;
|
||||
@ -190,27 +190,27 @@ class CORE_EXPORT QgsPaintEffectRegistry
|
||||
/** Creates a new paint effect given a DOM element storing paint effect
|
||||
* properties.
|
||||
* \param element encoded DOM element of effect properties
|
||||
* @returns new paint effect, or nullptr if matching
|
||||
* \returns new paint effect, or nullptr if matching
|
||||
* paint effect could not be created
|
||||
*/
|
||||
QgsPaintEffect *createEffect( const QDomElement &element ) const;
|
||||
|
||||
/** Returns a list of known paint effects.
|
||||
* @returns list of paint effect names
|
||||
* \returns list of paint effect names
|
||||
*/
|
||||
QStringList effects() const;
|
||||
|
||||
/** Returns a new effect stack consisting of a sensible selection of default
|
||||
* 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
|
||||
* \returns default effects stack
|
||||
* @see isDefaultStack()
|
||||
*/
|
||||
static QgsPaintEffect *defaultStack();
|
||||
|
||||
/** Tests whether a paint effect matches the default effects stack.
|
||||
* \param effect paint effect to test
|
||||
* @returns true if effect is default stack
|
||||
* \returns true if effect is default stack
|
||||
* \since QGIS 2.12
|
||||
* @see defaultStack()
|
||||
*/
|
||||
|
@ -48,7 +48,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blur level. Value will be between 0 and 16, with larger
|
||||
* values indicating greater blur strength.
|
||||
* @see setBlurLevel
|
||||
*/
|
||||
@ -62,7 +62,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
void setOffsetAngle( const int angle ) { mOffsetAngle = angle; }
|
||||
|
||||
/** Returns the angle used for offsetting the shadow.
|
||||
* @returns offset angle in degrees clockwise from North
|
||||
* \returns offset angle in degrees clockwise from North
|
||||
* @see setOffsetAngle
|
||||
* @see offsetDistance
|
||||
*/
|
||||
@ -77,7 +77,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns offset distance. Distance units are retrieved via @link offsetUnit @endlink
|
||||
* @see setOffsetDistance
|
||||
* @see offsetUnit
|
||||
* @see offsetMapUnitScale
|
||||
@ -93,7 +93,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
void setOffsetUnit( const QgsUnitTypes::RenderUnit unit ) { mOffsetUnit = unit; }
|
||||
|
||||
/** Returns the units used for the shadow offset distance.
|
||||
* @returns units for offset distance
|
||||
* \returns units for offset distance
|
||||
* @see setOffsetUnit
|
||||
* @see offsetDistance
|
||||
* @see offsetMapUnitScale
|
||||
@ -109,7 +109,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns map unit scale for offset distance
|
||||
* @see setOffsetMapUnitScale
|
||||
* @see offsetDistance
|
||||
* @see offsetUnit
|
||||
@ -123,7 +123,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
void setColor( const QColor &color ) { mColor = color; }
|
||||
|
||||
/** Returns the color used for the shadow.
|
||||
* @returns shadow color
|
||||
* \returns shadow color
|
||||
* @see setColor
|
||||
*/
|
||||
QColor color() const { return mColor; }
|
||||
@ -136,7 +136,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns transparency value between 0 and 1 inclusive, where 0 is fully opaque
|
||||
* and 1 is fully transparent
|
||||
* @see setTransparency
|
||||
*/
|
||||
@ -150,7 +150,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
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
|
||||
* \returns blend mode used for drawing the effect on to a destination
|
||||
* paint device
|
||||
* @see setBlendMode
|
||||
*/
|
||||
@ -163,7 +163,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
|
||||
|
||||
/** Specifies whether the shadow is drawn outside the picture or within
|
||||
* the picture.
|
||||
* @returns true if shadow is to be drawn outside the picture, or false
|
||||
* \returns true if shadow is to be drawn outside the picture, or false
|
||||
* to draw shadow within the picture
|
||||
*/
|
||||
virtual bool exteriorShadow() const = 0;
|
||||
@ -193,7 +193,7 @@ class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect
|
||||
|
||||
/** Creates a new QgsDropShadowEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsDropShadowEffect
|
||||
* \returns new QgsDropShadowEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -222,7 +222,7 @@ class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect
|
||||
|
||||
/** Creates a new QgsInnerShadowEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsInnerShadowEffect
|
||||
* \returns new QgsInnerShadowEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
|
@ -39,7 +39,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
|
||||
/** Creates a new QgsTransformEffect effect from a properties string map.
|
||||
* \param map encoded properties string map
|
||||
* @returns new QgsTransformEffect
|
||||
* \returns new QgsTransformEffect
|
||||
*/
|
||||
static QgsPaintEffect *create( const QgsStringMap &map );
|
||||
|
||||
@ -60,7 +60,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setTranslateX( const double translateX ) { mTranslateX = translateX; }
|
||||
|
||||
/** Returns the transform x translation.
|
||||
* @returns X distance translated along the x axis
|
||||
* \returns X distance translated along the x axis
|
||||
* @see setTranslateX
|
||||
* @see translateY
|
||||
* @see translateUnit
|
||||
@ -78,7 +78,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setTranslateY( const double translateY ) { mTranslateY = translateY; }
|
||||
|
||||
/** Returns the transform y translation.
|
||||
* @returns Y distance translated along the y axis
|
||||
* \returns Y distance translated along the y axis
|
||||
* @see setTranslateY
|
||||
* @see translateX
|
||||
* @see translateUnit
|
||||
@ -96,7 +96,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setTranslateUnit( const QgsUnitTypes::RenderUnit unit ) { mTranslateUnit = unit; }
|
||||
|
||||
/** Returns the units used for the transform translation.
|
||||
* @returns units for translation
|
||||
* \returns units for translation
|
||||
* @see setTranslateUnit
|
||||
* @see translateX
|
||||
* @see translateY
|
||||
@ -114,7 +114,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setTranslateMapUnitScale( const QgsMapUnitScale &scale ) { mTranslateMapUnitScale = scale; }
|
||||
|
||||
/** Returns the map unit scale used for the transform translation.
|
||||
* @returns map unit scale for translation
|
||||
* \returns map unit scale for translation
|
||||
* @see setTranslateMapUnitScale
|
||||
* @see translateX
|
||||
* @see translateY
|
||||
@ -130,7 +130,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setScaleX( const double scaleX ) { mScaleX = scaleX; }
|
||||
|
||||
/** Returns the x axis scaling factor.
|
||||
* @returns x axis scaling factor, where 1.0 = no scaling
|
||||
* \returns x axis scaling factor, where 1.0 = no scaling
|
||||
* @see setScaleX
|
||||
* @see scaleY
|
||||
*/
|
||||
@ -143,7 +143,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setScaleY( const double scaleY ) { mScaleY = scaleY; }
|
||||
|
||||
/** Returns the y axis scaling factor.
|
||||
* @returns y axis scaling factor, where 1.0 = no scaling
|
||||
* \returns y axis scaling factor, where 1.0 = no scaling
|
||||
* @see setScaleY
|
||||
* @see scaleX
|
||||
*/
|
||||
@ -156,7 +156,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setRotation( const double rotation ) { mRotation = rotation; }
|
||||
|
||||
/** Returns the transform rotation.
|
||||
* @returns rotation in degrees clockwise
|
||||
* \returns rotation in degrees clockwise
|
||||
* @see setRotation
|
||||
*/
|
||||
double rotation() const { return mRotation; }
|
||||
@ -169,7 +169,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setShearX( const double shearX ) { mShearX = shearX; }
|
||||
|
||||
/** Returns the x axis shearing factor.
|
||||
* @returns x axis shearing
|
||||
* \returns x axis shearing
|
||||
* @see setShearX
|
||||
* @see shearY
|
||||
*/
|
||||
@ -183,7 +183,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setShearY( const double shearY ) { mShearY = shearY; }
|
||||
|
||||
/** Returns the y axis shearing factor.
|
||||
* @returns y axis shearing
|
||||
* \returns y axis shearing
|
||||
* @see setShearY
|
||||
* @see shearX
|
||||
*/
|
||||
@ -197,7 +197,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setReflectX( const bool reflectX ) { mReflectX = reflectX; }
|
||||
|
||||
/** Returns whether transform will be reflected along the x-axis
|
||||
* @returns true if transform will reflect horizontally
|
||||
* \returns true if transform will reflect horizontally
|
||||
* @see setReflectX
|
||||
* @see reflectY
|
||||
*/
|
||||
@ -211,7 +211,7 @@ class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect
|
||||
void setReflectY( const bool reflectY ) { mReflectY = reflectY; }
|
||||
|
||||
/** Returns whether transform will be reflected along the y-axis
|
||||
* @returns true if transform will reflect horizontally
|
||||
* \returns true if transform will reflect horizontally
|
||||
* @see setReflectY
|
||||
* @see reflectX
|
||||
*/
|
||||
|
@ -118,7 +118,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
|
||||
/** Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
|
||||
* For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
|
||||
* @returns boundary for geometry. May be null for some geometry types.
|
||||
* \returns boundary for geometry. May be null for some geometry types.
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
virtual QgsAbstractGeometry *boundary() const = 0;
|
||||
@ -219,12 +219,12 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
* \param id initial value should be the starting vertex id. The next vertex id will be stored
|
||||
* in this variable if found.
|
||||
* \param vertex container for found node
|
||||
* @return false if at end
|
||||
* \return false if at end
|
||||
*/
|
||||
virtual bool nextVertex( QgsVertexId &id, QgsPointV2 &vertex ) const = 0;
|
||||
|
||||
/** Retrieves the sequence of geometries, rings and nodes.
|
||||
* @return coordinate sequence
|
||||
* \return coordinate sequence
|
||||
*/
|
||||
virtual QgsCoordinateSequence coordinateSequence() const = 0;
|
||||
|
||||
@ -243,7 +243,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
* \param leftOf returns whether the point lies on the left side of the nearest segment (true if point is to left of segment,
|
||||
* false if point is to right of segment)
|
||||
* \param epsilon epsilon for segment snapping
|
||||
* @returns squared distance to closest segment or negative value on error
|
||||
* \returns squared distance to closest segment or negative value on error
|
||||
*/
|
||||
virtual double closestSegment( const QgsPointV2 &pt, QgsPointV2 &segmentPt, QgsVertexId &vertexAfter, bool *leftOf, double epsilon ) const = 0;
|
||||
|
||||
@ -252,7 +252,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
/** Inserts a vertex into the geometry
|
||||
* \param position vertex id for position of inserted vertex
|
||||
* \param vertex vertex to insert
|
||||
* @returns true if insert was successful
|
||||
* \returns true if insert was successful
|
||||
* @see moveVertex
|
||||
* @see deleteVertex
|
||||
*/
|
||||
@ -261,7 +261,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
/** Moves a vertex within the geometry
|
||||
* \param position vertex id for vertex to move
|
||||
* \param newPos new position of vertex
|
||||
* @returns true if move was successful
|
||||
* \returns true if move was successful
|
||||
* @see insertVertex
|
||||
* @see deleteVertex
|
||||
*/
|
||||
@ -269,7 +269,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
|
||||
/** Deletes a vertex within the geometry
|
||||
* \param position vertex id for vertex to delete
|
||||
* @returns true if delete was successful
|
||||
* \returns true if delete was successful
|
||||
* @see insertVertex
|
||||
* @see moveVertex
|
||||
*/
|
||||
@ -314,14 +314,14 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
/** Returns the geometry converted to the more generic curve type.
|
||||
E.g. QgsLineString -> QgsCompoundCurve, QgsPolygonV2 -> QgsCurvePolygon,
|
||||
QgsMultiLineString -> QgsMultiCurve, QgsMultiPolygonV2 -> QgsMultiSurface
|
||||
@return the converted geometry. Caller takes ownership*/
|
||||
\return the converted geometry. Caller takes ownership*/
|
||||
virtual QgsAbstractGeometry *toCurveType() const { return 0; }
|
||||
|
||||
/** Returns approximate angle at a vertex. This is usually the average angle between adjacent
|
||||
* segments, and can be pictured as the orientation of a line following the curvature of the
|
||||
* geometry at the specified vertex.
|
||||
* \param vertex the vertex id
|
||||
* @return rotation in radians, clockwise from north
|
||||
* \return rotation in radians, clockwise from north
|
||||
*/
|
||||
virtual double vertexAngle( QgsVertexId vertex ) const = 0;
|
||||
|
||||
@ -343,7 +343,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
|
||||
/** Adds a z-dimension to the geometry, initialized to a preset value.
|
||||
* \param zValue initial z-value for all nodes
|
||||
* @returns true on success
|
||||
* \returns true on success
|
||||
* \since QGIS 2.12
|
||||
* @see dropZValue()
|
||||
* @see addMValue()
|
||||
@ -352,7 +352,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
|
||||
/** Adds a measure to the geometry, initialized to a preset value.
|
||||
* \param mValue initial m-value for all nodes
|
||||
* @returns true on success
|
||||
* \returns true on success
|
||||
* \since QGIS 2.12
|
||||
* @see dropMValue()
|
||||
* @see addZValue()
|
||||
@ -360,7 +360,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
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
|
||||
* \returns true if Z values were present and have been removed
|
||||
* @see addZValue()
|
||||
* @see dropMValue()
|
||||
* \since QGIS 2.14
|
||||
@ -368,7 +368,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
virtual bool dropZValue() = 0;
|
||||
|
||||
/** Drops any measure values which exist in the geometry.
|
||||
* @returns true if m-values were present and have been removed
|
||||
* \returns true if m-values were present and have been removed
|
||||
* @see addMValue()
|
||||
* @see dropZValue()
|
||||
* \since QGIS 2.14
|
||||
@ -376,7 +376,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
virtual bool dropMValue() = 0;
|
||||
|
||||
/** Converts the geometry to a specified type.
|
||||
* @returns true if conversion was successful
|
||||
* \returns true if conversion was successful
|
||||
* \since QGIS 2.14
|
||||
*/
|
||||
virtual bool convertTo( QgsWkbTypes::Type type );
|
||||
|
@ -121,7 +121,7 @@ class CORE_EXPORT QgsCircularString: public QgsCurve
|
||||
|
||||
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
|
||||
\param vertex the vertex id
|
||||
@return rotation in radians, clockwise from north*/
|
||||
\return rotation in radians, clockwise from north*/
|
||||
double vertexAngle( QgsVertexId vertex ) const override;
|
||||
|
||||
virtual QgsCircularString *reversed() const override;
|
||||
|
@ -110,7 +110,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
|
||||
|
||||
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
|
||||
\param vertex the vertex id
|
||||
@return rotation in radians, clockwise from north*/
|
||||
\return rotation in radians, clockwise from north*/
|
||||
double vertexAngle( QgsVertexId vertex ) const override;
|
||||
|
||||
virtual QgsCompoundCurve *reversed() const override;
|
||||
@ -132,7 +132,7 @@ class CORE_EXPORT QgsCompoundCurve: public QgsCurve
|
||||
QList< QgsCurve * > mCurves;
|
||||
|
||||
/** Turns a vertex id for the compound curve into one or more ids for the subcurves
|
||||
@return the index of the subcurve or -1 in case of error*/
|
||||
\return the index of the subcurve or -1 in case of error*/
|
||||
QList< QPair<int, QgsVertexId> > curveVertexId( QgsVertexId id ) const;
|
||||
|
||||
};
|
||||
|
@ -92,7 +92,7 @@ class CORE_EXPORT QgsCurve: public QgsAbstractGeometry
|
||||
* \param node node number, where the first node is 0
|
||||
* \param point will be set to point at corresponding node in the curve
|
||||
* \param type will be set to the vertex type of the node
|
||||
* @returns true if node exists within the curve
|
||||
* \returns true if node exists within the curve
|
||||
*/
|
||||
virtual bool pointAt( int node, QgsPointV2 &point, QgsVertexId::VertexType &type ) const = 0;
|
||||
|
||||
@ -117,14 +117,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
|
||||
* \returns x-coordinate of node, or 0.0 if index is out of bounds
|
||||
* @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
|
||||
* \returns y-coordinate of node, or 0.0 if index is out of bounds
|
||||
* @see setYAt()
|
||||
*/
|
||||
virtual double yAt( int index ) const = 0;
|
||||
|
@ -123,7 +123,7 @@ class CORE_EXPORT QgsCurvePolygon: public QgsSurface
|
||||
|
||||
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
|
||||
* \param vertex the vertex id
|
||||
* @return rotation in radians, clockwise from north
|
||||
* \return rotation in radians, clockwise from north
|
||||
*/
|
||||
double vertexAngle( QgsVertexId vertex ) const override;
|
||||
|
||||
|
@ -224,7 +224,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* \param afterVertex will be set to the vertex index of the next vertex after the closest one. Will be set to -1 if
|
||||
* not present.
|
||||
* \param sqrDist will be set to the square distance between the closest vertex and the specified point
|
||||
* @returns closest point in geometry. If not found (empty geometry), returns null point nad sqrDist is negative.
|
||||
* \returns closest point in geometry. If not found (empty geometry), returns null point nad sqrDist is negative.
|
||||
*/
|
||||
//TODO QGIS 3.0 - rename beforeVertex to previousVertex, afterVertex to nextVertex
|
||||
QgsPoint closestVertex( const QgsPoint &point, int &atVertex, int &beforeVertex, int &afterVertex, double &sqrDist ) const;
|
||||
@ -232,7 +232,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/**
|
||||
* Returns the distance along this geometry from its first vertex to the specified vertex.
|
||||
* \param vertex vertex index to calculate distance to
|
||||
* @returns distance to vertex (following geometry), or -1 for invalid vertex numbers
|
||||
* \returns distance to vertex (following geometry), or -1 for invalid vertex numbers
|
||||
* \since QGIS 2.16
|
||||
*/
|
||||
double distanceToVertex( int vertex ) const;
|
||||
@ -240,7 +240,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/**
|
||||
* Returns the bisector angle for this geometry at the specified vertex.
|
||||
* \param vertex vertex index to calculate bisector angle at
|
||||
* @returns bisector angle, in radians clockwise from north
|
||||
* \returns bisector angle, in radians clockwise from north
|
||||
* \since QGIS 3.0
|
||||
* @see interpolateAngle()
|
||||
*/
|
||||
@ -317,7 +317,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/**
|
||||
* Returns coordinates of a vertex.
|
||||
* \param atVertex index of the vertex
|
||||
* @return Coordinates of the vertex or QgsPoint(0,0) on error
|
||||
* \return Coordinates of the vertex or QgsPoint(0,0) on error
|
||||
*/
|
||||
QgsPoint vertexAt( int atVertex ) const;
|
||||
|
||||
@ -344,7 +344,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* Searches for the closest vertex in this geometry to the given point.
|
||||
* \param point Specifiest the point for search
|
||||
* \param atVertex Receives index of the closest vertex
|
||||
* @return The squared cartesian distance is also returned in sqrDist, negative number on error
|
||||
* \return The squared cartesian distance is also returned in sqrDist, negative number on error
|
||||
*/
|
||||
double closestVertexWithContext( const QgsPoint &point, int &atVertex ) const;
|
||||
|
||||
@ -356,18 +356,18 @@ class CORE_EXPORT QgsGeometry
|
||||
* before the closest segment is always afterVertex - 1
|
||||
* \param leftOf Out: Returns if the point lies on the left of right side of the segment ( < 0 means left, > 0 means right )
|
||||
* \param epsilon epsilon for segment snapping (added in 1.8)
|
||||
* @return The squared cartesian distance is also returned in sqrDist, negative number on error
|
||||
* \return The squared cartesian distance is also returned in sqrDist, negative number on error
|
||||
*/
|
||||
double closestSegmentWithContext( const QgsPoint &point, QgsPoint &minDistPoint, int &afterVertex, double *leftOf = nullptr, double epsilon = DEFAULT_SEGMENT_EPSILON ) const;
|
||||
|
||||
/** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
|
||||
@return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
int addRing( const QList<QgsPoint> &ring );
|
||||
|
||||
/** Adds a new ring to this geometry. This makes only sense for polygon and multipolygons.
|
||||
@return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
int addRing( QgsCurve *ring );
|
||||
@ -375,7 +375,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/** Adds a new part to a the geometry.
|
||||
* \param points points describing part to add
|
||||
* \param geomType default geometry type to create if no existing geometry
|
||||
* @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* not disjoint with existing polygons of the feature
|
||||
*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
@ -384,7 +384,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/** Adds a new part to a the geometry.
|
||||
* \param points points describing part to add
|
||||
* \param geomType default geometry type to create if no existing geometry
|
||||
* @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* not disjoint with existing polygons of the feature
|
||||
*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
@ -393,7 +393,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/** Adds a new part to this geometry.
|
||||
* \param part part to add (ownership is transferred)
|
||||
* \param geomType default geometry type to create if no existing geometry
|
||||
* @returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* \returns 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* not disjoint with existing polygons of the feature
|
||||
*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
@ -401,7 +401,7 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Adds a new island polygon to a multipolygon feature
|
||||
* \param newPart part to add. Ownership is NOT transferred.
|
||||
* @return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* \return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
* not disjoint with existing polygons of the feature
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
@ -409,7 +409,7 @@ class CORE_EXPORT QgsGeometry
|
||||
int addPart( GEOSGeometry *newPart );
|
||||
|
||||
/** Adds a new island polygon to a multipolygon feature
|
||||
@return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
\return 0 in case of success, 1 if not a multipolygon, 2 if ring is not a valid geometry, 3 if new polygon ring
|
||||
not disjoint with existing polygons of the feature
|
||||
\note available in Python bindings as addPartGeometry
|
||||
\since QGIS 2.2
|
||||
@ -426,23 +426,23 @@ class CORE_EXPORT QgsGeometry
|
||||
QgsGeometry removeInteriorRings( double minimumAllowedArea = -1 ) const;
|
||||
|
||||
/** Translate this geometry by dx, dy
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int translate( double dx, double dy );
|
||||
|
||||
/** Transform this geometry as described by CoordinateTransform ct
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int transform( const QgsCoordinateTransform &ct );
|
||||
|
||||
/** Transform this geometry as described by QTransform ct
|
||||
\since QGIS 2.8
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int transform( const QTransform &ct );
|
||||
|
||||
/** Rotate this geometry around the Z axis
|
||||
\since QGIS 2.8
|
||||
\param rotation clockwise rotation in degrees
|
||||
\param center rotation center
|
||||
@return 0 in case of success*/
|
||||
\return 0 in case of success*/
|
||||
int rotate( double rotation, const QgsPoint ¢er );
|
||||
|
||||
/** Splits this geometry according to a given line.
|
||||
@ -450,7 +450,7 @@ class CORE_EXPORT QgsGeometry
|
||||
\param[out] newGeometries list of new geometries that have been created with the split
|
||||
\param topological true if topological editing is enabled
|
||||
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
|
||||
@return 0 in case of success, 1 if geometry has not been split, error else*/
|
||||
\return 0 in case of success, 1 if geometry has not been split, error else*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
int splitGeometry( const QList<QgsPoint> &splitLine,
|
||||
QList<QgsGeometry> &newGeometries,
|
||||
@ -458,21 +458,21 @@ class CORE_EXPORT QgsGeometry
|
||||
QList<QgsPoint> &topologyTestPoints );
|
||||
|
||||
/** Replaces a part of this geometry with another line
|
||||
* @return 0 in case of success
|
||||
* \return 0 in case of success
|
||||
* \since QGIS 1.3
|
||||
*/
|
||||
int reshapeGeometry( const QList<QgsPoint> &reshapeWithLine );
|
||||
|
||||
/** Changes this geometry such that it does not intersect the other geometry
|
||||
* \param other geometry that should not be intersect
|
||||
* @return 0 in case of success
|
||||
* \return 0 in case of success
|
||||
*/
|
||||
int makeDifference( const QgsGeometry *other );
|
||||
|
||||
/** Returns the geometry formed by modifying this geometry such that it does not
|
||||
* intersect the other geometry.
|
||||
* \param other geometry that should not be intersect
|
||||
* @return difference geometry, or empty geometry if difference could not be calculated
|
||||
* \return difference geometry, or empty geometry if difference could not be calculated
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
QgsGeometry makeDifference( const QgsGeometry &other ) const;
|
||||
@ -593,7 +593,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* \param side side of geometry to buffer
|
||||
* \param joinStyle join style for corners
|
||||
* \param mitreLimit limit on the mitre ratio used for very sharp corners
|
||||
* @return buffered geometry, or an empty geometry if buffer could not be
|
||||
* \return buffered geometry, or an empty geometry if buffer could not be
|
||||
* calculated
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
@ -714,7 +714,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* how far along this linestring you need to traverse to get to the closest location
|
||||
* where this linestring comes to the specified point.
|
||||
* \param point point to seek proximity to
|
||||
* @return distance along line, or -1 on error
|
||||
* \return distance along line, or -1 on error
|
||||
* \note only valid for linestring geometries
|
||||
* @see interpolate()
|
||||
* \since QGIS 3.0
|
||||
@ -742,7 +742,7 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Merges any connected lines in a LineString/MultiLineString geometry and
|
||||
* converts them to single line strings.
|
||||
* @returns a LineString or MultiLineString geometry, with any connected lines
|
||||
* \returns a LineString or MultiLineString geometry, with any connected lines
|
||||
* joined. An empty geometry will be returned if the input geometry was not a
|
||||
* MultiLineString geometry.
|
||||
* \since QGIS 3.0
|
||||
@ -765,12 +765,12 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Exports the geometry to WKT
|
||||
* \note precision parameter added in QGIS 2.4
|
||||
* @return true in case of success and false else
|
||||
* \return true in case of success and false else
|
||||
*/
|
||||
QString exportToWkt( int precision = 17 ) const;
|
||||
|
||||
/** Exports the geometry to GeoJSON
|
||||
* @return a QString representing the geometry as GeoJSON
|
||||
* \return a QString representing the geometry as GeoJSON
|
||||
* \since QGIS 1.8
|
||||
* \note Available in Python bindings since QGIS 1.9
|
||||
* \note precision parameter added in QGIS 2.4
|
||||
@ -780,7 +780,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/** Try to convert the geometry to the requested type
|
||||
* \param destType the geometry type to be converted to
|
||||
* \param destMultipart determines if the output geometry will be multipart or not
|
||||
* @return the converted geometry or nullptr if the conversion fails.
|
||||
* \return the converted geometry or nullptr if the conversion fails.
|
||||
* \since QGIS 2.2
|
||||
*/
|
||||
QgsGeometry convertToType( QgsWkbTypes::GeometryType destType, bool destMultipart = false ) const;
|
||||
@ -833,12 +833,12 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Delete a ring in polygon or multipolygon.
|
||||
Ring 0 is outer ring and can't be deleted.
|
||||
@return true on success
|
||||
\return true on success
|
||||
\since QGIS 1.2 */
|
||||
bool deleteRing( int ringNum, int partNum = 0 );
|
||||
|
||||
/** Delete part identified by the part number
|
||||
@return true on success
|
||||
\return true on success
|
||||
\since QGIS 1.2 */
|
||||
bool deletePart( int partNum );
|
||||
|
||||
@ -848,7 +848,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* If it is already a multipart geometry, it will return true and
|
||||
* not change the geometry.
|
||||
*
|
||||
* @return true in case of success and false else
|
||||
* \return true in case of success and false else
|
||||
*/
|
||||
bool convertToMultiType();
|
||||
|
||||
@ -859,12 +859,12 @@ class CORE_EXPORT QgsGeometry
|
||||
* If it is already a single part geometry, it will return true and
|
||||
* not change the geometry.
|
||||
*
|
||||
* @return true in case of success and false else
|
||||
* \return true in case of success and false else
|
||||
*/
|
||||
bool convertToSingleType();
|
||||
|
||||
/** Modifies geometry to avoid intersections with the layers specified in project properties
|
||||
* @return 0 in case of success,
|
||||
* \return 0 in case of success,
|
||||
* 1 if geometry is not of polygon type,
|
||||
* 2 if avoid intersection would change the geometry type,
|
||||
* 3 other error during intersection removal
|
||||
@ -884,7 +884,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* of lower-to-equal dimension geometries or a geometry of lower dimension.
|
||||
* Single polygons may become multi-geometries in case of self-intersections.
|
||||
* It preserves Z values, but M values will be dropped.
|
||||
* @return new valid QgsGeometry or null geometry on error
|
||||
* \return new valid QgsGeometry or null geometry on error
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
QgsGeometry makeValid();
|
||||
@ -963,7 +963,7 @@ class CORE_EXPORT QgsGeometry
|
||||
/** Calculates the vertex ID from a vertex number
|
||||
* \param nr vertex number
|
||||
* \param id reference to QgsVertexId for storing result
|
||||
* @returns true if vertex was found
|
||||
* \returns true if vertex was found
|
||||
* \since QGIS 2.10
|
||||
* @see vertexNrFromVertexId
|
||||
*/
|
||||
@ -971,7 +971,7 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Returns the vertex number corresponding to a vertex idd
|
||||
* \param i vertex id
|
||||
* @returns vertex number
|
||||
* \returns vertex number
|
||||
* \since QGIS 2.10
|
||||
* @see vertexIdFromVertexNr
|
||||
*/
|
||||
@ -999,14 +999,14 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/** Creates a QgsPolyline from a QPolygonF.
|
||||
* \param polygon source polygon
|
||||
* @returns QgsPolyline
|
||||
* \returns QgsPolyline
|
||||
* @see createPolygonFromQPolygonF
|
||||
*/
|
||||
static QgsPolyline createPolylineFromQPolygonF( const QPolygonF &polygon );
|
||||
|
||||
/** Creates a QgsPolygon from a QPolygonF.
|
||||
* \param polygon source polygon
|
||||
* @returns QgsPolygon
|
||||
* \returns QgsPolygon
|
||||
* @see createPolylineFromQPolygonF
|
||||
*/
|
||||
static QgsPolygon createPolygonFromQPolygonF( const QPolygonF &polygon );
|
||||
@ -1015,7 +1015,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* \param p1 first polyline
|
||||
* \param p2 second polyline
|
||||
* \param epsilon maximum difference for coordinates between the polylines
|
||||
* @returns true if polylines have the same number of points and all
|
||||
* \returns true if polylines have the same number of points and all
|
||||
* points are equal within the specified tolerance
|
||||
* \since QGIS 2.9
|
||||
*/
|
||||
@ -1025,7 +1025,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* \param p1 first polygon
|
||||
* \param p2 second polygon
|
||||
* \param epsilon maximum difference for coordinates between the polygons
|
||||
* @returns true if polygons have the same number of rings, and each ring has the same
|
||||
* \returns true if polygons have the same number of rings, and each ring has the same
|
||||
* number of points and all points are equal within the specified tolerance
|
||||
* \since QGIS 2.9
|
||||
*/
|
||||
@ -1035,7 +1035,7 @@ class CORE_EXPORT QgsGeometry
|
||||
* \param p1 first multipolygon
|
||||
* \param p2 second multipolygon
|
||||
* \param epsilon maximum difference for coordinates between the multipolygons
|
||||
* @returns true if multipolygons have the same number of polygons, the polygons have the same number
|
||||
* \returns true if multipolygons have the same number of polygons, the polygons have the same number
|
||||
* of rings, and each ring has the same number of points and all points are equal within the specified
|
||||
* tolerance
|
||||
* \since QGIS 2.9
|
||||
|
@ -69,7 +69,7 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry
|
||||
|
||||
/** Removes a geometry from the collection.
|
||||
* \param nr index of geometry to remove
|
||||
* @returns true if removal was successful.
|
||||
* \returns true if removal was successful.
|
||||
*/
|
||||
virtual bool removeGeometry( int nr );
|
||||
|
||||
@ -115,7 +115,7 @@ class CORE_EXPORT QgsGeometryCollection: public QgsAbstractGeometry
|
||||
|
||||
/** Returns approximate rotation angle for a vertex. Usually average angle between adjacent segments.
|
||||
* \param vertex the vertex id
|
||||
* @return rotation in radians, clockwise from north
|
||||
* \return rotation in radians, clockwise from north
|
||||
*/
|
||||
double vertexAngle( QgsVertexId vertex ) const override;
|
||||
|
||||
|
@ -36,24 +36,24 @@ class QgsGeometryEditUtils
|
||||
public:
|
||||
|
||||
/** Adds interior ring (taking ownership).
|
||||
@return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
\return 0 in case of success (ring added), 1 problem with geometry type, 2 ring not closed,
|
||||
3 ring is not valid geometry, 4 ring not disjoint with existing rings, 5 no polygon found which contained the ring*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
static int addRing( QgsAbstractGeometry *geom, QgsCurve *ring );
|
||||
|
||||
/** Adds part to multi type geometry (taking ownership)
|
||||
@return 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring
|
||||
\return 0 in case of success, 1 if not a multigeometry, 2 if part is not a valid geometry, 3 if new polygon ring
|
||||
not disjoint with existing polygons of the feature*/
|
||||
// TODO QGIS 3.0 returns an enum instead of a magic constant
|
||||
static int addPart( QgsAbstractGeometry *geom, QgsAbstractGeometry *part );
|
||||
|
||||
/** Deletes a ring from a geometry.
|
||||
* @returns true if delete was successful
|
||||
* \returns true if delete was successful
|
||||
*/
|
||||
static bool deleteRing( QgsAbstractGeometry *geom, int ringNum, int partNum = 0 );
|
||||
|
||||
/** Deletes a part from a geometry.
|
||||
* @returns true if delete was successful
|
||||
* \returns true if delete was successful
|
||||
*/
|
||||
static bool deletePart( QgsAbstractGeometry *geom, int partNum );
|
||||
|
||||
|
@ -64,7 +64,7 @@ class CORE_EXPORT QgsGeometryEngine
|
||||
* relationship between the geometries.
|
||||
* \param geom geometry to relate to
|
||||
* \param errorMsg destination storage for any error message
|
||||
* @returns DE-9IM string for relationship, or an empty string if an error occurred
|
||||
* \returns DE-9IM string for relationship, or an empty string if an error occurred
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
virtual QString relate( const QgsAbstractGeometry &geom, QString *errorMsg = nullptr ) const = 0;
|
||||
@ -74,7 +74,7 @@ class CORE_EXPORT QgsGeometryEngine
|
||||
* \param geom geometry to relate to
|
||||
* \param pattern DE-9IM pattern for match
|
||||
* \param errorMsg destination storage for any error message
|
||||
* @returns true if geometry relationship matches with pattern
|
||||
* \returns true if geometry relationship matches with pattern
|
||||
* \since QGIS 2.14
|
||||
*/
|
||||
virtual bool relatePattern( const QgsAbstractGeometry &geom, const QString &pattern, QString *errorMsg = nullptr ) const = 0;
|
||||
|
@ -44,7 +44,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
/** Returns the distance along a geometry from its first vertex to the specified vertex.
|
||||
* \param geom geometry
|
||||
* \param id vertex id to find distance to
|
||||
* @returns distance to vertex (following geometry)
|
||||
* \returns distance to vertex (following geometry)
|
||||
* \since QGIS 2.16
|
||||
*/
|
||||
static double distanceToVertex( const QgsAbstractGeometry &geom, QgsVertexId id );
|
||||
@ -56,7 +56,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param previousVertex will be set to previous vertex ID
|
||||
* \param nextVertex will be set to next vertex ID
|
||||
* \note if the distance coincides exactly with a vertex, then both previousVertex and nextVertex will be set to this vertex
|
||||
* @returns true if vertices were successfully retrieved
|
||||
* \returns true if vertices were successfully retrieved
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
static bool verticesAtDistance( const QgsAbstractGeometry &geometry,
|
||||
@ -83,7 +83,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param q1 Point on the second line
|
||||
* \param w Direction vector of the second line
|
||||
* \param inter Output parameter, the intersection point
|
||||
* @return Whether the lines intersect
|
||||
* \return Whether the lines intersect
|
||||
*/
|
||||
static bool lineIntersection( const QgsPointV2 &p1, QgsVector v, const QgsPointV2 &q1, QgsVector w, QgsPointV2 &inter );
|
||||
|
||||
@ -95,7 +95,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param q2 Second segment end point
|
||||
* \param inter Output parameter, the intersection point
|
||||
* \param tolerance The tolerance to use
|
||||
* @return Whether the segments intersect
|
||||
* \return Whether the segments intersect
|
||||
*/
|
||||
static bool segmentIntersection( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &q1, const QgsPointV2 &q2, QgsPointV2 &inter, double tolerance );
|
||||
|
||||
@ -104,7 +104,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param p The point
|
||||
* \param s1 The segment start point
|
||||
* \param s2 The segment end point
|
||||
* @return The projection of the point on the segment
|
||||
* \return The projection of the point on the segment
|
||||
*/
|
||||
static QgsPointV2 projPointOnSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 )
|
||||
{
|
||||
@ -128,7 +128,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param part The part of the geometry to check
|
||||
* \param ring The ring of the geometry part to check
|
||||
* \param tolerance The tolerance to use
|
||||
* @return The list of self intersections
|
||||
* \return The list of self intersections
|
||||
* \note not available in Python bindings
|
||||
* \since QGIS 2.12
|
||||
*/
|
||||
@ -208,7 +208,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
|
||||
/** Ensures that an angle is in the range 0 <= angle < 2 pi.
|
||||
* \param angle angle in radians
|
||||
* @returns equivalent angle within the range [0, 2 pi)
|
||||
* \returns equivalent angle within the range [0, 2 pi)
|
||||
*/
|
||||
static double normalizedAngle( double angle );
|
||||
|
||||
@ -217,7 +217,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param y1 y-coordinate of line start
|
||||
* \param x2 x-coordinate of line end
|
||||
* \param y2 y-coordinate of line end
|
||||
* @returns angle in radians. Returned value is undefined if start and end point are the same.
|
||||
* \returns angle in radians. Returned value is undefined if start and end point are the same.
|
||||
*/
|
||||
static double lineAngle( double x1, double y1, double x2, double y2 );
|
||||
|
||||
@ -229,7 +229,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param y2 y-coordinate of point b
|
||||
* \param x3 x-coordinate of point c
|
||||
* \param y3 y-coordinate of point c
|
||||
* @returns angle between lines in radians. Returned value is undefined if two or more points are equal.
|
||||
* \returns angle between lines in radians. Returned value is undefined if two or more points are equal.
|
||||
*/
|
||||
static double angleBetweenThreePoints( double x1, double y1, double x2, double y2,
|
||||
double x3, double y3 );
|
||||
@ -240,7 +240,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param y1 y-coordinate of line start
|
||||
* \param x2 x-coordinate of line end
|
||||
* \param y2 y-coordinate of line end
|
||||
* @returns angle in radians. Returned value is undefined if start and end point are the same.
|
||||
* \returns angle in radians. Returned value is undefined if start and end point are the same.
|
||||
*/
|
||||
static double linePerpendicularAngle( double x1, double y1, double x2, double y2 );
|
||||
|
||||
@ -250,7 +250,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
/** Averages two angles, correctly handling negative angles and ensuring the result is between 0 and 2 pi.
|
||||
* \param a1 first angle (in radians)
|
||||
* \param a2 second angle (in radians)
|
||||
* @returns average angle (in radians)
|
||||
* \returns average angle (in radians)
|
||||
*/
|
||||
static double averageAngle( double a1, double a2 );
|
||||
|
||||
@ -264,7 +264,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* Parses a WKT string and returns of list of blocks contained in the WKT.
|
||||
* \param wkt WKT string in the format "TYPE1 (contents1), TYPE2 (TYPE3 (contents3), TYPE4 (contents4))"
|
||||
* \param defaultType default geometry type for children
|
||||
* @returns list of WKT child block strings, e.g., List("TYPE1 (contents1)", "TYPE2 (TYPE3 (contents3), TYPE4 (contents4))")
|
||||
* \returns list of WKT child block strings, e.g., List("TYPE1 (contents1)", "TYPE2 (TYPE3 (contents3), TYPE4 (contents4))")
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
static QStringList wktGetChildBlocks( const QString &wkt, const QString &defaultType = "" );
|
||||
@ -274,7 +274,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* M value is computed if one of this point have M.
|
||||
* \param pt1 first point.
|
||||
* \param pt2 second point.
|
||||
* @return New point at middle between points pt1 and pt2.
|
||||
* \return New point at middle between points pt1 and pt2.
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* p = QgsPointV2( 4, 6 ) # 2D point
|
||||
@ -294,7 +294,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
/** Return the gradient of a line defined by points \a pt1 and \a pt2.
|
||||
* \param pt1 first point.
|
||||
* \param pt2 second point.
|
||||
* @return The gradient of this linear entity, or infinity if vertical
|
||||
* \return The gradient of this linear entity, or infinity if vertical
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
static double gradient( const QgsPointV2 &pt1, const QgsPointV2 &pt2 );
|
||||
@ -314,7 +314,7 @@ class CORE_EXPORT QgsGeometryUtils
|
||||
* \param p The point
|
||||
* \param s1 The segment start point
|
||||
* \param s2 The segment end point
|
||||
* @return A line (segment) from p to perpendicular point on segment [s1, s2]
|
||||
* \return A line (segment) from p to perpendicular point on segment [s1, s2]
|
||||
*/
|
||||
static QgsLineString perpendicularSegment( const QgsPointV2 &p, const QgsPointV2 &s1, const QgsPointV2 &s2 );
|
||||
|
||||
|
@ -79,7 +79,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
|
||||
\param topological true if topological editing is enabled
|
||||
\param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset
|
||||
\param[out] errorMsg error messages emitted, if any
|
||||
@return 0 in case of success, 1 if geometry has not been split, error else*/
|
||||
\return 0 in case of success, 1 if geometry has not been split, error else*/
|
||||
int splitGeometry( const QgsLineString &splitLine,
|
||||
QList<QgsAbstractGeometry *> &newGeometries,
|
||||
bool topological,
|
||||
@ -97,7 +97,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
|
||||
* \param joinStyle join style for corners ( Round (1) / Mitre (2) / Bevel (3) )
|
||||
* \param mitreLimit limit on the mitre ratio used for very sharp corners
|
||||
* \param errorMsg error messages emitted, if any
|
||||
* @return buffered geometry, or an nullptr if buffer could not be
|
||||
* \return buffered geometry, or an nullptr if buffer could not be
|
||||
* calculated
|
||||
* \since QGIS 3.0
|
||||
*/
|
||||
@ -111,7 +111,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
|
||||
/** Merges any connected lines in a LineString/MultiLineString geometry and
|
||||
* converts them to single line strings.
|
||||
* \param errorMsg if specified, will be set to any reported GEOS errors
|
||||
* @returns a LineString or MultiLineString geometry, with any connected lines
|
||||
* \returns a LineString or MultiLineString geometry, with any connected lines
|
||||
* joined. An empty geometry will be returned if the input geometry was not a
|
||||
* LineString/MultiLineString geometry.
|
||||
* \since QGIS 3.0
|
||||
@ -137,7 +137,7 @@ class CORE_EXPORT QgsGeos: public QgsGeometryEngine
|
||||
* \param point point to seek proximity to
|
||||
* \param errorMsg error messages emitted, if any
|
||||
* \note only valid for linestring geometries
|
||||
* @return distance along line, or -1 on error
|
||||
* \return distance along line, or -1 on error
|
||||
*/
|
||||
double lineLocatePoint( const QgsPointV2 &point, QString *errorMsg = nullptr ) const;
|
||||
|
||||
|
@ -46,7 +46,7 @@ class QgsInternalGeometryEngine
|
||||
*
|
||||
* \param x offset in x direction
|
||||
* \param y offset in y direction
|
||||
* @return an extruded polygon
|
||||
* \return an extruded polygon
|
||||
*/
|
||||
QgsGeometry extrude( double x, double y ) const;
|
||||
|
||||
|
@ -71,7 +71,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
|
||||
|
||||
/** Returns the z-coordinate of the specified node in the line string.
|
||||
* \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
|
||||
* \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()
|
||||
*/
|
||||
@ -79,7 +79,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
|
||||
|
||||
/** Returns the m value of the specified node in the line string.
|
||||
* \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
|
||||
* \returns m value of node, or 0.0 if index is out of bounds or the line
|
||||
* does not have m values
|
||||
* @see setMAt()
|
||||
*/
|
||||
@ -137,7 +137,7 @@ class CORE_EXPORT QgsLineString: public QgsCurve
|
||||
void close();
|
||||
|
||||
/** Returns the geometry converted to the more generic curve type QgsCompoundCurve
|
||||
@return the converted geometry. Caller takes ownership*/
|
||||
\return the converted geometry. Caller takes ownership*/
|
||||
QgsAbstractGeometry *toCurveType() const override;
|
||||
|
||||
/**
|
||||
|
@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve
|
||||
virtual bool addGeometry( QgsAbstractGeometry *g ) override;
|
||||
|
||||
/** Returns the geometry converted to the more generic curve type QgsMultiCurve
|
||||
@return the converted geometry. Caller takes ownership*/
|
||||
\return the converted geometry. Caller takes ownership*/
|
||||
QgsAbstractGeometry *toCurveType() const override;
|
||||
|
||||
protected:
|
||||
|
@ -45,7 +45,7 @@ class CORE_EXPORT QgsMultiPolygonV2: public QgsMultiSurface
|
||||
virtual bool addGeometry( QgsAbstractGeometry *g ) override;
|
||||
|
||||
/** Returns the geometry converted to the more generic curve type QgsMultiSurface
|
||||
@return the converted geometry. Caller takes ownership*/
|
||||
\return the converted geometry. Caller takes ownership*/
|
||||
QgsAbstractGeometry *toCurveType() const override;
|
||||
|
||||
virtual QgsAbstractGeometry *boundary() const override;
|
||||
|
@ -234,7 +234,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
|
||||
* \param distance distance to project
|
||||
* \param azimuth angle to project in X Y, clockwise in degrees starting from north
|
||||
* \param inclination angle to project in Z (3D)
|
||||
* @return The point projected. If a 2D point is projected a 3D point will be returned except if
|
||||
* \return The point projected. If a 2D point is projected a 3D point will be returned except if
|
||||
* inclination is 90. A 3D point is always returned if a 3D point is projected.
|
||||
* Example:
|
||||
* \code{.py}
|
||||
@ -319,7 +319,7 @@ class CORE_EXPORT QgsPointV2: public QgsAbstractGeometry
|
||||
|
||||
/** Angle undefined. Always returns 0.0
|
||||
\param vertex the vertex id
|
||||
@return 0.0*/
|
||||
\return 0.0*/
|
||||
double vertexAngle( QgsVertexId vertex ) const override { Q_UNUSED( vertex ); return 0.0; }
|
||||
|
||||
virtual int vertexCount( int /*part*/ = 0, int /*ring*/ = 0 ) const override { return 1; }
|
||||
|
@ -52,7 +52,7 @@ class CORE_EXPORT QgsPolygonV2: public QgsCurvePolygon
|
||||
QgsPolygonV2 *surfaceToPolygon() const override;
|
||||
|
||||
/** Returns the geometry converted to the more generic curve type QgsCurvePolygon
|
||||
@return the converted geometry. Caller takes ownership*/
|
||||
\return the converted geometry. Caller takes ownership*/
|
||||
QgsAbstractGeometry *toCurveType() const override;
|
||||
|
||||
void addInteriorRing( QgsCurve *ring ) override;
|
||||
|
@ -98,13 +98,13 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* Returns coordinates of a vertex.
|
||||
* \param atVertex index of the vertex
|
||||
* @return Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3).
|
||||
* \return Coordinates of the vertex or QgsPointV2(0,0) on error (\a atVertex < 0 or > 3).
|
||||
*/
|
||||
QgsPointV2 vertexAt( int atVertex ) const;
|
||||
|
||||
/**
|
||||
* Returns the three lengths of the triangle.
|
||||
* @return Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2
|
||||
* \return Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -116,7 +116,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Returns the three angles of the triangle.
|
||||
* @return Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2
|
||||
* \return Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -129,7 +129,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* Is the triangle isocele (two sides with the same length)?
|
||||
* \param lengthTolerance The tolerance to use
|
||||
* @return True or False
|
||||
* \return True or False
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -145,7 +145,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* Is the triangle equilateral (three sides with the same length)?
|
||||
* \param lengthTolerance The tolerance to use
|
||||
* @return True or False
|
||||
* \return True or False
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 10, 10 ), QgsPointV2( 16, 10 ), QgsPointV2( 13, 15.1962 ) )
|
||||
@ -161,7 +161,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* Is the triangle right-angled?
|
||||
* \param angleTolerance The tolerance to use
|
||||
* @return True or False
|
||||
* \return True or False
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -177,8 +177,8 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* Is the triangle scalene (all sides have differen lengths)?
|
||||
* \param lengthTolerance The tolerance to use
|
||||
* @return True or False
|
||||
* @return True or False
|
||||
* \return True or False
|
||||
* \return True or False
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 7.2825, 4.2368 ), QgsPointV2( 13.0058, 3.3218 ), QgsPointV2( 9.2145, 6.5242 ) )
|
||||
@ -193,7 +193,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side).
|
||||
* @return Three altitudes from this triangle
|
||||
* \return Three altitudes from this triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -205,7 +205,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side.
|
||||
* @return Three medians from this triangle
|
||||
* \return Three medians from this triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -218,7 +218,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side.
|
||||
* \param lengthTolerance The tolerance to use
|
||||
* @return Three angle bisector from this triangle
|
||||
* \return Three angle bisector from this triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -230,7 +230,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides.
|
||||
* @return The medial from this triangle
|
||||
* \return The medial from this triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -243,7 +243,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
/**
|
||||
* An orthocenter is the point of intersection of the altitudes of a triangle.
|
||||
* \param lengthTolerance The tolerance to use
|
||||
* @return The orthocenter of the triangle.
|
||||
* \return The orthocenter of the triangle.
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -255,7 +255,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Center of the circumscribed circle of the triangle.
|
||||
* @return The center of the circumscribed circle of the triangle
|
||||
* \return The center of the circumscribed circle of the triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -267,7 +267,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Radius of the circumscribed circle of the triangle.
|
||||
* @return The radius of the circumscribed circle of the triangle
|
||||
* \return The radius of the circumscribed circle of the triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -282,7 +282,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Center of the inscribed circle of the triangle.
|
||||
* @return The center of the inscribed circle of the triangle
|
||||
* \return The center of the inscribed circle of the triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -294,7 +294,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
|
||||
/**
|
||||
* Radius of the inscribed circle of the triangle.
|
||||
* @return The radius of the inscribed circle of the triangle
|
||||
* \return The radius of the inscribed circle of the triangle
|
||||
* * Example:
|
||||
* \code{.py}
|
||||
* tri = QgsTriangle( QgsPointV2( 0, 0 ), QgsPointV2( 0, 5 ), QgsPointV2( 5, 5 ) )
|
||||
@ -313,7 +313,7 @@ class CORE_EXPORT QgsTriangle : public QgsPolygonV2
|
||||
* \param p1 first point
|
||||
* \param p2 second point
|
||||
* \param p3 third point
|
||||
* @return True if the points can create a triangle, otherwise false.
|
||||
* \return True if the points can create a triangle, otherwise false.
|
||||
* \note not available in Python bindings
|
||||
*/
|
||||
bool validateGeom( const QgsPointV2 &p1, const QgsPointV2 &p2, const QgsPointV2 &p3 );
|
||||
|
@ -612,7 +612,7 @@ class CORE_EXPORT QgsWkbTypes
|
||||
|
||||
/** Returns the inherent dimension of the geometry type as an integer. Returned value will
|
||||
* always be less than or equal to the coordinate dimension.
|
||||
* @returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries
|
||||
* \returns 0 for point geometries, 1 for line geometries, 2 for polygon geometries
|
||||
* Invalid geometry types will return a dimension of 0.
|
||||
* @see coordDimensions()
|
||||
*/
|
||||
@ -747,7 +747,7 @@ class CORE_EXPORT QgsWkbTypes
|
||||
static QString geometryDisplayString( GeometryType type );
|
||||
|
||||
/** Tests whether a WKB type contains the z-dimension.
|
||||
* @returns true if type has z values
|
||||
* \returns true if type has z values
|
||||
* @see addZ()
|
||||
* @see hasM()
|
||||
*/
|
||||
@ -796,7 +796,7 @@ class CORE_EXPORT QgsWkbTypes
|
||||
}
|
||||
|
||||
/** Tests whether a WKB type contains m values.
|
||||
* @returns true if type has m values
|
||||
* \returns true if type has m values
|
||||
* @see addM()
|
||||
* @see hasZ()
|
||||
*/
|
||||
@ -930,7 +930,7 @@ class CORE_EXPORT QgsWkbTypes
|
||||
/**
|
||||
* Will convert the 25D version of the flat type if supported or Unknown if not supported.
|
||||
* \param type The type to convert
|
||||
* @return the 25D version of the type or Unknown
|
||||
* \return the 25D version of the type or Unknown
|
||||
*/
|
||||
static Type to25D( Type type )
|
||||
{
|
||||
|
@ -143,7 +143,7 @@ class CORE_EXPORT QgsLayerTreeModel : public QAbstractItemModel
|
||||
* and rule key.
|
||||
* \param layerId map layer ID
|
||||
* \param ruleKey legend node rule key
|
||||
* @returns QgsLayerTreeModelLegendNode if found
|
||||
* \returns QgsLayerTreeModelLegendNode if found
|
||||
* \since QGIS 2.14
|
||||
*/
|
||||
QgsLayerTreeModelLegendNode *findLegendNode( const QString &layerId, const QString &ruleKey ) const;
|
||||
|
@ -107,7 +107,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
|
||||
* \param settings Legend layout configuration
|
||||
* \param ctx Context for rendering - may be null if only doing layout without actual rendering
|
||||
* \param itemHeight Minimal height of the legend item - used for correct positioning when rendering
|
||||
* @return Real size of the symbol (may be bigger than "normal" symbol size from settings)
|
||||
* \return Real size of the symbol (may be bigger than "normal" symbol size from settings)
|
||||
*/
|
||||
virtual QSizeF drawSymbol( const QgsLegendSettings &settings, ItemContext *ctx, double itemHeight ) const;
|
||||
|
||||
@ -116,7 +116,7 @@ class CORE_EXPORT QgsLayerTreeModelLegendNode : public QObject
|
||||
* \param settings Legend layout configuration
|
||||
* \param ctx Context for rendering - may be null if only doing layout without actual rendering
|
||||
* \param symbolSize Real size of the associated symbol - used for correct positioning when rendering
|
||||
* @return Size of the label (may span multiple lines)
|
||||
* \return Size of the label (may span multiple lines)
|
||||
*/
|
||||
virtual QSizeF drawSymbolText( const QgsLegendSettings &settings, ItemContext *ctx, QSizeF symbolSize ) const;
|
||||
|
||||
|
@ -80,7 +80,7 @@ class CORE_EXPORT QgsLayerTreeUtils
|
||||
//! \param group the tree group where layers are (can be the root group)
|
||||
//! \param refLayer the reference layer
|
||||
//! \param layerToInsert the new layer to insert just below the reference layer
|
||||
//! @returns the new tree layer
|
||||
//! \returns the new tree layer
|
||||
static QgsLayerTreeLayer *insertLayerBelow( QgsLayerTreeGroup *group, const QgsMapLayer *refLayer, QgsMapLayer *layerToInsert );
|
||||
};
|
||||
|
||||
|
@ -133,7 +133,7 @@ namespace pal
|
||||
* \param y y coordinate of the point
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidates
|
||||
* \param angle orientation of the label
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCandidatesAroundPoint( double x, double y, QList<LabelPosition *> &lPos, double angle );
|
||||
|
||||
@ -142,7 +142,7 @@ namespace pal
|
||||
* \param y y coordinate of the point
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidate
|
||||
* \param angle orientation of the label
|
||||
* @returns the number of generated candidates (always 1)
|
||||
* \returns the number of generated candidates (always 1)
|
||||
*/
|
||||
int createCandidatesOverPoint( double x, double y, QList<LabelPosition *> &lPos, double angle );
|
||||
|
||||
@ -151,14 +151,14 @@ namespace pal
|
||||
* \param y y coordinate of the point
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidate
|
||||
* \param angle orientation of the label
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCandidatesAtOrderedPositionsOverPoint( double x, double y, QList<LabelPosition *> &lPos, double angle );
|
||||
|
||||
/** Generate candidates for line feature.
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidates
|
||||
* \param mapShape a pointer to the line
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCandidatesAlongLine( QList<LabelPosition *> &lPos, PointSet *mapShape );
|
||||
|
||||
@ -166,7 +166,7 @@ namespace pal
|
||||
* straightish segments of the line. Segments closer to horizontal are preferred over vertical segments.
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidates
|
||||
* \param mapShape a pointer to the line
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCandidatesAlongLineNearStraightSegments( QList<LabelPosition *> &lPos, PointSet *mapShape );
|
||||
|
||||
@ -176,7 +176,7 @@ namespace pal
|
||||
* \param mapShape a pointer to the line
|
||||
* \param initialCost initial cost for candidates generated using this method. If set, cost can be increased
|
||||
* by a preset amount.
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCandidatesAlongLineNearMidpoint( QList<LabelPosition *> &lPos, PointSet *mapShape, double initialCost = 0.0 );
|
||||
|
||||
@ -188,7 +188,7 @@ namespace pal
|
||||
* \param distance distance to offset label along curve by
|
||||
* \param reversed if true label is reversed from lefttoright to righttoleft
|
||||
* \param flip if true label is placed on the other side of the line
|
||||
* @returns calculated label position
|
||||
* \returns calculated label position
|
||||
*/
|
||||
LabelPosition *curvedPlacementAtOffset( PointSet *path_positions, double *path_distances,
|
||||
int &orientation, int index, double distance, bool &reversed, bool &flip );
|
||||
@ -196,7 +196,7 @@ namespace pal
|
||||
/** Generate curved candidates for line features.
|
||||
* \param lPos pointer to an array of candidates, will be filled by generated candidates
|
||||
* \param mapShape a pointer to the line
|
||||
* @returns the number of generated candidates
|
||||
* \returns the number of generated candidates
|
||||
*/
|
||||
int createCurvedCandidatesAlongLine( QList<LabelPosition *> &lPos, PointSet *mapShape );
|
||||
|
||||
@ -210,7 +210,7 @@ namespace pal
|
||||
/** Tests whether this feature part belongs to the same QgsLabelFeature as another
|
||||
* feature part.
|
||||
* \param part part to compare to
|
||||
* @returns true if both parts belong to same QgsLabelFeature
|
||||
* \returns true if both parts belong to same QgsLabelFeature
|
||||
*/
|
||||
bool hasSameLabelFeatureAs( FeaturePart *part ) const;
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user