File: qgsprojectstorageguiprovider.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 (66 lines) | stat: -rw-r--r-- 2,542 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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/gui/qgsprojectstorageguiprovider.h                               *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/




class QgsProjectStorageGuiProvider
{
%Docstring(signature="appended")
Abstract interface for project storage GUI - to be implemented by
various backends and registered in
:py:class:`QgsProjectStorageGuiRegistry`.

.. versionadded:: 3.10
%End

%TypeHeaderCode
#include "qgsprojectstorageguiprovider.h"
%End
  public:
    virtual ~QgsProjectStorageGuiProvider();

    virtual QString type() = 0;
%Docstring
Unique identifier of the project storage type. If
:py:func:`~QgsProjectStorageGuiProvider.type` returns "memory", all
project file names starting with "memory:" will have read/write
redirected through that storage implementation.
%End

    virtual QString visibleName();
%Docstring
Returns human-readable name of the storage. Used as the menu item text
in QGIS. Empty name indicates that the storage does not implement GUI
support (:py:func:`~QgsProjectStorageGuiProvider.showLoadGui` and
:py:func:`~QgsProjectStorageGuiProvider.showSaveGui`). The name may be
translatable and ideally unique as well.
%End

    virtual QString showLoadGui();
%Docstring
Opens GUI to allow user to select a project to be loaded (GUI specific
to this storage type). Returns project URI if user has picked a project
or empty string if the GUI was canceled.
%End

    virtual QString showSaveGui();
%Docstring
Opens GUI to allow user to select where a project should be saved (GUI
specific to this storage type). Returns project URI if user has picked a
destination or empty string if the GUI was canceled.
%End
};

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