A dialog for configuring a WMS group. More...

#include <qgsgroupwmsdatadialog.h>

Inheritance diagram for QgsGroupWmsDataDialog:

[legend]

Public Member Functions
	QgsGroupWmsDataDialog (const QgsMapLayerServerProperties &serverProperties, QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
	Constructor.
	QgsGroupWmsDataDialog (QWidget *parent=nullptr, Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
	Constructor.
	~QgsGroupWmsDataDialog () override=default
void	accept () override
Q_DECL_DEPRECATED QString	groupAbstract () const
	Returns group WMS abstract.
Qgis::WmsGroupRequestMode	groupRequestMode () const
	Returns the request mode of the group.
Q_DECL_DEPRECATED QString	groupShortName () const
	Returns group WMS short name.
Q_DECL_DEPRECATED QString	groupTitle () const
	Returns group WMS title.
bool	hasTimeDimension () const
	Returns whether the time dimension should be computed for this group or not.
QgsMapLayerServerProperties *	serverProperties ()
	Returns QGIS Server Properties for the layer tree group.
const QgsMapLayerServerProperties *	serverProperties () const
	Returns QGIS Server Properties const for the layer tree group.
Q_DECL_DEPRECATED void	setGroupAbstract (const QString &abstract)
	Sets group WMS abstract.
void	setGroupRequestMode (Qgis::WmsGroupRequestMode groupRequestMode)
	Sets the request mode of the group.
Q_DECL_DEPRECATED void	setGroupShortName (const QString &shortName)
	Sets group WMS short name.
Q_DECL_DEPRECATED void	setGroupTitle (const QString &title)
	Sets group WMS title.
void	setHasTimeDimension (bool hasTimeDimension)
	Sets whether the time dimension should be computed for this group or not.

Detailed Description

A dialog for configuring a WMS group.

Definition at line 30 of file qgsgroupwmsdatadialog.h.

Constructor & Destructor Documentation

◆ QgsGroupWmsDataDialog() [1/2]

QgsGroupWmsDataDialog::QgsGroupWmsDataDialog	(	QWidget *	parent = nullptr,
		Qt::WindowFlags	fl = QgsGuiUtils::ModalDialogFlags )

Constructor.

Parameters

parent	parent widget
fl	dialog window flags

Definition at line 25 of file qgsgroupwmsdatadialog.cpp.

◆ QgsGroupWmsDataDialog() [2/2]

QgsGroupWmsDataDialog::QgsGroupWmsDataDialog	(	const QgsMapLayerServerProperties &	serverProperties,
		QWidget *	parent = nullptr,
		Qt::WindowFlags	fl = QgsGuiUtils::ModalDialogFlags )

Constructor.

Parameters

serverProperties	used to initialize the dialog
parent	parent widget
fl	dialog window flags

Definition at line 29 of file qgsgroupwmsdatadialog.cpp.

◆ ~QgsGroupWmsDataDialog()

QgsGroupWmsDataDialog::~QgsGroupWmsDataDialog ( )

overridedefault

Member Function Documentation

◆ accept()

void QgsGroupWmsDataDialog::accept ( )

override

Definition at line 92 of file qgsgroupwmsdatadialog.cpp.

◆ groupAbstract()

QString QgsGroupWmsDataDialog::groupAbstract ( ) const

Returns group WMS abstract.

Deprecated: QGIS 3.44. Use serverProperties()->abstract() instead.

Definition at line 70 of file qgsgroupwmsdatadialog.cpp.

◆ groupRequestMode()

Qgis::WmsGroupRequestMode QgsGroupWmsDataDialog::groupRequestMode ( ) const

Returns the request mode of the group.

When it's opaque, WMS treats it as a single opaque layer instead of a collection of individual layers. Its child layers are hidden from GetCapabilities requests. Any direct requests (like GetMap or GetFeatureInfo etc.) for a child layer will result in an error. Child layers are rendered whenever a request is made for the group itself.

See also: setGroupRequestMode(); QgsLayerTreeGroup::setWmsGroupRequestMode

Since: QGIS 4.2

Definition at line 108 of file qgsgroupwmsdatadialog.cpp.

◆ groupShortName()

QString QgsGroupWmsDataDialog::groupShortName ( ) const

Returns group WMS short name.

Deprecated: QGIS 3.44. Use serverProperties()->shortName() instead.

Definition at line 46 of file qgsgroupwmsdatadialog.cpp.

◆ groupTitle()

QString QgsGroupWmsDataDialog::groupTitle ( ) const

Returns group WMS title.

Deprecated: QGIS 3.44. Use serverProperties()->title() instead.

Definition at line 58 of file qgsgroupwmsdatadialog.cpp.

◆ hasTimeDimension()

bool QgsGroupWmsDataDialog::hasTimeDimension ( ) const

Returns whether the time dimension should be computed for this group or not.

if true, when a GetCapabilities request is sent, QGIS server would return a TIME dimension computed as an union of all time dimensions of its children recursively. Else, no TIME dimension will be returned.

See also: setHasTimeDimension()

Since: QGIS 3.44

Definition at line 98 of file qgsgroupwmsdatadialog.cpp.

◆ serverProperties() [1/2]

QgsMapLayerServerProperties * QgsGroupWmsDataDialog::serverProperties ( )

Returns QGIS Server Properties for the layer tree group.

Since: QGIS 3.44

Definition at line 82 of file qgsgroupwmsdatadialog.cpp.

◆ serverProperties() [2/2]

const QgsMapLayerServerProperties * QgsGroupWmsDataDialog::serverProperties ( ) const

Returns QGIS Server Properties const for the layer tree group.

Since: QGIS 3.44

Definition at line 87 of file qgsgroupwmsdatadialog.cpp.

◆ setGroupAbstract()

void QgsGroupWmsDataDialog::setGroupAbstract ( const QString & abstract )

Sets group WMS abstract.

Deprecated: QGIS 3.44. Use serverProperties()->setAbstract() instead.

Definition at line 76 of file qgsgroupwmsdatadialog.cpp.

◆ setGroupRequestMode()

void QgsGroupWmsDataDialog::setGroupRequestMode ( Qgis::WmsGroupRequestMode groupRequestMode )

Sets the request mode of the group.

Parameters

groupRequestMode On Opaque, WMS treats it as a single opaque layer instead of a collection of individual layers. On Normal it behaves as a standard group.

See also: groupRequestMode(); QgsLayerTreeGroup::wmsGroupRequestMode

Since: QGIS 4.2

Definition at line 113 of file qgsgroupwmsdatadialog.cpp.

◆ setGroupShortName()

void QgsGroupWmsDataDialog::setGroupShortName ( const QString & shortName )

Sets group WMS short name.

Deprecated: QGIS 3.44. Use serverProperties()->setShortName() instead.

Definition at line 52 of file qgsgroupwmsdatadialog.cpp.

◆ setGroupTitle()

void QgsGroupWmsDataDialog::setGroupTitle ( const QString & title )

Sets group WMS title.

Deprecated: QGIS 3.44. Use serverProperties()->setTitle() instead.

Definition at line 64 of file qgsgroupwmsdatadialog.cpp.

◆ setHasTimeDimension()

void QgsGroupWmsDataDialog::setHasTimeDimension ( bool hasTimeDimension )

Sets whether the time dimension should be computed for this group or not.

Parameters

hasTimeDimension if true, when a GetCapabilities request is sent, QGIS server would return a TIME dimension computed as an union of all time dimensions of its children recursively. Else, no TIME dimension will be returned.

See also: hasTimeDimension()

Since: QGIS 3.44

Definition at line 103 of file qgsgroupwmsdatadialog.cpp.

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

/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/gui/qgsgroupwmsdatadialog.h
/build/qgis-4.1.0+git20260529+31622b25bb0+99sid/src/gui/qgsgroupwmsdatadialog.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QgsGroupWmsDataDialog() [1/2]

◆ QgsGroupWmsDataDialog() [2/2]

◆ ~QgsGroupWmsDataDialog()

Member Function Documentation

◆ accept()

◆ groupAbstract()

◆ groupRequestMode()

◆ groupShortName()

◆ groupTitle()

◆ hasTimeDimension()

◆ serverProperties() [1/2]

◆ serverProperties() [2/2]

◆ setGroupAbstract()

◆ setGroupRequestMode()

◆ setGroupShortName()

◆ setGroupTitle()

◆ setHasTimeDimension()