mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-03 00:05:24 -04:00
b992e871ee
when exporting to PDF If an individual layout item needs rasterisation in order to be exported correctly, it can now be individually rasterised without forcing every other item to also be rasterised. This allows exports to PDF keeping as much as possible as vectors, e.g. a map with layer opacity won't force labels, scalebars, etc to be rasterised too. To accompany this, a new "Always export as vectors" checkbox was added to layout properties. If checked, this will force the export to keep items as vectors, even when it causes the output to look different to layouts. Fixes #7885
238 lines
6.3 KiB
Plaintext
238 lines
6.3 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 : QObject
|
|
{
|
|
%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,
|
|
FlagForceVectorOutput,
|
|
};
|
|
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:: :py:func:`setFlag()`
|
|
|
|
.. seealso:: :py:func:`flags()`
|
|
|
|
.. seealso:: :py:func:`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:: :py:func:`setFlags()`
|
|
|
|
.. seealso:: :py:func:`flags()`
|
|
|
|
.. seealso:: :py:func:`testFlag()`
|
|
%End
|
|
|
|
QgsLayoutContext::Flags flags() const;
|
|
%Docstring
|
|
Returns the current combination of flags used for rendering the layout.
|
|
|
|
.. seealso:: :py:func:`setFlags()`
|
|
|
|
.. seealso:: :py:func:`setFlag()`
|
|
|
|
.. seealso:: :py:func:`testFlag()`
|
|
%End
|
|
|
|
bool testFlag( const Flag flag ) const;
|
|
%Docstring
|
|
Check whether a particular rendering ``flag`` is enabled for the layout.
|
|
|
|
.. seealso:: :py:func:`setFlags()`
|
|
|
|
.. seealso:: :py:func:`setFlag()`
|
|
|
|
.. seealso:: :py:func:`flags()`
|
|
%End
|
|
|
|
QgsRenderContext::Flags renderContextFlags() const;
|
|
%Docstring
|
|
Returns the combination of render context flags matched to the layout context's settings.
|
|
%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:: :py:func:`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:: :py:func:`setFeature()`
|
|
%End
|
|
|
|
QgsVectorLayer *layer() const;
|
|
%Docstring
|
|
Returns the vector layer associated with the layout's context.
|
|
|
|
.. seealso:: :py:func:`setLayer()`
|
|
%End
|
|
|
|
void setLayer( QgsVectorLayer *layer );
|
|
%Docstring
|
|
Sets the vector ``layer`` associated with the layout's context.
|
|
|
|
.. seealso:: :py:func:`layer()`
|
|
%End
|
|
|
|
void setDpi( double dpi );
|
|
%Docstring
|
|
Sets the ``dpi`` for outputting the layout. This also sets the
|
|
corresponding DPI for the context's measurementConverter().
|
|
|
|
.. seealso:: :py:func:`dpi()`
|
|
%End
|
|
|
|
double dpi() const;
|
|
%Docstring
|
|
Returns the ``dpi`` for outputting the layout.
|
|
|
|
.. seealso:: :py:func:`setDpi()`
|
|
%End
|
|
|
|
|
|
QgsLayoutMeasurementConverter &measurementConverter();
|
|
%Docstring
|
|
Returns the layout measurement converter to be used in the layout. This converter is used
|
|
for translating between other measurement units and the layout's native unit.
|
|
%End
|
|
|
|
bool isPreviewRender() const;
|
|
%Docstring
|
|
Returns true if the render current being conducted is a preview render,
|
|
i.e. it is being rendered inside a QGraphicsView widget as opposed to a destination
|
|
device (such as an image).
|
|
%End
|
|
|
|
bool gridVisible() const;
|
|
%Docstring
|
|
Returns true if the page grid should be drawn.
|
|
|
|
.. seealso:: :py:func:`setGridVisible()`
|
|
%End
|
|
|
|
void setGridVisible( bool visible );
|
|
%Docstring
|
|
Sets whether the page grid should be ``visible``.
|
|
|
|
.. seealso:: :py:func:`gridVisible()`
|
|
%End
|
|
|
|
bool boundingBoxesVisible() const;
|
|
%Docstring
|
|
Returns true if the item bounding boxes should be drawn.
|
|
|
|
.. seealso:: :py:func:`setBoundingBoxesVisible()`
|
|
%End
|
|
|
|
void setBoundingBoxesVisible( bool visible );
|
|
%Docstring
|
|
Sets whether the item bounding boxes should be ``visible``.
|
|
|
|
.. seealso:: :py:func:`boundingBoxesVisible()`
|
|
%End
|
|
|
|
void setPagesVisible( bool visible );
|
|
%Docstring
|
|
Sets whether the page items should be ``visible`` in the layout. Removing
|
|
them will prevent both display of the page boundaries in layout views and
|
|
will also prevent them from being rendered in layout exports.
|
|
|
|
.. seealso:: :py:func:`pagesVisible()`
|
|
%End
|
|
|
|
bool pagesVisible() const;
|
|
%Docstring
|
|
Returns whether the page items are be visible in the layout. This setting
|
|
effects both display of the page boundaries in layout views and
|
|
whether they will be rendered in layout exports.
|
|
|
|
.. seealso:: :py:func:`setPagesVisible()`
|
|
%End
|
|
|
|
void setCurrentExportLayer( int layer = -1 );
|
|
%Docstring
|
|
Sets the current item ``layer`` to draw while exporting. QgsLayoutItem subclasses
|
|
which support multi-layer SVG exports must check the currentExportLayer()
|
|
and customise their rendering based on the layer.
|
|
|
|
If ``layer`` is -1, all item layers will be rendered.
|
|
|
|
.. seealso:: :py:func:`currentExportLayer()`
|
|
%End
|
|
|
|
int currentExportLayer() const;
|
|
%Docstring
|
|
Returns the current item layer to draw while exporting. QgsLayoutItem subclasses
|
|
which support multi-layer SVG exports must check this
|
|
and customise their rendering based on the layer.
|
|
|
|
If ``layer`` is -1, all item layers should be rendered.
|
|
|
|
.. seealso:: :py:func:`setCurrentExportLayer()`
|
|
%End
|
|
|
|
signals:
|
|
|
|
void flagsChanged( QgsLayoutContext::Flags flags );
|
|
%Docstring
|
|
Emitted whenever the context's ``flags`` change.
|
|
|
|
.. seealso:: :py:func:`setFlags()`
|
|
%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 *
|
|
************************************************************************/
|