The QgsRasterAttributeTableWidget class provides an attribute table for rasters and methods to edit the table. More...

#include <qgsrasterattributetablewidget.h>

Inheritance diagram for QgsRasterAttributeTableWidget:

[legend]

Public Slots
void	saveChanges ()
	Save the changes in the raster attribute table. More...

bool	setEditable (bool editable, bool allowCancel=true)
	Set the editable state, it may trigger save changes if the attribute table has unsave changes. More...

Public Slots inherited from QgsPanelWidget
void	acceptPanel ()
	Accept the panel. More...

void	openPanel (QgsPanelWidget *panel)
	Open a panel or dialog depending on dock mode setting If dock mode is `true` this method will emit the showPanel signal for connected slots to handle the open event. More...

Signals
void	rendererChanged ()
	This signal is emitted after a successful classify operation which changed the raster renderer. More...

Signals inherited from QgsPanelWidget
void	panelAccepted (QgsPanelWidget *panel)
	Emitted when the panel is accepted by the user. More...

void	showPanel (QgsPanelWidget *panel)
	Emit when you require a panel to be show in the interface. More...

void	widgetChanged ()
	Emitted when the widget state changes. More...

Public Member Functions
	QgsRasterAttributeTableWidget (QWidget parent=nullptr, QgsRasterLayer rasterLayer=nullptr, const int bandNumber=0)
	Creates a new QgsRasterAttributeTableWidget. More...

bool	isDirty () const
	Returns `true` if the associated raster attribute table is dirty. More...

void	setDockMode (bool dockMode) override
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...

void	setMessageBar (QgsMessageBar *bar)
	Sets the message bar associated with the widget. More...

void	setRasterLayer (QgsRasterLayer *rasterLayer, const int bandNumber=0)
	Sets the raster layer and an optional band number. More...

Public Member Functions inherited from QgsPanelWidget
	QgsPanelWidget (QWidget *parent=nullptr)
	Base class for any widget that can be shown as a inline panel. More...

virtual bool	applySizeConstraintsToStack () const
	Returns `true` if the size constraints and hints for the panel widget should be applied to the parent QgsPanelWidgetStack which this panel is shown in. More...

bool	autoDelete ()
	The the auto delete property on the widget. More...

void	connectChildPanel (QgsPanelWidget *panel)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

void	connectChildPanels (const QList< QgsPanelWidget * > &panels)
	Connect the given sub panel widgets showPanel signals to this current panels main showPanel event to bubble up to the user. More...

bool	dockMode ()
	Returns the dock mode state. More...

virtual QMenu *	menuButtonMenu ()
	Returns the menu to use for the menu button for this panel, or `nullptr` if no menu button is required. More...

virtual QString	menuButtonTooltip () const
	Returns the (translated) tooltip text to use for the menu button for this panel. More...

QString	panelTitle ()
	The title of the panel. More...

void	setAutoDelete (bool autoDelete)
	The the auto delete property on the widget. More...

virtual void	setDockMode (bool dockMode)
	Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs. More...

void	setPanelTitle (const QString &panelTitle)
	Set the title of the panel when shown in the interface. More...

Additional Inherited Members
Static Public Member Functions inherited from QgsPanelWidget
static QgsPanelWidget *	findParentPanel (QWidget *widget)
	Traces through the parents of a widget to find if it is contained within a QgsPanelWidget widget. More...

Protected Member Functions inherited from QgsPanelWidget
void	keyPressEvent (QKeyEvent *event) override
	Overridden key press event to handle the esc event on the widget. More...

Detailed Description

The QgsRasterAttributeTableWidget class provides an attribute table for rasters and methods to edit the table.

Since: QGIS 3.30

Definition at line 126 of file qgsrasterattributetablewidget.h.

Constructor & Destructor Documentation

◆ QgsRasterAttributeTableWidget()

QgsRasterAttributeTableWidget::QgsRasterAttributeTableWidget	(	QWidget *	parent = `nullptr`,
		QgsRasterLayer *	rasterLayer = `nullptr`,
		const int	bandNumber = `0`
	)

explicit

Creates a new QgsRasterAttributeTableWidget.

Parameters

parent	parent widget
rasterLayer	raster layer
bandNumber	optional initial selected band number (default to 0, which makes the widget use the first available RAT, if any)

Definition at line 32 of file qgsrasterattributetablewidget.cpp.

Member Function Documentation

◆ isDirty()

bool QgsRasterAttributeTableWidget::isDirty ( ) const

Returns true if the associated raster attribute table is dirty.

Definition at line 93 of file qgsrasterattributetablewidget.cpp.

◆ rendererChanged

void QgsRasterAttributeTableWidget::rendererChanged ( )

signal

This signal is emitted after a successful classify operation which changed the raster renderer.

◆ saveChanges

void QgsRasterAttributeTableWidget::saveChanges ( )

slot

Save the changes in the raster attribute table.

Definition at line 244 of file qgsrasterattributetablewidget.cpp.

◆ setDockMode()

void QgsRasterAttributeTableWidget::setDockMode ( bool dockMode )

overridevirtual

Set the widget in dock mode which tells the widget to emit panel widgets and not open dialogs.

Parameters

dockMode true to enable dock mode.

Reimplemented from QgsPanelWidget.

Definition at line 183 of file qgsrasterattributetablewidget.cpp.

◆ setEditable

bool QgsRasterAttributeTableWidget::setEditable	(	bool	editable,
		bool	allowCancel = `true`
	)

slot

Set the editable state, it may trigger save changes if the attribute table has unsave changes.

Parameters

editable	editable state
allowCancel	optional (default `true`) flag to show cancel option in confirm save dialog.

Definition at line 194 of file qgsrasterattributetablewidget.cpp.

◆ setMessageBar()

void QgsRasterAttributeTableWidget::setMessageBar ( QgsMessageBar * bar )

Sets the message bar associated with the widget.

This allows the widget to push feedback messages to the appropriate message bar.

Definition at line 189 of file qgsrasterattributetablewidget.cpp.

◆ setRasterLayer()

void QgsRasterAttributeTableWidget::setRasterLayer	(	QgsRasterLayer *	rasterLayer,
		const int	bandNumber = `0`
	)

Sets the raster layer and an optional band number.

Parameters

rasterLayer	raster layer
bandNumber	optional initial selected band number (default to 0, which makes the widget use the first available RAT, if any)

Definition at line 87 of file qgsrasterattributetablewidget.cpp.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/raster/qgsrasterattributetablewidget.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/gui/raster/qgsrasterattributetablewidget.cpp

Public Slots

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsRasterAttributeTableWidget()

Member Function Documentation

◆ isDirty()

◆ rendererChanged

◆ saveChanges

◆ setDockMode()

◆ setEditable

◆ setMessageBar()

◆ setRasterLayer()