mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-25 00:58:06 -05:00
Update sipify to use the "\since" tag
This commit is contained in:
parent
50ca79ef43
commit
beb185a72e
@ -13,7 +13,7 @@
|
||||
class QgsAnnotationManager : QObject
|
||||
{
|
||||
%Docstring
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
|
||||
Manages storage of a set of QgsAnnotation annotation objects.
|
||||
|
||||
|
@ -13,7 +13,7 @@ class QgsSvgAnnotation: QgsAnnotation
|
||||
{
|
||||
%Docstring
|
||||
An annotation which renders the contents of an SVG file.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -13,7 +13,7 @@ class QgsTextAnnotation: QgsAnnotation
|
||||
{
|
||||
%Docstring
|
||||
An annotation item that displays formatted text from a QTextDocument document.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -17,7 +17,7 @@ class QgsProcessingRegistry : QObject
|
||||
|
||||
QgsProcessingRegistry is not usually directly created, but rather accessed through
|
||||
QgsApplication::processingRegistry().
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -71,14 +71,14 @@ The short title is used to label user interface elements like buttons
|
||||
%Docstring
|
||||
Returns a unique id for this action.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
bool isValid() const;
|
||||
%Docstring
|
||||
Returns true if this action was a default constructed one.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QString iconPath() const;
|
||||
@ -97,7 +97,7 @@ The icon
|
||||
How the content is interpreted depends on the type() and
|
||||
the actionScope().
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
ActionType type() const;
|
||||
@ -119,14 +119,14 @@ Checks if the action is runable on the current platform
|
||||
%Docstring
|
||||
Run this action.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void run( const QgsExpressionContext &expressionContext ) const;
|
||||
%Docstring
|
||||
Run this action.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QSet<QString> actionScopes() const;
|
||||
@ -136,7 +136,7 @@ Checks if the action is runable on the current platform
|
||||
coordinate.
|
||||
|
||||
@see QgsActionScope
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
@ -51,7 +51,7 @@ Constructor
|
||||
%Docstring
|
||||
Remove an action by its id.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) /PyName=doActionFeature/;
|
||||
@ -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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsVectorLayer *layer() const;
|
||||
@ -104,7 +104,7 @@ Reads the actions in in XML format
|
||||
%Docstring
|
||||
Get an action by its id.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
@ -29,7 +29,7 @@ class QgsActionScope
|
||||
<dd>Show in attribute table and work on the layer or selection.</dd>
|
||||
</dl>
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -41,7 +41,7 @@ class QgsActionScope
|
||||
%Docstring
|
||||
Creates a new invalid action scope.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
|
||||
@ -74,7 +74,7 @@ class QgsActionScope
|
||||
%Docstring
|
||||
A unique identifier for this action scope.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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().
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
void setDescription( const QString &description );
|
||||
%Docstring
|
||||
@ -111,7 +111,7 @@ class QgsActionScope
|
||||
%Docstring
|
||||
Returns if this scope is valid.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
@ -21,7 +21,7 @@ class QgsActionScopeRegistry : QObject
|
||||
QgsApplication::actionScopeRegistry()
|
||||
```
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
@ -37,35 +37,35 @@ class QgsActionScopeRegistry : QObject
|
||||
want to use QgsApplication::actionScopeRegistry() to get access
|
||||
to that one instead.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QSet<QgsActionScope> actionScopes() const;
|
||||
%Docstring
|
||||
Get all registered action scopes.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void registerActionScope( const QgsActionScope &actionScope );
|
||||
%Docstring
|
||||
Register an additional action scope.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void unregisterActionScope( const QgsActionScope &actionScope );
|
||||
%Docstring
|
||||
Unregister an additional action scope.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
QgsActionScope actionScope( const QString &id );
|
||||
%Docstring
|
||||
Get an action scope by its id.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
};
|
||||
|
@ -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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
@ -65,14 +65,14 @@ class QgsAnimatedIcon : QObject
|
||||
%Docstring
|
||||
The native width of the icon.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
int height() const;
|
||||
%Docstring
|
||||
The native height of the icon.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
signals:
|
||||
|
@ -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
|
||||
\since QGIS 2.12
|
||||
.. versionadded:: 2.12
|
||||
%End
|
||||
|
||||
void setFieldStyles( const QString &fieldName, const QList<QgsConditionalStyle> &styles );
|
||||
|
@ -182,7 +182,7 @@ class QgsFeature
|
||||
@link attributes @endlink method.
|
||||
@returns list of feature's attributes
|
||||
@see setAttributes
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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()
|
||||
\since QGIS 3.0.
|
||||
.. versionadded:: 3.0.
|
||||
%End
|
||||
|
||||
QgsGeometry geometry() const;
|
||||
@ -304,7 +304,7 @@ class QgsFeature
|
||||
Removes any geometry associated with the feature.
|
||||
@see setGeometry()
|
||||
@see hasGeometry()
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 2.9
|
||||
@see fields
|
||||
%End
|
||||
|
||||
|
@ -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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -36,7 +36,7 @@ class QgsSettings : QObject
|
||||
- Misc
|
||||
- Auth
|
||||
|
||||
\since QGIS 3
|
||||
.. versionadded:: 3
|
||||
%End
|
||||
|
||||
%TypeHeaderCode
|
||||
|
@ -414,7 +414,7 @@ Setup the coordinate system transformation for the layer
|
||||
QgsVectorLayerJoinBuffer *joinBuffer();
|
||||
%Docstring
|
||||
Accessor to the join buffer object
|
||||
\since QGIS 2.14.7
|
||||
.. versionadded:: 2.14.7
|
||||
%End
|
||||
const QList<QgsVectorLayerJoinInfo> vectorJoins() const;
|
||||
|
||||
@ -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
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 2.6
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 2.16
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 2.16
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.10
|
||||
.. versionadded:: 2.10
|
||||
%End
|
||||
|
||||
bool countSymbolFeatures( bool showProgress = true );
|
||||
@ -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
|
||||
\since QGIS 2.14
|
||||
.. versionadded:: 2.14
|
||||
%End
|
||||
|
||||
bool deleteSelectedFeatures( int *deletedCount = 0 );
|
||||
@ -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
|
||||
\since QGIS 2.4
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void removeFieldAlias( int index );
|
||||
%Docstring
|
||||
Removes an alias (a display name) for attributes to display in dialogs
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.16
|
||||
.. versionadded:: 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
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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`.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.16
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.9
|
||||
.. versionadded:: 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
|
||||
\since QGIS 2.2
|
||||
.. versionadded:: 2.2
|
||||
%End
|
||||
|
||||
const QgsVectorSimplifyMethod &simplifyMethod() const;
|
||||
%Docstring
|
||||
Returns the simplification settings for fast rendering of features
|
||||
\since QGIS 2.2
|
||||
.. versionadded:: 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!
|
||||
\since QGIS 2.2
|
||||
.. versionadded:: 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.
|
||||
\since QGIS 2.12
|
||||
.. versionadded:: 2.12
|
||||
%End
|
||||
|
||||
QgsAttributeTableConfig attributeTableConfig() const;
|
||||
@ -1565,7 +1565,7 @@ Returns the current transparency for the vector layer
|
||||
|
||||
It may also contain embedded expressions.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 2.14
|
||||
.. versionadded:: 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
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
public slots:
|
||||
@ -1889,14 +1889,14 @@ Signal emitted when setLayerTransparency() is called
|
||||
%Docstring
|
||||
Emitted when the map tip changes
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
void displayExpressionChanged();
|
||||
%Docstring
|
||||
Emitted when the display expression changes
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 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.
|
||||
|
||||
\since QGIS 3.0
|
||||
.. versionadded:: 3.0
|
||||
%End
|
||||
|
||||
|
||||
|
@ -12,7 +12,7 @@ sub processDoxygenLine
|
||||
if ( $_[0] =~ m/[\\@](ingroup|class)/ ) {
|
||||
return ""
|
||||
}
|
||||
if ( $_[0] =~ m/[\\@]note added .*?([\d\.]+)/i ) {
|
||||
if ( $_[0] =~ m/\\since .*?([\d\.]+)/i ) {
|
||||
return ".. versionadded:: $1\n";
|
||||
}
|
||||
if ( $_[0] =~ m/[\\@]note (.*)/ ) {
|
||||
|
Loading…
x
Reference in New Issue
Block a user