File: qgsconfigcache.sip.in

package info (click to toggle)
qgis 3.40.10%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,183,672 kB
  • sloc: cpp: 1,595,771; python: 372,544; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 161
file content (111 lines) | stat: -rw-r--r-- 2,942 bytes parent folder | download | duplicates (12)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsconfigcache.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/







class QgsConfigCache : QObject
{
%Docstring(signature="appended")
Cache for server configuration.
%End

%TypeHeaderCode
#include "qgsconfigcache.h"
%End
  public:
    static void initialize( QgsServerSettings *settings );
%Docstring
Initialize from settings.

This method must be called prior any call to `QgsConfigCache.instance`
%End

    static QgsConfigCache *instance();
%Docstring
Returns the current instance.
%End

    void removeEntry( const QString &path );
%Docstring
Removes an entry from cache.

:param path: The path of the project
%End

    const QgsProject *project( const QString &path, const QgsServerSettings *settings = 0 );
%Docstring
If the project is not cached yet, then the project is read from the
path. If the project is not available, then ``None`` is returned. If the
project contains any bad layer it is considered unavailable unless the
server configuration variable QGIS_SERVER_IGNORE_BAD_LAYERS passed in
the optional settings argument is set to ``True`` (the default value is
``False``).

:param path: the filename of the QGIS project
:param settings: QGIS server settings

:return: the project or ``None`` if an error happened
%End

    QString strategyName() const;
%Docstring
Returns the name of the current strategy

.. versionadded:: 3.26
%End

    QList<QgsProject *> projects() const;
%Docstring
Returns projects currently in cache.

.. versionadded:: 3.30
%End

  public:
    QgsConfigCache( QgsServerSettings *settings );
%Docstring
Initialize from settings
%End


  signals:

    void projectRemovedFromCache( const QString &path );
%Docstring
Emitted whenever a project is removed from the cache.

.. versionadded:: 3.38
%End

  private:
    QgsConfigCache();
  public slots:
    void removeChangedEntry( const QString &path );
%Docstring
Remove cache entry
%End

    void removeChangedEntries();
%Docstring
Remove all changed cache entries
%End
};



/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/server/qgsconfigcache.h                                          *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/