Property sheet for a raster map layer. More...

#include <qgsrasterlayerproperties.h>

Inheritance diagram for QgsRasterLayerProperties:

[legend]

Public Types
enum	StyleType { QML , SLD }
	enumeration for the different types of style More...

Public Member Functions
	QgsRasterLayerProperties (QgsMapLayer lyr, QgsMapCanvas canvas, QWidget *parent=nullptr, Qt::WindowFlags=QgsGuiUtils::ModalDialogFlags)
	Constructor. More...

void	addPropertiesPageFactory (QgsMapLayerConfigWidgetFactory *factory)
	Adds a properties page factory to the raster layer properties dialog. More...

Public Member Functions inherited from QgsOptionsDialogBase
	QgsOptionsDialogBase (const QString &settingsKey, QWidget parent=nullptr, Qt::WindowFlags fl=Qt::WindowFlags(), QgsSettings settings=nullptr)
	Constructor. More...

	~QgsOptionsDialogBase () override

void	addPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget)
	Adds a new page to the dialog pages. More...

bool	iconOnly ()
	Determine if the options list is in icon only mode. More...

void	initOptionsBase (bool restoreUi=true, const QString &title=QString())
	Set up the base ui connections for vertical tabs. More...

void	insertPage (const QString &title, const QString &tooltip, const QIcon &icon, QWidget *widget, const QString &before)
	Inserts a new page into the dialog pages. More...

void	resizeAlltabs (int index)
	Resizes all tabs when the dialog is resized. More...

void	restoreLastPage ()
	Refocus the active tab from the last time the dialog was shown. More...

void	restoreOptionsBaseUi (const QString &title=QString())
	Restore the base ui. More...

void	setCurrentPage (const QString &page)
	Sets the dialog page (by object name) to show. More...

void	setSettings (QgsSettings *settings)

Protected Slots
void	optionsStackedWidget_CurrentChanged (int index) override
	auto slot executed when the active page in the main widget stack is changed More...

Protected Slots inherited from QgsOptionsDialogBase
virtual void	optionsStackedWidget_CurrentChanged (int index)
	Select relevant tab on current page change. More...

virtual void	optionsStackedWidget_WidgetRemoved (int index)
	Remove tab and unregister widgets on page remove. More...

virtual void	updateOptionsListVerticalTabs ()
	Update tabs on the splitter move. More...

void	warnAboutMissingObjects ()

Friends
class	QgsAppScreenShots

Additional Inherited Members
Public Slots inherited from QgsOptionsDialogBase
void	searchText (const QString &text)
	searchText searches for a text in all the pages of the stacked widget and highlight the results More...

Protected Member Functions inherited from QgsOptionsDialogBase
void	paintEvent (QPaintEvent *e) override

void	registerTextSearchWidgets ()
	register widgets in the dialog to search for text in it it is automatically called if a line edit has "mSearchLineEdit" as object name. More...

void	showEvent (QShowEvent *e) override

virtual void	updateWindowTitle ()

Protected Attributes inherited from QgsOptionsDialogBase
bool	mDelSettings

QString	mDialogTitle

bool	mIconOnly

bool	mInit

QDialogButtonBox *	mOptButtonBox = nullptr

QListWidget *	mOptListWidget = nullptr

QString	mOptsKey

QSplitter *	mOptSplitter = nullptr

QStackedWidget *	mOptStackedWidget = nullptr

QList< QPair< QgsOptionsDialogHighlightWidget *, int > >	mRegisteredSearchWidgets

QgsFilterLineEdit *	mSearchLineEdit = nullptr

QPointer< QgsSettings >	mSettings

Detailed Description

Property sheet for a raster map layer.

Since: QGIS 3.12 (in the GUI API)

Definition at line 55 of file qgsrasterlayerproperties.h.

Member Enumeration Documentation

◆ StyleType

enum QgsRasterLayerProperties::StyleType

enumeration for the different types of style

Enumerator
QML
SLD

Definition at line 65 of file qgsrasterlayerproperties.h.

Constructor & Destructor Documentation

◆ QgsRasterLayerProperties()

QgsRasterLayerProperties::QgsRasterLayerProperties	(	QgsMapLayer *	lyr,
		QgsMapCanvas *	canvas,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	fl = `QgsGuiUtils::ModalDialogFlags`
	)

Constructor.

Parameters

lyr	Map layer for which properties will be displayed
canvas	the QgsMapCanvas instance
parent	the parent of this widget
fl	windows flag

Definition at line 90 of file qgsrasterlayerproperties.cpp.

Member Function Documentation

◆ addPropertiesPageFactory()

void QgsRasterLayerProperties::addPropertiesPageFactory ( QgsMapLayerConfigWidgetFactory * factory )

Adds a properties page factory to the raster layer properties dialog.

Since: QGIS 3.18

Definition at line 549 of file qgsrasterlayerproperties.cpp.

◆ optionsStackedWidget_CurrentChanged

void QgsRasterLayerProperties::optionsStackedWidget_CurrentChanged ( int index )

overrideprotectedslot

auto slot executed when the active page in the main widget stack is changed

Definition at line 1845 of file qgsrasterlayerproperties.cpp.

Friends And Related Function Documentation

◆ QgsAppScreenShots

friend class QgsAppScreenShots

friend

Definition at line 312 of file qgsrasterlayerproperties.h.

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

/build/qgis-3.18.1+99unstable/src/gui/raster/qgsrasterlayerproperties.h
/build/qgis-3.18.1+99unstable/src/gui/raster/qgsrasterlayerproperties.cpp

Public Types

Public Member Functions

Protected Slots

Friends

Additional Inherited Members