mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-30 00:07:09 -04:00
218 lines
6.2 KiB
Plaintext
218 lines
6.2 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/layout/qgslayoutmodel.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsLayoutModel: QAbstractItemModel
|
|
{
|
|
%Docstring(signature="appended")
|
|
|
|
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, :py:class:`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.
|
|
%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 :py:class:`QgsLayoutItem` corresponding to a QModelIndex ``index``, if possible.
|
|
|
|
.. seealso:: :py:func:`indexForItem`
|
|
%End
|
|
|
|
QModelIndex indexForItem( QgsLayoutItem *item, int column = 0 );
|
|
%Docstring
|
|
Returns the QModelIndex corresponding to a :py:class:`QgsLayoutItem` ``item`` and ``column``, if possible.
|
|
|
|
.. seealso:: :py:func:`itemFromIndex`
|
|
%End
|
|
|
|
public slots:
|
|
|
|
|
|
};
|
|
|
|
|
|
class QgsLayoutProxyModel: QSortFilterProxyModel
|
|
{
|
|
%Docstring(signature="appended")
|
|
Allows for filtering a :py:class:`QgsLayoutModel` by item type.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutmodel.h"
|
|
%End
|
|
public:
|
|
|
|
QgsLayoutProxyModel( QgsLayout *layout, QObject *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for :py:class:`QgsLayoutProxyModelm`, attached to the specified ``layout``.
|
|
%End
|
|
|
|
QgsLayoutItemRegistry::ItemType filterType() const;
|
|
%Docstring
|
|
Returns the current item type filter, or :py:class:`QgsLayoutItemRegistry`.LayoutItem if no
|
|
item type filter is set.
|
|
|
|
.. 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 :py:class:`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.
|
|
|
|
.. seealso:: :py:func:`setExceptedItemList`
|
|
%End
|
|
|
|
QgsLayoutModel *sourceLayerModel() const;
|
|
%Docstring
|
|
Returns the :py:class:`QgsLayoutModel` used in this proxy model.
|
|
%End
|
|
|
|
QgsLayoutItem *itemFromSourceIndex( const QModelIndex &sourceIndex ) const;
|
|
%Docstring
|
|
Returns the :py:class:`QgsLayoutItem` corresponding to an index from the source
|
|
:py:class:`QgsLayoutModel` model.
|
|
%End
|
|
|
|
QgsLayout *layout();
|
|
%Docstring
|
|
Returns the associated layout.
|
|
|
|
.. versionadded:: 3.8
|
|
%End
|
|
|
|
void setAllowEmptyItem( bool allowEmpty );
|
|
%Docstring
|
|
Sets whether an optional empty layout item is present in the model.
|
|
|
|
.. seealso:: :py:func:`allowEmptyItem`
|
|
|
|
.. versionadded:: 3.8
|
|
%End
|
|
|
|
bool allowEmptyItem() const;
|
|
%Docstring
|
|
Returns ``True`` if the model includes the empty item choice.
|
|
|
|
.. seealso:: :py:func:`setAllowEmptyItem`
|
|
|
|
.. versionadded:: 3.8
|
|
%End
|
|
|
|
void setItemFlags( QgsLayoutItem::Flags flags );
|
|
%Docstring
|
|
Sets layout item flags to use for filtering the available items.
|
|
|
|
Set ``flags`` to ``None`` to clear the flag based filtering.
|
|
|
|
.. seealso:: :py:func:`itemFlags`
|
|
|
|
.. versionadded:: 3.16
|
|
%End
|
|
|
|
QgsLayoutItem::Flags itemFlags() const;
|
|
%Docstring
|
|
Returns the layout item flags used for filtering the available items.
|
|
|
|
Returns ``None`` if no flag based filtering is occurring.
|
|
|
|
.. seealso:: :py:func:`setItemFlags`
|
|
|
|
.. versionadded:: 3.16
|
|
%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.py again *
|
|
************************************************************************/
|