Skip to content
Permalink
Browse files
Update sip files
  • Loading branch information
nyalldawson committed Apr 3, 2017
1 parent 266f182 commit 9b3539ab07d52e1605cbb7f6f638ec0c728e2816
@@ -43,25 +43,25 @@ class QgsAnnotationManager : QObject
%Docstring
Adds an annotation to the manager. Ownership of the annotation is transferred to the manager.
Returns true if the addition was successful, or false if the annotation could not be added.
@see removeAnnotation()
@see annotationAdded()
\see removeAnnotation()
\see annotationAdded()
%End

bool removeAnnotation( QgsAnnotation *annotation );
%Docstring
Removes an annotation from the manager. The annotation is deleted.
Returns true if the removal was successful, or false if the removal failed (eg as a result
of removing an annotation which is not contained in the manager).
@see addAnnotation()
@see compositionRemoved()
@see compositionAboutToBeRemoved()
@see clear()
\see addAnnotation()
\see compositionRemoved()
\see compositionAboutToBeRemoved()
\see clear()
%End

void clear();
%Docstring
Removes and deletes all annotations from the manager.
@see removeAnnotation()
\see removeAnnotation()
%End

QList< QgsAnnotation * > annotations() const;
@@ -73,13 +73,13 @@ class QgsAnnotationManager : QObject
%Docstring
Reads the manager's state from a DOM element, restoring all annotations
present in the XML document.
@see writeXml()
\see writeXml()
%End

QDomElement writeXml( QDomDocument &doc ) const;
%Docstring
Returns a DOM element representing the state of the manager.
@see readXml()
\see readXml()
%End

signals:
@@ -32,13 +32,13 @@ class QgsHtmlAnnotation: QgsAnnotation
void setSourceFile( const QString &htmlFile );
%Docstring
Sets the file path for the source HTML file.
@see sourceFile()
\see sourceFile()
%End

QString sourceFile() const;
%Docstring
Returns the file path for the source HTML file.
@see setSourceFile()
\see setSourceFile()
%End

virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const;
@@ -33,13 +33,13 @@ class QgsSvgAnnotation: QgsAnnotation
void setFilePath( const QString &file );
%Docstring
Sets the file path for the source SVG file.
@see filePath()
\see filePath()
%End

QString filePath() const;
%Docstring
Returns the file path for the source SVG file.
@see setFilePath()
\see setFilePath()
%End

static QgsSvgAnnotation *create() /Factory/;
@@ -31,14 +31,14 @@ class QgsTextAnnotation: QgsAnnotation
%Docstring
Returns the text document which will be rendered
within the annotation.
@see setDocument()
\see setDocument()
%End

void setDocument( const QTextDocument *doc );
%Docstring
Sets the text document which will be rendered
within the annotation. Ownership is not transferred.
@see document()
\see document()
%End

virtual void writeXml( QDomElement &elem, QDomDocument &doc ) const;
@@ -31,7 +31,7 @@ class QgsProcessingFeedback : QgsFeedback
Sets a progress report text string. This can be used in conjunction with
setProgress() to provide detailed progress reports, such as "Transformed
4 of 5 layers".
@see setProgress()
\see setProgress()
%End

virtual void reportError( const QString &error );
@@ -45,37 +45,37 @@ class QgsProcessingFeedback : QgsFeedback
Pushes a general informational message from the algorithm. This can
be used to report feedback which is neither a status report or an
error, such as "Found 47 matching features".
@see pushCommandInfo()
@see pushDebugInfo()
@see pushConsoleInfo()
\see pushCommandInfo()
\see pushDebugInfo()
\see pushConsoleInfo()
%End

virtual void pushCommandInfo( const QString &info );
%Docstring
Pushes an informational message containing a command from the algorithm.
This is usually used to report commands which are executed in an external
application or as subprocesses.
@see pushInfo()
@see pushDebugInfo()
@see pushConsoleInfo()
\see pushInfo()
\see pushDebugInfo()
\see pushConsoleInfo()
%End

virtual void pushDebugInfo( const QString &info );
%Docstring
Pushes an informational message containing debugging helpers from
the algorithm.
@see pushInfo()
@see pushCommandInfo()
@see pushConsoleInfo()
\see pushInfo()
\see pushCommandInfo()
\see pushConsoleInfo()
%End

