Skip to content
Permalink
Browse files
Update sipify to use the "\since" tag
  • Loading branch information
m-kuhn committed Apr 2, 2017
1 parent 50ca79e commit beb185a72e00e5143fe8b049497d38da56022378
@@ -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,23 +145,23 @@ 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 );
%Docstring
Reads an XML definition from actionNode
into this object.

\since QGIS 3.0
.. versionadded:: 3.0
%End

void writeXml( QDomNode &actionsNode ) const;
%Docstring
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,23 +104,23 @@ 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 );
%Docstring
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 );
%Docstring
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,29 +50,29 @@ 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


int width() const;
%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
Loading

0 comments on commit beb185a

Please sign in to comment.