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

Update sip files

Browse Source
This commit is contained in:
Nyall Dawson 2017-04-03 11:59:45 +10:00
parent 266f182a26
commit 9b3539ab07
15 changed files with 511 additions and 513 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -43,8 +43,8 @@ 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 );
@ -52,16 +52,16 @@ class QgsAnnotationManager : QObject
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:

4
python/core/annotations/qgshtmlannotation.sip
View File

@ -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;

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

@ -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/;

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

@ -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;

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

@ -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,9 +45,9 @@ 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 );
@ -55,27 +55,27 @@ class QgsProcessingFeedback : QgsFeedback
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
};

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

@ -36,13 +36,13 @@ 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;
@ -50,14 +50,14 @@ class QgsProcessingProvider
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;

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

@ -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 );

24
python/core/qgsaction.sip
View File

@ -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

6
python/core/qgsactionmanager.sip
View File

@ -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();

2
python/core/qgsanimatedicon.sip
View File

@ -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
};

6
python/core/qgsclipper.sip
View File

@ -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
};

58
python/core/qgsconditionalstyle.sip
View File

@ -31,21 +31,21 @@ class QgsConditionalLayerStyles
%Docstring
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
\param styles The styles to assign to all the rows
.. versionadded:: 2.12
%End
void setFieldStyles( const QString &fieldName, const QList<QgsConditionalStyle> &styles );
%Docstring
Set the conditional styles for the field UI properties.
@param fieldName name of field
@param styles
\param fieldName name of field
\param styles
%End
QList<QgsConditionalStyle> fieldStyles( const QString &fieldName );
%Docstring
Returns the conditional styles set for the field UI properties
@return A list of conditional styles that have been set.
\returns A list of conditional styles that have been set.
%End
bool readXml( const QDomNode &node );
@ -79,122 +79,122 @@ class QgsConditionalStyle
bool matches( const QVariant &value, QgsExpressionContext &context ) const;
%Docstring
Check if the rule matches using the given value and feature
@param value The current value being checked. The "value" variable from the context is replaced with this value.
@param context Expression context for evaluating rule expression
@return True of the rule matches against the given feature
\param value The current value being checked. The "value" variable from the context is replaced with this value.
\param context Expression context for evaluating rule expression
\returns True of the rule matches against the given feature
%End
QPixmap renderPreview() const;
%Docstring
Render a preview icon of the rule.
@return QPixmap preview of the style
\returns QPixmap preview of the style
%End
void setName( const QString &value );
%Docstring
Set the name of the style. Names are optional but handy for display
@param value The name given to the style
\param value The name given to the style
%End
void setRule( const QString &value );
%Docstring
Set the rule for the style. Rules should be of QgsExpression syntax.
Special value of \@value is replaced at run time with the check value
@param value The QgsExpression style rule to use for this style
\param value The QgsExpression style rule to use for this style
%End
void setBackgroundColor( const QColor &value );
%Docstring
Set the background color for the style
@param value QColor for background color
\param value QColor for background color
%End
void setTextColor( const QColor &value );
%Docstring
Set the text color for the style
@param value QColor for text color
\param value QColor for text color
%End
void setFont( const QFont &value );
%Docstring
Set the font for the the style
@param value QFont to be used for text
\param value QFont to be used for text
%End
void setSymbol( QgsSymbol *value );
%Docstring
Set the icon for the style. Icons are generated from symbols
@param value QgsSymbol to be used when generating the icon
\param value QgsSymbol to be used when generating the icon
%End
QString displayText() const;
%Docstring
The name of the style.
@return The name of the style. Names are optional so might be empty.
\returns The name of the style. Names are optional so might be empty.
%End
QString name() const;
%Docstring
The name of the style.
@return The name of the style. Names are optional so might be empty.
\returns The name of the style. Names are optional so might be empty.
%End
QPixmap icon() const;
%Docstring
The icon set for style generated from the set symbol
@return A QPixmap that was set for the icon using the symbol
\returns A QPixmap that was set for the icon using the symbol
%End
QgsSymbol *symbol() const;
%Docstring
The symbol used to generate the icon for the style
@return The QgsSymbol used for the icon
\returns The QgsSymbol used for the icon
%End
QColor textColor() const;
%Docstring
The text color set for style
@return QColor for text color
\returns QColor for text color
%End
bool validTextColor() const;
%Docstring
Check if the text color is valid for render.
Valid colors are non invalid QColors and a color with a > 0 alpha
@return True of the color set for text is valid.
\returns True of the color set for text is valid.
%End
QColor backgroundColor() const;
%Docstring
The background color for style
@return QColor for background color
\returns QColor for background color
%End
bool validBackgroundColor() const;
%Docstring
Check if the background color is valid for render.
Valid colors are non invalid QColors and a color with a > 0 alpha
@return True of the color set for background is valid.
\returns True of the color set for background is valid.
%End
QFont font() const;
%Docstring
The font for the style
@return QFont for the style
\returns QFont for the style
%End
QString rule() const;
%Docstring
The condition rule set for the style. Rule may contain variable \@value
to represent the current value
@return QString of the current set rule
\returns QString of the current set rule
%End
bool isValid() const;
%Docstring
isValid Check if this rule is valid. A valid rule has one or more properties
set.
@return True if the rule is valid.
\returns True if the rule is valid.
%End
static QList<QgsConditionalStyle> matchingConditionalStyles( const QList<QgsConditionalStyle> &styles, const QVariant &value, QgsExpressionContext &context );
@ -202,7 +202,7 @@ class QgsConditionalStyle
Find and return the matching styles for the value and feature.
If no match is found a invalid QgsConditionalStyle is return.
@return A condtional style that matches the value and feature.
\returns A condtional style that matches the value and feature.
Check with QgsConditionalStyle::isValid()
%End
@ -211,7 +211,7 @@ class QgsConditionalStyle
Find and return the matching style for the value and feature.
If no match is found a invalid QgsConditionalStyle is return.
@return A condtional style that matches the value and feature.
\returns A condtional style that matches the value and feature.
Check with QgsConditionalStyle::isValid()
%End
@ -219,8 +219,8 @@ class QgsConditionalStyle
%Docstring
Compress a list of styles into a single style. This can be used to stack the elements of the
styles. The font of the last style is used in the output.
@param styles The list of styles to compress down
@return A single style generated from joining each style property.
\param styles The list of styles to compress down
\returns A single style generated from joining each style property.
%End
bool readXml( const QDomNode &node );

