QGIS API Documentation 3.39.0-Master (8f4da32b6b8)
|
The QgsLayoutComboBox class is a combo box which displays available layouts from a QgsLayoutManager. More...
#include <qgslayoutcombobox.h>
Public Slots | |
void | setCurrentLayout (QgsMasterLayoutInterface *layout) |
Sets the currently selected layout in the combo box. | |
Signals | |
void | layoutChanged (QgsMasterLayoutInterface *layout) |
Emitted whenever the currently selected layout changes. | |
Public Member Functions | |
QgsLayoutComboBox (QWidget *parent=nullptr, QgsLayoutManager *manager=nullptr) | |
QgsLayoutComboBox creates a combo box to display a list of items in a layout manager. | |
bool | allowEmptyLayout () const |
Returns true if the combobox includes the empty layout ("not set") choice. | |
QgsMasterLayoutInterface * | currentLayout () const |
Returns the layout currently selected in the combo box. | |
QgsLayoutManagerProxyModel::Filters | filters () const |
Returns the current filters used for filtering available layouts. | |
QgsMasterLayoutInterface * | layout (int index) const |
Returns the layout at the specified index. | |
void | setAllowEmptyLayout (bool allowEmpty) |
Sets whether an optional empty layout ("not set") option is present in the combobox. | |
void | setFilters (QgsLayoutManagerProxyModel::Filters filters) |
Sets the current filters used for filtering available layouts. | |
void | setLayoutManager (QgsLayoutManager *manager) |
Sets the layout manager containing the layouts to list in the combo box. | |
The QgsLayoutComboBox class is a combo box which displays available layouts from a QgsLayoutManager.
Definition at line 30 of file qgslayoutcombobox.h.
|
explicit |
QgsLayoutComboBox creates a combo box to display a list of items in a layout manager.
The layouts can optionally be filtered by type.
Definition at line 20 of file qgslayoutcombobox.cpp.
bool QgsLayoutComboBox::allowEmptyLayout | ( | ) | const |
Returns true
if the combobox includes the empty layout ("not set") choice.
Definition at line 60 of file qgslayoutcombobox.cpp.
QgsMasterLayoutInterface * QgsLayoutComboBox::currentLayout | ( | ) | const |
Returns the layout currently selected in the combo box.
Definition at line 83 of file qgslayoutcombobox.cpp.
QgsLayoutManagerProxyModel::Filters QgsLayoutComboBox::filters | ( | ) | const |
Returns the current filters used for filtering available layouts.
Definition at line 45 of file qgslayoutcombobox.cpp.
QgsMasterLayoutInterface * QgsLayoutComboBox::layout | ( | int | index | ) | const |
Returns the layout at the specified index.
Definition at line 107 of file qgslayoutcombobox.cpp.
|
signal |
Emitted whenever the currently selected layout changes.
void QgsLayoutComboBox::setAllowEmptyLayout | ( | bool | allowEmpty | ) |
Sets whether an optional empty layout ("not set") option is present in the combobox.
Definition at line 55 of file qgslayoutcombobox.cpp.
|
slot |
Sets the currently selected layout in the combo box.
Definition at line 65 of file qgslayoutcombobox.cpp.
void QgsLayoutComboBox::setFilters | ( | QgsLayoutManagerProxyModel::Filters | filters | ) |
Sets the current filters used for filtering available layouts.
Definition at line 50 of file qgslayoutcombobox.cpp.
void QgsLayoutComboBox::setLayoutManager | ( | QgsLayoutManager * | manager | ) |
Sets the layout manager containing the layouts to list in the combo box.
Definition at line 28 of file qgslayoutcombobox.cpp.