mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
83 lines
2.6 KiB
Plaintext
83 lines
2.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/validity/qgsvaliditycheckcontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
class QgsValidityCheckContext
|
|
{
|
|
%Docstring(signature="appended")
|
|
Base class for validity check contexts.
|
|
|
|
:py:class:`QgsAbstractValidityCheck` subclasses are passed a :py:class:`QgsValidityCheckContext` subclass which
|
|
encapsulates the context around that particular check type. For instance, a :py:class:`QgsAbstractValidityCheck`
|
|
of the :py:class:`QgsAbstractValidityCheck`.TypeLayoutCheck type will be passed a :py:class:`QgsLayoutValidityCheckContext`
|
|
context, containing a reference to the :py:class:`QgsLayout` to be checked.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsvaliditycheckcontext.h"
|
|
%End
|
|
%ConvertToSubClassCode
|
|
if ( dynamic_cast<QgsLayoutValidityCheckContext *>( sipCpp ) != NULL )
|
|
sipType = sipType_QgsLayoutValidityCheckContext;
|
|
else
|
|
sipType = 0;
|
|
%End
|
|
public:
|
|
|
|
enum ContextType
|
|
{
|
|
TypeLayoutContext,
|
|
TypeUserContext,
|
|
};
|
|
|
|
virtual int type() const = 0;
|
|
%Docstring
|
|
Returns the context type.
|
|
%End
|
|
|
|
virtual ~QgsValidityCheckContext();
|
|
|
|
};
|
|
|
|
class QgsLayoutValidityCheckContext : QgsValidityCheckContext
|
|
{
|
|
%Docstring(signature="appended")
|
|
Validity check context for print layout validation.
|
|
|
|
:py:class:`QgsLayoutValidityCheckContext` are passed to :py:class:`QgsAbstractValidityCheck` subclasses which
|
|
indicate they are of the :py:class:`QgsAbstractValidityCheck`.TypeLayoutCheck type.
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsvaliditycheckcontext.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutValidityCheckContext( QgsLayout *layout );
|
|
%Docstring
|
|
Constructor for QgsLayoutValidityCheckContext for the specified ``layout``.
|
|
%End
|
|
|
|
virtual int type() const;
|
|
|
|
QgsLayout *layout;
|
|
|
|
};
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/validity/qgsvaliditycheckcontext.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|