QGIS API Documentation  2.99.0-Master (9caa722)
Public Types | Public Slots | Public Member Functions | 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...
 
enum  Flag { FlagShowTestConnection = 1 << 1 }
 Flags controlling dialog behavior. More...
 

Public Slots

void accept () override
 

Public Member Functions

 QgsNewHttpConnection (QWidget *parent=nullptr, QgsNewHttpConnection::ConnectionTypes types=ConnectionWms, const QString &baseKey="qgis/connections-wms/", const QString &connectionName=QString(), QgsNewHttpConnection::Flags flags=0, 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 Member Functions

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...
 
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...
 
virtual QString wfsSettingsKey (const QString &base, const QString &connectionName) const
 Returns the QSettings key for WFS related settings for the connection. 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 32 of file qgsnewhttpconnection.h.

Member Enumeration Documentation

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

◆ Flag

Flags controlling dialog behavior.

Since
QGIS 3.0
Enumerator
FlagShowTestConnection 

Display the 'test connection' button.

Definition at line 55 of file qgsnewhttpconnection.h.

Constructor & Destructor Documentation

◆ QgsNewHttpConnection()

QgsNewHttpConnection::QgsNewHttpConnection ( QWidget *  parent = nullptr,
QgsNewHttpConnection::ConnectionTypes  types = ConnectionWms,
const QString &  baseKey = "qgis/connections-wms/",
const QString &  connectionName = QString(),
QgsNewHttpConnection::Flags  flags = 0,
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 28 of file qgsnewhttpconnection.cpp.

Member Function Documentation

◆ accept

void QgsNewHttpConnection::accept ( )
overrideslot

Definition at line 267 of file qgsnewhttpconnection.cpp.

◆ name()

QString QgsNewHttpConnection::name ( ) const

Returns the current connection name.

Since
QGIS 3.0

Definition at line 147 of file qgsnewhttpconnection.cpp.

◆ testConnectButton()

QPushButton * QgsNewHttpConnection::testConnectButton ( )
protected

Returns the "test connection" button.

Since
QGIS 3.0

Definition at line 203 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 218 of file qgsnewhttpconnection.cpp.

◆ url()

QString QgsNewHttpConnection::url ( ) const

Returns the current connection url.

Since
QGIS 3.0

Definition at line 152 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 175 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 208 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 213 of file qgsnewhttpconnection.cpp.


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