-
-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
82 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/qgsdefaultvalue.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ | ||
|
||
|
||
|
||
|
||
class QgsDefaultValue | ||
{ | ||
%Docstring | ||
|
||
The QgsDefaultValue class provides a container for managing client | ||
side default values for fields. | ||
|
||
A QgsDefaultValue consists of an expression string that will be evaluated | ||
on the client when a defeault field value needs to be generated. | ||
|
||
Usual values for such an expression are | ||
|
||
- `now()` for a timestamp for a record | ||
- `@some_variable` to insert a project or application level variable like | ||
the username of the one digitizing a feature | ||
- `$length` to insert a derived attribute of a geometry | ||
|
||
QgsDefaultValue also has a `applyOnUpdate` flag which will indicate that a | ||
default value should also be applied when a feature is updated. If this is | ||
not set, the default value will only be used when a feature is created. | ||
|
||
.. versionadded:: 3.0 | ||
%End | ||
|
||
%TypeHeaderCode | ||
#include "qgsdefaultvalue.h" | ||
%End | ||
public: | ||
|
||
QgsDefaultValue( const QString &expression = QString(), bool applyOnUpdate = false ); | ||
%Docstring | ||
Create a new default value with the given ``expression`` and ``applyOnUpdate`` flag. | ||
%End | ||
bool operator==( const QgsDefaultValue &other ) const; | ||
|
||
QString expression() const; | ||
%Docstring | ||
The expression will be evaluated whenever a default value needs | ||
to be calculated for a field. | ||
:rtype: str | ||
%End | ||
|
||
void setExpression( const QString &expression ); | ||
%Docstring | ||
The expression will be evaluated whenever a default value needs | ||
to be calculated for a field. | ||
%End | ||
|
||
bool applyOnUpdate() const; | ||
%Docstring | ||
The applyOnUpdate flag determines if this expression should also be | ||
applied when a feature is updated or only when it's created. | ||
:rtype: bool | ||
%End | ||
|
||
void setApplyOnUpdate( bool applyOnUpdate ); | ||
%Docstring | ||
The applyOnUpdate flag determines if this expression should also be | ||
applied when a feature is updated or only when it's created. | ||
%End | ||
|
||
}; | ||
|
||
/************************************************************************ | ||
* This file has been generated automatically from * | ||
* * | ||
* src/core/qgsdefaultvalue.h * | ||
* * | ||
* Do not edit manually ! Edit header and run scripts/sipify.pl again * | ||
************************************************************************/ |