QGIS API Documentation 3.41.0-Master (3440c17df1d)
|
A model for items attached to a layout. More...
#include <qgslayoutmodel.h>
Public Types | |
enum | Columns { Visibility = 0 , LockStatus , ItemId } |
Columns returned by the model. More... | |
Public Member Functions | |
QgsLayoutModel (QgsLayout *layout, QObject *parent=nullptr) | |
Constructor for a QgsLayoutModel attached to the specified layout. | |
int | columnCount (const QModelIndex &parent=QModelIndex()) const override |
QVariant | data (const QModelIndex &index, int role) const override |
bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override |
Qt::ItemFlags | flags (const QModelIndex &index) const override |
QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const override |
QModelIndex | index (int row, int column, const QModelIndex &parent=QModelIndex()) const override |
QModelIndex | indexForItem (QgsLayoutItem *item, int column=0) |
Returns the QModelIndex corresponding to a QgsLayoutItem item and column, if possible. | |
QgsLayoutItem * | itemFromIndex (const QModelIndex &index) const |
Returns the QgsLayoutItem corresponding to a QModelIndex index, if possible. | |
QMimeData * | mimeData (const QModelIndexList &indexes) const override |
QStringList | mimeTypes () const override |
QModelIndex | parent (const QModelIndex &index) const override |
bool | removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override |
int | rowCount (const QModelIndex &parent=QModelIndex()) const override |
bool | setData (const QModelIndex &index, const QVariant &value, int role) override |
Qt::DropActions | supportedDropActions () const override |
Friends | |
class | TestQgsLayoutGui |
class | TestQgsLayoutModel |
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.
Definition at line 51 of file qgslayoutmodel.h.
Columns returned by the model.
Enumerator | |
---|---|
Visibility | Item visibility checkbox. |
LockStatus | Item lock status checkbox. |
ItemId | Item ID. |
Definition at line 58 of file qgslayoutmodel.h.
|
explicit |
Constructor for a QgsLayoutModel attached to the specified layout.
Definition at line 33 of file qgslayoutmodel.cpp.
|
override |
Definition at line 120 of file qgslayoutmodel.cpp.
|
override |
Definition at line 126 of file qgslayoutmodel.cpp.
|
override |
Definition at line 309 of file qgslayoutmodel.cpp.
|
override |
Definition at line 874 of file qgslayoutmodel.cpp.
|
override |
Definition at line 231 of file qgslayoutmodel.cpp.
|
override |
Definition at line 52 of file qgslayoutmodel.cpp.
QModelIndex QgsLayoutModel::indexForItem | ( | QgsLayoutItem * | item, |
int | column = 0 |
||
) |
Returns the QModelIndex corresponding to a QgsLayoutItem item and column, if possible.
Definition at line 902 of file qgslayoutmodel.cpp.
QgsLayoutItem * QgsLayoutModel::itemFromIndex | ( | const QModelIndex & | index | ) | const |
Returns the QgsLayoutItem corresponding to a QModelIndex index, if possible.
Definition at line 40 of file qgslayoutmodel.cpp.
|
override |
Definition at line 279 of file qgslayoutmodel.cpp.
|
override |
Definition at line 272 of file qgslayoutmodel.cpp.
|
override |
Definition at line 91 of file qgslayoutmodel.cpp.
|
override |
Definition at line 412 of file qgslayoutmodel.cpp.
|
override |
Definition at line 99 of file qgslayoutmodel.cpp.
|
override |
Definition at line 197 of file qgslayoutmodel.cpp.
|
override |
Definition at line 267 of file qgslayoutmodel.cpp.
|
friend |
Definition at line 294 of file qgslayoutmodel.h.
|
friend |
Definition at line 293 of file qgslayoutmodel.h.