QgsRasterBandComboBox Class Reference

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

#include <qgsrasterbandcombobox.h>

Inheritance diagram for QgsRasterBandComboBox:

Public Slots
void	setBand (int band)
	Sets the current band number selected in the combobox. More...
void	setLayer (QgsMapLayer *layer)
	Sets the raster layer for which the bands are listed in the combobox. More...

Signals
void	bandChanged (int band)
	This signal is emitted when the currently selected band changes. More...

Public Member Functions
	QgsRasterBandComboBox (QWidget *parent=nullptr)
	Constructor for QgsRasterBandComboBox. More...
int	currentBand () const
	Returns the current band number selected in the combobox, or -1 if no band is selected. More...
bool	isShowingNotSetOption () const
	Returns true if the combo box is showing the "not set" option. More...
QgsRasterLayer *	layer () const
	Returns the layer currently associated with the combobox. More...
void	setShowNotSetOption (bool show, const QString &string=QString())
	Sets whether the combo box should show the "not set" option. More...

Properties
int	band

Detailed Description

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

Since

QGIS 3.0

Definition at line 33 of file qgsrasterbandcombobox.h.

Constructor & Destructor Documentation

QgsRasterBandComboBox::QgsRasterBandComboBox

(

QWidget *

parent = nullptr

)

Constructor for QgsRasterBandComboBox.

Definition at line 20 of file qgsrasterbandcombobox.cpp.

Member Function Documentation

void QgsRasterBandComboBox::bandChanged ( int  band )

signal

This signal is emitted when the currently selected band changes.

int QgsRasterBandComboBox::currentBand

(

)

const

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

See also

setBand()

Definition at line 35 of file qgsrasterbandcombobox.cpp.

bool QgsRasterBandComboBox::isShowingNotSetOption

(

)

const

Returns true if the combo box is showing the "not set" option.

See also

setShowNotSetOption()

Definition at line 78 of file qgsrasterbandcombobox.cpp.

QgsRasterLayer * QgsRasterBandComboBox::layer

(

)

const

Returns the layer currently associated with the combobox.

See also

setLayer()

Definition at line 30 of file qgsrasterbandcombobox.cpp.

void QgsRasterBandComboBox::setBand ( int  band )

slot

Sets the current band number selected in the combobox.

See also

band()

Definition at line 73 of file qgsrasterbandcombobox.cpp.

void QgsRasterBandComboBox::setLayer ( QgsMapLayer *  layer )

slot

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()

Definition at line 40 of file qgsrasterbandcombobox.cpp.

void QgsRasterBandComboBox::setShowNotSetOption	(	bool	show,
		const QString &	string = QString()
	)

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()

Definition at line 83 of file qgsrasterbandcombobox.cpp.

Property Documentation

int QgsRasterBandComboBox::band

readwrite

Definition at line 36 of file qgsrasterbandcombobox.h.

---

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

• /build/qgis-3.4.15+24xenial/src/gui/raster/qgsrasterbandcombobox.h
• /build/qgis-3.4.15+24xenial/src/gui/raster/qgsrasterbandcombobox.cpp