QGIS/python/core/auto_generated/maprenderer/qgsrendereditemresults.sip.in
Nyall Dawson 40bef07264 Correctly handle rendered item results stored when map canvas redraw
partially uses cached layer results
2021-09-06 12:38:33 +10:00

86 lines
2.9 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/maprenderer/qgsrendereditemresults.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsRenderedItemResults
{
%Docstring(signature="appended")
Stores collated details of rendered items during a map rendering operation.
.. versionadded:: 3.22
%End
%TypeHeaderCode
#include "qgsrendereditemresults.h"
%End
public:
QgsRenderedItemResults();
~QgsRenderedItemResults();
QList< QgsRenderedItemDetails * > renderedItems() const;
%Docstring
Returns a list of all rendered items.
%End
QList<const QgsRenderedAnnotationItemDetails *> renderedAnnotationItemsInBounds( const QgsRectangle &bounds ) const;
%Docstring
Returns a list with details of the rendered annotation items within the specified ``bounds``.
.. versionadded:: 3.22
%End
void appendResults( const QList< QgsRenderedItemDetails * > &results /Transfer/, const QgsRenderContext &context );
%Docstring
Appends rendered item details to the results object.
Ownership of ``results`` is transferred to the this object.
The render ``context`` argument is used to specify the render context used to render the items. It will be used
to transform the details to the destination map CRS.
%End
void transferResults( QgsRenderedItemResults *other, const QStringList &layerIds );
%Docstring
Transfers all results from an ``other`` QgsRenderedItemResults object where the items
have layer IDs matching the specified list.
Items are removed from ``other`` and transferred to this object.
.. warning::
After calling this method the ``other`` results will be left in an undefined state.
%End
void transferResults( QgsRenderedItemResults *other );
%Docstring
Transfers all results from an ``other`` QgsRenderedItemResults object to this one.
Items are removed from ``other`` and transferred to this object.
.. warning::
After calling this method the ``other`` results will be left in an undefined state.
%End
private:
QgsRenderedItemResults( const QgsRenderedItemResults & );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/maprenderer/qgsrendereditemresults.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/