Class: QgsRasterBandComboBox¶
- class qgis.gui.QgsRasterBandComboBox(parent: QWidget = None)¶
Bases:
PyQt5.QtWidgets.QComboBox
Constructor for QgsRasterBandComboBox.
A combobox widget which displays the bands present in a raster layer.
New in version 3.0:
Methods
Returns the current band number selected in the combobox, or -1 if no band is selected.
Returns a user-friendly band name for the specified
band
.Returns
True
if the combo box is showing the "not set" option.Returns the layer currently associated with the combobox.
Sets the current
band
number selected in the combobox.Sets the raster
layer
for which the bands are listed in the combobox.Sets whether the combo box should show the "not set" option.
Signals
Emitted when the currently selected band changes.
- actionEvent(self, QActionEvent)¶
- bandChanged¶
Emitted when the currently selected band changes. [signal]
- Parameters
band (int) –
- changeEvent(self, QEvent)¶
- childEvent(self, QChildEvent)¶
- closeEvent(self, QCloseEvent)¶
- connectNotify(self, QMetaMethod)¶
- contextMenuEvent(self, QContextMenuEvent)¶
- create(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
- currentBand(self) int ¶
Returns the current band number selected in the combobox, or -1 if no band is selected.
See also
- Return type
int
- customEvent(self, QEvent)¶
- destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
- disconnectNotify(self, QMetaMethod)¶
- displayBandName(provider: QgsRasterDataProvider, band: int) str ¶
Returns a user-friendly band name for the specified
band
.- Parameters
provider (QgsRasterDataProvider) –
band (int) –
- Return type
str
- dragEnterEvent(self, QDragEnterEvent)¶
- dragLeaveEvent(self, QDragLeaveEvent)¶
- dragMoveEvent(self, QDragMoveEvent)¶
- dropEvent(self, QDropEvent)¶
- enterEvent(self, QEvent)¶
- focusInEvent(self, QFocusEvent)¶
- focusNextChild(self) bool ¶
- focusNextPrevChild(self, bool) bool ¶
- focusOutEvent(self, QFocusEvent)¶
- focusPreviousChild(self) bool ¶
- hideEvent(self, QHideEvent)¶
- initPainter(self, QPainter)¶
- initStyleOption(self, QStyleOptionComboBox)¶
- inputMethodEvent(self, QInputMethodEvent)¶
- isShowingNotSetOption(self) bool ¶
Returns
True
if the combo box is showing the “not set” option.See also
- Return type
bool
- isSignalConnected(self, QMetaMethod) bool ¶
- keyPressEvent(self, QKeyEvent)¶
- keyReleaseEvent(self, QKeyEvent)¶
- layer(self) QgsRasterLayer ¶
Returns the layer currently associated with the combobox.
See also
- Return type
- leaveEvent(self, QEvent)¶
- metric(self, QPaintDevice.PaintDeviceMetric) int ¶
- mouseDoubleClickEvent(self, QMouseEvent)¶
- mouseMoveEvent(self, QMouseEvent)¶
- mousePressEvent(self, QMouseEvent)¶
- mouseReleaseEvent(self, QMouseEvent)¶
- moveEvent(self, QMoveEvent)¶
- nativeEvent(self, Union[QByteArray, bytes, bytearray], sip.voidptr) Tuple[bool, int] ¶
- paintEvent(self, QPaintEvent)¶
- receivers(self, PYQT_SIGNAL) int ¶
- resizeEvent(self, QResizeEvent)¶
- sender(self) QObject ¶
- senderSignalIndex(self) int ¶
- setBand(self, band: int)¶
Sets the current
band
number selected in the combobox.See also
band()
- Parameters
band (int) –
- setLayer(self, layer: QgsMapLayer)¶
Sets the raster
layer
for which the bands are listed in the combobox. If no layer is set or a non-raster layer is set then the combobox will be empty.See also
- Parameters
layer (QgsMapLayer) –
- setShowNotSetOption(self, show: bool, string: str = '')¶
Sets whether the combo box should show the “not set” option. Optionally the built in “not set” text can be overridden by specifying a
string
.See also
- Parameters
show (bool) –
string (str = '') –
- showEvent(self, QShowEvent)¶
- tabletEvent(self, QTabletEvent)¶
- timerEvent(self, QTimerEvent)¶
- updateMicroFocus(self)¶
- wheelEvent(self, QWheelEvent)¶