The QgsLayoutItemComboBox class is a combo box which displays items of a matching type from a layout. More...

#include <qgslayoutitemcombobox.h>

Inheritance diagram for QgsLayoutItemComboBox:

Public Slots
void	setItem (const QgsLayoutItem *item)
	Sets the currently selected item in the combo box. More...

Signals
void	itemChanged (QgsLayoutItem *item)
	Emitted whenever the currently selected item changes. More...

Public Member Functions
	QgsLayoutItemComboBox (QWidget parent=nullptr, QgsLayout layout=nullptr)
	QgsLayoutItemComboBox creates a combo box to display a list of items in a layout. More...

bool	allowEmptyItem () const
	Returns `true` if the model includes the empty item choice. More...

QgsLayoutItem *	currentItem () const
	Returns the item currently selected in the combo box. More...

QgsLayout *	currentLayout ()
	Returns the current layout containing the items shown in the combo box. More...

QList< QgsLayoutItem * >	exceptedItemList () const
	Returns the list of specific items excluded from the combo box. More...

QgsLayoutItem *	item (int index) const
	Returns the item currently shown at the specified index within the combo box. More...

QgsLayoutItem::Flags	itemFlags () const
	Returns the layout item flags used for filtering the available items. More...

QgsLayoutItemRegistry::ItemType	itemType () const
	Returns the filter for the item types to show in the combo box. More...

void	setAllowEmptyItem (bool allowEmpty)
	Sets whether an optional empty layout item is present in the combobox. More...

void	setCurrentLayout (QgsLayout *layout)
	Sets the layout containing the items to list in the combo box. More...

void	setExceptedItemList (const QList< QgsLayoutItem * > &exceptList)
	Sets a list of specific items to exclude from the combo box. More...

void	setItemFlags (QgsLayoutItem::Flags flags)
	Sets layout item flags to use for filtering the available items. More...

void	setItemType (QgsLayoutItemRegistry::ItemType itemType)
	Sets a filter for the item type to show in the combo box. More...

Detailed Description

The QgsLayoutItemComboBox class is a combo box which displays items of a matching type from a layout.

Since: QGIS 3.0

Definition at line 34 of file qgslayoutitemcombobox.h.

Constructor & Destructor Documentation

◆ QgsLayoutItemComboBox()

QgsLayoutItemComboBox::QgsLayoutItemComboBox	(	QWidget *	parent = `nullptr`,
		QgsLayout *	layout = `nullptr`
	)

explicit

QgsLayoutItemComboBox creates a combo box to display a list of items in a layout.

The items can optionally be filtered by type. If layout is not set, no items will be shown until setCurrentLayout() is called

Definition at line 23 of file qgslayoutitemcombobox.cpp.

Member Function Documentation

◆ allowEmptyItem()

bool QgsLayoutItemComboBox::allowEmptyItem ( ) const

Returns true if the model includes the empty item choice.

See also: setAllowEmptyItem()

Since: QGIS 3.8

Definition at line 119 of file qgslayoutitemcombobox.cpp.

◆ currentItem()

QgsLayoutItem * QgsLayoutItemComboBox::currentItem ( ) const

Returns the item currently selected in the combo box.

Definition at line 70 of file qgslayoutitemcombobox.cpp.

◆ currentLayout()

QgsLayout * QgsLayoutItemComboBox::currentLayout ( )

Returns the current layout containing the items shown in the combo box.

See also: setCurrentLayout()

Definition at line 47 of file qgslayoutitemcombobox.cpp.

◆ exceptedItemList()

QList< QgsLayoutItem * > QgsLayoutItemComboBox::exceptedItemList ( ) const

Returns the list of specific items excluded from the combo box.

See also: setExceptedItemList()

Definition at line 109 of file qgslayoutitemcombobox.cpp.

◆ item()

QgsLayoutItem * QgsLayoutItemComboBox::item ( int index ) const

Returns the item currently shown at the specified index within the combo box.

See also: currentItem()

Definition at line 134 of file qgslayoutitemcombobox.cpp.

◆ itemChanged

void QgsLayoutItemComboBox::itemChanged ( QgsLayoutItem * item )

signal

Emitted whenever the currently selected item changes.

◆ itemFlags()

QgsLayoutItem::Flags QgsLayoutItemComboBox::itemFlags ( ) const

Returns the layout item flags used for filtering the available items.

Returns nullptr if no flag based filtering is occurring.

See also: setItemFlags()

Since: QGIS 3.16

Definition at line 129 of file qgslayoutitemcombobox.cpp.

◆ itemType()

QgsLayoutItemRegistry::ItemType QgsLayoutItemComboBox::itemType ( ) const

Returns the filter for the item types to show in the combo box.

See also: setItemType()

Definition at line 99 of file qgslayoutitemcombobox.cpp.

◆ setAllowEmptyItem()

void QgsLayoutItemComboBox::setAllowEmptyItem ( bool allowEmpty )

Sets whether an optional empty layout item is present in the combobox.

See also: allowEmptyItem()

Since: QGIS 3.8

Definition at line 114 of file qgslayoutitemcombobox.cpp.

◆ setCurrentLayout()

void QgsLayoutItemComboBox::setCurrentLayout ( QgsLayout * layout )

Sets the layout containing the items to list in the combo box.

See also: currentLayout()

Definition at line 32 of file qgslayoutitemcombobox.cpp.

◆ setExceptedItemList()

void QgsLayoutItemComboBox::setExceptedItemList ( const QList< QgsLayoutItem * > & exceptList )

Sets a list of specific items to exclude from the combo box.

See also: exceptedItemList()

Definition at line 104 of file qgslayoutitemcombobox.cpp.

◆ setItem

void QgsLayoutItemComboBox::setItem ( const QgsLayoutItem * item )

slot

Sets the currently selected item in the combo box.

Definition at line 52 of file qgslayoutitemcombobox.cpp.

◆ setItemFlags()

void QgsLayoutItemComboBox::setItemFlags ( QgsLayoutItem::Flags flags )

Sets layout item flags to use for filtering the available items.

Set flags to nullptr to clear the flag based filtering.

See also: itemFlags()

Since: QGIS 3.16

Definition at line 124 of file qgslayoutitemcombobox.cpp.

◆ setItemType()

void QgsLayoutItemComboBox::setItemType ( QgsLayoutItemRegistry::ItemType itemType )

Sets a filter for the item type to show in the combo box.

Parameters

itemType type of items to show. Set to QgsLayoutItemRegistry::LayoutItem to show all items.

See also: itemType()

Definition at line 94 of file qgslayoutitemcombobox.cpp.

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

/build/qgis-3.16.0+99unstable/src/gui/layout/qgslayoutitemcombobox.h
/build/qgis-3.16.0+99unstable/src/gui/layout/qgslayoutitemcombobox.cpp

Public Slots

Signals

Public Member Functions