QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Slots | Public Member Functions | Protected Types | Protected Member Functions | List of all members
QgsNewHttpConnection Class Reference
gui library

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...
 
enum  Flag { FlagShowTestConnection = 1 << 1 , FlagHideAuthenticationGroup = 1 << 2 , FlagShowHttpSettings = 1 << 3 }
 Flags controlling dialog behavior. More...
 

Public Slots

void accept () override
 

Public Member Functions

 QgsNewHttpConnection (QWidget *parent=nullptr, QgsNewHttpConnection::ConnectionTypes types=ConnectionWms, const QString &serviceName SIP_PYARGRENAME(settingsKey)="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  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

QgsAuthSettingsWidget * authSettingsWidget ()
 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...
 
QCheckBox * wfsPagingEnabledCheckBox ()
 Returns the "WFS paging enabled" checkbox. 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 Enumeration Documentation

◆ ConnectionType

enum QgsNewHttpConnection::ConnectionType

Available connection types for configuring in the dialog.

Since
QGIS 3.0
Enumerator
ConnectionWfs 

WFS connection.

ConnectionWms 

WMS connection.

ConnectionWcs 

WCS connection.

ConnectionOther 

Other connection type.

Definition at line 43 of file qgsnewhttpconnection.h.

◆ Flag

enum QgsNewHttpConnection::Flag

Flags controlling dialog behavior.

Since
QGIS 3.0
Enumerator
FlagShowTestConnection 

Display the 'test connection' button.

FlagHideAuthenticationGroup 

Hide the Authentication group.

FlagShowHttpSettings 

Display the 'http' group.

Definition at line 56 of file qgsnewhttpconnection.h.

◆ WfsVersionIndex

enum QgsNewHttpConnection::WfsVersionIndex
protected

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 107 of file qgsnewhttpconnection.h.

Constructor & Destructor Documentation

◆ QgsNewHttpConnection()

QgsNewHttpConnection::QgsNewHttpConnection ( QWidget *  parent = nullptr,
QgsNewHttpConnection::ConnectionTypes  types = ConnectionWms,
const QString &serviceName   SIP_PYARGRENAMEsettingsKey = "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 32 of file qgsnewhttpconnection.cpp.

Member Function Documentation

◆ accept

void QgsNewHttpConnection::accept ( )
overrideslot

Definition at line 359 of file qgsnewhttpconnection.cpp.

◆ authSettingsWidget()

QgsAuthSettingsWidget * QgsNewHttpConnection::authSettingsWidget ( )
protected

Returns the current authentication settings widget.

Since
QGIS 3.8

Definition at line 247 of file qgsnewhttpconnection.cpp.

◆ name()

QString QgsNewHttpConnection::name ( ) const

Returns the current connection name.

Since
QGIS 3.0

Definition at line 184 of file qgsnewhttpconnection.cpp.

◆ testConnectButton()

QPushButton * QgsNewHttpConnection::testConnectButton ( )
protected

Returns the "test connection" button.

Since
QGIS 3.0

Definition at line 242 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).

Since
QGIS 3.0

Definition at line 287 of file qgsnewhttpconnection.cpp.

◆ url()

QString QgsNewHttpConnection::url ( ) const

Returns the current connection url.

Since
QGIS 3.0

Definition at line 189 of file qgsnewhttpconnection.cpp.

◆ urlTrimmed()

QUrl QgsNewHttpConnection::urlTrimmed ( ) const
protected

Returns the url.

Since
QGIS 3.2

Definition at line 330 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.

Since
QGIS 3.0

Definition at line 213 of file qgsnewhttpconnection.cpp.

◆ wfsPageSizeLineEdit()

QLineEdit * QgsNewHttpConnection::wfsPageSizeLineEdit ( )
protected

Returns the "WFS page size" edit.

Since
QGIS 3.2

Definition at line 272 of file qgsnewhttpconnection.cpp.

◆ wfsPagingEnabledCheckBox()

QCheckBox * QgsNewHttpConnection::wfsPagingEnabledCheckBox ( )
protected

Returns the "WFS paging enabled" checkbox.

Since
QGIS 3.2

Definition at line 262 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()
Since
QGIS 3.0

Definition at line 277 of file qgsnewhttpconnection.cpp.

◆ wfsUseGml2EncodingForTransactions()

QCheckBox * QgsNewHttpConnection::wfsUseGml2EncodingForTransactions ( )
protected

Returns the "Use GML2 encoding for transactions" checkbox.

Since
QGIS 3.16

Definition at line 267 of file qgsnewhttpconnection.cpp.

◆ wfsVersionComboBox()

QComboBox * QgsNewHttpConnection::wfsVersionComboBox ( )
protected

Returns the "WFS version" combobox.

Since
QGIS 3.2

Definition at line 257 of file qgsnewhttpconnection.cpp.

◆ wfsVersionDetectButton()

QPushButton * QgsNewHttpConnection::wfsVersionDetectButton ( )
protected

Returns the "WFS version detect" button.

Since
QGIS 3.2

Definition at line 252 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()
Since
QGIS 3.0

Definition at line 282 of file qgsnewhttpconnection.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Oct 22 2022 16:10:47 for QGIS API Documentation by doxygen 1.9.4