QGIS API Documentation 3.99.0-Master (f78f5286a64)
Public Member Functions | List of all members
QgsGroupWmsDataDialog Class Reference

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

#include <qgsgroupwmsdatadialog.h>

Inheritance diagram for QgsGroupWmsDataDialog:
Inheritance graph
[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.
 
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.
 
QgsMapLayerServerPropertiesserverProperties ()
 Returns QGIS Server Properties for the layer tree group.
 
const QgsMapLayerServerPropertiesserverProperties () const
 Returns QGIS Server Properties const for the layer tree group.
 
Q_DECL_DEPRECATED void setGroupAbstract (const QString &abstract)
 Sets group WMS abstract.
 
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 29 of file qgsgroupwmsdatadialog.h.

Constructor & Destructor Documentation

◆ QgsGroupWmsDataDialog() [1/2]

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

Constructor.

Parameters
parentparent widget
fldialog window flags

Definition at line 23 of file qgsgroupwmsdatadialog.cpp.

◆ QgsGroupWmsDataDialog() [2/2]

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

Constructor.

Parameters
serverPropertiesused to initialize the dialog
parentparent widget
fldialog window flags

Definition at line 28 of file qgsgroupwmsdatadialog.cpp.

◆ ~QgsGroupWmsDataDialog()

QgsGroupWmsDataDialog::~QgsGroupWmsDataDialog ( )
overridedefault

Member Function Documentation

◆ accept()

void QgsGroupWmsDataDialog::accept ( )
override

Definition at line 87 of file qgsgroupwmsdatadialog.cpp.

◆ groupAbstract()

QString QgsGroupWmsDataDialog::groupAbstract ( ) const

Returns group WMS abstract.

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

Definition at line 65 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 41 of file qgsgroupwmsdatadialog.cpp.

◆ groupTitle()

QString QgsGroupWmsDataDialog::groupTitle ( ) const

Returns group WMS title.

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

Definition at line 53 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 93 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 77 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 82 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 71 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 47 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 59 of file qgsgroupwmsdatadialog.cpp.

◆ setHasTimeDimension()

void QgsGroupWmsDataDialog::setHasTimeDimension ( bool  hasTimeDimension)

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

Parameters
hasTimeDimensionif 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 98 of file qgsgroupwmsdatadialog.cpp.


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