QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Types | Public Slots | Public Member Functions | List of all members
QgsLayoutManagerProxyModel Class Reference

#include <qgslayoutmanager.h>

Inheritance diagram for QgsLayoutManagerProxyModel:
Inheritance graph
[legend]

Public Types

enum  Filter { FilterPrintLayouts = 1 << 1, FilterReports = 1 << 2 }
 Available filter flags for filtering the model. More...
 

Public Slots

void setFilterString (const QString &filter)
 Sets a filter string, such that only layouts with names containing the specified string will be shown. More...
 

Public Member Functions

 QgsLayoutManagerProxyModel (QObject *parent=nullptr)
 Constructor for QgsLayoutManagerProxyModel. More...
 
bool filterAcceptsRow (int sourceRow, const QModelIndex &sourceParent) const override
 
QgsLayoutManagerProxyModel::Filters filters () const
 Returns the current filters used for filtering available layouts. More...
 
QString filterString () const
 Returns the current filter string, if set. More...
 
bool lessThan (const QModelIndex &left, const QModelIndex &right) const override
 
void setFilters (QgsLayoutManagerProxyModel::Filters filters)
 Sets the current filters used for filtering available layouts. More...
 

Detailed Description

QSortFilterProxyModel subclass for QgsLayoutManagerModel

Since
QGIS 3.8

Definition at line 238 of file qgslayoutmanager.h.

Member Enumeration Documentation

◆ Filter

Available filter flags for filtering the model.

Enumerator
FilterPrintLayouts 

Includes print layouts.

FilterReports 

Includes reports.

Definition at line 245 of file qgslayoutmanager.h.

Constructor & Destructor Documentation

◆ QgsLayoutManagerProxyModel()

QgsLayoutManagerProxyModel::QgsLayoutManagerProxyModel ( QObject *  parent = nullptr)
explicit

Constructor for QgsLayoutManagerProxyModel.

Definition at line 527 of file qgslayoutmanager.cpp.

Member Function Documentation

◆ filterAcceptsRow()

bool QgsLayoutManagerProxyModel::filterAcceptsRow ( int  sourceRow,
const QModelIndex &  sourceParent 
) const
override

Definition at line 547 of file qgslayoutmanager.cpp.

◆ filters()

QgsLayoutManagerProxyModel::Filters QgsLayoutManagerProxyModel::filters ( ) const

Returns the current filters used for filtering available layouts.

See also
setFilters()

Definition at line 573 of file qgslayoutmanager.cpp.

◆ filterString()

QString QgsLayoutManagerProxyModel::filterString ( ) const
inline

Returns the current filter string, if set.

See also
setFilterString()
Since
QGIS 3.12

Definition at line 280 of file qgslayoutmanager.h.

◆ lessThan()

bool QgsLayoutManagerProxyModel::lessThan ( const QModelIndex &  left,
const QModelIndex &  right 
) const
override

Definition at line 535 of file qgslayoutmanager.cpp.

◆ setFilters()

void QgsLayoutManagerProxyModel::setFilters ( QgsLayoutManagerProxyModel::Filters  filters)

Sets the current filters used for filtering available layouts.

See also
filters()

Definition at line 578 of file qgslayoutmanager.cpp.

◆ setFilterString

void QgsLayoutManagerProxyModel::setFilterString ( const QString &  filter)
slot

Sets a filter string, such that only layouts with names containing the specified string will be shown.

See also
filterString()
Since
QGIS 3.12

Definition at line 584 of file qgslayoutmanager.cpp.


The documentation for this class was generated from the following files: