The QgsCreateRasterAttributeTableDialog dialog collects the information required to create a new raster attribute table and performs the creation when the dialog is accepted. More...

#include <qgscreaterasterattributetabledialog.h>

Inheritance diagram for QgsCreateRasterAttributeTableDialog:

[legend]

Public Slots
void	accept () override

Public Member Functions
	QgsCreateRasterAttributeTableDialog (QgsRasterLayer rasterLayer, QWidget parent=nullptr)
	Creates a new QgsCreateRasterAttributeTableDialog.

QString	filePath () const
	Returns the file path in case of VAT.DBF save option.

bool	openWhenDone () const
	Returns `true` if the option to open the newly created attribute table is checked.

bool	saveToFile () const
	Returns `true` if the option to save to a file is selected.

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

void	setOpenWhenDoneVisible (bool visible)
	Sets the visibility of the "Open newly created raster attribute table" option to visible, the option is visible by default.

Detailed Description

The QgsCreateRasterAttributeTableDialog dialog collects the information required to create a new raster attribute table and performs the creation when the dialog is accepted.

Warning: Client code must check if the creation of attribute tables is supported by the raster layer by calling QgsRasterLayer::canCreateAttributeTable() before using this dialog.

Note: Not available in Python bindings

Since: QGIS 3.30

Definition at line 37 of file qgscreaterasterattributetabledialog.h.

Constructor & Destructor Documentation

◆ QgsCreateRasterAttributeTableDialog()

QgsCreateRasterAttributeTableDialog::QgsCreateRasterAttributeTableDialog	(	QgsRasterLayer *	rasterLayer,
		QWidget *	parent = `nullptr`
	)

Creates a new QgsCreateRasterAttributeTableDialog.

Parameters

rasterLayer	the raster layer, must be suitable for creating a new raster attribute table
parent	optional parent

Definition at line 23 of file qgscreaterasterattributetabledialog.cpp.

Member Function Documentation

◆ accept

void QgsCreateRasterAttributeTableDialog::accept ( )

overrideslot

Definition at line 125 of file qgscreaterasterattributetabledialog.cpp.

◆ filePath()

QString QgsCreateRasterAttributeTableDialog::filePath ( ) const

Returns the file path in case of VAT.DBF save option.

Definition at line 95 of file qgscreaterasterattributetabledialog.cpp.

◆ openWhenDone()

bool QgsCreateRasterAttributeTableDialog::openWhenDone ( ) const

Returns true if the option to open the newly created attribute table is checked.

Definition at line 105 of file qgscreaterasterattributetabledialog.cpp.

◆ saveToFile()

bool QgsCreateRasterAttributeTableDialog::saveToFile ( ) const

Returns true if the option to save to a file is selected.

Definition at line 100 of file qgscreaterasterattributetabledialog.cpp.

◆ setMessageBar()

void QgsCreateRasterAttributeTableDialog::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 110 of file qgscreaterasterattributetabledialog.cpp.

◆ setOpenWhenDoneVisible()

void QgsCreateRasterAttributeTableDialog::setOpenWhenDoneVisible ( bool visible )

Sets the visibility of the "Open newly created raster attribute table" option to visible, the option is visible by default.

Definition at line 115 of file qgscreaterasterattributetabledialog.cpp.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/raster/qgscreaterasterattributetabledialog.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/gui/raster/qgscreaterasterattributetabledialog.cpp

Public Slots

Public Member Functions