mirror of
https://github.com/qgis/QGIS.git
synced 2025-10-15 00:02:52 -04:00
150 lines
4.1 KiB
Plaintext
150 lines
4.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutitemcombobox.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsLayoutItemComboBox : QComboBox
|
|
{
|
|
%Docstring(signature="appended")
|
|
A combo box which displays items of a matching type from a layout.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgslayoutitemcombobox.h"
|
|
%End
|
|
public:
|
|
explicit QgsLayoutItemComboBox( QWidget *parent /TransferThis/ = 0, QgsLayout *layout = 0 );
|
|
%Docstring
|
|
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 :py:func:`~QgsLayoutItemComboBox.setCurrentLayout` is called
|
|
%End
|
|
|
|
void setCurrentLayout( QgsLayout *layout );
|
|
%Docstring
|
|
Sets the ``layout`` containing the items to list in the combo box.
|
|
|
|
.. seealso:: :py:func:`currentLayout`
|
|
%End
|
|
|
|
QgsLayout *currentLayout();
|
|
%Docstring
|
|
Returns the current layout containing the items shown in the combo box.
|
|
|
|
.. seealso:: :py:func:`setCurrentLayout`
|
|
%End
|
|
|
|
void setItemType( QgsLayoutItemRegistry::ItemType itemType );
|
|
%Docstring
|
|
Sets a filter for the item type to show in the combo box.
|
|
|
|
:param itemType: type of items to show. Set to :py:class:`QgsLayoutItemRegistry`.LayoutItem to
|
|
show all items.
|
|
|
|
.. seealso:: :py:func:`itemType`
|
|
%End
|
|
|
|
QgsLayoutItemRegistry::ItemType itemType() const;
|
|
%Docstring
|
|
Returns the filter for the item types to show in the combo box.
|
|
|
|
.. seealso:: :py:func:`setItemType`
|
|
%End
|
|
|
|
void setExceptedItemList( const QList<QgsLayoutItem *> &exceptList );
|
|
%Docstring
|
|
Sets a list of specific items to exclude from the combo box.
|
|
|
|
.. seealso:: :py:func:`exceptedItemList`
|
|
%End
|
|
|
|
QList<QgsLayoutItem *> exceptedItemList() const;
|
|
%Docstring
|
|
Returns the list of specific items excluded from the combo box.
|
|
|
|
.. seealso:: :py:func:`setExceptedItemList`
|
|
%End
|
|
|
|
void setAllowEmptyItem( bool allowEmpty );
|
|
%Docstring
|
|
Sets whether an optional empty layout item is present in the combobox.
|
|
|
|
.. 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
|
|
|
|
QgsLayoutItem *item( int index ) const;
|
|
%Docstring
|
|
Returns the item currently shown at the specified ``index`` within the combo box.
|
|
|
|
.. seealso:: :py:func:`currentItem`
|
|
%End
|
|
|
|
QgsLayoutItem *currentItem() const;
|
|
%Docstring
|
|
Returns the item currently selected in the combo box.
|
|
%End
|
|
|
|
public slots:
|
|
|
|
void setItem( const QgsLayoutItem *item );
|
|
%Docstring
|
|
Sets the currently selected ``item`` in the combo box.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void itemChanged( QgsLayoutItem *item );
|
|
%Docstring
|
|
Emitted whenever the currently selected item changes
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/layout/qgslayoutitemcombobox.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|