mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-09 00:05:52 -04:00
4da1ce8404
Run clang-tidy modernize-use-override to remove all the redundant virtual keywords from overridden methods, and add some missing overrides. Another benefit is that this has also added the overrides on destructors, which will cause a build failure if a base class is missing a virtual destructor.
187 lines
5.3 KiB
Plaintext
187 lines
5.3 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutmodel.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLayoutModel: QAbstractItemModel
|
|
{
|
|
%Docstring
|
|
|
|
A model for items attached to a layout. The model also maintains the z-order for the
|
|
layout, and must be notified whenever item stacking changes.
|
|
|
|
Internally, QgsLayoutModel maintains two lists. One contains a complete list of all items for
|
|
the layout, ordered by their position within the z-order stack.
|
|
|
|
The second list contains only items which are currently displayed in the layout's scene.
|
|
It is used as a cache of the last known stacking order, so that the model can compare the current
|
|
stacking of items in the layout to the last known state, and emit the corresponding signals
|
|
as required.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutmodel.h"
|
|
%End
|
|
public:
|
|
|
|
enum Columns
|
|
{
|
|
Visibility,
|
|
LockStatus,
|
|
ItemId,
|
|
};
|
|
|
|
explicit QgsLayoutModel( QgsLayout *layout, QObject *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for a QgsLayoutModel attached to the specified ``layout``.
|
|
%End
|
|
|
|
virtual QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const;
|
|
|
|
virtual QModelIndex parent( const QModelIndex &index ) 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 ) const;
|
|
|
|
virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
|
|
|
|
virtual bool setData( const QModelIndex &index, const QVariant &value, int role );
|
|
|
|
virtual QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const;
|
|
|
|
virtual Qt::DropActions supportedDropActions() const;
|
|
|
|
virtual QStringList mimeTypes() 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 bool removeRows( int row, int count, const QModelIndex &parent = QModelIndex() );
|
|
|
|
|
|
|
|
QgsLayoutItem *itemFromIndex( const QModelIndex &index ) const;
|
|
%Docstring
|
|
Returns the QgsLayoutItem corresponding to a QModelIndex ``index``, if possible.
|
|
|
|
:rtype: QgsLayoutItem
|
|
|
|
.. seealso:: :py:func:`indexForItem()`
|
|
%End
|
|
|
|
QModelIndex indexForItem( QgsLayoutItem *item, const int column = 0 );
|
|
%Docstring
|
|
Returns the QModelIndex corresponding to a QgsLayoutItem ``item`` and ``column``, if possible.
|
|
|
|
:rtype: QModelIndex
|
|
|
|
.. seealso:: :py:func:`itemFromIndex()`
|
|
%End
|
|
|
|
public slots:
|
|
|
|
|
|
};
|
|
|
|
|
|
class QgsLayoutProxyModel: QSortFilterProxyModel
|
|
{
|
|
%Docstring
|
|
Allows for filtering a QgsLayoutModel by item type.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutmodel.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutProxyModel( QgsLayout *layout, QObject *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsLayoutProxyModelm, attached to the specified ``layout``.
|
|
%End
|
|
|
|
QgsLayoutItemRegistry::ItemType filterType() const;
|
|
%Docstring
|
|
Returns the current item type filter, or QgsLayoutItemRegistry.LayoutItem if no
|
|
item type filter is set.
|
|
|
|
:rtype: QgsLayoutItemRegistry.ItemType
|
|
|
|
.. seealso:: :py:func:`setFilterType()`
|
|
%End
|
|
|
|
void setFilterType( QgsLayoutItemRegistry::ItemType filter );
|
|
%Docstring
|
|
Sets the item type ``filter``. Only matching item types will be shown.
|
|
Set ``filter`` to QgsLayoutItemRegistry.LayoutItem to show all
|
|
item types.
|
|
|
|
.. seealso:: :py:func:`filterType()`
|
|
%End
|
|
|
|
void setExceptedItemList( const QList< QgsLayoutItem * > &items );
|
|
%Docstring
|
|
Sets a list of specific ``items`` to exclude from the model.
|
|
|
|
.. seealso:: :py:func:`exceptedItemList()`
|
|
%End
|
|
|
|
QList< QgsLayoutItem * > exceptedItemList() const;
|
|
%Docstring
|
|
Returns the list of specific items excluded from the model.
|
|
|
|
:rtype: list of QgsLayoutItem
|
|
|
|
.. seealso:: :py:func:`setExceptedItemList()`
|
|
%End
|
|
|
|
QgsLayoutModel *sourceLayerModel() const;
|
|
%Docstring
|
|
Returns the QgsLayoutModel used in this proxy model.
|
|
|
|
:rtype: QgsLayoutModel
|
|
%End
|
|
|
|
QgsLayoutItem *itemFromSourceIndex( const QModelIndex &sourceIndex ) const;
|
|
%Docstring
|
|
Returns the QgsLayoutItem corresponding to an index from the source
|
|
QgsLayoutModel model.
|
|
|
|
:rtype: QgsLayoutItem
|
|
%End
|
|
|
|
protected:
|
|
virtual bool filterAcceptsRow( int sourceRow, const QModelIndex &sourceParent ) const;
|
|
|
|
virtual bool lessThan( const QModelIndex &left, const QModelIndex &right ) const;
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutmodel.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|