QGIS API Documentation  2.99.0-Master (ae4d26a)
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Properties | List of all members
QgsCheckableComboBox Class Reference

QComboBox subclass which allows selecting multiple items. More...

#include <qgscheckablecombobox.h>

Inheritance diagram for QgsCheckableComboBox:
Inheritance graph
[legend]

Public Slots

void setCheckedItems (const QStringList &items)
 Set items which should be checked/selected. More...
 

Signals

void checkedItemsChanged (const QStringList &items)
 This signal is emitted whenever the checked items list changed. More...
 

Public Member Functions

 QgsCheckableComboBox (QWidget *parent=nullptr)
 Constructor for QgsCheckableComboBox. More...
 
QStringList checkedItems () const
 Returns currently checked items. More...
 
QString defaultText () const
 Returns default text which will be displayed in the widget when no items selected. More...
 
virtual bool eventFilter (QObject *object, QEvent *event) override
 Filters events to enable context menu. More...
 
virtual void hidePopup () override
 Hides the list of items in the combobox if it is currently visible and resets the internal state. More...
 
Qt::CheckState itemCheckState (int index) const
 Returns the checked state of the item identified by index. More...
 
QString separator () const
 Returns separator used to separate items in the display text. More...
 
void setDefaultText (const QString &text)
 Set default text which will be displayed in the widget when no items selected. More...
 
void setItemCheckState (int index, Qt::CheckState state)
 Sets the item check state to state. More...
 
void setSeparator (const QString &separator)
 Set separator used to separate items in the display text. More...
 
void toggleItemCheckState (int index)
 Toggles the item check state. More...
 

Protected Slots

void deselectAllOptions ()
 Removes selection from all items. More...
 
void selectAllOptions ()
 Selects all items. More...
 
void showContextMenu (const QPoint &pos)
 Display context menu which allows selecting/deselecting all items at once. More...
 

Protected Member Functions

virtual void resizeEvent (QResizeEvent *event) override
 Handler for widget resizing. More...
 

Properties

QStringList checkedItems
 
QString defaultText
 
QString separator
 

Detailed Description

QComboBox subclass which allows selecting multiple items.

Since
QGIS 3.0

Definition at line 125 of file qgscheckablecombobox.h.

Constructor & Destructor Documentation

◆ QgsCheckableComboBox()

QgsCheckableComboBox::QgsCheckableComboBox ( QWidget *  parent = nullptr)

Constructor for QgsCheckableComboBox.

Definition at line 76 of file qgscheckablecombobox.cpp.

Member Function Documentation

◆ checkedItems()

QStringList QgsCheckableComboBox::checkedItems ( ) const

Returns currently checked items.

See also
setCheckedItems()

◆ checkedItemsChanged

void QgsCheckableComboBox::checkedItemsChanged ( const QStringList &  items)
signal

This signal is emitted whenever the checked items list changed.

◆ defaultText()

QString QgsCheckableComboBox::defaultText ( ) const

Returns default text which will be displayed in the widget when no items selected.

See also
setDefaultText()

◆ deselectAllOptions

void QgsCheckableComboBox::deselectAllOptions ( )
protectedslot

Removes selection from all items.

Definition at line 197 of file qgscheckablecombobox.cpp.

◆ eventFilter()

bool QgsCheckableComboBox::eventFilter ( QObject *  object,
QEvent *  event 
)
overridevirtual

Filters events to enable context menu.

Definition at line 208 of file qgscheckablecombobox.cpp.

◆ hidePopup()

void QgsCheckableComboBox::hidePopup ( )
overridevirtual

Hides the list of items in the combobox if it is currently visible and resets the internal state.

Definition at line 170 of file qgscheckablecombobox.cpp.

◆ itemCheckState()

Qt::CheckState QgsCheckableComboBox::itemCheckState ( int  index) const

Returns the checked state of the item identified by index.

Parameters
indexitem index
See also
setItemCheckState()
toggleItemCheckState()

Definition at line 150 of file qgscheckablecombobox.cpp.

◆ resizeEvent()

void QgsCheckableComboBox::resizeEvent ( QResizeEvent *  event)
overrideprotectedvirtual

Handler for widget resizing.

Definition at line 235 of file qgscheckablecombobox.cpp.

◆ selectAllOptions

void QgsCheckableComboBox::selectAllOptions ( )
protectedslot

Selects all items.

Definition at line 186 of file qgscheckablecombobox.cpp.

◆ separator()

QString QgsCheckableComboBox::separator ( ) const

Returns separator used to separate items in the display text.

See also
setSeparator()

◆ setCheckedItems

void QgsCheckableComboBox::setCheckedItems ( const QStringList &  items)
slot

Set items which should be checked/selected.

Parameters
itemsitems to select
See also
checkedItems()

Definition at line 226 of file qgscheckablecombobox.cpp.

◆ setDefaultText()

void QgsCheckableComboBox::setDefaultText ( const QString &  text)

Set default text which will be displayed in the widget when no items selected.

Parameters
textdefault text
See also
defaultText()

Definition at line 124 of file qgscheckablecombobox.cpp.

◆ setItemCheckState()

void QgsCheckableComboBox::setItemCheckState ( int  index,
Qt::CheckState  state 
)

Sets the item check state to state.

Parameters
indexitem index
statecheck state
See also
itemCheckState()
toggleItemCheckState()

Definition at line 155 of file qgscheckablecombobox.cpp.

◆ setSeparator()

void QgsCheckableComboBox::setSeparator ( const QString &  separator)

Set separator used to separate items in the display text.

Parameters
separatorseparator to use
See also
separator()

Definition at line 110 of file qgscheckablecombobox.cpp.

◆ showContextMenu

void QgsCheckableComboBox::showContextMenu ( const QPoint &  pos)
protectedslot

Display context menu which allows selecting/deselecting all items at once.

Definition at line 179 of file qgscheckablecombobox.cpp.

◆ toggleItemCheckState()

void QgsCheckableComboBox::toggleItemCheckState ( int  index)

Toggles the item check state.

Parameters
indexitem index
See also
itemCheckState()
setItemCheckState()

Definition at line 160 of file qgscheckablecombobox.cpp.

Property Documentation

◆ checkedItems

QStringList QgsCheckableComboBox::checkedItems
readwrite

Definition at line 131 of file qgscheckablecombobox.h.

◆ defaultText

QString QgsCheckableComboBox::defaultText
readwrite

Definition at line 130 of file qgscheckablecombobox.h.

◆ separator

QString QgsCheckableComboBox::separator
readwrite

Definition at line 129 of file qgscheckablecombobox.h.


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