QGIS API Documentation
4.3.0-Master (52aa6503bed)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
tiledscene
qgstiledsceneconnection.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgstiledsceneconnection.h
3
---------------------
4
begin : June 2023
5
copyright : (C) 2023 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************
8
* *
9
* This program is free software; you can redistribute it and/or modify *
10
* it under the terms of the GNU General Public License as published by *
11
* the Free Software Foundation; either version 2 of the License, or *
12
* (at your option) any later version. *
13
* *
14
***************************************************************************/
15
16
#ifndef QGSTILEDSCENECONNECTION_H
17
#define QGSTILEDSCENECONNECTION_H
18
19
#include "qgis_core.h"
20
#include "
qgssettingstree.h
"
21
#include "
qgssettingstreenode.h
"
22
23
#include <QString>
24
25
#define SIP_NO_FILE
26
27
using namespace
Qt::StringLiterals;
28
29
30
#include <QStringList>
31
32
#include "
qgsabstractproviderconnection.h
"
33
#include "
qgshttpheaders.h
"
34
35
class
QgsSettingsEntryString
;
36
class
QgsSettingsEntryInteger
;
37
class
QgsSettingsEntryVariantMap
;
38
47
class
CORE_EXPORT
QgsTiledSceneProviderConnection
:
public
QgsAbstractProviderConnection
48
{
49
public
:
50
#ifndef SIP_RUN
51
53
static
inline
QgsSettingsTreeNamedListNode
*sTreeConnectionTiledScene
54
=
QgsSettingsTree::sTreeConnections
->createNamedListNode( u
"tiled-scene"
_s,
Qgis::SettingsTreeNodeOption::NamedListSelectedItemSetting
);
55
56
static
const
QgsSettingsEntryString
*settingsProvider;
57
static
const
QgsSettingsEntryString
*settingsUrl;
58
static
const
QgsSettingsEntryString
*settingsAuthcfg;
59
static
const
QgsSettingsEntryString
*settingsUsername;
60
static
const
QgsSettingsEntryString
*settingsPassword;
61
static
const
QgsSettingsEntryVariantMap
*settingsHeaders;
62
64
#endif
65
69
QgsTiledSceneProviderConnection
(
const
QString &name );
70
74
QgsTiledSceneProviderConnection
(
const
QString &
uri
,
const
QString &provider,
const
QVariantMap &
configuration
);
75
76
void
store
(
const
QString &name )
const override
;
77
void
remove
(
const
QString &name )
const override
;
78
82
QString
providerKey
()
const
{
return
mProvider; }
83
92
struct
Data
93
{
95
QString
provider
;
96
98
QString
url
;
99
101
QString
authCfg
;
102
104
QString
username
;
105
107
QString
password
;
108
110
QgsHttpHeaders
httpHeaders
;
111
};
112
119
static
QString
encodedUri
(
const
Data
&data );
120
127
static
Data
decodedUri
(
const
QString &
uri
);
128
135
static
QString
encodedLayerUri
(
const
Data
&data );
136
140
static
QStringList
connectionList
();
141
145
static
Data
connection
(
const
QString &name );
146
150
static
void
addConnection
(
const
QString &name,
const
Data
&
connection
);
151
157
static
QString
selectedConnection
();
158
164
static
void
setSelectedConnection
(
const
QString &name );
165
166
private
:
167
QString mProvider;
168
};
169
170
#endif
// QGSTILEDSCENECONNECTION_H
Qgis::SettingsTreeNodeOption::NamedListSelectedItemSetting
@ NamedListSelectedItemSetting
Creates a setting to store which is the current item.
Definition
qgis.h:728
QgsAbstractProviderConnection::configuration
QVariantMap configuration() const
Returns the connection configuration parameters.
Definition
qgsabstractproviderconnection.cpp:47
QgsAbstractProviderConnection::QgsAbstractProviderConnection
QgsAbstractProviderConnection(const QString &name)
Creates a new connection with name by reading its configuration from the settings.
Definition
qgsabstractproviderconnection.cpp:20
QgsAbstractProviderConnection::remove
virtual void remove(const QString &name) const =0
Deletes the connection from the settings.
QgsAbstractProviderConnection::store
virtual void store(const QString &name) const =0
Stores the connection in the settings.
QgsAbstractProviderConnection::uri
QString uri() const
Returns the connection data source URI string representation.
Definition
qgsabstractproviderconnection.cpp:37
QgsHttpHeaders
Implements simple HTTP header management.
Definition
qgshttpheaders.h:41
QgsSettingsEntryInteger
An integer settings entry.
Definition
qgssettingsentryimpl.h:367
QgsSettingsEntryString
A string settings entry.
Definition
qgssettingsentryimpl.h:123
QgsSettingsEntryVariantMap
A string list settings entry.
Definition
qgssettingsentryimpl.h:789
QgsSettingsTreeNamedListNode
A named list tree node for the settings tree to help organizing and introspecting the tree.
Definition
qgssettingstreenode.h:201
QgsSettingsTree::sTreeConnections
static QgsSettingsTreeNode * sTreeConnections
Definition
qgssettingstree.h:50
QgsTiledSceneProviderConnection::selectedConnection
static QString selectedConnection()
Returns the name of the last used connection.
Definition
qgstiledsceneconnection.cpp:122
QgsTiledSceneProviderConnection::decodedUri
static Data decodedUri(const QString &uri)
Returns a connection uri decoded to a data structure.
Definition
qgstiledsceneconnection.cpp:57
QgsTiledSceneProviderConnection::connection
static Data connection(const QString &name)
Returns connection details for the stored connection with the specified name.
Definition
qgstiledsceneconnection.cpp:94
QgsTiledSceneProviderConnection::QgsTiledSceneProviderConnection
PRIVATE QgsTiledSceneProviderConnection(const QString &name)
Constructor for QgsTiledSceneProviderConnection, using the stored settings with the specified connect...
Definition
qgstiledsceneconnection.cpp:132
QgsTiledSceneProviderConnection::addConnection
static void addConnection(const QString &name, const Data &connection)
Stores a new connection, under the specified connection name.
Definition
qgstiledsceneconnection.cpp:112
QgsTiledSceneProviderConnection::setSelectedConnection
static void setSelectedConnection(const QString &name)
Stores the name of the last used connection.
Definition
qgstiledsceneconnection.cpp:127
QgsTiledSceneProviderConnection::connectionList
static QStringList connectionList()
Returns a list of the stored connection names.
Definition
qgstiledsceneconnection.cpp:89
QgsTiledSceneProviderConnection::providerKey
QString providerKey() const
Returns the data provider associated with the connection.
Definition
qgstiledsceneconnection.h:82
QgsTiledSceneProviderConnection::encodedUri
static QString encodedUri(const Data &data)
Returns connection data encoded as a string.
Definition
qgstiledsceneconnection.cpp:39
QgsTiledSceneProviderConnection::encodedLayerUri
static QString encodedLayerUri(const Data &data)
Returns connection data encoded as a string containing a URI for a QgsTiledSceneLayer.
Definition
qgstiledsceneconnection.cpp:72
qgsabstractproviderconnection.h
qgshttpheaders.h
qgssettingstree.h
qgssettingstreenode.h
QgsTiledSceneProviderConnection::Data
Represents decoded data of a tiled scene connection.
Definition
qgstiledsceneconnection.h:93
QgsTiledSceneProviderConnection::Data::authCfg
QString authCfg
Authentication configuration ID.
Definition
qgstiledsceneconnection.h:101
QgsTiledSceneProviderConnection::Data::password
QString password
HTTP Basic password.
Definition
qgstiledsceneconnection.h:107
QgsTiledSceneProviderConnection::Data::provider
QString provider
Provider key.
Definition
qgstiledsceneconnection.h:95
QgsTiledSceneProviderConnection::Data::url
QString url
Source URI.
Definition
qgstiledsceneconnection.h:98
QgsTiledSceneProviderConnection::Data::username
QString username
HTTP Basic username.
Definition
qgstiledsceneconnection.h:104
QgsTiledSceneProviderConnection::Data::httpHeaders
QgsHttpHeaders httpHeaders
HTTP headers.
Definition
qgstiledsceneconnection.h:110
Generated on
for QGIS API Documentation by
1.17.0