Class: QgsFieldComboBox¶
-
class
qgis.gui.
QgsFieldComboBox
(parent: QWidget = None)¶ Bases:
PyQt5.QtWidgets.QComboBox
QgsFieldComboBox
creates a combo box to display the fields of a layer. The layer can be either manually given or dynamically set by connecting the signal QgsMapLayerComboBox.layerChanged to the slot setLayer.The
QgsFieldComboBox
is a combo box which displays the list of fields of a given layer. It might be combined with aQgsMapLayerComboBox
to automatically update fields according to a chosen layer. If expression must be used,QgsFieldExpressionWidget
shall be used instead.See also
New in version 2.3.
- Parameters
parent –
-
actionEvent
()¶
-
allowEmptyFieldName
(self) → bool¶ Returns true if the combo box allows the empty field (“not set”) choice.
See also
New in version 3.0.
- Return type
bool
-
changeEvent
()¶
-
childEvent
()¶
-
closeEvent
()¶
-
connectNotify
()¶
-
contextMenuEvent
()¶
-
create
()¶
-
currentField
(self) → str¶ Returns the currently selected field
- Return type
str
-
customEvent
()¶
-
destroy
()¶
-
disconnectNotify
()¶
-
dragEnterEvent
()¶
-
dragLeaveEvent
()¶
-
dragMoveEvent
()¶
-
dropEvent
()¶
-
enterEvent
()¶
-
fieldChanged
¶ the signal is emitted when the currently selected field changes [signal]
-
filters
(self) → QgsFieldProxyModel.Filters¶ currently used filter on list of fields
- Return type
-
focusInEvent
()¶
-
focusNextChild
()¶
-
focusNextPrevChild
()¶
-
focusOutEvent
()¶
-
focusPreviousChild
()¶
-
hideEvent
()¶
-
indexChanged
(self, i: int)¶ - Parameters
i (int) –
-
initPainter
()¶
-
initStyleOption
()¶
-
inputMethodEvent
()¶
-
isSignalConnected
()¶
-
keyPressEvent
()¶
-
keyReleaseEvent
()¶
-
layer
(self) → QgsVectorLayer¶ Returns the layer currently associated with the combobox.
See also
- Return type
-
leaveEvent
()¶
-
metric
()¶
-
mouseDoubleClickEvent
()¶
-
mouseMoveEvent
()¶
-
mousePressEvent
()¶
-
mouseReleaseEvent
()¶
-
moveEvent
()¶
-
nativeEvent
()¶
-
paintEvent
()¶
-
receivers
()¶
-
resizeEvent
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
setAllowEmptyFieldName
(self, allowEmpty: bool)¶ Sets whether an optional empty field (“not set”) option is shown in the combo box.
See also
New in version 3.0.
- Parameters
allowEmpty (bool) –
-
setField
(self, fieldName: str)¶ setField sets the currently selected field
- Parameters
fieldName (str) –
-
setFilters
(self, filters: Union[QgsFieldProxyModel.Filters, QgsFieldProxyModel.Filter])¶ setFilters allows fitering according to the type of field
- Parameters
filters (Union[QgsFieldProxyModel.Filters) –
-
setLayer
(self, layer: QgsMapLayer)¶ Sets the layer for which fields are listed in the combobox. If no layer is set or a non-vector layer is set then the combobox will be empty.
See also
- Parameters
layer (QgsMapLayer) –
-
showEvent
()¶
-
tabletEvent
()¶
-
timerEvent
()¶
-
updateMicroFocus
()¶
-
wheelEvent
()¶