mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
c30c769ef5
This feature allows users to enable map clipping for layout map items
so that the maps are clipped to the boundary of the current atlas feature.
(It's available for polygon atlas coverage layers only, for obvious reasons!)
Options exist for:
- Enabling or disabling the clipping on a per-map basis
- Specifying the clipping type:
- "Clip During Render Only": applies a painter based clip, so that
portions of vector features which sit outside the atlas feature become
invisible
- "Clip Feature Before Render": applies the clip before rendering features,
so borders of features which fall partially outside the atlas feature
will still be visible on the boundary of the atlas feature
- "Render Intersecting Features Unchanged": just renders all features
which intersect the current atlas feature, but without clipping their
geometry
- Controlling whether labels should be forced placed inside the atlas feature,
or whether they may be placed outside the feature
- Restricting the clip to a subset of the layers in the project, so that
only some are clipped
Sponsored by City of Canning
222 lines
6.3 KiB
Plaintext
222 lines
6.3 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmaplayermodel.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMapLayerModel : QAbstractItemModel
|
|
{
|
|
%Docstring
|
|
The QgsMapLayerModel class is a model to display layers in widgets.
|
|
|
|
.. seealso:: :py:class:`QgsMapLayerProxyModel`
|
|
|
|
.. seealso:: :py:class:`QgsFieldModel`
|
|
|
|
.. versionadded:: 2.3
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsmaplayermodel.h"
|
|
%End
|
|
public:
|
|
|
|
enum ItemDataRole
|
|
{
|
|
LayerIdRole,
|
|
LayerRole,
|
|
EmptyRole,
|
|
AdditionalRole,
|
|
};
|
|
|
|
explicit QgsMapLayerModel( QObject *parent /TransferThis/ = 0, QgsProject *project = 0 );
|
|
%Docstring
|
|
QgsMapLayerModel creates a model to display layers in widgets.
|
|
|
|
If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
|
|
populate the model.
|
|
%End
|
|
|
|
explicit QgsMapLayerModel( const QList<QgsMapLayer *> &layers, QObject *parent = 0, QgsProject *project = 0 );
|
|
%Docstring
|
|
QgsMapLayerModel creates a model to display a specific list of layers in a widget.
|
|
|
|
If a specific ``project`` is not specified then the :py:func:`QgsProject.instance()` project will be used to
|
|
populate the model.
|
|
%End
|
|
|
|
void setItemsCheckable( bool checkable );
|
|
%Docstring
|
|
setItemsCheckable defines if layers should be selectable in the widget
|
|
%End
|
|
|
|
void setItemsCanBeReordered( bool allow );
|
|
%Docstring
|
|
Sets whether items in the model can be reordered via drag and drop.
|
|
|
|
.. seealso:: :py:func:`itemsCanBeReordered`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
bool itemsCanBeReordered() const;
|
|
%Docstring
|
|
Returns ``True`` if items in the model can be reordered via drag and drop.
|
|
|
|
.. seealso:: :py:func:`setItemsCanBeReordered`
|
|
|
|
.. versionadded:: 3.14
|
|
%End
|
|
|
|
void checkAll( Qt::CheckState checkState );
|
|
%Docstring
|
|
checkAll changes the checkstate for all the layers
|
|
%End
|
|
|
|
void setAllowEmptyLayer( bool allowEmpty );
|
|
%Docstring
|
|
Sets whether an optional empty layer ("not set") option is present in the model.
|
|
|
|
.. seealso:: :py:func:`allowEmptyLayer`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
bool allowEmptyLayer() const;
|
|
%Docstring
|
|
Returns ``True`` if the model allows the empty layer ("not set") choice.
|
|
|
|
.. seealso:: :py:func:`setAllowEmptyLayer`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
void setShowCrs( bool showCrs );
|
|
%Docstring
|
|
Sets whether the CRS of layers is also included in the model's display role.
|
|
|
|
.. seealso:: :py:func:`showCrs`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
bool showCrs() const;
|
|
%Docstring
|
|
Returns ``True`` if the model includes layer's CRS in the display role.
|
|
|
|
.. seealso:: :py:func:`setShowCrs`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
QList<QgsMapLayer *> layersChecked( Qt::CheckState checkState = Qt::Checked );
|
|
%Docstring
|
|
layersChecked returns the list of layers which are checked (or unchecked)
|
|
%End
|
|
|
|
void setLayersChecked( const QList< QgsMapLayer * > &layers );
|
|
%Docstring
|
|
Sets which layers are checked in the model.
|
|
%End
|
|
|
|
bool itemsCheckable() const;
|
|
%Docstring
|
|
returns if the items can be checked or not
|
|
%End
|
|
|
|
QModelIndex indexFromLayer( QgsMapLayer *layer ) const;
|
|
%Docstring
|
|
indexFromLayer returns the model index for a given layer
|
|
|
|
.. seealso:: :py:func:`layerFromIndex`
|
|
%End
|
|
|
|
QgsMapLayer *layerFromIndex( const QModelIndex &index ) const;
|
|
%Docstring
|
|
Returns the map layer corresponding to the specified ``index``.
|
|
|
|
.. seealso:: :py:func:`indexFromLayer`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
void setAdditionalItems( const QStringList &items );
|
|
%Docstring
|
|
Sets a list of additional (non map layer) items to include at the end of the model.
|
|
These may represent additional layers such as layers which are not included in the map
|
|
layer registry, or paths to layers which have not yet been loaded into QGIS.
|
|
|
|
.. seealso:: :py:func:`additionalItems`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
QStringList additionalItems() const;
|
|
%Docstring
|
|
Returns the list of additional (non map layer) items included at the end of the model.
|
|
|
|
.. seealso:: :py:func:`setAdditionalItems`
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
|
|
|
|
virtual QModelIndex parent( const QModelIndex &child ) const;
|
|
|
|
virtual int rowCount( const QModelIndex &parent = QModelIndex() ) const;
|
|
|
|
virtual int columnCount( const QModelIndex &parent = QModelIndex() ) const;
|
|
|
|
virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;
|
|
|
|
virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole );
|
|
|
|
virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
|
|
|
|
virtual bool insertRows( int row, int count, const QModelIndex &parent = QModelIndex() );
|
|
|
|
virtual bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() );
|
|
|
|
virtual QStringList mimeTypes() const;
|
|
|
|
virtual bool canDropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent ) const;
|
|
|
|
virtual QMimeData *mimeData( const QModelIndexList &indexes ) const;
|
|
|
|
virtual bool dropMimeData( const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent );
|
|
|
|
virtual Qt::DropActions supportedDropActions() const;
|
|
|
|
|
|
|
|
static QIcon iconForLayer( QgsMapLayer *layer );
|
|
%Docstring
|
|
Returns the icon corresponding to a specified map ``layer``.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
protected slots:
|
|
void removeLayers( const QStringList &layerIds );
|
|
void addLayers( const QList<QgsMapLayer *> &layers );
|
|
|
|
protected:
|
|
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsmaplayermodel.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|