QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Types | Public Slots | Public Member Functions | Protected Types | Protected Member Functions | List of all members
QgsNewHttpConnection Class Reference

Dialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc. More...

#include <qgsnewhttpconnection.h>

Inheritance diagram for QgsNewHttpConnection:
Inheritance graph
[legend]

Public Types

enum  ConnectionType { ConnectionWfs = 1 << 1 , ConnectionWms = 1 << 2 , ConnectionWcs = 1 << 3 , ConnectionOther = 1 << 4 }
 Available connection types for configuring in the dialog. More...
 
typedef QFlags< ConnectionTypeConnectionTypes
 
enum  Flag { FlagShowTestConnection = 1 << 1 , FlagHideAuthenticationGroup = 1 << 2 , FlagShowHttpSettings = 1 << 3 }
 Flags controlling dialog behavior. More...
 
typedef QFlags< FlagFlags
 

Public Slots

void accept () override
 

Public Member Functions

 QgsNewHttpConnection (QWidget *parent=nullptr, QgsNewHttpConnection::ConnectionTypes types=ConnectionWms, const QString &serviceName="WMS", const QString &connectionName=QString(), QgsNewHttpConnection::Flags flags=QgsNewHttpConnection::Flags(), Qt::WindowFlags fl=QgsGuiUtils::ModalDialogFlags)
 Constructor for QgsNewHttpConnection. More...
 
QString name () const
 Returns the current connection name. More...
 
QString url () const
 Returns the current connection url. More...
 

Protected Types

enum class  WfsFeaturePagingIndex { DEFAULT = 0 , ENABLED = 1 , DISABLED = 2 }
 Index of wfsFeaturePaging. More...
 
enum  WfsVersionIndex {
  WFS_VERSION_MAX = 0 , WFS_VERSION_1_0 = 1 , WFS_VERSION_1_1 = 2 , WFS_VERSION_2_0 = 3 ,
  WFS_VERSION_API_FEATURES_1_0 = 4
}
 Index of wfsVersionComboBox. More...
 

Protected Member Functions

QgsAuthSettingsWidgetauthSettingsWidget ()
 Returns the current authentication settings widget. More...
 
QPushButton * testConnectButton ()
 Returns the "test connection" button. More...
 
void updateServiceSpecificSettings ()
 Triggers a resync of the GUI widgets for the service specific settings (i.e. More...
 
QUrl urlTrimmed () const
 Returns the url. More...
 
virtual bool validate ()
 Returns true if dialog settings are valid, or false if current settings are not valid and the dialog should not be acceptable. More...
 
QLineEdit * wfsPageSizeLineEdit ()
 Returns the "WFS page size" edit. More...
 
QComboBox * wfsPagingComboBox ()
 Returns the "WFS paging" combobox. More...
 
virtual QString wfsSettingsKey (const QString &base, const QString &connectionName) const
 Returns the QSettings key for WFS related settings for the connection. More...
 
QCheckBox * wfsUseGml2EncodingForTransactions ()
 Returns the "Use GML2 encoding for transactions" checkbox. More...
 
QComboBox * wfsVersionComboBox ()
 Returns the "WFS version" combobox. More...
 
QPushButton * wfsVersionDetectButton ()
 Returns the "WFS version detect" button. More...
 
virtual QString wmsSettingsKey (const QString &base, const QString &connectionName) const
 Returns the QSettings key for WMS related settings for the connection. More...
 

Detailed Description

Dialog to allow the user to configure and save connection information for an HTTP Server for WMS, etc.

Definition at line 33 of file qgsnewhttpconnection.h.

Member Typedef Documentation

◆ ConnectionTypes

Definition at line 49 of file qgsnewhttpconnection.h.

◆ Flags

typedef QFlags< Flag > QgsNewHttpConnection::Flags

Definition at line 60 of file qgsnewhttpconnection.h.

Member Enumeration Documentation

◆ ConnectionType

Available connection types for configuring in the dialog.

Enumerator
ConnectionWfs 

WFS connection.

ConnectionWms 

WMS connection.

ConnectionWcs 

WCS connection.

ConnectionOther 

Other connection type.

Definition at line 42 of file qgsnewhttpconnection.h.

◆ Flag

Flags controlling dialog behavior.

Enumerator
FlagShowTestConnection 

Display the 'test connection' button.

FlagHideAuthenticationGroup 

Hide the Authentication group.

FlagShowHttpSettings 

Display the 'http' group.

Definition at line 54 of file qgsnewhttpconnection.h.

◆ WfsFeaturePagingIndex

Index of wfsFeaturePaging.

Enumerator
DEFAULT 
ENABLED 
DISABLED 

Definition at line 114 of file qgsnewhttpconnection.h.

◆ WfsVersionIndex

Index of wfsVersionComboBox.

Enumerator
WFS_VERSION_MAX 
WFS_VERSION_1_0 
WFS_VERSION_1_1 
WFS_VERSION_2_0 
WFS_VERSION_API_FEATURES_1_0 

Definition at line 103 of file qgsnewhttpconnection.h.

Constructor & Destructor Documentation

◆ QgsNewHttpConnection()

QgsNewHttpConnection::QgsNewHttpConnection ( QWidget *  parent = nullptr,
QgsNewHttpConnection::ConnectionTypes  types = ConnectionWms,
const QString &  serviceName = "WMS",
const QString &  connectionName = QString(),
QgsNewHttpConnection::Flags  flags = QgsNewHttpConnection::Flags(),
Qt::WindowFlags  fl = QgsGuiUtils::ModalDialogFlags 
)

Constructor for QgsNewHttpConnection.

The types argument dictates which connection type settings should be shown in the dialog.

The flags argument allows specifying flags which control the dialog behavior and appearance.

Definition at line 34 of file qgsnewhttpconnection.cpp.

Member Function Documentation

◆ accept

void QgsNewHttpConnection::accept ( )
overrideslot

Definition at line 383 of file qgsnewhttpconnection.cpp.

◆ authSettingsWidget()

QgsAuthSettingsWidget * QgsNewHttpConnection::authSettingsWidget ( )
protected

Returns the current authentication settings widget.

Since
QGIS 3.8

Definition at line 263 of file qgsnewhttpconnection.cpp.

◆ name()

QString QgsNewHttpConnection::name ( ) const

Returns the current connection name.

Definition at line 200 of file qgsnewhttpconnection.cpp.

◆ testConnectButton()

QPushButton * QgsNewHttpConnection::testConnectButton ( )
protected

Returns the "test connection" button.

Definition at line 258 of file qgsnewhttpconnection.cpp.

◆ updateServiceSpecificSettings()

void QgsNewHttpConnection::updateServiceSpecificSettings ( )
protected

Triggers a resync of the GUI widgets for the service specific settings (i.e.

WFS and WMS related settings).

Definition at line 303 of file qgsnewhttpconnection.cpp.

◆ url()

QString QgsNewHttpConnection::url ( ) const

Returns the current connection url.

Definition at line 205 of file qgsnewhttpconnection.cpp.

◆ urlTrimmed()

QUrl QgsNewHttpConnection::urlTrimmed ( ) const
protected

Returns the url.

Since
QGIS 3.2

Definition at line 354 of file qgsnewhttpconnection.cpp.

◆ validate()

bool QgsNewHttpConnection::validate ( )
protectedvirtual

Returns true if dialog settings are valid, or false if current settings are not valid and the dialog should not be acceptable.

Definition at line 229 of file qgsnewhttpconnection.cpp.

◆ wfsPageSizeLineEdit()

QLineEdit * QgsNewHttpConnection::wfsPageSizeLineEdit ( )
protected

Returns the "WFS page size" edit.

Since
QGIS 3.2

Definition at line 288 of file qgsnewhttpconnection.cpp.

◆ wfsPagingComboBox()

QComboBox * QgsNewHttpConnection::wfsPagingComboBox ( )
protected

Returns the "WFS paging" combobox.

Since
QGIS 3.36

Definition at line 278 of file qgsnewhttpconnection.cpp.

◆ wfsSettingsKey()

QString QgsNewHttpConnection::wfsSettingsKey ( const QString &  base,
const QString &  connectionName 
) const
protectedvirtual

Returns the QSettings key for WFS related settings for the connection.

See also
wmsSettingsKey()

Definition at line 293 of file qgsnewhttpconnection.cpp.

◆ wfsUseGml2EncodingForTransactions()

QCheckBox * QgsNewHttpConnection::wfsUseGml2EncodingForTransactions ( )
protected

Returns the "Use GML2 encoding for transactions" checkbox.

Since
QGIS 3.16

Definition at line 283 of file qgsnewhttpconnection.cpp.

◆ wfsVersionComboBox()

QComboBox * QgsNewHttpConnection::wfsVersionComboBox ( )
protected

Returns the "WFS version" combobox.

Since
QGIS 3.2

Definition at line 273 of file qgsnewhttpconnection.cpp.

◆ wfsVersionDetectButton()

QPushButton * QgsNewHttpConnection::wfsVersionDetectButton ( )
protected

Returns the "WFS version detect" button.

Since
QGIS 3.2

Definition at line 268 of file qgsnewhttpconnection.cpp.

◆ wmsSettingsKey()

QString QgsNewHttpConnection::wmsSettingsKey ( const QString &  base,
const QString &  connectionName 
) const
protectedvirtual

Returns the QSettings key for WMS related settings for the connection.

See also
wfsSettingsKey()

Definition at line 298 of file qgsnewhttpconnection.cpp.


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