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

Use "\since" instead of "@note added in"

Browse Source
This commit is contained in:
Matthias Kuhn 2017-04-03 01:06:33 +02:00
parent 9c1861a1f3
commit fb91ed7395
475 changed files with 2202 additions and 2202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
python/core/annotations/qgsannotationmanager.sip
View File

@ -13,7 +13,7 @@
class QgsAnnotationManager : QObject
{
%Docstring
.. versionadded:: 3.0
\since QGIS 3.0
Manages storage of a set of QgsAnnotation annotation objects.

2
python/core/annotations/qgssvgannotation.sip
View File

@ -13,7 +13,7 @@ class QgsSvgAnnotation: QgsAnnotation
{
%Docstring
An annotation which renders the contents of an SVG file.
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

2
python/core/annotations/qgstextannotation.sip
View File

@ -13,7 +13,7 @@ class QgsTextAnnotation: QgsAnnotation
{
%Docstring
An annotation item that displays formatted text from a QTextDocument document.
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

2
python/core/processing/qgsprocessingfeedback.sip
View File

@ -17,7 +17,7 @@ class QgsProcessingFeedback : QgsFeedback
This base class implementation silently ignores all feedback reported by algorithms.
Subclasses of QgsProcessingFeedback can be used to log this feedback or report
it to users via the GUI.
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

2
python/core/processing/qgsprocessingprovider.sip
View File

@ -15,7 +15,7 @@ class QgsProcessingProvider
Abstract base class for processing providers. An algorithm provider is a set of
related algorithms, typically from the same external application or related
to a common area of analysis.
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

2
python/core/processing/qgsprocessingregistry.sip
View File

@ -17,7 +17,7 @@ class QgsProcessingRegistry : QObject
QgsProcessingRegistry is not usually directly created, but rather accessed through
QgsApplication::processingRegistry().
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

18
python/core/qgsaction.sip
View File

@ -71,14 +71,14 @@ The short title is used to label user interface elements like buttons
%Docstring
Returns a unique id for this action.
.. versionadded:: 3.0
\since QGIS 3.0
%End
bool isValid() const;
%Docstring
Returns true if this action was a default constructed one.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QString iconPath() const;
@ -97,7 +97,7 @@ The icon
How the content is interpreted depends on the type() and
the actionScope().
.. versionadded:: 3.0
\since QGIS 3.0
%End
ActionType type() const;
@ -119,14 +119,14 @@ Checks if the action is runable on the current platform
%Docstring
Run this action.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void run( const QgsExpressionContext &expressionContext ) const;
%Docstring
Run this action.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QSet<QString> actionScopes() const;
@ -136,7 +136,7 @@ Checks if the action is runable on the current platform
coordinate.
@see QgsActionScope
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setActionScopes( const QSet<QString> &actionScopes );
@ -145,7 +145,7 @@ Checks if the action is runable on the current platform
Action scopes may offer additional variables like the clicked
coordinate.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void readXml( const QDomNode &actionNode );
@ -153,7 +153,7 @@ Checks if the action is runable on the current platform
Reads an XML definition from actionNode
into this object.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void writeXml( QDomNode &actionsNode ) const;
@ -161,7 +161,7 @@ Checks if the action is runable on the current platform
Appends an XML definition for this action as a new
child node to actionsNode.
.. versionadded:: 3.0
\since QGIS 3.0
%End
};

12
python/core/qgsactionmanager.sip
View File

@ -51,7 +51,7 @@ Constructor
%Docstring
Remove an action by its id.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) /PyName=doActionFeature/;
@ -60,7 +60,7 @@ Constructor
field to be used if the action has a $currfield placeholder.
.. note::
available in python bindings as doActionFeature
available in Python bindings as doActionFeature
%End
void doAction( const QUuid &actionId, const QgsFeature &feature, const QgsExpressionContext &context );
@ -82,7 +82,7 @@ Removes all actions
Return a list of actions that are available in the given action scope.
If no action scope is provided, all actions will be returned.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QgsVectorLayer *layer() const;
@ -104,7 +104,7 @@ Reads the actions in in XML format
%Docstring
Get an action by its id.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setDefaultAction( const QString &actionScope, const QUuid &actionId );
@ -112,7 +112,7 @@ Reads the actions in in XML format
Each scope can have a default action. This will be saved in the project
file.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QgsAction defaultAction( const QString &actionScope );
@ -120,7 +120,7 @@ Reads the actions in in XML format
Each scope can have a default action. This will be saved in the project
file.
.. versionadded:: 3.0
\since QGIS 3.0
%End
};

14
python/core/qgsactionscope.sip
View File

@ -29,7 +29,7 @@ class QgsActionScope
<dd>Show in attribute table and work on the layer or selection.</dd>
</dl>
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode
@ -41,7 +41,7 @@ class QgsActionScope
%Docstring
Creates a new invalid action scope.
.. versionadded:: 3.0
\since QGIS 3.0
%End
explicit QgsActionScope( const QString &id, const QString &title, const QString &description, const QgsExpressionContextScope &expressionContextScope = QgsExpressionContextScope() );
@ -62,7 +62,7 @@ class QgsActionScope
This can be an `field_name` for the attribute which was clicked or
`clicked_x` and `clicked_y` for actions which are available as map canvas clicks.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
@ -74,7 +74,7 @@ class QgsActionScope
%Docstring
A unique identifier for this action scope.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setId( const QString &id );
@ -87,7 +87,7 @@ class QgsActionScope
The title is a human readable and translated string that will be
presented to the user in the properties dialog.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setTitle( const QString &title );
%Docstring
@ -100,7 +100,7 @@ class QgsActionScope
are available. It is not necessary to list the available expression variables
in here, they are extracted automatically from the expressionContextScope().
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setDescription( const QString &description );
%Docstring
@ -111,7 +111,7 @@ class QgsActionScope
%Docstring
Returns if this scope is valid.
.. versionadded:: 3.0
\since QGIS 3.0
%End
};

14
python/core/qgsactionscoperegistry.sip
View File

