mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
200 lines
4.6 KiB
Plaintext
200 lines
4.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgscheckablecombobox.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsCheckableComboBox : QComboBox
|
|
{
|
|
%Docstring
|
|
QComboBox subclass which allows selecting multiple items.
|
|
|
|
.. versionadded:: 3.0
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgscheckablecombobox.h"
|
|
%End
|
|
public:
|
|
|
|
QgsCheckableComboBox( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsCheckableComboBox.
|
|
%End
|
|
|
|
QString separator() const;
|
|
%Docstring
|
|
Returns separator used to separate items in the display text.
|
|
|
|
.. seealso:: :py:func:`setSeparator`
|
|
%End
|
|
|
|
void setSeparator( const QString &separator );
|
|
%Docstring
|
|
Set separator used to separate items in the display text.
|
|
|
|
:param separator: separator to use
|
|
|
|
.. seealso:: :py:func:`separator`
|
|
%End
|
|
|
|
QString defaultText() const;
|
|
%Docstring
|
|
Returns default text which will be displayed in the widget
|
|
when no items selected.
|
|
|
|
.. seealso:: :py:func:`setDefaultText`
|
|
%End
|
|
|
|
void setDefaultText( const QString &text );
|
|
%Docstring
|
|
Set default text which will be displayed in the widget when
|
|
no items selected.
|
|
|
|
:param text: default text
|
|
|
|
.. seealso:: :py:func:`defaultText`
|
|
%End
|
|
|
|
void addItemWithCheckState( const QString &text, Qt::CheckState state, const QVariant &userData = QVariant() );
|
|
%Docstring
|
|
Adds an item to the combobox with the given ``text``, check ``state`` (stored in the Qt.CheckStateRole)
|
|
and containing the specified ``userData`` (stored in the Qt.UserRole).
|
|
The item is appended to the list of existing items.
|
|
|
|
.. versionadded:: 3.16
|
|
%End
|
|
|
|
QStringList checkedItems() const;
|
|
%Docstring
|
|
Returns currently checked items.
|
|
|
|
.. seealso:: :py:func:`setCheckedItems`
|
|
%End
|
|
|
|
QVariantList checkedItemsData() const;
|
|
%Docstring
|
|
Returns userData (stored in the Qt.UserRole) associated with
|
|
currently checked items.
|
|
|
|
.. seealso:: :py:func:`checkedItems`
|
|
%End
|
|
|
|
Qt::CheckState itemCheckState( int index ) const;
|
|
%Docstring
|
|
Returns the checked state of the item identified by index
|
|
|
|
:param index: item index
|
|
|
|
.. seealso:: :py:func:`setItemCheckState`
|
|
|
|
.. seealso:: :py:func:`toggleItemCheckState`
|
|
%End
|
|
|
|
void setItemCheckState( int index, Qt::CheckState state );
|
|
%Docstring
|
|
Sets the item check state to state
|
|
|
|
:param index: item index
|
|
:param state: check state
|
|
|
|
.. seealso:: :py:func:`itemCheckState`
|
|
|
|
.. seealso:: :py:func:`toggleItemCheckState`
|
|
%End
|
|
|
|
void toggleItemCheckState( int index );
|
|
%Docstring
|
|
Toggles the item check state
|
|
|
|
:param index: item index
|
|
|
|
.. seealso:: :py:func:`itemCheckState`
|
|
|
|
.. seealso:: :py:func:`setItemCheckState`
|
|
%End
|
|
|
|
QgsCheckableItemModel *model() const;
|
|
%Docstring
|
|
Returns the custom item model which handles checking the items
|
|
|
|
.. seealso:: :py:class:`QgsCheckableItemModel`
|
|
|
|
.. versionadded:: 3.16
|
|
%End
|
|
|
|
virtual void hidePopup();
|
|
|
|
%Docstring
|
|
Hides the list of items in the combobox if it is currently
|
|
visible and resets the internal state.
|
|
%End
|
|
|
|
virtual bool eventFilter( QObject *object, QEvent *event );
|
|
|
|
%Docstring
|
|
Filters events to enable context menu
|
|
%End
|
|
|
|
signals:
|
|
|
|
void checkedItemsChanged( const QStringList &items );
|
|
%Docstring
|
|
Emitted whenever the checked items list changed.
|
|
%End
|
|
|
|
public slots:
|
|
|
|
void setCheckedItems( const QStringList &items );
|
|
%Docstring
|
|
Set items which should be checked/selected.
|
|
|
|
:param items: items to select
|
|
|
|
.. seealso:: :py:func:`checkedItems`
|
|
%End
|
|
|
|
protected:
|
|
|
|
virtual void resizeEvent( QResizeEvent *event );
|
|
|
|
%Docstring
|
|
Handler for widget resizing
|
|
%End
|
|
|
|
protected slots:
|
|
|
|
void showContextMenu( QPoint pos );
|
|
%Docstring
|
|
Display context menu which allows selecting/deselecting
|
|
all items at once.
|
|
%End
|
|
|
|
void selectAllOptions();
|
|
%Docstring
|
|
Selects all items.
|
|
%End
|
|
|
|
void deselectAllOptions();
|
|
%Docstring
|
|
Removes selection from all items.
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgscheckablecombobox.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|