QGIS/python/gui/auto_generated/qgscheckablecombobox.sip.in
Denis Rouzaud 65bb60e96c run sipify
2018-05-28 10:39:34 -08:00

174 lines
3.9 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
QStringList checkedItems() const;
%Docstring
Returns currently checked items.
.. seealso:: :py:func:`setCheckedItems`
%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
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
This signal is 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 *
************************************************************************/