Class: QgsRasterBandComboBox

A combobox widget which displays the bands present in a raster layer.

QgsRasterBandComboBox in the collapsed state

QgsRasterBandComboBox in the expanded state

Class Hierarchy

Base classes

QComboBox
QWidget
QObject
QPaintDevice

class qgis.gui.QgsRasterBandComboBox

Bases: QComboBox

__init__(parent: QWidget | None = None)

Constructor for QgsRasterBandComboBox.

Parameters:

parent (Optional[QWidget] = None)

signal bandChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

currentBand(self) → int

Returns the current band number selected in the combobox, or -1 if no band is selected.

See also

setBand()

Return type:

int

static displayBandName(provider: QgsRasterDataProvider | None, band: int) → str

Returns a user-friendly band name for the specified band.

Parameters:

• provider (Optional[QgsRasterDataProvider])

• band (int)

Return type:

str

isShowingNotSetOption(self) → bool

Returns True if the combo box is showing the “not set” option.

See also

setShowNotSetOption()

Return type:

bool

layer(self) → QgsRasterLayer | None

Returns the layer currently associated with the combobox.

See also

setLayer()

Return type:

Optional[QgsRasterLayer]

setBand(self, band: int)

Sets the current band number selected in the combobox.

See also

band()

Parameters:

band (int)

setLayer(self, layer: QgsMapLayer | None)

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

layer()

Parameters:

layer (Optional[QgsMapLayer])

setShowNotSetOption(self, show: bool, string: str | None = '')

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

setShowNotSetOption()

Parameters:

• show (bool)

• string (Optional[str] = '')