mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-26 00:02:08 -05:00
112 lines
3.1 KiB
Plaintext
112 lines
3.1 KiB
Plaintext
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/layout/qgslayoutcontext.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
class QgsLayoutContext
|
||
|
|
{
|
||
|
|
%Docstring
|
||
|
|
Stores information relating to the current context and rendering settings for a layout.
|
||
|
|
.. versionadded:: 3.0
|
||
|
|
%End
|
||
|
|
|
||
|
|
%TypeHeaderCode
|
||
|
|
#include "qgslayoutcontext.h"
|
||
|
|
%End
|
||
|
|
public:
|
||
|
|
|
||
|
|
enum Flag
|
||
|
|
{
|
||
|
|
FlagDebug,
|
||
|
|
FlagOutlineOnly,
|
||
|
|
FlagAntialiasing,
|
||
|
|
FlagUseAdvancedEffects,
|
||
|
|
};
|
||
|
|
typedef QFlags<QgsLayoutContext::Flag> Flags;
|
||
|
|
|
||
|
|
|
||
|
|
QgsLayoutContext();
|
||
|
|
|
||
|
|
void setFlags( const QgsLayoutContext::Flags flags );
|
||
|
|
%Docstring
|
||
|
|
Sets the combination of ``flags`` that will be used for rendering the layout.
|
||
|
|
.. seealso:: setFlag()
|
||
|
|
.. seealso:: flags()
|
||
|
|
.. seealso:: testFlag()
|
||
|
|
%End
|
||
|
|
|
||
|
|
void setFlag( const QgsLayoutContext::Flag flag, const bool on = true );
|
||
|
|
%Docstring
|
||
|
|
Enables or disables a particular rendering ``flag`` for the layout. Other existing
|
||
|
|
flags are not affected.
|
||
|
|
.. seealso:: setFlags()
|
||
|
|
.. seealso:: flags()
|
||
|
|
.. seealso:: testFlag()
|
||
|
|
%End
|
||
|
|
|
||
|
|
QgsLayoutContext::Flags flags() const;
|
||
|
|
%Docstring
|
||
|
|
Returns the current combination of flags used for rendering the layout.
|
||
|
|
.. seealso:: setFlags()
|
||
|
|
.. seealso:: setFlag()
|
||
|
|
.. seealso:: testFlag()
|
||
|
|
:rtype: QgsLayoutContext.Flags
|
||
|
|
%End
|
||
|
|
|
||
|
|
bool testFlag( const Flag flag ) const;
|
||
|
|
%Docstring
|
||
|
|
Check whether a particular rendering ``flag`` is enabled for the layout.
|
||
|
|
.. seealso:: setFlags()
|
||
|
|
.. seealso:: setFlag()
|
||
|
|
.. seealso:: flags()
|
||
|
|
:rtype: bool
|
||
|
|
%End
|
||
|
|
|
||
|
|
void setFeature( const QgsFeature &feature );
|
||
|
|
%Docstring
|
||
|
|
Sets the current ``feature`` for evaluating the layout. This feature may
|
||
|
|
be used for altering an item's content and appearance for a report
|
||
|
|
or atlas layout.
|
||
|
|
.. seealso:: feature()
|
||
|
|
%End
|
||
|
|
|
||
|
|
QgsFeature feature() const;
|
||
|
|
%Docstring
|
||
|
|
Returns the current feature for evaluating the layout. This feature may
|
||
|
|
be used for altering an item's content and appearance for a report
|
||
|
|
or atlas layout.
|
||
|
|
.. seealso:: setFeature()
|
||
|
|
:rtype: QgsFeature
|
||
|
|
%End
|
||
|
|
|
||
|
|
QgsVectorLayer *layer() const;
|
||
|
|
%Docstring
|
||
|
|
Returns the vector layer associated with the layout's context.
|
||
|
|
.. seealso:: setLayer()
|
||
|
|
:rtype: QgsVectorLayer
|
||
|
|
%End
|
||
|
|
|
||
|
|
void setLayer( QgsVectorLayer *layer );
|
||
|
|
%Docstring
|
||
|
|
Sets the vector ``layer`` associated with the layout's context.
|
||
|
|
.. seealso:: layer()
|
||
|
|
%End
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
/************************************************************************
|
||
|
|
* This file has been generated automatically from *
|
||
|
|
* *
|
||
|
|
* src/core/layout/qgslayoutcontext.h *
|
||
|
|
* *
|
||
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
||
|
|
************************************************************************/
|