mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-13 00:03:09 -04:00
Merge pull request #3921 from DelazJ/example
Spelling fix: Replace "eg" by "e.g." or "for example"
This commit is contained in:
Nyall Dawson
GitHub
commit
78134ee9dc
4
INSTALL
4
INSTALL
@ -87,7 +87,7 @@ source directory.
|
||||
2. Overview
|
||||
===========
|
||||
|
||||
QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
|
||||
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
|
||||
(http://www.cmake.org) for building from source.
|
||||
|
||||
Following a summary of the required dependencies for building:
|
||||
@ -125,7 +125,7 @@ Optional dependencies:
|
||||
|
||||
Indirect dependencies:
|
||||
|
||||
Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
|
||||
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
|
||||
proprietary third party libraries. QGIS doesn't need any of those itself to
|
||||
build, but will only support those formats if GDAL is built accordingly. Refer
|
||||
to http://gdal.org/formats_list.html ff. for instructions how to include
|
||||
|
||||
4
NEWS
4
NEWS
@ -94,7 +94,7 @@ This release has following new features:
|
||||
- Map Composer: Parameterized svg support for composer svg images
|
||||
- Map Composer: Easier use of HTML in labels
|
||||
- Map Composer: Relative links in composer labels
|
||||
- Map Composer: Georeference outputs (eg PDF) from composer
|
||||
- Map Composer: Georeference outputs (e.g., PDF) from composer
|
||||
- Map Composer: Composer maps now auto-update with presets
|
||||
- Analysis tools: Named parameters in expressions
|
||||
- Analysis tools: More distance units
|
||||
@ -814,7 +814,7 @@ changed so we will just provide a bullet list of key new features here.
|
||||
|
||||
- Optionally re-use entered attribute values for next digitized feature.
|
||||
- Allow merging/assigning attribute values to a set of features.-
|
||||
- Allow OGR 'save as' without attributes (for eg. DGN/DXF).
|
||||
- Allow OGR 'save as' without attributes (e.g., DGN/DXF).
|
||||
|
||||
|
||||
14.7. Api and Developer Centric
|
||||
|
||||
@ -186,7 +186,7 @@ source directory.
|
||||
<H1>2. Overview</H1>
|
||||
|
||||
<P>
|
||||
QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
|
||||
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
|
||||
(<A HREF="http://www.cmake.org">http://www.cmake.org</A>) for building from source.
|
||||
</P>
|
||||
<P>
|
||||
@ -239,7 +239,7 @@ Optional dependencies:
|
||||
Indirect dependencies:
|
||||
</P>
|
||||
<P>
|
||||
Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
|
||||
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
|
||||
proprietary third party libraries. QGIS doesn't need any of those itself to
|
||||
build, but will only support those formats if GDAL is built accordingly. Refer
|
||||
to <A HREF="http://gdal.org/formats_list.html">http://gdal.org/formats_list.html</A> ff. for instructions how to include
|
||||
|
||||
@ -174,7 +174,7 @@ This release has following new features:
|
||||
<LI>Map Composer: Parameterized svg support for composer svg images
|
||||
<LI>Map Composer: Easier use of HTML in labels
|
||||
<LI>Map Composer: Relative links in composer labels
|
||||
<LI>Map Composer: Georeference outputs (eg PDF) from composer
|
||||
<LI>Map Composer: Georeference outputs (e.g., PDF) from composer
|
||||
<LI>Map Composer: Composer maps now auto-update with presets
|
||||
<LI>Analysis tools: Named parameters in expressions
|
||||
<LI>Analysis tools: More distance units
|
||||
@ -935,7 +935,7 @@ changed so we will just provide a bullet list of key new features here.
|
||||
<UL>
|
||||
<LI>Optionally re-use entered attribute values for next digitized feature.
|
||||
<LI>Allow merging/assigning attribute values to a set of features.-
|
||||
<LI>Allow OGR 'save as' without attributes (for eg. DGN/DXF).
|
||||
<LI>Allow OGR 'save as' without attributes (e.g., DGN/DXF).
|
||||
</UL>
|
||||
</UL>
|
||||
|
||||
|
||||
@ -795,7 +795,7 @@ changed so we will just provide a bullet list of key new features here.
|
||||
|
||||
- Optionally re-use entered attribute values for next digitized feature.
|
||||
- Allow merging/assigning attribute values to a set of features.-
|
||||
- Allow OGR 'save as' without attributes (for eg. DGN/DXF).
|
||||
- Allow OGR 'save as' without attributes (e.g., DGN/DXF).
|
||||
-
|
||||
-
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
|
||||
= Overview =
|
||||
|
||||
QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
|
||||
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
|
||||
(http://www.cmake.org) for building from source.
|
||||
|
||||
Following a summary of the required dependencies for building:
|
||||
@ -45,7 +45,7 @@ Optional dependencies:
|
||||
|
||||
Indirect dependencies:
|
||||
|
||||
Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
|
||||
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
|
||||
proprietary third party libraries. QGIS doesn't need any of those itself to
|
||||
build, but will only support those formats if GDAL is built accordingly. Refer
|
||||
to http://gdal.org/formats_list.html ff. for instructions how to include
|
||||
|
||||
@ -76,7 +76,7 @@ class QgsComposerAttributeTableV2 : QgsComposerTableV2
|
||||
*/
|
||||
ContentSource source() const;
|
||||
|
||||
/** Returns the source layer for the table, considering the table source mode. Eg,
|
||||
/** Returns the source layer for the table, considering the table source mode. For example,
|
||||
* 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.
|
||||
|
||||
@ -416,7 +416,7 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
|
||||
*/
|
||||
void setTransparency( const int transparency );
|
||||
|
||||
/** Returns whether effects (eg blend modes) are enabled for the item
|
||||
/** Returns whether effects (e.g., blend modes) are enabled for the item
|
||||
* @returns true if effects are enabled
|
||||
* @see setEffectsEnabled
|
||||
* @see transparency
|
||||
@ -424,7 +424,7 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
|
||||
*/
|
||||
bool effectsEnabled() const;
|
||||
|
||||
/** Sets whether effects (eg blend modes) are enabled for the item
|
||||
/** Sets whether effects (e.g., blend modes) are enabled for the item
|
||||
* @param effectsEnabled set to true to enable effects
|
||||
* @see effectsEnabled
|
||||
* @see setTransparency
|
||||
@ -508,7 +508,7 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
|
||||
/** Sets visibility for item.
|
||||
* @param visible set to true to show item, false to hide item
|
||||
* @note QGraphicsItem::setVisible should not be called directly
|
||||
* on a QgsComposerItem, as some item types (eg groups) need to override
|
||||
* on a QgsComposerItem, as some item types (e.g., groups) need to override
|
||||
* the visibility toggle.
|
||||
* @note added in version 2.5
|
||||
*/
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/** \ingroup core
|
||||
* \class QgsComposerMapItem
|
||||
* \brief An item which is drawn inside a QgsComposerMap, eg a grid or map overview.
|
||||
* \brief An item which is drawn inside a QgsComposerMap, e.g., a grid or map overview.
|
||||
*/
|
||||
class QgsComposerMapItem : QgsComposerObject
|
||||
{
|
||||
|
||||
@ -205,7 +205,7 @@ class QgsComposerMultiFrame: QgsComposerObject
|
||||
|
||||
/** Creates a new frame and adds it to the multi frame and composition.
|
||||
* @param currentFrame an existing QgsComposerFrame from which to copy the size
|
||||
* and general frame properties (eg frame style, background, rendering settings).
|
||||
* 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
|
||||
|
||||
@ -732,7 +732,7 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator
|
||||
|
||||
/** Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles.
|
||||
* @param ignorePages set to true to ignore page items
|
||||
* @param margin optional marginal (in percent, eg 0.05 = 5% ) to add around items
|
||||
* @param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items
|
||||
*/
|
||||
QRectF compositionBounds( bool ignorePages = false, double margin = 0.0 ) const;
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/** \ingroup core
|
||||
* \class QgsColorEffect
|
||||
* \brief A paint effect which alters the colors (eg brightness, contrast) in a
|
||||
* \brief A paint effect which alters the colors (e.g., brightness, contrast) in a
|
||||
* source picture.
|
||||
*
|
||||
* \note Added in version 2.9
|
||||
|
||||
@ -398,7 +398,7 @@ class QgsAbstractGeometry
|
||||
*/
|
||||
virtual QgsRectangle calculateBoundingBox() const;
|
||||
|
||||
/** Clears any cached parameters associated with the geometry, eg bounding boxes
|
||||
/** Clears any cached parameters associated with the geometry, e.g., bounding boxes
|
||||
*/
|
||||
virtual void clearCache() const;
|
||||
};
|
||||
|
||||
@ -551,7 +551,7 @@ class QgsGeometry
|
||||
|
||||
/**
|
||||
* Returns a point guaranteed to lie on the surface of a geometry. While the centroid()
|
||||
* of a geometry may be located outside of the geometry itself (eg for concave shapes),
|
||||
* of a geometry may be located outside of the geometry itself (e.g., for concave shapes),
|
||||
* the point on surface will always be inside the geometry.
|
||||
* @see centroid()
|
||||
* @see poleOfInaccessibility()
|
||||
@ -892,7 +892,7 @@ class QgsGeometry
|
||||
* @param iterations number of smoothing iterations to run. More iterations results
|
||||
* in a smoother geometry
|
||||
* @param offset fraction of line to create new vertices along, between 0 and 1.0
|
||||
* eg the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* For example, the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* of the geometry for each iteration. Smaller values result in "tighter" smoothing.
|
||||
* @param minimumDistance minimum segment length to apply smoothing to
|
||||
* @param maxAngle maximum angle at node (0-180) at which smoothing will be applied
|
||||
|
||||
@ -25,7 +25,7 @@ class QgsPointV2: public QgsAbstractGeometry
|
||||
*/
|
||||
explicit QgsPointV2( QPointF p );
|
||||
|
||||
/** Construct a point with a specified type (eg PointZ, PointM) and initial x, y, z, and m values.
|
||||
/** Construct a point with a specified type (e.g., PointZ, PointM) and initial x, y, z, and m values.
|
||||
* @param type point type
|
||||
* @param x x-coordinate of point
|
||||
* @param y y-coordinate of point
|
||||
@ -140,8 +140,8 @@ class QgsPointV2: public QgsAbstractGeometry
|
||||
|
||||
/**
|
||||
* Returns the distance between this point and a specified x, y coordinate. In certain
|
||||
* cases it may be more appropriate to call the faster distanceSquared() method, eg
|
||||
* when comparing distances.
|
||||
* cases it may be more appropriate to call the faster distanceSquared() method,
|
||||
* e.g., when comparing distances.
|
||||
* @note added in QGIS 3.0
|
||||
* @see distanceSquared()
|
||||
*/
|
||||
@ -149,8 +149,8 @@ class QgsPointV2: public QgsAbstractGeometry
|
||||
|
||||
/**
|
||||
* Returns the 2D distance between this point and another point. In certain
|
||||
* cases it may be more appropriate to call the faster distanceSquared() method, eg
|
||||
* when comparing distances.
|
||||
* cases it may be more appropriate to call the faster distanceSquared() method,
|
||||
* e.g., when comparing distances.
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
double distance( const QgsPointV2& other ) const;
|
||||
|
||||
@ -75,14 +75,14 @@ class QgsWkbTypes
|
||||
NullGeometry
|
||||
};
|
||||
|
||||
/** Returns the single type for a WKB type. Eg, for MultiPolygon WKB types the single type would be Polygon.
|
||||
/** Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon.
|
||||
* @see isSingleType()
|
||||
* @see multiType()
|
||||
* @see flatType()
|
||||
*/
|
||||
static Type singleType( Type type );
|
||||
|
||||
/** Returns the multi type for a WKB type. Eg, for Polygon WKB types the multi type would be MultiPolygon.
|
||||
/** Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon.
|
||||
* @see isMultiType()
|
||||
* @see singleType()
|
||||
* @see flatType()
|
||||
@ -90,7 +90,7 @@ class QgsWkbTypes
|
||||
static Type multiType( Type type );
|
||||
|
||||
/** Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions.
|
||||
* Eg, for PolygonZM WKB types the single type would be Polygon.
|
||||
* For example, for PolygonZM WKB types the single type would be Polygon.
|
||||
* @see singleType()
|
||||
* @see multiType()
|
||||
*/
|
||||
@ -137,12 +137,12 @@ class QgsWkbTypes
|
||||
*/
|
||||
static int coordDimensions( Type type );
|
||||
|
||||
/** Returns the geometry type for a WKB type, eg both MultiPolygon and CurvePolygon would have a
|
||||
/** Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a
|
||||
* PolygonGeometry geometry type.
|
||||
*/
|
||||
static GeometryType geometryType( Type type );
|
||||
|
||||
/** Returns a display string type for a WKB type, eg the geometry name used in WKT geometry representations.
|
||||
/** Returns a display string type for a WKB type, e.g., the geometry name used in WKT geometry representations.
|
||||
*/
|
||||
static QString displayString( Type type );
|
||||
|
||||
|
||||
@ -104,7 +104,7 @@ class Qgis
|
||||
static double SCALE_PRECISION;
|
||||
};
|
||||
|
||||
/** Converts a string to a double in a permissive way, eg allowing for incorrect
|
||||
/** Converts a string to a double in a permissive way, e.g., allowing for incorrect
|
||||
* numbers of digits between thousand separators
|
||||
* @param string string to convert
|
||||
* @param ok will be set to true if conversion was successful
|
||||
@ -114,7 +114,7 @@ class Qgis
|
||||
*/
|
||||
double qgsPermissiveToDouble( QString string, bool& ok );
|
||||
|
||||
/** Converts a string to an integer in a permissive way, eg allowing for incorrect
|
||||
/** Converts a string to an integer in a permissive way, e.g., allowing for incorrect
|
||||
* numbers of digits between thousand separators
|
||||
* @param string string to convert
|
||||
* @param ok will be set to true if conversion was successful
|
||||
|
||||
@ -248,7 +248,7 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
|
||||
*/
|
||||
static QString osName();
|
||||
|
||||
/** Returns the QGIS platform name, eg "desktop" or "server".
|
||||
/** Returns the QGIS platform name, e.g., "desktop" or "server".
|
||||
* @note added in QGIS 2.14
|
||||
* @see osName()
|
||||
*/
|
||||
|
||||
@ -183,12 +183,12 @@ class QgsGradientColorRamp : QgsColorRamp
|
||||
*/
|
||||
QgsGradientStopsList stops() const;
|
||||
|
||||
/** Returns any additional info attached to the gradient ramp (eg authorship notes)
|
||||
/** Returns any additional info attached to the gradient ramp (e.g., authorship notes)
|
||||
* @see setInfo()
|
||||
*/
|
||||
QgsStringMap info() const;
|
||||
|
||||
/** Sets additional info to attach to the gradient ramp (eg authorship notes)
|
||||
/** Sets additional info to attach to the gradient ramp (e.g., authorship notes)
|
||||
* @param info map of string info to attach
|
||||
* @see info()
|
||||
*/
|
||||
|
||||
@ -186,7 +186,7 @@ class QgsCoordinateReferenceSystem
|
||||
// static creators
|
||||
|
||||
/** Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
|
||||
* @param ogcCrs OGR compliant CRS definition, eg "EPSG:4326"
|
||||
* @param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326"
|
||||
* @returns matching CRS, or an invalid CRS if string could not be matched
|
||||
* @note added in QGIS 3.0
|
||||
* @see createFromOgcWmsCrs()
|
||||
@ -416,9 +416,9 @@ class QgsCoordinateReferenceSystem
|
||||
|
||||
/** Returns the authority identifier for the CRS.
|
||||
*
|
||||
* The identifier includes both the authority (eg EPSG) and the CRS number (eg 4326).
|
||||
* The identifier includes both the authority (e.g., EPSG) and the CRS number (e.g., 4326).
|
||||
* This is the best method to use when showing a very short CRS identifier to a user,
|
||||
* eg "EPSG:4326".
|
||||
* e.g., "EPSG:4326".
|
||||
*
|
||||
* If CRS object is a custom CRS (not found in database), the method will return
|
||||
* internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005"
|
||||
@ -427,7 +427,7 @@ class QgsCoordinateReferenceSystem
|
||||
*/
|
||||
QString authid() const;
|
||||
|
||||
/** Returns the descriptive name of the CRS, eg "WGS 84" or "GDA 94 / Vicgrid94". In most
|
||||
/** Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". In most
|
||||
* cases this is the best method to use when showing a friendly identifier for the CRS to a
|
||||
* user.
|
||||
* @returns descriptive name of the CRS
|
||||
@ -472,7 +472,7 @@ class QgsCoordinateReferenceSystem
|
||||
*/
|
||||
bool isGeographic() const;
|
||||
|
||||
/** Returns whether axis is inverted (eg. for WMS 1.3) for the CRS.
|
||||
/** Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS.
|
||||
* @returns true if CRS axis is inverted
|
||||
*/
|
||||
bool hasAxisInverted() const;
|
||||
|
||||
@ -37,13 +37,13 @@ class QgsDateTimeStatisticalSummary
|
||||
QgsDateTimeStatisticalSummary( QgsDateTimeStatisticalSummary::Statistics stats = All );
|
||||
|
||||
/** Returns flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg count).
|
||||
* are always calculated (e.g., count).
|
||||
* @see setStatistics
|
||||
*/
|
||||
Statistics statistics() const;
|
||||
|
||||
/** Sets flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg count).
|
||||
* are always calculated (e.g., count).
|
||||
* @param stats flags for statistics to calculate
|
||||
* @see statistics
|
||||
*/
|
||||
|
||||
@ -167,7 +167,7 @@ class QgsDistanceArea
|
||||
* @param distance distance to format
|
||||
* @param decimals number of decimal places to show
|
||||
* @param unit unit of distance
|
||||
* @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, eg meters to
|
||||
* @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to
|
||||
* kilometers
|
||||
* @returns formatted distance string
|
||||
* @note added in QGIS 2.16
|
||||
@ -179,7 +179,7 @@ class QgsDistanceArea
|
||||
* @param area area to format
|
||||
* @param decimals number of decimal places to show
|
||||
* @param unit unit of area
|
||||
* @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, eg square meters to
|
||||
* @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to
|
||||
* square kilometers
|
||||
* @returns formatted area string
|
||||
* @note added in QGIS 2.14
|
||||
|
||||
@ -140,21 +140,21 @@ class QgsExpression
|
||||
*/
|
||||
void setGeomCalculator( const QgsDistanceArea* calc );
|
||||
|
||||
/** Returns the desired distance units for calculations involving geomCalculator(), eg "$length" and "$perimeter".
|
||||
/** Returns the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
|
||||
* @note distances are only converted when a geomCalculator() has been set
|
||||
* @note added in QGIS 2.14
|
||||
* @see setDistanceUnits()
|
||||
*/
|
||||
QgsUnitTypes::DistanceUnit distanceUnits() const;
|
||||
|
||||
/** Sets the desired distance units for calculations involving geomCalculator(), eg "$length" and "$perimeter".
|
||||
/** Sets the desired distance units for calculations involving geomCalculator(), e.g., "$length" and "$perimeter".
|
||||
* @note distances are only converted when a geomCalculator() has been set
|
||||
* @note added in QGIS 2.14
|
||||
* @see distanceUnits()
|
||||
*/
|
||||
void setDistanceUnits( QgsUnitTypes::DistanceUnit unit );
|
||||
|
||||
/** Returns the desired areal units for calculations involving geomCalculator(), eg "$area".
|
||||
/** Returns the desired areal units for calculations involving geomCalculator(), e.g., "$area".
|
||||
* @note areas are only converted when a geomCalculator() has been set
|
||||
* @note added in QGIS 2.14
|
||||
* @see setAreaUnits()
|
||||
@ -162,7 +162,7 @@ class QgsExpression
|
||||
*/
|
||||
QgsUnitTypes::AreaUnit areaUnits() const;
|
||||
|
||||
/** Sets the desired areal units for calculations involving geomCalculator(), eg "$area".
|
||||
/** Sets the desired areal units for calculations involving geomCalculator(), e.g., "$area".
|
||||
* @note areas are only converted when a geomCalculator() has been set
|
||||
* @note added in QGIS 2.14
|
||||
* @see areaUnits()
|
||||
@ -362,7 +362,7 @@ class QgsExpression
|
||||
virtual bool usesGeometry( const QgsExpression::NodeFunction* node ) const;
|
||||
|
||||
/** Returns a list of possible aliases for the function. These include
|
||||
* other permissible names for the function, eg deprecated names.
|
||||
* other permissible names for the function, e.g., deprecated names.
|
||||
* @return list of known aliases
|
||||
* @note added in QGIS 2.9
|
||||
*/
|
||||
@ -835,7 +835,7 @@ class QgsExpression
|
||||
static QString group( const QString& group );
|
||||
|
||||
/** Formats an expression result for friendly display to the user. Truncates the result to a sensible
|
||||
* length, and presents text representations of non numeric/text types (eg geometries and features).
|
||||
* length, and presents text representations of non numeric/text types (e.g., geometries and features).
|
||||
* @param value expression result to format
|
||||
* @returns formatted string, may contain HTML formatting characters
|
||||
* @note added in QGIS 2.14
|
||||
|
||||
@ -466,7 +466,7 @@ class QgsExpressionContext
|
||||
/** \ingroup core
|
||||
* \class QgsExpressionContextUtils
|
||||
* \brief Contains utilities for working with QgsExpressionContext objects, including methods
|
||||
* for creating scopes for specific uses (eg project scopes, layer scopes).
|
||||
* for creating scopes for specific uses (e.g., project scopes, layer scopes).
|
||||
* \note added in QGIS 2.12
|
||||
*/
|
||||
|
||||
|
||||
@ -18,12 +18,12 @@ class QgsField
|
||||
/** Constructor. Constructs a new QgsField object.
|
||||
* @param name Field name
|
||||
* @param type Field variant type, currently supported: String / Int / Double
|
||||
* @param typeName Field type (eg. char, varchar, text, int, serial, double).
|
||||
* @param typeName Field type (e.g., char, varchar, text, int, serial, double).
|
||||
* Field types are usually unique to the source and are stored exactly
|
||||
* as returned from the data store.
|
||||
* @param len Field length
|
||||
* @param prec Field precision. Usually decimal places but may also be
|
||||
* used in conjunction with other fields types (eg. variable character fields)
|
||||
* used in conjunction with other fields types (e.g., variable character fields)
|
||||
* @param comment Comment for the field
|
||||
* @param subType If the field is a collection, its element's type. When
|
||||
* all the elements don't need to have the same type, leave
|
||||
|
||||
@ -115,9 +115,9 @@ class QgsFontUtils
|
||||
* @param font QFont to convert
|
||||
* @param pointToPixelMultiplier scaling factor to apply to convert point sizes to pixel font sizes.
|
||||
* The CSS returned by this function will always use pixels for font sizes, so this parameter
|
||||
* should be set to a suitable value to convert point sizes to pixels (eg taking into account
|
||||
* should be set to a suitable value to convert point sizes to pixels (e.g., taking into account
|
||||
* desination DPI)
|
||||
* @returns partial CSS string, eg "font-family: Comic Sans; font-size: 12px;"
|
||||
* @returns partial CSS string, e.g., "font-family: Comic Sans; font-size: 12px;"
|
||||
* @note added in QGIS 2.16
|
||||
*/
|
||||
static QString asCSS( const QFont& font, double pointToPixelMultiplier = 1.0 );
|
||||
|
||||
@ -128,7 +128,7 @@ class QgsPalLayerSettings
|
||||
Curved, /** Arranges candidates following the curvature of a line feature. Applies to line layers only.*/
|
||||
Horizontal, /**< Arranges horizontal candidates scattered throughout a polygon feature. Applies to polygon layers only.*/
|
||||
Free, /**< Arranges candidates scattered throughout a polygon feature. Candidates are rotated to respect the polygon's orientation. Applies to polygon layers only.*/
|
||||
OrderedPositionsAroundPoint, /**< Candidates are placed in predefined positions around a point. Peference is given to positions with greatest cartographic appeal, eg top right, bottom right, etc. Applies to point layers only.*/
|
||||
OrderedPositionsAroundPoint, /**< Candidates are placed in predefined positions around a point. Preference is given to positions with greatest cartographic appeal, e.g., top right, bottom right, etc. Applies to point layers only.*/
|
||||
PerimeterCurved, /** Arranges candidates following the curvature of a polygon's boundary. Applies to polygon layers only.*/
|
||||
};
|
||||
|
||||
@ -173,7 +173,7 @@ class QgsPalLayerSettings
|
||||
respects the direction of the line feature, so a line from right to left labels will have labels
|
||||
placed placed above the line feature. */
|
||||
MapOrientation, /**< Signifies that the AboveLine and BelowLine flags should respect the map's orientation rather
|
||||
than the feature's orientation. Eg, AboveLine will always result in label's being placed
|
||||
than the feature's orientation. For example, AboveLine will always result in label's being placed
|
||||
above a line, regardless of the line's direction. */
|
||||
};
|
||||
|
||||
@ -209,7 +209,7 @@ class QgsPalLayerSettings
|
||||
MultiLeft,
|
||||
MultiCenter,
|
||||
MultiRight,
|
||||
MultiFollowPlacement /*!< Alignment follows placement of label, eg labels to the left of a feature
|
||||
MultiFollowPlacement /*!< Alignment follows placement of label, e.g., labels to the left of a feature
|
||||
will be drawn with right alignment*/
|
||||
};
|
||||
|
||||
@ -366,7 +366,7 @@ class QgsPalLayerSettings
|
||||
|
||||
QString fieldName;
|
||||
|
||||
/** Is this label made from a expression string eg FieldName || 'mm'
|
||||
/** Is this label made from a expression string, e.g., FieldName || 'mm'
|
||||
*/
|
||||
bool isExpression;
|
||||
|
||||
@ -487,7 +487,7 @@ class QgsPalLayerSettings
|
||||
* @param labelFeature if using QgsLabelingEngine, this will receive the label feature. Not available
|
||||
* in Python bindings.
|
||||
* @param obstacleGeometry optional obstacle geometry, if a different geometry to the feature's geometry
|
||||
* should be used as an obstacle for labels (eg, if the feature has been rendered with an offset point
|
||||
* should be used as an obstacle for labels (e.g., if the feature has been rendered with an offset point
|
||||
* symbol, the obstacle geometry should represent the bounds of the offset symbol). If not set,
|
||||
* the feature's original geometry will be used as an obstacle for labels. Not available
|
||||
* in Python bindings.
|
||||
@ -569,13 +569,13 @@ class QgsPalLayerSettings
|
||||
*/
|
||||
// QMap<QgsPalLayerSettings::DataDefinedProperties, QPair<QString, int> > dataDefinedNames() const;
|
||||
|
||||
/** Returns the label text formatting settings, eg font settings, buffer settings, etc.
|
||||
/** Returns the label text formatting settings, e.g., font settings, buffer settings, etc.
|
||||
* @see setFormat()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
const QgsTextFormat& format() const;
|
||||
|
||||
/** Sets the label text formatting settings, eg font settings, buffer settings, etc.
|
||||
/** Sets the label text formatting settings, e.g., font settings, buffer settings, etc.
|
||||
* @param format label text format
|
||||
* @see format()
|
||||
* @note added in QGIS 3.0
|
||||
@ -727,7 +727,7 @@ class QgsPalLabeling
|
||||
|
||||
/** Splits a text string to a list of graphemes, which are the smallest allowable character
|
||||
* divisions in the string. This accounts for scripts were individual characters are not
|
||||
* allowed to be split apart (eg Arabic and Indic based scripts)
|
||||
* allowed to be split apart (e.g., Arabic and Indic based scripts)
|
||||
* @param text string to split
|
||||
* @returns list of graphemes
|
||||
* @note added in QGIS 2.10
|
||||
|
||||
@ -185,10 +185,10 @@ class QgsPoint
|
||||
* Its up to the calling function to ensure that this point can
|
||||
* be meaningfully represented in this form.
|
||||
* @param thePrecision number of decimal points to use for seconds
|
||||
* @param useSuffix set to true to include a direction suffix (eg 'N'),
|
||||
* @param useSuffix set to true to include a direction suffix (e.g., 'N'),
|
||||
* set to false to use a "-" prefix for west and south coordinates
|
||||
* @param padded set to true to force minutes and seconds to use two decimals,
|
||||
* eg, '05' instead of '5'.
|
||||
* e.g., '05' instead of '5'.
|
||||
*/
|
||||
QString toDegreesMinutesSeconds( int thePrecision, const bool useSuffix = true, const bool padded = false ) const;
|
||||
|
||||
@ -196,10 +196,10 @@ class QgsPoint
|
||||
* Its up to the calling function to ensure that this point can
|
||||
* be meaningfully represented in this form.
|
||||
* @param thePrecision number of decimal points to use for minutes
|
||||
* @param useSuffix set to true to include a direction suffix (eg 'N'),
|
||||
* @param useSuffix set to true to include a direction suffix (e.g., 'N'),
|
||||
* set to false to use a "-" prefix for west and south coordinates
|
||||
* @param padded set to true to force minutes to use two decimals,
|
||||
* eg, '05' instead of '5'.
|
||||
* e.g., '05' instead of '5'.
|
||||
*/
|
||||
QString toDegreesMinutes( int thePrecision, const bool useSuffix = true, const bool padded = false ) const;
|
||||
|
||||
|
||||
@ -86,7 +86,7 @@ class QgsProject : QObject, QgsExpressionContextGenerator
|
||||
void setCrs( const QgsCoordinateReferenceSystem& crs );
|
||||
|
||||
/**
|
||||
* Returns a proj string representing the project's ellipsoid setting, eg "WGS84".
|
||||
* Returns a proj string representing the project's ellipsoid setting, e.g., "WGS84".
|
||||
* @see setEllipsoid()
|
||||
* @see crs()
|
||||
* @note added in QGIS 2.18
|
||||
@ -94,7 +94,7 @@ class QgsProject : QObject, QgsExpressionContextGenerator
|
||||
QString ellipsoid() const;
|
||||
|
||||
/**
|
||||
* Sets the project's ellipsoid from a proj string representation, eg "WGS84".
|
||||
* Sets the project's ellipsoid from a proj string representation, e.g., "WGS84".
|
||||
* @see ellipsoid()
|
||||
* @see setCrs()
|
||||
* @note added in QGIS 2.18
|
||||
|
||||
@ -49,13 +49,13 @@ class QgsStatisticalSummary
|
||||
virtual ~QgsStatisticalSummary();
|
||||
|
||||
/** Returns flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg sum, min and max).
|
||||
* are always calculated (e.g., sum, min and max).
|
||||
* @see setStatistics
|
||||
*/
|
||||
QgsStatisticalSummary::Statistics statistics() const;
|
||||
|
||||
/** Sets flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg sum, min and max).
|
||||
* are always calculated (e.g., sum, min and max).
|
||||
* @param stats flags for statistics to calculate
|
||||
* @see statistics
|
||||
*/
|
||||
|
||||
@ -42,13 +42,13 @@ class QgsStringStatisticalSummary
|
||||
QgsStringStatisticalSummary( QgsStringStatisticalSummary::Statistics stats = All );
|
||||
|
||||
/** Returns flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg count).
|
||||
* are always calculated (e.g., count).
|
||||
* @see setStatistics
|
||||
*/
|
||||
Statistics statistics() const;
|
||||
|
||||
/** Sets flags which specify which statistics will be calculated. Some statistics
|
||||
* are always calculated (eg count).
|
||||
* are always calculated (e.g., count).
|
||||
* @param stats flags for statistics to calculate
|
||||
* @see statistics
|
||||
*/
|
||||
|
||||
@ -152,7 +152,7 @@ class QgsStringUtils
|
||||
static int levenshteinDistance( const QString &string1, const QString &string2, bool caseSensitive = false );
|
||||
|
||||
/** Returns the longest common substring between two strings. This substring is the longest
|
||||
* string that is a substring of the two input strings. Eg, the longest common substring
|
||||
* string that is a substring of the two input strings. For example, the longest common substring
|
||||
* of "ABABC" and "BABCA" is "ABC".
|
||||
* @param string1 first string
|
||||
* @param string2 second string
|
||||
@ -178,7 +178,7 @@ class QgsStringUtils
|
||||
*/
|
||||
static QString soundex( const QString &string );
|
||||
|
||||
/** Returns a string with any URL (eg http(s)/ftp) and mailto: text converted to valid HTML <a ...>
|
||||
/** Returns a string with any URL (e.g., http(s)/ftp) and mailto: text converted to valid HTML <a ...>
|
||||
* links.
|
||||
* @param string string to insert links into
|
||||
* @param foundLinks if specified, will be set to true if any links were inserted into the string
|
||||
|
||||
@ -181,7 +181,7 @@ class QgsTask : QObject
|
||||
|
||||
/**
|
||||
* Will be emitted by task if it has terminated for any reason
|
||||
* other then completion (eg when a task has been cancelled or encountered
|
||||
* other then completion (e.g., when a task has been cancelled or encountered
|
||||
* an internal error).
|
||||
* @note derived classes should not emit this signal directly, it will automatically
|
||||
* be emitted
|
||||
|
||||
@ -215,12 +215,12 @@ class QgsTextBackgroundSettings
|
||||
*/
|
||||
void setEnabled( bool enabled );
|
||||
|
||||
/** Returns the type of background shape (eg square, ellipse, SVG).
|
||||
/** Returns the type of background shape (e.g., square, ellipse, SVG).
|
||||
* @see setType()
|
||||
*/
|
||||
ShapeType type() const;
|
||||
|
||||
/** Sets the type of background shape to draw (eg square, ellipse, SVG).
|
||||
/** Sets the type of background shape to draw (e.g., square, ellipse, SVG).
|
||||
* @param type shape type
|
||||
* @see type()
|
||||
*/
|
||||
@ -238,14 +238,14 @@ class QgsTextBackgroundSettings
|
||||
*/
|
||||
void setSvgFile( const QString& file );
|
||||
|
||||
/** Returns the method used to determine the size of the background shape (eg fixed size or buffer
|
||||
/** Returns the method used to determine the size of the background shape (e.g., fixed size or buffer
|
||||
* around text).
|
||||
* @see setSizeType()
|
||||
* @see size()
|
||||
*/
|
||||
SizeType sizeType() const;
|
||||
|
||||
/** Sets the method used to determine the size of the background shape (eg fixed size or buffer
|
||||
/** Sets the method used to determine the size of the background shape (e.g., fixed size or buffer
|
||||
* around text).
|
||||
* @param type size method
|
||||
* @see sizeType()
|
||||
@ -253,8 +253,8 @@ class QgsTextBackgroundSettings
|
||||
*/
|
||||
void setSizeType( SizeType type );
|
||||
|
||||
/** Returns the size of the background shape. The meaning of the size depends on the current sizeType()
|
||||
* eg, for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and
|
||||
/** Returns the size of the background shape. The meaning of the size depends on the current sizeType(),
|
||||
* e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and
|
||||
* height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal
|
||||
* and vertical margins to add to the text when calculating the size of the shape.
|
||||
* @see setSize()
|
||||
@ -262,8 +262,8 @@ class QgsTextBackgroundSettings
|
||||
*/
|
||||
QSizeF size() const;
|
||||
|
||||
/** Sets the size of the background shape. The meaning of the size depends on the current sizeType()
|
||||
* eg, for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and
|
||||
/** Sets the size of the background shape. The meaning of the size depends on the current sizeType(),
|
||||
* e.g., for size types of QgsTextBackgroundSettings::SizeFixed the size will represent the actual width and
|
||||
* height of the shape, for QgsTextBackgroundSettings::SizeBuffer the size will represent the horizontal
|
||||
* and vertical margins to add to the text when calculating the size of the shape.
|
||||
* @param size QSizeF representing horizontal and vertical size components for shape
|
||||
@ -589,14 +589,14 @@ class QgsTextShadowSettings
|
||||
void setEnabled( bool enabled );
|
||||
|
||||
/** Returns the placement for the drop shadow. The placement determines
|
||||
* both the z-order stacking position for the shadow and the what shape (eg text,
|
||||
* both the z-order stacking position for the shadow and the what shape (e.g., text,
|
||||
* background shape) is used for casting the shadow.
|
||||
* @see setShadowPlacement()
|
||||
*/
|
||||
QgsTextShadowSettings::ShadowPlacement shadowPlacement() const;
|
||||
|
||||
/** Sets the placement for the drop shadow. The placement determines
|
||||
* both the z-order stacking position for the shadow and the what shape (eg text,
|
||||
* both the z-order stacking position for the shadow and the what shape (e.g., text,
|
||||
* background shape) is used for casting the shadow.
|
||||
* @param placement shadow placement
|
||||
* @see shadowPlacement()
|
||||
@ -874,14 +874,14 @@ class QgsTextFormat
|
||||
*/
|
||||
void setFont( const QFont& font );
|
||||
|
||||
/** Returns the named style for the font used for rendering text (eg "bold").
|
||||
/** Returns the named style for the font used for rendering text (e.g., "bold").
|
||||
* @see setNamedStyle()
|
||||
* @see font()
|
||||
*/
|
||||
QString namedStyle() const;
|
||||
|
||||
/** Sets the named style for the font used for rendering text.
|
||||
* @param style named style, eg "bold"
|
||||
* @param style named style, e.g., "bold"
|
||||
* @see namedStyle()
|
||||
* @see setFont()
|
||||
*/
|
||||
@ -1115,7 +1115,7 @@ class QgsTextRenderer
|
||||
* @param context render context
|
||||
* @param format text format
|
||||
* @param part component of text to draw. Note that Shadow parts cannot be drawn
|
||||
* individually and instead are drawn with their associated part (eg drawn together
|
||||
* individually and instead are drawn with their associated part (e.g., drawn together
|
||||
* with the text or background parts)
|
||||
* @param drawAsOutlines set to false to render text as text. This allows outputs to
|
||||
* formats like SVG to maintain text as text objects, but at the cost of degraded
|
||||
|
||||
@ -30,7 +30,7 @@ class QgsUnitTypes
|
||||
enum DistanceUnitType
|
||||
{
|
||||
Standard, /*!< unit is a standard measurement unit */
|
||||
Geographic, /*!< unit is a geographic (eg degree based) unit */
|
||||
Geographic, /*!< unit is a geographic (e.g., degree based) unit */
|
||||
UnknownType, /*!< unknown unit type */
|
||||
};
|
||||
|
||||
@ -67,8 +67,8 @@ class QgsUnitTypes
|
||||
RenderMillimeters, //!< millimeters
|
||||
RenderMapUnits, //!< map units
|
||||
RenderPixels, //!< pixels
|
||||
RenderPercentage, //!< percentage of another measurement (eg canvas size, feature size)
|
||||
RenderPoints, //! points (eg for font sizes)
|
||||
RenderPercentage, //!< percentage of another measurement (e.g., canvas size, feature size)
|
||||
RenderPoints, //! points (e.g., for font sizes)
|
||||
RenderUnknownUnit, //!< mixed or unknown units
|
||||
};
|
||||
|
||||
@ -153,7 +153,7 @@ class QgsUnitTypes
|
||||
*/
|
||||
static double fromUnitToUnitFactor( AreaUnit fromUnit, AreaUnit toUnit );
|
||||
|
||||
/** Converts a distance unit to its corresponding area unit, eg meters to square meters
|
||||
/** Converts a distance unit to its corresponding area unit, e.g., meters to square meters
|
||||
* @param distanceUnit distance unit to convert
|
||||
* @return matching areal unit
|
||||
*/
|
||||
|
||||
@ -253,8 +253,8 @@ class QgsVectorDataProvider : QgsDataProvider
|
||||
* Returns any literal default values which are present at the provider for a specified
|
||||
* field index. Important - this should ONLY be called when creating an attribute to insert
|
||||
* directly into the database. Do not call this method for non-feature creation or modification,
|
||||
* eg when validating an attribute or to compare it against an existing value, as calling it
|
||||
* can cause changes to the underlying data source (eg Postgres provider where the default value
|
||||
* e.g., when validating an attribute or to compare it against an existing value, as calling it
|
||||
* can cause changes to the underlying data source (e.g., Postgres provider where the default value
|
||||
* is calculated as a result of a sequence). It is recommended that you instead use the methods
|
||||
* in QgsVectorLayerUtils such as QgsVectorLayerUtils::createFeature()
|
||||
* so that default value handling and validation is automatically carried out.
|
||||
@ -265,7 +265,7 @@ class QgsVectorDataProvider : QgsDataProvider
|
||||
/**
|
||||
* Returns any default value clauses which are present at the provider for a specified
|
||||
* field index. These clauses are usually SQL fragments which must be evaluated by the
|
||||
* provider, eg sequence values.
|
||||
* provider, e.g., sequence values.
|
||||
* @see defaultValue()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
@ -280,7 +280,7 @@ class QgsVectorDataProvider : QgsDataProvider
|
||||
QgsFieldConstraints::Constraints fieldConstraints( int fieldIndex ) const;
|
||||
|
||||
/**
|
||||
* Returns true if a constraint check should be skipped for a specified field (eg if
|
||||
* Returns true if a constraint check should be skipped for a specified field (e.g., if
|
||||
* the value returned by defaultValue() is trusted implicitly. An optional attribute value can be
|
||||
* passed which can help refine the skip constraint check.
|
||||
* @note added in QGIS 3.0
|
||||
|
||||
@ -352,7 +352,7 @@ class QgsVectorLayer : QgsMapLayer, QgsExpressionContextGenerator
|
||||
* @param path The path or url of the parameter. Typically this encodes
|
||||
* parameters used by the data provider as url query items.
|
||||
* @param baseName The name used to represent the layer in the legend
|
||||
* @param providerLib The name of the data provider, eg "memory", "postgres"
|
||||
* @param providerLib The name of the data provider, e.g., "memory", "postgres"
|
||||
* @param loadDefaultStyleFlag whether to load the default style
|
||||
*
|
||||
*/
|
||||
|
||||
@ -38,7 +38,7 @@ class QgsVectorLayerUtils
|
||||
|
||||
/**
|
||||
* Creates a new feature ready for insertion into a layer. Default values and constraints
|
||||
* (eg unique constraints) will automatically be handled. An optional attribute map can be
|
||||
* (e.g., unique constraints) will automatically be handled. An optional attribute map can be
|
||||
* passed for the new feature to copy as many attribute values as possible from the map,
|
||||
* assuming that they respect the layer's constraints. Note that the created feature is not
|
||||
* automatically inserted into the layer.
|
||||
|
||||
@ -174,7 +174,7 @@ class QgsGradientFillSymbolLayer : QgsFillSymbolLayer
|
||||
|
||||
double estimateMaxBleed() const;
|
||||
|
||||
/** Type of gradient, eg linear or radial*/
|
||||
/** Type of gradient, e.g., linear or radial*/
|
||||
GradientType gradientType() const;
|
||||
void setGradientType( GradientType gradientType );
|
||||
|
||||
|
||||
@ -218,7 +218,7 @@ class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
|
||||
*/
|
||||
void setBorderColor( const QColor& color );
|
||||
|
||||
/** Returns the marker's outline style (eg solid, dashed, etc)
|
||||
/** Returns the marker's outline style (e.g., solid, dashed, etc)
|
||||
* @note added in 2.4
|
||||
* @see setOutlineStyle()
|
||||
* @see borderColor()
|
||||
@ -226,7 +226,7 @@ class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
|
||||
*/
|
||||
Qt::PenStyle outlineStyle() const;
|
||||
|
||||
/** Sets the marker's outline style (eg solid, dashed, etc)
|
||||
/** Sets the marker's outline style (e.g., solid, dashed, etc)
|
||||
* @param outlineStyle style
|
||||
* @note added in 2.4
|
||||
* @see outlineStyle()
|
||||
@ -235,7 +235,7 @@ class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
|
||||
*/
|
||||
void setOutlineStyle( Qt::PenStyle outlineStyle );
|
||||
|
||||
/** Returns the marker's outline join style (eg miter, bevel, etc).
|
||||
/** Returns the marker's outline join style (e.g., miter, bevel, etc).
|
||||
* @note added in 2.16
|
||||
* @see setPenJoinStyle()
|
||||
* @see borderColor()
|
||||
@ -243,7 +243,7 @@ class QgsSimpleMarkerSymbolLayer : QgsSimpleMarkerSymbolLayerBase
|
||||
*/
|
||||
Qt::PenJoinStyle penJoinStyle() const;
|
||||
|
||||
/** Sets the marker's outline join style (eg miter, bevel, etc).
|
||||
/** Sets the marker's outline join style (e.g., miter, bevel, etc).
|
||||
* @param style join style
|
||||
* @note added in 2.16
|
||||
* @see penJoinStyle()
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
/** \class QgsPointDistanceRenderer
|
||||
* \ingroup core
|
||||
* An abstract base class for distance based point renderers (eg clusterer and displacement renderers).
|
||||
* An abstract base class for distance based point renderers (e.g., clusterer and displacement renderers).
|
||||
* QgsPointDistanceRenderer handles calculation of point clusters using a distance based threshold.
|
||||
* Subclasses must implement drawGroup() to handle the rendering of individual point clusters
|
||||
* in the desired style.
|
||||
|
||||
@ -106,7 +106,7 @@ class QgsRendererRegistry
|
||||
//! Adds a renderer to the registry. Takes ownership of the metadata object.
|
||||
//! @param metadata renderer metadata
|
||||
//! @returns true if renderer was added successfully, or false if renderer could not
|
||||
//! be added (eg a renderer with a duplicate name already exists)
|
||||
//! be added (e.g., a renderer with a duplicate name already exists)
|
||||
bool addRenderer( QgsRendererAbstractMetadata* metadata /Transfer/ );
|
||||
|
||||
//! Removes a renderer from registry.
|
||||
|
||||
@ -155,7 +155,7 @@ class QgsSymbol
|
||||
void toSld( QDomDocument &doc, QDomElement &element, QgsStringMap props ) const;
|
||||
|
||||
/** Returns the units to use for sizes and widths within the symbol. Individual
|
||||
* symbol layer definitions will interpret this in different ways, eg a marker symbol
|
||||
* symbol layer definitions will interpret this in different ways, e.g., a marker symbol
|
||||
* may use it to specify the units for the marker size, while a line symbol
|
||||
* may use it to specify the units for the line width.
|
||||
* @returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol contains mixed units
|
||||
@ -164,7 +164,7 @@ class QgsSymbol
|
||||
QgsUnitTypes::RenderUnit outputUnit() const;
|
||||
|
||||
/** Sets the units to use for sizes and widths within the symbol. Individual
|
||||
* symbol definitions will interpret this in different ways, eg a marker symbol
|
||||
* symbol definitions will interpret this in different ways, e.g., a marker symbol
|
||||
* may use it to specify the units for the marker size, while a line symbol
|
||||
* may use it to specify the units for the line width.
|
||||
* @param unit output units
|
||||
|
||||
@ -148,13 +148,13 @@ class QgsSymbolLayer
|
||||
bool isLocked() const;
|
||||
|
||||
/** Returns the estimated maximum distance which the layer style will bleed outside
|
||||
the drawn shape. Eg, polygons drawn with an outline will draw half the width
|
||||
the drawn shape. For example, polygons drawn with an outline will draw half the width
|
||||
of the outline outside of the polygon. This amount is estimated, since it may
|
||||
be affected by data defined symbology rules.*/
|
||||
virtual double estimateMaxBleed() const;
|
||||
|
||||
/** Sets the units to use for sizes and widths within the symbol layer. Individual
|
||||
* symbol layer subclasses will interpret this in different ways, eg a marker symbol
|
||||
* symbol layer subclasses will interpret this in different ways, e.g., a marker symbol
|
||||
* layer may use it to specify the units for the marker size, while a line symbol
|
||||
* layer may use it to specify the units for the line width.
|
||||
* @param unit output units
|
||||
@ -163,7 +163,7 @@ class QgsSymbolLayer
|
||||
virtual void setOutputUnit( QgsUnitTypes::RenderUnit unit );
|
||||
|
||||
/** Returns the units to use for sizes and widths within the symbol layer. Individual
|
||||
* symbol layer subclasses will interpret this in different ways, eg a marker symbol
|
||||
* symbol layer subclasses will interpret this in different ways, e.g., a marker symbol
|
||||
* layer may use it to specify the units for the marker size, while a line symbol
|
||||
* layer may use it to specify the units for the line width.
|
||||
* @returns output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
|
||||
|
||||
@ -82,13 +82,13 @@ class QgsSearchWidgetWrapper : QgsWidgetWrapper
|
||||
};
|
||||
typedef QFlags<QgsSearchWidgetWrapper::FilterFlag> FilterFlags;
|
||||
|
||||
/** Returns a list of exclusive filter flags, which cannot be combined with other flags (eg EqualTo/NotEqualTo)
|
||||
/** Returns a list of exclusive filter flags, which cannot be combined with other flags (e.g., EqualTo/NotEqualTo)
|
||||
* @note added in QGIS 2.16
|
||||
* @see nonExclusiveFilterFlags()
|
||||
*/
|
||||
static QList< QgsSearchWidgetWrapper::FilterFlag > exclusiveFilterFlags();
|
||||
|
||||
/** Returns a list of non-exclusive filter flags, which can be combined with other flags (eg CaseInsensitive)
|
||||
/** Returns a list of non-exclusive filter flags, which can be combined with other flags (e.g., CaseInsensitive)
|
||||
* @note added in QGIS 2.16
|
||||
* @see exclusiveFilterFlags()
|
||||
*/
|
||||
|
||||
@ -48,7 +48,7 @@ class QgsAttributeDialog : QDialog
|
||||
|
||||
/**
|
||||
* Toggles the form mode.
|
||||
* @param mode form mode. Eg if set to QgsAttributeForm::AddFeatureMode, the dialog will be editable even with an invalid feature and
|
||||
* @param mode form mode. For example, if set to QgsAttributeForm::AddFeatureMode, the dialog will be editable even with an invalid feature and
|
||||
* will add a new feature when the form is accepted.
|
||||
*/
|
||||
void setMode( QgsAttributeForm::Mode mode );
|
||||
|
||||
@ -42,7 +42,7 @@ class QgsAttributeFormEditorWidget : QWidget
|
||||
const QgsAttributeEditorContext &context = QgsAttributeEditorContext() );
|
||||
|
||||
/** Sets the current mode for the widget. The widget will adapt its state and visible widgets to
|
||||
* reflect the updated mode. Eg, showing multi edit tool buttons if the mode is set to MultiEditMode.
|
||||
* reflect the updated mode. For example, showing multi edit tool buttons if the mode is set to MultiEditMode.
|
||||
* @param mode widget mode
|
||||
* @see mode()
|
||||
*/
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/** \ingroup gui
|
||||
* \class QgsColorWidget
|
||||
* A base class for interactive color widgets. Widgets can either allow setting a single component of
|
||||
* a color (eg the red or green components), or an entire color. The QgsColorWidget also keeps track of
|
||||
* a color (e.g., the red or green components), or an entire color. The QgsColorWidget also keeps track of
|
||||
* any explicitly set hue for the color, so that this information is not lost when the widget is
|
||||
* set to a color with an ambiguous hue (eg black or white shades).
|
||||
* set to a color with an ambiguous hue (e.g., black or white shades).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
@ -112,7 +112,7 @@ class QgsColorWidget : QWidget
|
||||
int componentRange( const ColorComponent component ) const;
|
||||
|
||||
/** Returns the value of a component of the widget's current color. This method correctly
|
||||
* handles hue values when the color has an ambiguous hue (eg black or white shades)
|
||||
* handles hue values when the color has an ambiguous hue (e.g., black or white shades)
|
||||
* @param component color component to return
|
||||
* @returns value of color component, or -1 if widget has an invalid color set
|
||||
* @see hue
|
||||
@ -120,7 +120,7 @@ class QgsColorWidget : QWidget
|
||||
int componentValue( const ColorComponent component ) const;
|
||||
|
||||
/** Returns the hue for the widget. This may differ from the hue for the QColor returned by color(),
|
||||
* as QColor returns a hue of -1 if the color's hue is ambiguous (eg, if the saturation is zero).
|
||||
* as QColor returns a hue of -1 if the color's hue is ambiguous (e.g., if the saturation is zero).
|
||||
* @returns explicitly set hue for widget
|
||||
*/
|
||||
int hue() const;
|
||||
@ -288,7 +288,7 @@ class QgsColorBox : QgsColorWidget
|
||||
/** \ingroup gui
|
||||
* \class QgsColorRampWidget
|
||||
* A color ramp widget. This widget consists of an interactive box filled with a color which varies along
|
||||
* its length by a single color component (eg, varying saturation from 0 to 100%).
|
||||
* its length by a single color component (e.g., varying saturation from 0 to 100%).
|
||||
* \note Added in version 2.5
|
||||
*/
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ class QgsExpressionItem : QStandardItem
|
||||
*/
|
||||
void setHelpText( const QString& helpText );
|
||||
|
||||
/** Get the type of expression item eg header, field, ExpressionNode.
|
||||
/** Get the type of expression item, e.g., header, field, ExpressionNode.
|
||||
*
|
||||
* @return The QgsExpressionItem::ItemType
|
||||
*/
|
||||
|
||||
@ -90,7 +90,7 @@ class QgsPanelWidget : public QWidget
|
||||
* @note This argument is normally raised with emit panelAccepted(this)
|
||||
* so that callers can retrive the widget easier in calling code.
|
||||
* @note this is emitted only when this panel is accepted, and is not emitted for
|
||||
* child panels. Eg, if this panel opens a second stacked panel, then this panel
|
||||
* child panels. For example, if this panel opens a second stacked panel, then this panel
|
||||
* will not emit panelAccepted when the second panel is accepted.
|
||||
*/
|
||||
void panelAccepted( QgsPanelWidget* panel );
|
||||
|
||||
@ -18,7 +18,7 @@ class QgsShortcutsManager: QObject
|
||||
|
||||
/** Constructor for QgsShortcutsManager.
|
||||
* @param parent parent object
|
||||
* @param settingsRoot root QSettings path for storing settings, eg "/myplugin/shortcuts". Leave
|
||||
* @param settingsRoot root QSettings path for storing settings, e.g., "/myplugin/shortcuts". Leave
|
||||
* as the default value to store settings alongside built in QGIS shortcuts, but care must be
|
||||
* taken to not register actions which conflict with the built in QGIS actions.
|
||||
*/
|
||||
|
||||
@ -56,7 +56,7 @@ class QgsVariableEditorWidget : QWidget
|
||||
QgsExpressionContextScope* editableScope() const;
|
||||
|
||||
/** Sets the setting group for the widget. QgsVariableEditorWidget widgets with
|
||||
* the same setting group will synchronise their settings, eg the size
|
||||
* the same setting group will synchronise their settings, e.g., the size
|
||||
* of columns in the tree widget.
|
||||
* @param group setting group
|
||||
* @see settingGroup()
|
||||
@ -64,7 +64,7 @@ class QgsVariableEditorWidget : QWidget
|
||||
void setSettingGroup( const QString &group );
|
||||
|
||||
/** Returns the setting group for the widget. QgsVariableEditorWidget widgets with
|
||||
* the same setting group will synchronise their settings, eg the size
|
||||
* the same setting group will synchronise their settings, e.g., the size
|
||||
* of columns in the tree widget.
|
||||
* @returns setting group name
|
||||
* @see setSettingGroup()
|
||||
|
||||
@ -7,14 +7,14 @@ class QgsLayerPropertiesWidget : QgsPanelWidget, QgsExpressionContextGenerator
|
||||
public:
|
||||
QgsLayerPropertiesWidget( QgsSymbolLayer* layer, const QgsSymbol* symbol, const QgsVectorLayer* vl, QWidget* parent /TransferThis/ = NULL );
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
|
||||
@ -15,14 +15,14 @@ class QgsRendererWidget : QgsPanelWidget
|
||||
//! show a dialog with renderer's symbol level settings
|
||||
void showSymbolLevelsDialog( QgsFeatureRenderer* r );
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
@ -98,14 +98,14 @@ class QgsDataDefinedValueDialog : QDialog
|
||||
QgsDataDefinedValueDialog( const QList<QgsSymbol*>& symbolList, QgsVectorLayer * layer, const QString & label );
|
||||
virtual ~QgsDataDefinedValueDialog();
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
|
||||
@ -11,14 +11,14 @@ class QgsSymbolLayerWidget : QWidget
|
||||
virtual void setSymbolLayer( QgsSymbolLayer* layer ) = 0;
|
||||
virtual QgsSymbolLayer* symbolLayer() = 0;
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
|
||||
@ -10,14 +10,14 @@ class QgsSymbolSelectorWidget : QgsPanelWidget
|
||||
//! return menu for "advanced" button - create it if doesn't exist and show the advanced button
|
||||
QMenu* advancedMenu();
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
@ -89,14 +89,14 @@ class QgsSymbolSelectorDialog : QDialog
|
||||
//! return menu for "advanced" button - create it if doesn't exist and show the advanced button
|
||||
QMenu* advancedMenu();
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
|
||||
@ -6,14 +6,14 @@ class QgsSymbolsListWidget : QWidget
|
||||
public:
|
||||
QgsSymbolsListWidget( QgsSymbol* symbol, QgsStyle* style, QMenu* menu, QWidget* parent /TransferThis/ = 0, const QgsVectorLayer * layer = 0 );
|
||||
|
||||
/** Sets the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Sets the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @param context symbol widget context
|
||||
* @see context()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
void setContext( const QgsSymbolWidgetContext& context );
|
||||
|
||||
/** Returns the context in which the symbol widget is shown, eg the associated map canvas and expression contexts.
|
||||
/** Returns the context in which the symbol widget is shown, e.g., the associated map canvas and expression contexts.
|
||||
* @see setContext()
|
||||
* @note added in QGIS 3.0
|
||||
*/
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
|
||||
/** \ingroup gui
|
||||
* \class QgsSymbolWidgetContext
|
||||
* Contains settings which reflect the context in which a symbol (or renderer) widget is shown, eg the
|
||||
* Contains settings which reflect the context in which a symbol (or renderer) widget is shown, e.g., the
|
||||
* map canvas and relevant expression contexts.
|
||||
*
|
||||
* \note added in QGIS 3.0
|
||||
|
||||
@ -397,7 +397,7 @@ class DlgSqlLayerWindow(QWidget, Ui_Dialog):
|
||||
QApplication.restoreOverrideCursor()
|
||||
|
||||
def setColumnCombos(self, cols, quotedCols):
|
||||
# get sensible default columns. do this before sorting in case there's hints in the column order (eg, id is more likely to be first)
|
||||
# get sensible default columns. do this before sorting in case there's hints in the column order (e.g., id is more likely to be first)
|
||||
try:
|
||||
defaultGeomCol = next(col for col in cols if col in ['geom', 'geometry', 'the_geom', 'way'])
|
||||
except:
|
||||
|
||||
@ -333,7 +333,7 @@ class DlgSqlWindow(QWidget, Ui_Dialog):
|
||||
QApplication.restoreOverrideCursor()
|
||||
|
||||
def setColumnCombos(self, cols, quotedCols):
|
||||
# get sensible default columns. do this before sorting in case there's hints in the column order (eg, id is more likely to be first)
|
||||
# get sensible default columns. do this before sorting in case there's hints in the column order (e.g., id is more likely to be first)
|
||||
try:
|
||||
defaultGeomCol = next(col for col in cols if col in ['geom', 'geometry', 'the_geom', 'way'])
|
||||
except:
|
||||
|
||||
@ -190,9 +190,9 @@ qgis:extractnodes: >
|
||||
qgis:extractspecificnodes: >
|
||||
This algorithm takes a line or polygon layer and generates a point layer with points representing specific nodes in the input lines or polygons. For instance, this algorithm can be used to extract the first or last nodes in the geometry. The attributes associated to each point are the same ones associated to the line or polygon that the point belongs to.
|
||||
|
||||
The node indices parameter accepts a comma separated string specifying the indices of the nodes to extract. The first node corresponds to an index of 0, the second node has an index of 1, etc. Negative indices can be used to find nodes at the end of the geometry, eg an index of -1 corresponds to the last node, -2 corresponds to the second last node, etc.
|
||||
The node indices parameter accepts a comma separated string specifying the indices of the nodes to extract. The first node corresponds to an index of 0, the second node has an index of 1, etc. Negative indices can be used to find nodes at the end of the geometry, e.g., an index of -1 corresponds to the last node, -2 corresponds to the second last node, etc.
|
||||
|
||||
Additional fields are added to the nodes indicating the specific node position (eg 0, -1, etc), the original node index, distance along the original geometry and bisector angle of node for the original geometry.
|
||||
Additional fields are added to the nodes indicating the specific node position (e.g., 0, -1, etc), the original node index, distance along the original geometry and bisector angle of node for the original geometry.
|
||||
|
||||
qgis:fieldcalculator: >
|
||||
This algorithm computes a new vector layer with the same features of the input layer, but with an additional attribute. The values of this new attribute are computed from each feature using a mathematical formula, based on te properties and attributes of the feature.
|
||||
@ -501,7 +501,7 @@ qgis:smoothgeometry: >
|
||||
|
||||
The offset parameter controls how "tightly" the smoothed geometries follow the original geometries. Smaller values results in a tighter fit, and larger values will create a looser fit.
|
||||
|
||||
The maximum angle parameter can be used to prevent smoothing of nodes with large angles. Any node where the angle of the segments to either side is larger then this will not be smoothed. Eg setting the maximum angle to 90 degrees or lower would preserve right angles in the geometry.
|
||||
The maximum angle parameter can be used to prevent smoothing of nodes with large angles. Any node where the angle of the segments to either side is larger then this will not be smoothed. For example, setting the maximum angle to 90 degrees or lower would preserve right angles in the geometry.
|
||||
|
||||
qgis:snapgeometriestolayer: >
|
||||
This algorithm snaps the geometries in a layer to the geometries in another layer. A tolerance is specified in layer units to control how close vertices need to be to the reference layer geometries before they are snapped. Snapping occurs to both vertices and edges, but snapping to a vertex is preferred. Vertices will be inserted or removed as required to make the geometries match the reference geometries.
|
||||
|
||||
@ -166,9 +166,9 @@ are escaped.</p>
|
||||
<p>Regular expressions are mini-language used to represent character patterns. There are many variations
|
||||
of regular expression syntax - QGIS uses the syntax provided by the <a href="http://qt-project.org/doc/qt-4.8/qregexp.html">QRegExp</a> class of the <a href="http://qt.digia.com">Qt</a> framework.</p>
|
||||
<p>In a regular expression delimited file each line is treated as a record. Each match of the regular expression in the line is treated as the end of a field.
|
||||
If the regular expression contains capture groups (eg <tt>(cat|dog)</tt>)
|
||||
If the regular expression contains capture groups (e.g., <tt>(cat|dog)</tt>)
|
||||
then these are extracted as fields.
|
||||
If this is not desired then use non-capturing groups (eg <tt>(?:cat|dog)</tt>).
|
||||
If this is not desired then use non-capturing groups (e.g., <tt>(?:cat|dog)</tt>).
|
||||
</p>
|
||||
<p>The regular expression is treated differently if it is anchored to the start of the line (that is, the pattern starts with <tt>^</tt>).
|
||||
In this case the regular expression is matched against each line. If the line does not match it is discarded
|
||||
@ -190,12 +190,12 @@ The delimited text layer recognizes the following
|
||||
<a href="http://en.wikipedia.org/wiki/Well-known_text">well known text</a> types -
|
||||
<tt>POINT</tt>, <tt>MULTIPOINT</tt>, <tt>LINESTRING</tt>, <tt>MULTILINESTRING</tt>, <tt>POLYGON</tt>, and <tt>MULTIPOLYGON</tt>.
|
||||
It will accept geometries with
|
||||
a Z coordinate (eg <tt>POINT Z</tt>), a measure (<tt>POINT M</tt>), or both (<tt>POINT ZM</tt>).
|
||||
a Z coordinate (e.g., <tt>POINT Z</tt>), a measure (<tt>POINT M</tt>), or both (<tt>POINT ZM</tt>).
|
||||
</p>
|
||||
<p>
|
||||
It can also handle the PostGIS EWKT variation, in which the geometry is preceded by an spatial reference
|
||||
system id (eg <tt>SRID=4326;POINT(175.3 41.2)</tt>), and a variant used by Informix in which the WKT is
|
||||
preceded by an integer spatial reference id (eg <tt>1 POINT(175.3 41.2)</tt>).
|
||||
system id (e.g., <tt>SRID=4326;POINT(175.3 41.2)</tt>), and a variant used by Informix in which the WKT is
|
||||
preceded by an integer spatial reference id (e.g., <tt>1 POINT(175.3 41.2)</tt>).
|
||||
In both cases the SRID is ignored.
|
||||
</p>
|
||||
|
||||
|
||||
@ -2,5 +2,5 @@
|
||||
|
||||
The open vector layer dialog is used to add vector data to the QGIS map view. Vector data are spatial data described using geometries of points, lines and polygons (enclosed areas).</p>
|
||||
QGIS supports vector data in a number of formats, including those supported by the OGR library data provider plugin, such as ESRI shape files, MapInfo MIF (interchange format) and MapInfo TAB (native format).</p>
|
||||
QGIS supports PostGIS layers in a PostgreSQL database and SpatiaLite layers. Support for additional data types (eg. delimited text) is provided by additional data provider plugins. A list of OGR supported vector formats can be found in Appendix A.1 of the User Guide.</p>
|
||||
QGIS supports PostGIS layers in a PostgreSQL database and SpatiaLite layers. Support for additional data types (e.g., delimited text) is provided by additional data provider plugins. A list of OGR supported vector formats can be found in Appendix A.1 of the User Guide.</p>
|
||||
Detailed description how to proceed with vector data is described in chapter 5 'Working with Vector Data'.
|
||||
|
||||
@ -27,6 +27,6 @@ This dialog allows you to define the settings for a connection to a PostgreSQL/P
|
||||
|
||||
<li> <label>Also list tables with no geometry</label> Indicates that tables without geometry should also be listed by default.
|
||||
|
||||
<li> <label>Use estimated table metadata</label> When initializing layers, various queries may be needed to establish the characteristics of the geometries stored in the database table. When this option is checked, these queries examine only a sample of the rows and use the table statistics, rather than the entire table. This can drastically speed up operations on large datasets, but may result in incorrect characterization of layers (eg. the <font color="red">feature count</font> of filtered layers will not be accurately determined) and may even cause strange behaviour in case columns that are supposed to be unique actually are not.
|
||||
<li> <label>Use estimated table metadata</label> When initializing layers, various queries may be needed to establish the characteristics of the geometries stored in the database table. When this option is checked, these queries examine only a sample of the rows and use the table statistics, rather than the entire table. This can drastically speed up operations on large datasets, but may result in incorrect characterization of layers (e.g., the <font color="red">feature count</font> of filtered layers will not be accurately determined) and may even cause strange behaviour in case columns that are supposed to be unique actually are not.
|
||||
|
||||
</ul>
|
||||
|
||||
@ -14,7 +14,7 @@ are sometimes limited (e.g. for shape files) or behave diffently.
|
||||
<tr>
|
||||
<td>OGR</td>
|
||||
<td>where clauses depending on the
|
||||
<a href="http://www.gdal.org/ogr_formats.html">format</a> (eg.
|
||||
<a href="http://www.gdal.org/ogr_formats.html">format</a> (e.g.,
|
||||
<a href="http://www.gdal.org/ogr_sql.html">OGR SQL</a>
|
||||
for shape files)
|
||||
</td>
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "$area",
|
||||
"type": "function",
|
||||
"description": "Returns the area of the current feature. The area calculated by this function respects both the current project's ellipsoid setting and area unit settings. Eg, if an ellipsoid has been set for the project then the calculated area will be ellipsoidal, and if no ellipsoid is set then the calculated area will be planimetric.",
|
||||
"description": "Returns the area of the current feature. The area calculated by this function respects both the current project's ellipsoid setting and area unit settings. For example, if an ellipsoid has been set for the project then the calculated area will be ellipsoidal, and if no ellipsoid is set then the calculated area will be planimetric.",
|
||||
"examples": [ { "expression":"$area", "returns":"42"}]
|
||||
}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "$length",
|
||||
"type": "function",
|
||||
"description": "Returns the length of a linestring. If you need the length of a border of a polygon, use $perimeter instead. The length calculated by this function respects both the current project's ellipsoid setting and distance unit settings. Eg, if an ellipsoid has been set for the project then the calculated length will be ellipsoidal, and if no ellipsoid is set then the calculated length will be planimetric.",
|
||||
"description": "Returns the length of a linestring. If you need the length of a border of a polygon, use $perimeter instead. The length calculated by this function respects both the current project's ellipsoid setting and distance unit settings. For example, if an ellipsoid has been set for the project then the calculated length will be ellipsoidal, and if no ellipsoid is set then the calculated length will be planimetric.",
|
||||
"examples": [
|
||||
{ "expression":"$length", "returns":"42.4711"}
|
||||
]
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "$perimeter",
|
||||
"type": "function",
|
||||
"description": "Returns the perimeter length of the current feature. The perimeter calculated by this function respects both the current project's ellipsoid setting and distance unit settings. Eg, if an ellipsoid has been set for the project then the calculated perimeter will be ellipsoidal, and if no ellipsoid is set then the calculated perimeter will be planimetric.",
|
||||
"description": "Returns the perimeter length of the current feature. The perimeter calculated by this function respects both the current project's ellipsoid setting and distance unit settings. For example, if an ellipsoid has been set for the project then the calculated perimeter will be ellipsoidal, and if no ellipsoid is set then the calculated perimeter will be planimetric.",
|
||||
"examples": [ { "expression":"$perimeter", "returns":"42"}
|
||||
]
|
||||
}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "boundary",
|
||||
"type": "function",
|
||||
"description":"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. Some geometry types do not have a defined boundary, eg points or geometry collections, and will return null.",
|
||||
"description":"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. Some geometry types do not have a defined boundary, e.g., points or geometry collections, and will return null.",
|
||||
"arguments": [ {"arg":"geometry","description":"a geometry"} ],
|
||||
"examples": [ { "expression":"geom_to_wkt(boundary(geom_from_wkt('Polygon((1 1, 0 0, -1 1, 1 1))')))", "returns":"'LineString(1 1,0 0,-1 1,1 1)'"}]
|
||||
}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "color_part",
|
||||
"type": "function",
|
||||
"description": "Returns a specific component from a color string, eg the red component or alpha component.",
|
||||
"description": "Returns a specific component from a color string, e.g., the red component or alpha component.",
|
||||
"arguments": [
|
||||
{"arg":"color", "description":"a color string"},
|
||||
{"arg":"component", "description":"a string corresponding to the color component to return. Valid options are:<br /><ul><li>red: RGB red component (0-255)</li><li>green: RGB green component (0-255)</li><li>blue: RGB blue component (0-255)</li><li>alpha: alpha (transparency) value (0-255)</li><li>hue: HSV hue (0-360)</li><li>saturation: HSV saturation (0-100)</li><li>value: HSV value (0-100)</li><li>hsl_hue: HSL hue (0-360)</li><li>hsl_saturation: HSL saturation (0-100)</li><li>lightness: HSL lightness (0-100)</li><li>cyan: CMYK cyan component (0-100)</li><li>magenta: CMYK magenta component (0-100)</li><li>yellow: CMYK yellow component (0-100)</li> <li>black: CMYK black component (0-100)</li></ul>"}
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
"description": "Returns a matching layer property or metadata value.",
|
||||
"arguments": [
|
||||
{"arg":"layer", "description":"a string, representing either a layer name or layer ID"},
|
||||
{"arg":"property", "description":"a string corresponding to the property to return. Valid options are:<br /><ul><li>name: layer name</li><li>id: layer ID</li><li>title: metadata title string</li><li>abstract: metadata abstract string</li><li>keywords: metadata keywords</li><li>data_url: metadata URL</li><li>attribution: metadata attribution string</li><li>attribution_url: metadata attribution URL</li><li>source: layer source</li><li>min_scale: minimum display scale for layer</li><li>max_scale: maximum display scale for layer</li><li>crs: layer CRS</li><li>crs_definition: layer CRS full definition</li> <li>extent: layer extent (as a geometry object)</li><li>type: layer type, eg Vector or Raster</li><li>storage_type: storage format (vector layers only)</li><li>geometry_type: geometry type, eg Point (vector layers only)</li><li>feature_count: approximate feature count for layer (vector layers only)</li></ul>"}
|
||||
{"arg":"property", "description":"a string corresponding to the property to return. Valid options are:<br /><ul><li>name: layer name</li><li>id: layer ID</li><li>title: metadata title string</li><li>abstract: metadata abstract string</li><li>keywords: metadata keywords</li><li>data_url: metadata URL</li><li>attribution: metadata attribution string</li><li>attribution_url: metadata attribution URL</li><li>source: layer source</li><li>min_scale: minimum display scale for layer</li><li>max_scale: maximum display scale for layer</li><li>crs: layer CRS</li><li>crs_definition: layer CRS full definition</li> <li>extent: layer extent (as a geometry object)</li><li>type: layer type, e.g., Vector or Raster</li><li>storage_type: storage format (vector layers only)</li><li>geometry_type: geometry type, e.g., Point (vector layers only)</li><li>feature_count: approximate feature count for layer (vector layers only)</li></ul>"}
|
||||
],
|
||||
"examples": [
|
||||
{ "expression":"layer_property('streets','title')", "returns":"'Basemap Streets'"},
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "longest_common_substring",
|
||||
"type": "function",
|
||||
"description": "Returns the longest common substring between two strings. This substring is the longest string that is a substring of the two input strings. Eg, the longest common substring of \"ABABC\" and \"BABCA\" is \"ABC\". The substring is case sensitive.",
|
||||
"description": "Returns the longest common substring between two strings. This substring is the longest string that is a substring of the two input strings. For example, the longest common substring of \"ABABC\" and \"BABCA\" is \"ABC\". The substring is case sensitive.",
|
||||
"arguments": [
|
||||
{"arg":"string1","description":"a string"},
|
||||
{"arg":"string2","description":"a string"}
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"type": "function",
|
||||
"description": "Return the first matching position matching a regular expression within a string, or 0 if the substring is not found.",
|
||||
"arguments": [ {"arg":"input_string","description":"the string to test against the regular expression"},
|
||||
{"arg":"regex","description":"The regular expression to test against. Backslash characters must be double escaped (eg \"\\\\\\\\s\" to match a white space character)."}
|
||||
{"arg":"regex","description":"The regular expression to test against. Backslash characters must be double escaped (e.g., \"\\\\\\\\s\" to match a white space character)."}
|
||||
],
|
||||
"examples": [ { "expression":"regexp_match('QGIS ROCKS','\\\\\\\\sROCKS')", "returns":"4"}]
|
||||
}
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"type": "function",
|
||||
"description": "Returns a string with the supplied regular expression replaced.",
|
||||
"arguments": [ {"arg":"input_string","description":"the string to replace matches in"},
|
||||
{"arg":"regex","description":"The regular expression to replace. Backslash characters must be double escaped (eg \"\\\\\\\\s\" to match a white space character)."},
|
||||
{"arg":"regex","description":"The regular expression to replace. Backslash characters must be double escaped (e.g., \"\\\\\\\\s\" to match a white space character)."},
|
||||
{"arg":"replacement","description":"The string that will replace any matching occurrences of the supplied regular expression. Captured groups can be inserted into the replacement string using \\\\\\\\1, \\\\\\\\2, etc."}
|
||||
],
|
||||
"examples": [ { "expression":"regexp_replace('QGIS SHOULD ROCK','\\\\\\\\sSHOULD\\\\\\\\s',' DOES ')", "returns":"'QGIS DOES ROCK'"}]
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
"type": "function",
|
||||
"description": "Returns the portion of a string which matches a supplied regular expression.",
|
||||
"arguments": [ {"arg":"input_string","description":"the string to find matches in"},
|
||||
{"arg":"regex","description":"The regular expression to match against. Backslash characters must be double escaped (eg \"\\\\\\\\s\" to match a white space character)."}
|
||||
{"arg":"regex","description":"The regular expression to match against. Backslash characters must be double escaped (e.g., \"\\\\\\\\s\" to match a white space character)."}
|
||||
],
|
||||
"examples": [ { "expression":"regexp_substr('abc123','(\\\\\\\\d+)')", "returns":"'123'"}]
|
||||
}
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "set_color_part",
|
||||
"type": "function",
|
||||
"description": "Sets a specific color component for a color string, eg the red component or alpha component.",
|
||||
"description": "Sets a specific color component for a color string, e.g., the red component or alpha component.",
|
||||
"arguments": [
|
||||
{"arg":"color", "description":"a color string"},
|
||||
{"arg":"component", "description":"a string corresponding to the color component to set. Valid options are:<br /><ul><li>red: RGB red component (0-255)</li><li>green: RGB green component (0-255)</li><li>blue: RGB blue component (0-255)</li><li>alpha: alpha (transparency) value (0-255)</li><li>hue: HSV hue (0-360)</li><li>saturation: HSV saturation (0-100)</li><li>value: HSV value (0-100)</li><li>hsl_hue: HSL hue (0-360)</li><li>hsl_saturation: HSL saturation (0-100)</li><li>lightness: HSL lightness (0-100)</li><li>cyan: CMYK cyan component (0-100)</li><li>magenta: CMYK magenta component (0-100)</li><li>yellow: CMYK yellow component (0-100)</li> <li>black: CMYK black component (0-100)</li></ul>"},
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "simplify_vw",
|
||||
"type": "function",
|
||||
"description":"Simplifies a geometry by removing nodes using an area based threshold (ie, the Visvalingam-Whyatt algorithm). The algorithm removes vertices which create small areas in geometries, eg narrow spikes or nearly straight segments.",
|
||||
"description":"Simplifies a geometry by removing nodes using an area based threshold (ie, the Visvalingam-Whyatt algorithm). The algorithm removes vertices which create small areas in geometries, e.g., narrow spikes or nearly straight segments.",
|
||||
"arguments": [ {"arg":"geometry","description":"a geometry"},
|
||||
{"arg":"tolerance","description":"a measure of the maximum area created by a node for the node to be removed"} ],
|
||||
"examples": [ { "expression":"geom_to_wkt(simplify_vw(geometry:=geom_from_wkt('LineString(0 0, 5 0, 5.01 10, 5.02 0, 10 0)'),tolerance:=5))", "returns":"'LineString(0 0, 10 0)'"}]
|
||||
|
||||
@ -20,9 +20,9 @@ class FixUiimport(fixer_base.BaseFix):
|
||||
imp = results.get('imp')
|
||||
|
||||
if node.type == syms.import_from:
|
||||
# Some imps are top-level (eg: 'import ham')
|
||||
# some are first level (eg: 'import ham.eggs')
|
||||
# some are third level (eg: 'import ham.eggs as spam')
|
||||
# Some imps are top-level (e.g., 'import ham')
|
||||
# some are first level (e.g., 'import ham.eggs')
|
||||
# some are third level (e.g., 'import ham.eggs as spam')
|
||||
# Hence, the loop
|
||||
while not hasattr(imp, 'value'):
|
||||
imp = imp.children[0]
|
||||
|
||||
@ -55,7 +55,7 @@
|
||||
# DETAILS:
|
||||
#
|
||||
# The script creates an SQL plain text dump that can be imported into
|
||||
# SQlite db eg. using SQLite Database Browser's "Import > Database from
|
||||
# SQlite db e.g.,. using SQLite Database Browser's "Import > Database from
|
||||
# SQL file" tool.
|
||||
#
|
||||
# The ellipsoids (tbl_ellipsoid) and projections (tbl_projection) tables
|
||||
|
||||
@ -344,6 +344,7 @@ paramter:parameter
|
||||
paramters:parameters
|
||||
particularily:particularly
|
||||
pased:passed
|
||||
peference:preference
|
||||
peprocessor:preprocessor
|
||||
perfoming:performing
|
||||
permissons:permissions
|
||||
|
||||
@ -1128,7 +1128,7 @@ void QgsComposer::on_mActionAtlasPreview_triggered( bool checked )
|
||||
bool previewEnabled = mComposition->setAtlasMode( checked ? QgsComposition::PreviewAtlas : QgsComposition::AtlasOff );
|
||||
if ( !previewEnabled )
|
||||
{
|
||||
//something went wrong, eg, no matching features
|
||||
//something went wrong, e.g., no matching features
|
||||
QMessageBox::warning( nullptr, tr( "Enable atlas preview" ),
|
||||
tr( "No matching atlas features found!" ),
|
||||
QMessageBox::Ok,
|
||||
|
||||
@ -39,7 +39,7 @@ class QgsDataDefinedButton;
|
||||
// contains a child QgsPanelWidget, which breaks lots of assumptions made in QgsPanelWidget
|
||||
// and related classes).
|
||||
// So QgsComposerItemWidget HAS a QgsComposerConfigObject to handle these common tasks.
|
||||
// Specific item property widgets (eg QgsComposerMapWidget) should inherit from QgsComposerItemBaseWidget
|
||||
// Specific item property widgets (e.g., QgsComposerMapWidget) should inherit from QgsComposerItemBaseWidget
|
||||
// (which is a QgsPanelWidget) and also HAS a QgsComposerConfigObject, with protected methods
|
||||
// which are just proxied through to the QgsComposerConfigObject.
|
||||
// phew!
|
||||
@ -78,7 +78,7 @@ class QgsComposerConfigObject: public QObject
|
||||
//! Must be called when a data defined button changes
|
||||
void updateDataDefinedProperty();
|
||||
|
||||
//! Updates data defined buttons to reflect current state of atlas (eg coverage layer)
|
||||
//! Updates data defined buttons to reflect current state of atlas (e.g., coverage layer)
|
||||
void updateDataDefinedButtons();
|
||||
|
||||
private:
|
||||
|
||||
@ -285,7 +285,7 @@ void QgsSelectedFeature::deleteSelectedVertexes()
|
||||
|
||||
if ( res == QgsVectorLayer::EmptyGeometry )
|
||||
{
|
||||
//geometry has been cleared as a result of deleting vertices (eg not enough vertices left to leave a valid geometry),
|
||||
//geometry has been cleared as a result of deleting vertices (e.g., not enough vertices left to leave a valid geometry),
|
||||
//so nothing more to do
|
||||
QgsGeometry empty;
|
||||
geometryChanged( mFeatureId, empty );
|
||||
|
||||
@ -348,7 +348,7 @@ void QgsMeasureDialog::updateUi()
|
||||
QgsUnitTypes::unitType( mAreaUnits ) == QgsUnitTypes::Standard )
|
||||
{
|
||||
// only shown if both conditions are true:
|
||||
// - the display unit is a standard distance measurement (eg square feet)
|
||||
// - the display unit is a standard distance measurement (e.g., square feet)
|
||||
// - either the canvas units is also a standard distance OR we are using an ellipsoid (in which case the
|
||||
// value will be in square meters)
|
||||
toolTip += "<br> * " + tr( "The value is converted from %1 to %2." ).arg( QgsUnitTypes::toString( resultUnit ),
|
||||
@ -422,7 +422,7 @@ void QgsMeasureDialog::updateUi()
|
||||
QgsUnitTypes::unitType( mDistanceUnits ) == QgsUnitTypes::Standard )
|
||||
{
|
||||
// only shown if both conditions are true:
|
||||
// - the display unit is a standard distance measurement (eg feet)
|
||||
// - the display unit is a standard distance measurement (e.g., feet)
|
||||
// - either the canvas units is also a standard distance OR we are using an ellipsoid (in which case the
|
||||
// value will be in meters)
|
||||
toolTip += "<br> * " + tr( "The value is converted from %1 to %2." ).arg( QgsUnitTypes::toString( resultUnit ),
|
||||
|
||||
@ -47,7 +47,7 @@ class APP_EXPORT QgsMergeAttributesDialog: public QDialog, private Ui::QgsMergeA
|
||||
|
||||
QgsAttributes mergedAttributes() const;
|
||||
|
||||
/** Returns a list of attribute indexes which should be skipped when merging (eg, attributes
|
||||
/** Returns a list of attribute indexes which should be skipped when merging (e.g., attributes
|
||||
* which have been set to "skip"
|
||||
*/
|
||||
QSet<int> skippedAttributeIndexes() const;
|
||||
|
||||
@ -101,7 +101,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
|
||||
*/
|
||||
ContentSource source() const { return mSource; }
|
||||
|
||||
/** Returns the source layer for the table, considering the table source mode. Eg,
|
||||
/** Returns the source layer for the table, considering the table source mode. For example,
|
||||
* 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.
|
||||
|
||||
@ -375,7 +375,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
*/
|
||||
void setTransparency( const int transparency );
|
||||
|
||||
/** Returns whether effects (eg blend modes) are enabled for the item
|
||||
/** Returns whether effects (e.g., blend modes) are enabled for the item
|
||||
* @returns true if effects are enabled
|
||||
* @see setEffectsEnabled
|
||||
* @see transparency
|
||||
@ -383,7 +383,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
*/
|
||||
bool effectsEnabled() const { return mEffectsEnabled; }
|
||||
|
||||
/** Sets whether effects (eg blend modes) are enabled for the item
|
||||
/** Sets whether effects (e.g., blend modes) are enabled for the item
|
||||
* @param effectsEnabled set to true to enable effects
|
||||
* @see effectsEnabled
|
||||
* @see setTransparency
|
||||
@ -467,7 +467,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
|
||||
/** Sets visibility for item.
|
||||
* @param visible set to true to show item, false to hide item
|
||||
* @note QGraphicsItem::setVisible should not be called directly
|
||||
* on a QgsComposerItem, as some item types (eg groups) need to override
|
||||
* on a QgsComposerItem, as some item types (e.g., groups) need to override
|
||||
* the visibility toggle.
|
||||
* @note added in version 2.5
|
||||
*/
|
||||
|
||||
@ -218,7 +218,7 @@ QgsMapSettings QgsComposerMap::mapSettings( const QgsRectangle& extent, QSizeF s
|
||||
const int layerIdx = mCurrentExportLayer - ( hasBackground() ? 1 : 0 );
|
||||
if ( layerIdx >= 0 && layerIdx < layers.length() )
|
||||
{
|
||||
// exporting with separate layers (eg, to svg layers), so we only want to render a single map layer
|
||||
// exporting with separate layers (e.g., to svg layers), so we only want to render a single map layer
|
||||
QgsMapLayer* ml = layers[ layers.length() - layerIdx - 1 ];
|
||||
layers.clear();
|
||||
layers << ml;
|
||||
|
||||
@ -1426,7 +1426,7 @@ QString QgsComposerMapGrid::gridAnnotationString( double value, QgsComposerMapGr
|
||||
if ( geographic && coord == QgsComposerMapGrid::Longitude &&
|
||||
( mGridAnnotationFormat == QgsComposerMapGrid::Decimal || mGridAnnotationFormat == QgsComposerMapGrid::DecimalWithSuffix ) )
|
||||
{
|
||||
// wrap around longitudes > 180 or < -180 degrees, so that eg "190E" -> "170W"
|
||||
// wrap around longitudes > 180 or < -180 degrees, so that, e.g., "190E" -> "170W"
|
||||
double wrappedX = fmod( value, 360.0 );
|
||||
if ( wrappedX > 180.0 )
|
||||
{
|
||||
@ -1449,7 +1449,7 @@ QString QgsComposerMapGrid::gridAnnotationString( double value, QgsComposerMapGr
|
||||
double coordRounded = qRound( value * pow( 10.0, mGridAnnotationPrecision ) ) / pow( 10.0, mGridAnnotationPrecision );
|
||||
if ( coord == QgsComposerMapGrid::Longitude )
|
||||
{
|
||||
//don't use E/W suffixes if ambiguous (eg 180 degrees)
|
||||
//don't use E/W suffixes if ambiguous (e.g., 180 degrees)
|
||||
if ( !geographic || ( coordRounded != 180.0 && coordRounded != 0.0 ) )
|
||||
{
|
||||
hemisphere = value < 0 ? QObject::tr( "W" ) : QObject::tr( "E" );
|
||||
@ -1457,7 +1457,7 @@ QString QgsComposerMapGrid::gridAnnotationString( double value, QgsComposerMapGr
|
||||
}
|
||||
else
|
||||
{
|
||||
//don't use N/S suffixes if ambiguous (eg 0 degrees)
|
||||
//don't use N/S suffixes if ambiguous (e.g., 0 degrees)
|
||||
if ( !geographic || coordRounded != 0.0 )
|
||||
{
|
||||
hemisphere = value < 0 ? QObject::tr( "S" ) : QObject::tr( "N" );
|
||||
|
||||
@ -23,7 +23,7 @@ class QgsComposerMap;
|
||||
|
||||
/** \ingroup core
|
||||
* \class QgsComposerMapItem
|
||||
* \brief An item which is drawn inside a QgsComposerMap, eg a grid or map overview.
|
||||
* \brief An item which is drawn inside a QgsComposerMap, e.g., a grid or map overview.
|
||||
*/
|
||||
class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
|
||||
{
|
||||
|
||||
@ -537,7 +537,7 @@ void QgsComposerModel::removeItem( QgsComposerItem * item )
|
||||
QModelIndex itemIndex = indexForItem( item );
|
||||
if ( !itemIndex.isValid() )
|
||||
{
|
||||
//removing an item not in the scene (eg, deleted item)
|
||||
//removing an item not in the scene (e.g., deleted item)
|
||||
//we need to remove it from the list, but don't need to call
|
||||
//beginRemoveRows or endRemoveRows since the item was not used by the model
|
||||
mItemZList.removeAt( pos );
|
||||
|
||||
@ -643,7 +643,7 @@ void QgsComposerMouseHandles::mouseReleaseEvent( QGraphicsSceneMouseEvent* event
|
||||
{
|
||||
if (( *itemIter )->positionLock() || (( *itemIter )->flags() & QGraphicsItem::ItemIsSelectable ) == 0 )
|
||||
{
|
||||
//don't resize locked items or unselectable items (eg, items which make up an item group)
|
||||
//don't resize locked items or unselectable items (e.g., items which make up an item group)
|
||||
continue;
|
||||
}
|
||||
QgsComposerItemCommand* subcommand = new QgsComposerItemCommand( *itemIter, QLatin1String( "" ), parentCommand );
|
||||
@ -1078,7 +1078,7 @@ void QgsComposerMouseHandles::resizeMouseMove( QPointF currentPosition, bool loc
|
||||
itemTransform.translate( sceneTranslate.x(), sceneTranslate.y() );
|
||||
setTransform( itemTransform );
|
||||
|
||||
//handle non-normalised resizes - eg, dragging the left handle so far to the right that it's past the right handle
|
||||
//handle non-normalised resizes - e.g., dragging the left handle so far to the right that it's past the right handle
|
||||
if ( mBeginHandleWidth + rx >= 0 && mBeginHandleHeight + ry >= 0 )
|
||||
{
|
||||
mResizeRect = QRectF( 0, 0, mBeginHandleWidth + rx, mBeginHandleHeight + ry );
|
||||
|
||||
@ -214,7 +214,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
|
||||
|
||||
/** Creates a new frame and adds it to the multi frame and composition.
|
||||
* @param currentFrame an existing QgsComposerFrame from which to copy the size
|
||||
* and general frame properties (eg frame style, background, rendering settings).
|
||||
* 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
|
||||
|
||||
@ -342,7 +342,7 @@ void QgsComposerTableV2::render( QPainter *p, const QRectF &, const int frameInd
|
||||
mComposition->plotStyle() == QgsComposition::Postscript )
|
||||
{
|
||||
//exporting composition, so force an attribute refresh
|
||||
//we do this in case vector layer has changed via an external source (eg, another database user)
|
||||
//we do this in case vector layer has changed via an external source (e.g., another database user)
|
||||
refreshAttributes();
|
||||
}
|
||||
|
||||
|
||||
@ -2830,7 +2830,7 @@ void QgsComposition::georeferenceOutput( const QString& file, QgsComposerMap* ma
|
||||
{
|
||||
GDALSetGeoTransform( outputDS, t );
|
||||
#if 0
|
||||
//TODO - metadata can be set here, eg:
|
||||
//TODO - metadata can be set here, e.g.:
|
||||
GDALSetMetadataItem( outputDS, "AUTHOR", "me", nullptr );
|
||||
#endif
|
||||
GDALSetProjection( outputDS, mMapSettings.destinationCrs().toWkt().toLocal8Bit().constData() );
|
||||
|
||||
@ -798,7 +798,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
|
||||
/** Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles.
|
||||
* @param ignorePages set to true to ignore page items
|
||||
* @param margin optional marginal (in percent, eg 0.05 = 5% ) to add around items
|
||||
* @param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items
|
||||
*/
|
||||
QRectF compositionBounds( bool ignorePages = false, double margin = 0.0 ) const;
|
||||
|
||||
@ -940,7 +940,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
|
||||
//! Loads default composer settings
|
||||
void loadDefaults();
|
||||
|
||||
//! Loads composer settings which may change, eg grid color
|
||||
//! Loads composer settings which may change, e.g., grid color
|
||||
void loadSettings();
|
||||
|
||||
//! Calculates the item minimum position from an xml string
|
||||
|
||||
@ -24,7 +24,7 @@
|
||||
|
||||
/** \ingroup core
|
||||
* \class QgsColorEffect
|
||||
* \brief A paint effect which alters the colors (eg brightness, contrast) in a
|
||||
* \brief A paint effect which alters the colors (e.g., brightness, contrast) in a
|
||||
* source picture.
|
||||
*
|
||||
* \note Added in version 2.9
|
||||
|
||||
@ -392,7 +392,7 @@ class CORE_EXPORT QgsAbstractGeometry
|
||||
*/
|
||||
virtual QgsRectangle calculateBoundingBox() const;
|
||||
|
||||
/** Clears any cached parameters associated with the geometry, eg bounding boxes
|
||||
/** Clears any cached parameters associated with the geometry, e.g., bounding boxes
|
||||
*/
|
||||
virtual void clearCache() const {}
|
||||
|
||||
|
||||
@ -604,7 +604,7 @@ class CORE_EXPORT QgsGeometry
|
||||
|
||||
/**
|
||||
* Returns a point guaranteed to lie on the surface of a geometry. While the centroid()
|
||||
* of a geometry may be located outside of the geometry itself (eg for concave shapes),
|
||||
* of a geometry may be located outside of the geometry itself (e.g., for concave shapes),
|
||||
* the point on surface will always be inside the geometry.
|
||||
* @see centroid()
|
||||
* @see poleOfInaccessibility()
|
||||
@ -946,8 +946,8 @@ class CORE_EXPORT QgsGeometry
|
||||
* roughly doubles the number of vertices in a geometry.
|
||||
* @param iterations number of smoothing iterations to run. More iterations results
|
||||
* in a smoother geometry
|
||||
* @param offset fraction of line to create new vertices along, between 0 and 1.0
|
||||
* eg the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* @param offset fraction of line to create new vertices along, between 0 and 1.0,
|
||||
* e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* of the geometry for each iteration. Smaller values result in "tighter" smoothing.
|
||||
* @param minimumDistance minimum segment length to apply smoothing to
|
||||
* @param maxAngle maximum angle at node (0-180) at which smoothing will be applied
|
||||
@ -1004,8 +1004,8 @@ class CORE_EXPORT QgsGeometry
|
||||
* @param line line to smooth
|
||||
* @param iterations number of smoothing iterations to run. More iterations results
|
||||
* in a smoother geometry
|
||||
* @param offset fraction of line to create new vertices along, between 0 and 1.0
|
||||
* eg the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* @param offset fraction of line to create new vertices along, between 0 and 1.0,
|
||||
* e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* of the geometry for each iteration. Smaller values result in "tighter" smoothing.
|
||||
* @param minimumDistance minimum segment length to apply smoothing to
|
||||
* @param maxAngle maximum angle at node (0-180) at which smoothing will be applied
|
||||
@ -1017,8 +1017,8 @@ class CORE_EXPORT QgsGeometry
|
||||
* @param polygon polygon to smooth
|
||||
* @param iterations number of smoothing iterations to run. More iterations results
|
||||
* in a smoother geometry
|
||||
* @param offset fraction of segment to create new vertices along, between 0 and 1.0
|
||||
* eg the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* @param offset fraction of segment to create new vertices along, between 0 and 1.0,
|
||||
* e.g., the default value of 0.25 will create new vertices 25% and 75% along each line segment
|
||||
* of the geometry for each iteration. Smaller values result in "tighter" smoothing.
|
||||
* @param minimumDistance minimum segment length to apply smoothing to
|
||||
* @param maxAngle maximum angle at node (0-180) at which smoothing will be applied
|
||||
|
||||
@ -239,7 +239,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 childen
|
||||
* @returns list of WKT child block strings, eg 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))")
|
||||
*/
|
||||
static QStringList wktGetChildBlocks( const QString& wkt , const QString &defaultType = "" );
|
||||
|
||||
|
||||
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