virtual void pushConsoleInfo( const QString &info );
%Docstring
Pushes a console feedback message from the algorithm. This is used to
report the output from executing an external command or subprocess.
@see pushInfo()
@see pushDebugInfo()
@see pushCommandInfo()
\see pushInfo()
\see pushDebugInfo()
\see pushCommandInfo()
%End

};
@@ -36,28 +36,28 @@ class QgsProcessingProvider
virtual QIcon icon() const;
%Docstring
Returns an icon for the provider.
@see svgIconPath()
\see svgIconPath()
%End

virtual QString svgIconPath() const;
%Docstring
Returns a path to an SVG version of the provider's icon.
@see icon()
\see icon()
%End

virtual QString id() const = 0;
%Docstring
Returns the unique provider id, used for identifying the provider. This string
should be a unique, short, character only string, eg "qgis" or "gdal". This
string should not be localised.
@see name()
\see name()
%End

virtual QString name() const = 0;
%Docstring
Returns the full provider name, which is used to describe the provider within the GUI.
This string should be localised.
@see id()
\see id()
%End

virtual bool canBeActivated() const;
@@ -45,21 +45,21 @@ class QgsProcessingRegistry : QObject
Add a processing provider to the registry. Ownership of the provider is transferred to the registry.
Returns false if the provider could not be added (eg if a provider with a duplicate ID already exists
in the registry).
@see removeProvider()
\see removeProvider()
%End

bool removeProvider( QgsProcessingProvider *provider );
%Docstring
Removes a provider implementation from the registry (the provider object is deleted).
Returns false if the provider could not be removed (eg provider does not exist in the registry).
@see addProvider()
\see addProvider()
%End

bool removeProvider( const QString &providerId );
%Docstring
Removes a provider implementation from the registry (the provider object is deleted).
Returns false if the provider could not be removed (eg provider does not exist in the registry).
@see addProvider()
\see addProvider()
%End

QgsProcessingProvider *providerById( const QString &id );
@@ -38,23 +38,23 @@ class QgsAction
%Docstring
Create a new QgsAction

@param type The type of this action
@param description A human readable description string
@param command The action text. Its interpretation depends on the type
@param capture If this is set to true, the output will be captured when an action is run
\param type The type of this action
\param description A human readable description string
\param command The action text. Its interpretation depends on the type
\param capture If this is set to true, the output will be captured when an action is run
%End

QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet<QString> &actionScopes = QSet<QString>() );
%Docstring
Create a new QgsAction

@param type The type of this action
@param description A human readable description string
@param action The action text. Its interpretation depends on the type
@param icon Path to an icon for this action
@param capture If this is set to true, the output will be captured when an action is run
@param shortTitle A short string used to label user interface elements like buttons
@param actionScopes A set of scopes in which this action will be available
\param type The type of this action
\param description A human readable description string
\param action The action text. Its interpretation depends on the type
\param icon Path to an icon for this action
\param capture If this is set to true, the output will be captured when an action is run
\param shortTitle A short string used to label user interface elements like buttons
\param actionScopes A set of scopes in which this action will be available
%End

QString name() const;
@@ -135,7 +135,7 @@ Checks if the action is runable on the current platform
Action scopes may offer additional variables like the clicked
coordinate.

@see QgsActionScope
\see QgsActionScope
.. versionadded:: 3.0
%End

@@ -67,9 +67,9 @@ Constructor
%Docstring
Does the action using the expression engine to replace any embedded expressions
in the action definition.
@param actionId action id
@param feature feature to run action for
@param context expression context to evaluate expressions under
\param actionId action id
\param feature feature to run action for
\param context expression context to evaluate expressions under
%End

void clearActions();
@@ -83,7 +83,7 @@ class QgsAnimatedIcon : QObject
to this signal directly.
Connecting to this signal directly will cause the animation not to be started.

@see connectFrameChanged
\see connectFrameChanged
%End

};
@@ -67,9 +67,9 @@ class QgsClipper
static QPolygonF clippedLine( const QgsCurve &curve, const QgsRectangle &clipExtent );
%Docstring
Takes a linestring and clips it to clipExtent
@param curve the linestring
@param clipExtent clipping bounds
@return clipped line coordinates
\param curve the linestring
\param clipExtent clipping bounds
\returns clipped line coordinates
%End

};
Loading

0 comments on commit 9b3539a

Please sign in to comment.