/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmapcanvasutils.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsMapCanvasUtils
{
%Docstring(signature="appended")
Utility functions for working with :py:class:`QgsMapCanvas` widgets.

.. versionadded:: 3.14
%End

%TypeHeaderCode
#include "qgsmapcanvasutils.h"
%End
  public:
    static long zoomToMatchingFeatures( QgsMapCanvas *canvas, QgsVectorLayer *layer, const QString &filter );
%Docstring
Zooms a map ``canvas`` to features from the specified ``layer`` which
match the given ``filter`` expression string.

The total count of matching features will be returned.
%End

    static long flashMatchingFeatures( QgsMapCanvas *canvas, QgsVectorLayer *layer, const QString &filter );
%Docstring
Flashes features from the specified ``layer`` which match the given
``filter`` expression string with a map ``canvas``.

The total count of matching features will be returned.
%End

    static QString filterForLayer( QgsMapCanvas *canvas, QgsVectorLayer *layer );
%Docstring
Constructs a filter to use for selecting features from the given
``layer``, in order to apply filters which prevent some features from
being displayed (e.g. as a result of temporal range of the canvas and
the layer's temporal settings).

Will return an empty string if no filtering is required, or "``False``"
if ALL features are filtered out by the canvas.

.. versionadded:: 3.26
%End
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsmapcanvasutils.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/
