diff --git a/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in b/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in index 75b67dfc977a..6a75b191bb83 100644 --- a/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in +++ b/python/3d/auto_generated/materials/qgsphongtexturedmaterialsettings.sip.in @@ -81,7 +81,7 @@ If the texture scale is less than 1 the texture will be stretched bool requiresTextureCoordinates() const; %Docstring -Returns true if the material requires texture coordinates to be generated +Returns ``True`` if the material requires texture coordinates to be generated during triangulation.quiresTextureCoordinates %End diff --git a/python/analysis/auto_generated/raster/qgsrelief.sip.in b/python/analysis/auto_generated/raster/qgsrelief.sip.in index d2b9dd13b5c9..509331f2b847 100644 --- a/python/analysis/auto_generated/raster/qgsrelief.sip.in +++ b/python/analysis/auto_generated/raster/qgsrelief.sip.in @@ -53,7 +53,7 @@ Starts the calculation, reads from mInputFile and stores the result in mOutputFi %Docstring Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression -:return: true in case of success +:return: ``True`` in case of success %End bool exportFrequencyDistributionToCsv( const QString &file ); diff --git a/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in b/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in index d9001323043d..06787d74b3af 100644 --- a/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in +++ b/python/core/auto_generated/classification/qgsclassificationmethodregistry.sip.in @@ -33,7 +33,7 @@ QgsClassificationMethodRegistry is not usually directly created, but rather acce bool addMethod( QgsClassificationMethod *method /Transfer/ ); %Docstring Adds a method to the registry -Returns false if a method with same id already exists. +Returns ``False`` if a method with same id already exists. %End QgsClassificationMethod *method( const QString &id ) /Factory/; diff --git a/python/core/auto_generated/geometry/qgsgeometry.sip.in b/python/core/auto_generated/geometry/qgsgeometry.sip.in index cf128a4908d7..98554fce3af8 100644 --- a/python/core/auto_generated/geometry/qgsgeometry.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometry.sip.in @@ -849,7 +849,7 @@ Splits this geometry according to a given line. \param[out] newGeometries list of new geometries that have been created with the split :param topological: ``True`` if topological editing is enabled \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset -:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts +:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts :return: OperationResult a result code: success or reason of failure @@ -865,7 +865,7 @@ Splits this geometry according to a given line. \param[out] newGeometries list of new geometries that have been created with the ``splitLine``. If the geometry is 3D, a linear interpolation of the z value is performed on the geometry at split points, see example. :param topological: ``True`` if topological editing is enabled \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset -:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts +:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts fix this bug? :return: OperationResult a result code: success or reason of failure @@ -889,7 +889,7 @@ Splits this geometry according to a given curve. :param preserveCircular: whether if circular strings are preserved after splitting :param topological: ``True`` if topological editing is enabled \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset -:param splitFeature: Set to True if you want to split a feature, otherwise set to False to split parts +:param splitFeature: Set to ``True`` if you want to split a feature, otherwise set to ``False`` to split parts :return: OperationResult a result code: success or reason of failure diff --git a/python/core/auto_generated/geometry/qgsgeometryengine.sip.in b/python/core/auto_generated/geometry/qgsgeometryengine.sip.in index e1ef5835423a..2ecb1739df18 100644 --- a/python/core/auto_generated/geometry/qgsgeometryengine.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryengine.sip.in @@ -210,7 +210,7 @@ pattern. virtual bool isValid( QString *errorMsg = 0, bool allowSelfTouchingHoles = false, QgsGeometry *errorLoc = 0 ) const = 0; %Docstring -Returns true if the geometry is valid. +Returns ``True`` if the geometry is valid. If the geometry is invalid, ``errorMsg`` will be filled with the reported geometry error. diff --git a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in index 416f1b998caa..396c66fba7e9 100644 --- a/python/core/auto_generated/geometry/qgsgeometryutils.sip.in +++ b/python/core/auto_generated/geometry/qgsgeometryutils.sip.in @@ -111,7 +111,7 @@ Compute the intersection between two segments :param q1: Second segment start point :param q2: Second segment end point :param tolerance: The tolerance to use -:param acceptImproperIntersection: By default, this method returns true only if segments have proper intersection. If set true, returns also ``True`` if segments have improper intersection (end of one segment on other segment ; continuous segments). +:param acceptImproperIntersection: By default, this method returns ``True`` only if segments have proper intersection. If set true, returns also ``True`` if segments have improper intersection (end of one segment on other segment ; continuous segments). :return: - Whether the segments intersect - intersectionPoint: Output parameter, the intersection point @@ -360,7 +360,7 @@ Convert circular arc defined by p1, p2, p3 (p1/p3 being start resp. end point, p static bool pointContinuesArc( const QgsPoint &a1, const QgsPoint &a2, const QgsPoint &a3, const QgsPoint &b, double distanceTolerance, double pointSpacingAngleTolerance ) /HoldGIL/; %Docstring -Returns true if point ``b`` is on the arc formed by points ``a1``, ``a2``, and ``a3``, but not within +Returns ``True`` if point ``b`` is on the arc formed by points ``a1``, ``a2``, and ``a3``, but not within that arc portion already described by ``a1``, ``a2`` and ``a3``. The ``distanceTolerance`` specifies the maximum deviation allowed between the original location diff --git a/python/core/auto_generated/layertree/qgslayertreelayer.sip.in b/python/core/auto_generated/layertree/qgslayertreelayer.sip.in index c81cff75fb7f..8a49d1309496 100644 --- a/python/core/auto_generated/layertree/qgslayertreelayer.sip.in +++ b/python/core/auto_generated/layertree/qgslayertreelayer.sip.in @@ -80,8 +80,8 @@ Sets the layer's name. void setUseLayerName( bool use = true ); %Docstring -Uses the layer's name if ``use`` is true, or the name manually set if -false. +Uses the layer's name if ``use`` is ``True``, or the name manually set if +``False``. .. versionadded:: 3.8 %End diff --git a/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in b/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in index cf35ff440a39..5971524eb60f 100644 --- a/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in +++ b/python/core/auto_generated/layout/qgslayoutitemnodeitem.sip.in @@ -44,7 +44,7 @@ Add a node in current shape. :param point: is the location of the new node (in scene coordinates) :param checkArea: is a flag to indicate if there's a space constraint. :param radius: is the space contraint and is used only if checkArea is - true. Typically, if this flag is ``True``, the new node has to be nearer + ``True``. Typically, if this flag is ``True``, the new node has to be nearer than radius to the shape to be added. %End diff --git a/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in b/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in index 2ff50997a0af..c9a9ab3eab0b 100644 --- a/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in +++ b/python/core/auto_generated/mesh/qgsmesh3daveraging.sip.in @@ -138,8 +138,8 @@ Constructs multi level averaging method :param startLevel: starting vertical level index numbered from 1 :param endLevel: ending vertical level index numbered from 1 (higher or equal than startLevel) -:param countedFromTop: if true, the startLevel index is counted from surface (index 1 is the top layer). - if false, the startLevel index is counted from the bed level (index 1 is the bottom layer) +:param countedFromTop: if ``True``, the startLevel index is counted from surface (index 1 is the top layer). + if ``False``, the startLevel index is counted from the bed level (index 1 is the bottom layer) %End QgsMeshMultiLevelsAveragingMethod( int verticalLevel, bool countedFromTop ); @@ -147,8 +147,8 @@ Constructs multi level averaging method Constructs single level averaging method :param verticalLevel: vertical level index numbered from 1 -:param countedFromTop: if true, the startLevel index is counted from surface (index 1 is the top layer). - if false, the startLevel index is counted from the bed level (index 1 is the bottom layer) +:param countedFromTop: if ``True``, the startLevel index is counted from surface (index 1 is the top layer). + if ``False``, the startLevel index is counted from the bed level (index 1 is the bottom layer) %End ~QgsMeshMultiLevelsAveragingMethod(); @@ -284,8 +284,8 @@ Constructs the depth/height averaging method :param startHeight: starting depth/height, higher or equal than 0 :param endHeight: ending depth/height, higher or equal than startDepth -:param countedFromTop: if true, the startLength and endLength is relative to surface (0 is surface level). - if false, the startLength and endLength is relative to bed (0 is bed level). +:param countedFromTop: if ``True``, the startLength and endLength is relative to surface (0 is surface level). + if ``False``, the startLength and endLength is relative to bed (0 is bed level). %End ~QgsMeshRelativeHeightAveragingMethod(); diff --git a/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in b/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in index 4b4f7eeb947a..a518812afbee 100644 --- a/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in +++ b/python/core/auto_generated/mesh/qgsmeshdataprovider.sip.in @@ -77,7 +77,7 @@ Remove all vertices, edges and faces static bool compareFaces( const QgsMeshFace &face1, const QgsMeshFace &face2 ); %Docstring -Compare two faces, return true if they are equivalent : same indexes and same clock wise +Compare two faces, return ``True`` if they are equivalent : same indexes and same clock wise .. versionadded:: 3.16 %End diff --git a/python/core/auto_generated/mesh/qgsmeshdataset.sip.in b/python/core/auto_generated/mesh/qgsmeshdataset.sip.in index 318196cf3ddb..b80cb1057183 100644 --- a/python/core/auto_generated/mesh/qgsmeshdataset.sip.in +++ b/python/core/auto_generated/mesh/qgsmeshdataset.sip.in @@ -194,7 +194,7 @@ Sets active flag values. If the data provider/datasets does not have active flag capability (== all values are valid), just -set block validity by setValid( true ) +set block validity by setValid( ``True`` ) :param vals: value vector with size :py:func:`~QgsMeshDataBlock.count` diff --git a/python/core/auto_generated/qgsmaplayer.sip.in b/python/core/auto_generated/qgsmaplayer.sip.in index 06ee650fcd80..6b649b3eda9f 100644 --- a/python/core/auto_generated/qgsmaplayer.sip.in +++ b/python/core/auto_generated/qgsmaplayer.sip.in @@ -1725,7 +1725,7 @@ Sets error message bool hasDependencyCycle( const QSet & ) const; %Docstring Checks whether a new set of dependencies will introduce a cycle -this method is now deprecated and always return false, because circular dependencies are now correctly managed. +this method is now deprecated and always return ``False``, because circular dependencies are now correctly managed. .. deprecated:: QGIS 3.10 %End diff --git a/python/core/auto_generated/qgspointlocator.sip.in b/python/core/auto_generated/qgspointlocator.sip.in index c4606f8e3fe4..a6a7c0123c5e 100644 --- a/python/core/auto_generated/qgspointlocator.sip.in +++ b/python/core/auto_generated/qgspointlocator.sip.in @@ -110,7 +110,7 @@ This method is either blocking or non blocking according to ``relaxed`` paramete in the constructor. if ``True``, index building will be done in another thread and :py:func:`~QgsPointLocator.init` method returns immediately. :py:func:`~QgsPointLocator.initFinished` signal will be emitted once the initialization is over. -Returns false if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise true +Returns ``False`` if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise ``True`` .. seealso:: :py:class:`QgsPointLocator` %End diff --git a/python/core/auto_generated/qgsproperty.sip.in b/python/core/auto_generated/qgsproperty.sip.in index abf310eaf80c..77b11a3a5d15 100644 --- a/python/core/auto_generated/qgsproperty.sip.in +++ b/python/core/auto_generated/qgsproperty.sip.in @@ -315,7 +315,7 @@ expression context. .. note:: - The optional argument ignoreContext has been added in QGIS 3.14. When set to true, + The optional argument ignoreContext has been added in QGIS 3.14. When set to ``True``, even fields not set in context's :py:func:`~QgsProperty.fields` will be reported - this is useful e.g. with vector tiles where the actual available field names may not be known beforehand. %End diff --git a/python/core/auto_generated/qgspropertycollection.sip.in b/python/core/auto_generated/qgspropertycollection.sip.in index 343cb2179ca5..59aeb66c89c6 100644 --- a/python/core/auto_generated/qgspropertycollection.sip.in +++ b/python/core/auto_generated/qgspropertycollection.sip.in @@ -276,7 +276,7 @@ Returns ``True`` if preparation was successful. Returns the set of any fields referenced by the active properties from the collection. :param context: expression context the properties will be evaluated against. -:param ignoreContext: This parameter has been added in QGIS 3.14. When set to true, even fields not set +:param ignoreContext: This parameter has been added in QGIS 3.14. When set to ``True``, even fields not set in context's :py:func:`~QgsAbstractPropertyCollection.fields` will be reported - this is useful e.g. with vector tiles where the actual available field names may not be known beforehand. %End @@ -588,7 +588,7 @@ Returns the calculated value of the highest priority property with the specified Returns the set of any fields referenced by the active properties from the stack. :param context: expression context the properties will be evaluated against. -:param ignoreContext: This parameter has been added in QGIS 3.14. When set to true, even fields not set +:param ignoreContext: This parameter has been added in QGIS 3.14. When set to ``True``, even fields not set in context's :py:func:`~QgsPropertyCollectionStack.fields` will be reported - this is useful e.g. with vector tiles where the actual available field names may not be known beforehand. %End diff --git a/python/core/auto_generated/qgsprovidermetadata.sip.in b/python/core/auto_generated/qgsprovidermetadata.sip.in index 15eecb228121..823da83ace73 100644 --- a/python/core/auto_generated/qgsprovidermetadata.sip.in +++ b/python/core/auto_generated/qgsprovidermetadata.sip.in @@ -197,7 +197,7 @@ Class factory to return a pointer to a newly created QgsDataProvider object static void setBoolParameter( QVariantMap &uri, const QString ¶meter, const QVariant &value ); %Docstring Sets the ``value`` into the ``uri`` ``parameter`` as a bool. -eg. "yes" value will be saved as true, 0 will be saved as false +eg. "yes" value will be saved as ``True``, 0 will be saved as ``False`` .. versionadded:: 3.14 %End @@ -205,7 +205,7 @@ eg. "yes" value will be saved as true, 0 will be saved as false static bool boolParameter( const QVariantMap &uri, const QString ¶meter, bool defaultValue = false ); %Docstring Returns the ``parameter`` value in the ``uri`` as a bool. -eg. "yes" value will be returned as true, 0 will be returned as false +eg. "yes" value will be returned as ``True``, 0 will be returned as ``False`` .. versionadded:: 3.14 %End diff --git a/python/core/auto_generated/qgsstringutils.sip.in b/python/core/auto_generated/qgsstringutils.sip.in index 478f679e3095..738aa322d3db 100644 --- a/python/core/auto_generated/qgsstringutils.sip.in +++ b/python/core/auto_generated/qgsstringutils.sip.in @@ -285,7 +285,7 @@ links. Automatically wraps a ``string`` by inserting new line characters at appropriate locations in the string. The ``length`` argument specifies either the minimum or maximum length of lines desired, depending -on whether ``useMaxLineLength`` is true. If ``useMaxLineLength`` is ``True``, then the string will be wrapped +on whether ``useMaxLineLength`` is ``True``. If ``useMaxLineLength`` is ``True``, then the string will be wrapped so that each line ideally will not exceed ``length`` of characters. If ``useMaxLineLength`` is ``False``, then the string will be wrapped so that each line will ideally exceed ``length`` of characters. diff --git a/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in b/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in index f69913984d04..62ac04fb7396 100644 --- a/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in +++ b/python/core/auto_generated/qgsvectorlayereditbuffer.sip.in @@ -32,7 +32,7 @@ Adds a feature :param f: feature to add -:return: ``True`` in case of success and False in case of error +:return: ``True`` in case of success and ``False`` in case of error %End virtual bool addFeatures( QgsFeatureList &features ); diff --git a/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in b/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in index b906c7e05b55..e868432ffdf2 100644 --- a/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in +++ b/python/core/auto_generated/qgsvectorlayerjoinbuffer.sip.in @@ -39,7 +39,7 @@ Joins another vector layer to this layer %Docstring Removes a vector layer join -:return: true if join was found and successfully removed +:return: ``True`` if join was found and successfully removed %End void updateFields( QgsFields &fields ); diff --git a/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in b/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in index db0488f4cfda..eec09f315566 100644 --- a/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in +++ b/python/core/auto_generated/qgsvectorlayerjoininfo.sip.in @@ -81,7 +81,7 @@ Sets whether values from the joined layer should be cached in memory to speed up bool isUsingMemoryCache() const; %Docstring Returns whether values from the joined layer should be cached in memory to speed up lookups. -Will return false if upsertOnEdit is enabled. +Will return ``False`` if upsertOnEdit is enabled. %End bool isDynamicFormEnabled() const; diff --git a/python/core/auto_generated/qgsvectorlayertools.sip.in b/python/core/auto_generated/qgsvectorlayertools.sip.in index f8956c85ee97..7f040a8808db 100644 --- a/python/core/auto_generated/qgsvectorlayertools.sip.in +++ b/python/core/auto_generated/qgsvectorlayertools.sip.in @@ -83,7 +83,7 @@ Copy and move features with defined translation. :param request: The request for the features to be moved. It will be assigned to a new feature request with the newly copied features. :param dx: The translation on x :param dy: The translation on y -:param topologicalEditing: If true, the function will perform topological +:param topologicalEditing: If ``True``, the function will perform topological editing of the vertices of ``layer`` on ``layer`` and ``topologicalLayer`` :param topologicalLayer: The layer where vertices from the moved features of ``layer`` will be added diff --git a/python/core/auto_generated/qgsvectorlayerutils.sip.in b/python/core/auto_generated/qgsvectorlayerutils.sip.in index fe2cc64acbc2..f712c1c6fe53 100644 --- a/python/core/auto_generated/qgsvectorlayerutils.sip.in +++ b/python/core/auto_generated/qgsvectorlayerutils.sip.in @@ -286,8 +286,8 @@ Optionally, ``sinkFlags`` can be specified to further refine the compatibility l static bool fieldIsEditable( const QgsVectorLayer *layer, int fieldIndex, const QgsFeature &feature ); %Docstring -:return: true if the:param feature: field at index:param fieldIndex: from:param layer: - is editable, false if the field is readonly +:return: ``True`` if the:param feature: field at index:param fieldIndex: from:param layer: + is editable, ``False`` if the field is readonly .. versionadded:: 3.10 %End diff --git a/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in b/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in index f7d77ed3330f..a98f1782929e 100644 --- a/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in +++ b/python/core/auto_generated/raster/qgsrasterdataprovider.sip.in @@ -493,7 +493,7 @@ Resolutions are calculated in the provider's :py:func:`~QgsRasterDataProvider.cr virtual bool ignoreExtents() const; %Docstring -Returns true if the extents reported by the data provider are not reliable +Returns ``True`` if the extents reported by the data provider are not reliable and it's possible that there is renderable content outside of these extents. .. versionadded:: 3.10.0 @@ -524,7 +524,7 @@ does not support this functionality), an empty point is returned. %Docstring Enable or disable provider-level resampling. -:return: true if success +:return: ``True`` if success .. versionadded:: 3.16 %End @@ -559,7 +559,7 @@ Returns whether provider-level resampling is enabled. %Docstring Set resampling method to apply for zoomed-in operations. -:return: true if success +:return: ``True`` if success .. versionadded:: 3.16 %End @@ -575,7 +575,7 @@ Returns resampling method for zoomed-in operations. %Docstring Set resampling method to apply for zoomed-out operations. -:return: true if success +:return: ``True`` if success .. versionadded:: 3.16 %End @@ -591,7 +591,7 @@ Returns resampling method for zoomed-out operations. %Docstring Sets maximum oversampling factor for zoomed-out operations. -:return: true if success +:return: ``True`` if success .. versionadded:: 3.16 %End diff --git a/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in b/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in index 6f300bfaf605..e14fbf296f8f 100644 --- a/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in +++ b/python/core/auto_generated/symbology/qgslinesymbollayer.sip.in @@ -690,7 +690,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be rendered. -If ``selected`` is true then the symbol will be drawn using the "selected feature" +If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature" style and colors instead of the symbol's normal style. %End diff --git a/python/core/auto_generated/symbology/qgsrendererrange.sip.in b/python/core/auto_generated/symbology/qgsrendererrange.sip.in index 1a15868004a0..fab02e215040 100644 --- a/python/core/auto_generated/symbology/qgsrendererrange.sip.in +++ b/python/core/auto_generated/symbology/qgsrendererrange.sip.in @@ -31,7 +31,7 @@ Creates a renderer symbol range :param range: The classification range :param symbol: The symbol for this renderer range -:param render: If true, it will be renderered +:param render: If ``True``, it will be renderered %End QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol /Transfer/, const QString &label, bool render = true ); QgsRendererRange( const QgsRendererRange &range ); diff --git a/python/core/auto_generated/symbology/qgssymbol.sip.in b/python/core/auto_generated/symbology/qgssymbol.sip.in index b28262e826f3..5a5c512ae587 100644 --- a/python/core/auto_generated/symbology/qgssymbol.sip.in +++ b/python/core/auto_generated/symbology/qgssymbol.sip.in @@ -435,7 +435,7 @@ extent. If this option is enabled then features which are partially outside the will be clipped. This speeds up rendering of the feature, but may have undesirable side effects for certain symbol types. -:param clipFeaturesToExtent: set to true to enable clipping (defaults to ``True``) +:param clipFeaturesToExtent: set to ``True`` to enable clipping (defaults to ``True``) .. seealso:: :py:func:`clipFeaturesToExtent` @@ -1053,7 +1053,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be rendered. -If ``selected`` is true then the symbol will be drawn using the "selected feature" +If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature" style and colors instead of the symbol's normal style. %End @@ -1180,7 +1180,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be rendered. -If ``selected`` is true then the symbol will be drawn using the "selected feature" +If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature" style and colors instead of the symbol's normal style. %End @@ -1229,7 +1229,7 @@ If only a single symbol layer from the symbol should be rendered, it should be s in the ``layer`` argument. A ``layer`` of -1 indicates that all symbol layers should be rendered. -If ``selected`` is true then the symbol will be drawn using the "selected feature" +If ``selected`` is ``True`` then the symbol will be drawn using the "selected feature" style and colors instead of the symbol's normal style. %End diff --git a/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in b/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in index 5ec94f6d176c..e13178defa11 100644 --- a/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in +++ b/python/core/auto_generated/vectortile/qgsvectortilewriter.sip.in @@ -159,7 +159,7 @@ Sets coordinate transform context for transforms between layers and tile matrix bool writeTiles( QgsFeedback *feedback = 0 ); %Docstring Writes vector tiles according to the configuration. -Returns true on success (upon failure one can get error cause using :py:func:`~QgsVectorTileWriter.errorMessage`) +Returns ``True`` on success (upon failure one can get error cause using :py:func:`~QgsVectorTileWriter.errorMessage`) If a pointer to a feedback object is provided, it can be used to track progress or provide cancellation functionality. diff --git a/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in index 1416c73e3102..53b4c70e5832 100644 --- a/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in +++ b/python/gui/auto_generated/editorwidgets/core/qgseditorwidgetwrapper.sip.in @@ -180,7 +180,7 @@ Gets the current constraint status. bool isBlockingCommit() const; %Docstring -Returns true if the widget is preventing the feature from being committed. This may be ``True`` as a result +Returns ``True`` if the widget is preventing the feature from being committed. This may be ``True`` as a result of attribute values failing enforced field constraints. .. seealso:: :py:func:`isValidConstraint` diff --git a/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in b/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in index a60110019b31..f6063540a880 100644 --- a/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in +++ b/python/gui/auto_generated/editorwidgets/qgsrelationwidgetwrapper.sip.in @@ -123,7 +123,7 @@ Determines the force suppress form popup status that is configured for this widg void setForceSuppressFormPopup( bool forceSuppressFormPopup ); %Docstring Sets force suppress form popup status to ``forceSuppressFormPopup`` for this widget -and for the vectorLayerTools (if true). +and for the vectorLayerTools (if ``True``). This flag will override the layer and general settings regarding the automatic opening of the attribute form dialog when digitizing is completed. diff --git a/python/gui/auto_generated/qgisinterface.sip.in b/python/gui/auto_generated/qgisinterface.sip.in index 705bc27bc9bd..849fc103426a 100644 --- a/python/gui/auto_generated/qgisinterface.sip.in +++ b/python/gui/auto_generated/qgisinterface.sip.in @@ -1081,7 +1081,7 @@ Adds a ``dock`` widget to the main window, in the specified dock ``area``. %Docstring Add a dock widget to the given area and tabify it (if other dock widgets exist in the same ``area``). The new tab will be below other tabs unless -``raiseTab`` is passed as true. +``raiseTab`` is passed as ``True``. ``tabifyWith`` is a list of dock widget object names, ordered by priority, with which the new dock widget should be tabified. Only the @@ -1360,7 +1360,7 @@ QGIS documentation, set useQgisDocDirectory to ``False``. virtual bool openFeatureForm( QgsVectorLayer *l, QgsFeature &f, bool updateFeatureOnly = false, bool showModal = true ) = 0; %Docstring Opens a new feature form. -Returns true if dialog was accepted (if shown modal, ``True`` otherwise). +Returns ``True`` if dialog was accepted (if shown modal, ``True`` otherwise). :param l: vector layer :param f: feature to show/modify diff --git a/python/gui/auto_generated/qgsdataitemguiprovider.sip.in b/python/gui/auto_generated/qgsdataitemguiprovider.sip.in index 96d775afdd39..248016a07f69 100644 --- a/python/gui/auto_generated/qgsdataitemguiprovider.sip.in +++ b/python/gui/auto_generated/qgsdataitemguiprovider.sip.in @@ -114,7 +114,7 @@ The default implementation does nothing. virtual bool deleteLayer( QgsLayerItem *item, QgsDataItemGuiContext context ); %Docstring Tries to permanently delete map layer representing the given item. -Returns true if the layer was successfully deleted. +Returns ``True`` if the layer was successfully deleted. Items which implement this method should return the QgsDataItem.Delete capability. diff --git a/python/gui/auto_generated/qgsmapcanvas.sip.in b/python/gui/auto_generated/qgsmapcanvas.sip.in index 60b7bc6fc2ef..81b35c743471 100644 --- a/python/gui/auto_generated/qgsmapcanvas.sip.in +++ b/python/gui/auto_generated/qgsmapcanvas.sip.in @@ -279,7 +279,7 @@ Centers canvas extent to feature ids :param layer: the vector layer :param ids: the feature ids -:param alwaysRecenter: if false, the canvas is recentered only if the bounding box is not contained within the current extent +:param alwaysRecenter: if ``False``, the canvas is recentered only if the bounding box is not contained within the current extent %End void panToSelected( QgsVectorLayer *layer = 0 ); diff --git a/python/gui/auto_generated/qgsmapcanvasitem.sip.in b/python/gui/auto_generated/qgsmapcanvasitem.sip.in index fe8a8bde6590..45e015f76016 100644 --- a/python/gui/auto_generated/qgsmapcanvasitem.sip.in +++ b/python/gui/auto_generated/qgsmapcanvasitem.sip.in @@ -49,7 +49,7 @@ Sets render context parameters :param p: painter for rendering :param context: out: configured context -:return: true in case of success +:return: ``True`` in case of success %End public: diff --git a/python/gui/auto_generated/qgsmaplayerconfigwidget.sip.in b/python/gui/auto_generated/qgsmaplayerconfigwidget.sip.in index 21f21ce165f5..c53df025dc51 100644 --- a/python/gui/auto_generated/qgsmaplayerconfigwidget.sip.in +++ b/python/gui/auto_generated/qgsmaplayerconfigwidget.sip.in @@ -39,7 +39,7 @@ A panel widget that can be shown in the map style dock virtual bool shouldTriggerLayerRepaint() const; %Docstring Whether this config widget changes map layer properties in a way that :py:func:`~QgsMapLayerConfigWidget.triggerRepaint` should -be called for the layer after applying changes. This is true by default, but some config widgets +be called for the layer after applying changes. This is ``True`` by default, but some config widgets (for example 3D rendering config) do not need layer repaint as they do not modify 2D map rendering. .. versionadded:: 3.8 diff --git a/python/gui/auto_generated/qgsmaptooldigitizefeature.sip.in b/python/gui/auto_generated/qgsmaptooldigitizefeature.sip.in index 4705794fc354..9075512b9fb5 100644 --- a/python/gui/auto_generated/qgsmaptooldigitizefeature.sip.in +++ b/python/gui/auto_generated/qgsmaptooldigitizefeature.sip.in @@ -69,14 +69,14 @@ any feature bool checkGeometryType() const; %Docstring -Check if CaptureMode matches layer type. Default is true. +Check if CaptureMode matches layer type. Default is ``True``. .. versionadded:: 3.0 %End void setCheckGeometryType( bool checkGeometryType ); %Docstring -Check if CaptureMode matches layer type. Default is true. +Check if CaptureMode matches layer type. Default is ``True``. .. versionadded:: 3.0 %End diff --git a/python/gui/auto_generated/qgsscalecombobox.sip.in b/python/gui/auto_generated/qgsscalecombobox.sip.in index 349d2cfdad29..8ff7f5709c90 100644 --- a/python/gui/auto_generated/qgsscalecombobox.sip.in +++ b/python/gui/auto_generated/qgsscalecombobox.sip.in @@ -50,7 +50,7 @@ The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. bool isNull() const; %Docstring -Returns true if the combo box is currently set to a "null" value. +Returns ``True`` if the combo box is currently set to a "null" value. .. seealso:: :py:func:`setAllowNull` @@ -148,7 +148,7 @@ Except for 0 which is always allowed. %Docstring Sets the combo box to the null value. -This only has an effect if :py:func:`~QgsScaleComboBox.allowNull` is true. +This only has an effect if :py:func:`~QgsScaleComboBox.allowNull` is ``True``. .. seealso:: :py:func:`allowNull` diff --git a/python/gui/auto_generated/qgsscalewidget.sip.in b/python/gui/auto_generated/qgsscalewidget.sip.in index c1bb1954b756..c236a36fac95 100644 --- a/python/gui/auto_generated/qgsscalewidget.sip.in +++ b/python/gui/auto_generated/qgsscalewidget.sip.in @@ -78,7 +78,7 @@ The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. bool isNull() const; %Docstring -Returns true if the widget is currently set to a "null" value. +Returns ``True`` if the widget is currently set to a "null" value. .. seealso:: :py:func:`setAllowNull` @@ -175,7 +175,7 @@ Except for 0 which is always allowed. %Docstring Sets the widget to the null value. -This only has an effect if :py:func:`~QgsScaleWidget.allowNull` is true. +This only has an effect if :py:func:`~QgsScaleWidget.allowNull` is ``True``. .. seealso:: :py:func:`allowNull` diff --git a/src/3d/materials/qgsphongtexturedmaterialsettings.h b/src/3d/materials/qgsphongtexturedmaterialsettings.h index a31310e14abe..006d41c5c16f 100644 --- a/src/3d/materials/qgsphongtexturedmaterialsettings.h +++ b/src/3d/materials/qgsphongtexturedmaterialsettings.h @@ -79,7 +79,7 @@ class _3D_EXPORT QgsPhongTexturedMaterialSettings : public QgsAbstractMaterialSe float textureScale() const { return mTextureScale; } /** - * Returns true if the material requires texture coordinates to be generated + * Returns TRUE if the material requires texture coordinates to be generated * during triangulation.quiresTextureCoordinates */ bool requiresTextureCoordinates() const { return !mDiffuseTexturePath.isEmpty(); } diff --git a/src/3d/mesh/qgsmesh3dgeometry_p.cpp b/src/3d/mesh/qgsmesh3dgeometry_p.cpp index 80bec0318f15..074194259a01 100644 --- a/src/3d/mesh/qgsmesh3dgeometry_p.cpp +++ b/src/3d/mesh/qgsmesh3dgeometry_p.cpp @@ -254,7 +254,7 @@ class MeshDatasetVertexBufferFunctor : public QBufferDataGenerator public: /** - * verticalRelative parameter is true when the vertical magnitude provides from the sum of the z vertices and the scalar dataset chosen + * verticalRelative parameter is TRUE when the vertical magnitude provides from the sum of the z vertices and the scalar dataset chosen * for rendering the vertical component. */ explicit MeshDatasetVertexBufferFunctor( const QgsTriangularMesh &mesh, diff --git a/src/3d/qgs3dsceneexporter.h b/src/3d/qgs3dsceneexporter.h index 2c21668c9c12..e032c3635326 100644 --- a/src/3d/qgs3dsceneexporter.h +++ b/src/3d/qgs3dsceneexporter.h @@ -67,7 +67,7 @@ class _3D_EXPORT Qgs3DSceneExporter : public Qt3DCore::QEntity /** * Creates necessary export objects from entity if it represents valid vector layer entity - * Returns false if the no 3D object was extracted from the vector layer + * Returns FALSE if the no 3D object was extracted from the vector layer */ bool parseVectorLayerEntity( Qt3DCore::QEntity *entity, QgsVectorLayer *layer ); diff --git a/src/analysis/raster/qgsrelief.h b/src/analysis/raster/qgsrelief.h index 8822c251ee3e..035e97e4e0fe 100644 --- a/src/analysis/raster/qgsrelief.h +++ b/src/analysis/raster/qgsrelief.h @@ -71,7 +71,7 @@ class ANALYSIS_EXPORT QgsRelief /** * Calculates class breaks according with the method of Buenzli (2011) using an iterative algorithm for segmented regression - * \returns true in case of success + * \returns TRUE in case of success */ QList< QgsRelief::ReliefColor > calculateOptimizedReliefClasses(); diff --git a/src/app/3d/qgs3dmaptool.h b/src/app/3d/qgs3dmaptool.h index 199a0ca62b5f..edc15858c6de 100644 --- a/src/app/3d/qgs3dmaptool.h +++ b/src/app/3d/qgs3dmaptool.h @@ -48,7 +48,7 @@ class Qgs3DMapTool : public QObject * Whether the default mouse controls to zoom/pan/rotate camera can stay enabled * while the tool is active. This may be useful for some basic tools using just * mouse clicks (e.g. identify, measure), but it could be creating conflicts when used - * with more advanced tools. Default implementation returns true. + * with more advanced tools. Default implementation returns TRUE. */ virtual bool allowsCameraControls() const { return true; } diff --git a/src/app/decorations/qgsdecorationlayoutextent.h b/src/app/decorations/qgsdecorationlayoutextent.h index fc3c032af0a4..131cc0068a6f 100644 --- a/src/app/decorations/qgsdecorationlayoutextent.h +++ b/src/app/decorations/qgsdecorationlayoutextent.h @@ -68,7 +68,7 @@ class APP_EXPORT QgsDecorationLayoutExtent : public QgsDecorationItem void setTextFormat( const QgsTextFormat &format ) { mTextFormat = format; } /** - * Returns true if layout extents should be labeled with the name of the associated layout & map. + * Returns TRUE if layout extents should be labeled with the name of the associated layout & map. * \see setLabelExtents() * \see textFormat() */ diff --git a/src/app/georeferencer/qgsgeorefmainwindow.h b/src/app/georeferencer/qgsgeorefmainwindow.h index 0cb47c14d514..5b5f4dedb4bc 100644 --- a/src/app/georeferencer/qgsgeorefmainwindow.h +++ b/src/app/georeferencer/qgsgeorefmainwindow.h @@ -192,7 +192,7 @@ class QgsGeoreferencerMainWindow : public QMainWindow, private Ui::QgsGeorefPlug * Note that the RMSE measure is adjusted for the degrees of freedom of the * used polynomial transform. * \param error out: the mean error - * \returns true in case of success + * \returns TRUE in case of success */ bool calculateMeanError( double &error ) const; diff --git a/src/app/georeferencer/qgsgeoreftransform.h b/src/app/georeferencer/qgsgeoreftransform.h index 694d5a154e7b..c9f4df9a53d4 100644 --- a/src/app/georeferencer/qgsgeoreftransform.h +++ b/src/app/georeferencer/qgsgeoreftransform.h @@ -107,7 +107,7 @@ class QgsGeorefTransform : public QgsGeorefTransformInterface /** * \brief Fits transformation parameters to the supplied ground control points. * - * \returns true on success, false on failure + * \returns TRUE on success, FALSE on failure */ bool updateParametersFromGCPs( const QVector &mapCoords, const QVector &pixelCoords ) override; @@ -139,8 +139,8 @@ class QgsGeorefTransform : public QgsGeorefTransformInterface bool transformWorldToRaster( const QgsPointXY &world, QgsPointXY &raster ); /** - * \brief Transforms from raster to world if rasterToWorld is true, - * \brief or from world to raster when rasterToWorld is false. + * \brief Transforms from raster to world if rasterToWorld is TRUE, + * \brief or from world to raster when rasterToWorld is FALSE. * * \note Negative y-axis points down in raster CS. */ diff --git a/src/app/labeling/qgsmaptoollabel.h b/src/app/labeling/qgsmaptoollabel.h index 7f061cb61f9a..417f200b5d8a 100644 --- a/src/app/labeling/qgsmaptoollabel.h +++ b/src/app/labeling/qgsmaptoollabel.h @@ -39,10 +39,10 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool ~QgsMapToolLabel() override; /** - * Returns true if label move can be applied to a layer + * Returns TRUE if label move can be applied to a layer * \param xCol out: index of the attribute for data defined x coordinate * \param yCol out: index of the attribute for data defined y coordinate - * \returns true if labels of layer can be moved + * \returns TRUE if labels of layer can be moved */ bool labelMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; bool labelMoveable( QgsVectorLayer *vlayer, const QgsPalLayerSettings &settings, int &xCol, int &yCol ) const; @@ -51,27 +51,27 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool * Returns true if diagram move can be applied to a layer * \param xCol out: index of the attribute for data defined x coordinate * \param yCol out: index of the attribute for data defined y coordinate - * \returns true if labels of layer can be moved + * \returns TRUE if labels of layer can be moved */ bool diagramMoveable( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; /** - * Returns true if layer has attribute fields set up + * Returns TRUE if layer has attribute fields set up * \param xCol out: index of the attribute for data defined x coordinate * \param yCol out: index of the attribute for data defined y coordinate - * \returns true if layer fields set up and exist + * \returns TRUE if layer fields set up and exist */ bool layerCanPin( QgsVectorLayer *vlayer, int &xCol, int &yCol ) const; /** - * Returns true if layer has attribute field set up for diagrams + * Returns TRUE if layer has attribute field set up for diagrams * \param showCol out: attribute column for data defined diagram showing * \since QGIS 2.16 */ bool diagramCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; /** - * Returns true if layer has attribute field set up + * Returns TRUE if layer has attribute field set up * \param showCol out: attribute column for data defined label showing */ bool labelCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const; @@ -107,14 +107,14 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool * Returns label position for mouse click location * \param e mouse event * \param p out: label position - * \returns true in case of success, false if no label at this location + * \returns TRUE in case of success, FALSE if no label at this location */ bool labelAtPosition( QMouseEvent *e, QgsLabelPosition &p ); /** * Finds out rotation point of current label position * \param ignoreUpsideDown treat label as right-side-up - * \returns true in case of success + * \returns TRUE in case of success */ bool currentLabelRotationPoint( QgsPointXY &pos, bool ignoreUpsideDown = false, bool rotatingUnpinned = false ); @@ -134,7 +134,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool /** * Gets vector feature for current label pos - * \returns true in case of success + * \returns TRUE in case of success */ bool currentFeature( QgsFeature &f, bool fetchGeom = false ); @@ -161,22 +161,22 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool /** * Gets data defined position of current label * \param x out: data defined x-coordinate - * \param xSuccess out: false if attribute value is NULL + * \param xSuccess out: FALSE if attribute value is NULL * \param y out: data defined y-coordinate - * \param ySuccess out: false if attribute value is NULL + * \param ySuccess out: FALSE if attribute value is NULL * \param xCol out: index of the x position column * \param yCol out: index of the y position column - * \returns false if layer does not have data defined label position enabled + * \returns FALSE if layer does not have data defined label position enabled */ bool currentLabelDataDefinedPosition( double &x, bool &xSuccess, double &y, bool &ySuccess, int &xCol, int &yCol ) const; /** * Returns data defined rotation of current label * \param rotation out: rotation value - * \param rotationSuccess out: false if rotation value is NULL + * \param rotationSuccess out: FALSE if rotation value is NULL * \param rCol out: index of the rotation column * \param ignoreXY ignore that x and y are required to be data-defined - * \returns true if data defined rotation is enabled on the layer + * \returns TRUE if data defined rotation is enabled on the layer */ bool currentLabelDataDefinedRotation( double &rotation, bool &rotationSuccess, int &rCol, bool ignoreXY = false ) const; @@ -185,15 +185,15 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool * \param vlayer vector layer * \param featureId feature identification integer * \param show out: show/hide value - * \param showSuccess out: false if show/hide value is NULL + * \param showSuccess out: FALSE if show/hide value is NULL * \param showCol out: index of the show label column - * \returns true if data defined show/hide is enabled on the layer + * \returns TRUE if data defined show/hide is enabled on the layer */ bool dataDefinedShowHide( QgsVectorLayer *vlayer, QgsFeatureId featureId, int &show, bool &showSuccess, int &showCol ) const; /** * Returns the pin status for the current label/diagram - * \returns true if the label/diagram is pinned, false otherwise + * \returns TRUE if the label/diagram is pinned, FALSE otherwise * \since QGIS 2.16 */ bool isPinned(); diff --git a/src/app/layout/qgslayoutdesignerdialog.h b/src/app/layout/qgslayoutdesignerdialog.h index ceda6f2695ce..e1991d4d78f8 100644 --- a/src/app/layout/qgslayoutdesignerdialog.h +++ b/src/app/layout/qgslayoutdesignerdialog.h @@ -146,7 +146,7 @@ class QgsLayoutDesignerDialog: public QMainWindow, public Ui::QgsLayoutDesignerB /** * Shows the configuration widget for the specified layout \a item. * - * If \a bringPanelToFront is true, then the item properties panel will be automatically + * If \a bringPanelToFront is TRUE, then the item properties panel will be automatically * shown and raised to the top of the interface. */ void showItemOptions( QgsLayoutItem *item, bool bringPanelToFront = true ); diff --git a/src/app/options/qgsoptions.h b/src/app/options/qgsoptions.h index 24fd50cd49e3..b2c709fe21ed 100644 --- a/src/app/options/qgsoptions.h +++ b/src/app/options/qgsoptions.h @@ -62,7 +62,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption * Constructor * \param parent Parent widget (usually a QgisApp) * \param name name for the widget - * \param modal true for modal dialog + * \param modal TRUE for modal dialog * \param optionsFactories factories for additional option pages */ QgsOptions( QWidget *parent = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags, @@ -113,7 +113,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption /** * Returns the desired state of newly added layers. If a layer * is to be drawn when added to the map, this function returns - * true. + * TRUE. */ bool newVisible(); diff --git a/src/app/qgisapp.h b/src/app/qgisapp.h index b79c3b7d2151..51f8b7a624b5 100644 --- a/src/app/qgisapp.h +++ b/src/app/qgisapp.h @@ -212,7 +212,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Open a raster layer for the given file - * \returns false if unable to open a raster layer for rasterFile + * \returns FALSE if unable to open a raster layer for rasterFile * \note This is essentially a simplified version of the above */ QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true ); @@ -232,9 +232,9 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Open a raster or vector file; ignore other files. * Used to process a commandline argument, FileOpen or Drop event. - * Set \a allowInteractive to true if it is OK to ask the user for information (mostly for + * Set \a allowInteractive to TRUE if it is OK to ask the user for information (mostly for * when a vector layer has sublayers and we want to ask which sublayers to use). - * \returns true if the file is successfully opened + * \returns TRUE if the file is successfully opened */ bool openLayer( const QString &fileName, bool allowInteractive = false ); @@ -259,7 +259,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Opens a QGIS project file - * \returns false if unable to open the project + * \returns FALSE if unable to open the project */ bool addProject( const QString &projectFile ); @@ -299,7 +299,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow void closeAdditionalMapCanvases(); /** - * Freezes all map canvases (or thaws them if the \a frozen argument is false). + * Freezes all map canvases (or thaws them if the \a frozen argument is FALSE). */ void freezeCanvases( bool frozen = true ); @@ -350,7 +350,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Add a dock widget to the given area and tabify it (if other dock widgets * exist in the same \a area). The new tab will be below other tabs unless - * \a raiseTab is passed as true. + * \a raiseTab is passed as TRUE. * * \a tabifyWith is a list of dock widget object names, ordered by * priority, with which the new dock widget should be tabified. Only the @@ -401,11 +401,11 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * * The \a title argument will be filled with the new layout title. * - * If \a acceptEmpty is true then empty titles will be acceptable (one will be generated). + * If \a acceptEmpty is TRUE then empty titles will be acceptable (one will be generated). * * The \a currentTitle argument specifies a base name for initial title choice. * - * \returns true if user did not cancel the dialog. + * \returns TRUE if user did not cancel the dialog. */ bool uniqueLayoutTitle( QWidget *parent, QString &title, bool acceptEmpty, QgsMasterLayoutInterface::Type type, const QString ¤tTitle = QString() ); @@ -454,7 +454,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * * \param title * \param message - * \param replaceExisting set to true to replace any existing notifications, or false to add a new notification + * \param replaceExisting set to TRUE to replace any existing notifications, or FALSE to add a new notification */ void showSystemNotification( const QString &title, const QString &message, bool replaceExisting = true ); @@ -802,7 +802,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow QgsMapLayer *activeLayer(); /** - * Returns the toolbar icon size. If \a dockedToolbar is true, the icon size + * Returns the toolbar icon size. If \a dockedToolbar is TRUE, the icon size * for toolbars contained within docks is returned. */ QSize iconSize( bool dockedToolbar = false ) const; @@ -810,7 +810,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Checks available datum transforms and ask user if several are available and none * is chosen. Dialog is shown only if global option is set accordingly. - * \returns true if a datum transform has been specifically chosen by user or only one is available. + * \returns TRUE if a datum transform has been specifically chosen by user or only one is available. * \since 3.0 */ bool askUserForDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QgsMapLayer *layer = nullptr ); @@ -1141,7 +1141,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * file names instead of prompting user with a dialog. * \param enc encoding type for the layer * \param dataSourceType type of ogr datasource - * \returns true if successfully added layer + * \returns TRUE if successfully added layer */ bool addVectorLayers( const QStringList &layerQStringList, const QString &enc, const QString &dataSourceType ); @@ -1149,7 +1149,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * Overloaded version of the private addRasterLayer() * Method that takes a list of file names instead of prompting * user with a dialog. - * \returns true if successfully added layer(s) + * \returns TRUE if successfully added layer(s) */ bool addRasterLayers( const QStringList &layerQStringList, bool guiWarning = true ); @@ -2017,7 +2017,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * This method will open a dialog so the user can select GDAL sublayers to load - * \returns true if any items were loaded + * \returns TRUE if any items were loaded */ bool askUserForZipItemLayers( const QString &path ); @@ -2071,7 +2071,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * pass settings by reference since creating more than one * instance simultaneously results in data loss. * - * \param savePreviewImage Set to false when the preview image should not be saved. E.g. project load. + * \param savePreviewImage Set to FALSE when the preview image should not be saved. E.g. project load. * \param iconOverlay optional icon to overlay when saving a preview image */ void saveRecentProjectPath( bool savePreviewImage = true, const QIcon &iconOverlay = QIcon() ); @@ -2086,7 +2086,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow /** * Check to see if the current project file is dirty and if so, prompt the user to save it. - * \returns true if saved or discarded, false if canceled + * \returns TRUE if saved or discarded, FALSE if canceled */ bool saveDirty(); @@ -2094,8 +2094,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * Checks for unsaved changes in open layers and prompts the user to save * or discard these changes for each layer. * - * Returns true if there are no unsaved layer edits remaining, or the user - * opted to discard them all. Returns false if the user opted to cancel + * Returns TRUE if there are no unsaved layer edits remaining, or the user + * opted to discard them all. Returns FALSE if the user opted to cancel * on any layer. */ bool checkUnsavedLayerEdits(); @@ -2105,8 +2105,8 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow * shows a warning to users that their contents will be lost on * project unload. * - * Returns true if there are no memory layers present, or if the - * user opted to discard their contents. Returns false if there + * Returns TRUE if there are no memory layers present, or if the + * user opted to discard their contents. Returns FALSE if there * are memory layers present and the user clicked 'Cancel' on * the warning dialog. */ diff --git a/src/app/qgsclipboard.h b/src/app/qgsclipboard.h index 5053078ca049..2aea976ef432 100644 --- a/src/app/qgsclipboard.h +++ b/src/app/qgsclipboard.h @@ -91,7 +91,7 @@ class APP_EXPORT QgsClipboard : public QObject void insert( const QgsFeature &feature ); /** - * Returns true if the internal clipboard is empty, else false. + * Returns TRUE if the internal clipboard is empty, else FALSE. */ bool isEmpty() const; diff --git a/src/app/qgsfeatureaction.h b/src/app/qgsfeatureaction.h index 6d05259538e0..1f070a94fa10 100644 --- a/src/app/qgsfeatureaction.h +++ b/src/app/qgsfeatureaction.h @@ -50,13 +50,13 @@ class APP_EXPORT QgsFeatureAction : public QAction * * \param defaultAttributes Provide some default attributes here if desired. * - * \returns true if feature was added if showModal is true. If showModal is false, returns true in every case + * \returns TRUE if feature was added if showModal is true. If showModal is FALSE, returns TRUE in every case */ bool addFeature( const QgsAttributeMap &defaultAttributes = QgsAttributeMap(), bool showModal = true, QgsExpressionContextScope *scope = nullptr ); /** * Sets whether to force suppression of the attribute form popup after creating a new feature. - * If \a force is true, then regardless of any user settings, form settings, etc, the attribute + * If \a force is TRUE, then regardless of any user settings, form settings, etc, the attribute * form will ALWAYS be suppressed. */ void setForceSuppressFormPopup( bool force ); diff --git a/src/app/qgsguivectorlayertools.h b/src/app/qgsguivectorlayertools.h index 1b062abe9c36..608c4ceae0e3 100644 --- a/src/app/qgsguivectorlayertools.h +++ b/src/app/qgsguivectorlayertools.h @@ -58,7 +58,7 @@ class QgsGuiVectorLayerTools : public QgsVectorLayerTools /** * Should be called, when an editing session is ended and the features should be committed. * An appropriate dialog asking the user if he wants to save the edits will be shown if - * allowCancel is set to true. + * allowCancel is set to TRUE. * * \param layer The layer to commit * \param allowCancel TRUE if a cancel button should be offered diff --git a/src/app/qgslayerstylingwidget.h b/src/app/qgslayerstylingwidget.h index dc61cb6f7a3b..b9733817ac98 100644 --- a/src/app/qgslayerstylingwidget.h +++ b/src/app/qgslayerstylingwidget.h @@ -106,7 +106,7 @@ class APP_EXPORT QgsLayerStylingWidget : public QWidget, private Ui::QgsLayerSty * Sets whether updates of the styling widget are blocked. This can be called to prevent * the widget being refreshed multiple times when a batch of layer style changes are * about to be applied - * \param blocked set to true to block updates, or false to re-allow updates + * \param blocked set to TRUE to block updates, or FALSE to re-allow updates */ void blockUpdates( bool blocked ); diff --git a/src/app/qgsmapcanvasdockwidget.h b/src/app/qgsmapcanvasdockwidget.h index a912ccd9c38b..57b1609c7a86 100644 --- a/src/app/qgsmapcanvasdockwidget.h +++ b/src/app/qgsmapcanvasdockwidget.h @@ -62,13 +62,13 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM void setViewCenterSynchronized( bool enabled ); /** - * Returns true if the view extent is synchronized with the main canvas extent. + * Returns TRUE if the view extent is synchronized with the main canvas extent. * \see setViewCenterSynchronized() */ bool isViewCenterSynchronized() const; /** - * Returns true if the view is synchronized with the selection on the main canvas. + * Returns TRUE if the view is synchronized with the selection on the main canvas. * \see setAutoZoomToSelected() */ bool isAutoZoomToSelected() const; @@ -86,7 +86,7 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM void setCursorMarkerVisible( bool visible ); /** - * Returns true if the cursor position marker is visible. + * Returns TRUE if the cursor position marker is visible. * \see setCursorMarkerVisible() */ bool isCursorMarkerVisible() const; @@ -98,7 +98,7 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM void setMainCanvasExtentVisible( bool visible ); /** - * Returns true if the main canvas extent is visible. + * Returns TRUE if the main canvas extent is visible. * \see setMainCanvasExtentVisible() */ bool isMainCanvasExtentVisible() const; @@ -125,7 +125,7 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM void setViewScaleSynchronized( bool enabled ); /** - * Returns true if the view scale is synchronized with the main canvas extent. + * Returns TRUE if the view scale is synchronized with the main canvas extent. * \see setViewScaleSynchronized() * \see scaleFactor() */ diff --git a/src/app/qgsmaptooladdfeature.h b/src/app/qgsmaptooladdfeature.h index 3c8351f63adb..c9ffc4640532 100644 --- a/src/app/qgsmaptooladdfeature.h +++ b/src/app/qgsmaptooladdfeature.h @@ -31,7 +31,7 @@ class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolDigitizeFeature void digitized( const QgsFeature &f ) override; /** - * Check if CaptureMode matches layer type. Default is true. + * Check if CaptureMode matches layer type. Default is TRUE. * \since QGIS 2.12 */ bool mCheckGeometryType; diff --git a/src/app/qgsmaptooloffsetpointsymbol.h b/src/app/qgsmaptooloffsetpointsymbol.h index 4fa974a89ea3..3d921f61f203 100644 --- a/src/app/qgsmaptooloffsetpointsymbol.h +++ b/src/app/qgsmaptooloffsetpointsymbol.h @@ -42,7 +42,7 @@ class APP_EXPORT QgsMapToolOffsetPointSymbol: public QgsMapToolPointSymbol void canvasReleaseEvent( QgsMapMouseEvent *e ) override; /** - * Returns true if the symbols of a map layer can be offset. This means the layer + * Returns TRUE if the symbols of a map layer can be offset. This means the layer * is a vector layer, has type point or multipoint and has at least one offset attribute in the renderer. */ static bool layerIsOffsetable( QgsMapLayer *ml ); diff --git a/src/app/qgsmaptoolrotatepointsymbols.h b/src/app/qgsmaptoolrotatepointsymbols.h index 2ac90481b008..91bbb7b219b1 100644 --- a/src/app/qgsmaptoolrotatepointsymbols.h +++ b/src/app/qgsmaptoolrotatepointsymbols.h @@ -42,7 +42,7 @@ class APP_EXPORT QgsMapToolRotatePointSymbols: public QgsMapToolPointSymbol void canvasReleaseEvent( QgsMapMouseEvent *e ) override; /** - * Returns true if the symbols of a maplayer can be rotated. This means the layer + * Returns TRUE if the symbols of a maplayer can be rotated. This means the layer * is a vector layer, has type point or multipoint and has at least one rotation attribute in the renderer. */ static bool layerIsRotatable( QgsMapLayer *ml ); diff --git a/src/app/qgsmeasuredialog.h b/src/app/qgsmeasuredialog.h index a2b67de9007f..b669d7fd018f 100644 --- a/src/app/qgsmeasuredialog.h +++ b/src/app/qgsmeasuredialog.h @@ -90,7 +90,7 @@ class APP_EXPORT QgsMeasureDialog : public QDialog, private Ui::QgsMeasureBase /** * Resets the units combo box to display either distance or area units - * \param isArea set to true to populate with areal units, or false to show distance units + * \param isArea set to TRUE to populate with areal units, or FALSE to show distance units */ void repopulateComboBoxUnits( bool isArea ); diff --git a/src/app/vertextool/qgslockedfeature.h b/src/app/vertextool/qgslockedfeature.h index 9f02ce3851ab..9a3778bb1524 100644 --- a/src/app/vertextool/qgslockedfeature.h +++ b/src/app/vertextool/qgslockedfeature.h @@ -79,7 +79,7 @@ class QgsLockedFeature: public QObject /** * Tells if vertex is selected * \param vertexNr number of vertex for which we are getting info - * \returns true if vertex is selected, false otherwise + * \returns TRUE if vertex is selected, FALSE otherwise */ bool isSelected( int vertexNr ); diff --git a/src/core/classification/qgsclassificationmethodregistry.h b/src/core/classification/qgsclassificationmethodregistry.h index 38478916f1ea..2eaf03d2d3d9 100644 --- a/src/core/classification/qgsclassificationmethodregistry.h +++ b/src/core/classification/qgsclassificationmethodregistry.h @@ -43,7 +43,7 @@ class CORE_EXPORT QgsClassificationMethodRegistry /** * Adds a method to the registry - * Returns false if a method with same id already exists. + * Returns FALSE if a method with same id already exists. */ bool addMethod( QgsClassificationMethod *method SIP_TRANSFER ); diff --git a/src/core/geometry/qgsgeometry.h b/src/core/geometry/qgsgeometry.h index 73d9df648ef4..5db675ba3562 100644 --- a/src/core/geometry/qgsgeometry.h +++ b/src/core/geometry/qgsgeometry.h @@ -885,7 +885,7 @@ class CORE_EXPORT QgsGeometry * \param[out] newGeometries list of new geometries that have been created with the split * \param topological TRUE if topological editing is enabled * \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - * \param splitFeature Set to True if you want to split a feature, otherwise set to False to split parts + * \param splitFeature Set to TRUE if you want to split a feature, otherwise set to FALSE to split parts * \returns OperationResult a result code: success or reason of failure * \deprecated since QGIS 3.12 - will be removed in QGIS 4.0. Use the variant which accepts QgsPoint objects instead of QgsPointXY. */ @@ -897,7 +897,7 @@ class CORE_EXPORT QgsGeometry * \param[out] newGeometries list of new geometries that have been created with the ``splitLine``. If the geometry is 3D, a linear interpolation of the z value is performed on the geometry at split points, see example. * \param topological TRUE if topological editing is enabled * \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - * \param splitFeature Set to True if you want to split a feature, otherwise set to False to split parts + * \param splitFeature Set to TRUE if you want to split a feature, otherwise set to FALSE to split parts * fix this bug? * \param skipIntersectionTest set to TRUE to skip the potentially expensive initial intersection check. Only set this flag if an intersection * test has already been performed by the caller! Not available in Python bindings. @@ -921,7 +921,7 @@ class CORE_EXPORT QgsGeometry * \param preserveCircular whether if circular strings are preserved after splitting * \param topological TRUE if topological editing is enabled * \param[out] topologyTestPoints points that need to be tested for topological completeness in the dataset - * \param splitFeature Set to True if you want to split a feature, otherwise set to False to split parts + * \param splitFeature Set to TRUE if you want to split a feature, otherwise set to FALSE to split parts * \returns OperationResult a result code: success or reason of failure * \since QGIS 3.16 */ diff --git a/src/core/geometry/qgsgeometryengine.h b/src/core/geometry/qgsgeometryengine.h index 1a2da812d2bc..94d842c47c0d 100644 --- a/src/core/geometry/qgsgeometryengine.h +++ b/src/core/geometry/qgsgeometryengine.h @@ -219,7 +219,7 @@ class CORE_EXPORT QgsGeometryEngine virtual double length( QString *errorMsg = nullptr ) const = 0; /** - * Returns true if the geometry is valid. + * Returns TRUE if the geometry is valid. * * If the geometry is invalid, \a errorMsg will be filled with the reported geometry error. * diff --git a/src/core/geometry/qgsgeometryutils.h b/src/core/geometry/qgsgeometryutils.h index 4a277e5e244b..d2bf3237cb97 100644 --- a/src/core/geometry/qgsgeometryutils.h +++ b/src/core/geometry/qgsgeometryutils.h @@ -114,7 +114,7 @@ class CORE_EXPORT QgsGeometryUtils * \param intersectionPoint Output parameter, the intersection point * \param isIntersection Output parameter, return TRUE if an intersection is found * \param tolerance The tolerance to use - * \param acceptImproperIntersection By default, this method returns true only if segments have proper intersection. If set true, returns also TRUE if segments have improper intersection (end of one segment on other segment ; continuous segments). + * \param acceptImproperIntersection By default, this method returns TRUE only if segments have proper intersection. If set true, returns also TRUE if segments have improper intersection (end of one segment on other segment ; continuous segments). * \returns Whether the segments intersect * * ### Example @@ -375,7 +375,7 @@ class CORE_EXPORT QgsGeometryUtils bool hasZ = false, bool hasM = false ); /** - * Returns true if point \a b is on the arc formed by points \a a1, \a a2, and \a a3, but not within + * Returns TRUE if point \a b is on the arc formed by points \a a1, \a a2, and \a a3, but not within * that arc portion already described by \a a1, \a a2 and \a a3. * * The \a distanceTolerance specifies the maximum deviation allowed between the original location diff --git a/src/core/labeling/qgspallabeling.h b/src/core/labeling/qgspallabeling.h index 16035af285a2..f11a922fef91 100644 --- a/src/core/labeling/qgspallabeling.h +++ b/src/core/labeling/qgspallabeling.h @@ -1165,7 +1165,7 @@ class CORE_EXPORT QgsPalLayerSettings /** * Checks if a feature is larger than a minimum size (in mm) - * \returns true if above size, false if below + * \returns TRUE if above size, FALSE if below */ bool checkMinimumSizeMM( const QgsRenderContext &ct, const QgsGeometry &geom, double minSize ) const; diff --git a/src/core/layertree/qgslayertreelayer.h b/src/core/layertree/qgslayertreelayer.h index b3be2d56c12e..5988366f0561 100644 --- a/src/core/layertree/qgslayertreelayer.h +++ b/src/core/layertree/qgslayertreelayer.h @@ -92,8 +92,8 @@ class CORE_EXPORT QgsLayerTreeLayer : public QgsLayerTreeNode void setName( const QString &n ) override; /** - * Uses the layer's name if \a use is true, or the name manually set if - * false. + * Uses the layer's name if \a use is TRUE, or the name manually set if + * FALSE. * \since QGIS 3.8 */ void setUseLayerName( bool use = true ); diff --git a/src/core/layout/qgslayoutitemlegend.h b/src/core/layout/qgslayoutitemlegend.h index 54e0d9fed74d..f2642ca51c79 100644 --- a/src/core/layout/qgslayoutitemlegend.h +++ b/src/core/layout/qgslayoutitemlegend.h @@ -57,7 +57,7 @@ class CORE_EXPORT QgsLegendModel : public QgsLayerTreeModel /** * Returns filtered list of active legend nodes attached to a particular layer node - * (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is true) + * (by default it returns also legend node embedded in parent layer node (if any) unless skipNodeEmbeddedInParent is TRUE) * \note Parameter skipNodeEmbeddedInParent added in QGIS 2.18 * \note Not available in Python bindings * \see layerOriginalLegendNodes() diff --git a/src/core/layout/qgslayoutitemnodeitem.h b/src/core/layout/qgslayoutitemnodeitem.h index a7a637e0bd6a..420a5afd5b50 100644 --- a/src/core/layout/qgslayoutitemnodeitem.h +++ b/src/core/layout/qgslayoutitemnodeitem.h @@ -49,7 +49,7 @@ class CORE_EXPORT QgsLayoutNodesItem: public QgsLayoutItem * \param point is the location of the new node (in scene coordinates) * \param checkArea is a flag to indicate if there's a space constraint. * \param radius is the space contraint and is used only if checkArea is - * true. Typically, if this flag is TRUE, the new node has to be nearer + * TRUE. Typically, if this flag is TRUE, the new node has to be nearer * than radius to the shape to be added. */ bool addNode( QPointF point, bool checkArea = true, double radius = 10 ); diff --git a/src/core/mesh/qgsmesh3daveraging.h b/src/core/mesh/qgsmesh3daveraging.h index 09ec0bf608dd..a25db110b37f 100644 --- a/src/core/mesh/qgsmesh3daveraging.h +++ b/src/core/mesh/qgsmesh3daveraging.h @@ -165,16 +165,16 @@ class CORE_EXPORT QgsMeshMultiLevelsAveragingMethod: public QgsMesh3dAveragingMe * Constructs multi level averaging method * \param startLevel starting vertical level index numbered from 1 * \param endLevel ending vertical level index numbered from 1 (higher or equal than startLevel) - * \param countedFromTop if true, the startLevel index is counted from surface (index 1 is the top layer). - * if false, the startLevel index is counted from the bed level (index 1 is the bottom layer) + * \param countedFromTop if TRUE, the startLevel index is counted from surface (index 1 is the top layer). + * if FALSE, the startLevel index is counted from the bed level (index 1 is the bottom layer) */ QgsMeshMultiLevelsAveragingMethod( int startLevel, int endLevel, bool countedFromTop ); /** * Constructs single level averaging method * \param verticalLevel vertical level index numbered from 1 - * \param countedFromTop if true, the startLevel index is counted from surface (index 1 is the top layer). - * if false, the startLevel index is counted from the bed level (index 1 is the bottom layer) + * \param countedFromTop if TRUE, the startLevel index is counted from surface (index 1 is the top layer). + * if FALSE, the startLevel index is counted from the bed level (index 1 is the bottom layer) */ QgsMeshMultiLevelsAveragingMethod( int verticalLevel, bool countedFromTop ); @@ -307,8 +307,8 @@ class CORE_EXPORT QgsMeshRelativeHeightAveragingMethod: public QgsMesh3dAveragin * Constructs the depth/height averaging method * \param startHeight starting depth/height, higher or equal than 0 * \param endHeight ending depth/height, higher or equal than startDepth - * \param countedFromTop if true, the startLength and endLength is relative to surface (0 is surface level). - * if false, the startLength and endLength is relative to bed (0 is bed level). + * \param countedFromTop if TRUE, the startLength and endLength is relative to surface (0 is surface level). + * if FALSE, the startLength and endLength is relative to bed (0 is bed level). */ QgsMeshRelativeHeightAveragingMethod( double startHeight, double endHeight, bool countedFromTop ); diff --git a/src/core/mesh/qgsmeshcalcnode.h b/src/core/mesh/qgsmeshcalcnode.h index 88267bc06644..8f2824b1f93e 100644 --- a/src/core/mesh/qgsmeshcalcnode.h +++ b/src/core/mesh/qgsmeshcalcnode.h @@ -147,7 +147,7 @@ class CORE_EXPORT QgsMeshCalcNode /** * Returns whether the calculation will leads to a non temporal dataset group result - * \returns true if the result will be non temporal + * \returns TRUE if the result will be non temporal */ bool isNonTemporal() const; diff --git a/src/core/mesh/qgsmeshdataprovider.h b/src/core/mesh/qgsmeshdataprovider.h index 3a5a6bf6ab7e..31170b4eb090 100644 --- a/src/core/mesh/qgsmeshdataprovider.h +++ b/src/core/mesh/qgsmeshdataprovider.h @@ -103,7 +103,7 @@ struct CORE_EXPORT QgsMesh void clear(); /** - * Compare two faces, return true if they are equivalent : same indexes and same clock wise + * Compare two faces, return TRUE if they are equivalent : same indexes and same clock wise * \since QGIS 3.16 */ static bool compareFaces( const QgsMeshFace &face1, const QgsMeshFace &face2 ); diff --git a/src/core/mesh/qgsmeshdataset.h b/src/core/mesh/qgsmeshdataset.h index a8ec174c674f..57f6bc7d604a 100644 --- a/src/core/mesh/qgsmeshdataset.h +++ b/src/core/mesh/qgsmeshdataset.h @@ -175,7 +175,7 @@ class CORE_EXPORT QgsMeshDataBlock * * If the data provider/datasets does not have active * flag capability (== all values are valid), just - * set block validity by setValid( true ) + * set block validity by setValid( TRUE ) * * \param vals value vector with size count() * diff --git a/src/core/mesh/qgsmeshlayerutils.h b/src/core/mesh/qgsmeshlayerutils.h index 39e28f75bf26..d02e25c92221 100644 --- a/src/core/mesh/qgsmeshlayerutils.h +++ b/src/core/mesh/qgsmeshlayerutils.h @@ -287,7 +287,7 @@ class CORE_EXPORT QgsMeshLayerUtils * Calculates the normals on the vertices using vertical magnitudes instead Z value of vertices * \param triangularMesh the triangular mesh * \param verticalMagnitude the vertical magnitude values used instead Z value of vertices - * \param isRelative true if the vertical magnitude is relative to the Z value of vertices + * \param isRelative TRUE if the vertical magnitude is relative to the Z value of vertices * \returns normales (3D vector) on all the vertices * \since QGIS 3.14 */ diff --git a/src/core/mesh/qgstriangularmesh.h b/src/core/mesh/qgstriangularmesh.h index f2b0a0c3f17e..c52ee97cb9be 100644 --- a/src/core/mesh/qgstriangularmesh.h +++ b/src/core/mesh/qgstriangularmesh.h @@ -58,7 +58,7 @@ class CORE_EXPORT QgsTriangularMesh // TODO rename to QgsRendererMesh in QGIS 4 * Constructs triangular mesh from layer's native mesh and transform to destination CRS. Populates spatial index. * \param nativeMesh QgsMesh to access native vertices and faces * \param transform Transformation from layer CRS to destination (e.g. map) CRS. With invalid transform, it keeps the native mesh CRS - * \returns true if the mesh is effectivly updated, and false if not + * \returns TRUE if the mesh is effectivly updated, and FALSE if not */ bool update( QgsMesh *nativeMesh, const QgsCoordinateTransform &transform = QgsCoordinateTransform() ); diff --git a/src/core/pal/pal.h b/src/core/pal/pal.h index 76ac7d60361c..6f4c226b658f 100644 --- a/src/core/pal/pal.h +++ b/src/core/pal/pal.h @@ -139,7 +139,7 @@ namespace pal * Solves the labeling problem, selecting the best candidate locations for all labels and returns a list of these * calculated label positions. * - * If \a displayAll is true, then the best positions for ALL labels will be returned, regardless of whether these + * If \a displayAll is TRUE, then the best positions for ALL labels will be returned, regardless of whether these * labels overlap other labels. * * If the optional \a unlabeled list is specified, it will be filled with a list of all feature labels which could diff --git a/src/core/pal/priorityqueue.h b/src/core/pal/priorityqueue.h index e88bf0e20ffe..e774e7459025 100644 --- a/src/core/pal/priorityqueue.h +++ b/src/core/pal/priorityqueue.h @@ -57,7 +57,7 @@ namespace pal * \brief Create a priority queue of max size n * \\param n max size of the queuet * \\param p external vector representing the priority - * \\param min best element has the smalest p when min is True ans has the biggest when min is false + * \\param min best element has the smallest p when min is TRUE and has the biggest when min is FALSE */ PriorityQueue( int n, int maxId, bool min ); ~PriorityQueue(); diff --git a/src/core/pal/problem.h b/src/core/pal/problem.h index 223c2868b3b3..39aa563bd8d1 100644 --- a/src/core/pal/problem.h +++ b/src/core/pal/problem.h @@ -121,7 +121,7 @@ namespace pal * Solves the labeling problem, selecting the best candidate locations for all labels and returns a list of these * calculated label positions. * - * If \a returnInactive is true, then the best positions for ALL labels will be returned, regardless of whether these + * If \a returnInactive is TRUE, then the best positions for ALL labels will be returned, regardless of whether these * labels overlap other labels. * * If the optional \a unlabeled list is specified, it will be filled with a list of all feature labels which could diff --git a/src/core/providers/gdal/qgsgdalprovider.cpp b/src/core/providers/gdal/qgsgdalprovider.cpp index 1fb090aaa472..210ae1febc51 100644 --- a/src/core/providers/gdal/qgsgdalprovider.cpp +++ b/src/core/providers/gdal/qgsgdalprovider.cpp @@ -1207,7 +1207,7 @@ bool QgsGdalProvider::readBlock( int bandNo, QgsRectangle const &reqExtent, int /** * \param bandNumber the number of the band for which you want a color table * \param list a pointer the object that will hold the color table - * \return true of a color table was able to be read, false otherwise + * \return TRUE if a color table was able to be read, FALSE otherwise */ QList QgsGdalProvider::colorTable( int bandNumber )const { diff --git a/src/core/providers/gdal/qgsgdalproviderbase.cpp b/src/core/providers/gdal/qgsgdalproviderbase.cpp index 5dda088cdfa8..7a679b544ee1 100644 --- a/src/core/providers/gdal/qgsgdalproviderbase.cpp +++ b/src/core/providers/gdal/qgsgdalproviderbase.cpp @@ -38,7 +38,7 @@ QgsGdalProviderBase::QgsGdalProviderBase() /** * \param bandNumber the number of the band for which you want a color table * \param list a pointer the object that will hold the color table - * \return true of a color table was able to be read, false otherwise + * \return TRUE of a color table was able to be read, FALSE otherwise */ QList QgsGdalProviderBase::colorTable( GDALDatasetH gdalDataset, int bandNumber )const { diff --git a/src/core/providers/ogr/qgsgeopackagedataitems.h b/src/core/providers/ogr/qgsgeopackagedataitems.h index 02e533e8eb47..48c0812428b3 100644 --- a/src/core/providers/ogr/qgsgeopackagedataitems.h +++ b/src/core/providers/ogr/qgsgeopackagedataitems.h @@ -54,7 +54,7 @@ class CORE_EXPORT QgsGeoPackageCollectionItem : public QgsDataCollectionItem * \param name DB connection name * \param path DB connection path * \param errCause contains the error message - * \return true on success + * \return TRUE on success */ static bool vacuumGeoPackageDb( const QString &name, const QString &path, QString &errCause ); diff --git a/src/core/providers/ogr/qgsogrprovider.h b/src/core/providers/ogr/qgsogrprovider.h index 15ef616f9b1b..73fe02d20f51 100644 --- a/src/core/providers/ogr/qgsogrprovider.h +++ b/src/core/providers/ogr/qgsogrprovider.h @@ -417,7 +417,7 @@ class CORE_EXPORT QgsOgrProviderUtils * \param format data format (e.g. "ESRI Shapefile") * \param vectortype point/line/polygon or multitypes * \param attributes a list of name/type pairs for the initial attributes - * \return true in case of success + * \return TRUE in case of success */ static bool createEmptyDataSource( const QString &uri, const QString &format, diff --git a/src/core/providers/ogr/qgsogrtransaction.h b/src/core/providers/ogr/qgsogrtransaction.h index e4ed9f6e9643..0372ce7d6e15 100644 --- a/src/core/providers/ogr/qgsogrtransaction.h +++ b/src/core/providers/ogr/qgsogrtransaction.h @@ -37,8 +37,8 @@ class QgsOgrTransaction : public QgsTransaction * * \param sql The SQL query to execute * \param error The error or an empty string if none - * \param isDirty True to add an undo/redo command in the edition buffer, false otherwise - * \param name Name of the operation ( only used if `isDirty` is true) + * \param isDirty TRUE to add an undo/redo command in the edition buffer, FALSE otherwise + * \param name Name of the operation ( only used if `isDirty` is TRUE) */ bool executeSql( const QString &sql, QString &error, bool isDirty = false, const QString &name = QString() ) override; diff --git a/src/core/qgis.h b/src/core/qgis.h index 020a21094097..8b7ef718991e 100644 --- a/src/core/qgis.h +++ b/src/core/qgis.h @@ -513,7 +513,7 @@ template QString qgsEnumValueToKey( const T &value ) SIP_SKIP /** * Returns the value corresponding to the given \a key of an enum. * If the key is invalid, it will return the \a defaultValue. - * If \a tryValueAsKey is true, it will try to convert the string key to an enum value + * If \a tryValueAsKey is TRUE, it will try to convert the string key to an enum value * \since QGIS 3.6 */ template T qgsEnumKeyToValue( const QString &key, const T &defaultValue, bool tryValueAsKey = true ) SIP_SKIP diff --git a/src/core/qgseditformconfig.h b/src/core/qgseditformconfig.h index 05722122cad0..20204cd13322 100644 --- a/src/core/qgseditformconfig.h +++ b/src/core/qgseditformconfig.h @@ -350,7 +350,7 @@ class CORE_EXPORT QgsEditFormConfig /** * Used for the backwards compatibility of the api, on setting nmrel or force-suppress-popup for relations. - * Returns true when a relation instance (the first one found) has been updated. + * Returns TRUE when a relation instance (the first one found) has been updated. */ bool legacyUpdateRelationWidgetInTabs( QgsAttributeEditorContainer *container, const QString &widgetName, const QVariantMap &config ); diff --git a/src/core/qgseventtracing.h b/src/core/qgseventtracing.h index 2516c2aaed5e..a5bd816d8b75 100644 --- a/src/core/qgseventtracing.h +++ b/src/core/qgseventtracing.h @@ -93,17 +93,17 @@ class CORE_EXPORT QgsEventTracing }; /** - * Starts tracing and clears buffers. Returns true on success (false if tracing is already running). + * Starts tracing and clears buffers. Returns TRUE on success (FALSE if tracing is already running). */ static bool startTracing(); /** - * Stops tracing. Returns true on success (false if tracing is already stopped). + * Stops tracing. Returns TRUE on success (FALSE if tracing is already stopped). */ static bool stopTracing(); /** - * Returns true if tracing is currently in progress. + * Returns TRUE if tracing is currently in progress. */ static bool isTracingEnabled(); diff --git a/src/core/qgsmaplayer.h b/src/core/qgsmaplayer.h index 26f8fe84801b..009ddfdedd5f 100644 --- a/src/core/qgsmaplayer.h +++ b/src/core/qgsmaplayer.h @@ -1572,7 +1572,7 @@ class CORE_EXPORT QgsMapLayer : public QObject /** * Checks whether a new set of dependencies will introduce a cycle - * this method is now deprecated and always return false, because circular dependencies are now correctly managed. + * this method is now deprecated and always return FALSE, because circular dependencies are now correctly managed. * \deprecated since QGIS 3.10 */ Q_DECL_DEPRECATED bool hasDependencyCycle( const QSet & ) const {return false;} diff --git a/src/core/qgsmbtiles.h b/src/core/qgsmbtiles.h index 226830a65b06..c4b2d597fc2c 100644 --- a/src/core/qgsmbtiles.h +++ b/src/core/qgsmbtiles.h @@ -50,7 +50,7 @@ class CORE_EXPORT QgsMbTiles /** * Creates a new MBTiles file and initializes it with metadata and tiles tables. * It is up to the caller to set appropriate metadata entries and add tiles afterwards. - * Returns true on success. If the file exists already, returns false. + * Returns TRUE on success. If the file exists already, returns FALSE. */ bool create(); diff --git a/src/core/qgspointlocator.h b/src/core/qgspointlocator.h index c1251ca97c68..f14ca17d642f 100644 --- a/src/core/qgspointlocator.h +++ b/src/core/qgspointlocator.h @@ -172,7 +172,7 @@ class CORE_EXPORT QgsPointLocator : public QObject * in the constructor. if TRUE, index building will be done in another thread and init() method returns * immediately. initFinished() signal will be emitted once the initialization is over. * - * Returns false if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise true + * Returns FALSE if the creation of index is blocking and has been prematurely stopped due to the limit of features, otherwise TRUE * * \see QgsPointLocator() */ diff --git a/src/core/qgsproperty.h b/src/core/qgsproperty.h index e07eb4c032ff..5dcbcd659018 100644 --- a/src/core/qgsproperty.h +++ b/src/core/qgsproperty.h @@ -351,7 +351,7 @@ class CORE_EXPORT QgsProperty /** * Returns the set of any fields referenced by the property for a specified * expression context. - * \note The optional argument ignoreContext has been added in QGIS 3.14. When set to true, + * \note The optional argument ignoreContext has been added in QGIS 3.14. When set to TRUE, * even fields not set in context's fields() will be reported - this is useful e.g. with vector tiles * where the actual available field names may not be known beforehand. */ diff --git a/src/core/qgspropertycollection.h b/src/core/qgspropertycollection.h index 44270675ab87..ccbb5e453af3 100644 --- a/src/core/qgspropertycollection.h +++ b/src/core/qgspropertycollection.h @@ -232,7 +232,7 @@ class CORE_EXPORT QgsAbstractPropertyCollection /** * Returns the set of any fields referenced by the active properties from the collection. * \param context expression context the properties will be evaluated against. - * \param ignoreContext This parameter has been added in QGIS 3.14. When set to true, even fields not set + * \param ignoreContext This parameter has been added in QGIS 3.14. When set to TRUE, even fields not set * in context's fields() will be reported - this is useful e.g. with vector tiles * where the actual available field names may not be known beforehand. */ @@ -506,7 +506,7 @@ class CORE_EXPORT QgsPropertyCollectionStack : public QgsAbstractPropertyCollect /** * Returns the set of any fields referenced by the active properties from the stack. * \param context expression context the properties will be evaluated against. - * \param ignoreContext This parameter has been added in QGIS 3.14. When set to true, even fields not set + * \param ignoreContext This parameter has been added in QGIS 3.14. When set to TRUE, even fields not set * in context's fields() will be reported - this is useful e.g. with vector tiles * where the actual available field names may not be known beforehand. */ diff --git a/src/core/qgsprovidermetadata.h b/src/core/qgsprovidermetadata.h index 06d080d07f00..950ae8a756e9 100644 --- a/src/core/qgsprovidermetadata.h +++ b/src/core/qgsprovidermetadata.h @@ -251,7 +251,7 @@ class CORE_EXPORT QgsProviderMetadata : public QObject /** * Sets the \a value into the \a uri \a parameter as a bool. - * eg. "yes" value will be saved as true, 0 will be saved as false + * eg. "yes" value will be saved as TRUE, 0 will be saved as FALSE * * \since QGIS 3.14 */ @@ -259,7 +259,7 @@ class CORE_EXPORT QgsProviderMetadata : public QObject /** * Returns the \a parameter value in the \a uri as a bool. - * eg. "yes" value will be returned as true, 0 will be returned as false + * eg. "yes" value will be returned as TRUE, 0 will be returned as FALSE * * \since QGIS 3.14 */ diff --git a/src/core/qgsstringutils.h b/src/core/qgsstringutils.h index 7f34d170c42e..39389ad3794c 100644 --- a/src/core/qgsstringutils.h +++ b/src/core/qgsstringutils.h @@ -280,7 +280,7 @@ class CORE_EXPORT QgsStringUtils * Automatically wraps a \a string by inserting new line characters at appropriate locations in the string. * * The \a length argument specifies either the minimum or maximum length of lines desired, depending - * on whether \a useMaxLineLength is true. If \a useMaxLineLength is TRUE, then the string will be wrapped + * on whether \a useMaxLineLength is TRUE. If \a useMaxLineLength is TRUE, then the string will be wrapped * so that each line ideally will not exceed \a length of characters. If \a useMaxLineLength is FALSE, then * the string will be wrapped so that each line will ideally exceed \a length of characters. * diff --git a/src/core/qgstilecache.h b/src/core/qgstilecache.h index c5dfc9bb7c7a..6f6f0eac4eff 100644 --- a/src/core/qgstilecache.h +++ b/src/core/qgstilecache.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsTileCache /** * Try to access a tile and load it into "image" argument - * \returns true if the tile exists in the cache + * \returns TRUE if the tile exists in the cache */ static bool tile( const QUrl &url, QImage &image ); diff --git a/src/core/qgsvectorlayereditbuffer.h b/src/core/qgsvectorlayereditbuffer.h index 7b42249e182d..69f3e9a2c6d9 100644 --- a/src/core/qgsvectorlayereditbuffer.h +++ b/src/core/qgsvectorlayereditbuffer.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject /** * Adds a feature * \param f feature to add - * \returns TRUE in case of success and False in case of error + * \returns TRUE in case of success and FALSE in case of error */ virtual bool addFeature( QgsFeature &f ); diff --git a/src/core/qgsvectorlayerfeatureiterator.cpp b/src/core/qgsvectorlayerfeatureiterator.cpp index 3ccf908b5920..958e9ae8b093 100644 --- a/src/core/qgsvectorlayerfeatureiterator.cpp +++ b/src/core/qgsvectorlayerfeatureiterator.cpp @@ -317,7 +317,7 @@ QgsVectorLayerFeatureIterator::~QgsVectorLayerFeatureIterator() /** * This class guards against infinite recursion. * The counter will be created per thread and hasStackOverflow will return - * true if more than maxDepth instances are created in parallel in a thread. + * TRUE if more than maxDepth instances are created in parallel in a thread. */ class QgsThreadStackOverflowGuard { diff --git a/src/core/qgsvectorlayerjoinbuffer.h b/src/core/qgsvectorlayerjoinbuffer.h index c294fd50674d..09755db13dfe 100644 --- a/src/core/qgsvectorlayerjoinbuffer.h +++ b/src/core/qgsvectorlayerjoinbuffer.h @@ -49,7 +49,7 @@ class CORE_EXPORT QgsVectorLayerJoinBuffer : public QObject, public QgsFeatureSi /** * Removes a vector layer join - * \returns true if join was found and successfully removed + * \returns TRUE if join was found and successfully removed */ bool removeJoin( const QString &joinLayerId ); diff --git a/src/core/qgsvectorlayerjoininfo.h b/src/core/qgsvectorlayerjoininfo.h index da3eb300d5c3..21f68f9de0ed 100644 --- a/src/core/qgsvectorlayerjoininfo.h +++ b/src/core/qgsvectorlayerjoininfo.h @@ -69,7 +69,7 @@ class CORE_EXPORT QgsVectorLayerJoinInfo /** * Returns whether values from the joined layer should be cached in memory to speed up lookups. - * Will return false if upsertOnEdit is enabled. + * Will return FALSE if upsertOnEdit is enabled. */ bool isUsingMemoryCache() const; diff --git a/src/core/qgsvectorlayertools.h b/src/core/qgsvectorlayertools.h index ee746fa7fd08..bc164199b730 100644 --- a/src/core/qgsvectorlayertools.h +++ b/src/core/qgsvectorlayertools.h @@ -105,7 +105,7 @@ class CORE_EXPORT QgsVectorLayerTools : public QObject * \param dx The translation on x * \param dy The translation on y * \param errorMsg If given, it will contain the error message - * \param topologicalEditing If true, the function will perform topological + * \param topologicalEditing If TRUE, the function will perform topological * editing of the vertices of \a layer on \a layer and \a topologicalLayer * \param topologicalLayer The layer where vertices from the moved features of \a layer will be added * \returns TRUE if all features could be copied. diff --git a/src/core/qgsvectorlayerutils.h b/src/core/qgsvectorlayerutils.h index 96feaabdae5f..c78194ab16bc 100644 --- a/src/core/qgsvectorlayerutils.h +++ b/src/core/qgsvectorlayerutils.h @@ -295,8 +295,8 @@ class CORE_EXPORT QgsVectorLayerUtils static QgsFeatureList makeFeaturesCompatible( const QgsFeatureList &features, const QgsVectorLayer *layer, QgsFeatureSink::SinkFlags sinkFlags = QgsFeatureSink::SinkFlags() ); /** - * \return true if the \param feature field at index \param fieldIndex from \param layer - * is editable, false if the field is readonly + * \return TRUE if the \param feature field at index \param fieldIndex from \param layer + * is editable, FALSE if the field is readonly * * \since QGIS 3.10 */ diff --git a/src/core/raster/qgsrasterdataprovider.h b/src/core/raster/qgsrasterdataprovider.h index 68a3f3cecded..4cde8effd92c 100644 --- a/src/core/raster/qgsrasterdataprovider.h +++ b/src/core/raster/qgsrasterdataprovider.h @@ -552,7 +552,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast virtual QList< double > nativeResolutions() const; /** - * Returns true if the extents reported by the data provider are not reliable + * Returns TRUE if the extents reported by the data provider are not reliable * and it's possible that there is renderable content outside of these extents. * * \since QGIS 3.10.0 @@ -587,7 +587,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** * Enable or disable provider-level resampling. * - * \return true if success + * \return TRUE if success * \since QGIS 3.16 */ virtual bool enableProviderResampling( bool enable ) { Q_UNUSED( enable ); return false; } @@ -620,7 +620,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** * Set resampling method to apply for zoomed-in operations. * - * \return true if success + * \return TRUE if success * \since QGIS 3.16 */ virtual bool setZoomedInResamplingMethod( ResamplingMethod method ) { Q_UNUSED( method ); return false; } @@ -634,7 +634,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** * Set resampling method to apply for zoomed-out operations. * - * \return true if success + * \return TRUE if success * \since QGIS 3.16 */ virtual bool setZoomedOutResamplingMethod( ResamplingMethod method ) { Q_UNUSED( method ); return false; } @@ -648,7 +648,7 @@ class CORE_EXPORT QgsRasterDataProvider : public QgsDataProvider, public QgsRast /** * Sets maximum oversampling factor for zoomed-out operations. * - * \return true if success + * \return TRUE if success * \since QGIS 3.16 */ virtual bool setMaxOversampling( double factor ) { Q_UNUSED( factor ); return false; } diff --git a/src/core/raster/qgsrasterlayer.cpp b/src/core/raster/qgsrasterlayer.cpp index d6d6ec3f0f47..9cf5d71b1335 100644 --- a/src/core/raster/qgsrasterlayer.cpp +++ b/src/core/raster/qgsrasterlayer.cpp @@ -1760,7 +1760,7 @@ QImage QgsRasterLayer::previewAsImage( QSize size, const QColor &bgColor, QImage /* * \param QDomNode node that will contain the symbology definition for this layer. * \param errorMessage reference to string that will be updated with any error messages - * \return true in case of success. + * \return TRUE in case of success. */ bool QgsRasterLayer::readSymbology( const QDomNode &layer_node, QString &errorMessage, QgsReadWriteContext &context, QgsMapLayer::StyleCategories categories ) diff --git a/src/core/symbology/qgsarrowsymbollayer.cpp b/src/core/symbology/qgsarrowsymbollayer.cpp index daba20d64a6e..112abedb449b 100644 --- a/src/core/symbology/qgsarrowsymbollayer.cpp +++ b/src/core/symbology/qgsarrowsymbollayer.cpp @@ -334,7 +334,7 @@ inline qreal clampAngle( qreal a ) /** * Compute the circumscribed circle from three points - * \return false if the three points are colinear + * \return FALSE if the three points are colinear */ bool pointsToCircle( QPointF a, QPointF b, QPointF c, QPointF ¢er, qreal &radius ) { diff --git a/src/core/symbology/qgslinesymbollayer.h b/src/core/symbology/qgslinesymbollayer.h index 2ec611354560..e73d1fdeff3f 100644 --- a/src/core/symbology/qgslinesymbollayer.h +++ b/src/core/symbology/qgslinesymbollayer.h @@ -628,7 +628,7 @@ class CORE_EXPORT QgsTemplatedLineSymbolLayerBase : public QgsLineSymbolLayer * in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be * rendered. * - * If \a selected is true then the symbol will be drawn using the "selected feature" + * If \a selected is TRUE then the symbol will be drawn using the "selected feature" * style and colors instead of the symbol's normal style. */ virtual void renderSymbol( const QPointF &point, const QgsFeature *feature, QgsRenderContext &context, int layer = -1, bool selected = false ) = 0; diff --git a/src/core/symbology/qgsrendererrange.h b/src/core/symbology/qgsrendererrange.h index 09ec9732df2b..e947a8fc6dcf 100644 --- a/src/core/symbology/qgsrendererrange.h +++ b/src/core/symbology/qgsrendererrange.h @@ -46,7 +46,7 @@ class CORE_EXPORT QgsRendererRange * Creates a renderer symbol range * \param range The classification range * \param symbol The symbol for this renderer range - * \param render If true, it will be renderered + * \param render If TRUE, it will be renderered */ QgsRendererRange( const QgsClassificationRange &range, QgsSymbol *symbol SIP_TRANSFER, bool render = true ); QgsRendererRange( double lowerValue, double upperValue, QgsSymbol *symbol SIP_TRANSFER, const QString &label, bool render = true ); diff --git a/src/core/symbology/qgssymbol.h b/src/core/symbology/qgssymbol.h index e6eb6a2c3631..c7e032069303 100644 --- a/src/core/symbology/qgssymbol.h +++ b/src/core/symbology/qgssymbol.h @@ -468,7 +468,7 @@ class CORE_EXPORT QgsSymbol * extent. If this option is enabled then features which are partially outside the extent * will be clipped. This speeds up rendering of the feature, but may have undesirable * side effects for certain symbol types. - * \param clipFeaturesToExtent set to true to enable clipping (defaults to TRUE) + * \param clipFeaturesToExtent set to TRUE to enable clipping (defaults to TRUE) * \see clipFeaturesToExtent * \since QGIS 2.9 */ @@ -1081,7 +1081,7 @@ class CORE_EXPORT QgsMarkerSymbol : public QgsSymbol * in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be * rendered. * - * If \a selected is true then the symbol will be drawn using the "selected feature" + * If \a selected is TRUE then the symbol will be drawn using the "selected feature" * style and colors instead of the symbol's normal style. */ void renderPoint( QPointF point, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false ); @@ -1197,7 +1197,7 @@ class CORE_EXPORT QgsLineSymbol : public QgsSymbol * in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be * rendered. * - * If \a selected is true then the symbol will be drawn using the "selected feature" + * If \a selected is TRUE then the symbol will be drawn using the "selected feature" * style and colors instead of the symbol's normal style. */ void renderPolyline( const QPolygonF &points, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false ); @@ -1247,7 +1247,7 @@ class CORE_EXPORT QgsFillSymbol : public QgsSymbol * in the \a layer argument. A \a layer of -1 indicates that all symbol layers should be * rendered. * - * If \a selected is true then the symbol will be drawn using the "selected feature" + * If \a selected is TRUE then the symbol will be drawn using the "selected feature" * style and colors instead of the symbol's normal style. */ void renderPolygon( const QPolygonF &points, const QVector *rings, const QgsFeature *f, QgsRenderContext &context, int layer = -1, bool selected = false ); diff --git a/src/core/vectortile/qgsvectortilewriter.h b/src/core/vectortile/qgsvectortilewriter.h index 01dc7763412b..75410b1731a0 100644 --- a/src/core/vectortile/qgsvectortilewriter.h +++ b/src/core/vectortile/qgsvectortilewriter.h @@ -149,7 +149,7 @@ class CORE_EXPORT QgsVectorTileWriter /** * Writes vector tiles according to the configuration. - * Returns true on success (upon failure one can get error cause using errorMessage()) + * Returns TRUE on success (upon failure one can get error cause using errorMessage()) * * If a pointer to a feedback object is provided, it can be used to track progress or * provide cancellation functionality. diff --git a/src/gui/codeeditors/qgscodeeditorexpression.h b/src/gui/codeeditors/qgscodeeditorexpression.h index a6305f31c7a0..e379e7bce21c 100644 --- a/src/gui/codeeditors/qgscodeeditorexpression.h +++ b/src/gui/codeeditors/qgscodeeditorexpression.h @@ -76,7 +76,7 @@ class GUI_EXPORT QgsCodeEditorExpression : public QgsCodeEditor * * setAutoCompletionCaseSensitivity( false ) is not sufficient when installing * a lexer, since its caseSensitive() method is actually used, and defaults - * to true. + * to TRUE. * \note not available in Python bindings * \ingroup gui */ diff --git a/src/gui/codeeditors/qgscodeeditorsql.h b/src/gui/codeeditors/qgscodeeditorsql.h index 5541429817a9..55c30f616a18 100644 --- a/src/gui/codeeditors/qgscodeeditorsql.h +++ b/src/gui/codeeditors/qgscodeeditorsql.h @@ -65,7 +65,7 @@ class GUI_EXPORT QgsCodeEditorSQL : public QgsCodeEditor * * setAutoCompletionCaseSensitivity( false ) is not sufficient when installing * a lexer, since its caseSensitive() method is actually used, and defaults - * to true. + * to TRUE. * \note not available in Python bindings * \ingroup gui */ diff --git a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h index b6f5fabb058e..ade5fbcb002a 100644 --- a/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h +++ b/src/gui/editorwidgets/core/qgseditorwidgetwrapper.h @@ -186,7 +186,7 @@ class GUI_EXPORT QgsEditorWidgetWrapper : public QgsWidgetWrapper bool isValidConstraint() const; /** - * Returns true if the widget is preventing the feature from being committed. This may be TRUE as a result + * Returns TRUE if the widget is preventing the feature from being committed. This may be TRUE as a result * of attribute values failing enforced field constraints. * \see isValidConstraint() * \since QGIS 3.0 diff --git a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h index a740c55fb822..6c3c48fc603c 100644 --- a/src/gui/editorwidgets/qgsrelationwidgetwrapper.h +++ b/src/gui/editorwidgets/qgsrelationwidgetwrapper.h @@ -114,7 +114,7 @@ class GUI_EXPORT QgsRelationWidgetWrapper : public QgsWidgetWrapper /** * Sets force suppress form popup status to \a forceSuppressFormPopup for this widget - * and for the vectorLayerTools (if true). + * and for the vectorLayerTools (if TRUE). * This flag will override the layer and general settings regarding the automatic * opening of the attribute form dialog when digitizing is completed. * \since QGIS 3.16 diff --git a/src/gui/layout/qgslayoutattributeselectiondialog.h b/src/gui/layout/qgslayoutattributeselectiondialog.h index c807ba269010..ee464edfa12d 100644 --- a/src/gui/layout/qgslayoutattributeselectiondialog.h +++ b/src/gui/layout/qgslayoutattributeselectiondialog.h @@ -104,7 +104,7 @@ class GUI_EXPORT QgsLayoutAttributeTableColumnModelBase: public QAbstractTableMo /** * Moves the specified row up or down in the model. Used for rearranging the attribute tables * columns. - * \returns true if the move is allowed + * \returns TRUE if the move is allowed * \param row row in model representing attribute table column to move * \param direction direction to move the attribute table column */ diff --git a/src/gui/layout/qgslayoutimageexportoptionsdialog.h b/src/gui/layout/qgslayoutimageexportoptionsdialog.h index 6547d7b97733..3d9699afc0bb 100644 --- a/src/gui/layout/qgslayoutimageexportoptionsdialog.h +++ b/src/gui/layout/qgslayoutimageexportoptionsdialog.h @@ -81,7 +81,7 @@ class GUI_EXPORT QgsLayoutImageExportOptionsDialog: public QDialog, private Ui:: /** * Sets whether the crop to contents option should be checked in the dialog - * \param crop set to true to check crop to contents + * \param crop set to TRUE to check crop to contents * \see cropToContents() */ void setCropToContents( bool crop ); diff --git a/src/gui/qgisinterface.h b/src/gui/qgisinterface.h index 2e90181b6d61..a9fd1b1a665e 100644 --- a/src/gui/qgisinterface.h +++ b/src/gui/qgisinterface.h @@ -912,7 +912,7 @@ class GUI_EXPORT QgisInterface : public QObject /** * Add a dock widget to the given area and tabify it (if other dock widgets * exist in the same \a area). The new tab will be below other tabs unless - * \a raiseTab is passed as true. + * \a raiseTab is passed as TRUE. * * \a tabifyWith is a list of dock widget object names, ordered by * priority, with which the new dock widget should be tabified. Only the @@ -1117,7 +1117,7 @@ class GUI_EXPORT QgisInterface : public QObject /** * Opens a new feature form. - * Returns true if dialog was accepted (if shown modal, TRUE otherwise). + * Returns TRUE if dialog was accepted (if shown modal, TRUE otherwise). * \param l vector layer * \param f feature to show/modify * \param updateFeatureOnly only update the feature update (don't change any attributes of the layer) [UNUSED] diff --git a/src/gui/qgsdataitemguiprovider.h b/src/gui/qgsdataitemguiprovider.h index a875a2d51d31..2d3e642dd2ff 100644 --- a/src/gui/qgsdataitemguiprovider.h +++ b/src/gui/qgsdataitemguiprovider.h @@ -133,7 +133,7 @@ class GUI_EXPORT QgsDataItemGuiProvider /** * Tries to permanently delete map layer representing the given item. - * Returns true if the layer was successfully deleted. + * Returns TRUE if the layer was successfully deleted. * * Items which implement this method should return the QgsDataItem::Delete capability. * diff --git a/src/gui/qgsdatumtransformdialog.h b/src/gui/qgsdatumtransformdialog.h index 55718f4ddd18..cba2fc6bff18 100644 --- a/src/gui/qgsdatumtransformdialog.h +++ b/src/gui/qgsdatumtransformdialog.h @@ -125,7 +125,7 @@ class GUI_EXPORT QgsDatumTransformDialog : public QDialog, private Ui::QgsDatumT void setOKButtonEnabled(); /** - * Returns true if the dialog should be shown and the user prompted to make the transformation selection. + * Returns TRUE if the dialog should be shown and the user prompted to make the transformation selection. * * \see defaultDatumTransform() */ diff --git a/src/gui/qgsgui.h b/src/gui/qgsgui.h index 08a76cb9e790..b852195f2d54 100644 --- a/src/gui/qgsgui.h +++ b/src/gui/qgsgui.h @@ -208,7 +208,7 @@ class GUI_EXPORT QgsGui : public QObject static QScreen *findScreenAt( QPoint point ); /** - * Returns true if python macros are currently allowed to be run + * Returns TRUE if python macros are currently allowed to be run * If the global option is to ask user, a modal dialog will be shown * \param lambda a pointer to a lambda method. If specified, the dialog is not modal, * a message is shown with a button to enable macro. diff --git a/src/gui/qgsguiutils.h b/src/gui/qgsguiutils.h index 2097a4abea90..647a5630274e 100644 --- a/src/gui/qgsguiutils.h +++ b/src/gui/qgsguiutils.h @@ -89,7 +89,7 @@ namespace QgsGuiUtils * the current working directory if this is the first time invoked * with the current filter name. * - * This method returns true if cancel all was clicked, otherwise false + * This method returns TRUE if cancel all was clicked, otherwise FALSE */ bool GUI_EXPORT openFilesRememberingFilter( QString const &filterName, @@ -177,7 +177,7 @@ namespace QgsGuiUtils /** * Returns the user-preferred size of a window's toolbar icons. - * \param dockableToolbar If set to true, the icon size will be returned for dockable window panel's toolbars. + * \param dockableToolbar If set to TRUE, the icon size will be returned for dockable window panel's toolbars. * \returns a QSize object representing an icon's width and height. * \since QGIS 3.8 */ diff --git a/src/gui/qgsmapcanvas.h b/src/gui/qgsmapcanvas.h index 3e9625c5b637..7182a358551c 100644 --- a/src/gui/qgsmapcanvas.h +++ b/src/gui/qgsmapcanvas.h @@ -303,7 +303,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * Centers canvas extent to feature ids * \param layer the vector layer * \param ids the feature ids - * \param alwaysRecenter if false, the canvas is recentered only if the bounding box is not contained within the current extent + * \param alwaysRecenter if FALSE, the canvas is recentered only if the bounding box is not contained within the current extent */ void panToFeatureIds( QgsVectorLayer *layer, const QgsFeatureIds &ids, bool alwaysRecenter = true ); @@ -1283,7 +1283,7 @@ class GUI_EXPORT QgsMapCanvas : public QGraphicsView * \param layer the layer * \param bbox out: bounding box * \param errorMsg error message in case of error - * \returns true in case of success + * \returns TRUE in case of success */ bool boundingBoxOfFeatureIds( const QgsFeatureIds &ids, QgsVectorLayer *layer, QgsRectangle &bbox, QString &errorMsg ) const; diff --git a/src/gui/qgsmapcanvasitem.h b/src/gui/qgsmapcanvasitem.h index 5e923dc4921d..24ce2fdc0a01 100644 --- a/src/gui/qgsmapcanvasitem.h +++ b/src/gui/qgsmapcanvasitem.h @@ -53,7 +53,7 @@ class GUI_EXPORT QgsMapCanvasItem : public QGraphicsItem * Sets render context parameters * \param p painter for rendering * \param context out: configured context - * \returns true in case of success + * \returns TRUE in case of success */ bool setRenderContextVariables( QPainter *p, QgsRenderContext &context ) const; diff --git a/src/gui/qgsmaplayerconfigwidget.h b/src/gui/qgsmaplayerconfigwidget.h index 6f4672cc08e0..d53c4ad0eb8d 100644 --- a/src/gui/qgsmaplayerconfigwidget.h +++ b/src/gui/qgsmaplayerconfigwidget.h @@ -47,7 +47,7 @@ class GUI_EXPORT QgsMapLayerConfigWidget : public QgsPanelWidget /** * Whether this config widget changes map layer properties in a way that triggerRepaint() should - * be called for the layer after applying changes. This is true by default, but some config widgets + * be called for the layer after applying changes. This is TRUE by default, but some config widgets * (for example 3D rendering config) do not need layer repaint as they do not modify 2D map rendering. * \since QGIS 3.8 */ diff --git a/src/gui/qgsmaptooldigitizefeature.h b/src/gui/qgsmaptooldigitizefeature.h index 9e6170e122a6..638e68ed448e 100644 --- a/src/gui/qgsmaptooldigitizefeature.h +++ b/src/gui/qgsmaptooldigitizefeature.h @@ -72,13 +72,13 @@ class GUI_EXPORT QgsMapToolDigitizeFeature : public QgsMapToolCapture protected: /** - * Check if CaptureMode matches layer type. Default is true. + * Check if CaptureMode matches layer type. Default is TRUE. * \since QGIS 3.0 */ bool checkGeometryType() const; /** - * Check if CaptureMode matches layer type. Default is true. + * Check if CaptureMode matches layer type. Default is TRUE. * \since QGIS 3.0 */ void setCheckGeometryType( bool checkGeometryType ); @@ -104,7 +104,7 @@ class GUI_EXPORT QgsMapToolDigitizeFeature : public QgsMapToolCapture QgsMapLayer *mCurrentLayer = nullptr; /** - * Check if CaptureMode matches layer type. Default is true. + * Check if CaptureMode matches layer type. Default is TRUE. * \since QGIS 2.12 */ bool mCheckGeometryType; diff --git a/src/gui/qgsscalecombobox.h b/src/gui/qgsscalecombobox.h index 6730775e4e4b..9bfc3b3e4be2 100644 --- a/src/gui/qgsscalecombobox.h +++ b/src/gui/qgsscalecombobox.h @@ -60,7 +60,7 @@ class GUI_EXPORT QgsScaleComboBox : public QComboBox double scale() const; /** - * Returns true if the combo box is currently set to a "null" value. + * Returns TRUE if the combo box is currently set to a "null" value. * * \see setAllowNull() * \see setNull() @@ -145,7 +145,7 @@ class GUI_EXPORT QgsScaleComboBox : public QComboBox /** * Sets the combo box to the null value. * - * This only has an effect if allowNull() is true. + * This only has an effect if allowNull() is TRUE. * * \see allowNull() * \see isNull() diff --git a/src/gui/qgsscalewidget.h b/src/gui/qgsscalewidget.h index 9796dfdb546f..948700e02f0a 100644 --- a/src/gui/qgsscalewidget.h +++ b/src/gui/qgsscalewidget.h @@ -85,7 +85,7 @@ class GUI_EXPORT QgsScaleWidget : public QWidget double scale() const { return mScaleComboBox->scale(); } /** - * Returns true if the widget is currently set to a "null" value. + * Returns TRUE if the widget is currently set to a "null" value. * * \see setAllowNull() * \see setNull() @@ -168,7 +168,7 @@ class GUI_EXPORT QgsScaleWidget : public QWidget /** * Sets the widget to the null value. * - * This only has an effect if allowNull() is true. + * This only has an effect if allowNull() is TRUE. * * \see allowNull() * \see isNull() diff --git a/src/gui/vector/qgssourcefieldsproperties.h b/src/gui/vector/qgssourcefieldsproperties.h index c204cbdfea4c..8154cd768cd4 100644 --- a/src/gui/vector/qgssourcefieldsproperties.h +++ b/src/gui/vector/qgssourcefieldsproperties.h @@ -56,7 +56,7 @@ class GUI_EXPORT QgsSourceFieldsProperties : public QWidget, private Ui_QgsSourc /** * Adds an attribute to the table (but does not commit it yet) * \param field the field to add - * \returns false in case of a name conflict, true in case of success + * \returns FALSE in case of a name conflict, TRUE in case of success */ bool addAttribute( const QgsField &field ); diff --git a/src/plugins/grass/qgsgrassmoduleoptions.h b/src/plugins/grass/qgsgrassmoduleoptions.h index 4287348615ac..b678367647d3 100644 --- a/src/plugins/grass/qgsgrassmoduleoptions.h +++ b/src/plugins/grass/qgsgrassmoduleoptions.h @@ -186,7 +186,7 @@ class QgsGrassModuleStandardOptions: public QWidget, public QgsGrassModuleOption /** * Gets region for currently selected map. It will show warning dialog if region could not be read. - * \returns true if region was successfully read + * \returns TRUE if region was successfully read */ bool getCurrentMapRegion( QgsGrassModuleInput *param, struct Cell_head *window ); diff --git a/src/plugins/grass/qtermwidget/Emulation.h b/src/plugins/grass/qtermwidget/Emulation.h index 9b19c5997395..c716bbf822b0 100644 --- a/src/plugins/grass/qtermwidget/Emulation.h +++ b/src/plugins/grass/qtermwidget/Emulation.h @@ -40,431 +40,431 @@ namespace Konsole { -class KeyboardTranslator; -class HistoryType; -class Screen; -class ScreenWindow; -class TerminalCharacterDecoder; - -/** - * This enum describes the available states which - * the terminal emulation may be set to. - * - * These are the values used by Emulation::stateChanged() - */ -enum -{ + class KeyboardTranslator; + class HistoryType; + class Screen; + class ScreenWindow; + class TerminalCharacterDecoder; + + /** + * This enum describes the available states which + * the terminal emulation may be set to. + * + * These are the values used by Emulation::stateChanged() + */ + enum + { /** The emulation is currently receiving user input. */ - NOTIFYNORMAL=0, + NOTIFYNORMAL = 0, /** * The terminal program has triggered a bell event * to get the user's attention. */ - NOTIFYBELL=1, + NOTIFYBELL = 1, /** * The emulation is currently receiving data from its * terminal input. */ - NOTIFYACTIVITY=2, + NOTIFYACTIVITY = 2, // unused here? - NOTIFYSILENCE=3 -}; - -/** - * Base class for terminal emulation back-ends. - * - * The back-end is responsible for decoding an incoming character stream and - * producing an output image of characters. - * - * When input from the terminal is received, the receiveData() slot should be called with - * the data which has arrived. The emulation will process the data and update the - * screen image accordingly. The codec used to decode the incoming character stream - * into the unicode characters used internally can be specified using setCodec() - * - * The size of the screen image can be specified by calling setImageSize() with the - * desired number of lines and columns. When new lines are added, old content - * is moved into a history store, which can be set by calling setHistory(). - * - * The screen image can be accessed by creating a ScreenWindow onto this emulation - * by calling createWindow(). Screen windows provide access to a section of the - * output. Each screen window covers the same number of lines and columns as the - * image size returned by imageSize(). The screen window can be moved up and down - * and provides transparent access to both the current on-screen image and the - * previous output. The screen windows emit an outputChanged signal - * when the section of the image they are looking at changes. - * Graphical views can then render the contents of a screen window, listening for notifications - * of output changes from the screen window which they are associated with and updating - * accordingly. - * - * The emulation also is also responsible for converting input from the connected views such - * as keypresses and mouse activity into a character string which can be sent - * to the terminal program. Key presses can be processed by calling the sendKeyEvent() slot, - * while mouse events can be processed using the sendMouseEvent() slot. When the character - * stream has been produced, the emulation will emit a sendData() signal with a pointer - * to the character buffer. This data should be fed to the standard input of the terminal - * process. The translation of key presses into an output character stream is performed - * using a lookup in a set of key bindings which map key sequences to output - * character sequences. The name of the key bindings set used can be specified using - * setKeyBindings() - * - * The emulation maintains certain state information which changes depending on the - * input received. The emulation can be reset back to its starting state by calling - * reset(). - * - * The emulation also maintains an activity state, which specifies whether - * terminal is currently active ( when data is received ), normal - * ( when the terminal is idle or receiving user input ) or trying - * to alert the user ( also known as a "Bell" event ). The stateSet() signal - * is emitted whenever the activity state is set. This can be used to determine - * how long the emulation has been active/idle for and also respond to - * a 'bell' event in different ways. - */ -class KONSOLEPRIVATE_EXPORT Emulation : public QObject -{ -Q_OBJECT - -public: - - /** Constructs a new terminal emulation */ - Emulation(); - ~Emulation() override; - - /** - * Creates a new window onto the output from this emulation. The contents - * of the window are then rendered by views which are set to use this window using the - * TerminalDisplay::setScreenWindow() method. - */ - ScreenWindow* createWindow(); - - /** Returns the size of the screen image which the emulation produces */ - QSize imageSize() const; - - /** - * Returns the total number of lines, including those stored in the history. - */ - int lineCount() const; - - /** - * Sets the history store used by this emulation. When new lines - * are added to the output, older lines at the top of the screen are transferred to a history - * store. - * - * The number of lines which are kept and the storage location depend on the - * type of store. - */ - void setHistory(const HistoryType&); - /** Returns the history store used by this emulation. See setHistory() */ - const HistoryType& history() const; - /** Clears the history scroll. */ - void clearHistory(); - - /** - * Copies the output history from @p startLine to @p endLine - * into @p stream, using @p decoder to convert the terminal - * characters into text. - * - * \param decoder A decoder which converts lines of terminal characters with - * appearance attributes into output text. PlainTextDecoder is the most commonly - * used decoder. - * \param startLine Index of first line to copy - * \param endLine Index of last line to copy - */ - virtual void writeToStream(TerminalCharacterDecoder* decoder,int startLine,int endLine); - - /** Returns the codec used to decode incoming characters. See setCodec() */ - const QTextCodec* codec() const { return _codec; } - /** Sets the codec used to decode incoming characters. */ - void setCodec(const QTextCodec*); - - /** - * Convenience method. - * Returns true if the current codec used to decode incoming - * characters is UTF-8 - */ - bool utf8() const - { Q_ASSERT(_codec); return _codec->mibEnum() == 106; } - - - /** TODO Document me */ - virtual char eraseChar() const; - - /** - * Sets the key bindings used to key events - * ( received through sendKeyEvent() ) into character - * streams to send to the terminal. - */ - void setKeyBindings(const QString& name); - /** - * Returns the name of the emulation's current key bindings. - * See setKeyBindings() - */ - QString keyBindings() const; - - /** - * Copies the current image into the history and clears the screen. - */ - virtual void clearEntireScreen() =0; - - /** Resets the state of the terminal. */ - virtual void reset() =0; - - /** - * Returns true if the active terminal program wants - * mouse input events. - * - * The programUsesMouseChanged() signal is emitted when this - * changes. - */ - bool programUsesMouse() const; - -public slots: - - /** Change the size of the emulation's image */ - virtual void setImageSize(int lines, int columns); - - /** - * Interprets a sequence of characters and sends the result to the terminal. - * This is equivalent to calling sendKeyEvent() for each character in @p text in succession. - */ - virtual void sendText(const QString& text) = 0; - - /** - * Interprets a key press event and emits the sendData() signal with - * the resulting character stream. - */ - virtual void sendKeyEvent(QKeyEvent*); - - /** - * Converts information about a mouse event into an xterm-compatible escape - * sequence and emits the character sequence via sendData() - */ - virtual void sendMouseEvent(int buttons, int column, int line, int eventType); - - /** - * Sends a string of characters to the foreground terminal process. - * - * \param string The characters to send. - * \param length Length of @p string or if set to a negative value, @p string will - * be treated as a null-terminated string and its length will be determined automatically. - */ - virtual void sendString(const char* string, int length = -1) = 0; - - /** - * Processes an incoming stream of characters. receiveData() decodes the incoming - * character buffer using the current codec(), and then calls receiveChar() for - * each unicode character in the resulting buffer. - * - * receiveData() also starts a timer which causes the outputChanged() signal - * to be emitted when it expires. The timer allows multiple updates in quick - * succession to be buffered into a single outputChanged() signal emission. - * - * \param buffer A string of characters received from the terminal program. - * \param len The length of @p buffer - */ - void receiveData(const char* buffer,int len); - -signals: - - /** - * Emitted when a buffer of data is ready to send to the - * standard input of the terminal. - * - * \param data The buffer of data ready to be sent - * \param len The length of @p data in bytes - */ - void sendData(const char* data,int len); - - /** - * Requests that sending of input to the emulation - * from the terminal process be suspended or resumed. - * - * \param suspend If true, requests that sending of - * input from the terminal process' stdout be - * suspended. Otherwise requests that sending of - * input be resumed. - */ - void lockPtyRequest(bool suspend); - - /** - * Requests that the pty used by the terminal process - * be set to UTF 8 mode. - * - * TODO: More documentation - */ - void useUtf8Request(bool); - - /** - * Emitted when the activity state of the emulation is set. - * - * \param state The new activity state, one of NOTIFYNORMAL, NOTIFYACTIVITY - * or NOTIFYBELL - */ - void stateSet(int state); - - /** TODO Document me */ - void zmodemDetected(); - - - /** - * Requests that the color of the text used - * to represent the tabs associated with this - * emulation be changed. This is a Konsole-specific - * extension from pre-KDE 4 times. - * - * TODO: Document how the parameter works. - */ - void changeTabTextColorRequest(int color); - - /** - * This is emitted when the program running in the shell indicates whether or - * not it is interested in mouse events. - * - * \param usesMouse This will be true if the program wants to be informed about - * mouse events or false otherwise. - */ - void programUsesMouseChanged(bool usesMouse); + NOTIFYSILENCE = 3 + }; /** - * Emitted when the contents of the screen image change. - * The emulation buffers the updates from successive image changes, - * and only emits outputChanged() at sensible intervals when - * there is a lot of terminal activity. - * - * Normally there is no need for objects other than the screen windows - * created with createWindow() to listen for this signal. + * Base class for terminal emulation back-ends. * - * ScreenWindow objects created using createWindow() will emit their - * own outputChanged() signal in response to this signal. - */ - void outputChanged(); - - /** - * Emitted when the program running in the terminal wishes to update the - * session's title. This also allows terminal programs to customize other - * aspects of the terminal emulation display. + * The back-end is responsible for decoding an incoming character stream and + * producing an output image of characters. * - * This signal is emitted when the escape sequence "\033]ARG;VALUE\007" - * is received in the input string, where ARG is a number specifying what - * should change and VALUE is a string specifying the new value. + * When input from the terminal is received, the receiveData() slot should be called with + * the data which has arrived. The emulation will process the data and update the + * screen image accordingly. The codec used to decode the incoming character stream + * into the unicode characters used internally can be specified using setCodec() * - * TODO: The name of this method is not very accurate since this method - * is used to perform a whole range of tasks besides just setting - * the user-title of the session. + * The size of the screen image can be specified by calling setImageSize() with the + * desired number of lines and columns. When new lines are added, old content + * is moved into a history store, which can be set by calling setHistory(). * - * \param title Specifies what to change. - *
    - *
  • 0 - Set window icon text and session title to @p newTitle
    • - *
  • 1 - Set window icon text to @p newTitle
    • - *
  • 2 - Set session title to @p newTitle
    • - *
  • 11 - Set the session's default background color to @p newTitle, - * where @p newTitle can be an HTML-style string ("#RRGGBB") or a named - * color (e.g., 'red', 'blue'). - * See http://doc.trolltech.com/4.2/qcolor.html#setNamedColor for more - * details. - *
    • - *
  • 31 - Supposedly treats @p newTitle as a URL and opens it (NOT IMPLEMENTED)
    • - *
  • 32 - Sets the icon associated with the session. @p newTitle is the name - * of the icon to use, which can be the name of any icon in the current KDE icon - * theme (e.g., 'konsole', 'kate', 'folder_home')
    • - *
- * \param newTitle Specifies the new title - */ - - void titleChanged(int title,const QString& newTitle); - - /** - * Emitted when the program running in the terminal changes the - * screen size. - */ - void imageSizeChanged(int lineCount , int columnCount); - - /** - * Emitted when the terminal program requests to change various properties - * of the terminal display. + * The screen image can be accessed by creating a ScreenWindow onto this emulation + * by calling createWindow(). Screen windows provide access to a section of the + * output. Each screen window covers the same number of lines and columns as the + * image size returned by imageSize(). The screen window can be moved up and down + * and provides transparent access to both the current on-screen image and the + * previous output. The screen windows emit an outputChanged signal + * when the section of the image they are looking at changes. + * Graphical views can then render the contents of a screen window, listening for notifications + * of output changes from the screen window which they are associated with and updating + * accordingly. * - * A profile change command occurs when a special escape sequence, followed - * by a string containing a series of name and value pairs is received. - * This string can be parsed using a ProfileCommandParser instance. + * The emulation also is also responsible for converting input from the connected views such + * as keypresses and mouse activity into a character string which can be sent + * to the terminal program. Key presses can be processed by calling the sendKeyEvent() slot, + * while mouse events can be processed using the sendMouseEvent() slot. When the character + * stream has been produced, the emulation will emit a sendData() signal with a pointer + * to the character buffer. This data should be fed to the standard input of the terminal + * process. The translation of key presses into an output character stream is performed + * using a lookup in a set of key bindings which map key sequences to output + * character sequences. The name of the key bindings set used can be specified using + * setKeyBindings() * - * \param text A string expected to contain a series of key and value pairs in - * the form: name=value;name2=value2 ... - */ - void profileChangeCommandReceived(const QString& text); - - /** - * Emitted when a flow control key combination ( Ctrl+S or Ctrl+Q ) is pressed. - * \param suspendKeyPressed True if Ctrl+S was pressed to suspend output or Ctrl+Q to - * resume output. - */ - void flowControlKeyPressed(bool suspendKeyPressed); - -protected: - virtual void setMode(int mode) = 0; - virtual void resetMode(int mode) = 0; - - /** - * Processes an incoming character. See receiveData() - * @p ch A unicode character code. - */ - virtual void receiveChar(int ch); - - /** - * Sets the active screen. The terminal has two screens, primary and alternate. - * The primary screen is used by default. When certain interactive programs such - * as Vim are run, they trigger a switch to the alternate screen. + * The emulation maintains certain state information which changes depending on the + * input received. The emulation can be reset back to its starting state by calling + * reset(). * - * \param index 0 to switch to the primary screen, or 1 to switch to the alternate screen + * The emulation also maintains an activity state, which specifies whether + * terminal is currently active ( when data is received ), normal + * ( when the terminal is idle or receiving user input ) or trying + * to alert the user ( also known as a "Bell" event ). The stateSet() signal + * is emitted whenever the activity state is set. This can be used to determine + * how long the emulation has been active/idle for and also respond to + * a 'bell' event in different ways. */ - void setScreen(int index); - - enum EmulationCodec + class KONSOLEPRIVATE_EXPORT Emulation : public QObject { - LocaleCodec = 0, - Utf8Codec = 1 - }; - void setCodec(EmulationCodec codec); // codec number, 0 = locale, 1=utf8 - - - QList _windows; - - Screen* _currentScreen; // pointer to the screen which is currently active, - // this is one of the elements in the screen[] array - - Screen* _screen[2]; // 0 = primary screen ( used by most programs, including the shell - // scrollbars are enabled in this mode ) - // 1 = alternate ( used by vi , emacs etc. - // scrollbars are not enabled in this mode ) - - - //decodes an incoming C-style character stream into a unicode QString using - //the current text codec. (this allows for rendering of non-ASCII characters in text files etc.) - const QTextCodec* _codec; - QTextDecoder* _decoder; - const KeyboardTranslator* _keyTranslator; // the keyboard layout + Q_OBJECT + + public: + + /** Constructs a new terminal emulation */ + Emulation(); + ~Emulation() override; + + /** + * Creates a new window onto the output from this emulation. The contents + * of the window are then rendered by views which are set to use this window using the + * TerminalDisplay::setScreenWindow() method. + */ + ScreenWindow *createWindow(); + + /** Returns the size of the screen image which the emulation produces */ + QSize imageSize() const; + + /** + * Returns the total number of lines, including those stored in the history. + */ + int lineCount() const; + + /** + * Sets the history store used by this emulation. When new lines + * are added to the output, older lines at the top of the screen are transferred to a history + * store. + * + * The number of lines which are kept and the storage location depend on the + * type of store. + */ + void setHistory( const HistoryType & ); + /** Returns the history store used by this emulation. See setHistory() */ + const HistoryType &history() const; + /** Clears the history scroll. */ + void clearHistory(); + + /** + * Copies the output history from @p startLine to @p endLine + * into @p stream, using @p decoder to convert the terminal + * characters into text. + * + * \param decoder A decoder which converts lines of terminal characters with + * appearance attributes into output text. PlainTextDecoder is the most commonly + * used decoder. + * \param startLine Index of first line to copy + * \param endLine Index of last line to copy + */ + virtual void writeToStream( TerminalCharacterDecoder *decoder, int startLine, int endLine ); + + /** Returns the codec used to decode incoming characters. See setCodec() */ + const QTextCodec *codec() const { return _codec; } + /** Sets the codec used to decode incoming characters. */ + void setCodec( const QTextCodec * ); + + /** + * Convenience method. + * Returns true if the current codec used to decode incoming + * characters is UTF-8 + */ + bool utf8() const + { Q_ASSERT( _codec ); return _codec->mibEnum() == 106; } + + + /** TODO Document me */ + virtual char eraseChar() const; + + /** + * Sets the key bindings used to key events + * ( received through sendKeyEvent() ) into character + * streams to send to the terminal. + */ + void setKeyBindings( const QString &name ); + /** + * Returns the name of the emulation's current key bindings. + * See setKeyBindings() + */ + QString keyBindings() const; + + /** + * Copies the current image into the history and clears the screen. + */ + virtual void clearEntireScreen() = 0; + + /** Resets the state of the terminal. */ + virtual void reset() = 0; + + /** + * Returns true if the active terminal program wants + * mouse input events. + * + * The programUsesMouseChanged() signal is emitted when this + * changes. + */ + bool programUsesMouse() const; + + public slots: + + /** Change the size of the emulation's image */ + virtual void setImageSize( int lines, int columns ); + + /** + * Interprets a sequence of characters and sends the result to the terminal. + * This is equivalent to calling sendKeyEvent() for each character in @p text in succession. + */ + virtual void sendText( const QString &text ) = 0; + + /** + * Interprets a key press event and emits the sendData() signal with + * the resulting character stream. + */ + virtual void sendKeyEvent( QKeyEvent * ); + + /** + * Converts information about a mouse event into an xterm-compatible escape + * sequence and emits the character sequence via sendData() + */ + virtual void sendMouseEvent( int buttons, int column, int line, int eventType ); + + /** + * Sends a string of characters to the foreground terminal process. + * + * \param string The characters to send. + * \param length Length of @p string or if set to a negative value, @p string will + * be treated as a null-terminated string and its length will be determined automatically. + */ + virtual void sendString( const char *string, int length = -1 ) = 0; + + /** + * Processes an incoming stream of characters. receiveData() decodes the incoming + * character buffer using the current codec(), and then calls receiveChar() for + * each unicode character in the resulting buffer. + * + * receiveData() also starts a timer which causes the outputChanged() signal + * to be emitted when it expires. The timer allows multiple updates in quick + * succession to be buffered into a single outputChanged() signal emission. + * + * \param buffer A string of characters received from the terminal program. + * \param len The length of @p buffer + */ + void receiveData( const char *buffer, int len ); + + signals: + + /** + * Emitted when a buffer of data is ready to send to the + * standard input of the terminal. + * + * \param data The buffer of data ready to be sent + * \param len The length of @p data in bytes + */ + void sendData( const char *data, int len ); + + /** + * Requests that sending of input to the emulation + * from the terminal process be suspended or resumed. + * + * \param suspend If true, requests that sending of + * input from the terminal process' stdout be + * suspended. Otherwise requests that sending of + * input be resumed. + */ + void lockPtyRequest( bool suspend ); + + /** + * Requests that the pty used by the terminal process + * be set to UTF 8 mode. + * + * TODO: More documentation + */ + void useUtf8Request( bool ); + + /** + * Emitted when the activity state of the emulation is set. + * + * \param state The new activity state, one of NOTIFYNORMAL, NOTIFYACTIVITY + * or NOTIFYBELL + */ + void stateSet( int state ); + + /** TODO Document me */ + void zmodemDetected(); + + + /** + * Requests that the color of the text used + * to represent the tabs associated with this + * emulation be changed. This is a Konsole-specific + * extension from pre-KDE 4 times. + * + * TODO: Document how the parameter works. + */ + void changeTabTextColorRequest( int color ); + + /** + * This is emitted when the program running in the shell indicates whether or + * not it is interested in mouse events. + * + * \param usesMouse This will be true if the program wants to be informed about + * mouse events or false otherwise. + */ + void programUsesMouseChanged( bool usesMouse ); + + /** + * Emitted when the contents of the screen image change. + * The emulation buffers the updates from successive image changes, + * and only emits outputChanged() at sensible intervals when + * there is a lot of terminal activity. + * + * Normally there is no need for objects other than the screen windows + * created with createWindow() to listen for this signal. + * + * ScreenWindow objects created using createWindow() will emit their + * own outputChanged() signal in response to this signal. + */ + void outputChanged(); + + /** + * Emitted when the program running in the terminal wishes to update the + * session's title. This also allows terminal programs to customize other + * aspects of the terminal emulation display. + * + * This signal is emitted when the escape sequence "\033]ARG;VALUE\007" + * is received in the input string, where ARG is a number specifying what + * should change and VALUE is a string specifying the new value. + * + * TODO: The name of this method is not very accurate since this method + * is used to perform a whole range of tasks besides just setting + * the user-title of the session. + * + * \param title Specifies what to change. + *
    + *
  • 0 - Set window icon text and session title to @p newTitle
    • + *
  • 1 - Set window icon text to @p newTitle
    • + *
  • 2 - Set session title to @p newTitle
    • + *
  • 11 - Set the session's default background color to @p newTitle, + * where @p newTitle can be an HTML-style string ("#RRGGBB") or a named + * color (e.g., 'red', 'blue'). + * See http://doc.trolltech.com/4.2/qcolor.html#setNamedColor for more + * details. + *
    • + *
  • 31 - Supposedly treats @p newTitle as a URL and opens it (NOT IMPLEMENTED)
    • + *
  • 32 - Sets the icon associated with the session. @p newTitle is the name + * of the icon to use, which can be the name of any icon in the current KDE icon + * theme (e.g., 'konsole', 'kate', 'folder_home')
    • + *
+ * \param newTitle Specifies the new title + */ + + void titleChanged( int title, const QString &newTitle ); + + /** + * Emitted when the program running in the terminal changes the + * screen size. + */ + void imageSizeChanged( int lineCount, int columnCount ); + + /** + * Emitted when the terminal program requests to change various properties + * of the terminal display. + * + * A profile change command occurs when a special escape sequence, followed + * by a string containing a series of name and value pairs is received. + * This string can be parsed using a ProfileCommandParser instance. + * + * \param text A string expected to contain a series of key and value pairs in + * the form: name=value;name2=value2 ... + */ + void profileChangeCommandReceived( const QString &text ); + + /** + * Emitted when a flow control key combination ( Ctrl+S or Ctrl+Q ) is pressed. + * \param suspendKeyPressed TRUE if Ctrl+S was pressed to suspend output or Ctrl+Q to + * resume output. + */ + void flowControlKeyPressed( bool suspendKeyPressed ); + + protected: + virtual void setMode( int mode ) = 0; + virtual void resetMode( int mode ) = 0; + + /** + * Processes an incoming character. See receiveData() + * @p ch A unicode character code. + */ + virtual void receiveChar( int ch ); + + /** + * Sets the active screen. The terminal has two screens, primary and alternate. + * The primary screen is used by default. When certain interactive programs such + * as Vim are run, they trigger a switch to the alternate screen. + * + * \param index 0 to switch to the primary screen, or 1 to switch to the alternate screen + */ + void setScreen( int index ); + + enum EmulationCodec + { + LocaleCodec = 0, + Utf8Codec = 1 + }; + void setCodec( EmulationCodec codec ); // codec number, 0 = locale, 1=utf8 + + + QList _windows; + + Screen *_currentScreen; // pointer to the screen which is currently active, + // this is one of the elements in the screen[] array + + Screen *_screen[2]; // 0 = primary screen ( used by most programs, including the shell + // scrollbars are enabled in this mode ) + // 1 = alternate ( used by vi , emacs etc. + // scrollbars are not enabled in this mode ) + + + //decodes an incoming C-style character stream into a unicode QString using + //the current text codec. (this allows for rendering of non-ASCII characters in text files etc.) + const QTextCodec *_codec; + QTextDecoder *_decoder; + const KeyboardTranslator *_keyTranslator; // the keyboard layout + + protected slots: + /** + * Schedules an update of attached views. + * Repeated calls to bufferedUpdate() in close succession will result in only a single update, + * much like the Qt buffered update of widgets. + */ + void bufferedUpdate(); + + private slots: + + // triggered by timer, causes the emulation to send an updated screen image to each + // view + void showBulk(); + + void usesMouseChanged( bool usesMouse ); + + private: + bool _usesMouse; + QTimer _bulkTimer1; + QTimer _bulkTimer2; -protected slots: - /** - * Schedules an update of attached views. - * Repeated calls to bufferedUpdate() in close succession will result in only a single update, - * much like the Qt buffered update of widgets. - */ - void bufferedUpdate(); - -private slots: - - // triggered by timer, causes the emulation to send an updated screen image to each - // view - void showBulk(); - - void usesMouseChanged(bool usesMouse); - -private: - bool _usesMouse; - QTimer _bulkTimer1; - QTimer _bulkTimer2; - -}; + }; }