QGIS/python/gui/auto_generated/raster/qgsrasterbandcombobox.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

97 lines
2.8 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/raster/qgsrasterbandcombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRasterBandComboBox : QComboBox
{
%Docstring(signature="appended")
A combobox widget which displays the bands present in a raster layer.
%End
%TypeHeaderCode
#include "qgsrasterbandcombobox.h"
%End
public:
QgsRasterBandComboBox( QWidget *parent /TransferThis/ = 0 );
%Docstring
Constructor for QgsRasterBandComboBox.
%End
QgsRasterLayer *layer() const;
%Docstring
Returns the layer currently associated with the combobox.
.. seealso:: :py:func:`setLayer`
%End
int currentBand() const;
%Docstring
Returns the current band number selected in the combobox, or -1 if no
band is selected.
.. seealso:: :py:func:`setBand`
%End
bool isShowingNotSetOption() const;
%Docstring
Returns ``True`` if the combo box is showing the "not set" option.
.. seealso:: :py:func:`setShowNotSetOption`
%End
void setShowNotSetOption( bool show, const QString &string = QString() );
%Docstring
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``.
.. seealso:: :py:func:`setShowNotSetOption`
%End
static QString displayBandName( QgsRasterDataProvider *provider, int band );
%Docstring
Returns a user-friendly band name for the specified ``band``.
%End
public slots:
void setLayer( QgsMapLayer *layer );
%Docstring
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.
.. seealso:: :py:func:`layer`
%End
void setBand( int band );
%Docstring
Sets the current ``band`` number selected in the combobox.
.. seealso:: :py:func:`band`
%End
signals:
void bandChanged( int band );
%Docstring
Emitted when the currently selected band changes.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/gui/raster/qgsrasterbandcombobox.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/