mirror of
				https://github.com/qgis/QGIS.git
				synced 2025-11-04 00:04:25 -05:00 
			
		
		
		
	
		
			
				
	
	
		
			84 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
			
		
		
	
	
			84 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			Plaintext
		
	
	
	
	
	
/************************************************************************
 | 
						|
 * This file has been generated automatically from                      *
 | 
						|
 *                                                                      *
 | 
						|
 * src/core/qgsoptionalexpression.h                                     *
 | 
						|
 *                                                                      *
 | 
						|
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 | 
						|
 ************************************************************************/
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
typedef QgsOptional<QgsExpression> QgsOptionalQgsExpressionBase;
 | 
						|
 | 
						|
class QgsOptionalExpression : QgsOptionalQgsExpressionBase
 | 
						|
{
 | 
						|
%Docstring(signature="appended")
 | 
						|
 | 
						|
An expression with an additional enabled flag.
 | 
						|
 | 
						|
This can be used for configuration options where an expression can be enabled
 | 
						|
or disabled but when disabled it shouldn't lose it's information for the case
 | 
						|
it gets re-enabled later on and a user shouldn't be force to redo the configuration.
 | 
						|
 | 
						|
.. versionadded:: 2.18
 | 
						|
%End
 | 
						|
 | 
						|
%TypeHeaderCode
 | 
						|
#include "qgsoptionalexpression.h"
 | 
						|
#include "qgsoptional.h"
 | 
						|
typedef QgsOptional<QgsExpression> QgsOptionalQgsExpressionBase;
 | 
						|
%End
 | 
						|
  public:
 | 
						|
 | 
						|
    QgsOptionalExpression();
 | 
						|
%Docstring
 | 
						|
Construct a default optional expression.
 | 
						|
It will be disabled and with an empty expression.
 | 
						|
%End
 | 
						|
 | 
						|
    QgsOptionalExpression( const QgsExpression &expression );
 | 
						|
%Docstring
 | 
						|
Construct an optional expression with the provided expression.
 | 
						|
It will be enabled.
 | 
						|
%End
 | 
						|
 | 
						|
    QgsOptionalExpression( const QgsExpression &expression, bool enabled );
 | 
						|
%Docstring
 | 
						|
Construct an optional expression with the provided expression and enabled state.
 | 
						|
%End
 | 
						|
 | 
						|
 | 
						|
    void writeXml( QDomElement &element );
 | 
						|
%Docstring
 | 
						|
Save the optional expression to the provided QDomElement.
 | 
						|
 | 
						|
The caller is responsible to pass an empty QDomElement and to append it to
 | 
						|
a parent element.
 | 
						|
 | 
						|
.. versionadded:: 2.18
 | 
						|
%End
 | 
						|
 | 
						|
    void readXml( const QDomElement &element );
 | 
						|
%Docstring
 | 
						|
Read the optional expression from the provided QDomElement.
 | 
						|
 | 
						|
.. versionadded:: 2.18
 | 
						|
%End
 | 
						|
};
 | 
						|
 | 
						|
 | 
						|
 | 
						|
 | 
						|
/************************************************************************
 | 
						|
 * This file has been generated automatically from                      *
 | 
						|
 *                                                                      *
 | 
						|
 * src/core/qgsoptionalexpression.h                                     *
 | 
						|
 *                                                                      *
 | 
						|
 * Do not edit manually ! Edit header and run scripts/sipify.pl again   *
 | 
						|
 ************************************************************************/
 |