112
python/core/qgsfeature.sip
View File

@ -25,7 +25,6 @@ class QgsFeature
.. note::
QgsFeature objects are implicitly shared.
@author Gary E.Sherman
%End
%TypeHeaderCode
@ -142,14 +141,14 @@ class QgsFeature
QgsFeature( qint64 id = 0 );
%Docstring
Constructor for QgsFeature
@param id feature id
\param id feature id
%End
QgsFeature( const QgsFields &fields, qint64 id = 0 );
%Docstring
Constructor for QgsFeature
@param fields feature's fields
@param id feature id
\param fields feature's fields
\param id feature id
%End
QgsFeature( const QgsFeature &rhs );
@ -165,23 +164,22 @@ class QgsFeature
QgsFeatureId id() const;
%Docstring
Get the feature ID for this feature.
@returns feature ID
@see setId()
\returns feature ID
\see setId()
%End
void setId( QgsFeatureId id );
%Docstring
Sets the feature ID for this feature.
@param id feature id
@see id
\param id feature id
\see id
%End
QgsAttributes attributes() const;
%Docstring
Returns the feature's attributes.
@link attributes @endlink method.
@returns list of feature's attributes
@see setAttributes
\returns list of feature's attributes
\see setAttributes
.. versionadded:: 2.9
.. note::
@ -192,25 +190,25 @@ class QgsFeature
%Docstring
Sets the feature's attributes.
The feature will be valid after.
@param attrs attribute list
@see setAttribute
@see attributes
\param attrs attribute list
\see setAttribute
\see attributes
%End
bool setAttribute( int field, const QVariant &attr /GetWrapper/ );
%Docstring
Set an attribute's value by field index.
The feature will be valid if it was successful.
@param field the index of the field to set
@param attr the value of the attribute
@return false, if the field index does not exist
\param field the index of the field to set
\param attr the value of the attribute
\returns false, if the field index does not exist
.. note::
For Python: raises a KeyError exception instead of returning false
.. note::
Alternatively in Python: @code feature[field] = attr @endcode
@see setAttributes
\see setAttributes
%End
%MethodCode
bool rv;
@ -236,14 +234,14 @@ class QgsFeature
void initAttributes( int fieldCount );
%Docstring
Initialize this feature with the given number of fields. Discard any previously set attribute data.
@param fieldCount Number of fields to initialize
\param fieldCount Number of fields to initialize
%End
void deleteAttribute( int field );
%Docstring
Deletes an attribute and its value.
@param field the index of the field
@see setAttribute
\param field the index of the field
\see setAttribute
.. note::
For Python: raises a KeyError exception if the field is not found
@ -266,20 +264,20 @@ class QgsFeature
Returns the validity of this feature. This is normally set by
the provider to indicate some problem that makes the feature
invalid or to indicate a null feature.
@see setValid
\see setValid
%End
void setValid( bool validity );
%Docstring
Sets the validity of the feature.
@param validity set to true if feature is valid
@see isValid
\param validity set to true if feature is valid
\see isValid
%End
bool hasGeometry() const;
%Docstring
Returns true if the feature has an associated geometry.
@see geometry()
\see geometry()
.. versionadded:: 3.0.
%End
@ -287,58 +285,58 @@ class QgsFeature
%Docstring
Returns the geometry associated with this feature. If the feature has no geometry,
an empty QgsGeometry object will be returned.
@see hasGeometry()
@see setGeometry()
\see hasGeometry()
\see setGeometry()
%End
void setGeometry( const QgsGeometry &geometry );
%Docstring
Set the feature's geometry. The feature will be valid after.
@param geometry new feature geometry
@see geometry()
@see clearGeometry()
\param geometry new feature geometry
\see geometry()
\see clearGeometry()
%End
void clearGeometry();
%Docstring
Removes any geometry associated with the feature.
@see setGeometry()
@see hasGeometry()
\see setGeometry()
\see hasGeometry()
.. versionadded:: 3.0
%End
void setFields( const QgsFields &fields, bool initAttributes = true );
%Docstring
Assign a field map with the feature to allow attribute access by attribute name.
@param fields The attribute fields which this feature holds
@param initAttributes If true, attributes are initialized. Clears any data previously assigned.
\param fields The attribute fields which this feature holds
\param initAttributes If true, attributes are initialized. Clears any data previously assigned.
C++: Defaults to false
Python: Defaults to true
.. versionadded:: 2.9
@see fields
\see fields
%End
QgsFields fields() const;
%Docstring
Returns the field map associated with the feature.
@see setFields
\see setFields
%End
void setAttribute( const QString &name, const QVariant &value /GetWrapper/ );
%Docstring
Insert a value into attribute. Returns false if attribute name could not be converted to index.
Field map must be associated using @link setFields @endlink before this method can be used.
Field map must be associated using setFields() before this method can be used.
The feature will be valid if it was successful
@param name The name of the field to set
@param value The value to set
@return false if attribute name could not be converted to index (C++ only)
\param name The name of the field to set
\param value The value to set
\returns false if attribute name could not be converted to index (C++ only)
.. note::
For Python: raises a KeyError exception instead of returning false
.. note::
Alternatively in Python: @code feature[name] = attr @endcode
@see setFields
\see setFields
%End
%MethodCode
int fieldIdx = sipCpp->fieldNameIndex( *a0 );
@ -362,17 +360,17 @@ class QgsFeature
bool deleteAttribute( const QString &name );
%Docstring
Removes an attribute value by field name. Field map must be associated using @link setFields @endlink
Removes an attribute value by field name. Field map must be associated using setFields()
before this method can be used.
@param name The name of the field to delete
@return false if attribute name could not be converted to index (C++ only)
\param name The name of the field to delete
\returns false if attribute name could not be converted to index (C++ only)
.. note::
For Python: raises a KeyError exception instead of returning false
.. note::
Alternatively in Python: @code del feature[name] @endcode
@see setFields
\see setFields
%End
%MethodCode
int fieldIdx = sipCpp->fieldNameIndex( *a0 );
@ -391,17 +389,17 @@ class QgsFeature
SIP_PYOBJECT attribute( const QString &name ) const;
%Docstring
Lookup attribute value from attribute name. Field map must be associated using @link setFields @endlink
Lookup attribute value from attribute name. Field map must be associated using setFields()
before this method can be used.
@param name The name of the attribute to get
@return The value of the attribute (C++: Invalid variant if no such name exists )
\param name The name of the attribute to get
\returns The value of the attribute (C++: Invalid variant if no such name exists )
.. note::
For Python: raises a KeyError exception if the field is not found
.. note::
Alternatively in Python: @code feature[name] @endcode
@see setFields
\see setFields
%End
%MethodCode
int fieldIdx = sipCpp->fieldNameIndex( *a0 );
@ -419,17 +417,17 @@ class QgsFeature
SIP_PYOBJECT attribute( int fieldIdx ) const;
%Docstring
Lookup attribute value from its index. Field map must be associated using @link setFields @endlink
Lookup attribute value from its index. Field map must be associated using setFields()
before this method can be used.
@param fieldIdx The index of the attribute to get
@return The value of the attribute (C++: Invalid variant if no such index exists )
\param fieldIdx The index of the attribute to get
\returns The value of the attribute (C++: Invalid variant if no such index exists )
.. note::
For Python: raises a KeyError exception if the field is not found
.. note::
Alternatively in Python: @code feature[fieldIdx] @endcode
@see setFields
\see setFields
%End
%MethodCode
{
@ -448,11 +446,11 @@ class QgsFeature
int fieldNameIndex( const QString &fieldName ) const;
%Docstring
Utility method to get attribute index from name. Field map must be associated using @link setFields @endlink
Utility method to get attribute index from name. Field map must be associated using setFields()
before this method can be used.
@param fieldName name of field to get attribute index of
@returns -1 if field does not exist or field map is not associated.
@see setFields
\param fieldName name of field to get attribute index of
\returns -1 if field does not exist or field map is not associated.
\see setFields
%End
operator QVariant() const;

218
python/core/qgspropertytransformer.sip
View File

@ -43,28 +43,28 @@ class QgsCurveTransform
QList< QgsPoint > controlPoints() const;
%Docstring
Returns a list of the control points for the transform.
@see setControlPoints()
\see setControlPoints()
%End
void setControlPoints( const QList< QgsPoint > &points );
%Docstring
Sets the list of control points for the transform. Any existing
points are removed.
@see controlPoints()
\see controlPoints()
%End
void addControlPoint( double x, double y );
%Docstring
Adds a control point to the transform. Behavior is undefined if duplicate
x values exist in the control points list.
@see removeControlPoint()
\see removeControlPoint()
%End
void removeControlPoint( double x, double y );
%Docstring
Removes a control point from the transform. This will have no effect if a
matching control point does not exist.
@see addControlPoint()
\see addControlPoint()
%End
double y( double x ) const;
@ -82,17 +82,17 @@ class QgsCurveTransform
bool readXml( const QDomElement &elem, const QDomDocument &doc );
%Docstring
Reads the curve's state from an XML element.
@param elem source DOM element for transform's state
@param doc DOM document
@see writeXml()
\param elem source DOM element for transform's state
\param doc DOM document
\see writeXml()
%End
bool writeXml( QDomElement &transformElem, QDomDocument &doc ) const;
%Docstring
Writes the current state of the transform into an XML element
@param transformElem destination element for the transform's state
@param doc DOM document
@see readXml()
\param transformElem destination element for the transform's state
\param doc DOM document
\see readXml()
%End
QVariant toVariant() const;
@ -100,7 +100,7 @@ class QgsCurveTransform
Saves this curve transformer to a QVariantMap, wrapped in a QVariant.
You can use QgsXmlUtils::writeVariant to save it to an XML document.
@see loadVariant()
\see loadVariant()
%End
bool loadVariant( const QVariant &transformer );
@ -108,7 +108,7 @@ class QgsCurveTransform
Load this curve transformer from a QVariantMap, wrapped in a QVariant.
You can use QgsXmlUtils::writeVariant to load it from an XML document.
@see toVariant()
\see toVariant()
%End
};
@ -148,14 +148,14 @@ class QgsPropertyTransformer
static QgsPropertyTransformer *create( Type type ) /Factory/;
%Docstring
Factory method for creating a new property transformer of the specified type.
@param type transformer type to create
\param type transformer type to create
%End
QgsPropertyTransformer( double minValue = 0.0, double maxValue = 1.0 );
%Docstring
Constructor for QgsPropertyTransformer
@param minValue minimum expected value from source property
@param maxValue maximum expected value from source property
\param minValue minimum expected value from source property
\param maxValue maximum expected value from source property
%End
QgsPropertyTransformer( const QgsPropertyTransformer &other );
@ -181,7 +181,7 @@ class QgsPropertyTransformer
Loads this transformer from a QVariantMap, wrapped in a QVariant.
You can use QgsXmlUtils::writeVariant to save it to an XML document.
@see loadVariant()
\see loadVariant()
%End
virtual QVariant toVariant() const;
@ -189,44 +189,44 @@ class QgsPropertyTransformer
Saves this transformer to a QVariantMap, wrapped in a QVariant.
You can use QgsXmlUtils::writeVariant to save it to an XML document.
@see toVariant()
\see toVariant()
%End
double minValue() const;
%Docstring
Returns the minimum value expected by the transformer.
@see maxValue()
@see setMinValue()
\see maxValue()
\see setMinValue()
%End
void setMinValue( double min );
%Docstring
Sets the minimum value expected by the transformer.
@param min minimum value
@see setMaxValue()
@see minValue()
\param min minimum value
\see setMaxValue()
\see minValue()
%End
double maxValue() const;
%Docstring
Returns the maximum value expected by the transformer.
@see minValue()
@see setMaxValue()
\see minValue()
\see setMaxValue()
%End
void setMaxValue( double max );
%Docstring
Sets the maximum value expected by the transformer.
@param max maximum value
@see setMinValue()
@see maxValue()
\param max maximum value
\see setMinValue()
\see maxValue()
%End
QgsCurveTransform *curveTransform() const;
%Docstring
Returns the curve transform applied to input values before they are transformed
by the individual transform subclasses.
@see setCurveTransform()
\see setCurveTransform()
%End
void setCurveTransform( QgsCurveTransform *transform /Transfer/ );
@ -234,15 +234,15 @@ class QgsPropertyTransformer
Sets a curve transform to apply to input values before they are transformed
by the individual transform subclasses. Ownership of \a transform is transferred
to the property transformer.
@see curveTransform()
\see curveTransform()
%End
virtual QVariant transform( const QgsExpressionContext &context, const QVariant &value ) const = 0;
%Docstring
Calculates the transform of a value. Derived classes must implement this to perform their transformations
on input values
@param context expression context
@param value input value to transform
\param context expression context
\param value input value to transform
%End
virtual QString toExpression( const QString &baseExpression ) const = 0;
@ -254,14 +254,14 @@ class QgsPropertyTransformer
static QgsPropertyTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/;
%Docstring
Attempts to parse an expression into a corresponding property transformer.
@param expression expression to parse
@param baseExpression will be set to the component of the source expression which
\param expression expression to parse
\param baseExpression will be set to the component of the source expression which
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
@param fieldName will be set to a field name which is used to calculate the input
\param fieldName will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.
@returns corresponding property transformer, or nullptr if expression could not
\returns corresponding property transformer, or nullptr if expression could not
be parsed to a transformer.
%End
@ -292,12 +292,12 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer
double exponent = 1.0 );
%Docstring
Constructor for QgsGenericNumericTransformer.
@param minValue minimum expected input value
@param maxValue maximum expected input value
@param minOutput minimum value to return
@param maxOutput maximum value to return
@param nullOutput value to return for null inputs
@param exponent optional exponential for non-linear scaling
\param minValue minimum expected input value
\param maxValue maximum expected input value
\param minOutput minimum value to return
\param maxOutput maximum value to return
\param nullOutput value to return for null inputs
\param exponent optional exponential for non-linear scaling
%End
QgsGenericNumericTransformer( const QgsGenericNumericTransformer &other );
@ -316,77 +316,77 @@ class QgsGenericNumericTransformer : QgsPropertyTransformer
static QgsGenericNumericTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/;
%Docstring
Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.
@param expression expression to parse
@param baseExpression will be set to the component of the source expression which
\param expression expression to parse
\param baseExpression will be set to the component of the source expression which
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
@param fieldName will be set to a field name which is used to calculate the input
\param fieldName will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.
@returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not
\returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not
be parsed to a size scale transformer.
%End
double value( double input ) const;
%Docstring
Calculates the size corresponding to a specific \a input value.
@returns calculated size using size scale transformer's parameters and type
\returns calculated size using size scale transformer's parameters and type
%End
double minOutputValue() const;
%Docstring
Returns the minimum calculated size.
@see setMinSize()
@see maxSize()
\see setMinSize()
\see maxSize()
%End
void setMinOutputValue( double size );
%Docstring
Sets the minimum calculated size.
@param size minimum size
@see minSize()
@see setMaxSize()
\param size minimum size
\see minSize()
\see setMaxSize()
%End
double maxOutputValue() const;
%Docstring
Returns the maximum calculated size.
@see minSize()
\see minSize()
%End
void setMaxOutputValue( double size );
%Docstring
Sets the maximum calculated size.
@param size maximum size
@see maxSize()
@see setMinSize()
\param size maximum size
\see maxSize()
\see setMinSize()
%End
double nullOutputValue() const;
%Docstring
Returns the size value when an expression evaluates to NULL.
@see setNullSize()
\see setNullSize()
%End
void setNullOutputValue( double size );
%Docstring
Sets the size value for when an expression evaluates to NULL.
@param size null size
@see nullSize()
\param size null size
\see nullSize()
%End
double exponent() const;
%Docstring
Returns the exponent for an exponential expression.
@see setExponent()
@see type()
\see setExponent()
\see type()
%End
void setExponent( double exponent );
%Docstring
Sets the exponent for an exponential expression.
@param exponent exponent
@see exponent()
\param exponent exponent
\see exponent()
%End
};
@ -417,13 +417,13 @@ class QgsSizeScaleTransformer : QgsPropertyTransformer
double exponent = 1.0 );
%Docstring
Constructor for QgsSizeScaleTransformer.
@param type scaling type
@param minValue minimum expected value
@param maxValue maximum expected value
@param minSize minimum size to return
@param maxSize maximum size to return
@param nullSize size to return for null values
@param exponent exponent for Exponential scaling method
\param type scaling type
\param minValue minimum expected value
\param maxValue maximum expected value
\param minSize minimum size to return
\param maxSize maximum size to return
\param nullSize size to return for null values
\param exponent exponent for Exponential scaling method
%End
QgsSizeScaleTransformer( const QgsSizeScaleTransformer &other );
@ -442,93 +442,93 @@ class QgsSizeScaleTransformer : QgsPropertyTransformer
static QgsSizeScaleTransformer *fromExpression( const QString &expression, QString &baseExpression /Out/, QString &fieldName /Out/ ) /Factory/;
%Docstring
Attempts to parse an expression into a corresponding QgsSizeScaleTransformer.
@param expression expression to parse
@param baseExpression will be set to the component of the source expression which
\param expression expression to parse
\param baseExpression will be set to the component of the source expression which
is used to calculate the input to the property transformer. This will be set to an
empty string if a field reference is the transformer input.
@param fieldName will be set to a field name which is used to calculate the input
\param fieldName will be set to a field name which is used to calculate the input
to the property transformer. This will be set to an
empty string if an expression is the transformer input.
@returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not
\returns corresponding QgsSizeScaleTransformer, or nullptr if expression could not
be parsed to a size scale transformer.
%End
double size( double value ) const;
%Docstring
Calculates the size corresponding to a specific value.
@param value value to calculate size for
@returns calculated size using size scale transformer's parameters and type
\param value value to calculate size for
\returns calculated size using size scale transformer's parameters and type
%End
double minSize() const;
%Docstring
Returns the minimum calculated size.
@see setMinSize()
@see maxSize()
\see setMinSize()
\see maxSize()
%End
void setMinSize( double size );
%Docstring
Sets the minimum calculated size.
@param size minimum size
@see minSize()
@see setMaxSize()
\param size minimum size
\see minSize()
\see setMaxSize()
%End
double maxSize() const;
%Docstring
Returns the maximum calculated size.
@see minSize()
\see minSize()
%End
void setMaxSize( double size );
%Docstring
Sets the maximum calculated size.
@param size maximum size
@see maxSize()
@see setMinSize()
\param size maximum size
\see maxSize()
\see setMinSize()
%End
double nullSize() const;
%Docstring
Returns the size value when an expression evaluates to NULL.
@see setNullSize()
\see setNullSize()
%End
void setNullSize( double size );
%Docstring
Sets the size value for when an expression evaluates to NULL.
@param size null size
@see nullSize()
\param size null size
\see nullSize()
%End
double exponent() const;
%Docstring
Returns the exponent for an exponential expression.
@see setExponent()
@see type()
\see setExponent()
\see type()
%End
void setExponent( double exponent );
%Docstring
Sets the exponent for an exponential expression.
@param exponent exponent
@see exponent()
\param exponent exponent
\see exponent()
%End
ScaleType type() const;
%Docstring
Returns the size transformer's scaling type (the method used to calculate
the size from a value).
@see setType()
\see setType()
%End
void setType( ScaleType type );
%Docstring
Sets the size transformer's scaling type (the method used to calculate
the size from a value).
@param type scale type
@see type()
\param type scale type
\see type()
%End
};
@ -548,10 +548,10 @@ class QgsColorRampTransformer : QgsPropertyTransformer
const QColor &nullColor = QColor( 0, 0, 0, 0 ) );
%Docstring
Constructor for QgsColorRampTransformer.
@param minValue minimum expected value
@param maxValue maximum expected value
@param ramp source color ramp. Ownership is transferred to the transformer.
@param nullColor color to return for null values
\param minValue minimum expected value
\param maxValue maximum expected value
\param ramp source color ramp. Ownership is transferred to the transformer.
\param nullColor color to return for null values
%End
QgsColorRampTransformer( const QgsColorRampTransformer &other );
@ -571,41 +571,41 @@ Copy constructor
QColor color( double value ) const;
%Docstring
Calculates the color corresponding to a specific value.
@param value value to calculate color for
@returns calculated color using transformer's parameters and type
\param value value to calculate color for
\returns calculated color using transformer's parameters and type
%End
QgsColorRamp *colorRamp() const;
%Docstring
Returns the color ramp used for calculating property colors.
@returns color ramp
@see setColorRamp()
\returns color ramp
\see setColorRamp()
%End
void setColorRamp( QgsColorRamp *ramp /Transfer/ );
%Docstring
Sets the color ramp to use for calculating property colors.
@param ramp color ramp, ownership of ramp is transferred to the transformer.
@see colorRamp()
\param ramp color ramp, ownership of ramp is transferred to the transformer.
\see colorRamp()
%End
QColor nullColor() const;
%Docstring
Returns the color corresponding to a null value.
@see setNullColor()
\see setNullColor()
%End
void setNullColor( const QColor &color );
%Docstring
Sets the color corresponding to a null value.
@param color null color
@see nullSize()
\param color null color
\see nullSize()
%End
QString rampName() const;
%Docstring
Returns the color ramp's name.
@see setRampName()
\see setRampName()
%End
void setRampName( const QString &name );
@ -613,7 +613,7 @@ Copy constructor
Sets the color ramp's \a name. The ramp name must be set to match
a color ramp available in the style database for conversion to expression
to work correctly.
@see rampName()
\see rampName()
%End
};

528
python/core/qgsvectorlayer.sip
View File

File diff suppressed because it is too large Load Diff