@ -21,7 +21,7 @@ class QgsActionScopeRegistry : QObject
QgsApplication::actionScopeRegistry()
```
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode
@ -37,35 +37,35 @@ class QgsActionScopeRegistry : QObject
want to use QgsApplication::actionScopeRegistry() to get access
to that one instead.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QSet<QgsActionScope> actionScopes() const;
%Docstring
Get all registered action scopes.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void registerActionScope( const QgsActionScope &actionScope );
%Docstring
Register an additional action scope.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void unregisterActionScope( const QgsActionScope &actionScope );
%Docstring
Unregister an additional action scope.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QgsActionScope actionScope( const QString &id );
%Docstring
Get an action scope by its id.
.. versionadded:: 3.0
\since QGIS 3.0
%End
signals:
@ -75,7 +75,7 @@ class QgsActionScopeRegistry : QObject
Emitted whenever a new action scope is registered or an action scope
is unregistered.
.. versionadded:: 3.0
\since QGIS 3.0
%End
};

8
python/core/qgsanimatedicon.sip
View File

@ -50,14 +50,14 @@ class QgsAnimatedIcon : QObject
Connect to the frame changed signal with this method and not directly. This method
makes sure the annimation is started.
.. versionadded:: 3.0
\since QGIS 3.0
%End
bool disconnectFrameChanged( const QObject *receiver, const char *method );
%Docstring
Convenience function to disconnect the same style that the frame change connection was established.
.. versionadded:: 3.0
\since QGIS 3.0
%End
@ -65,14 +65,14 @@ class QgsAnimatedIcon : QObject
%Docstring
The native width of the icon.
.. versionadded:: 3.0
\since QGIS 3.0
%End
int height() const;
%Docstring
The native height of the icon.
.. versionadded:: 3.0
\since QGIS 3.0
%End
signals:

2
python/core/qgsclipper.sip
View File

@ -58,7 +58,7 @@ class QgsClipper
.. note::
not available in python bindings on android
not available in Python bindings on android
%End
%End

2
python/core/qgsconditionalstyle.sip
View File

@ -32,7 +32,7 @@ class QgsConditionalLayerStyles
Set the conditional styles that apply to full rows of data in the attribute table.
Each row will check be checked against each rule.
@param styles The styles to assign to all the rows
.. versionadded:: 2.12
\since QGIS 2.12
%End
void setFieldStyles( const QString &fieldName, const QList<QgsConditionalStyle> &styles );

8
python/core/qgsfeature.sip
View File

@ -182,7 +182,7 @@ class QgsFeature
@link attributes @endlink method.
@returns list of feature's attributes
@see setAttributes
.. versionadded:: 2.9
\since QGIS 2.9
.. note::
Alternatively in Python: iterate feature, eg. @code [attr for attr in feature] @endcode
@ -280,7 +280,7 @@ class QgsFeature
%Docstring
Returns true if the feature has an associated geometry.
@see geometry()
.. versionadded:: 3.0.
\since QGIS 3.0.
%End
QgsGeometry geometry() const;
@ -304,7 +304,7 @@ class QgsFeature
Removes any geometry associated with the feature.
@see setGeometry()
@see hasGeometry()
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setFields( const QgsFields &fields, bool initAttributes = true );
@ -314,7 +314,7 @@ class QgsFeature
@param initAttributes If true, attributes are initialized. Clears any data previously assigned.
C++: Defaults to false
Python: Defaults to true
.. versionadded:: 2.9
\since QGIS 2.9
@see fields
%End

2
python/core/qgspropertytransformer.sip
View File

@ -119,7 +119,7 @@ class QgsPropertyTransformer
%Docstring
Abstract base class for objects which transform the calculated value of a property.
Possible uses include transformers which map a value into a scaled size or color from a gradient.
.. versionadded:: 3.0
\since QGIS 3.0
%End
%TypeHeaderCode

2
python/core/qgssettings.sip
View File

@ -36,7 +36,7 @@ class QgsSettings : QObject
- Misc
- Auth
.. versionadded:: 3
\since QGIS 3
%End
%TypeHeaderCode

90
python/core/qgsvectorlayer.sip
View File

@ -425,7 +425,7 @@ Setup the coordinate system transformation for the layer
@param layers set of QgsMapLayerDependency. Only user-defined dependencies will be added
@returns false if a dependency cycle has been detected
.. versionadded:: 3.0
\since QGIS 3.0
%End
virtual QSet<QgsMapLayerDependency> dependencies() const;
@ -434,7 +434,7 @@ Setup the coordinate system transformation for the layer
as well as dependencies given by the provider
@returns a set of QgsMapLayerDependency
.. versionadded:: 3.0
\since QGIS 3.0
%End
int addExpressionField( const QString &exp, const QgsField &fld );
@ -446,7 +446,7 @@ Setup the coordinate system transformation for the layer
@return The index of the new field
.. versionadded:: 2.6
\since QGIS 2.9
%End
void removeExpressionField( int index );
@ -455,7 +455,7 @@ Setup the coordinate system transformation for the layer
@param index The index of the field
.. versionadded:: 2.6
\since QGIS 2.6
%End
QString expressionField( int index ) const;
@ -466,7 +466,7 @@ Setup the coordinate system transformation for the layer
@return The expression for the field at index
.. versionadded:: 2.9
\since QGIS 2.9
%End
void updateExpressionField( int index, const QString &exp );
@ -477,7 +477,7 @@ Setup the coordinate system transformation for the layer
@param exp The new expression to set
.. versionadded:: 2.9
\since QGIS 2.9
%End
QgsActionManager *actions();
@ -512,7 +512,7 @@ Setup the coordinate system transformation for the layer
@param expression expression to evaluate to select features
@param behavior selection type, allows adding to current selection, removing
from selection, etc.
.. versionadded:: 2.16
\since QGIS 2.16
@see selectByRect()
@see selectByIds()
%End
@ -524,7 +524,7 @@ Setup the coordinate system transformation for the layer
@param ids feature IDs to select
@param behavior selection type, allows adding to current selection, removing
from selection, etc.
.. versionadded:: 2.16
\since QGIS 2.16
@see selectByRect()
@see selectByExpression()
%End
@ -607,14 +607,14 @@ Returns the bounding box of the selected features. If there is no selection, Qgs
%Docstring
Returns whether the layer contains labels which are enabled and should be drawn.
@return true if layer contains enabled labels
.. versionadded:: 2.9
\since QGIS 2.9
%End
bool diagramsEnabled() const;
%Docstring
Returns whether the layer contains diagrams which are enabled and should be drawn.
@return true if layer contains enabled diagrams
.. versionadded:: 2.9
\since QGIS 2.9
%End
void setDiagramRenderer( QgsDiagramRenderer *r /Transfer/ );
@ -677,7 +677,7 @@ Return the provider type for this layer
void resolveReferences( QgsProject *project );
%Docstring
Resolve references to other layers (kept as layer IDs after reading XML) into layer objects.
.. versionadded:: 3.0
\since QGIS 3.0
%End
virtual void saveStyleToDatabase( const QString &name, const QString &description,
@ -711,7 +711,7 @@ Return the provider type for this layer
virtual bool deleteStyleFromDatabase( const QString &styleId, QString &msgError /Out/ );
%Docstring
Delete a style from the database
.. versionadded:: 3.0
\since QGIS 3.0
@param styleId the provider's layer_styles table id of the style to delete
@param msgError reference to string that will be updated with any error messages
@return true in case of success
@ -793,7 +793,7 @@ Return the provider type for this layer
@param provider provider string
@param loadDefaultStyleFlag set to true to reset the layer's style to the default for the
data source
.. versionadded:: 2.10
\since QGIS 2.10
%End
bool countSymbolFeatures( bool showProgress = true );
@ -891,7 +891,7 @@ on every call. Consider using {@link changeAttributeValue()} or
to the given coordinates
.. note::
available in python as moveVertexV2
available in Python as moveVertexV2
%End
EditResult deleteVertex( QgsFeatureId featureId, int vertex );
@ -899,7 +899,7 @@ on every call. Consider using {@link changeAttributeValue()} or
Deletes a vertex from a feature.
@param featureId ID of feature to remove vertex from
@param vertex index of vertex to delete
.. versionadded:: 2.14
\since QGIS 2.14
%End
bool deleteSelectedFeatures( int *deletedCount = 0 );
@ -932,7 +932,7 @@ TODO QGIS 3.0 returns an enum instead of a magic constant
%Docstring
.. note::
available in python as addCurvedPart
available in Python as addCurvedPart
%End
@ -1027,7 +1027,7 @@ Synchronises with changes in the datasource
virtual QgsMapLayerRenderer *createMapRenderer( QgsRenderContext &rendererContext ) /Factory/;
%Docstring
Return new instance of QgsMapLayerRenderer that will be used for rendering of given context
.. versionadded:: 2.4
\since QGIS 2.4
%End
QgsRectangle extent() const;
@ -1120,14 +1120,14 @@ Change feature's geometry
%Docstring
Sets an alias (a display name) for attributes to display in dialogs
.. versionadded:: 3.0
\since QGIS 3.0
%End
void removeFieldAlias( int index );
%Docstring
Removes an alias (a display name) for attributes to display in dialogs
.. versionadded:: 3.0
\since QGIS 3.0
%End
bool renameAttribute( int index, const QString &newName );
@ -1135,7 +1135,7 @@ Change feature's geometry
Renames an attribute field (but does not commit it).
@param index attribute index
@param newName new name of field
.. versionadded:: 2.16
\since QGIS 2.16
%End
QString attributeAlias( int index ) const;
@ -1309,7 +1309,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param context optional expression context to evaluate expressions again. If not
specified, a default context will be created
@return calculated default value
.. versionadded:: 3.0
\since QGIS 3.0
@see setDefaultValueExpression()
%End
@ -1319,7 +1319,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param index field index
@param expression expression to evaluate when calculating default values for field. Pass
an empty expression to clear the default.
.. versionadded:: 3.0
\since QGIS 3.0
@see defaultValue()
@see defaultValueExpression()
%End
@ -1330,7 +1330,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param index field index
@returns expression evaluated when calculating default values for field, or an
empty string if no default is set
.. versionadded:: 3.0
\since QGIS 3.0
@see defaultValue()
@see setDefaultValueExpression()
%End
@ -1340,7 +1340,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
Returns any constraints which are present for a specified
field index. These constraints may be inherited from the layer's data provider
or may be set manually on the vector layer from within QGIS.
.. versionadded:: 3.0
\since QGIS 3.0
@see setFieldConstraint()
%End
@ -1349,7 +1349,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
Sets a constraint for a specified field index. Any constraints inherited from the layer's
data provider will be kept intact and cannot be modified. Ie, calling this method only allows for new
constraints to be added on top of the existing provider constraints.
.. versionadded:: 3.0
\since QGIS 3.0
@see fieldConstraints()
@see removeFieldConstraint()
%End
@ -1358,7 +1358,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
%Docstring
Removes a constraint for a specified field index. Any constraints inherited from the layer's
data provider will be kept intact and cannot be removed.
.. versionadded:: 3.0
\since QGIS 3.0
@see fieldConstraints()
@see setFieldConstraint()
%End
@ -1366,7 +1366,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
QString constraintExpression( int index ) const;
%Docstring
Returns the constraint expression for for a specified field index, if set.
.. versionadded:: 3.0
\since QGIS 3.0
@see fieldConstraints()
@see constraintDescription()
@see setConstraintExpression()
@ -1375,7 +1375,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
QString constraintDescription( int index ) const;
%Docstring
Returns the descriptive name for the constraint expression for a specified field index.
.. versionadded:: 3.0
\since QGIS 3.0
@see constraints()
@see constraintExpression()
@see setConstraintExpression()
@ -1385,7 +1385,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
%Docstring
Set the constraint expression for the specified field index. An optional descriptive name for the constraint
can also be set. Setting an empty expression will clear any existing expression constraint.
.. versionadded:: 3.0
\since QGIS 3.0
@see constraintExpression()
@see constraintDescription()
@see constraints()
@ -1401,7 +1401,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
The editor widget setup defines which QgsFieldFormatter and editor widget will be used
for the field at `index`.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void uniqueValues( int index, QList<QVariant> &uniqueValues /Out/, int limit = -1 ) const;
@ -1467,7 +1467,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param context expression context for expressions and filters
@param ok if specified, will be set to true if aggregate calculation was successful
@return calculated aggregate value
.. versionadded:: 2.16
\since QGIS 2.16
%End
QList< QVariant > getValues( const QString &fieldOrExpression, bool &ok, bool selectedOnly = false, QgsFeedback *feedback = 0 ) const;
@ -1478,7 +1478,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param selectedOnly set to true to get values from selected features only
@param feedback optional feedback object to allow cancelation
@returns list of fetched values
.. versionadded:: 2.9
\since QGIS 2.9
@see getDoubleValues
%End
@ -1492,7 +1492,7 @@ Assembles mUpdatedFields considering provider fields, joined fields and added fi
@param nullCount optional pointer to integer to store number of null values encountered in
@param feedback optional feedback object to allow cancelation
@returns list of fetched values
.. versionadded:: 2.9
\since QGIS 2.9
@see getValues
%End
@ -1520,13 +1520,13 @@ Returns the current transparency for the vector layer
void setSimplifyMethod( const QgsVectorSimplifyMethod &simplifyMethod );
%Docstring
Set the simplification settings for fast rendering of features
.. versionadded:: 2.2
\since QGIS 2.2
%End
const QgsVectorSimplifyMethod &simplifyMethod() const;
%Docstring
Returns the simplification settings for fast rendering of features
.. versionadded:: 2.2
\since QGIS 2.2
%End
bool simplifyDrawingCanbeApplied( const QgsRenderContext &renderContext, QgsVectorSimplifyMethod::SimplifyHint simplifyHint ) const;
@ -1535,7 +1535,7 @@ Returns the current transparency for the vector layer
.. note::
Do not use in 3rd party code - may be removed in future version!
.. versionadded:: 2.2
\since QGIS 2.2
%End
QgsConditionalLayerStyles *conditionalStyles() const;
@ -1544,7 +1544,7 @@ Returns the current transparency for the vector layer
used to render conditional formatting in the attribute table.
@return Return a QgsConditionalLayerStyles object holding the conditional attribute
style information. Style information is generic and can be used for anything.
.. versionadded:: 2.12
\since QGIS 2.12
%End
QgsAttributeTableConfig attributeTableConfig() const;
@ -1565,7 +1565,7 @@ Returns the current transparency for the vector layer
It may also contain embedded expressions.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void setMapTipTemplate( const QString &mapTipTemplate );
@ -1574,7 +1574,7 @@ Returns the current transparency for the vector layer
It may also contain embedded expressions.
.. versionadded:: 3.0
\since QGIS 3.0
%End
QgsExpressionContext createExpressionContext() const;
@ -1586,7 +1586,7 @@ Returns the current transparency for the vector layer
@return The configuration of this layers' form
.. versionadded:: 2.14
\since QGIS 2.14
%End
void setEditFormConfig( const QgsEditFormConfig &editFormConfig );
@ -1596,7 +1596,7 @@ Returns the current transparency for the vector layer
@return The configuration of this layers' form
.. versionadded:: 3.0
\since QGIS 3.0
%End
public slots:
@ -1889,14 +1889,14 @@ Signal emitted when setLayerTransparency() is called
%Docstring
Emitted when the map tip changes
.. versionadded:: 3.0
\since QGIS 3.0
%End
void displayExpressionChanged();
%Docstring
Emitted when the display expression changes
.. versionadded:: 3.0
\since QGIS 3.0
%End
void raiseError( const QString &msg );
@ -1908,7 +1908,7 @@ Signal emitted when setLayerTransparency() is called
%Docstring
Will be emitted whenever the edit form configuration of this layer changes.
.. versionadded:: 3.0
\since QGIS 3.0
%End
void readOnlyChanged();
@ -1916,7 +1916,7 @@ Signal emitted when setLayerTransparency() is called
Emitted when the read only state of this layer is changed.
Only applies to manually set readonly state, not to the edit mode.
.. versionadded:: 3.0
\since QGIS 3.0
%End

2
src/analysis/network/qgsgraph.h
View File

@ -37,7 +37,7 @@ class QgsGraphVertex;
/**
* \ingroup analysis
* \class QgsGraphEdge
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief This class implements a graph edge
*/
class ANALYSIS_EXPORT QgsGraphEdge

2
src/analysis/network/qgsnetworkdistancestrategy.h
View File

@ -21,7 +21,7 @@
/** \ingroup analysis
* \class QgsNetworkDistanceStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Strategy for caclulating edge cost based on its length. Should be
* used for finding shortest path between two points.
*/

2
src/analysis/network/qgsnetworkspeedstrategy.h
View File

@ -21,7 +21,7 @@
/** \ingroup analysis
* \class QgsNetworkSpeedStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Strategy for calculating edge cost based on travel time. Should be
* used for finding fastest path between two points.
*/

2
src/analysis/network/qgsnetworkstrategy.h
View File

@ -25,7 +25,7 @@
/**
* \ingroup analysis
* \class QgsNetworkStrategy
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief QgsNetworkStrategy defines strategy used for calculation of the edge cost. For example it can
* take into account travel distance, amount of time or money. Currently there are two strategies
* implemented in the analysis library: QgsNetworkDistanceStrategy and QgsNetworkSpeedStrategy.

2
src/analysis/network/qgsvectorlayerdirector.h
View File

@ -25,7 +25,7 @@ class QgsVectorLayer;
/**
* \ingroup analysis
* \class QgsVectorLayerDirector
* \note added in QGIS 3.0
* \since QGIS 3.0
* \brief Determine making the graph from vector line layer
*/
class ANALYSIS_EXPORT QgsVectorLayerDirector : public QgsGraphDirector

2
src/analysis/raster/qgsalignraster.h
View File

@ -35,7 +35,7 @@ typedef void *GDALDatasetH;
* - cell size and raster size
* - offset of the raster grid
*
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
class ANALYSIS_EXPORT QgsAlignRaster
{

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

@ -34,7 +34,7 @@ class QgsFeature;
* \class QgsKernelDensityEstimation
* \ingroup analysis
* Performs Kernel Density Estimation ("heatmap") calculations on a vector layer.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsKernelDensityEstimation
{

2
src/analysis/raster/qgsrastercalcnode.h
View File

@ -93,7 +93,7 @@ class ANALYSIS_EXPORT QgsRasterCalcNode
* @param result destination raster matrix for calculation results
* @param row optional row number to calculate for calculating result by rows, or -1 to
* calculate entire result
* @note added in QGIS 2.10
* \since QGIS 2.10
* @note not available in Python bindings
*/
bool calculate( QMap<QString, QgsRasterBlock * > &rasterData, QgsRasterMatrix &result, int row = -1 ) const;

2
src/analysis/raster/qgsrastercalculator.h
View File

@ -74,7 +74,7 @@ class ANALYSIS_EXPORT QgsRasterCalculator
* @param nOutputColumns number of columns in output raster
* @param nOutputRows number of rows in output raster
* @param rasterEntries list of referenced raster layers
* @note added in QGIS 2.10
* \since QGIS 2.10
*/
QgsRasterCalculator( const QString &formulaString, const QString &outputFile, const QString &outputFormat,
const QgsRectangle &outputExtent, const QgsCoordinateReferenceSystem &outputCrs, int nOutputColumns, int nOutputRows, const QVector<QgsRasterCalculatorEntry> &rasterEntries );

4
src/analysis/vector/qgsgeometrysnapper.h
View File

@ -34,7 +34,7 @@ class QgsVectorLayer;
* QgsGeometrySnapper allows a geometry to be snapped to the geometries within a
* different reference layer. Vertices in the geometries will be modified to
* match the reference layer features within a specified snap tolerance.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsGeometrySnapper : public QObject
{
@ -126,7 +126,7 @@ class ANALYSIS_EXPORT QgsGeometrySnapper : public QObject
* The returned QgsGeometryMap can be passed to QgsVectorDataProvider::changeGeometryValues() to save
* the snapped geometries back to the source layer.
*
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class ANALYSIS_EXPORT QgsInternalGeometrySnapper
{

4
src/app/composer/qgscomposer.h
View File

@ -130,7 +130,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
bool loadFromTemplate( const QDomDocument &templateDoc, bool clearExisting );
//! Sets the specified feature as the current atlas feature
//! @note added in 2.1
//! \since QGIS 2.1
void setAtlasFeature( QgsMapLayer *layer, const QgsFeature &feat );
protected:
@ -592,7 +592,7 @@ class QgsComposer: public QMainWindow, private Ui::QgsComposerBase
QMenu *mirrorOtherMenu( QMenu *otherMenu );
//! Toggles the state of the atlas preview and navigation controls
//! @note added in 2.1
//! \since QGIS 2.1
void toggleAtlasControls( bool atlasEnabled );
//! Sets the printer page orientation when the page orientation changes

2
src/app/composer/qgscomposerpolygonwidget.h
View File

@ -24,7 +24,7 @@ class QgsComposerPolygon;
/**
* Input widget for QgsComposerPolygon
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class QgsComposerPolygonWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPolygonWidgetBase
{

2
src/app/composer/qgscomposerpolylinewidget.h
View File

@ -24,7 +24,7 @@ class QgsComposerPolyline;
/**
* Input widget for QgsComposerPolyline
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class QgsComposerPolylineWidget: public QgsComposerItemBaseWidget, private Ui::QgsComposerPolylineWidgetBase
{

30
src/app/qgisapp.h
View File

@ -192,7 +192,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QgsRasterLayer *addRasterLayer( const QString &rasterFile, const QString &baseName, bool guiWarning = true );
/** Returns and adjusted uri for the layer based on current and available CRS as well as the last selected image format
* @note added in 2.8
* \since QGIS 2.8
*/
QString crsAndFormatAdjustedLayerUri( const QString &uri, const QStringList &supportedCrs, const QStringList &supportedFormats ) const;
@ -323,7 +323,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** Add a toolbar to the main window. Overloaded from QMainWindow.
* After adding the toolbar to the ui (by delegating to the QMainWindow
* parent class, it will also add it to the View menu list of toolbars.
* @note added in 2.3
* \since QGIS 2.3
*/
void addToolBar( QToolBar *toolBar, Qt::ToolBarArea area = Qt::TopToolBarArea );
@ -466,7 +466,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QAction *actionLayerSaveAs() { return mActionLayerSaveAs; }
QAction *actionRemoveLayer() { return mActionRemoveLayer; }
QAction *actionDuplicateLayer() { return mActionDuplicateLayer; }
//! @note added in 2.4
//! \since QGIS 2.4
QAction *actionSetLayerScaleVisibility() { return mActionSetLayerScaleVisibility; }
QAction *actionSetLayerCrs() { return mActionSetLayerCRS; }
QAction *actionSetProjectCrsFromLayer() { return mActionSetProjectCRSFromLayer; }
@ -514,7 +514,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QMenu *viewMenu() { return mViewMenu; }
QMenu *layerMenu() { return mLayerMenu; }
QMenu *newLayerMenu() { return mNewLayerMenu; }
//! @note added in 2.5
//! \since QGIS 2.5
QMenu *addLayerMenu() { return mAddLayerMenu; }
QMenu *settingsMenu() { return mSettingsMenu; }
QMenu *pluginMenu() { return mPluginMenu; }
@ -585,7 +585,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
QList<QgsDecorationItem *> decorationItems() { return mDecorationItems; }
void addDecorationItem( QgsDecorationItem *item ) { mDecorationItems.append( item ); }
//! @note added in 2.1
//! \since QGIS 2.1
static QString normalizedMenuName( const QString &name ) { return name.normalized( QString::NormalizationForm_KD ).remove( QRegExp( "[^a-zA-Z]" ) ); }
#ifdef Q_OS_WIN
@ -794,7 +794,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void showOptionsDialog( QWidget *parent = nullptr, const QString &currentPage = QString() );
/** Refreshes the state of the layer actions toolbar action
* @note added in 2.1 */
* \since QGIS 2.1 */
void refreshActionFeatureAction();
QMenu *panelMenu() { return mPanelMenu; }
@ -874,7 +874,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
//! Slot to show current map scale;
void showScale( double scale );
//! Slot to handle user rotation input;
//! @note added in 2.8
//! \since QGIS 2.8
void userRotation();
//! Remove a layer from the map and legend
void removeLayer();
@ -945,7 +945,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void loadPythonSupport();
/** Install plugin from ZIP file
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void installPluginFromZip();
//! Find the QMenu with the given name within plugin menu (ie the user visible text on the menu item)
@ -1070,7 +1070,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
/** Attempts to run a Python script
* @param filePath full path to Python script
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void runScript( const QString &filePath );
//! Save the map view as an image - user is prompted for image name using a dialog
@ -1429,23 +1429,23 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void deleteComposerManager();
/** Disable any preview modes shown on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void disablePreviewMode();
/** Enable a grayscale preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateGrayscalePreview();
/** Enable a monochrome preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateMonoPreview();
/** Enable a color blindness (protanope) preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateProtanopePreview();
/** Enable a color blindness (deuteranope) preview mode on the map canvas
* @note added in 2.3 */
* \since QGIS 2.3 */
void activateDeuteranopePreview();
void toggleFilterLegendByExpression( bool );
@ -1518,7 +1518,7 @@ class APP_EXPORT QgisApp : public QMainWindow, private Ui::MainWindow
void customCrsValidation( QgsCoordinateReferenceSystem &crs );
/** This signal is emitted when a layer has been saved using save as
@note added in version 2.7
\since QGIS 2.7
*/
void layerSavedAs( QgsMapLayer *l, const QString &path );

10
src/app/qgisappinterface.h
View File

@ -161,7 +161,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
QToolBar *addToolBar( const QString &name ) override;
//! Add a toolbar
//! @note added in 2.3
//! \since QGIS 2.3
void addToolBar( QToolBar *toolbar, Qt::ToolBarArea area = Qt::TopToolBarArea ) override;
/** Open a url in the users browser. By default the QGIS doc directory is used
@ -186,7 +186,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
/**
* Returns a pointer to the layer tree canvas bridge
*
* @note added in 2.12
* \since QGIS 2.12
*/
QgsLayerTreeMapCanvasBridge *layerTreeCanvasBridge() override;
@ -293,14 +293,14 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
virtual void unregisterOptionsWidgetFactory( QgsOptionsWidgetFactory *factory ) override;
/** Register a new custom drop handler.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @note Ownership of the factory is not transferred, and the factory must
* be unregistered when plugin is unloaded.
* @see unregisterCustomDropHandler() */
virtual void registerCustomDropHandler( QgsCustomDropHandler *handler ) override;
/** Unregister a previously registered custom drop handler.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see registerCustomDropHandler() */
virtual void unregisterCustomDropHandler( QgsCustomDropHandler *handler ) override;
@ -314,7 +314,7 @@ class APP_EXPORT QgisAppInterface : public QgisInterface
virtual QMenu *viewMenu() override;
virtual QMenu *layerMenu() override;
virtual QMenu *newLayerMenu() override;
//! @note added in 2.5
//! \since QGIS 2.5
virtual QMenu *addLayerMenu() override;
virtual QMenu *settingsMenu() override;
virtual QMenu *pluginMenu() override;

8
src/app/qgsattributetypedialog.h
View File

@ -119,26 +119,26 @@ class APP_EXPORT QgsAttributeTypeDialog: public QDialog, private Ui::QgsAttribut
/**
* Setter for constraint expression description
* @param desc the expression description
* @note added in QGIS 2.16
* \since QGIS 2.16
**/
void setConstraintExpressionDescription( const QString &desc );
/**
* Getter for constraint expression description
* @return the expression description
* @note added in QGIS 2.16
* \since QGIS 2.16
**/
QString constraintExpressionDescription();
/**
* Getter for the constraint expression
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
QString constraintExpression() const;
/**
* Setter for the constraint expression
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
void setConstraintExpression( const QString &str );

2
src/app/qgsbrowserdockwidget.h
View File

@ -57,7 +57,7 @@ class QgsBrowserPropertiesWidget : public QWidget
/** Sets whether the properties widget should display in condensed mode, ie, for display in a dock
* widget rather than it's own separate dialog.
* @param condensedMode set to true to enable condensed mode
* @note added in QGIS 2.10
* \since QGIS 2.10
*/
virtual void setCondensedMode( bool condensedMode ) { Q_UNUSED( condensedMode ); }
};

2
src/app/qgsidentifyresultsdialog.h
View File

@ -92,7 +92,7 @@ class APP_EXPORT QgsIdentifyResultsWebViewItem: public QObject, public QTreeWidg
QgsIdentifyResultsWebViewItem( QTreeWidget *treeWidget = nullptr );
QgsIdentifyResultsWebView *webView() { return mWebView; }
void setHtml( const QString &html );
//! @note added in 2.1
//! \since QGIS 2.1
void setContent( const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl() );
public slots:

2
src/app/qgslabelpropertydialog.h
View File

@ -39,7 +39,7 @@ class APP_EXPORT QgsLabelPropertyDialog: public QDialog, private Ui::QgsLabelPro
signals:
/** Emitted when dialog settings are applied
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void applied();

4
src/app/qgsmapcanvasdockwidget.h
View File

@ -36,7 +36,7 @@ class QCheckBox;
/**
* \class QgsMapCanvasDockWidget
* A dock widget with an embedded map canvas, for additional map views.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsMapCanvasDockWidgetBase
{
@ -176,7 +176,7 @@ class APP_EXPORT QgsMapCanvasDockWidget : public QgsDockWidget, private Ui::QgsM
/**
* \class QgsMapSettingsAction
* Allows embedding a scale, rotation and other map settings into a menu.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class QgsMapSettingsAction: public QWidgetAction

2
src/app/qgsmaptooladdfeature.h
View File

@ -32,6 +32,6 @@ class APP_EXPORT QgsMapToolAddFeature : public QgsMapToolCapture
protected:
/** Check if CaptureMode match layer type. Default is true.
* @note Added in 2.12 */
* \since QGIS 2.12 */
bool mCheckGeometryType;
};

2
src/app/qgsmaptoolchangelabelproperties.h
View File

@ -36,7 +36,7 @@ class APP_EXPORT QgsMapToolChangeLabelProperties: public QgsMapToolLabel
/** Applies the label property changes
* @param changes attribute map of changes
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void applyChanges( const QgsAttributeMap &changes );

4
src/app/qgsmaptoollabel.h
View File

@ -54,7 +54,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
/** Returns true if layer has attribute field set up for diagrams
@param showCol out: attribute column for data defined diagram showing
@note added in QGIS 2.16 */
\since QGIS 2.16 */
bool diagramCanShowHide( QgsVectorLayer *vlayer, int &showCol ) const;
/** Returns true if layer has attribute field set up
@ -157,7 +157,7 @@ class APP_EXPORT QgsMapToolLabel: public QgsMapTool
/** Returns the pin status for the current label/diagram
@return true if the label/diagram is pinned, false otherwise
@note added in QGIS 2.16
\since QGIS 2.16
*/
bool isPinned();
};

6
src/app/qgsmaptoolselectutils.h
View File

@ -42,7 +42,7 @@ namespace QgsMapToolSelectUtils
the selection rubber band (otherwise intersection is enough).
* @param singleSelect only selects the closest feature to the selectGeometry.
* @returns list of features which match search geometry and parameters
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
QgsFeatureIds getMatchingFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, bool doContains, bool singleSelect );
@ -56,7 +56,7 @@ namespace QgsMapToolSelectUtils
@param doContains features will only be selected if fully contained within
the selection rubber band (otherwise intersection is enough).
@param singleSelect only selects the closest feature to the selectGeometry.
@note added in QGIS 2.16
\since QGIS 2.16
*/
void setSelectedFeatures( QgsMapCanvas *canvas,
const QgsGeometry &selectGeometry,
@ -72,7 +72,7 @@ namespace QgsMapToolSelectUtils
must be in terms of the canvas coordinate system.
@param e MouseEvents are used to determine the current selection
operations (add, subtract, contains)
@note added in QGIS 2.16
\since QGIS 2.16
@see selectSingleFeature()
*/
void selectMultipleFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, QMouseEvent *e );

2
src/app/qgsoptions.h
View File

@ -54,7 +54,7 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
~QgsOptions();
/** Sets the page with the specified widget name as the current page
* @note added in QGIS 2.1
* \since QGIS 2.1
*/
void setCurrentPage( const QString &pageWidgetName );

2
src/app/qgsselectbyformdialog.h
View File

@ -52,7 +52,7 @@ class APP_EXPORT QgsSelectByFormDialog : public QDialog
/** Sets the message bar to display feedback from the form in. This is used in the search/filter
* mode to display the count of selected features.
* @param messageBar target message bar
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
void setMessageBar( QgsMessageBar *messageBar );

2
src/app/qgsstatisticalsummarydockwidget.h
View File

@ -42,7 +42,7 @@ class APP_EXPORT QgsStatisticalSummaryDockWidget : public QgsDockWidget, private
~QgsStatisticalSummaryDockWidget();
/** Returns the currently active layer for the widget
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QgsVectorLayer *layer() const { return mLayer; }

2
src/app/qgsstatusbarmagnifierwidget.h
View File

@ -28,7 +28,7 @@ class QgsDoubleSpinBox;
/**
* A widget which lets the user select the current level of magnification to
* apply to the canvas.
* @note added in 2.16
* \since QGIS 2.16
*/
class APP_EXPORT QgsStatusBarMagnifierWidget : public QWidget
{

2
src/app/qgsstatusbarscalewidget.h
View File

@ -32,7 +32,7 @@ class QgsScaleComboBox;
/**
* Widget to define scale of the map canvas.
* @note added in 2.16
* \since QGIS 2.16
*/
class APP_EXPORT QgsStatusBarScaleWidget : public QWidget
{

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

@ -28,7 +28,7 @@
/** \ingroup core
* \class QgsAnnotation
* \note added in QGIS 3.0
* \since QGIS 3.0
*
* \brief Abstract base class for annotation items which are drawn over a map.
*

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

@ -27,7 +27,7 @@ class QgsAnnotation;
/** \ingroup core
* \class QgsAnnotationManager
* \note added in QGIS 3.0
* \since QGIS 3.0
*
* \brief Manages storage of a set of QgsAnnotation annotation objects.
*

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

@ -35,7 +35,7 @@ typedef std::function < QgsAnnotation*() > QgsCreateAnnotationFunc;
* \class QgsAnnotationMetadata
* \ingroup core
* Metadata item for an annotation type within a QgsAnnotationRegistry.
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsAnnotationMetadata
{
@ -74,7 +74,7 @@ class CORE_EXPORT QgsAnnotationMetadata
* \class QgsAnnotationRegistry
* \ingroup core
* Handles registration and creation of annotation item types.
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsAnnotationRegistry
{

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

@ -29,7 +29,7 @@ class QgsWebPage;
* \class QgsHtmlAnnotation
* \ingroup core
* An annotation item that embeds HTML content.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsHtmlAnnotation: public QgsAnnotation

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

@ -26,7 +26,7 @@
* \class QgsSvgAnnotation
* \ingroup core
* An annotation which renders the contents of an SVG file.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsSvgAnnotation: public QgsAnnotation
{

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

@ -26,7 +26,7 @@
* \class QgsTextAnnotation
* \ingroup core
* An annotation item that displays formatted text from a QTextDocument document.
* \note added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsTextAnnotation: public QgsAnnotation
{

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

@ -113,14 +113,14 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
* @returns expression string, or field name from coverage layer
* @see setPageNameExpression
* @see nameForPage
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QString pageNameExpression() const { return mPageNameExpression; }
/** Sets the expression used for calculating the page name.
* @param pageNameExpression expression string, or field name from coverage layer
* @see pageNameExpression
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setPageNameExpression( const QString &pageNameExpression ) { mPageNameExpression = pageNameExpression; }
@ -128,7 +128,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
* @param pageNumber number of page, where 0 = first page
* @returns page name
* @see pageNameExpression
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QString nameForPage( int pageNumber ) const;
@ -228,17 +228,17 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
int updateFeatures();
/** Returns the current atlas feature. Must be called after prepareForFeature().
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QgsFeature feature() const { return mCurrentFeature; }
/** Returns the name of the page for the current atlas feature. Must be called after prepareForFeature().
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QString currentPageName() const;
/** Returns the current feature number, where a value of 0 corresponds to the first feature.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
int currentFeatureNumber() const { return mCurrentFeatureNo; }
@ -251,7 +251,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
public slots:
/** Refreshes the current atlas feature, by refetching its attributes from the vector layer provider
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void refreshFeature();
@ -283,7 +283,7 @@ class CORE_EXPORT QgsAtlasComposition : public QObject
void featureChanged( QgsFeature *feature );
/** Is emitted when the number of features for the atlas changes.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void numberFeaturesChanged( int numFeatures );

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

@ -109,7 +109,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @returns arrow head stroke color
* @see arrowHeadFillColor
* @see setArrowHeadStrokeColor
* @note added in 2.5
* \since QGIS 2.5
*/
QColor arrowHeadStrokeColor() const { return mArrowHeadStrokeColor; }
@ -117,7 +117,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @param color arrow head stroke color
* @see setArrowHeadFillColor
* @see arrowHeadStrokeColor
* @note added in 2.5
* \since QGIS 2.5
*/
void setArrowHeadStrokeColor( const QColor &color );
@ -125,7 +125,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @returns arrow head fill color
* @see arrowHeadStrokeColor
* @see setArrowHeadFillColor
* @note added in 2.5
* \since QGIS 2.5
*/
QColor arrowHeadFillColor() const { return mArrowHeadFillColor; }
@ -133,7 +133,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @param color arrow head fill color
* @see arrowHeadFillColor
* @see setArrowHeadStrokeColor
* @note added in 2.5
* \since QGIS 2.5
*/
void setArrowHeadFillColor( const QColor &color );
@ -141,7 +141,7 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @param width pen width for arrow head stroke
* @see arrowHeadStrokeWidth
* @see setArrowHeadStrokeColor
* @note added in 2.5
* \since QGIS 2.5
*/
void setArrowHeadStrokeWidth( const double width );
@ -149,21 +149,21 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
* @returns pen width for arrow head stroke
* @see setArrowHeadStrokeWidth
* @see arrowHeadStrokeColor
* @note added in 2.5
* \since QGIS 2.5
*/
double arrowHeadStrokeWidth() const { return mArrowHeadStrokeWidth; }
/** Sets the line symbol used for drawing the line portion of the arrow
* @param symbol line symbol
* @see lineSymbol
* @note added in 2.5
* \since QGIS 2.5
*/
void setLineSymbol( QgsLineSymbol *symbol );
/** Returns the line symbol used for drawing the line portion of the arrow
* @returns line symbol
* @see setLineSymbol
* @note added in 2.5
* \since QGIS 2.5
*/
QgsLineSymbol *lineSymbol() { return mLineSymbol; }
@ -249,12 +249,12 @@ class CORE_EXPORT QgsComposerArrow: public QgsComposerItem
void init();
/** Creates the default line symbol
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void createDefaultLineSymbol();
/** Draws the arrow line
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void drawLine( QPainter *painter );
};

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

@ -67,20 +67,20 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* @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
* @note added in 2.3
* \since QGIS 2.3
*/
bool moveRow( int row, ShiftDirection direction );
/** Resets the attribute table's columns to match the source layer's fields. Remove all existing
* attribute table columns and column customisations.
* @note added in 2.3
* \since QGIS 2.3
*/
void resetToLayer();
/** Returns the QgsComposerTableColumn corresponding to an index in the model.
* @returns QgsComposerTableColumn for specified index
* @param index a QModelIndex
* @note added in 2.3
* \since QGIS 2.3
* @see indexFromColumn
*/
QgsComposerTableColumn *columnFromIndex( const QModelIndex &index ) const;
@ -88,7 +88,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
/** Returns a QModelIndex corresponding to a QgsComposerTableColumn in the model.
* @returns QModelIndex for specified QgsComposerTableColumn
* @param column a QgsComposerTableColumn
* @note added in 2.3
* \since QGIS 2.3
* @see columnFromIndex
*/
QModelIndex indexFromColumn( QgsComposerTableColumn *column );
@ -97,7 +97,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
* added to the end of the sort rank list, ie it will take the next largest available sort rank.
* @param column a QgsComposerTableColumn
* @param order sort order for column
* @note added in 2.3
* \since QGIS 2.3
* @see removeColumnFromSort
* @see moveColumnInSortRank
*/
@ -106,7 +106,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
/** Sets a specified column as an unsorted column in the QgsComposerAttributeTable. The column will be
* removed from the sort rank list.
* @param column a QgsComposerTableColumn
* @note added in 2.3
* \since QGIS 2.3
* @see setColumnAsSorted
*/
void setColumnAsUnsorted( QgsComposerTableColumn *column );
@ -114,7 +114,7 @@ class CORE_EXPORT QgsComposerAttributeTableColumnModelV2: public QAbstractTableM
/** Moves a column up or down in the sort rank for the QgsComposerAttributeTable.
* @param column a QgsComposerTableColumn
* @param direction direction to move the column in the sort rank list
* @note added in 2.3
* \since QGIS 2.3
* @see setColumnAsSorted
*/
bool moveColumnInSortRank( QgsComposerTableColumn *column, ShiftDirection direction );
@ -161,7 +161,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
/** Returns the QgsComposerTableColumn corresponding to a row in the proxy model.
* @returns QgsComposerTableColumn for specified row
* @param row a row number
* @note added in 2.3
* \since QGIS 2.3
* @see columnFromIndex
*/
QgsComposerTableColumn *columnFromRow( int row );
@ -169,7 +169,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
/** Returns the QgsComposerTableColumn corresponding to an index in the proxy model.
* @returns QgsComposerTableColumn for specified index
* @param index a QModelIndex
* @note added in 2.3
* \since QGIS 2.3
* @see columnFromRow
* @see columnFromSourceIndex
*/
@ -179,14 +179,14 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
* QgsComposerAttributeTableColumnModel model.
* @returns QgsComposerTableColumn for specified index from QgsComposerAttributeTableColumnModel
* @param sourceIndex a QModelIndex
* @note added in 2.3
* \since QGIS 2.3
* @see columnFromRow
* @see columnFromIndex
*/
QgsComposerTableColumn *columnFromSourceIndex( const QModelIndex &sourceIndex ) const;
/** Invalidates the current filter used by the proxy model
* @note added in 2.3
* \since QGIS 2.3
*/
void resetFilter();
@ -199,7 +199,7 @@ class CORE_EXPORT QgsComposerTableSortColumnsProxyModelV2: public QSortFilterPro
/** Returns a list of QgsComposerTableColumns without a set sort rank
* @returns QgsComposerTableColumns in attribute table without a sort rank
* @note added in 2.3
* \since QGIS 2.3
*/
QList<QgsComposerTableColumn *> columnsWithoutSortRank() const;

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

@ -261,7 +261,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
* @param refresh set to true to force the table to refetch features from its vector layer
* and immediately update the display of the table. This may result in the table changing size
* to accommodate the new displayed feature attributes.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
void setDisplayedFields( const QStringList &fields, bool refresh = true );
@ -276,7 +276,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/** Sets a string to wrap the contents of the table cells by. Occurrences of this string will
* be replaced by a line break.
* @param wrapString string to replace with line break
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see wrapString
*/
void setWrapString( const QString &wrapString );
@ -284,7 +284,7 @@ class CORE_EXPORT QgsComposerAttributeTableV2: public QgsComposerTableV2
/** Returns the string used to wrap the contents of the table cells by. Occurrences of this string will
* be replaced by a line break.
* @returns string which will be replaced with line break
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see setWrapString
*/
QString wrapString() const { return mWrapString; }

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

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

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

@ -52,7 +52,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @see contentMode
* @see setUrl
* @see setHtml
* @note added in 2.5
* \since QGIS 2.5
*/
void setContentMode( ContentMode mode ) { mContentMode = mode; }
@ -61,7 +61,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @see setContentMode
* @see url
* @see html
* @note added in 2.5
* \since QGIS 2.5
*/
ContentMode contentMode() const { return mContentMode; }
@ -90,7 +90,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @see html
* @see contentMode
* @see loadHtml
* @note added in 2.5
* \since QGIS 2.5
*/
void setHtml( const QString &html );
@ -99,7 +99,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @returns HTML displayed in item
* @see setHtml
* @see contentMode
* @note added in 2.5
* \since QGIS 2.5
*/
QString html() const { return mHtml; }
@ -109,7 +109,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* feature.
* @returns true if html item will evaluate expressions in the content
* @see setEvaluateExpressions
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool evaluateExpressions() const { return mEvaluateExpressions; }
@ -119,7 +119,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* feature.
* @param evaluateExpressions set to true to evaluate expressions in the HTML content
* @see evaluateExpressions
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void setEvaluateExpressions( bool evaluateExpressions );
@ -146,7 +146,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* useSmartBreaks is true.
* @param maxBreakDistance maximum amount of empty space to leave when calculating
* page break locations
* @note added in 2.3
* \since QGIS 2.3
* @see maxBreakDistance
* @see setUseSmartBreaks
*/
@ -157,7 +157,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* at the bottom of a frame after calculating the optimum break location. This setting
* is only effective if useSmartBreaks is true.
* @returns maximum amount of empty space to leave when calculating page break locations
* @note added in 2.3
* \since QGIS 2.3
* @see setMaxBreakDistance
* @see useSmartBreaks
*/
@ -171,7 +171,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @see userStylesheet
* @see setUserStylesheetEnabled
* @see loadHtml
* @note added in 2.5
* \since QGIS 2.5
*/
void setUserStylesheet( const QString &stylesheet );
@ -180,7 +180,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @returns CSS rules for user stylesheet
* @see setUserStylesheet
* @see userStylesheetEnabled
* @note added in 2.5
* \since QGIS 2.5
*/
QString userStylesheet() const { return mUserStylesheet; }
@ -188,7 +188,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @param stylesheetEnabled set to true to enable user stylesheets
* @see userStylesheetEnabled
* @see setUserStylesheet
* @note added in 2.5
* \since QGIS 2.5
*/
void setUserStylesheetEnabled( const bool stylesheetEnabled );
@ -196,7 +196,7 @@ class CORE_EXPORT QgsComposerHtml: public QgsComposerMultiFrame
* @returns true if user stylesheets are enabled
* @see setUserStylesheetEnabled
* @see userStylesheet
* @note added in 2.5
* \since QGIS 2.5
*/
bool userStylesheetEnabled() const { return mEnableUserStylesheet; }

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

@ -127,7 +127,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* from the composition are not deleted so that they can be restored via an undo
* command.
* @returns true if the item has been removed from the composition
* @note added in QGIS 2.5
* \since QGIS 2.5
* @see setIsRemoved
*/
virtual bool isRemoved() const { return mRemovedFromComposition; }
@ -136,7 +136,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* from the composition are not deleted so that they can be restored via an undo
* command.
* @param removed set to true if the item has been removed from the composition
* @note added in QGIS 2.5
* \since QGIS 2.5
* @see isRemoved
*/
void setIsRemoved( const bool removed ) { mRemovedFromComposition = removed; }
@ -159,7 +159,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* @param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out
* @param point item point for zoom center
* @param mode zoom mode
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) { Q_UNUSED( factor ); Q_UNUSED( point ); Q_UNUSED( mode ); }
@ -464,7 +464,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* @returns display name for item
* @see id
* @see setId
* @note added in version 2.5
* \since QGIS 2.5
*/
virtual QString displayName() const;
@ -473,7 +473,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* @note QGraphicsItem::setVisible should not be called directly
* on a QgsComposerItem, as some item types (e.g., groups) need to override
* the visibility toggle.
* @note added in version 2.5
* \since QGIS 2.5
*/
virtual void setVisibility( const bool visible );
@ -481,28 +481,28 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* @param valueType controls whether the returned value is the user specified value,
* or the current evaluated value (which may be affected by data driven settings).
* @returns true if item should be excluded
* @note added in version 2.5
* \since QGIS 2.5
* @see setExcludeFromExports
*/
bool excludeFromExports( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue );
/** Sets whether the item should be excluded from composer exports and prints
* @param exclude set to true to exclude the item from exports
* @note added in version 2.5
* \since QGIS 2.5
* @see excludeFromExports
*/
virtual void setExcludeFromExports( const bool exclude );
/** Returns whether this item is part of a group
* @returns true if item is in a group
* @note added in version 2.5
* \since QGIS 2.5
* @see setIsGroupMember
*/
bool isGroupMember() const { return mIsGroupMember; }
/** Sets whether this item is part of a group
* @param isGroupMember set to true if item is in a group
* @note added in version 2.5
* \since QGIS 2.5
* @see isGroupMember
*/
void setIsGroupMember( const bool isGroupMember );
@ -524,7 +524,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
/** Creates an expression context relating to the item's current state. The context includes
* scopes for global, project, composition, atlas and item properties.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
virtual QgsExpressionContext createExpressionContext() const override;
@ -533,7 +533,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* the item will not be redrawn. This can be used to prevent
* multiple item updates when many settings for an item are
* changed sequentially.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see updatesEnabled()
*/
void setUpdatesEnabled( bool enabled ) { mUpdatesEnabled = enabled; }
@ -543,7 +543,7 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* the item will not be redrawn. This can be used to prevent
* multiple item updates when many settings for an item are
* changed sequentially.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setUpdatesEnabled()
*/
bool updatesEnabled() const { return mUpdatesEnabled; }
@ -682,13 +682,13 @@ class CORE_EXPORT QgsComposerItem: public QgsComposerObject, public QGraphicsRec
* @param context expression context for evaluating data defined expressions
* @returns bounding box rectangle for item after data defined size and position have been
* set and position mode has been accounted for
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
QRectF evalItemRect( const QRectF &newRect, const bool resizeOnly = false, const QgsExpressionContext *context = nullptr );
/** Returns whether the item should be drawn in the current context
* @returns true if item should be drawn
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool shouldDrawItem() const;

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

@ -82,14 +82,14 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
/** Returns the horizontal margin between the edge of the frame and the label
* contents.
* @returns horizontal margin in mm
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
double marginX() const { return mMarginX; }
/** Returns the vertical margin between the edge of the frame and the label
* contents.
* @returns vertical margin in mm
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
double marginY() const { return mMarginY; }
@ -108,7 +108,7 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
* @param margin horizontal margin in mm
* @see setMargin
* @see setMarginY
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void setMarginX( const double margin );
@ -117,7 +117,7 @@ class CORE_EXPORT QgsComposerLabel: public QgsComposerItem
* @param margin vertical margin in mm
* @see setMargin
* @see setMarginX
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void setMarginY( const double margin );

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

@ -33,7 +33,7 @@ class QgsLegendRenderer;
* Item model implementation based on layer tree model for composer legend.
* Overrides some functionality of QgsLayerTreeModel to better fit the needs of composer legend.
*
* @note added in 2.6
* \since QGIS 2.6
*/
class CORE_EXPORT QgsLegendModel : public QgsLayerTreeModel
{
@ -76,13 +76,13 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @param enabled set to false to disable automatic resizing. The legend frame will not
* be expanded to fit legend items, and items may be cropped from display.
* @see resizeToContents()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setResizeToContents( bool enabled );
/** Returns whether the legend should automatically resize to fit its contents.
* @see setResizeToContents()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
bool resizeToContents() const;
@ -92,30 +92,30 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
*/
QgsLegendModel *model() { return mLegendModel; }
//! @note added in 2.6
//! \since QGIS 2.6
void setAutoUpdateModel( bool autoUpdate );
//! @note added in 2.6
//! \since QGIS 2.6
bool autoUpdateModel() const;
//! Set whether legend items should be filtered to show just the ones visible in the associated map
//! @note added in 2.6
//! \since QGIS 2.6
void setLegendFilterByMapEnabled( bool enabled );
//! Find out whether legend items are filtered to show just the ones visible in the associated map
//! @note added in 2.6
//! \since QGIS 2.6
bool legendFilterByMapEnabled() const { return mLegendFilterByMap; }
//! Update() overloading. Use it rather than update()
//! @note added in 2.12
//! \since QGIS 2.12
virtual void updateItem() override;
//! When set to true, during an atlas rendering, it will filter out legend elements
//! where features are outside the current atlas feature.
//! @note added in 2.14
//! \since QGIS 2.14
void setLegendFilterOutAtlas( bool doFilter );
//! Whether to filter out legend elements outside of the current atlas feature
//! @see setLegendFilterOutAtlas()
//! @note added in 2.14
//! \since QGIS 2.14
bool legendFilterOutAtlas() const;
//setters and getters
@ -124,14 +124,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/** Returns the alignment of the legend title
* @returns Qt::AlignmentFlag for the legend title
* @note added in 2.3
* \since QGIS 2.3
* @see setTitleAlignment
*/
Qt::AlignmentFlag titleAlignment() const;
/** Sets the alignment of the legend title
* @param alignment Text alignment for drawing the legend title
* @note added in 2.3
* \since QGIS 2.3
* @see titleAlignment
*/
void setTitleAlignment( Qt::AlignmentFlag alignment );
@ -151,14 +151,14 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
void setStyleMargin( QgsLegendStyle::Style s, QgsLegendStyle::Side side, double margin );
/** Returns the spacing in-between lines in mm
* @note added in 3.0
* \since QGIS 3.0
* @see setLineSpacing
*/
double lineSpacing() const;
/** Sets the spacing in-between multiple lines
* @param spacing Double value to use as spacing in between multiple lines
* @note added in 3.0
* \since QGIS 3.0
* @see lineSpacing
*/
void setLineSpacing( double spacing );
@ -200,7 +200,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see setDrawRasterStroke()
* @see rasterStrokeColor()
* @see rasterStrokeWidth()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
bool drawRasterStroke() const;
@ -209,7 +209,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see drawRasterStroke()
* @see setRasterStrokeColor()
* @see setRasterStrokeWidth()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setDrawRasterStroke( bool enabled );
@ -218,7 +218,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see setRasterStrokeColor()
* @see drawRasterStroke()
* @see rasterStrokeWidth()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QColor rasterStrokeColor() const;
@ -228,7 +228,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see rasterStrokeColor()
* @see setDrawRasterStroke()
* @see setRasterStrokeWidth()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setRasterStrokeColor( const QColor &color );
@ -237,7 +237,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see setRasterStrokeWidth()
* @see drawRasterStroke()
* @see rasterStrokeColor()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
double rasterStrokeWidth() const;
@ -247,7 +247,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
* @see rasterStrokeWidth()
* @see setDrawRasterStroke()
* @see setRasterStrokeColor()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setRasterStrokeWidth( double width );
@ -274,7 +274,7 @@ class CORE_EXPORT QgsComposerLegend : public QgsComposerItem
/**
* Returns the legend's renderer settings object.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
const QgsLegendSettings &legendSettings() const { return mSettings; }

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

@ -99,7 +99,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
void cache();
/** Return map settings that would be used for drawing of the map
* @note added in 2.6 */
* \since QGIS 2.6 */
QgsMapSettings mapSettings( const QgsRectangle &extent, QSizeF size, int dpi ) const;
//! \brief Get identification number
@ -121,7 +121,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* @param factor zoom factor, where > 1 results in a zoom in and < 1 results in a zoom out
* @param point item point for zoom center
* @param mode zoom mode
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) override;
@ -148,7 +148,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* map scale.
* @param extent new extent for the map
* @see setNewExtent
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void zoomToExtent( const QgsRectangle &extent );
@ -173,7 +173,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* This will match the presetCrs() if that is set, or if a preset
* CRS is not set then the map's CRS will follow the composition's
* project's CRS.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see presetCrs()
* @see setCrs()
*/
@ -184,7 +184,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* CRS will be used to render the map regardless of any project CRS
* setting. If the returned CRS is not valid then the project CRS
* will be used to render the map.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see crs()
* @see setCrs()
*/
@ -196,7 +196,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* setting. If the CRS is not valid then the project CRS will be used to render the map.
* @see crs()
* @see presetCrs()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setCrs( const QgsCoordinateReferenceSystem &crs );
@ -239,16 +239,16 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
*/
void setLayers( const QList<QgsMapLayer *> &layers );
//! Getter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8
//! Getter for flag that determines if current styles of layers should be overridden by previously stored styles. \since QGIS 2.8
bool keepLayerStyles() const { return mKeepLayerStyles; }
//! Setter for flag that determines if current styles of layers should be overridden by previously stored styles. @note added in 2.8
//! Setter for flag that determines if current styles of layers should be overridden by previously stored styles. \since QGIS 2.8
void setKeepLayerStyles( bool enabled ) { mKeepLayerStyles = enabled; }
//! Getter for stored overrides of styles for layers. @note added in 2.8
//! Getter for stored overrides of styles for layers. \since QGIS 2.8
QMap<QString, QString> layerStyleOverrides() const { return mLayerStyleOverrides; }
//! Setter for stored overrides of styles for layers. @note added in 2.8
//! Setter for stored overrides of styles for layers. \since QGIS 2.8
void setLayerStyleOverrides( const QMap<QString, QString> &overrides );
//! Stores the current layer styles into style overrides. @note added in 2.8
//! Stores the current layer styles into style overrides. \since QGIS 2.8
void storeCurrentLayerStyles();
/** Whether the map should follow a map theme. If true, the layers and layer styles
@ -259,20 +259,20 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
* at any time since they are alternative approaches - if both are enabled,
* following map theme has higher priority. If neither is enabled (or if preset name is not set),
* map will use the same configuration as the map canvas uses.
* @note added in 2.16 */
* \since QGIS 2.16 */
bool followVisibilityPreset() const { return mFollowVisibilityPreset; }
/** Sets whether the map should follow a map theme. See followVisibilityPreset() for more details.
* @note added in 2.16 */
* \since QGIS 2.16 */
void setFollowVisibilityPreset( bool follow ) { mFollowVisibilityPreset = follow; }
/** Preset name that decides which layers and layer styles are used for map rendering. It is only
* used when followVisibilityPreset() returns true.
* @note added in 2.16 */
* \since QGIS 2.16 */
QString followVisibilityPresetName() const { return mFollowVisibilityPresetName; }
/** Sets preset name for map rendering. See followVisibilityPresetName() for more details.
* @note added in 2.16 */
* \since QGIS 2.16 */
void setFollowVisibilityPresetName( const QString &name ) { mFollowVisibilityPresetName = name; }
// Set cache outdated
@ -450,7 +450,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
QPointF mapToItemCoords( QPointF mapCoords ) const;
/** Calculates the extent to request and the yShift of the top-left point in case of rotation.
* @note added in 2.6 */
* \since QGIS 2.6 */
void requestedExtent( QgsRectangle &extent ) const;
virtual QgsExpressionContext createExpressionContext() const override;
@ -466,7 +466,7 @@ class CORE_EXPORT QgsComposerMap : public QgsComposerItem
/** Emitted when layer style overrides are changed... a means to let
* associated legend items know they should update
* @note added in 2.10
* \since QGIS 2.10
*/
void layerStyleOverridesChanged();

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

@ -40,7 +40,7 @@ class QgsRenderContext;
* \brief A collection of grids which is drawn above the map content in a
* QgsComposerMap. The grid stack controls which grids are drawn and the
* order they are drawn in.
* \note added in QGIS 2.5
* \since QGIS 2.5
* \see QgsComposerMapGrid
*/
class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
@ -142,7 +142,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* @param right storage for right extension
* @param bottom storage for bottom extension
* @param left storage for left extension
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see maxGridExtension()
*/
void calculateMaxGridExtension( double &top, double &right, double &bottom, double &left ) const;
@ -156,7 +156,7 @@ class CORE_EXPORT QgsComposerMapGridStack : public QgsComposerMapItemStack
* \class QgsComposerMapGrid
* \brief An individual grid which is drawn above the map content in a
* QgsComposerMap.
* \note added in QGIS 2.5
* \since QGIS 2.5
* \see QgsComposerMapGridStack
*/
class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
@ -335,7 +335,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @param right storage for right extension
* @param bottom storage for bottom extension
* @param left storage for left extension
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see maxExtension()
*/
void calculateMaxExtension( double &top, double &right, double &bottom, double &left );
@ -585,7 +585,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @param display display mode for annotations
* @param border side of map for annotations
* @see annotationDisplay
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void setAnnotationDisplay( const DisplayMode display, const BorderSide border );
@ -595,7 +595,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @param border side of map for annotations
* @returns display mode for grid annotations
* @see setAnnotationDisplay
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
DisplayMode annotationDisplay( const BorderSide border ) const;
@ -663,7 +663,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* is QgsComposerMapGrid::CustomFormat.
* @param expression expression for evaluating custom grid annotations
* @see annotationExpression
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setAnnotationExpression( const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); }
@ -671,7 +671,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* is QgsComposerMapGrid::CustomFormat.
* @returns expression for evaluating custom grid annotations
* @see setAnnotationExpression
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QString annotationExpression() const { return mGridAnnotationExpressionString; }
@ -695,7 +695,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @param divisions grid divisions for frame
* @param border side of map for frame
* @see frameDivisions
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void setFrameDivisions( const DisplayMode divisions, const BorderSide border );
@ -703,7 +703,7 @@ class CORE_EXPORT QgsComposerMapGrid : public QgsComposerMapItem
* @param border side of map for frame
* @returns grid divisions for frame
* @see setFrameDivisions
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
DisplayMode frameDivisions( const BorderSide border ) const;

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

@ -126,7 +126,7 @@ class CORE_EXPORT QgsComposerMapItem : public QgsComposerObject
* \brief A collection of map items which are drawn above the map content in a
* QgsComposerMap. The item stack controls which items are drawn and the
* order they are drawn in.
* \note added in QGIS 2.5
* \since QGIS 2.5
* \see QgsComposerMapItem
*/
class CORE_EXPORT QgsComposerMapItemStack

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

@ -34,7 +34,7 @@ class QgsComposerMapOverview;
* \brief A collection of overviews which are drawn above the map content in a
* QgsComposerMap. The overview stack controls which overviews are drawn and the
* order they are drawn in.
* \note added in QGIS 2.5
* \since QGIS 2.5
* \see QgsComposerMapOverview
*/
class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
@ -128,7 +128,7 @@ class CORE_EXPORT QgsComposerMapOverviewStack : public QgsComposerMapItemStack
* \class QgsComposerMapOverview
* \brief An individual overview which is drawn above the map content in a
* QgsComposerMap, and shows the extent of another QgsComposerMap.
* \note added in QGIS 2.5
* \since QGIS 2.5
* \see QgsComposerMapOverviewStack
*/
class CORE_EXPORT QgsComposerMapOverview : public QgsComposerMapItem

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

@ -82,33 +82,33 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() ) override;
/** Clears all items from z-order list and resets the model
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void clear();
/** Returns the size of the z-order list, which includes items which may
* have been removed from the composition.
* @returns size of z-order list
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
int zOrderListSize() const;
/** Rebuilds the z-order list, based on the current stacking of items in the composition.
* This method should be called after adding multiple items to the composition.
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void rebuildZList();
/** Adds an item to the top of the composition z stack.
* @param item item to add. The item must not already exist in the z-order list.
* @note added in QGIS 2.5
* \since QGIS 2.5
* @see reorderItemToTop
*/
void addItemAtTop( QgsComposerItem *item );
/** Removes an item from the z-order list.
* @param item item to remove
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void removeItem( QgsComposerItem *item );
@ -119,7 +119,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see reorderItemDown
* @see reorderItemToTop
* @see reorderItemToBottom
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool reorderItemUp( QgsComposerItem *item );
@ -130,7 +130,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see reorderItemUp
* @see reorderItemToTop
* @see reorderItemToBottom
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool reorderItemDown( QgsComposerItem *item );
@ -141,7 +141,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see reorderItemUp
* @see reorderItemDown
* @see reorderItemToBottom
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool reorderItemToTop( QgsComposerItem *item );
@ -152,7 +152,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see reorderItemUp
* @see reorderItemDown
* @see reorderItemToTop
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
bool reorderItemToBottom( QgsComposerItem *item );
@ -163,7 +163,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @returns item above specified item. If no items were found, no item
* will be returned.
* @see getComposerItemBelow
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerItem *getComposerItemAbove( QgsComposerItem *item ) const;
@ -174,14 +174,14 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @returns item below specified item. If no items were found, no item
* will be returned.
* @see getComposerItemAbove
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
QgsComposerItem *getComposerItemBelow( QgsComposerItem *item ) const;
/** Returns the item z-order list. This list includes both items currently in the
* composition and items which have been removed from the composition.
* @returns item z-order list
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
QList<QgsComposerItem *> *zOrderList();
@ -189,7 +189,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* has been removed from the composition.
* @param item to mark as removed from the composition
* @see setItemRestored
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void setItemRemoved( QgsComposerItem *item );
@ -197,7 +197,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* from the composition is restored to the composition.
* @param item to mark as restored to the composition
* @see setItemRemoved
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void setItemRestored( QgsComposerItem *item );
@ -206,7 +206,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see updateItemLockStatus
* @see updateItemVisibility
* @see updateItemSelectStatus
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void updateItemDisplayName( QgsComposerItem *item );
@ -215,7 +215,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see updateItemDisplayName
* @see updateItemVisibility
* @see updateItemSelectStatus
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void updateItemLockStatus( QgsComposerItem *item );
@ -224,7 +224,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see updateItemDisplayName
* @see updateItemLockStatus
* @see updateItemSelectStatus
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void updateItemVisibility( QgsComposerItem *item );
@ -233,7 +233,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* @see updateItemDisplayName
* @see updateItemVisibility
* @see updateItemLockStatus
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void updateItemSelectStatus( QgsComposerItem *item );
@ -248,7 +248,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
/** Sets an item as the current selection from a QModelIndex
* @param index QModelIndex of item to set as selected
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void setSelected( const QModelIndex &index );
@ -295,7 +295,7 @@ class CORE_EXPORT QgsComposerModel: public QAbstractItemModel
* \class QgsComposerProxyModel
* \ingroup core
* \brief Allows for filtering a QgsComposerModel by item type.
* \note added in 2.16
* \since QGIS 2.16
*/
class CORE_EXPORT QgsComposerProxyModel: public QSortFilterProxyModel
{

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

@ -73,7 +73,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* @returns fixed size for frame. If the size has a width or height of 0, then
* the frame size is not fixed in that direction and frames can have variable width
* or height accordingly.
* @note added in version 2.5
* \since QGIS 2.5
* @see minFrameSize
* @see recalculateFrameRects
*/
@ -85,7 +85,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* @param frameIndex frame number
* @returns minimum size for frame. If the size has a width or height of 0, then
* the frame size has no minimum in that direction.
* @note added in version 2.5
* \since QGIS 2.5
* @see fixedFrameSize
* @see recalculateFrameRects
*/
@ -95,7 +95,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* @param painter destination painter
* @param renderExtent visible extent of content to render into the painter.
* @param frameIndex frame number for content
* @note added in version 2.5
* \since QGIS 2.5
*/
virtual void render( QPainter *painter, const QRectF &renderExtent, const int frameIndex ) = 0;
@ -110,7 +110,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* @param yPos maximum vertical position for break
* @returns the optimal breakable position which occurs in the multi frame close
* to and before the specified yPos
* @note added in version 2.3
* \since QGIS 2.3
*/
virtual double findNearbyPageBreak( double yPos ) { return yPos; }
@ -208,7 +208,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
/** Returns the index of a frame within the multiframe
* @param frame frame to find index of
* @returns index for frame if found, -1 if frame not found in multiframe
* @note added in version 2.5
* \since QGIS 2.5
* @see frame
*/
int frameIndex( QgsComposerFrame *frame ) const;
@ -219,13 +219,13 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
* @param pos position of top-left corner of the new frame
* @param size size of the new frame
* @returns new QgsComposerFrame
* @note added in version 2.3
* \since QGIS 2.3
*/
QgsComposerFrame *createNewFrame( QgsComposerFrame *currentFrame, QPointF pos, QSizeF size );
/** Get multiframe display name.
* @returns display name for item
* @note added in version 2.5
* \since QGIS 2.5
*/
virtual QString displayName() const;
@ -246,7 +246,7 @@ class CORE_EXPORT QgsComposerMultiFrame: public QgsComposerObject
/** Forces a recalculation of all the associated frame's scene rectangles. This
* method is useful for multiframes which implement a minFrameSize() or
* fixedFrameSize() method.
* @note added in version 2.5
* \since QGIS 2.5
* @see minFrameSize()
* @see fixedFrameSize()
* @see recalculateFrameSizes

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

@ -25,7 +25,7 @@
/** \ingroup core
* An abstract composer item that provides generic methods for nodes based
* shapes such as polygon or polylines.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class CORE_EXPORT QgsComposerNodesItem: public QgsComposerItem
{

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

@ -100,7 +100,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
/**
* Returns the composer object property definitions.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
static const QgsPropertiesDefinition &propertyDefinitions();
@ -131,20 +131,20 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
virtual bool readXml( const QDomElement &itemElem, const QDomDocument &doc );
/** Returns a reference to the object's property collection, used for data defined overrides.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setDataDefinedProperties()
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/** Returns a reference to the object's property collection, used for data defined overrides.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setDataDefinedProperties()
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; }
/** Sets the objects's property collection, used for data defined overrides.
* @param collection property collection. Existing properties will be replaced.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see dataDefinedProperties()
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
@ -155,7 +155,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
* @see customProperty()
* @see removeCustomProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setCustomProperty( const QString &key, const QVariant &value );
@ -166,7 +166,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
* @see setCustomProperty()
* @see removeCustomProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const;
@ -175,7 +175,7 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
* @see setCustomProperty()
* @see customProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void removeCustomProperty( const QString &key );
@ -183,13 +183,13 @@ class CORE_EXPORT QgsComposerObject: public QObject, public QgsExpressionContext
* @see setCustomProperty()
* @see customProperty()
* @see removeCustomProperty()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QStringList customProperties() const;
/** Creates an expression context relating to the objects' current state. The context includes
* scopes for global, project and composition properties.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
virtual QgsExpressionContext createExpressionContext() const;

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

@ -75,7 +75,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @param path path for the source image
* @see usePictureExpression
* @see picturePath
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
void setPicturePath( const QString &path );
@ -84,7 +84,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* @returns path for the source image
* @see usePictureExpression
* @see setPicturePath
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
QString picturePath() const;
@ -107,7 +107,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Returns the rotation used for drawing the picture within the item's frame
* @returns picture rotation in degrees
* @note added in 2.2
* \since QGIS 2.2
* @see setPictureRotation
* @see rotationMap
*/
@ -143,7 +143,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* Returns the mode used to align the picture to a map's North.
* @see setNorthMode()
* @see northOffset()
* @note added in QGIS 2.18
* \since QGIS 2.18
*/
NorthMode northMode() const { return mNorthMode; }
@ -151,7 +151,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* Sets the mode used to align the picture to a map's North.
* @see northMode()
* @see setNorthOffset()
* @note added in QGIS 2.18
* \since QGIS 2.18
*/
void setNorthMode( NorthMode mode );
@ -159,7 +159,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* Returns the offset added to the picture's rotation from a map's North.
* @see setNorthOffset()
* @see northMode()
* @note added in QGIS 2.18
* \since QGIS 2.18
*/
double northOffset() const { return mNorthOffset; }
@ -167,14 +167,14 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* Sets the offset added to the picture's rotation from a map's North.
* @see northOffset()
* @see setNorthMode()
* @note added in QGIS 2.18
* \since QGIS 2.18
*/
void setNorthOffset( double offset );
/** Returns the resize mode used for drawing the picture within the composer
* item's frame.
* @returns resize mode of picture
* @note added in 2.3
* \since QGIS 2.3
* @see setResizeMode
*/
ResizeMode resizeMode() const { return mResizeMode; }
@ -182,7 +182,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Sets the picture's anchor point, which controls how it is placed
* within the picture item's frame.
* @param anchor anchor point for picture
* @note added in 2.3
* \since QGIS 2.3
* @see pictureAnchor
*/
void setPictureAnchor( QgsComposerItem::ItemPositionMode anchor );
@ -190,7 +190,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Returns the picture's current anchor, which controls how it is placed
* within the picture item's frame.
* @returns anchor point for picture
* @note added in 2.3
* \since QGIS 2.3
* @see setPictureAnchor
*/
ItemPositionMode pictureAnchor() const { return mPictureAnchor; }
@ -198,7 +198,7 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Returns the fill color used for parametrized SVG files.
* @see setSvgFillColor()
* @see svgStrokeColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
QColor svgFillColor() const { return mSvgFillColor; }
@ -208,14 +208,14 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* non-parametrized SVG files.
* @see svgFillColor()
* @see setSvgStrokeColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
void setSvgFillColor( const QColor &color );
/** Returns the stroke color used for parametrized SVG files.
* @see setSvgStrokeColor()
* @see svgFillColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
QColor svgStrokeColor() const { return mSvgStrokeColor; }
@ -225,14 +225,14 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* non-parametrized SVG files.
* @see svgStrokelColor()
* @see setSvgFillColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
void setSvgStrokeColor( const QColor &color );
/** Returns the stroke width (in mm) used for parametrized SVG files.
* @see setSvgStrokeWidth()
* @see svgStrokeColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
double svgStrokeWidth() const { return mSvgStrokeWidth; }
@ -242,13 +242,13 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* non-parametrized SVG files.
* @see svgStrokeWidth()
* @see setSvgStrokeColor()
* @note added in QGIS 2.14.1
* \since QGIS 2.14.1
*/
void setSvgStrokeWidth( double width );
/** Returns the current picture mode (image format).
* @returns picture mode
* @note added in 2.3
* \since QGIS 2.3
*/
Mode mode() const { return mMode; }
@ -258,13 +258,13 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
* the item's frame, only the way the picture is drawn within the item.
* @param r rotation in degrees clockwise
* @see pictureRotation
* @note added in 2.2
* \since QGIS 2.2
*/
virtual void setPictureRotation( double r );
/** Sets the resize mode used for drawing the picture within the item bounds.
* @param mode ResizeMode to use for image file
* @note added in 2.3
* \since QGIS 2.3
* @see resizeMode
*/
virtual void setResizeMode( ResizeMode mode );
@ -272,12 +272,12 @@ class CORE_EXPORT QgsComposerPicture: public QgsComposerItem
/** Recalculates the source image (if using an expression for picture's source)
* and reloads and redraws the picture.
* @param context expression context for evaluating data defined picture sources
* @note added in 2.3
* \since QGIS 2.3
*/
void refreshPicture( const QgsExpressionContext *context = nullptr );
/** Forces a recalculation of the picture's frame size
* @note added in 2.3
* \since QGIS 2.3
*/
void recalculateSize();

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

@ -27,7 +27,7 @@ class QgsFillSymbol;
/** \ingroup core
* Composer item for polygons.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class CORE_EXPORT QgsComposerPolygon: public QgsComposerNodesItem

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

@ -27,7 +27,7 @@ class QgsLineSymbol;
/** \ingroup core
* Composer item for polylines.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
class CORE_EXPORT QgsComposerPolyline: public QgsComposerNodesItem
{

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

@ -81,7 +81,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see setSegmentSizeMode
* @see minBarWidth
* @see maxBarWidth
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
SegmentSizeMode segmentSizeMode() const { return mSegmentSizeMode; }
@ -90,7 +90,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see segmentSizeMode
* @see setMinBarWidth
* @see setMaxBarWidth
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void setSegmentSizeMode( SegmentSizeMode mode );
@ -100,7 +100,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see segmentSizeMode
* @see setMinBarWidth
* @see maxBarWidth
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
double minBarWidth() const { return mMinBarWidth; }
@ -111,7 +111,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see minBarWidth
* @see setMaxBarWidth
* @see setSegmentSizeMode
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void setMinBarWidth( double minWidth );
@ -121,7 +121,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see segmentSizeMode
* @see setMaxBarWidth
* @see minBarWidth
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
double maxBarWidth() const { return mMaxBarWidth; }
@ -132,7 +132,7 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
* @see minBarWidth
* @see setMaxBarWidth
* @see setSegmentSizeMode
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
void setMaxBarWidth( double maxWidth );
@ -162,52 +162,52 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
/** Returns the color used for fills in the scalebar.
* @see setFillColor()
* @see fillColor2()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
QColor fillColor() const {return mFillColor;}
/** Sets the color used for fills in the scalebar.
* @see fillColor()
* @see setFillColor2()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setFillColor( const QColor &color ) {mFillColor = color; mBrush.setColor( color ); }
/** Returns the secondary color used for fills in the scalebar.
* @see setFillColor2()
* @see fillColor()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
QColor fillColor2() const {return mFillColor2;}
/** Sets the secondary color used for fills in the scalebar.
* @see fillColor2()
* @see setFillColor2()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setFillColor2( const QColor &color ) {mFillColor2 = color; mBrush2.setColor( color ); }
/** Returns the color used for lines in the scalebar.
* @see setLineColor()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
QColor lineColor() const {return mLineColor;}
/** Sets the color used for lines in the scalebar.
* @see lineColor()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setLineColor( const QColor &color ) { mLineColor = color; mPen.setColor( mLineColor ); }
/** Returns the line width in millimeters for lines in the scalebar.
* @see setLineWidth()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
double lineWidth() const {return mLineWidth;}
/** Sets the line width in millimeters for lines in the scalebar.
* @see lineWidth()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setLineWidth( double width ) { mLineWidth = width; mPen.setWidthF( width ); }

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

@ -43,28 +43,28 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Writes the column's properties to xml for storage.
* @param columnElem an existing QDomElement in which to store the column's properties.
* @param doc QDomDocument for the destination xml.
* @note added in 2.3
* \since QGIS 2.3
* @see readXml
*/
virtual bool writeXml( QDomElement &columnElem, QDomDocument &doc ) const;
/** Reads the column's properties from xml.
* @param columnElem a QDomElement holding the column's desired properties.
* @note added in 2.3
* \since QGIS 2.3
* @see writeXml
*/
virtual bool readXml( const QDomElement &columnElem );
/** Returns the width for a column.
* @returns column width in mm, or 0 if column width is automatically calculated.
* @note added in 2.5
* \since QGIS 2.5
* @see setWidth
*/
double width() const { return mWidth; }
/** Sets the width for a column.
* @param width column width in mm, or 0 if column width is to be automatically calculated.
* @note added in 2.5
* \since QGIS 2.5
* @see width
*/
void setWidth( const double width ) { mWidth = width; }
@ -72,7 +72,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Returns the heading for a column, which is the value displayed in the columns
* header cell.
* @returns Heading for column.
* @note added in 2.3
* \since QGIS 2.3
* @see setHeading
*/
QString heading() const { return mHeading; }
@ -80,7 +80,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Sets the heading for a column, which is the value displayed in the columns
* header cell.
* @param heading Heading for column.
* @note added in 2.3
* \since QGIS 2.3
* @see heading
*/
void setHeading( const QString &heading ) { mHeading = heading; }
@ -88,7 +88,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Returns the horizontal alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @returns horizontal alignment.
* @note added in 2.3
* \since QGIS 2.3
* @see setHAlignment
* @see vAlignment
*/
@ -97,7 +97,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Sets the horizontal alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @param alignment horizontal alignment for cell.
* @note added in 2.3
* \since QGIS 2.3
* @see hAlignment
* @see setVAlignment
*/
@ -106,7 +106,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Returns the vertical alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @returns vertical alignment.
* @note added in 2.12
* \since QGIS 2.12
* @see setVAlignment
* @see hAlignment
*/
@ -115,7 +115,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Sets the vertical alignment for a column, which controls the alignment
* used for drawing column values within cells.
* @param alignment vertical alignment for cell.
* @note added in 2.12
* \since QGIS 2.12
* @see vAlignment
* @see setHAlignment
*/
@ -124,7 +124,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Returns the attribute name or expression used for the column's values. This property
* is only used when the column is part of a QgsComposerAttributeTable.
* @returns attribute name or expression text for column
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setAttribute
*/
@ -133,7 +133,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Sets the attribute name or expression used for the column's values. This property
* is only used when the column is part of a QgsComposerAttributeTable.
* @param attribute attribute name or expression text for column
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see attribute
*/
@ -142,7 +142,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Returns the sort order for the column. This property is only used when the column
* is part of a QgsComposerAttributeTable and when sortByRank is > 0.
* @returns sort order for column
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setSortOrder
* @see sortByRank
@ -152,7 +152,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Sets the sort order for the column. This property is only used when the column
* is part of a QgsComposerAttributeTable and when sortByRank is > 0.
* @param sortOrder sort order for column
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see sortOrder
* @see setSortByRank
@ -166,7 +166,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* is part of a QgsComposerAttributeTable.
* @returns sort rank for column. If sort rank is <= 0 then the column is not being
* sorted.
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see setSortByRank
* @see sortOrder
@ -180,7 +180,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
* is part of a QgsComposerAttributeTable.
* @param sortByRank sort rank for column. If sort rank is <= 0 then the column is not being
* sorted.
* @note added in 2.3
* \since QGIS 2.3
* @note only applicable when used in a QgsComposerAttributeTable
* @see sortByRank
* @see setSortOrder
@ -189,7 +189,7 @@ class CORE_EXPORT QgsComposerTableColumn: public QObject
/** Creates a duplicate column which is a deep copy of this column.
* @returns a new QgsComposerTableColumn with same properties as this column.
* @note added in 2.3
* \since QGIS 2.3
*/
QgsComposerTableColumn *clone();

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

@ -29,20 +29,20 @@ class QgsComposerTableColumn;
/** \ingroup core
* List of QVariants, representing a the contents of a single row in
* a QgsComposerTable
* \note Added in version 2.5
* \since QGIS 2.5
*/
typedef QList< QVariant > QgsComposerTableRow;
/** \ingroup core
* List of QgsComposerTableRows, representing rows and column cell contents
* for a QgsComposerTable
* \note Added in version 2.5
* \since QGIS 2.5
*/
typedef QList< QgsComposerTableRow > QgsComposerTableContents;
/** \ingroup core
* List of column definitions for a QgsComposerTable
* \note Added in version 2.5
* \since QGIS 2.5
*/
typedef QList<QgsComposerTableColumn *> QgsComposerTableColumns;
@ -50,7 +50,7 @@ typedef QList<QgsComposerTableColumn *> QgsComposerTableColumns;
/** \ingroup core
* \class QgsComposerTableStyle
* \brief Styling option for a composer table cell
* \note added in QGIS 2.12
* \since QGIS 2.12
*/
class CORE_EXPORT QgsComposerTableStyle
@ -86,7 +86,7 @@ class CORE_EXPORT QgsComposerTableStyle
/** A class to display a table in the print composer, and allow
* the table to span over multiple frames
* \ingroup core
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
{
@ -345,7 +345,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @see setGridStrokeWidth
* @see setGridColor
* @see setVerticalGrid
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setHorizontalGrid( const bool horizontalGrid );
@ -355,7 +355,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @see setGridStrokeWidth
* @see setGridColor
* @see setVerticalGrid
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
bool horizontalGrid() const { return mHorizontalGrid; }
@ -365,7 +365,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @see setGridStrokeWidth
* @see setGridColor
* @see setHorizontalGrid
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setVerticalGrid( const bool verticalGrid );
@ -375,7 +375,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @see setGridStrokeWidth
* @see setGridColor
* @see setHorizontalGrid
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
bool verticalGrid() const { return mVerticalGrid; }
@ -397,7 +397,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* automatically wrapped.
* @param behavior wrap behavior
* @see wrapBehavior
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setWrapBehavior( WrapBehavior behavior );
@ -405,7 +405,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* automatically wrapped.
* @returns current wrap behavior
* @see setWrapBehavior
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
WrapBehavior wrapBehavior() const { return mWrapBehavior; }
@ -426,14 +426,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @param group group to set style for
* @param style new cell style
* @see cellStyle()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setCellStyle( CellStyleGroup group, const QgsComposerTableStyle &style );
/** Returns the cell style for a cell group.
* @param group group to retrieve style for
* @see setCellStyle()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
const QgsComposerTableStyle *cellStyle( CellStyleGroup group ) const;
@ -550,7 +550,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
virtual bool calculateMaxColumnWidths();
/** Calculates the maximum height of text shown in rows.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
virtual bool calculateMaxRowHeights();
@ -577,7 +577,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* if the frame would include all table content rows and have space left for extra rows then setting this parameter
* to true would also include a count of these extra blank rows.
* @returns number of visible content rows (excluding header row)
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
int rowsVisible( double frameHeight, int firstRow, bool includeHeader, bool includeEmptyRows ) const;
@ -588,14 +588,14 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* if the frame would include all table content rows and have space left for extra rows then setting this parameter
* to true would also include a count of these extra blank rows.
* @returns number of visible content rows (excludes header rows)
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
int rowsVisible( int frameIndex, int firstRow, bool includeEmptyRows ) const;
/** Calculates a range of rows which should be visible in a given frame.
* @param frameIndex index number for frame
* @returns row range
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QPair<int, int> rowRange( const int frameIndex ) const;
@ -606,7 +606,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* table, then the default row height will be used for the remaining rows.
* @param drawHeaderLines set to true to include for the table header
* @see drawVerticalGridLines
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void drawHorizontalGridLines( QPainter *painter, int firstRow, int lastRow, bool drawHeaderLines ) const;
@ -623,7 +623,7 @@ class CORE_EXPORT QgsComposerTableV2: public QgsComposerMultiFrame
* @see drawVerticalGridLines
* @see calculateMaxColumnWidths
* @note not available in Python bindings
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void drawVerticalGridLines( QPainter *painter, const QMap<int, double> &maxWidthMap, int firstRow, int lastRow, bool hasHeader, bool mergeCells = false ) const;

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

@ -23,7 +23,7 @@
/** \ingroup core
* A text table item that reads text from string lists
* @note added in QGIS 2.10
* \since QGIS 2.10
*/
class CORE_EXPORT QgsComposerTextTableV2 : public QgsComposerTableV2
{

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

@ -143,14 +143,14 @@ class CORE_EXPORT QgsComposerUtils
* to workaround QT font rendering bugs
* @param font source font with size set in points
* @returns font with size set in pixels
* @note added in version 2.5
* \since QGIS 2.5
*/
static QFont scaledFontPixelSize( const QFont &font );
/** Calculate font ascent in millimeters, including workarounds for QT font rendering issues
* @param font input font
* @returns font ascent in millimeters
* @note added in version 2.5
* \since QGIS 2.5
* @see fontDescentMM
* @see fontHeightMM
* @see fontHeightCharacterMM
@ -161,7 +161,7 @@ class CORE_EXPORT QgsComposerUtils
/** Calculate font descent in millimeters, including workarounds for QT font rendering issues
* @param font input font
* @returns font descent in millimeters
* @note added in version 2.5
* \since QGIS 2.5
* @see fontAscentMM
* @see fontHeightMM
* @see fontHeightCharacterMM
@ -173,7 +173,7 @@ class CORE_EXPORT QgsComposerUtils
* The font height is the font ascent + descent + 1 (for the baseline).
* @param font input font
* @returns font height in millimeters
* @note added in version 2.5
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightCharacterMM
@ -186,7 +186,7 @@ class CORE_EXPORT QgsComposerUtils
* @param font input font
* @param character character to calculate height for
* @returns character height in millimeters
* @note added in version 2.5
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightMM
@ -199,7 +199,7 @@ class CORE_EXPORT QgsComposerUtils
* @param font input font
* @param text string to calculate width of
* @returns string width in millimeters
* @note added in version 2.5
* \since QGIS 2.5
* @see fontAscentMM
* @see fontDescentMM
* @see fontHeightMM
@ -215,7 +215,7 @@ class CORE_EXPORT QgsComposerUtils
* @param text string to calculate height of
* @param multiLineHeight line spacing factor
* @returns string height in millimeters
* @note added in version 2.12
* \since QGIS 2.12
* @see textWidthMM
*/
static double textHeightMM( const QFont &font, const QString &text, double multiLineHeight = 1.0 );
@ -227,7 +227,7 @@ class CORE_EXPORT QgsComposerUtils
* @param text string to draw
* @param font font to use for drawing text
* @param color color to draw text
* @note added in version 2.5
* \since QGIS 2.5
*/
static void drawText( QPainter *painter, QPointF pos, const QString &text, const QFont &font, const QColor &color = QColor() );
@ -241,7 +241,7 @@ class CORE_EXPORT QgsComposerUtils
* @param halignment optional horizontal alignment
* @param valignment optional vertical alignment
* @param flags allows for passing Qt::TextFlags to control appearance of rendered text
* @note added in version 2.5
* \since QGIS 2.5
*/
static void drawText( QPainter *painter, const QRectF &rect, const QString &text, const QFont &font, const QColor &color = QColor(), const Qt::AlignmentFlag halignment = Qt::AlignLeft, const Qt::AlignmentFlag valignment = Qt::AlignTop, const int flags = Qt::TextWordWrap );
@ -250,7 +250,7 @@ class CORE_EXPORT QgsComposerUtils
* This method returns a new QgsRenderContext which matches the scale and settings of the
* target map. If the \a dpi argument is not specified then the dpi will be taken from the destinatation
* painter device.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see createRenderContextForComposition()
*/
static QgsRenderContext createRenderContextForMap( QgsComposerMap *map, QPainter *painter, double dpi = -1 );
@ -259,7 +259,7 @@ class CORE_EXPORT QgsComposerUtils
* Creates a render context suitable for the specified \a composition and \a painter destination.
* This method returns a new QgsRenderContext which matches the scale and settings from the composition's
* QgsComposition::referenceMap().
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see createRenderContextForMap()
*/
static QgsRenderContext createRenderContextForComposition( QgsComposition *composition, QPainter *painter );

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

@ -125,21 +125,21 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* The project associated with the composition. Used to get access to layers, map themes,
* relations and various other bits. It is never null.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
QgsProject *project() const;
/**
* Returns the composition's name.
* @see setName()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
QString name() const { return mName; }
/**
* Sets the composition's name.
* @see name()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setName( const QString &name );
@ -177,7 +177,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param marginRight right margin (millimeters)
* @param marginBottom bottom margin (millimeters)
* @param marginLeft left margin (millimeters)
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see setResizeToContentsMargins()
* @see resizeToContentsMargins()
*/
@ -190,7 +190,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param marginRight right margin (millimeters)
* @param marginBottom bottom margin (millimeters)
* @param marginLeft left margin (millimeters)
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see resizePageToContents()
* @see resizeToContentsMargins()
*/
@ -203,7 +203,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param marginRight reference for right margin (millimeters)
* @param marginBottom reference for bottom margin (millimeters)
* @param marginLeft reference for left margin (millimeters)
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see resizePageToContents()
* @see setResizeToContentsMargins()
*/
@ -231,7 +231,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* paper item.
* @param page page number, starting with 1
* @returns true if page is empty
* @note added in QGIS 2.5
* \since QGIS 2.5
* @see numPages
* @see setNumPages
* @see shouldExportPage
@ -241,7 +241,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns whether a specified page number should be included in exports of the composition.
* @param page page number, starting with 1
* @returns true if page should be exported
* @note added in QGIS 2.5
* \since QGIS 2.5
* @see numPages
* @see pageIsEmpty
*/
@ -253,22 +253,22 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
QgsFillSymbol *pageStyleSymbol() { return mPageStyleSymbol; }
/** Returns the position within a page of a point in the composition
@note Added in QGIS 2.1
\since QGIS 2.1
*/
QPointF positionOnPage( QPointF position ) const;
/** Returns the page number corresponding to a point in the composition
@note Added in QGIS 2.1
\since QGIS 2.1
*/
int pageNumberForPoint( QPointF position ) const;
/** Sets the status bar message for the composer window
@note Added in QGIS 2.1
\since QGIS 2.1
*/
void setStatusMessage( const QString &message );
/** Refreshes the composition when composer related options change
@note added in version 2.1
\since QGIS 2.1
*/
void updateSettings();
@ -292,7 +292,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* them will prevent both display of the page boundaries in composer views and
* will also prevent them from being rendered in composition exports.
* @param visible set to true to show pages, false to hide pages
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see pagesVisible()
*/
void setPagesVisible( bool visible );
@ -300,7 +300,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Returns whether the page items are be visible in the composition. This setting
* effects both display of the page boundaries in composer views and
* whether they will be rendered in composition exports.
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see setPagesVisible()
*/
bool pagesVisible() const { return mPagesVisible; }
@ -327,7 +327,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* and the edges and centers of other items.
* @param snapTolerance snap tolerance in pixels
* @see alignmentSnapTolerance
* @note Added in QGIS 2.5
* \since QGIS 2.5
*/
void setSnapTolerance( const int snapTolerance ) { mSnapTolerance = snapTolerance; }
@ -335,21 +335,21 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* and the edges and centers of other items.
* @returns snap tolerance in pixels
* @see setAlignmentSnapTolerance
* @note Added in QGIS 2.5
* \since QGIS 2.5
*/
int snapTolerance() const { return mSnapTolerance; }
/** Sets whether selection bounding boxes should be shown in the composition
* @param boundsVisible set to true to show selection bounding box
* @see boundingBoxesVisible
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
void setBoundingBoxesVisible( const bool boundsVisible );
/** Returns whether selection bounding boxes should be shown in the composition
* @returns true if selection bounding boxes should be shown
* @see setBoundingBoxesVisible
* @note added in QGIS 2.7
* \since QGIS 2.7
*/
bool boundingBoxesVisible() const { return mBoundingBoxesVisible; }
@ -398,7 +398,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param itemList list of item type to store matching items in
* @param pageNumber page number (0 based)
* @note not available in Python bindings
* @note added in QGIS 2.5
* \since QGIS 2.5
*/
template<class T> void composerItemsOnPage( QList<T *> &itemList, const int pageNumber ) const;
@ -534,7 +534,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Creates a new group from a list of composer items and adds it to the composition.
* @param items items to include in group
* @returns QgsComposerItemGroup of grouped items, if grouping was possible
* @note added in QGIS 2.6
* \since QGIS 2.6
*/
QgsComposerItemGroup *groupItems( QList<QgsComposerItem *> items );
@ -543,7 +543,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param group item group to ungroup
* @returns list of items removed from the group, or an empty list if ungrouping
* was not successful
* @note added in QGIS 2.6
* \since QGIS 2.6
*/
QList<QgsComposerItem *> ungroupItems( QgsComposerItemGroup *group );
@ -678,7 +678,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param dpi optional dpi override, or 0 to use default composition print resolution. This
* parameter has no effect if imageSize is specified.
* @returns rendered image, or null image if image does not fit into available memory
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see printPageAsRaster()
* @see renderRect()
*/
@ -696,7 +696,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* to render sections of pages rather than full pages.
* @param p destination painter
* @param rect region of composition to render
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see renderPage()
* @see renderRectAsRaster()
*/
@ -709,7 +709,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param exportRegion set to a valid rectangle to indicate that only part of the composition was
* exported
* @param dpi set to DPI of exported file, or leave as -1 to use composition's DPI.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
void georeferenceOutput( const QString &file, QgsComposerMap *referenceMap = nullptr,
const QRectF &exportRegion = QRectF(), double dpi = -1 ) const;
@ -727,7 +727,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param d
* @param e
* @param f
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void computeWorldFileParameters( const QRectF &exportRegion, double &a, double &b, double &c, double &d, double &e, double &f ) const;
@ -748,7 +748,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Return pages in the correct order
* @note composerItems(QList< QgsPaperItem* > &) may not return pages in the correct order
* @note added in version 2.4
* \since QGIS 2.4
*/
QList< QgsPaperItem * > pages() { return mPages; }
@ -764,7 +764,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @see customProperty()
* @see removeCustomProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void setCustomProperty( const QString &key, const QVariant &value );
@ -775,7 +775,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @see setCustomProperty()
* @see removeCustomProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QVariant customProperty( const QString &key, const QVariant &defaultValue = QVariant() ) const;
@ -784,7 +784,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @see setCustomProperty()
* @see customProperty()
* @see customProperties()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
void removeCustomProperty( const QString &key );
@ -792,14 +792,14 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @see setCustomProperty()
* @see customProperty()
* @see removeCustomProperty()
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QStringList customProperties() const;
/** Returns the bounding box of the items contained on a specified page.
* @param pageNumber page number, where 0 is the first page
* @param visibleOnly set to true to only include visible items
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QRectF pageItemBounds( int pageNumber, bool visibleOnly = false ) const;
@ -814,25 +814,25 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
void sendItemAddedSignal( QgsComposerItem *item );
/** Updates the scene bounds of the composition
@note added in version 2.2*/
\since QGIS 2.2*/
void updateBounds();
/** Forces items in the composition to refresh. For instance, this causes maps to redraw
* and rebuild cached images, html items to reload their source url, and attribute tables
* to refresh their contents. Calling this also triggers a recalculation of all data defined
* attributes within the composition.
* @note added in version 2.3*/
* \since QGIS 2.3*/
void refreshItems();
/** Clears any selected items and sets an item as the current selection.
* @param item item to set as selected
* @note added in version 2.3*/
* \since QGIS 2.3*/
void setSelectedItem( QgsComposerItem *item );
/** Clears any selected items in the composition. Call this method rather than
* QGraphicsScene::clearSelection, as the latter does not correctly emit signals to allow
* the composition's model to update.
* @note added in version 2.5*/
* \since QGIS 2.5*/
void setAllDeselected();
/** Refreshes a data defined property for the composition by reevaluating the property's value
@ -847,25 +847,25 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/** Creates an expression context relating to the compositions's current state. The context includes
* scopes for global, project, composition and atlas properties.
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QgsExpressionContext createExpressionContext() const override;
/** Returns a reference to the composition's property collection, used for data defined overrides.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setDataDefinedProperties()
*/
QgsPropertyCollection &dataDefinedProperties() { return mDataDefinedProperties; }
/** Returns a reference to the composition's property collection, used for data defined overrides.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setDataDefinedProperties()
*/
const QgsPropertyCollection &dataDefinedProperties() const { return mDataDefinedProperties; }
/** Sets the composition's property collection, used for data defined overrides.
* @param collection property collection. Existing properties will be replaced.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see dataDefinedProperties()
*/
void setDataDefinedProperties( const QgsPropertyCollection &collection ) { mDataDefinedProperties = collection; }
@ -1001,7 +1001,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
* @param exportRegion set to a valid rectangle to indicate that only part of the composition is
* being exported
* @param dpi allows overriding the default composition DPI, or leave as -1 to use composition's DPI.
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
double *computeGeoTransform( const QgsComposerMap *referenceMap = nullptr, const QRectF &exportRegion = QRectF(), double dpi = -1 ) const;
@ -1014,7 +1014,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/**
* Emitted when the composition's name is changed.
* @note added in QGIS 3.0
* \since QGIS 3.0
* @see setName()
*/
void nameChanged( const QString &name );
@ -1030,7 +1030,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
/**
* Is emitted when a new composer item has been added to the composition.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void itemAdded( QgsComposerItem *item );
@ -1047,7 +1047,7 @@ class CORE_EXPORT QgsComposition : public QGraphicsScene, public QgsExpressionCo
void statusMsgChanged( const QString &message );
/** Emitted whenever the expression variables stored in the composition have been changed.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void variablesChanged();

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

@ -24,7 +24,7 @@ class QgsProject;
/** \ingroup core
* \class QgsLayoutManager
* \note added in QGIS 3.0
* \since QGIS 3.0
*
* \brief Manages storage of a set of compositions.
*

8
src/core/diagram/qgsdiagram.h
View File

@ -39,7 +39,7 @@ class CORE_EXPORT QgsDiagram
virtual ~QgsDiagram() { clearCache(); }
/** Returns an instance that is equivalent to this one
* @note added in 2.4 */
* \since QGIS 2.4 */
virtual QgsDiagram *clone() const = 0;
void clearCache();
@ -47,7 +47,7 @@ class CORE_EXPORT QgsDiagram
/** Returns a prepared expression for the specified context.
* @param expression expression string
* @param context expression context
* @note added in QGIS 2.12
* \since QGIS 2.12
*/
QgsExpression *getExpression( const QString &expression, const QgsExpressionContext &context );
@ -67,7 +67,7 @@ class CORE_EXPORT QgsDiagram
* @param value value to return legend item size for
* @param s diagram settings
* @param is interpolation settings
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
virtual double legendSize( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const = 0;
@ -112,7 +112,7 @@ class CORE_EXPORT QgsDiagram
* @param value value to calculate corresponding circular size for
* @param s diagram settings
* @param is interpolation settings
* @note added in QGIS 2.16
* \since QGIS 2.16
*/
QSizeF sizeForValue( double value, const QgsDiagramSettings &s, const QgsDiagramInterpolationSettings &is ) const;

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

@ -98,14 +98,14 @@ class CORE_EXPORT QgsDxfExport
/**
* Set destination CRS
* @see destinationCrs()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
/**
* Returns the destination CRS, or an invalid CRS if no reprojection will be done.
* @see setDestinationCrs()
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
QgsCoordinateReferenceSystem destinationCrs() const;
@ -200,7 +200,7 @@ class CORE_EXPORT QgsDxfExport
* @param code group code
* @param p point value
* @note available in Python bindings as writeGroupPointV2
* @note added in 2.15
* \since QGIS 2.15
*/
void writeGroup( int code, const QgsPointV2 &p );
@ -254,7 +254,7 @@ class CORE_EXPORT QgsDxfExport
* @param color color to use
* @param width line width to use
* @note not available in Python bindings
* @note added in 2.15
* \since QGIS 2.15
*/
void writePolyline( const QgsPointSequence &line, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );
@ -265,37 +265,37 @@ class CORE_EXPORT QgsDxfExport
* @param hatchPattern hatchPattern to use
* @param color color to use
* @note not available in Python bindings
* @note added in 2.15
* \since QGIS 2.15
*/
void writePolygon( const QgsRingSequence &polygon, const QString &layer, const QString &hatchPattern, const QColor &color );
//! Write line (as a polyline)
//! @note added in 2.15
//! \since QGIS 2.15
void writeLine( const QgsPointV2 &pt1, const QgsPointV2 &pt2, const QString &layer, const QString &lineStyleName, const QColor &color, double width = -1 );
//! Write point
//! @note available in Python bindings as writePointV2
//! @note added in 2.15
//! \since QGIS 2.15
void writePoint( const QString &layer, const QColor &color, const QgsPointV2 &pt );
//! Write filled circle (as hatch)
//! @note available in Python bindings as writePointV2
//! @note added in 2.15
//! \since QGIS 2.15
void writeFilledCircle( const QString &layer, const QColor &color, const QgsPointV2 &pt, double radius );
//! Write circle (as polyline)
//! @note available in Python bindings as writeCircleV2
//! @note added in 2.15
//! \since QGIS 2.15
void writeCircle( const QString &layer, const QColor &color, const QgsPointV2 &pt, double radius, const QString &lineStyleName, double width );
//! Write text (TEXT)
//! @note available in Python bindings as writeTextV2
//! @note added in 2.15
//! \since QGIS 2.15
void writeText( const QString &layer, const QString &text, const QgsPointV2 &pt, double size, double angle, const QColor &color );
//! Write mtext (MTEXT)
//! @note available in Python bindings as writeMTextV2
//! @note added in 2.15
//! \since QGIS 2.15
void writeMText( const QString &layer, const QString &text, const QgsPointV2 &pt, double width, double angle, const QColor &color );
//! Calculates a scaling factor to convert from map units to a specified symbol unit.

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

@ -27,7 +27,7 @@
* \brief A paint effect which blurs a source picture, using a number of different blur
* methods.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect

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

@ -28,7 +28,7 @@
* \brief A paint effect which alters the colors (e.g., brightness, contrast) in a
* source picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsColorEffect : public QgsPaintEffect

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

@ -36,7 +36,7 @@
* blurred picture will be drawn on the paint device, but the following drop shadow
* effect will be drawn using the original picture, not the blurred version.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsEffectStack : public QgsPaintEffect

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

@ -30,7 +30,7 @@
* \brief Base class for paint effect which draw a glow inside or outside a
* picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
@ -227,7 +227,7 @@ class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
* \class QgsOuterGlowEffect
* \brief A paint effect which draws a glow outside of a picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
@ -257,7 +257,7 @@ class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
* \class QgsInnerGlowEffect
* \brief A paint effect which draws a glow within a picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect

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

@ -38,7 +38,7 @@ class QgsColorRamp;
* Operations are written to either modify an image in place or return a new image, depending
* on which is faster for the particular operation.
*
* \note Added in version 2.7
* \since QGIS 2.7
*/
class CORE_EXPORT QgsImageOperation
{
@ -173,7 +173,7 @@ class CORE_EXPORT QgsImageOperation
* non-transparent region of the image is smaller than this minimum size,
* it will be centered in the returned rectangle.
* @param center return rectangle will be centered on the center of the original image if set to true
* @note added in QGIS 2.9
* \since QGIS 2.9
* @see cropTransparent
*/
static QRect nonTransparentImageRect( const QImage &image, QSize minSize = QSize(), bool center = false );
@ -184,7 +184,7 @@ class CORE_EXPORT QgsImageOperation
* cropped image is smaller than the minimum size, it will be centered
* in the returned image.
* @param center cropped image will be centered on the center of the original image if set to true
* @note added in QGIS 2.9
* \since QGIS 2.9
*/
static QImage cropTransparent( const QImage &image, QSize minSize = QSize(), bool center = false );

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

@ -45,7 +45,7 @@ class QgsRenderContext;
* and render the result to the render context's paint device.
*
* \see QgsPaintEffectRegistry
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffect
@ -251,7 +251,7 @@ class CORE_EXPORT QgsPaintEffect
* supported, however these changes will force the resultant output to be rasterized.
* If no alterations are performed then the original picture will be rendered as a vector.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
@ -313,7 +313,7 @@ class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
* \class QgsEffectPainter
* \brief A class to manager painter saving and restoring required for effect drawing
*
* \note Added in version 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsEffectPainter
{
@ -323,7 +323,7 @@ class CORE_EXPORT QgsEffectPainter
* QgsEffectPainter constructor
*
* @param renderContext the QgsRenderContext object
* @note Added in QGIS 3.0
* \since QGIS 3.0
*/
QgsEffectPainter( QgsRenderContext &renderContext );
@ -332,7 +332,7 @@ class CORE_EXPORT QgsEffectPainter
*
* @param renderContext the QgsRenderContext object
* @param effect the QgsPaintEffect object
* @note Added in QGIS 3.0
* \since QGIS 3.0
*/
QgsEffectPainter( QgsRenderContext &renderContext, QgsPaintEffect *effect );
~QgsEffectPainter();
@ -349,7 +349,7 @@ class CORE_EXPORT QgsEffectPainter
/**
* Access to the painter object
*
* @note Added in QGIS 3.0
* \since QGIS 3.0
*/
QPainter *operator->() { return mPainter; }
///@endcond

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

@ -32,7 +32,7 @@ class QgsPaintEffectWidget;
* In C++ you can use the QgsPaintEffectMetadata convenience class to
* simplify creation of the metadata.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffectAbstractMetadata
{
@ -83,7 +83,7 @@ typedef QgsPaintEffectWidget *( *QgsPaintEffectWidgetFunc )();
* \class QgsPaintEffectMetadata
* \brief Convenience metadata class that uses static functions to create an effect and its widget.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
{
@ -153,7 +153,7 @@ class CORE_EXPORT QgsPaintEffectMetadata : public QgsPaintEffectAbstractMetadata
* QgsPaintEffectRegistry is not usually directly created, but rather accessed through
* QgsApplication::paintEffectRegistry().
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffectRegistry
{
@ -211,7 +211,7 @@ class CORE_EXPORT QgsPaintEffectRegistry
/** Tests whether a paint effect matches the default effects stack.
* @param effect paint effect to test
* @returns true if effect is default stack
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see defaultStack()
*/
static bool isDefaultStack( QgsPaintEffect *effect );

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

@ -27,7 +27,7 @@
* \class QgsShadowEffect
* \brief Base class for paint effects which offset, blurred shadows
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
@ -184,7 +184,7 @@ class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
* \class QgsDropShadowEffect
* \brief A paint effect which draws an offset and optionally blurred drop shadow
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect
{
@ -213,7 +213,7 @@ class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect
* \brief A paint effect which draws an offset and optionally blurred drop shadow
* within a picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect
{

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

@ -29,7 +29,7 @@
* \brief A paint effect which applies transformations (such as move,
* scale and rotate) to a picture.
*
* \note Added in version 2.9
* \since QGIS 2.9
*/
class CORE_EXPORT QgsTransformEffect : public QgsPaintEffect

2
src/core/fieldformatter/qgsdatetimefieldformatter.h
View File

@ -25,7 +25,7 @@
* This represents a date, time or datetime value based on
* the field configuration.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsDateTimeFieldFormatter : public QgsFieldFormatter
{

2
src/core/fieldformatter/qgsfallbackfieldformatter.h
View File

@ -24,7 +24,7 @@
* A default fallback field formatter in case no specialized field formatter is defined.
* The values will be returned unmodified.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsFallbackFieldFormatter : public QgsFieldFormatter
{

2
src/core/fieldformatter/qgskeyvaluefieldformatter.h
View File

@ -28,7 +28,7 @@
*
* E.g. "color: yellow, amount: 5"
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsKeyValueFieldFormatter : public QgsFieldFormatter
{

2
src/core/fieldformatter/qgslistfieldformatter.h
View File

@ -25,7 +25,7 @@
* This represents a list type value.
* Values will be represented as a comma-separated list.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsListFieldFormatter : public QgsFieldFormatter
{

2
src/core/fieldformatter/qgsrelationreferencefieldformatter.h
View File

@ -25,7 +25,7 @@
* A value relation field formatter looks up the values from
* features on another layer.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsRelationReferenceFieldFormatter : public QgsFieldFormatter
{

2
src/core/fieldformatter/qgsvaluemapfieldformatter.h
View File

@ -34,7 +34,7 @@
* - 3 => "three"
* - 5 => "(5)"
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsValueMapFieldFormatter : public QgsFieldFormatter
{

4
src/core/fieldformatter/qgsvaluerelationfieldformatter.h
View File

@ -28,7 +28,7 @@
* A value relation field formatter looks up the values from
* features on another layer.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
class CORE_EXPORT QgsValueRelationFieldFormatter : public QgsFieldFormatter
{
@ -63,7 +63,7 @@ class CORE_EXPORT QgsValueRelationFieldFormatter : public QgsFieldFormatter
* This can be used to keep the value map in the local memory
* if doing multiple lookups in a loop.
*
* \note Added in QGIS 3.0
* \since QGIS 3.0
*/
static ValueRelationCache createCache( const QVariantMap &config );
};

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

@ -40,7 +40,7 @@ typedef QList< QgsRingSequence > QgsCoordinateSequence;
/** \ingroup core
* \class QgsAbstractGeometry
* \brief Abstract base class for all geometries
* \note added in QGIS 2.10
* \since QGIS 2.10
*/
class CORE_EXPORT QgsAbstractGeometry
{
@ -119,7 +119,7 @@ class CORE_EXPORT QgsAbstractGeometry
/** Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).
* For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.
* @returns boundary for geometry. May be null for some geometry types.
* @note added in QGIS 3.0
* \since QGIS 3.0
*/
virtual QgsAbstractGeometry *boundary() const = 0;
@ -143,7 +143,7 @@ class CORE_EXPORT QgsAbstractGeometry
* @see asGML2
* @see asGML3
* @see asJSON
* @note added in 3.0
* \since QGIS 3.0
*/
virtual QByteArray asWkb() const = 0;
@ -344,7 +344,7 @@ class CORE_EXPORT QgsAbstractGeometry
/** Adds a z-dimension to the geometry, initialized to a preset value.
* @param zValue initial z-value for all nodes
* @returns true on success
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see dropZValue()
* @see addMValue()
*/
@ -353,7 +353,7 @@ class CORE_EXPORT QgsAbstractGeometry
/** Adds a measure to the geometry, initialized to a preset value.
* @param mValue initial m-value for all nodes
* @returns true on success
* @note added in QGIS 2.12
* \since QGIS 2.12
* @see dropMValue()
* @see addZValue()
*/
@ -363,7 +363,7 @@ class CORE_EXPORT QgsAbstractGeometry
* @returns true if Z values were present and have been removed
* @see addZValue()
* @see dropMValue()
* @note added in QGIS 2.14
* \since QGIS 2.14
*/
virtual bool dropZValue() = 0;
@ -371,13 +371,13 @@ class CORE_EXPORT QgsAbstractGeometry
* @returns true if m-values were present and have been removed
* @see addMValue()
* @see dropZValue()
* @note added in QGIS 2.14
* \since QGIS 2.14
*/
virtual bool dropMValue() = 0;
/** Converts the geometry to a specified type.
* @returns true if conversion was successful
* @note added in QGIS 2.14
* \since QGIS 2.14
*/
virtual bool convertTo( QgsWkbTypes::Type type );
@ -403,7 +403,7 @@ class CORE_EXPORT QgsAbstractGeometry
/** \ingroup core
* \class QgsVertexId
* \brief Utility class for identifying a unique vertex within a geometry.
* \note added in QGIS 2.10
* \since QGIS 2.10
*/
struct CORE_EXPORT QgsVertexId
{

2
src/core/geometry/qgscircularstring.h
View File

@ -25,7 +25,7 @@
/** \ingroup core
* \class QgsCircularString
* \brief Circular string geometry type
* \note added in QGIS 2.10
* \since QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsCircularString: public QgsCurve

2
src/core/geometry/qgscompoundcurve.h
View File

@ -24,7 +24,7 @@
/** \ingroup core
* \class QgsCompoundCurve
* \brief Compound curve geometry type
* \note added in QGIS 2.10
* \since QGIS 2.10
* \note this API is not considered stable and may change for 2.12
*/
class CORE_EXPORT QgsCompoundCurve: public QgsCurve

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